Skip to content

Commit

Permalink
lint on items following statements
Browse files Browse the repository at this point in the history
  • Loading branch information
Oliver 'ker' Schneider committed Jan 24, 2016
1 parent 5dd0424 commit 2a51f8d
Show file tree
Hide file tree
Showing 6 changed files with 83 additions and 7 deletions.
3 changes: 2 additions & 1 deletion README.md
Expand Up @@ -6,7 +6,7 @@ A collection of lints to catch common mistakes and improve your Rust code.
[Jump to usage instructions](#usage)

##Lints
There are 96 lints included in this crate:
There are 97 lints included in this crate:

name | default | meaning
---------------------------------------------------------------------------------------------------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -37,6 +37,7 @@ name
[identity_op](https://github.com/Manishearth/rust-clippy/wiki#identity_op) | warn | using identity operations, e.g. `x + 0` or `y / 1`
[ineffective_bit_mask](https://github.com/Manishearth/rust-clippy/wiki#ineffective_bit_mask) | warn | expressions where a bit mask will be rendered useless by a comparison, e.g. `(x | 1) > 2`
[inline_always](https://github.com/Manishearth/rust-clippy/wiki#inline_always) | warn | `#[inline(always)]` is a bad idea in most cases
[items_after_statements](https://github.com/Manishearth/rust-clippy/wiki#items_after_statements) | warn | finds blocks where an item comes after a statement
[iter_next_loop](https://github.com/Manishearth/rust-clippy/wiki#iter_next_loop) | warn | for-looping over `_.next()` which is probably not intended
[len_without_is_empty](https://github.com/Manishearth/rust-clippy/wiki#len_without_is_empty) | warn | traits and impls that have `.len()` but not `.is_empty()`
[len_zero](https://github.com/Manishearth/rust-clippy/wiki#len_zero) | warn | checking `.len() == 0` or `.len() > 0` (or similar) when `.is_empty()` could be used instead
Expand Down
62 changes: 62 additions & 0 deletions src/items_after_statements.rs
@@ -0,0 +1,62 @@
//! lint when items are used after statements

use rustc::lint::*;
use syntax::attr::*;
use syntax::ast::*;
use utils::in_macro;

/// **What it does:** It `Warn`s on blocks where there are items that are declared in the middle of or after the statements
///
/// **Why is this bad?** Items live for the entire scope they are declared in. But statements are processed in order. This might cause confusion as it's hard to figure out which item is meant in a statement.
///
/// **Known problems:** None
///
/// **Example:**
/// ```rust
/// fn foo() {
/// println!("cake");
/// }
/// fn main() {
/// foo(); // prints "foo"
/// fn foo() {
/// println!("foo");
/// }
/// foo(); // prints "foo"
/// }
declare_lint! { pub ITEMS_AFTER_STATEMENTS, Warn, "finds blocks where an item comes after a statement" }

pub struct ItemsAfterStatemets;

impl LintPass for ItemsAfterStatemets {
fn get_lints(&self) -> LintArray {
lint_array!(ITEMS_AFTER_STATEMENTS)
}
}

impl EarlyLintPass for ItemsAfterStatemets {
fn check_block(&mut self, cx: &EarlyContext, item: &Block) {
if in_macro(cx, item.span) {
return;
}
let mut stmts = item.stmts.iter().map(|stmt| &stmt.node);
// skip initial items
while let Some(&StmtDecl(ref decl, _)) = stmts.next() {
if let DeclLocal(_) = decl.node {
break;
}
}
// lint on all further items
for stmt in stmts {
if let StmtDecl(ref decl, _) = *stmt {
if let DeclItem(ref it) = decl.node {
if in_macro(cx, it.span) {
return;
}
cx.struct_span_lint(ITEMS_AFTER_STATEMENTS, it.span,
"adding items after statements is confusing, since items exist from the start of the scope")
.emit();
}
}
}
}
}
3 changes: 3 additions & 0 deletions src/lib.rs
Expand Up @@ -43,6 +43,7 @@ pub mod needless_bool;
pub mod approx_const;
pub mod eta_reduction;
pub mod identity_op;
pub mod items_after_statements;
pub mod minmax;
pub mod mut_mut;
pub mod mut_reference;
Expand Down Expand Up @@ -97,6 +98,7 @@ pub fn plugin_registrar(reg: &mut Registry) {
reg.register_early_lint_pass(box precedence::Precedence);
reg.register_late_lint_pass(box eta_reduction::EtaPass);
reg.register_late_lint_pass(box identity_op::IdentityOp);
reg.register_early_lint_pass(box items_after_statements::ItemsAfterStatemets);
reg.register_late_lint_pass(box mut_mut::MutMut);
reg.register_late_lint_pass(box mut_reference::UnnecessaryMutPassed);
reg.register_late_lint_pass(box len_zero::LenZero);
Expand Down Expand Up @@ -176,6 +178,7 @@ pub fn plugin_registrar(reg: &mut Registry) {
escape::BOXED_LOCAL,
eta_reduction::REDUNDANT_CLOSURE,
identity_op::IDENTITY_OP,
items_after_statements::ITEMS_AFTER_STATEMENTS,
len_zero::LEN_WITHOUT_IS_EMPTY,
len_zero::LEN_ZERO,
lifetimes::NEEDLESS_LIFETIMES,
Expand Down
8 changes: 4 additions & 4 deletions src/mut_mut.rs
Expand Up @@ -37,17 +37,17 @@ impl LateLintPass for MutMut {
}

fn check_expr_mut(cx: &LateContext, expr: &Expr) {
if in_external_macro(cx, expr.span) {
return;
}

fn unwrap_addr(expr: &Expr) -> Option<&Expr> {
match expr.node {
ExprAddrOf(MutMutable, ref e) => Some(e),
_ => None,
}
}

if in_external_macro(cx, expr.span) {
return;
}

unwrap_addr(expr).map_or((), |e| {
unwrap_addr(e).map_or_else(|| {
if let TyRef(_, TypeAndMut{mutbl: MutMutable, ..}) = cx.tcx.expr_ty(e).sty {
Expand Down
5 changes: 3 additions & 2 deletions tests/compile-fail/cmp_owned.rs
Expand Up @@ -3,8 +3,6 @@

#[deny(cmp_owned)]
fn main() {
let x = "oh";

#[allow(str_to_string)]
fn with_to_string(x : &str) {
x != "foo".to_string();
Expand All @@ -13,6 +11,9 @@ fn main() {
"foo".to_string() != x;
//~^ ERROR this creates an owned instance just for comparison. Consider using `"foo" != x` to compare without allocation
}

let x = "oh";

with_to_string(x);

x != "foo".to_owned(); //~ERROR this creates an owned instance
Expand Down
9 changes: 9 additions & 0 deletions tests/compile-fail/item_after_statement.rs
@@ -0,0 +1,9 @@
#![feature(plugin)]
#![plugin(clippy)]
#![deny(items_after_statements)]

fn main() {
foo();
fn foo() { println!("foo"); } //~ ERROR adding items after statements is confusing
foo();
}

0 comments on commit 2a51f8d

Please sign in to comment.