]> git.lizzy.rs Git - rust.git/blobdiff - clippy_lints/src/strings.rs
Give more corrected code examples in doc
[rust.git] / clippy_lints / src / strings.rs
index 4135fc87fcd1970434004437bcc22b0493edd3de..f84566ef707a8e41dbc8a2b00275d7d55c07aeb6 100644 (file)
@@ -1,11 +1,14 @@
-use rustc::hir::*;
-use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
-use rustc::{declare_lint_pass, declare_tool_lint};
 use rustc_errors::Applicability;
-use syntax::source_map::Spanned;
+use rustc_hir::{BinOpKind, Expr, ExprKind};
+use rustc_lint::{LateContext, LateLintPass, LintContext};
+use rustc_middle::lint::in_external_macro;
+use rustc_session::{declare_lint_pass, declare_tool_lint};
+use rustc_span::source_map::Spanned;
+
+use if_chain::if_chain;
 
 use crate::utils::SpanlessEq;
-use crate::utils::{get_parent_expr, is_allowed, match_type, paths, span_lint, span_lint_and_sugg, walk_ptrs_ty};
+use crate::utils::{get_parent_expr, is_allowed, is_type_diagnostic_item, span_lint, span_lint_and_sugg, walk_ptrs_ty};
 
 declare_clippy_lint! {
     /// **What it does:** Checks for string appends of the form `x = x + y` (without
     /// ```rust
     /// let mut x = "Hello".to_owned();
     /// x = x + ", World";
+    ///
+    /// // More readable
+    /// x += ", World";
+    /// x.push_str(", World");
     /// ```
     pub STRING_ADD_ASSIGN,
     pedantic,
     ///
     /// **Example:**
     /// ```rust
+    /// // Bad
     /// let bs = "a byte string".as_bytes();
+    ///
+    /// // Good
+    /// let bs = b"a byte string";
     /// ```
     pub STRING_LIT_AS_BYTES,
     style,
 declare_lint_pass!(StringAdd => [STRING_ADD, STRING_ADD_ASSIGN]);
 
 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for StringAdd {
-    fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, e: &'tcx Expr) {
+    fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, e: &'tcx Expr<'_>) {
+        if in_external_macro(cx.sess(), e.span) {
+            return;
+        }
+
         if let ExprKind::Binary(
             Spanned {
                 node: BinOpKind::Add, ..
             },
             ref left,
             _,
-        ) = e.node
+        ) = e.kind
         {
             if is_string(cx, left) {
                 if !is_allowed(cx, STRING_ADD_ASSIGN, e.hir_id) {
                     let parent = get_parent_expr(cx, e);
                     if let Some(p) = parent {
-                        if let ExprKind::Assign(ref target, _) = p.node {
+                        if let ExprKind::Assign(ref target, _, _) = p.kind {
                             // avoid duplicate matches
                             if SpanlessEq::new(cx).eq_expr(target, left) {
                                 return;
@@ -104,7 +119,7 @@ fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, e: &'tcx Expr) {
                     "you added something to a string. Consider using `String::push_str()` instead",
                 );
             }
-        } else if let ExprKind::Assign(ref target, ref src) = e.node {
+        } else if let ExprKind::Assign(ref target, ref src, _) = e.kind {
             if is_string(cx, target) && is_add(cx, src, target) {
                 span_lint(
                     cx,
@@ -118,12 +133,12 @@ fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, e: &'tcx Expr) {
     }
 }
 
-fn is_string(cx: &LateContext<'_, '_>, e: &Expr) -> bool {
-    match_type(cx, walk_ptrs_ty(cx.tables.expr_ty(e)), &paths::STRING)
+fn is_string(cx: &LateContext<'_, '_>, e: &Expr<'_>) -> bool {
+    is_type_diagnostic_item(cx, walk_ptrs_ty(cx.tables.expr_ty(e)), sym!(string_type))
 }
 
-fn is_add(cx: &LateContext<'_, '_>, src: &Expr, target: &Expr) -> bool {
-    match src.node {
+fn is_add(cx: &LateContext<'_, '_>, src: &Expr<'_>, target: &Expr<'_>) -> bool {
+    match src.kind {
         ExprKind::Binary(
             Spanned {
                 node: BinOpKind::Add, ..
@@ -144,55 +159,48 @@ fn is_add(cx: &LateContext<'_, '_>, src: &Expr, target: &Expr) -> bool {
 declare_lint_pass!(StringLitAsBytes => [STRING_LIT_AS_BYTES]);
 
 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for StringLitAsBytes {
-    fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, e: &'tcx Expr) {
+    fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, e: &'tcx Expr<'_>) {
         use crate::utils::{snippet, snippet_with_applicability};
-        use syntax::ast::{LitKind, StrStyle};
+        use rustc_ast::ast::LitKind;
 
-        if let ExprKind::MethodCall(ref path, _, ref args) = e.node {
-            if path.ident.name == sym!(as_bytes) {
-                if let ExprKind::Lit(ref lit) = args[0].node {
-                    if let LitKind::Str(ref lit_content, style) = lit.node {
-                        let callsite = snippet(cx, args[0].span.source_callsite(), r#""foo""#);
-                        let expanded = if let StrStyle::Raw(n) = style {
-                            let term = (0..n).map(|_| '#').collect::<String>();
-                            format!("r{0}\"{1}\"{0}", term, lit_content.as_str())
-                        } else {
-                            format!("\"{}\"", lit_content.as_str())
-                        };
-                        let mut applicability = Applicability::MachineApplicable;
-                        if callsite.starts_with("include_str!") {
-                            span_lint_and_sugg(
-                                cx,
-                                STRING_LIT_AS_BYTES,
-                                e.span,
-                                "calling `as_bytes()` on `include_str!(..)`",
-                                "consider using `include_bytes!(..)` instead",
-                                snippet_with_applicability(cx, args[0].span, r#""foo""#, &mut applicability).replacen(
-                                    "include_str",
-                                    "include_bytes",
-                                    1,
-                                ),
-                                applicability,
-                            );
-                        } else if callsite == expanded
-                            && lit_content.as_str().chars().all(|c| c.is_ascii())
-                            && lit_content.as_str().len() <= MAX_LENGTH_BYTE_STRING_LIT
-                            && !args[0].span.from_expansion()
-                        {
-                            span_lint_and_sugg(
-                                cx,
-                                STRING_LIT_AS_BYTES,
-                                e.span,
-                                "calling `as_bytes()` on a string literal",
-                                "consider using a byte string literal instead",
-                                format!(
-                                    "b{}",
-                                    snippet_with_applicability(cx, args[0].span, r#""foo""#, &mut applicability)
-                                ),
-                                applicability,
-                            );
-                        }
-                    }
+        if_chain! {
+            if let ExprKind::MethodCall(path, _, args) = &e.kind;
+            if path.ident.name == sym!(as_bytes);
+            if let ExprKind::Lit(lit) = &args[0].kind;
+            if let LitKind::Str(lit_content, _) = &lit.node;
+            then {
+                let callsite = snippet(cx, args[0].span.source_callsite(), r#""foo""#);
+                let mut applicability = Applicability::MachineApplicable;
+                if callsite.starts_with("include_str!") {
+                    span_lint_and_sugg(
+                        cx,
+                        STRING_LIT_AS_BYTES,
+                        e.span,
+                        "calling `as_bytes()` on `include_str!(..)`",
+                        "consider using `include_bytes!(..)` instead",
+                        snippet_with_applicability(cx, args[0].span, r#""foo""#, &mut applicability).replacen(
+                            "include_str",
+                            "include_bytes",
+                            1,
+                        ),
+                        applicability,
+                    );
+                } else if lit_content.as_str().is_ascii()
+                    && lit_content.as_str().len() <= MAX_LENGTH_BYTE_STRING_LIT
+                    && !args[0].span.from_expansion()
+                {
+                    span_lint_and_sugg(
+                        cx,
+                        STRING_LIT_AS_BYTES,
+                        e.span,
+                        "calling `as_bytes()` on a string literal",
+                        "consider using a byte string literal instead",
+                        format!(
+                            "b{}",
+                            snippet_with_applicability(cx, args[0].span, r#""foo""#, &mut applicability)
+                        ),
+                        applicability,
+                    );
                 }
             }
         }