4 use crate::utils::{snippet_with_applicability, span_lint, span_lint_and_sugg, span_lint_and_then};
5 use if_chain::if_chain;
7 Expr, ExprKind, ImplKind, Item, ItemKind, LitKind, MacCall, StrLit, StrStyle,
10 use rustc_ast::tokenstream::TokenStream;
11 use rustc_errors::Applicability;
12 use rustc_lexer::unescape::{self, EscapeError};
13 use rustc_lint::{EarlyContext, EarlyLintPass};
14 use rustc_parse::parser;
15 use rustc_session::{declare_tool_lint, impl_lint_pass};
16 use rustc_span::symbol::kw;
17 use rustc_span::{sym, BytePos, Span};
19 declare_clippy_lint! {
20 /// **What it does:** This lint warns when you use `println!("")` to
23 /// **Why is this bad?** You should use `println!()`, which is simpler.
25 /// **Known problems:** None.
35 pub PRINTLN_EMPTY_STRING,
37 "using `println!(\"\")` with an empty string"
40 declare_clippy_lint! {
41 /// **What it does:** This lint warns when you use `print!()` with a format
42 /// string that ends in a newline.
44 /// **Why is this bad?** You should use `println!()` instead, which appends the
47 /// **Known problems:** None.
51 /// # let name = "World";
52 /// print!("Hello {}!\n", name);
54 /// use println!() instead
56 /// # let name = "World";
57 /// println!("Hello {}!", name);
59 pub PRINT_WITH_NEWLINE,
61 "using `print!()` with a format string that ends in a single newline"
64 declare_clippy_lint! {
65 /// **What it does:** Checks for printing on *stdout*. The purpose of this lint
66 /// is to catch debugging remnants.
68 /// **Why is this bad?** People often print on *stdout* while debugging an
69 /// application and might forget to remove those prints afterward.
71 /// **Known problems:** Only catches `print!` and `println!` calls.
75 /// println!("Hello world!");
82 declare_clippy_lint! {
83 /// **What it does:** Checks for printing on *stderr*. The purpose of this lint
84 /// is to catch debugging remnants.
86 /// **Why is this bad?** People often print on *stderr* while debugging an
87 /// application and might forget to remove those prints afterward.
89 /// **Known problems:** Only catches `eprint!` and `eprintln!` calls.
93 /// eprintln!("Hello world!");
100 declare_clippy_lint! {
101 /// **What it does:** Checks for use of `Debug` formatting. The purpose of this
102 /// lint is to catch debugging remnants.
104 /// **Why is this bad?** The purpose of the `Debug` trait is to facilitate
105 /// debugging Rust code. It should not be used in user-facing output.
109 /// # let foo = "bar";
110 /// println!("{:?}", foo);
114 "use of `Debug`-based formatting"
117 declare_clippy_lint! {
118 /// **What it does:** This lint warns about the use of literals as `print!`/`println!` args.
120 /// **Why is this bad?** Using literals as `println!` args is inefficient
121 /// (c.f., https://github.com/matthiaskrgr/rust-str-bench) and unnecessary
122 /// (i.e., just put the literal in the format string)
124 /// **Known problems:** Will also warn with macro calls as arguments that expand to literals
125 /// -- e.g., `println!("{}", env!("FOO"))`.
129 /// println!("{}", "foo");
131 /// use the literal without formatting:
137 "printing a literal with a format string"
140 declare_clippy_lint! {
141 /// **What it does:** This lint warns when you use `writeln!(buf, "")` to
144 /// **Why is this bad?** You should use `writeln!(buf)`, which is simpler.
146 /// **Known problems:** None.
150 /// # use std::fmt::Write;
151 /// # let mut buf = String::new();
153 /// writeln!(buf, "");
158 pub WRITELN_EMPTY_STRING,
160 "using `writeln!(buf, \"\")` with an empty string"
163 declare_clippy_lint! {
164 /// **What it does:** This lint warns when you use `write!()` with a format
166 /// ends in a newline.
168 /// **Why is this bad?** You should use `writeln!()` instead, which appends the
171 /// **Known problems:** None.
175 /// # use std::fmt::Write;
176 /// # let mut buf = String::new();
177 /// # let name = "World";
179 /// write!(buf, "Hello {}!\n", name);
182 /// writeln!(buf, "Hello {}!", name);
184 pub WRITE_WITH_NEWLINE,
186 "using `write!()` with a format string that ends in a single newline"
189 declare_clippy_lint! {
190 /// **What it does:** This lint warns about the use of literals as `write!`/`writeln!` args.
192 /// **Why is this bad?** Using literals as `writeln!` args is inefficient
193 /// (c.f., https://github.com/matthiaskrgr/rust-str-bench) and unnecessary
194 /// (i.e., just put the literal in the format string)
196 /// **Known problems:** Will also warn with macro calls as arguments that expand to literals
197 /// -- e.g., `writeln!(buf, "{}", env!("FOO"))`.
201 /// # use std::fmt::Write;
202 /// # let mut buf = String::new();
204 /// writeln!(buf, "{}", "foo");
207 /// writeln!(buf, "foo");
211 "writing a literal with a format string"
219 impl_lint_pass!(Write => [
221 PRINTLN_EMPTY_STRING,
227 WRITELN_EMPTY_STRING,
231 impl EarlyLintPass for Write {
232 fn check_item(&mut self, _: &EarlyContext<'_>, item: &Item) {
233 if let ItemKind::Impl(box ImplKind {
234 of_trait: Some(trait_ref),
238 let trait_name = trait_ref
243 .expect("path has at least one segment")
246 if trait_name == sym::Debug {
247 self.in_debug_impl = true;
252 fn check_item_post(&mut self, _: &EarlyContext<'_>, _: &Item) {
253 self.in_debug_impl = false;
256 fn check_mac(&mut self, cx: &EarlyContext<'_>, mac: &MacCall) {
257 fn is_build_script(cx: &EarlyContext<'_>) -> bool {
258 // Cargo sets the crate name for build scripts to `build_script_build`
263 .map_or(false, |crate_name| crate_name == "build_script_build")
266 if mac.path == sym!(print) {
267 if !is_build_script(cx) {
268 span_lint(cx, PRINT_STDOUT, mac.span(), "use of `print!`");
270 self.lint_print_with_newline(cx, mac);
271 } else if mac.path == sym!(println) {
272 if !is_build_script(cx) {
273 span_lint(cx, PRINT_STDOUT, mac.span(), "use of `println!`");
275 self.lint_println_empty_string(cx, mac);
276 } else if mac.path == sym!(eprint) {
277 span_lint(cx, PRINT_STDERR, mac.span(), "use of `eprint!`");
278 self.lint_print_with_newline(cx, mac);
279 } else if mac.path == sym!(eprintln) {
280 span_lint(cx, PRINT_STDERR, mac.span(), "use of `eprintln!`");
281 self.lint_println_empty_string(cx, mac);
282 } else if mac.path == sym!(write) {
283 if let (Some(fmt_str), _) = self.check_tts(cx, mac.args.inner_tokens(), true) {
284 if check_newlines(&fmt_str) {
289 "using `write!()` with a format string that ends in a single newline",
291 err.multipart_suggestion(
292 "use `writeln!()` instead",
294 (mac.path.span, String::from("writeln")),
295 (newline_span(&fmt_str), String::new()),
297 Applicability::MachineApplicable,
303 } else if mac.path == sym!(writeln) {
304 if let (Some(fmt_str), expr) = self.check_tts(cx, mac.args.inner_tokens(), true) {
305 if fmt_str.symbol == kw::Empty {
306 let mut applicability = Applicability::MachineApplicable;
307 // FIXME: remove this `#[allow(...)]` once the issue #5822 gets fixed
308 #[allow(clippy::option_if_let_else)]
309 let suggestion = if let Some(e) = expr {
310 snippet_with_applicability(cx, e.span, "v", &mut applicability)
312 applicability = Applicability::HasPlaceholders;
318 WRITELN_EMPTY_STRING,
320 format!("using `writeln!({}, \"\")`", suggestion).as_str(),
322 format!("writeln!({})", suggestion),
331 /// Given a format string that ends in a newline and its span, calculates the span of the
332 /// newline, or the format string itself if the format string consists solely of a newline.
333 fn newline_span(fmtstr: &StrLit) -> Span {
334 let sp = fmtstr.span;
335 let contents = &fmtstr.symbol.as_str();
337 if *contents == r"\n" {
341 let newline_sp_hi = sp.hi()
342 - match fmtstr.style {
343 StrStyle::Cooked => BytePos(1),
344 StrStyle::Raw(hashes) => BytePos((1 + hashes).into()),
347 let newline_sp_len = if contents.ends_with('\n') {
349 } else if contents.ends_with(r"\n") {
352 panic!("expected format string to contain a newline");
355 sp.with_lo(newline_sp_hi - newline_sp_len).with_hi(newline_sp_hi)
359 /// Checks the arguments of `print[ln]!` and `write[ln]!` calls. It will return a tuple of two
360 /// `Option`s. The first `Option` of the tuple is the macro's format string. It includes
361 /// the contents of the string, whether it's a raw string, and the span of the literal in the
362 /// source. The second `Option` in the tuple is, in the `write[ln]!` case, the expression the
363 /// `format_str` should be written to.
367 /// Calling this function on
369 /// # use std::fmt::Write;
370 /// # let mut buf = String::new();
371 /// # let something = "something";
372 /// writeln!(buf, "string to write: {}", something);
376 /// (Some("string to write: {}"), Some(buf))
378 #[allow(clippy::too_many_lines)]
381 cx: &EarlyContext<'a>,
384 ) -> (Option<StrLit>, Option<Expr>) {
385 use rustc_parse_format::{
386 AlignUnknown, ArgumentImplicitlyIs, ArgumentIs, ArgumentNamed, CountImplied,
387 FormatSpec, ParseMode, Parser, Piece,
390 let mut parser = parser::Parser::new(&cx.sess.parse_sess, tts, false, None);
391 let mut expr: Option<Expr> = None;
393 expr = match parser.parse_expr().map_err(|mut err| err.cancel()) {
394 Ok(p) => Some(p.into_inner()),
395 Err(_) => return (None, None),
397 // might be `writeln!(foo)`
398 if parser.expect(&token::Comma).map_err(|mut err| err.cancel()).is_err() {
403 let fmtstr = match parser.parse_str_lit() {
404 Ok(fmtstr) => fmtstr,
405 Err(_) => return (None, expr),
407 let tmp = fmtstr.symbol.as_str();
408 let mut args = vec![];
409 let mut fmt_parser = Parser::new(&tmp, None, None, false, ParseMode::Format);
410 while let Some(piece) = fmt_parser.next() {
411 if !fmt_parser.errors.is_empty() {
414 if let Piece::NextArgument(arg) = piece {
415 if !self.in_debug_impl && arg.format.ty == "?" {
416 // FIXME: modify rustc's fmt string parser to give us the current span
420 parser.prev_token.span,
421 "use of `Debug`-based formatting",
427 let lint = if is_write { WRITE_LITERAL } else { PRINT_LITERAL };
430 const SIMPLE: FormatSpec<'_> = FormatSpec {
434 precision: CountImplied,
435 precision_span: None,
441 if !parser.eat(&token::Comma) {
442 return (Some(fmtstr), expr);
444 let token_expr = if let Ok(expr) = parser.parse_expr().map_err(|mut err| err.cancel()) {
447 return (Some(fmtstr), None);
449 match &token_expr.kind {
451 if !matches!(lit.kind, LitKind::Int(..) | LitKind::Float(..)) =>
453 let mut all_simple = true;
454 let mut seen = false;
457 ArgumentImplicitlyIs(n) | ArgumentIs(n) => {
459 all_simple &= arg.format == SIMPLE;
463 ArgumentNamed(_) => {}
466 if all_simple && seen {
467 span_lint(cx, lint, token_expr.span, "literal with an empty format string");
471 ExprKind::Assign(lhs, rhs, _) => {
473 if let ExprKind::Lit(ref lit) = rhs.kind;
474 if !matches!(lit.kind, LitKind::Int(..) | LitKind::Float(..));
475 if let ExprKind::Path(_, p) = &lhs.kind;
477 let mut all_simple = true;
478 let mut seen = false;
481 ArgumentImplicitlyIs(_) | ArgumentIs(_) => {},
482 ArgumentNamed(name) => {
485 all_simple &= arg.format == SIMPLE;
490 if all_simple && seen {
491 span_lint(cx, lint, rhs.span, "literal with an empty format string");
501 fn lint_println_empty_string(&self, cx: &EarlyContext<'_>, mac: &MacCall) {
502 if let (Some(fmt_str), _) = self.check_tts(cx, mac.args.inner_tokens(), false) {
503 if fmt_str.symbol == kw::Empty {
504 let name = mac.path.segments[0].ident.name;
507 PRINTLN_EMPTY_STRING,
509 &format!("using `{}!(\"\")`", name),
511 format!("{}!()", name),
512 Applicability::MachineApplicable,
518 fn lint_print_with_newline(&self, cx: &EarlyContext<'_>, mac: &MacCall) {
519 if let (Some(fmt_str), _) = self.check_tts(cx, mac.args.inner_tokens(), false) {
520 if check_newlines(&fmt_str) {
521 let name = mac.path.segments[0].ident.name;
522 let suggested = format!("{}ln", name);
528 "using `{}!()` with a format string that ends in a single newline",
532 err.multipart_suggestion(
533 &format!("use `{}!` instead", suggested),
535 (mac.path.span, suggested),
536 (newline_span(&fmt_str), String::new()),
538 Applicability::MachineApplicable,
547 /// Checks if the format string contains a single newline that terminates it.
549 /// Literal and escaped newlines are both checked (only literal for raw strings).
550 fn check_newlines(fmtstr: &StrLit) -> bool {
551 let mut has_internal_newline = false;
552 let mut last_was_cr = false;
553 let mut should_lint = false;
555 let contents = &fmtstr.symbol.as_str();
557 let mut cb = |r: Range<usize>, c: Result<char, EscapeError>| {
560 if r.end == contents.len() && c == '\n' && !last_was_cr && !has_internal_newline {
563 last_was_cr = c == '\r';
565 has_internal_newline = true;
571 StrStyle::Cooked => unescape::unescape_literal(contents, unescape::Mode::Str, &mut cb),
572 StrStyle::Raw(_) => unescape::unescape_literal(contents, unescape::Mode::RawStr, &mut cb),