clippy_lints/src/strings.rs

   1 use clippy_utils::diagnostics::{span_lint, span_lint_and_help, span_lint_and_sugg};
   2 use clippy_utils::source::{snippet, snippet_with_applicability};
   3 use clippy_utils::ty::is_type_diagnostic_item;
   4 use clippy_utils::SpanlessEq;
   5 use clippy_utils::{get_parent_expr, is_lint_allowed, match_function_call, method_calls, paths};
   6 use if_chain::if_chain;
   7 use rustc_errors::Applicability;
   8 use rustc_hir::{BinOpKind, BorrowKind, Expr, ExprKind, LangItem, QPath};
   9 use rustc_lint::{LateContext, LateLintPass, LintContext};
  10 use rustc_middle::lint::in_external_macro;
  11 use rustc_middle::ty;
  12 use rustc_session::{declare_lint_pass, declare_tool_lint};
  13 use rustc_span::source_map::Spanned;
  14 use rustc_span::sym;
  15
  16 declare_clippy_lint! {
  17     /// ### What it does
  18     /// Checks for string appends of the form `x = x + y` (without
  19     /// `let`!).
  20     ///
  21     /// ### Why is this bad?
  22     /// It's not really bad, but some people think that the
  23     /// `.push_str(_)` method is more readable.
  24     ///
  25     /// ### Example
  26     /// ```rust
  27     /// let mut x = "Hello".to_owned();
  28     /// x = x + ", World";
  29     ///
  30     /// // More readable
  31     /// x += ", World";
  32     /// x.push_str(", World");
  33     /// ```
  34     #[clippy::version = "pre 1.29.0"]
  35     pub STRING_ADD_ASSIGN,
  36     pedantic,
  37     "using `x = x + ..` where x is a `String` instead of `push_str()`"
  38 }
  39
  40 declare_clippy_lint! {
  41     /// ### What it does
  42     /// Checks for all instances of `x + _` where `x` is of type
  43     /// `String`, but only if [`string_add_assign`](#string_add_assign) does *not*
  44     /// match.
  45     ///
  46     /// ### Why is this bad?
  47     /// It's not bad in and of itself. However, this particular
  48     /// `Add` implementation is asymmetric (the other operand need not be `String`,
  49     /// but `x` does), while addition as mathematically defined is symmetric, also
  50     /// the `String::push_str(_)` function is a perfectly good replacement.
  51     /// Therefore, some dislike it and wish not to have it in their code.
  52     ///
  53     /// That said, other people think that string addition, having a long tradition
  54     /// in other languages is actually fine, which is why we decided to make this
  55     /// particular lint `allow` by default.
  56     ///
  57     /// ### Example
  58     /// ```rust
  59     /// let x = "Hello".to_owned();
  60     /// x + ", World";
  61     /// ```
  62     #[clippy::version = "pre 1.29.0"]
  63     pub STRING_ADD,
  64     restriction,
  65     "using `x + ..` where x is a `String` instead of `push_str()`"
  66 }
  67
  68 declare_clippy_lint! {
  69     /// ### What it does
  70     /// Checks for the `as_bytes` method called on string literals
  71     /// that contain only ASCII characters.
  72     ///
  73     /// ### Why is this bad?
  74     /// Byte string literals (e.g., `b"foo"`) can be used
  75     /// instead. They are shorter but less discoverable than `as_bytes()`.
  76     ///
  77     /// ### Known problems
  78     /// `"str".as_bytes()` and the suggested replacement of `b"str"` are not
  79     /// equivalent because they have different types. The former is `&[u8]`
  80     /// while the latter is `&[u8; 3]`. That means in general they will have a
  81     /// different set of methods and different trait implementations.
  82     ///
  83     /// ```compile_fail
  84     /// fn f(v: Vec<u8>) {}
  85     ///
  86     /// f("...".as_bytes().to_owned()); // works
  87     /// f(b"...".to_owned()); // does not work, because arg is [u8; 3] not Vec<u8>
  88     ///
  89     /// fn g(r: impl std::io::Read) {}
  90     ///
  91     /// g("...".as_bytes()); // works
  92     /// g(b"..."); // does not work
  93     /// ```
  94     ///
  95     /// The actual equivalent of `"str".as_bytes()` with the same type is not
  96     /// `b"str"` but `&b"str"[..]`, which is a great deal of punctuation and not
  97     /// more readable than a function call.
  98     ///
  99     /// ### Example
 100     /// ```rust
 101     /// // Bad
 102     /// let bs = "a byte string".as_bytes();
 103     ///
 104     /// // Good
 105     /// let bs = b"a byte string";
 106     /// ```
 107     #[clippy::version = "pre 1.29.0"]
 108     pub STRING_LIT_AS_BYTES,
 109     nursery,
 110     "calling `as_bytes` on a string literal instead of using a byte string literal"
 111 }
 112
 113 declare_clippy_lint! {
 114     /// ### What it does
 115     /// Checks for slice operations on strings
 116     ///
 117     /// ### Why is this bad?
 118     /// UTF-8 characters span multiple bytes, and it is easy to inadvertently confuse character
 119     /// counts and string indices. This may lead to panics, and should warrant some test cases
 120     /// containing wide UTF-8 characters. This lint is most useful in code that should avoid
 121     /// panics at all costs.
 122     ///
 123     /// ### Known problems
 124     /// Probably lots of false positives. If an index comes from a known valid position (e.g.
 125     /// obtained via `char_indices` over the same string), it is totally OK.
 126     ///
 127     /// # Example
 128     /// ```rust,should_panic
 129     /// &"Ölkanne"[1..];
 130     /// ```
 131     #[clippy::version = "1.58.0"]
 132     pub STRING_SLICE,
 133     restriction,
 134     "slicing a string"
 135 }
 136
 137 declare_lint_pass!(StringAdd => [STRING_ADD, STRING_ADD_ASSIGN, STRING_SLICE]);
 138
 139 impl<'tcx> LateLintPass<'tcx> for StringAdd {
 140     fn check_expr(&mut self, cx: &LateContext<'tcx>, e: &'tcx Expr<'_>) {
 141         if in_external_macro(cx.sess(), e.span) {
 142             return;
 143         }
 144         match e.kind {
 145             ExprKind::Binary(
 146                 Spanned {
 147                     node: BinOpKind::Add, ..
 148                 },
 149                 left,
 150                 _,
 151             ) => {
 152                 if is_string(cx, left) {
 153                     if !is_lint_allowed(cx, STRING_ADD_ASSIGN, e.hir_id) {
 154                         let parent = get_parent_expr(cx, e);
 155                         if let Some(p) = parent {
 156                             if let ExprKind::Assign(target, _, _) = p.kind {
 157                                 // avoid duplicate matches
 158                                 if SpanlessEq::new(cx).eq_expr(target, left) {
 159                                     return;
 160                                 }
 161                             }
 162                         }
 163                     }
 164                     span_lint(
 165                         cx,
 166                         STRING_ADD,
 167                         e.span,
 168                         "you added something to a string. Consider using `String::push_str()` instead",
 169                     );
 170                 }
 171             },
 172             ExprKind::Assign(target, src, _) => {
 173                 if is_string(cx, target) && is_add(cx, src, target) {
 174                     span_lint(
 175                         cx,
 176                         STRING_ADD_ASSIGN,
 177                         e.span,
 178                         "you assigned the result of adding something to this string. Consider using \
 179                          `String::push_str()` instead",
 180                     );
 181                 }
 182             },
 183             ExprKind::Index(target, _idx) => {
 184                 let e_ty = cx.typeck_results().expr_ty(target).peel_refs();
 185                 if matches!(e_ty.kind(), ty::Str) || is_type_diagnostic_item(cx, e_ty, sym::String) {
 186                     span_lint(
 187                         cx,
 188                         STRING_SLICE,
 189                         e.span,
 190                         "indexing into a string may panic if the index is within a UTF-8 character",
 191                     );
 192                 }
 193             },
 194             _ => {},
 195         }
 196     }
 197 }
 198
 199 fn is_string(cx: &LateContext<'_>, e: &Expr<'_>) -> bool {
 200     is_type_diagnostic_item(cx, cx.typeck_results().expr_ty(e).peel_refs(), sym::String)
 201 }
 202
 203 fn is_add(cx: &LateContext<'_>, src: &Expr<'_>, target: &Expr<'_>) -> bool {
 204     match src.kind {
 205         ExprKind::Binary(
 206             Spanned {
 207                 node: BinOpKind::Add, ..
 208             },
 209             left,
 210             _,
 211         ) => SpanlessEq::new(cx).eq_expr(target, left),
 212         ExprKind::Block(block, _) => {
 213             block.stmts.is_empty() && block.expr.as_ref().map_or(false, |expr| is_add(cx, expr, target))
 214         },
 215         _ => false,
 216     }
 217 }
 218
 219 declare_clippy_lint! {
 220     /// ### What it does
 221     /// Check if the string is transformed to byte array and casted back to string.
 222     ///
 223     /// ### Why is this bad?
 224     /// It's unnecessary, the string can be used directly.
 225     ///
 226     /// ### Example
 227     /// ```rust
 228     /// let _ = std::str::from_utf8(&"Hello World!".as_bytes()[6..11]).unwrap();
 229     /// ```
 230     /// could be written as
 231     /// ```rust
 232     /// let _ = &"Hello World!"[6..11];
 233     /// ```
 234     #[clippy::version = "1.50.0"]
 235     pub STRING_FROM_UTF8_AS_BYTES,
 236     complexity,
 237     "casting string slices to byte slices and back"
 238 }
 239
 240 // Max length a b"foo" string can take
 241 const MAX_LENGTH_BYTE_STRING_LIT: usize = 32;
 242
 243 declare_lint_pass!(StringLitAsBytes => [STRING_LIT_AS_BYTES, STRING_FROM_UTF8_AS_BYTES]);
 244
 245 impl<'tcx> LateLintPass<'tcx> for StringLitAsBytes {
 246     fn check_expr(&mut self, cx: &LateContext<'tcx>, e: &'tcx Expr<'_>) {
 247         use rustc_ast::LitKind;
 248
 249         if_chain! {
 250             // Find std::str::converts::from_utf8
 251             if let Some(args) = match_function_call(cx, e, &paths::STR_FROM_UTF8);
 252
 253             // Find string::as_bytes
 254             if let ExprKind::AddrOf(BorrowKind::Ref, _, args) = args[0].kind;
 255             if let ExprKind::Index(left, right) = args.kind;
 256             let (method_names, expressions, _) = method_calls(left, 1);
 257             if method_names.len() == 1;
 258             if expressions.len() == 1;
 259             if expressions[0].len() == 1;
 260             if method_names[0] == sym!(as_bytes);
 261
 262             // Check for slicer
 263             if let ExprKind::Struct(QPath::LangItem(LangItem::Range, _), _, _) = right.kind;
 264
 265             then {
 266                 let mut applicability = Applicability::MachineApplicable;
 267                 let string_expression = &expressions[0][0];
 268
 269                 let snippet_app = snippet_with_applicability(
 270                     cx,
 271                     string_expression.span, "..",
 272                     &mut applicability,
 273                 );
 274
 275                 span_lint_and_sugg(
 276                     cx,
 277                     STRING_FROM_UTF8_AS_BYTES,
 278                     e.span,
 279                     "calling a slice of `as_bytes()` with `from_utf8` should be not necessary",
 280                     "try",
 281                     format!("Some(&{}[{}])", snippet_app, snippet(cx, right.span, "..")),
 282                     applicability
 283                 )
 284             }
 285         }
 286
 287         if_chain! {
 288             if let ExprKind::MethodCall(path, _, args, _) = &e.kind;
 289             if path.ident.name == sym!(as_bytes);
 290             if let ExprKind::Lit(lit) = &args[0].kind;
 291             if let LitKind::Str(lit_content, _) = &lit.node;
 292             then {
 293                 let callsite = snippet(cx, args[0].span.source_callsite(), r#""foo""#);
 294                 let mut applicability = Applicability::MachineApplicable;
 295                 if callsite.starts_with("include_str!") {
 296                     span_lint_and_sugg(
 297                         cx,
 298                         STRING_LIT_AS_BYTES,
 299                         e.span,
 300                         "calling `as_bytes()` on `include_str!(..)`",
 301                         "consider using `include_bytes!(..)` instead",
 302                         snippet_with_applicability(cx, args[0].span, r#""foo""#, &mut applicability).replacen(
 303                             "include_str",
 304                             "include_bytes",
 305                             1,
 306                         ),
 307                         applicability,
 308                     );
 309                 } else if lit_content.as_str().is_ascii()
 310                     && lit_content.as_str().len() <= MAX_LENGTH_BYTE_STRING_LIT
 311                     && !args[0].span.from_expansion()
 312                 {
 313                     span_lint_and_sugg(
 314                         cx,
 315                         STRING_LIT_AS_BYTES,
 316                         e.span,
 317                         "calling `as_bytes()` on a string literal",
 318                         "consider using a byte string literal instead",
 319                         format!(
 320                             "b{}",
 321                             snippet_with_applicability(cx, args[0].span, r#""foo""#, &mut applicability)
 322                         ),
 323                         applicability,
 324                     );
 325                 }
 326             }
 327         }
 328
 329         if_chain! {
 330             if let ExprKind::MethodCall(path, _, [recv], _) = &e.kind;
 331             if path.ident.name == sym!(into_bytes);
 332             if let ExprKind::MethodCall(path, _, [recv], _) = &recv.kind;
 333             if matches!(&*path.ident.name.as_str(), "to_owned" | "to_string");
 334             if let ExprKind::Lit(lit) = &recv.kind;
 335             if let LitKind::Str(lit_content, _) = &lit.node;
 336
 337             if lit_content.as_str().is_ascii();
 338             if lit_content.as_str().len() <= MAX_LENGTH_BYTE_STRING_LIT;
 339             if !recv.span.from_expansion();
 340             then {
 341                 let mut applicability = Applicability::MachineApplicable;
 342
 343                 span_lint_and_sugg(
 344                     cx,
 345                     STRING_LIT_AS_BYTES,
 346                     e.span,
 347                     "calling `into_bytes()` on a string literal",
 348                     "consider using a byte string literal instead",
 349                     format!(
 350                         "b{}.to_vec()",
 351                         snippet_with_applicability(cx, recv.span, r#""..""#, &mut applicability)
 352                     ),
 353                     applicability,
 354                 );
 355             }
 356         }
 357     }
 358 }
 359
 360 declare_clippy_lint! {
 361     /// ### What it does
 362     /// This lint checks for `.to_string()` method calls on values of type `&str`.
 363     ///
 364     /// ### Why is this bad?
 365     /// The `to_string` method is also used on other types to convert them to a string.
 366     /// When called on a `&str` it turns the `&str` into the owned variant `String`, which can be better
 367     /// expressed with `.to_owned()`.
 368     ///
 369     /// ### Example
 370     /// ```rust
 371     /// // example code where clippy issues a warning
 372     /// let _ = "str".to_string();
 373     /// ```
 374     /// Use instead:
 375     /// ```rust
 376     /// // example code which does not raise clippy warning
 377     /// let _ = "str".to_owned();
 378     /// ```
 379     #[clippy::version = "pre 1.29.0"]
 380     pub STR_TO_STRING,
 381     restriction,
 382     "using `to_string()` on a `&str`, which should be `to_owned()`"
 383 }
 384
 385 declare_lint_pass!(StrToString => [STR_TO_STRING]);
 386
 387 impl LateLintPass<'_> for StrToString {
 388     fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &Expr<'_>) {
 389         if_chain! {
 390             if let ExprKind::MethodCall(path, _, [self_arg, ..], _) = &expr.kind;
 391             if path.ident.name == sym!(to_string);
 392             let ty = cx.typeck_results().expr_ty(self_arg);
 393             if let ty::Ref(_, ty, ..) = ty.kind();
 394             if *ty.kind() == ty::Str;
 395             then {
 396                 span_lint_and_help(
 397                     cx,
 398                     STR_TO_STRING,
 399                     expr.span,
 400                     "`to_string()` called on a `&str`",
 401                     None,
 402                     "consider using `.to_owned()`",
 403                 );
 404             }
 405         }
 406     }
 407 }
 408
 409 declare_clippy_lint! {
 410     /// ### What it does
 411     /// This lint checks for `.to_string()` method calls on values of type `String`.
 412     ///
 413     /// ### Why is this bad?
 414     /// The `to_string` method is also used on other types to convert them to a string.
 415     /// When called on a `String` it only clones the `String`, which can be better expressed with `.clone()`.
 416     ///
 417     /// ### Example
 418     /// ```rust
 419     /// // example code where clippy issues a warning
 420     /// let msg = String::from("Hello World");
 421     /// let _ = msg.to_string();
 422     /// ```
 423     /// Use instead:
 424     /// ```rust
 425     /// // example code which does not raise clippy warning
 426     /// let msg = String::from("Hello World");
 427     /// let _ = msg.clone();
 428     /// ```
 429     #[clippy::version = "pre 1.29.0"]
 430     pub STRING_TO_STRING,
 431     restriction,
 432     "using `to_string()` on a `String`, which should be `clone()`"
 433 }
 434
 435 declare_lint_pass!(StringToString => [STRING_TO_STRING]);
 436
 437 impl LateLintPass<'_> for StringToString {
 438     fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &Expr<'_>) {
 439         if_chain! {
 440             if let ExprKind::MethodCall(path, _, [self_arg, ..], _) = &expr.kind;
 441             if path.ident.name == sym!(to_string);
 442             let ty = cx.typeck_results().expr_ty(self_arg);
 443             if is_type_diagnostic_item(cx, ty, sym::String);
 444             then {
 445                 span_lint_and_help(
 446                     cx,
 447                     STRING_TO_STRING,
 448                     expr.span,
 449                     "`to_string()` called on a `String`",
 450                     None,
 451                     "consider using `.clone()`",
 452                 );
 453             }
 454         }
 455     }
 456 }