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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
use rustc_errors::{Applicability, Diag};
use rustc_middle::bug;
use rustc_session::{config::ExpectedValues, Session};
use rustc_span::edit_distance::find_best_match_for_name;
use rustc_span::{sym, Span, Symbol};

const MAX_CHECK_CFG_NAMES_OR_VALUES: usize = 35;

fn check_cfg_expected_note(
    sess: &Session,
    possibilities: &[Symbol],
    type_: &str,
    name: Option<Symbol>,
    suffix: &str,
) -> String {
    use std::fmt::Write;

    let n_possibilities = if sess.opts.unstable_opts.check_cfg_all_expected {
        possibilities.len()
    } else {
        std::cmp::min(possibilities.len(), MAX_CHECK_CFG_NAMES_OR_VALUES)
    };

    let mut possibilities = possibilities.iter().map(Symbol::as_str).collect::<Vec<_>>();
    possibilities.sort();

    let and_more = possibilities.len().saturating_sub(n_possibilities);
    let possibilities = possibilities[..n_possibilities].join("`, `");

    let mut note = String::with_capacity(50 + possibilities.len());

    write!(&mut note, "expected {type_}").unwrap();
    if let Some(name) = name {
        write!(&mut note, " for `{name}`").unwrap();
    }
    write!(&mut note, " are: {suffix}`{possibilities}`").unwrap();
    if and_more > 0 {
        write!(&mut note, " and {and_more} more").unwrap();
    }

    note
}

pub(super) fn unexpected_cfg_name(
    sess: &Session,
    diag: &mut Diag<'_, ()>,
    (name, name_span): (Symbol, Span),
    value: Option<(Symbol, Span)>,
) {
    #[allow(rustc::potential_query_instability)]
    let possibilities: Vec<Symbol> = sess.psess.check_config.expecteds.keys().copied().collect();

    let mut names_possibilities: Vec<_> = if value.is_none() {
        // We later sort and display all the possibilities, so the order here does not matter.
        #[allow(rustc::potential_query_instability)]
        sess.psess
            .check_config
            .expecteds
            .iter()
            .filter_map(|(k, v)| match v {
                ExpectedValues::Some(v) if v.contains(&Some(name)) => Some(k),
                _ => None,
            })
            .collect()
    } else {
        Vec::new()
    };

    let is_from_cargo = rustc_session::utils::was_invoked_from_cargo();
    let mut is_feature_cfg = name == sym::feature;

    if is_feature_cfg && is_from_cargo {
        diag.help("consider defining some features in `Cargo.toml`");
    // Suggest the most probable if we found one
    } else if let Some(best_match) = find_best_match_for_name(&possibilities, name, None) {
        if let Some(ExpectedValues::Some(best_match_values)) =
            sess.psess.check_config.expecteds.get(&best_match)
        {
            // We will soon sort, so the initial order does not matter.
            #[allow(rustc::potential_query_instability)]
            let mut possibilities =
                best_match_values.iter().flatten().map(Symbol::as_str).collect::<Vec<_>>();
            possibilities.sort();

            let mut should_print_possibilities = true;
            if let Some((value, value_span)) = value {
                if best_match_values.contains(&Some(value)) {
                    diag.span_suggestion(
                        name_span,
                        "there is a config with a similar name and value",
                        best_match,
                        Applicability::MaybeIncorrect,
                    );
                    should_print_possibilities = false;
                } else if best_match_values.contains(&None) {
                    diag.span_suggestion(
                        name_span.to(value_span),
                        "there is a config with a similar name and no value",
                        best_match,
                        Applicability::MaybeIncorrect,
                    );
                    should_print_possibilities = false;
                } else if let Some(first_value) = possibilities.first() {
                    diag.span_suggestion(
                        name_span.to(value_span),
                        "there is a config with a similar name and different values",
                        format!("{best_match} = \"{first_value}\""),
                        Applicability::MaybeIncorrect,
                    );
                } else {
                    diag.span_suggestion(
                        name_span.to(value_span),
                        "there is a config with a similar name and different values",
                        best_match,
                        Applicability::MaybeIncorrect,
                    );
                };
            } else {
                diag.span_suggestion(
                    name_span,
                    "there is a config with a similar name",
                    best_match,
                    Applicability::MaybeIncorrect,
                );
            }

            if !possibilities.is_empty() && should_print_possibilities {
                let possibilities = possibilities.join("`, `");
                diag.help(format!("expected values for `{best_match}` are: `{possibilities}`"));
            }
        } else {
            diag.span_suggestion(
                name_span,
                "there is a config with a similar name",
                best_match,
                Applicability::MaybeIncorrect,
            );
        }

        is_feature_cfg |= best_match == sym::feature;
    } else {
        if !names_possibilities.is_empty() && names_possibilities.len() <= 3 {
            names_possibilities.sort();
            for cfg_name in names_possibilities.iter() {
                diag.span_suggestion(
                    name_span,
                    "found config with similar value",
                    format!("{cfg_name} = \"{name}\""),
                    Applicability::MaybeIncorrect,
                );
            }
        }
        if !possibilities.is_empty() {
            diag.help_once(check_cfg_expected_note(sess, &possibilities, "names", None, ""));
        }
    }

    let inst = if let Some((value, _value_span)) = value {
        let pre = if is_from_cargo { "\\" } else { "" };
        format!("cfg({name}, values({pre}\"{value}{pre}\"))")
    } else {
        format!("cfg({name})")
    };

    if is_from_cargo {
        if !is_feature_cfg {
            diag.help(format!("consider using a Cargo feature instead or adding `println!(\"cargo::rustc-check-cfg={inst}\");` to the top of the `build.rs`"));
        }
        diag.note("see <https://doc.rust-lang.org/nightly/cargo/reference/build-scripts.html#rustc-check-cfg> for more information about checking conditional configuration");
    } else {
        diag.help(format!("to expect this configuration use `--check-cfg={inst}`"));
        diag.note("see <https://doc.rust-lang.org/nightly/rustc/check-cfg.html> for more information about checking conditional configuration");
    }
}

