rustc_attr_parsing/
session_diagnostics.rs

1use std::num::IntErrorKind;
2
3use rustc_ast as ast;
4use rustc_errors::codes::*;
5use rustc_errors::{
6    Applicability, Diag, DiagArgValue, DiagCtxtHandle, Diagnostic, EmissionGuarantee, Level,
7};
8use rustc_feature::AttributeTemplate;
9use rustc_hir::AttrPath;
10use rustc_macros::{Diagnostic, LintDiagnostic, Subdiagnostic};
11use rustc_span::{Span, Symbol};
12
13use crate::fluent_generated as fluent;
14
15pub(crate) enum UnsupportedLiteralReason {
16    Generic,
17    CfgString,
18    CfgBoolean,
19}
20
21#[derive(Diagnostic)]
22#[diag(attr_parsing_expected_one_cfg_pattern, code = E0536)]
23pub(crate) struct ExpectedOneCfgPattern {
24    #[primary_span]
25    pub span: Span,
26}
27
28#[derive(Diagnostic)]
29#[diag(attr_parsing_invalid_predicate, code = E0537)]
30pub(crate) struct InvalidPredicate {
31    #[primary_span]
32    pub span: Span,
33
34    pub predicate: String,
35}
36
37/// Error code: E0541
38pub(crate) struct UnknownMetaItem<'a> {
39    pub span: Span,
40    pub item: String,
41    pub expected: &'a [&'a str],
42}
43
44// Manual implementation to be able to format `expected` items correctly.
45impl<'a, G: EmissionGuarantee> Diagnostic<'a, G> for UnknownMetaItem<'_> {
46    fn into_diag(self, dcx: DiagCtxtHandle<'a>, level: Level) -> Diag<'a, G> {
47        let expected = self.expected.iter().map(|name| format!("`{name}`")).collect::<Vec<_>>();
48        Diag::new(dcx, level, fluent::attr_parsing_unknown_meta_item)
49            .with_span(self.span)
50            .with_code(E0541)
51            .with_arg("item", self.item)
52            .with_arg("expected", expected.join(", "))
53            .with_span_label(self.span, fluent::attr_parsing_label)
54    }
55}
56
57#[derive(Diagnostic)]
58#[diag(attr_parsing_missing_since, code = E0542)]
59pub(crate) struct MissingSince {
60    #[primary_span]
61    pub span: Span,
62}
63
64#[derive(Diagnostic)]
65#[diag(attr_parsing_missing_note, code = E0543)]
66pub(crate) struct MissingNote {
67    #[primary_span]
68    pub span: Span,
69}
70
71#[derive(Diagnostic)]
72#[diag(attr_parsing_multiple_stability_levels, code = E0544)]
73pub(crate) struct MultipleStabilityLevels {
74    #[primary_span]
75    pub span: Span,
76}
77
78#[derive(Diagnostic)]
79#[diag(attr_parsing_invalid_issue_string, code = E0545)]
80pub(crate) struct InvalidIssueString {
81    #[primary_span]
82    pub span: Span,
83
84    #[subdiagnostic]
85    pub cause: Option<InvalidIssueStringCause>,
86}
87
88// The error kinds of `IntErrorKind` are duplicated here in order to allow the messages to be
89// translatable.
90#[derive(Subdiagnostic)]
91pub(crate) enum InvalidIssueStringCause {
92    #[label(attr_parsing_must_not_be_zero)]
93    MustNotBeZero {
94        #[primary_span]
95        span: Span,
96    },
97
98    #[label(attr_parsing_empty)]
99    Empty {
100        #[primary_span]
101        span: Span,
102    },
103
104    #[label(attr_parsing_invalid_digit)]
105    InvalidDigit {
106        #[primary_span]
107        span: Span,
108    },
109
110    #[label(attr_parsing_pos_overflow)]
111    PosOverflow {
112        #[primary_span]
113        span: Span,
114    },
115
116    #[label(attr_parsing_neg_overflow)]
117    NegOverflow {
118        #[primary_span]
119        span: Span,
120    },
121}
122
123impl InvalidIssueStringCause {
124    pub(crate) fn from_int_error_kind(span: Span, kind: &IntErrorKind) -> Option<Self> {
125        match kind {
126            IntErrorKind::Empty => Some(Self::Empty { span }),
127            IntErrorKind::InvalidDigit => Some(Self::InvalidDigit { span }),
128            IntErrorKind::PosOverflow => Some(Self::PosOverflow { span }),
129            IntErrorKind::NegOverflow => Some(Self::NegOverflow { span }),
130            IntErrorKind::Zero => Some(Self::MustNotBeZero { span }),
131            _ => None,
132        }
133    }
134}
135
136#[derive(Diagnostic)]
137#[diag(attr_parsing_missing_feature, code = E0546)]
138pub(crate) struct MissingFeature {
139    #[primary_span]
140    pub span: Span,
141}
142
143#[derive(Diagnostic)]
144#[diag(attr_parsing_non_ident_feature, code = E0546)]
145pub(crate) struct NonIdentFeature {
146    #[primary_span]
147    pub span: Span,
148}
149
150#[derive(Diagnostic)]
151#[diag(attr_parsing_missing_issue, code = E0547)]
152pub(crate) struct MissingIssue {
153    #[primary_span]
154    pub span: Span,
155}
156
157// FIXME: Why is this the same error code as `InvalidReprHintNoParen` and `InvalidReprHintNoValue`?
158// It is more similar to `IncorrectReprFormatGeneric`.
159#[derive(Diagnostic)]
160#[diag(attr_parsing_incorrect_repr_format_packed_one_or_zero_arg, code = E0552)]
161pub(crate) struct IncorrectReprFormatPackedOneOrZeroArg {
162    #[primary_span]
163    pub span: Span,
164}
165#[derive(Diagnostic)]
166#[diag(attr_parsing_incorrect_repr_format_packed_expect_integer, code = E0552)]
167pub(crate) struct IncorrectReprFormatPackedExpectInteger {
168    #[primary_span]
169    pub span: Span,
170}
171
172#[derive(Diagnostic)]
173#[diag(attr_parsing_invalid_repr_hint_no_paren, code = E0552)]
174pub(crate) struct InvalidReprHintNoParen {
175    #[primary_span]
176    pub span: Span,
177
178    pub name: Symbol,
179}
180
181#[derive(Diagnostic)]
182#[diag(attr_parsing_invalid_repr_hint_no_value, code = E0552)]
183pub(crate) struct InvalidReprHintNoValue {
184    #[primary_span]
185    pub span: Span,
186
187    pub name: Symbol,
188}
189
190/// Error code: E0565
191// FIXME(jdonszelmann): slowly phased out
192pub(crate) struct UnsupportedLiteral {
193    pub span: Span,
194    pub reason: UnsupportedLiteralReason,
195    pub is_bytestr: bool,
196    pub start_point_span: Span,
197}
198
199impl<'a, G: EmissionGuarantee> Diagnostic<'a, G> for UnsupportedLiteral {
200    fn into_diag(self, dcx: DiagCtxtHandle<'a>, level: Level) -> Diag<'a, G> {
201        let mut diag = Diag::new(
202            dcx,
203            level,
204            match self.reason {
205                UnsupportedLiteralReason::Generic => {
206                    fluent::attr_parsing_unsupported_literal_generic
207                }
208                UnsupportedLiteralReason::CfgString => {
209                    fluent::attr_parsing_unsupported_literal_cfg_string
210                }
211                UnsupportedLiteralReason::CfgBoolean => {
212                    fluent::attr_parsing_unsupported_literal_cfg_boolean
213                }
214            },
215        );
216        diag.span(self.span);
217        diag.code(E0565);
218        if self.is_bytestr {
219            diag.span_suggestion(
220                self.start_point_span,
221                fluent::attr_parsing_unsupported_literal_suggestion,
222                "",
223                Applicability::MaybeIncorrect,
224            );
225        }
226        diag
227    }
228}
229
230#[derive(Diagnostic)]
231#[diag(attr_parsing_invalid_repr_align_need_arg, code = E0589)]
232pub(crate) struct InvalidReprAlignNeedArg {
233    #[primary_span]
234    #[suggestion(code = "align(...)", applicability = "has-placeholders")]
235    pub span: Span,
236}
237
238#[derive(Diagnostic)]
239#[diag(attr_parsing_invalid_repr_generic, code = E0589)]
240pub(crate) struct InvalidReprGeneric<'a> {
241    #[primary_span]
242    pub span: Span,
243
244    pub repr_arg: String,
245    pub error_part: &'a str,
246}
247
248#[derive(Diagnostic)]
249#[diag(attr_parsing_incorrect_repr_format_align_one_arg, code = E0693)]
250pub(crate) struct IncorrectReprFormatAlignOneArg {
251    #[primary_span]
252    pub span: Span,
253}
254
255#[derive(Diagnostic)]
256#[diag(attr_parsing_incorrect_repr_format_expect_literal_integer, code = E0693)]
257pub(crate) struct IncorrectReprFormatExpectInteger {
258    #[primary_span]
259    pub span: Span,
260}
261
262#[derive(Diagnostic)]
263#[diag(attr_parsing_incorrect_repr_format_generic, code = E0693)]
264pub(crate) struct IncorrectReprFormatGeneric {
265    #[primary_span]
266    pub span: Span,
267
268    pub repr_arg: Symbol,
269
270    #[subdiagnostic]
271    pub cause: Option<IncorrectReprFormatGenericCause>,
272}
273
274#[derive(Subdiagnostic)]
275pub(crate) enum IncorrectReprFormatGenericCause {
276    #[suggestion(
277        attr_parsing_suggestion,
278        code = "{name}({value})",
279        applicability = "machine-applicable"
280    )]
281    Int {
282        #[primary_span]
283        span: Span,
284
285        #[skip_arg]
286        name: Symbol,
287
288        #[skip_arg]
289        value: u128,
290    },
291
292    #[suggestion(
293        attr_parsing_suggestion,
294        code = "{name}({value})",
295        applicability = "machine-applicable"
296    )]
297    Symbol {
298        #[primary_span]
299        span: Span,
300
301        #[skip_arg]
302        name: Symbol,
303
304        #[skip_arg]
305        value: Symbol,
306    },
307}
308
309impl IncorrectReprFormatGenericCause {
310    pub(crate) fn from_lit_kind(span: Span, kind: &ast::LitKind, name: Symbol) -> Option<Self> {
311        match *kind {
312            ast::LitKind::Int(value, ast::LitIntType::Unsuffixed) => {
313                Some(Self::Int { span, name, value: value.get() })
314            }
315            ast::LitKind::Str(value, _) => Some(Self::Symbol { span, name, value }),
316            _ => None,
317        }
318    }
319}
320
321#[derive(Diagnostic)]
322#[diag(attr_parsing_rustc_promotable_pairing, code = E0717)]
323pub(crate) struct RustcPromotablePairing {
324    #[primary_span]
325    pub span: Span,
326}
327
328#[derive(Diagnostic)]
329#[diag(attr_parsing_rustc_allowed_unstable_pairing, code = E0789)]
330pub(crate) struct RustcAllowedUnstablePairing {
331    #[primary_span]
332    pub span: Span,
333}
334
335#[derive(Diagnostic)]
336#[diag(attr_parsing_cfg_predicate_identifier)]
337pub(crate) struct CfgPredicateIdentifier {
338    #[primary_span]
339    pub span: Span,
340}
341
342#[derive(Diagnostic)]
343#[diag(attr_parsing_deprecated_item_suggestion)]
344pub(crate) struct DeprecatedItemSuggestion {
345    #[primary_span]
346    pub span: Span,
347
348    #[help]
349    pub is_nightly: bool,
350
351    #[note]
352    pub details: (),
353}
354
355#[derive(Diagnostic)]
356#[diag(attr_parsing_expected_single_version_literal)]
357pub(crate) struct ExpectedSingleVersionLiteral {
358    #[primary_span]
359    pub span: Span,
360}
361
362#[derive(Diagnostic)]
363#[diag(attr_parsing_expected_version_literal)]
364pub(crate) struct ExpectedVersionLiteral {
365    #[primary_span]
366    pub span: Span,
367}
368
369#[derive(Diagnostic)]
370#[diag(attr_parsing_expects_feature_list)]
371pub(crate) struct ExpectsFeatureList {
372    #[primary_span]
373    pub span: Span,
374
375    pub name: String,
376}
377
378#[derive(Diagnostic)]
379#[diag(attr_parsing_expects_features)]
380pub(crate) struct ExpectsFeatures {
381    #[primary_span]
382    pub span: Span,
383
384    pub name: String,
385}
386
387#[derive(Diagnostic)]
388#[diag(attr_parsing_invalid_since)]
389pub(crate) struct InvalidSince {
390    #[primary_span]
391    pub span: Span,
392}
393
394#[derive(Diagnostic)]
395#[diag(attr_parsing_soft_no_args)]
396pub(crate) struct SoftNoArgs {
397    #[primary_span]
398    pub span: Span,
399}
400
401#[derive(Diagnostic)]
402#[diag(attr_parsing_unknown_version_literal)]
403pub(crate) struct UnknownVersionLiteral {
404    #[primary_span]
405    pub span: Span,
406}
407
408// FIXME(jdonszelmann) duplicated from `rustc_passes`, remove once `check_attr` is integrated.
409#[derive(Diagnostic)]
410#[diag(attr_parsing_unused_multiple)]
411pub(crate) struct UnusedMultiple {
412    #[primary_span]
413    #[suggestion(code = "", applicability = "machine-applicable")]
414    pub this: Span,
415    #[note]
416    pub other: Span,
417    pub name: Symbol,
418}
419
420#[derive(LintDiagnostic)]
421#[diag(attr_parsing_unused_duplicate)]
422pub(crate) struct UnusedDuplicate {
423    #[suggestion(code = "", applicability = "machine-applicable")]
424    pub this: Span,
425    #[note]
426    pub other: Span,
427    #[warning]
428    pub warning: bool,
429}
430
431// FIXME(jdonszelmann): duplicated in rustc_lints, should be moved here completely.
432#[derive(LintDiagnostic)]
433#[diag(attr_parsing_ill_formed_attribute_input)]
434pub(crate) struct IllFormedAttributeInput {
435    pub num_suggestions: usize,
436    pub suggestions: DiagArgValue,
437}
438
439#[derive(Diagnostic)]
440#[diag(attr_parsing_ill_formed_attribute_input)]
441pub(crate) struct MustUseIllFormedAttributeInput {
442    #[primary_span]
443    pub span: Span,
444    pub num_suggestions: usize,
445    pub suggestions: DiagArgValue,
446}
447
448#[derive(Diagnostic)]
449#[diag(attr_parsing_null_on_export, code = E0648)]
450pub(crate) struct NullOnExport {
451    #[primary_span]
452    pub span: Span,
453}
454
455#[derive(Diagnostic)]
456#[diag(attr_parsing_null_on_link_section, code = E0648)]
457pub(crate) struct NullOnLinkSection {
458    #[primary_span]
459    pub span: Span,
460}
461
462#[derive(Diagnostic)]
463#[diag(attr_parsing_stability_outside_std, code = E0734)]
464pub(crate) struct StabilityOutsideStd {
465    #[primary_span]
466    pub span: Span,
467}
468
469#[derive(Diagnostic)]
470#[diag(attr_parsing_empty_confusables)]
471pub(crate) struct EmptyConfusables {
472    #[primary_span]
473    pub span: Span,
474}
475
476#[derive(LintDiagnostic)]
477#[diag(attr_parsing_empty_attribute)]
478pub(crate) struct EmptyAttributeList {
479    #[suggestion(code = "", applicability = "machine-applicable")]
480    pub attr_span: Span,
481}
482
483#[derive(Diagnostic)]
484#[diag(attr_parsing_invalid_alignment_value, code = E0589)]
485pub(crate) struct InvalidAlignmentValue {
486    #[primary_span]
487    pub span: Span,
488    pub error_part: &'static str,
489}
490
491#[derive(Diagnostic)]
492#[diag(attr_parsing_repr_ident, code = E0565)]
493pub(crate) struct ReprIdent {
494    #[primary_span]
495    pub span: Span,
496}
497
498#[derive(Diagnostic)]
499#[diag(attr_parsing_unrecognized_repr_hint, code = E0552)]
500#[help]
501pub(crate) struct UnrecognizedReprHint {
502    #[primary_span]
503    pub span: Span,
504}
505
506#[derive(Diagnostic)]
507#[diag(attr_parsing_naked_functions_incompatible_attribute, code = E0736)]
508pub(crate) struct NakedFunctionIncompatibleAttribute {
509    #[primary_span]
510    #[label]
511    pub span: Span,
512    #[label(attr_parsing_naked_attribute)]
513    pub naked_span: Span,
514    pub attr: String,
515}
516
517pub(crate) enum AttributeParseErrorReason {
518    ExpectedNoArgs,
519    ExpectedStringLiteral { byte_string: Option<Span> },
520    ExpectedIntegerLiteral,
521    ExpectedAtLeastOneArgument,
522    ExpectedSingleArgument,
523    ExpectedList,
524    UnexpectedLiteral,
525    ExpectedNameValue(Option<Symbol>),
526    DuplicateKey(Symbol),
527    ExpectedSpecificArgument { possibilities: Vec<&'static str>, strings: bool },
528}
529
530pub(crate) struct AttributeParseError {
531    pub(crate) span: Span,
532    pub(crate) attr_span: Span,
533    pub(crate) template: AttributeTemplate,
534    pub(crate) attribute: AttrPath,
535    pub(crate) reason: AttributeParseErrorReason,
536}
537
538impl<'a, G: EmissionGuarantee> Diagnostic<'a, G> for AttributeParseError {
539    fn into_diag(self, dcx: DiagCtxtHandle<'a>, level: Level) -> Diag<'a, G> {
540        let name = self.attribute.to_string();
541
542        let mut diag = Diag::new(dcx, level, format!("malformed `{name}` attribute input"));
543        diag.span(self.attr_span);
544        diag.code(E0539);
545        match self.reason {
546            AttributeParseErrorReason::ExpectedStringLiteral { byte_string } => {
547                if let Some(start_point_span) = byte_string {
548                    diag.span_suggestion(
549                        start_point_span,
550                        fluent::attr_parsing_unsupported_literal_suggestion,
551                        "",
552                        Applicability::MaybeIncorrect,
553                    );
554                    diag.note("expected a normal string literal, not a byte string literal");
555
556                    return diag;
557                } else {
558                    diag.span_label(self.span, "expected a string literal here");
559                }
560            }
561            AttributeParseErrorReason::ExpectedIntegerLiteral => {
562                diag.span_label(self.span, "expected an integer literal here");
563            }
564            AttributeParseErrorReason::ExpectedSingleArgument => {
565                diag.span_label(self.span, "expected a single argument here");
566                diag.code(E0805);
567            }
568            AttributeParseErrorReason::ExpectedAtLeastOneArgument => {
569                diag.span_label(self.span, "expected at least 1 argument here");
570            }
571            AttributeParseErrorReason::ExpectedList => {
572                diag.span_label(self.span, "expected this to be a list");
573            }
574            AttributeParseErrorReason::DuplicateKey(key) => {
575                diag.span_label(self.span, format!("found `{key}` used as a key more than once"));
576                diag.code(E0538);
577            }
578            AttributeParseErrorReason::UnexpectedLiteral => {
579                diag.span_label(self.span, format!("didn't expect a literal here"));
580                diag.code(E0565);
581            }
582            AttributeParseErrorReason::ExpectedNoArgs => {
583                diag.span_label(self.span, format!("didn't expect any arguments here"));
584                diag.code(E0565);
585            }
586            AttributeParseErrorReason::ExpectedNameValue(None) => {
587                // The suggestion we add below this match already contains enough information
588            }
589            AttributeParseErrorReason::ExpectedNameValue(Some(name)) => {
590                diag.span_label(
591                    self.span,
592                    format!("expected this to be of the form `{name} = \"...\"`"),
593                );
594            }
595            AttributeParseErrorReason::ExpectedSpecificArgument { possibilities, strings } => {
596                let quote = if strings { '"' } else { '`' };
597                match possibilities.as_slice() {
598                    &[] => {}
599                    &[x] => {
600                        diag.span_label(
601                            self.span,
602                            format!("the only valid argument here is {quote}{x}{quote}"),
603                        );
604                    }
605                    [first, second] => {
606                        diag.span_label(self.span, format!("valid arguments are {quote}{first}{quote} or {quote}{second}{quote}"));
607                    }
608                    [first @ .., second_to_last, last] => {
609                        let mut res = String::new();
610                        for i in first {
611                            res.push_str(&format!("{quote}{i}{quote}, "));
612                        }
613                        res.push_str(&format!(
614                            "{quote}{second_to_last}{quote} or {quote}{last}{quote}"
615                        ));
616
617                        diag.span_label(self.span, format!("valid arguments are {res}"));
618                    }
619                }
620            }
621        }
622
623        let suggestions = self.template.suggestions(false, &name);
624        diag.span_suggestions(
625            self.attr_span,
626            if suggestions.len() == 1 {
627                "must be of the form"
628            } else {
629                "try changing it to one of the following valid forms of the attribute"
630            },
631            suggestions,
632            Applicability::HasPlaceholders,
633        );
634
635        diag
636    }
637}
rustc_attr_parsing/session_diagnostics.rs

rustc_attr_parsing/
session_diagnostics.rs
