Implement IntoDiagnosticArg for rustc_ast::token::Token(Kind)

Xiretza · Xiretza · commit d7c64574e03f · 2022-09-27T20:29:19.000+02:00
diff --git a/compiler/rustc_error_messages/locales/en-US/parser.ftl b/compiler/rustc_error_messages/locales/en-US/parser.ftl
@@ -291,11 +291,11 @@ parser_inner_doc_comment_not_permitted = expected outer doc comment
     .label_does_not_annotate_this = the inner doc comment doesn't annotate this {$item}
     .sugg_change_inner_to_outer = to annotate the {$item}, change the doc comment from inner to outer style
 
-parser_expected_identifier_found_reserved_identifier_str = expected identifier, found reserved identifier `{$token_str}`
-parser_expected_identifier_found_keyword_str = expected identifier, found keyword `{$token_str}`
-parser_expected_identifier_found_reserved_keyword_str = expected identifier, found reserved keyword `{$token_str}`
-parser_expected_identifier_found_doc_comment_str = expected identifier, found doc comment `{$token_str}`
-parser_expected_identifier_found_str = expected identifier, found `{$token_str}`
+parser_expected_identifier_found_reserved_identifier_str = expected identifier, found reserved identifier `{$token}`
+parser_expected_identifier_found_keyword_str = expected identifier, found keyword `{$token}`
+parser_expected_identifier_found_reserved_keyword_str = expected identifier, found reserved keyword `{$token}`
+parser_expected_identifier_found_doc_comment_str = expected identifier, found doc comment `{$token}`
+parser_expected_identifier_found_str = expected identifier, found `{$token}`
 
 parser_expected_identifier_found_reserved_identifier = expected identifier, found reserved identifier
 parser_expected_identifier_found_keyword = expected identifier, found keyword
@@ -307,11 +307,11 @@ parser_sugg_escape_to_use_as_identifier = escape `{$ident_name}` to use it as an
 
 parser_sugg_remove_comma = remove this comma
 
-parser_expected_semi_found_reserved_identifier_str = expected `;`, found reserved identifier `{$token_str}`
-parser_expected_semi_found_keyword_str = expected `;`, found keyword `{$token_str}`
-parser_expected_semi_found_reserved_keyword_str = expected `;`, found reserved keyword `{$token_str}`
-parser_expected_semi_found_doc_comment_str = expected `;`, found doc comment `{$token_str}`
-parser_expected_semi_found_str = expected `;`, found `{$token_str}`
+parser_expected_semi_found_reserved_identifier_str = expected `;`, found reserved identifier `{$token}`
+parser_expected_semi_found_keyword_str = expected `;`, found keyword `{$token}`
+parser_expected_semi_found_reserved_keyword_str = expected `;`, found reserved keyword `{$token}`
+parser_expected_semi_found_doc_comment_str = expected `;`, found doc comment `{$token}`
+parser_expected_semi_found_str = expected `;`, found `{$token}`
 
 parser_sugg_change_this_to_semi = change this to `;`
 parser_sugg_add_semi = add `;` here
diff --git a/compiler/rustc_errors/src/diagnostic.rs b/compiler/rustc_errors/src/diagnostic.rs
@@ -183,6 +183,18 @@ impl IntoDiagnosticArg for ast::Path {
     }
 }
 
+impl IntoDiagnosticArg for ast::token::Token {
+    fn into_diagnostic_arg(self) -> DiagnosticArgValue<'static> {
+        DiagnosticArgValue::Str(pprust::token_to_string(&self))
+    }
+}
+
+impl IntoDiagnosticArg for ast::token::TokenKind {
+    fn into_diagnostic_arg(self) -> DiagnosticArgValue<'static> {
+        DiagnosticArgValue::Str(pprust::token_kind_to_string(&self))
+    }
+}
+
 /// Trait implemented by error types. This should not be implemented manually. Instead, use
 /// `#[derive(Subdiagnostic)]` -- see [rustc_macros::Subdiagnostic].
 #[cfg_attr(bootstrap, rustc_diagnostic_item = "AddSubdiagnostic")]
diff --git a/compiler/rustc_parse/src/errors.rs b/compiler/rustc_parse/src/errors.rs
@@ -1,11 +1,12 @@
+use rustc_ast::token::Token;
 use rustc_ast::Path;
 use rustc_errors::{fluent, AddToDiagnostic, Applicability, EmissionGuarantee, IntoDiagnostic};
 use rustc_macros::{Diagnostic, Subdiagnostic};
 use rustc_session::errors::ExprParenthesesNeeded;
 use rustc_span::symbol::Ident;
 use rustc_span::{Span, Symbol};
 