pub(super) fn unexpected_cfg_value(
    sess: &Session,
    diag: &mut Diag<'_, ()>,
    (name, name_span): (Symbol, Span),
    value: Option<(Symbol, Span)>,
) {
    let Some(ExpectedValues::Some(values)) = &sess.psess.check_config.expecteds.get(&name) else {
        bug!(
            "it shouldn't be possible to have a diagnostic on a value whose name is not in values"
        );
    };
    let mut have_none_possibility = false;
    // We later sort possibilities if it is not empty, so the
    // order here does not matter.
    #[allow(rustc::potential_query_instability)]
    let possibilities: Vec<Symbol> = values
        .iter()
        .inspect(|a| have_none_possibility |= a.is_none())
        .copied()
        .flatten()
        .collect();
    let is_from_cargo = rustc_session::utils::was_invoked_from_cargo();

    // Show the full list if all possible values for a given name, but don't do it
    // for names as the possibilities could be very long
    if !possibilities.is_empty() {
        diag.note(check_cfg_expected_note(
            sess,
            &possibilities,
            "values",
            Some(name),
            if have_none_possibility { "(none), " } else { "" },
        ));

        if let Some((value, value_span)) = value {
            // Suggest the most probable if we found one
            if let Some(best_match) = find_best_match_for_name(&possibilities, value, None) {
                diag.span_suggestion(
                    value_span,
                    "there is a expected value with a similar name",
                    format!("\"{best_match}\""),
                    Applicability::MaybeIncorrect,
                );
            }
        } else if let &[first_possibility] = &possibilities[..] {
            diag.span_suggestion(
                name_span.shrink_to_hi(),
                "specify a config value",
                format!(" = \"{first_possibility}\""),
                Applicability::MaybeIncorrect,
            );
        }
    } else if have_none_possibility {
        diag.note(format!("no expected value for `{name}`"));
        if let Some((_value, value_span)) = value {
            diag.span_suggestion(
                name_span.shrink_to_hi().to(value_span),
                "remove the value",
                "",
                Applicability::MaybeIncorrect,
            );
        }
    } else {
        diag.note(format!("no expected values for `{name}`"));

        let sp = if let Some((_value, value_span)) = value {
            name_span.to(value_span)
        } else {
            name_span
        };
        diag.span_suggestion(sp, "remove the condition", "", Applicability::MaybeIncorrect);
    }

    // We don't want to suggest adding values to well known names
    // since those are defined by rustc it-self. Users can still
    // do it if they want, but should not encourage them.
    let is_cfg_a_well_know_name = sess.psess.check_config.well_known_names.contains(&name);

    let inst = if let Some((value, _value_span)) = value {
        let pre = if is_from_cargo { "\\" } else { "" };
        format!("cfg({name}, values({pre}\"{value}{pre}\"))")
    } else {
        format!("cfg({name})")
    };

    if is_from_cargo {
        if name == sym::feature {
            if let Some((value, _value_span)) = value {
                diag.help(format!("consider adding `{value}` as a feature in `Cargo.toml`"));
            } else {
                diag.help("consider defining some features in `Cargo.toml`");
            }
        } else if !is_cfg_a_well_know_name {
            diag.help(format!("consider using a Cargo feature instead or adding `println!(\"cargo::rustc-check-cfg={inst}\");` to the top of the `build.rs`"));
        }
        diag.note("see <https://doc.rust-lang.org/nightly/cargo/reference/build-scripts.html#rustc-check-cfg> for more information about checking conditional configuration");
    } else {
        if !is_cfg_a_well_know_name {
            diag.help(format!("to expect this configuration use `--check-cfg={inst}`"));
        }
        diag.note("see <https://doc.rust-lang.org/nightly/rustc/check-cfg.html> for more information about checking conditional configuration");
    }
}