Rollup merge of #83092 - petrochenkov:qspan, r=estebank

[rust.git] / clippy_lints / src / dbg_macro.rs

diff --git a/clippy_lints/src/dbg_macro.rs b/clippy_lints/src/dbg_macro.rs
index 1759db1ca3a1a7464facd8c4934c1d81179ca3f2..e513dcce64e5349fb6668ceb1bf3fc864d577809 100644 (file)
--- a/clippy_lints/src/dbg_macro.rs
+++ b/clippy_lints/src/dbg_macro.rs
@@ -1,55 +1,65 @@
-use rustc::lint::{EarlyContext, EarlyLintPass, LintArray, LintPass};
-use rustc::{declare_tool_lint, lint_array};
-use crate::utils::span_lint_and_sugg;
-use syntax::ast;
+use crate::utils::{snippet_opt, span_lint_and_help, span_lint_and_sugg};
+use rustc_ast::ast;
+use rustc_ast::tokenstream::TokenStream;
 use rustc_errors::Applicability;
+use rustc_lint::{EarlyContext, EarlyLintPass};
+use rustc_session::{declare_lint_pass, declare_tool_lint};
+use rustc_span::source_map::Span;
 
-/// **What it does:** Checks for usage of dbg!() macro.
-///
-/// **Why is this bad?** `dbg!` macro is intended as a debugging tool. It
-/// should not be in version control.
-///
-/// **Known problems:** None.
-///
-/// **Example:**
-/// ```rust,ignore
-/// // Bad
-/// dbg!(true)
-///
-/// // Good
-/// true
-/// ```
 declare_clippy_lint! {
+    /// **What it does:** Checks for usage of dbg!() macro.
+    ///
+    /// **Why is this bad?** `dbg!` macro is intended as a debugging tool. It
+    /// should not be in version control.
+    ///
+    /// **Known problems:** None.
+    ///
+    /// **Example:**
+    /// ```rust,ignore
+    /// // Bad
+    /// dbg!(true)
+    ///
+    /// // Good
+    /// true
+    /// ```
     pub DBG_MACRO,
     restriction,
     "`dbg!` macro is intended as a debugging tool"
 }
 
-#[derive(Copy, Clone, Debug)]
-pub struct Pass;
+declare_lint_pass!(DbgMacro => [DBG_MACRO]);
 
-impl LintPass for Pass {
-    fn get_lints(&self) -> LintArray {
-        lint_array!(DBG_MACRO)
-    }
-
-    fn name(&self) -> &'static str {
-        "DbgMacro"
+impl EarlyLintPass for DbgMacro {
+    fn check_mac(&mut self, cx: &EarlyContext<'_>, mac: &ast::MacCall) {
+        if mac.path == sym!(dbg) {
+            if let Some(sugg) = tts_span(mac.args.inner_tokens()).and_then(|span| snippet_opt(cx, span)) {
+                span_lint_and_sugg(
+                    cx,
+                    DBG_MACRO,
+                    mac.span(),
+                    "`dbg!` macro is intended as a debugging tool",
+                    "ensure to avoid having uses of it in version control",
+                    sugg,
+                    Applicability::MaybeIncorrect,
+                );
+            } else {
+                span_lint_and_help(
+                    cx,
+                    DBG_MACRO,
+                    mac.span(),
+                    "`dbg!` macro is intended as a debugging tool",
+                    None,
+                    "ensure to avoid having uses of it in version control",
+                );
+            }
+        }
     }
 }
 
-impl EarlyLintPass for Pass {
-    fn check_mac(&mut self, cx: &EarlyContext<'_>, mac: &ast::Mac) {
-        if mac.node.path == "dbg" {
-            span_lint_and_sugg(
-                cx,
-                DBG_MACRO,
-                mac.span,
-                "`dbg!` macro is intended as a debugging tool",
-                "ensure to avoid having uses of it in version control",
-                mac.node.tts.to_string(),
-                Applicability::MaybeIncorrect,
-            );
-        }
-    }
+// Get span enclosing entire the token stream.
+fn tts_span(tts: TokenStream) -> Option<Span> {
+    let mut cursor = tts.into_trees();
+    let first = cursor.next()?.span();
+    let span = cursor.last().map_or(first, |tree| first.to(tree.span()));
+    Some(span)
 }