Skip to content

Commit

Permalink
Add new lint: non_uppercase_pattern_statics, for rust-lang#7526.
Browse files Browse the repository at this point in the history
This tries to warn about code like:
    ```rust
    match (0,0) {
        (0, aha) => { ... },
        ...
    }
    ```
where `aha` is actually a static constant, not a binding.
  • Loading branch information
pnkfelix committed Sep 30, 2013
1 parent 8174618 commit a076fef
Show file tree
Hide file tree
Showing 12 changed files with 129 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/librustc/lib/llvm.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
// LLVM wrappers are intended to be called from trans,
// which already runs in a #[fixed_stack_segment]
#[allow(cstack)];
#[allow(non_uppercase_pattern_statics)];

use std::c_str::ToCStr;
use std::hashmap::HashMap;
Expand Down
20 changes: 20 additions & 0 deletions src/librustc/middle/check_match.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@

use middle::const_eval::{compare_const_vals, lookup_const_by_id};
use middle::const_eval::{eval_const_expr, const_val, const_bool, const_float};
use middle::lint::non_uppercase_pattern_statics;
use middle::pat_util::*;
use middle::ty::*;
use middle::ty;
Expand Down Expand Up @@ -133,11 +134,30 @@ pub fn check_arms(cx: &MatchCheckCtxt, arms: &[Arm]) {
_ => false
}
};

// Lint for constants that look like binding identifiers (#7526)
let pat_matches_non_uppercase_static: &fn(@Pat) = |p| {
let msg = "static constant in pattern should have an uppercase identifier";
match (&p.node, cx.tcx.def_map.find(&p.id)) {
(&PatIdent(_, ref path, _), Some(&DefStatic(_, false))) => {
// last identifier alone is right choice for this lint.
let ident = path.segments.last().identifier;
let s = cx.tcx.sess.str_of(ident);
if s.iter().any(|c| c.is_lowercase()) {
cx.tcx.sess.add_lint(non_uppercase_pattern_statics,
p.id, path.span, msg.to_owned());
}
}
_ => {}
}
};

do walk_pat(*pat) |p| {
if pat_matches_nan(p) {
cx.tcx.sess.span_warn(p.span, "unmatchable NaN in pattern, \
use the is_nan method in a guard instead");
}
pat_matches_non_uppercase_static(p);
true
};

Expand Down
8 changes: 8 additions & 0 deletions src/librustc/middle/lint.rs
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ pub enum lint {
unrecognized_lint,
non_camel_case_types,
non_uppercase_statics,
non_uppercase_pattern_statics,
type_limits,
unused_unsafe,

Expand Down Expand Up @@ -209,6 +210,13 @@ static lint_table: &'static [(&'static str, LintSpec)] = &[
default: allow
}),

("non_uppercase_pattern_statics",
LintSpec {
lint: non_uppercase_pattern_statics,
desc: "static constants in match patterns should be uppercased",
default: warn
}),

("managed_heap_memory",
LintSpec {
lint: managed_heap_memory,
Expand Down
2 changes: 2 additions & 0 deletions src/librustc/middle/trans/cabi_arm.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

#[allow(non_uppercase_pattern_statics)];

use lib::llvm::{llvm, Integer, Pointer, Float, Double, Struct, Array};
use lib::llvm::{Attribute, StructRetAttribute};
use middle::trans::cabi::{FnType, LLVMType};
Expand Down
1 change: 1 addition & 0 deletions src/librustc/middle/trans/cabi_mips.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

#[allow(non_uppercase_pattern_statics)];

use std::libc::c_uint;
use std::num;
Expand Down
2 changes: 2 additions & 0 deletions src/librustc/middle/trans/cabi_x86_64.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
// The classification code for the x86_64 ABI is taken from the clay language
// https://github.com/jckarter/clay/blob/master/compiler/src/externals.cpp

#[allow(non_uppercase_pattern_statics)];

use lib::llvm::{llvm, Integer, Pointer, Float, Double};
use lib::llvm::{Struct, Array, Attribute};
use lib::llvm::{StructRetAttribute, ByValAttribute};
Expand Down
2 changes: 2 additions & 0 deletions src/librustc/middle/trans/intrinsic.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

#[allow(non_uppercase_pattern_statics)];

use back::{abi};
use lib::llvm::{SequentiallyConsistent, Acquire, Release, Xchg};
use lib::llvm::{ValueRef, Pointer};
Expand Down
1 change: 1 addition & 0 deletions src/librustc/middle/trans/type_.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

#[allow(non_uppercase_pattern_statics)];

use lib::llvm::{llvm, TypeRef, Bool, False, True, TypeKind};
use lib::llvm::{Float, Double, X86_FP80, PPC_FP128, FP128};
Expand Down
1 change: 1 addition & 0 deletions src/libstd/num/f32.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
//! Operations and constants for `f32`
#[allow(missing_doc)];
#[allow(non_uppercase_statics)];
#[allow(non_uppercase_pattern_statics)];

use default::Default;
use libc::c_int;
Expand Down
1 change: 1 addition & 0 deletions src/libstd/num/f64.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
#[allow(missing_doc)];
#[allow(non_uppercase_statics)];
#[allow(non_uppercase_pattern_statics)];

use default::Default;
use libc::c_int;
Expand Down
43 changes: 43 additions & 0 deletions src/test/compile-fail/match-static-const-lc.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
// Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

// Issue #7526: lowercase static constants in patterns look like bindings

#[deny(non_uppercase_pattern_statics)];

pub static a : int = 97;

fn f() {
let r = match (0,0) {
(0, a) => 0,
//~^ ERROR static constant in pattern should have an uppercase id
(x, y) => 1 + x + y,
};
assert!(r == 1);
}

mod m {
pub static aha : int = 7;
}

fn g() {
use m::aha;
let r = match (0,0) {
(0, aha) => 0,
//~^ ERROR static constant in pattern should have an uppercase id
(x, y) => 1 + x + y,
};
assert!(r == 1);
}

fn main () {
f();
g();
}
47 changes: 47 additions & 0 deletions src/test/run-pass/match-static-const-rename.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
// Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

// Issue #7526: lowercase static constants in patterns look like bindings

// This is similar to compile-fail/match-static-const-lc, except it
// shows the expected usual workaround (choosing a different name for
// the static definition) and also demonstrates that one can work
// around this problem locally by reanming the constant in the `use`
// form to an uppercase identifier that placates the lint.

#[deny(non_uppercase_pattern_statics)];

pub static A : int = 97;

fn f() {
let r = match (0,0) {
(0, A) => 0,
(x, y) => 1 + x + y,
};
assert!(r == 1);
}

mod m {
pub static aha : int = 7;
}

fn g() {
use AHA = m::aha;
let r = match (0,0) {
(0, AHA) => 0,
(x, y) => 1 + x + y,
};
assert!(r == 1);
}

fn main () {
f();
g();
}

0 comments on commit a076fef

Please sign in to comment.