-use crate::parser::{TokenDescription, TokenDescriptionKind};
+use crate::parser::TokenDescription;
 
 #[derive(Diagnostic)]
 #[diag(parser::maybe_report_ambiguous_plus)]
@@ -572,7 +573,7 @@ pub(crate) struct FoundExprWouldBeStmt {
     #[primary_span]
     #[label]
     pub span: Span,
-    pub token: String,
+    pub token: Token,
     #[subdiagnostic]
     pub suggestion: ExprParenthesesNeeded,
 }
@@ -871,7 +872,7 @@ pub(crate) struct SuffixedLiteralInAttribute {
 pub(crate) struct InvalidMetaItem {
     #[primary_span]
     pub span: Span,
-    pub token: String,
+    pub token: Token,
 }
 
 #[derive(Subdiagnostic)]
@@ -908,22 +909,22 @@ pub(crate) enum ExpectedIdentifierFound {
 }
 
 impl ExpectedIdentifierFound {
-    pub fn new(token_descr_kind: Option<TokenDescriptionKind>, span: Span) -> Self {
-        (match token_descr_kind {
-            Some(TokenDescriptionKind::ReservedIdentifier) => {
+    pub fn new(token_descr: Option<TokenDescription>, span: Span) -> Self {
+        (match token_descr {
+            Some(TokenDescription::ReservedIdentifier) => {
                 ExpectedIdentifierFound::ReservedIdentifier
             }
-            Some(TokenDescriptionKind::Keyword) => ExpectedIdentifierFound::Keyword,
-            Some(TokenDescriptionKind::ReservedKeyword) => ExpectedIdentifierFound::ReservedKeyword,
-            Some(TokenDescriptionKind::DocComment) => ExpectedIdentifierFound::DocComment,
+            Some(TokenDescription::Keyword) => ExpectedIdentifierFound::Keyword,
+            Some(TokenDescription::ReservedKeyword) => ExpectedIdentifierFound::ReservedKeyword,
+            Some(TokenDescription::DocComment) => ExpectedIdentifierFound::DocComment,
             None => ExpectedIdentifierFound::Other,
         })(span)
     }
 }
 
 pub(crate) struct ExpectedIdentifier {
     pub span: Span,
-    pub token_descr: TokenDescription,
+    pub token: Token,
     pub suggest_raw: Option<SuggEscapeToUseAsIdentifier>,
     pub suggest_remove_comma: Option<SuggRemoveComma>,
 }
@@ -933,29 +934,31 @@ impl<'a, G: EmissionGuarantee> IntoDiagnostic<'a, G> for ExpectedIdentifier {
         self,
         handler: &'a rustc_errors::Handler,
     ) -> rustc_errors::DiagnosticBuilder<'a, G> {
-        let mut diag = handler.struct_diagnostic(match self.token_descr.kind {
-            Some(TokenDescriptionKind::ReservedIdentifier) => {
+        let token_descr = super::parser::TokenDescription::from_token(&self.token);
+
+        let mut diag = handler.struct_diagnostic(match token_descr {
+            Some(TokenDescription::ReservedIdentifier) => {
                 fluent::parser::expected_identifier_found_reserved_identifier_str
             }
-            Some(TokenDescriptionKind::Keyword) => {
+            Some(TokenDescription::Keyword) => {
                 fluent::parser::expected_identifier_found_keyword_str
             }
-            Some(TokenDescriptionKind::ReservedKeyword) => {
+            Some(TokenDescription::ReservedKeyword) => {
                 fluent::parser::expected_identifier_found_reserved_keyword_str
             }
-            Some(TokenDescriptionKind::DocComment) => {
+            Some(TokenDescription::DocComment) => {
                 fluent::parser::expected_identifier_found_doc_comment_str
             }
             None => fluent::parser::expected_identifier_found_str,
         });
         diag.set_span(self.span);
-        diag.set_arg("token_str", self.token_descr.name);
+        diag.set_arg("token", self.token);
 
         if let Some(sugg) = self.suggest_raw {
             sugg.add_to_diagnostic(&mut diag);
         }
 
-        ExpectedIdentifierFound::new(self.token_descr.kind, self.span).add_to_diagnostic(&mut diag);
+        ExpectedIdentifierFound::new(token_descr, self.span).add_to_diagnostic(&mut diag);
 
         if let Some(sugg) = self.suggest_remove_comma {
             sugg.add_to_diagnostic(&mut diag);
@@ -967,7 +970,7 @@ impl<'a, G: EmissionGuarantee> IntoDiagnostic<'a, G> for ExpectedIdentifier {
 
 pub(crate) struct ExpectedSemi {
     pub span: Span,
-    pub token_descr: TokenDescription,
+    pub token: Token,
 
     pub unexpected_token_label: Option<Span>,
     pub sugg: ExpectedSemiSugg,
@@ -978,21 +981,23 @@ impl<'a, G: EmissionGuarantee> IntoDiagnostic<'a, G> for ExpectedSemi {
         self,
         handler: &'a rustc_errors::Handler,
     ) -> rustc_errors::DiagnosticBuilder<'a, G> {
-        let mut diag = handler.struct_diagnostic(match self.token_descr.kind {
-            Some(TokenDescriptionKind::ReservedIdentifier) => {
+        let token_descr = super::parser::TokenDescription::from_token(&self.token);
+
+        let mut diag = handler.struct_diagnostic(match token_descr {
+            Some(TokenDescription::ReservedIdentifier) => {
                 fluent::parser::expected_semi_found_reserved_identifier_str
             }
-            Some(TokenDescriptionKind::Keyword) => fluent::parser::expected_semi_found_keyword_str,
-            Some(TokenDescriptionKind::ReservedKeyword) => {
+            Some(TokenDescription::Keyword) => fluent::parser::expected_semi_found_keyword_str,
+            Some(TokenDescription::ReservedKeyword) => {
                 fluent::parser::expected_semi_found_reserved_keyword_str
             }
-            Some(TokenDescriptionKind::DocComment) => {
+            Some(TokenDescription::DocComment) => {
                 fluent::parser::expected_semi_found_doc_comment_str
             }
             None => fluent::parser::expected_semi_found_str,
         });
         diag.set_span(self.span);
-        diag.set_arg("token_str", self.token_descr.name);
+        diag.set_arg("token", self.token);
 
         if let Some(unexpected_token_label) = self.unexpected_token_label {
             diag.span_label(unexpected_token_label, fluent::parser::label_unexpected_token);
diff --git a/compiler/rustc_parse/src/parser/attr.rs b/compiler/rustc_parse/src/parser/attr.rs
@@ -4,7 +4,6 @@ use super::{AttrWrapper, Capturing, FnParseMode, ForceCollect, Parser, PathStyle
 use rustc_ast as ast;
 use rustc_ast::attr;
 use rustc_ast::token::{self, Delimiter, Nonterminal};
-use rustc_ast_pretty::pprust;
 use rustc_errors::{error_code, fluent, Diagnostic, IntoDiagnostic, PResult};
 use rustc_span::{sym, BytePos, Span};
 use std::convert::TryInto;
@@ -414,8 +413,7 @@ impl<'a> Parser<'a> {
             Err(err) => err.cancel(),
         }
 
-        let token = pprust::token_to_string(&self.token).to_string();
-        Err(InvalidMetaItem { span: self.token.span, token }
+        Err(InvalidMetaItem { span: self.token.span, token: self.token.clone() }
             .into_diagnostic(&self.sess.span_diagnostic))
     }
 }
diff --git a/compiler/rustc_parse/src/parser/diagnostics.rs b/compiler/rustc_parse/src/parser/diagnostics.rs
@@ -326,7 +326,7 @@ impl<'a> Parser<'a> {
 
         let err = ExpectedIdentifier {
             span: self.token.span,
-            token_descr: super::token_descr_struct(&self.token),
+            token: self.token.clone(),
             suggest_raw,
             suggest_remove_comma,
         };
@@ -426,7 +426,7 @@ impl<'a> Parser<'a> {
                 //   let y = 42;
                 self.sess.emit_err(ExpectedSemi {
                     span: self.token.span,
-                    token_descr: super::token_descr_struct(&self.token),
+                    token: self.token.clone(),
                     unexpected_token_label: None,
                     sugg: ExpectedSemiSugg::ChangeToSemi(self.token.span),
                 });
@@ -451,7 +451,7 @@ impl<'a> Parser<'a> {
                 let span = self.prev_token.span.shrink_to_hi();
                 self.sess.emit_err(ExpectedSemi {
                     span,
-                    token_descr: super::token_descr_struct(&self.token),
+                    token: self.token.clone(),
                     unexpected_token_label: Some(self.token.span),
                     sugg: ExpectedSemiSugg::AddSemi(span),
                 });
diff --git a/compiler/rustc_parse/src/parser/expr.rs b/compiler/rustc_parse/src/parser/expr.rs
@@ -430,8 +430,7 @@ impl<'a> Parser<'a> {
     fn error_found_expr_would_be_stmt(&self, lhs: &Expr) {
         self.sess.emit_err(FoundExprWouldBeStmt {
             span: self.token.span,
-            // FIXME(#100717)
-            token: pprust::token_to_string(&self.token).to_string(),
+            token: self.token.clone(),
             suggestion: ExprParenthesesNeeded::surrounding(lhs.span),
         });
     }
diff --git a/compiler/rustc_parse/src/parser/mod.rs b/compiler/rustc_parse/src/parser/mod.rs
@@ -411,40 +411,33 @@ pub enum FollowedByType {
 }
 
 #[derive(Clone, Copy, PartialEq, Eq)]
-pub enum TokenDescriptionKind {
+pub enum TokenDescription {
     ReservedIdentifier,
     Keyword,
     ReservedKeyword,
     DocComment,
 }
 
-#[derive(Clone, PartialEq, Eq)]
-pub struct TokenDescription {
-    pub kind: Option<TokenDescriptionKind>,
-    pub name: String,
-}
-
-pub(super) fn token_descr_struct(token: &Token) -> TokenDescription {
-    let kind = match token.kind {
-        _ if token.is_special_ident() => Some(TokenDescriptionKind::ReservedIdentifier),
-        _ if token.is_used_keyword() => Some(TokenDescriptionKind::Keyword),
-        _ if token.is_unused_keyword() => Some(TokenDescriptionKind::ReservedKeyword),
-        token::DocComment(..) => Some(TokenDescriptionKind::DocComment),
-        _ => None,
-    };
-    let name = pprust::token_to_string(token).to_string();
-
-    TokenDescription { kind, name }
+impl TokenDescription {
+    pub fn from_token(token: &Token) -> Option<Self> {
+        match token.kind {
+            _ if token.is_special_ident() => Some(TokenDescription::ReservedIdentifier),
+            _ if token.is_used_keyword() => Some(TokenDescription::Keyword),
+            _ if token.is_unused_keyword() => Some(TokenDescription::ReservedKeyword),
+            token::DocComment(..) => Some(TokenDescription::DocComment),
+            _ => None,
+        }
+    }
 }
 
 pub(super) fn token_descr(token: &Token) -> String {
-    let TokenDescription { kind, name } = token_descr_struct(token);
+    let name = pprust::token_to_string(token).to_string();
 
-    let kind = kind.map(|kind| match kind {
-        TokenDescriptionKind::ReservedIdentifier => "reserved identifier",
-        TokenDescriptionKind::Keyword => "keyword",
-        TokenDescriptionKind::ReservedKeyword => "reserved keyword",
-        TokenDescriptionKind::DocComment => "doc comment",
+    let kind = TokenDescription::from_token(token).map(|kind| match kind {
+        TokenDescription::ReservedIdentifier => "reserved identifier",
+        TokenDescription::Keyword => "keyword",
+        TokenDescription::ReservedKeyword => "reserved keyword",
+        TokenDescription::DocComment => "doc comment",
     });
 
     if let Some(kind) = kind { format!("{} `{}`", kind, name) } else { format!("`{}`", name) }

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@ use super::{AttrWrapper, Capturing, FnParseMode, ForceCollect, Parser, PathStyle`
`4`	`4`	`use rustc_ast as ast;`
`5`	`5`	`use rustc_ast::attr;`
`6`	`6`	`use rustc_ast::token::{self, Delimiter, Nonterminal};`
`7`		`-use rustc_ast_pretty::pprust;`
`8`	`7`	`use rustc_errors::{error_code, fluent, Diagnostic, IntoDiagnostic, PResult};`
`9`	`8`	`use rustc_span::{sym, BytePos, Span};`
`10`	`9`	`use std::convert::TryInto;`
`@@ -414,8 +413,7 @@ impl<'a> Parser<'a> {`
`414`	`413`	`Err(err) => err.cancel(),`
`415`	`414`	`}`
`416`	`415`
`417`		`- let token = pprust::token_to_string(&self.token).to_string();`
`418`		`- Err(InvalidMetaItem { span: self.token.span, token }`
	`416`	`+ Err(InvalidMetaItem { span: self.token.span, token: self.token.clone() }`
`419`	`417`	`.into_diagnostic(&self.sess.span_diagnostic))`
`420`	`418`	`}`
`421`	`419`	`}`