[go: up one dir, main page]

autocfg 1.5.0

Automatic cfg for Rust compiler features
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189

extern crate autocfg;

use autocfg::AutoCfg;

mod support;

fn core_std(ac: &AutoCfg, path: &str) -> String {
    let krate = if ac.no_std() { "core" } else { "std" };
    format!("{}::{}", krate, path)
}

fn assert_std(ac: &AutoCfg, probe_result: bool) {
    assert_eq!(!ac.no_std(), probe_result);
}

fn assert_min(ac: &AutoCfg, major: usize, minor: usize, probe_result: bool) {
    assert_eq!(ac.probe_rustc_version(major, minor), probe_result);
}

fn autocfg_for_test() -> AutoCfg {
    AutoCfg::with_dir(support::out_dir().as_ref()).unwrap()
}

#[test]
fn autocfg_version() {
    let ac = autocfg_for_test();
    assert!(ac.probe_rustc_version(1, 0));
}

#[test]
fn probe_add() {
    let ac = autocfg_for_test();
    let add = core_std(&ac, "ops::Add");
    let add_rhs = add.clone() + "<i32>";
    let add_rhs_output = add.clone() + "<i32, Output = i32>";
    let dyn_add_rhs_output = "dyn ".to_string() + &*add_rhs_output;
    assert!(ac.probe_path(&add));
    assert!(ac.probe_trait(&add));
    assert!(ac.probe_trait(&add_rhs));
    assert!(ac.probe_trait(&add_rhs_output));
    assert_min(&ac, 1, 27, ac.probe_type(&dyn_add_rhs_output));
}

#[test]
fn probe_as_ref() {
    let ac = autocfg_for_test();
    let as_ref = core_std(&ac, "convert::AsRef");
    let as_ref_str = as_ref.clone() + "<str>";
    let dyn_as_ref_str = "dyn ".to_string() + &*as_ref_str;
    assert!(ac.probe_path(&as_ref));
    assert!(ac.probe_trait(&as_ref_str));
    assert!(ac.probe_type(&as_ref_str));
    assert_min(&ac, 1, 27, ac.probe_type(&dyn_as_ref_str));
}

#[test]
fn probe_i128() {
    let ac = autocfg_for_test();
    let i128_path = core_std(&ac, "i128");
    assert_min(&ac, 1, 26, ac.probe_path(&i128_path));
    assert_min(&ac, 1, 26, ac.probe_type("i128"));
}

#[test]
fn probe_sum() {
    let ac = autocfg_for_test();
    let sum = core_std(&ac, "iter::Sum");
    let sum_i32 = sum.clone() + "<i32>";
    let dyn_sum_i32 = "dyn ".to_string() + &*sum_i32;
    assert_min(&ac, 1, 12, ac.probe_path(&sum));
    assert_min(&ac, 1, 12, ac.probe_trait(&sum));
    assert_min(&ac, 1, 12, ac.probe_trait(&sum_i32));
    assert_min(&ac, 1, 12, ac.probe_type(&sum_i32));
    assert_min(&ac, 1, 27, ac.probe_type(&dyn_sum_i32));
}

#[test]
fn probe_std() {
    let ac = autocfg_for_test();
    assert_std(&ac, ac.probe_sysroot_crate("std"));
}

#[test]
fn probe_alloc() {
    let ac = autocfg_for_test();
    assert_min(&ac, 1, 36, ac.probe_sysroot_crate("alloc"));
}

#[test]
fn probe_bad_sysroot_crate() {
    let ac = autocfg_for_test();
    assert!(!ac.probe_sysroot_crate("doesnt_exist"));
}

#[test]
fn probe_no_std() {
    let ac = autocfg_for_test();
    assert!(ac.probe_type("i32"));
    assert!(ac.probe_type("[i32]"));
    assert_std(&ac, ac.probe_type("Vec<i32>"));
}

#[test]
fn probe_expression() {
    let ac = autocfg_for_test();
    assert!(ac.probe_expression(r#""test".trim_left()"#));
    assert_min(&ac, 1, 30, ac.probe_expression(r#""test".trim_start()"#));
    assert_std(&ac, ac.probe_expression("[1, 2, 3].to_vec()"));
}

#[test]
fn probe_constant() {
    let ac = autocfg_for_test();
    assert!(ac.probe_constant("1 + 2 + 3"));
    assert_min(
        &ac,
        1,
        33,
        ac.probe_constant("{ let x = 1 + 2 + 3; x * x }"),
    );
    assert_min(&ac, 1, 39, ac.probe_constant(r#""test".len()"#));
}

#[test]
fn probe_raw() {
    let ac = autocfg_for_test();
    let prefix = if ac.no_std() { "#![no_std]\n" } else { "" };
    let f = |s| format!("{}{}", prefix, s);

    // This attribute **must** be used at the crate level.
    assert!(ac.probe_raw(&f("#![no_builtins]")).is_ok());

    assert!(ac.probe_raw(&f("#![deny(dead_code)] fn x() {}")).is_err());
    assert!(ac.probe_raw(&f("#![allow(dead_code)] fn x() {}")).is_ok());
    assert!(ac
        .probe_raw(&f("#![deny(dead_code)] pub fn x() {}"))
        .is_ok());
}

#[test]
fn probe_cleanup() {
    let dir = support::out_dir().join("autocfg_test_probe_cleanup");
    std::fs::create_dir(&dir).unwrap();

    let ac = AutoCfg::with_dir(&dir).unwrap();
    assert!(ac.probe_type("i32"));

    // NB: this is not `remove_dir_all`, so it will only work if the directory
    // is empty -- i.e. the probe should have removed any output files.
    std::fs::remove_dir(&dir).unwrap();
}

#[test]
fn editions() {
    let mut ac = autocfg_for_test();
    assert!(ac.edition().is_none());
    assert!(ac.probe_raw("").is_ok());

    for (edition, minor) in vec![(2015, 27), (2018, 31), (2021, 56), (2024, 85)] {
        let edition = edition.to_string();
        ac.set_edition(Some(edition.clone()));
        assert_eq!(ac.edition(), Some(&*edition));
        assert_min(&ac, 1, minor, ac.probe_raw("").is_ok());
    }

    ac.set_edition(Some("invalid".into()));
    assert_eq!(ac.edition(), Some("invalid"));
    assert!(ac.probe_raw("").is_err());

    ac.set_edition(None);
    assert!(ac.edition().is_none());
    assert!(ac.probe_raw("").is_ok());
}

#[test]
fn edition_keyword_try() {
    let mut ac = autocfg_for_test();

    if ac.probe_rustc_version(1, 27) {
        ac.set_edition(Some(2015.to_string()));
    }
    assert!(ac.probe_expression("{ let try = 0; try }"));

    if ac.probe_rustc_version(1, 31) {
        ac.set_edition(Some(2018.to_string()));
        assert!(!ac.probe_expression("{ let try = 0; try }"));
        assert!(ac.probe_expression("{ let r#try = 0; r#try }"));
    }
}