Skip to content

Commit

Permalink
dead-code lint: say "constructed", "called" for structs, functions
Browse files Browse the repository at this point in the history
Respectively.

This is a sequel to November 2017's rust-lang#46103 / 1a9dc2e. It had been
reported (more than once—at least rust-lang#19140, rust-lang#44083, and rust-lang#44565) that the
"never used" language was confusing for enum variants that were "used"
as match patterns, so the wording was changed to say never "constructed"
specifically for enum variants. More recently, the same issue was raised
for structs (rust-lang#52325). It seems consistent to say "constructed" here,
too, for the same reasons.

While we're here, we can also use more specific word "called" for unused
functions and methods. (We declined to do this in rust-lang#46103, but the
rationale given in the commit message doesn't actually make sense.)

This resolves rust-lang#52325.
  • Loading branch information
zackmdavis committed Jul 13, 2018
1 parent 299ee47 commit 8cc4fd6
Show file tree
Hide file tree
Showing 14 changed files with 41 additions and 35 deletions.
10 changes: 8 additions & 2 deletions src/librustc/middle/dead.rs
Original file line number Diff line number Diff line change
Expand Up @@ -567,12 +567,17 @@ impl<'a, 'tcx> Visitor<'tcx> for DeadVisitor<'a, 'tcx> {
hir::ItemImpl(..) => self.tcx.sess.codemap().def_span(item.span),
_ => item.span,
};
let participle = match item.node {
hir::ItemFn(..) => "called",
hir::ItemStruct(..) => "constructed",
_ => "used"
};
self.warn_dead_code(
item.id,
span,
item.name,
item.node.descriptive_variant(),
"used",
participle,
);
} else {
// Only continue if we didn't warn
Expand Down Expand Up @@ -622,7 +627,8 @@ impl<'a, 'tcx> Visitor<'tcx> for DeadVisitor<'a, 'tcx> {
hir::ImplItemKind::Method(_, body_id) => {
if !self.symbol_is_live(impl_item.id, None) {
let span = self.tcx.sess.codemap().def_span(impl_item.span);
self.warn_dead_code(impl_item.id, span, impl_item.ident.name, "method", "used");
self.warn_dead_code(impl_item.id, span, impl_item.ident.name,
"method", "called");
}
self.visit_nested_body(body_id)
}
Expand Down
2 changes: 1 addition & 1 deletion src/test/compile-fail/fail-no-dead-code-core.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
#[macro_use]
extern crate core;

fn foo() { //~ ERROR function is never used
fn foo() { //~ ERROR function is never called

// none of these should have any dead_code exposed to the user
panic!();
Expand Down
2 changes: 1 addition & 1 deletion src/test/compile-fail/fail-no-dead-code.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
#![deny(dead_code)]
#![allow(unreachable_code)]

fn foo() { //~ ERROR function is never used
fn foo() { //~ ERROR function is never called

// none of these should have any dead_code exposed to the user
panic!();
Expand Down
10 changes: 5 additions & 5 deletions src/test/compile-fail/lint-dead-code-1.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
pub use foo2::Bar2;

mod foo {
pub struct Bar; //~ ERROR: struct is never used
pub struct Bar; //~ ERROR: struct is never constructed
}

mod foo2 {
Expand All @@ -42,7 +42,7 @@ const CONST_USED_IN_ENUM_DISCRIMINANT: isize = 11;

pub type typ = *const UsedStruct4;
pub struct PubStruct;
struct PrivStruct; //~ ERROR: struct is never used
struct PrivStruct; //~ ERROR: struct is never constructed
struct UsedStruct1 {
#[allow(dead_code)]
x: isize
Expand Down Expand Up @@ -95,17 +95,17 @@ pub fn pub_fn() {
}
f::<StructUsedInGeneric>();
}
fn priv_fn() { //~ ERROR: function is never used
fn priv_fn() { //~ ERROR: function is never called
let unused_struct = PrivStruct;
}
fn used_fn() {}

fn foo() { //~ ERROR: function is never used
fn foo() { //~ ERROR: function is never called
bar();
let unused_enum = priv_enum::foo2;
}

fn bar() { //~ ERROR: function is never used
fn bar() { //~ ERROR: function is never called
foo();
}

Expand Down
6 changes: 3 additions & 3 deletions src/test/compile-fail/lint-dead-code-2.rs
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ impl Bar for Foo {

fn live_fn() {}

fn dead_fn() {} //~ ERROR: function is never used
fn dead_fn() {} //~ ERROR: function is never called

#[main]
fn dead_fn2() {} //~ ERROR: function is never used
fn dead_fn2() {} //~ ERROR: function is never called

fn used_fn() {}

Expand All @@ -45,7 +45,7 @@ fn start(_: isize, _: *const *const u8) -> isize {
}

// this is not main
fn main() { //~ ERROR: function is never used
fn main() { //~ ERROR: function is never called
dead_fn();
dead_fn2();
}
6 changes: 3 additions & 3 deletions src/test/compile-fail/lint-dead-code-3.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ extern {
pub fn extern_foo();
}

struct Foo; //~ ERROR: struct is never used
struct Foo; //~ ERROR: struct is never constructed
impl Foo {
fn foo(&self) { //~ ERROR: method is never used
fn foo(&self) { //~ ERROR: method is never called
bar()
}
}

fn bar() { //~ ERROR: function is never used
fn bar() { //~ ERROR: function is never called
fn baz() {}

Foo.foo();
Expand Down
2 changes: 1 addition & 1 deletion src/test/compile-fail/test-warns-dead-code.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@

#![deny(dead_code)]

fn dead() {} //~ error: function is never used: `dead`
fn dead() {} //~ error: function is never called: `dead`

fn main() {}
2 changes: 1 addition & 1 deletion src/test/ui-fulldeps/lint-plugin-cmdline-allow.stderr
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
warning: function is never used: `lintme`
warning: function is never called: `lintme`
--> $DIR/lint-plugin-cmdline-allow.rs:20:1
|
LL | fn lintme() { }
Expand Down
4 changes: 2 additions & 2 deletions src/test/ui/path-lookahead.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@

// Parser test for #37765

fn with_parens<T: ToString>(arg: T) -> String { //~WARN function is never used: `with_parens`
fn with_parens<T: ToString>(arg: T) -> String { //~WARN function is never called: `with_parens`
return (<T as ToString>::to_string(&arg)); //~WARN unnecessary parentheses around `return` value
}

fn no_parens<T: ToString>(arg: T) -> String { //~WARN function is never used: `no_parens`
fn no_parens<T: ToString>(arg: T) -> String { //~WARN function is never called: `no_parens`
return <T as ToString>::to_string(&arg);
}

Expand Down
8 changes: 4 additions & 4 deletions src/test/ui/path-lookahead.stderr
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ LL | #![warn(unused)]
| ^^^^^^
= note: #[warn(unused_parens)] implied by #[warn(unused)]

warning: function is never used: `with_parens`
warning: function is never called: `with_parens`
--> $DIR/path-lookahead.rs:17:1
|
LL | fn with_parens<T: ToString>(arg: T) -> String { //~WARN function is never used: `with_parens`
LL | fn with_parens<T: ToString>(arg: T) -> String { //~WARN function is never called: `with_parens`
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
note: lint level defined here
Expand All @@ -24,9 +24,9 @@ LL | #![warn(unused)]
| ^^^^^^
= note: #[warn(dead_code)] implied by #[warn(unused)]

warning: function is never used: `no_parens`
warning: function is never called: `no_parens`
--> $DIR/path-lookahead.rs:21:1
|
LL | fn no_parens<T: ToString>(arg: T) -> String { //~WARN function is never used: `no_parens`
LL | fn no_parens<T: ToString>(arg: T) -> String { //~WARN function is never called: `no_parens`
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

2 changes: 1 addition & 1 deletion src/test/ui/span/macro-span-replacement.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

macro_rules! m {
($a:tt $b:tt) => {
$b $a; //~ WARN struct is never used
$b $a; //~ WARN struct is never constructed
}
}

Expand Down
4 changes: 2 additions & 2 deletions src/test/ui/span/macro-span-replacement.stderr
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
warning: struct is never used: `S`
warning: struct is never constructed: `S`
--> $DIR/macro-span-replacement.rs:17:14
|
LL | $b $a; //~ WARN struct is never used
LL | $b $a; //~ WARN struct is never constructed
| ^
...
LL | m!(S struct);
Expand Down
6 changes: 3 additions & 3 deletions src/test/ui/span/unused-warning-point-at-signature.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,18 @@ enum Enum { //~ WARN enum is never used
D,
}

struct Struct { //~ WARN struct is never used
struct Struct { //~ WARN struct is never constructed
a: usize,
b: usize,
c: usize,
d: usize,
}

fn func() -> usize { //~ WARN function is never used
fn func() -> usize { //~ WARN function is never called
3
}

fn //~ WARN function is never used
fn //~ WARN function is never called
func_complete_span()
-> usize
{
Expand Down
12 changes: 6 additions & 6 deletions src/test/ui/span/unused-warning-point-at-signature.stderr
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,22 @@ LL | #![warn(unused)]
| ^^^^^^
= note: #[warn(dead_code)] implied by #[warn(unused)]

warning: struct is never used: `Struct`
warning: struct is never constructed: `Struct`
--> $DIR/unused-warning-point-at-signature.rs:22:1
|
LL | struct Struct { //~ WARN struct is never used
LL | struct Struct { //~ WARN struct is never constructed
| ^^^^^^^^^^^^^

warning: function is never used: `func`
warning: function is never called: `func`
--> $DIR/unused-warning-point-at-signature.rs:29:1
|
LL | fn func() -> usize { //~ WARN function is never used
LL | fn func() -> usize { //~ WARN function is never called
| ^^^^^^^^^^^^^^^^^^

warning: function is never used: `func_complete_span`
warning: function is never called: `func_complete_span`
--> $DIR/unused-warning-point-at-signature.rs:33:1
|
LL | / fn //~ WARN function is never used
LL | / fn //~ WARN function is never called
LL | | func_complete_span()
LL | | -> usize
LL | | {
Expand Down

0 comments on commit 8cc4fd6

Please sign in to comment.