Skip to content

WIP: Add duration_subsec lint #2558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions clippy_lints/src/duration_subsec.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
use rustc::lint::*;
use rustc::hir::*;
use syntax::codemap::Spanned;
use consts::{constant, Constant};
use utils::{match_type, snippet, span_lint_and_sugg, walk_ptrs_ty};
use utils::paths;

/// **What it does:** Checks for calculation of subsecond microseconds or milliseconds from
/// `Duration::subsec_nanos()`.
///
/// **Why is this bad?** It's more concise to call `Duration::subsec_micros()` or
/// `Duration::subsec_millis()`.
///
/// **Known problems:** None.
///
/// **Example:**
/// ```rust
/// let dur = Duration::new(5, 0);
/// let _micros = dur.subsec_nanos() / 1_000;
/// let _millis = dur.subsec_nanos() / 1_000_000;
/// ```
declare_lint! {
pub DURATION_SUBSEC,
Warn,
"checking `dur.subsec_nanos() / 1_000` or `dur.subsec_nanos() / 1_000_000`"
}

#[derive(Copy, Clone)]
pub struct DurationSubsec;

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

impl<'a, 'tcx> LateLintPass<'a, 'tcx> for DurationSubsec {
fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
if_chain! {
if let ExprBinary(Spanned { node: BiDiv, .. }, ref left, ref right) = expr.node;
if let ExprMethodCall(ref method_path, _ , ref args) = left.node;
if method_path.name == "subsec_nanos";
if match_type(cx, walk_ptrs_ty(cx.tables.expr_ty(&args[0])), &paths::DURATION);
if let Some((Constant::Int(divisor), _)) = constant(cx, right);
then {
let suggested_fn = match divisor {
1_000 => "subsec_micros",
1_000_000 => "subsec_millis",
_ => return,
};

span_lint_and_sugg(
cx,
DURATION_SUBSEC,
expr.span,
&format!("Calling `{}()` is more concise than this calculation", suggested_fn),
"try",
format!("{}.{}()", snippet(cx, args[0].span, "_"), suggested_fn),
);
}
}
}
}
3 changes: 3 additions & 0 deletions clippy_lints/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ pub mod doc;
pub mod double_comparison;
pub mod double_parens;
pub mod drop_forget_ref;
pub mod duration_subsec;
pub mod else_if_without_else;
pub mod empty_enum;
pub mod entry;
Expand Down Expand Up @@ -402,6 +403,7 @@ pub fn register_plugins(reg: &mut rustc_plugin::Registry) {
reg.register_late_lint_pass(box question_mark::QuestionMarkPass);
reg.register_late_lint_pass(box suspicious_trait_impl::SuspiciousImpl);
reg.register_late_lint_pass(box redundant_field_names::RedundantFieldNames);
reg.register_late_lint_pass(box duration_subsec::DurationSubsec);


reg.register_lint_group("clippy_restriction", vec![
Expand Down Expand Up @@ -495,6 +497,7 @@ pub fn register_plugins(reg: &mut rustc_plugin::Registry) {
drop_forget_ref::DROP_REF,
drop_forget_ref::FORGET_COPY,
drop_forget_ref::FORGET_REF,
duration_subsec::DURATION_SUBSEC,
entry::MAP_ENTRY,
enum_clike::ENUM_CLIKE_UNPORTABLE_VARIANT,
enum_variants::ENUM_VARIANT_NAMES,
Expand Down
1 change: 1 addition & 0 deletions clippy_lints/src/utils/paths.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ pub const DEFAULT_TRAIT: [&str; 3] = ["core", "default", "Default"];
pub const DISPLAY_FMT_METHOD: [&str; 4] = ["core", "fmt", "Display", "fmt"];
pub const DOUBLE_ENDED_ITERATOR: [&str; 4] = ["core", "iter", "traits", "DoubleEndedIterator"];
pub const DROP: [&str; 3] = ["core", "mem", "drop"];
pub const DURATION: [&str; 3] = ["core", "time", "Duration"];
pub const FMT_ARGUMENTS_NEWV1: [&str; 4] = ["core", "fmt", "Arguments", "new_v1"];
pub const FMT_ARGUMENTV1_NEW: [&str; 4] = ["core", "fmt", "ArgumentV1", "new"];
pub const FROM_FROM: [&str; 4] = ["core", "convert", "From", "from"];
Expand Down
28 changes: 28 additions & 0 deletions tests/ui/duration_subsec.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
#![warn(duration_subsec)]

#![feature(duration_extras)]

use std::time::Duration;

fn main() {
let dur = Duration::new(5, 0);

let bad_micros = dur.subsec_nanos() / 1_000;
let good_micros = dur.subsec_micros();
assert_eq!(bad_micros, good_micros);

let bad_millis = dur.subsec_nanos() / 1_000_000;
let good_millis = dur.subsec_millis();
assert_eq!(bad_millis, good_millis);

// Handle refs
let _ = (&dur).subsec_nanos() / 1_000;

// Handle simple constants
const NANOS_IN_MICRO: u32 = 1_000;
let _ = dur.subsec_nanos() / NANOS_IN_MICRO;

// Other literals aren't linted
let _ = dur.subsec_nanos() / 699;

}
28 changes: 28 additions & 0 deletions tests/ui/duration_subsec.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
error: Calling `subsec_micros()` is more concise than this calculation
--> $DIR/duration_subsec.rs:10:22
|
10 | let bad_micros = dur.subsec_nanos() / 1_000;
| ^^^^^^^^^^^^^^^^^^^^^^^^^^ help: try: `dur.subsec_micros()`
|
= note: `-D duration-subsec` implied by `-D warnings`

error: Calling `subsec_millis()` is more concise than this calculation
--> $DIR/duration_subsec.rs:14:22
|
14 | let bad_millis = dur.subsec_nanos() / 1_000_000;
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: try: `dur.subsec_millis()`

error: Calling `subsec_micros()` is more concise than this calculation
--> $DIR/duration_subsec.rs:19:13
|
19 | let _ = (&dur).subsec_nanos() / 1_000;
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: try: `(&dur).subsec_micros()`

error: Calling `subsec_micros()` is more concise than this calculation
--> $DIR/duration_subsec.rs:23:13
|
23 | let _ = dur.subsec_nanos() / NANOS_IN_MICRO;
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: try: `dur.subsec_micros()`

error: aborting due to 4 previous errors

Empty file added tests/ui/duration_subsec.stdout
Empty file.