1 use crate::utils::{snippet_with_applicability, span_lint, span_lint_and_sugg};
2 use rustc::lint::{EarlyContext, EarlyLintPass, LintArray, LintPass};
3 use rustc::{declare_tool_lint, lint_array};
4 use rustc_errors::Applicability;
7 use syntax::parse::{parser, token};
8 use syntax::tokenstream::TokenStream;
10 /// **What it does:** This lint warns when you use `println!("")` to
13 /// **Why is this bad?** You should use `println!()`, which is simpler.
15 /// **Known problems:** None.
21 declare_clippy_lint! {
22 pub PRINTLN_EMPTY_STRING,
24 "using `println!(\"\")` with an empty string"
27 /// **What it does:** This lint warns when you use `print!()` with a format
29 /// ends in a newline.
31 /// **Why is this bad?** You should use `println!()` instead, which appends the
34 /// **Known problems:** None.
38 /// print!("Hello {}!\n", name);
40 /// use println!() instead
42 /// println!("Hello {}!", name);
44 declare_clippy_lint! {
45 pub PRINT_WITH_NEWLINE,
47 "using `print!()` with a format string that ends in a single newline"
50 /// **What it does:** Checks for printing on *stdout*. The purpose of this lint
51 /// is to catch debugging remnants.
53 /// **Why is this bad?** People often print on *stdout* while debugging an
54 /// application and might forget to remove those prints afterward.
56 /// **Known problems:** Only catches `print!` and `println!` calls.
60 /// println!("Hello world!");
62 declare_clippy_lint! {
68 /// **What it does:** Checks for use of `Debug` formatting. The purpose of this
69 /// lint is to catch debugging remnants.
71 /// **Why is this bad?** The purpose of the `Debug` trait is to facilitate
72 /// debugging Rust code. It should not be used in in user-facing output.
76 /// println!("{:?}", foo);
78 declare_clippy_lint! {
81 "use of `Debug`-based formatting"
84 /// **What it does:** This lint warns about the use of literals as `print!`/`println!` args.
86 /// **Why is this bad?** Using literals as `println!` args is inefficient
87 /// (c.f., https://github.com/matthiaskrgr/rust-str-bench) and unnecessary
88 /// (i.e., just put the literal in the format string)
90 /// **Known problems:** Will also warn with macro calls as arguments that expand to literals
91 /// -- e.g., `println!("{}", env!("FOO"))`.
95 /// println!("{}", "foo");
97 /// use the literal without formatting:
101 declare_clippy_lint! {
104 "printing a literal with a format string"
107 /// **What it does:** This lint warns when you use `writeln!(buf, "")` to
110 /// **Why is this bad?** You should use `writeln!(buf)`, which is simpler.
112 /// **Known problems:** None.
118 declare_clippy_lint! {
119 pub WRITELN_EMPTY_STRING,
121 "using `writeln!(\"\")` with an empty string"
124 /// **What it does:** This lint warns when you use `write!()` with a format
126 /// ends in a newline.
128 /// **Why is this bad?** You should use `writeln!()` instead, which appends the
131 /// **Known problems:** None.
135 /// write!(buf, "Hello {}!\n", name);
137 declare_clippy_lint! {
138 pub WRITE_WITH_NEWLINE,
140 "using `write!()` with a format string that ends in a single newline"
143 /// **What it does:** This lint warns about the use of literals as `write!`/`writeln!` args.
145 /// **Why is this bad?** Using literals as `writeln!` args is inefficient
146 /// (c.f., https://github.com/matthiaskrgr/rust-str-bench) and unnecessary
147 /// (i.e., just put the literal in the format string)
149 /// **Known problems:** Will also warn with macro calls as arguments that expand to literals
150 /// -- e.g., `writeln!(buf, "{}", env!("FOO"))`.
154 /// writeln!(buf, "{}", "foo");
156 declare_clippy_lint! {
159 "writing a literal with a format string"
162 #[derive(Copy, Clone, Debug)]
165 impl LintPass for Pass {
166 fn get_lints(&self) -> LintArray {
169 PRINTLN_EMPTY_STRING,
174 WRITELN_EMPTY_STRING,
180 impl EarlyLintPass for Pass {
181 fn check_mac(&mut self, cx: &EarlyContext<'_>, mac: &Mac) {
182 if mac.node.path == "println" {
183 span_lint(cx, PRINT_STDOUT, mac.span, "use of `println!`");
184 if let Some(fmtstr) = check_tts(cx, &mac.node.tts, false).0 {
188 PRINTLN_EMPTY_STRING,
190 "using `println!(\"\")`",
192 "println!()".to_string(),
193 Applicability::MachineApplicable,
197 } else if mac.node.path == "print" {
198 span_lint(cx, PRINT_STDOUT, mac.span, "use of `print!`");
199 if let Some(fmtstr) = check_tts(cx, &mac.node.tts, false).0 {
200 if check_newlines(&fmtstr) {
205 "using `print!()` with a format string that ends in a \
206 single newline, consider using `println!()` instead",
210 } else if mac.node.path == "write" {
211 if let Some(fmtstr) = check_tts(cx, &mac.node.tts, true).0 {
212 if check_newlines(&fmtstr) {
217 "using `write!()` with a format string that ends in a \
218 single newline, consider using `writeln!()` instead",
222 } else if mac.node.path == "writeln" {
223 let check_tts = check_tts(cx, &mac.node.tts, true);
224 if let Some(fmtstr) = check_tts.0 {
226 let mut applicability = Applicability::MachineApplicable;
227 let suggestion = check_tts.1.map_or_else(
229 applicability = Applicability::HasPlaceholders;
232 move |expr| snippet_with_applicability(cx, expr.span, "v", &mut applicability),
237 WRITELN_EMPTY_STRING,
239 format!("using `writeln!({}, \"\")`", suggestion).as_str(),
241 format!("writeln!({})", suggestion),
250 /// Checks the arguments of `print[ln]!` and `write[ln]!` calls. It will return a tuple of two
251 /// options. The first part of the tuple is `format_str` of the macros. The second part of the tuple
252 /// is in the `write[ln]!` case the expression the `format_str` should be written to.
256 /// Calling this function on
258 /// writeln!(buf, "string to write: {}", something)
262 /// (Some("string to write: {}"), Some(buf))
264 fn check_tts<'a>(cx: &EarlyContext<'a>, tts: &TokenStream, is_write: bool) -> (Option<String>, Option<Expr>) {
266 let tts = tts.clone();
267 let mut parser = parser::Parser::new(&cx.sess.parse_sess, tts, None, false, false);
268 let mut expr: Option<Expr> = None;
270 expr = match parser.parse_expr().map_err(|mut err| err.cancel()) {
271 Ok(p) => Some(p.into_inner()),
272 Err(_) => return (None, None),
274 // might be `writeln!(foo)`
275 if parser.expect(&token::Comma).map_err(|mut err| err.cancel()).is_err() {
280 let fmtstr = match parser.parse_str().map_err(|mut err| err.cancel()) {
281 Ok(token) => token.0.to_string(),
282 Err(_) => return (None, expr),
284 let tmp = fmtstr.clone();
285 let mut args = vec![];
286 let mut fmt_parser = Parser::new(&tmp, None, Vec::new(), false);
287 while let Some(piece) = fmt_parser.next() {
288 if !fmt_parser.errors.is_empty() {
291 if let Piece::NextArgument(arg) = piece {
292 if arg.format.ty == "?" {
293 // FIXME: modify rustc's fmt string parser to give us the current span
294 span_lint(cx, USE_DEBUG, parser.prev_span, "use of `Debug`-based formatting");
299 let lint = if is_write { WRITE_LITERAL } else { PRINT_LITERAL };
302 const SIMPLE: FormatSpec<'_> = FormatSpec {
306 precision: CountImplied,
310 if !parser.eat(&token::Comma) {
311 return (Some(fmtstr), expr);
313 let token_expr = match parser.parse_expr().map_err(|mut err| err.cancel()) {
315 Err(_) => return (Some(fmtstr), None),
317 match &token_expr.node {
318 ExprKind::Lit(_) => {
319 let mut all_simple = true;
320 let mut seen = false;
323 ArgumentImplicitlyIs(n) | ArgumentIs(n) => {
325 all_simple &= arg.format == SIMPLE;
329 ArgumentNamed(_) => {},
332 if all_simple && seen {
333 span_lint(cx, lint, token_expr.span, "literal with an empty format string");
337 ExprKind::Assign(lhs, rhs) => {
338 if let ExprKind::Lit(_) = rhs.node {
339 if let ExprKind::Path(_, p) = &lhs.node {
340 let mut all_simple = true;
341 let mut seen = false;
344 ArgumentImplicitlyIs(_) | ArgumentIs(_) => {},
345 ArgumentNamed(name) => {
348 all_simple &= arg.format == SIMPLE;
353 if all_simple && seen {
354 span_lint(cx, lint, rhs.span, "literal with an empty format string");
364 // Checks if `s` constains a single newline that terminates it
365 fn check_newlines(s: &str) -> bool {
370 let bytes = s.as_bytes();
371 if bytes[bytes.len() - 2] != b'\\' || bytes[bytes.len() - 1] != b'n' {
375 let mut escaping = false;
376 for (index, &byte) in bytes.iter().enumerate() {
379 return index == bytes.len() - 1;
382 } else if byte == b'\\' {