2018-10-06 16:18:06 +00:00
|
|
|
// Copyright 2014-2018 The Rust Project Developers. See the COPYRIGHT
|
|
|
|
// file at the top-level directory of this distribution.
|
|
|
|
//
|
|
|
|
// 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.
|
|
|
|
|
2015-11-18 11:35:18 +00:00
|
|
|
//! calculate cyclomatic complexity and warn about overly complex functions
|
|
|
|
|
2018-12-29 15:04:45 +00:00
|
|
|
use rustc::cfg::CFG;
|
|
|
|
use rustc::hir::intravisit::{walk_expr, NestedVisitorMap, Visitor};
|
|
|
|
use rustc::hir::*;
|
|
|
|
use rustc::lint::{LateContext, LateLintPass, LintArray, LintContext, LintPass};
|
|
|
|
use rustc::ty;
|
|
|
|
use rustc::{declare_tool_lint, lint_array};
|
|
|
|
use syntax::ast::{Attribute, NodeId};
|
|
|
|
use syntax::source_map::Span;
|
2015-11-18 11:35:18 +00:00
|
|
|
|
2018-05-30 08:15:50 +00:00
|
|
|
use crate::utils::{in_macro, is_allowed, match_type, paths, span_help_and_lint, LimitStack};
|
2015-11-18 11:35:18 +00:00
|
|
|
|
2016-08-06 07:55:04 +00:00
|
|
|
/// **What it does:** Checks for methods with high cyclomatic complexity.
|
2015-12-14 21:16:56 +00:00
|
|
|
///
|
2016-08-06 07:55:04 +00:00
|
|
|
/// **Why is this bad?** Methods of high cyclomatic complexity tend to be badly
|
|
|
|
/// readable. Also LLVM will usually optimize small methods better.
|
2015-12-14 21:16:56 +00:00
|
|
|
///
|
2017-08-09 07:30:56 +00:00
|
|
|
/// **Known problems:** Sometimes it's hard to find a way to reduce the
|
|
|
|
/// complexity.
|
2015-12-14 21:16:56 +00:00
|
|
|
///
|
|
|
|
/// **Example:** No. You'll see it when you get the warning.
|
2018-03-28 13:24:26 +00:00
|
|
|
declare_clippy_lint! {
|
2016-08-06 08:18:36 +00:00
|
|
|
pub CYCLOMATIC_COMPLEXITY,
|
2018-03-28 13:24:26 +00:00
|
|
|
complexity,
|
2016-08-06 08:18:36 +00:00
|
|
|
"functions that should be split up into multiple functions"
|
2016-02-05 23:13:29 +00:00
|
|
|
}
|
2015-11-18 11:35:18 +00:00
|
|
|
|
|
|
|
pub struct CyclomaticComplexity {
|
|
|
|
limit: LimitStack,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl CyclomaticComplexity {
|
|
|
|
pub fn new(limit: u64) -> Self {
|
2017-09-05 09:33:04 +00:00
|
|
|
Self {
|
|
|
|
limit: LimitStack::new(limit),
|
|
|
|
}
|
2015-11-18 11:35:18 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl LintPass for CyclomaticComplexity {
|
|
|
|
fn get_lints(&self) -> LintArray {
|
|
|
|
lint_array!(CYCLOMATIC_COMPLEXITY)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl CyclomaticComplexity {
|
2017-03-05 02:10:46 +00:00
|
|
|
fn check<'a, 'tcx: 'a>(&mut self, cx: &'a LateContext<'a, 'tcx>, body: &'tcx Body, span: Span) {
|
2017-03-31 22:14:04 +00:00
|
|
|
if in_macro(span) {
|
2016-01-04 04:26:12 +00:00
|
|
|
return;
|
|
|
|
}
|
2016-04-05 15:29:14 +00:00
|
|
|
|
2017-03-05 02:10:46 +00:00
|
|
|
let cfg = CFG::new(cx.tcx, body);
|
|
|
|
let expr = &body.value;
|
2015-11-18 11:35:18 +00:00
|
|
|
let n = cfg.graph.len_nodes() as u64;
|
|
|
|
let e = cfg.graph.len_edges() as u64;
|
2016-03-14 16:24:55 +00:00
|
|
|
if e + 2 < n {
|
|
|
|
// the function has unreachable code, other lints should catch this
|
|
|
|
return;
|
|
|
|
}
|
2015-11-18 11:35:18 +00:00
|
|
|
let cc = e + 2 - n;
|
2016-03-04 15:27:03 +00:00
|
|
|
let mut helper = CCHelper {
|
|
|
|
match_arms: 0,
|
|
|
|
divergence: 0,
|
2016-03-08 14:10:02 +00:00
|
|
|
short_circuits: 0,
|
2016-04-23 12:30:05 +00:00
|
|
|
returns: 0,
|
2018-03-15 15:07:15 +00:00
|
|
|
cx,
|
2016-03-04 15:27:03 +00:00
|
|
|
};
|
2016-11-16 20:57:56 +00:00
|
|
|
helper.visit_expr(expr);
|
2017-08-09 07:30:56 +00:00
|
|
|
let CCHelper {
|
|
|
|
match_arms,
|
|
|
|
divergence,
|
|
|
|
short_circuits,
|
|
|
|
returns,
|
|
|
|
..
|
|
|
|
} = helper;
|
2017-08-15 09:10:49 +00:00
|
|
|
let ret_ty = cx.tables.node_id_to_type(expr.hir_id);
|
2016-04-23 12:30:05 +00:00
|
|
|
let ret_adjust = if match_type(cx, ret_ty, &paths::RESULT) {
|
|
|
|
returns
|
|
|
|
} else {
|
|
|
|
returns / 2
|
|
|
|
};
|
2016-03-04 15:27:03 +00:00
|
|
|
|
2016-06-05 23:42:39 +00:00
|
|
|
if cc + divergence < match_arms + short_circuits {
|
2017-08-11 12:11:46 +00:00
|
|
|
report_cc_bug(
|
|
|
|
cx,
|
|
|
|
cc,
|
|
|
|
match_arms,
|
|
|
|
divergence,
|
|
|
|
short_circuits,
|
|
|
|
ret_adjust,
|
|
|
|
span,
|
|
|
|
body.id().node_id,
|
|
|
|
);
|
2015-12-05 08:53:00 +00:00
|
|
|
} else {
|
2016-04-23 12:30:05 +00:00
|
|
|
let mut rust_cc = cc + divergence - match_arms - short_circuits;
|
|
|
|
// prevent degenerate cases where unreachable code contains `return` statements
|
|
|
|
if rust_cc >= ret_adjust {
|
|
|
|
rust_cc -= ret_adjust;
|
|
|
|
}
|
2015-12-05 08:53:00 +00:00
|
|
|
if rust_cc > self.limit.limit() {
|
2017-08-09 07:30:56 +00:00
|
|
|
span_help_and_lint(
|
|
|
|
cx,
|
|
|
|
CYCLOMATIC_COMPLEXITY,
|
|
|
|
span,
|
|
|
|
&format!("the function has a cyclomatic complexity of {}", rust_cc),
|
|
|
|
"you could split it up into multiple smaller functions",
|
|
|
|
);
|
2015-12-05 08:53:00 +00:00
|
|
|
}
|
2015-11-18 11:35:18 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-12-07 12:13:40 +00:00
|
|
|
impl<'a, 'tcx> LateLintPass<'a, 'tcx> for CyclomaticComplexity {
|
2017-01-13 16:04:56 +00:00
|
|
|
fn check_fn(
|
|
|
|
&mut self,
|
|
|
|
cx: &LateContext<'a, 'tcx>,
|
|
|
|
_: intravisit::FnKind<'tcx>,
|
|
|
|
_: &'tcx FnDecl,
|
|
|
|
body: &'tcx Body,
|
|
|
|
span: Span,
|
2017-08-09 07:30:56 +00:00
|
|
|
node_id: NodeId,
|
2017-01-13 16:04:56 +00:00
|
|
|
) {
|
2018-12-08 00:56:03 +00:00
|
|
|
let def_id = cx.tcx.hir().local_def_id(node_id);
|
2017-01-13 16:04:56 +00:00
|
|
|
if !cx.tcx.has_attr(def_id, "test") {
|
2017-03-05 02:10:46 +00:00
|
|
|
self.check(cx, body, span);
|
2015-11-18 11:35:18 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-12-07 12:13:40 +00:00
|
|
|
fn enter_lint_attrs(&mut self, cx: &LateContext<'a, 'tcx>, attrs: &'tcx [Attribute]) {
|
2018-11-27 20:14:15 +00:00
|
|
|
self.limit.push_attrs(cx.sess(), attrs, "cyclomatic_complexity");
|
2015-11-18 11:35:18 +00:00
|
|
|
}
|
2016-12-07 12:13:40 +00:00
|
|
|
fn exit_lint_attrs(&mut self, cx: &LateContext<'a, 'tcx>, attrs: &'tcx [Attribute]) {
|
2018-11-27 20:14:15 +00:00
|
|
|
self.limit.pop_attrs(cx.sess(), attrs, "cyclomatic_complexity");
|
2015-11-18 11:35:18 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-12-06 10:32:21 +00:00
|
|
|
struct CCHelper<'a, 'tcx: 'a> {
|
2016-03-04 15:27:03 +00:00
|
|
|
match_arms: u64,
|
|
|
|
divergence: u64,
|
2016-04-23 12:30:05 +00:00
|
|
|
returns: u64,
|
2016-03-08 14:10:02 +00:00
|
|
|
short_circuits: u64, // && and ||
|
2016-12-06 10:32:21 +00:00
|
|
|
cx: &'a LateContext<'a, 'tcx>,
|
2016-03-04 15:27:03 +00:00
|
|
|
}
|
2015-11-18 11:35:18 +00:00
|
|
|
|
2016-12-06 10:32:21 +00:00
|
|
|
impl<'a, 'tcx> Visitor<'tcx> for CCHelper<'a, 'tcx> {
|
|
|
|
fn visit_expr(&mut self, e: &'tcx Expr) {
|
2015-11-18 11:35:18 +00:00
|
|
|
match e.node {
|
2018-07-12 07:30:57 +00:00
|
|
|
ExprKind::Match(_, ref arms, _) => {
|
2015-11-18 11:35:18 +00:00
|
|
|
walk_expr(self, e);
|
|
|
|
let arms_n: u64 = arms.iter().map(|arm| arm.pats.len() as u64).sum();
|
2015-12-14 13:29:20 +00:00
|
|
|
if arms_n > 1 {
|
2016-03-04 15:27:03 +00:00
|
|
|
self.match_arms += arms_n - 2;
|
2015-12-14 13:29:20 +00:00
|
|
|
}
|
2016-12-20 17:21:30 +00:00
|
|
|
},
|
2018-07-12 07:30:57 +00:00
|
|
|
ExprKind::Call(ref callee, _) => {
|
2015-12-14 13:29:20 +00:00
|
|
|
walk_expr(self, e);
|
2017-08-15 09:10:49 +00:00
|
|
|
let ty = self.cx.tables.node_id_to_type(callee.hir_id);
|
2016-03-10 17:13:49 +00:00
|
|
|
match ty.sty {
|
2018-08-22 21:34:52 +00:00
|
|
|
ty::FnDef(..) | ty::FnPtr(_) => {
|
2017-06-29 13:38:25 +00:00
|
|
|
let sig = ty.fn_sig(self.cx.tcx);
|
2018-08-22 21:34:52 +00:00
|
|
|
if sig.skip_binder().output().sty == ty::Never {
|
2017-06-29 13:38:25 +00:00
|
|
|
self.divergence += 1;
|
|
|
|
}
|
2016-12-20 17:21:30 +00:00
|
|
|
},
|
2016-03-10 17:13:49 +00:00
|
|
|
_ => (),
|
2015-11-18 11:35:18 +00:00
|
|
|
}
|
2016-12-20 17:21:30 +00:00
|
|
|
},
|
2018-07-12 07:30:57 +00:00
|
|
|
ExprKind::Closure(.., _) => (),
|
|
|
|
ExprKind::Binary(op, _, _) => {
|
2016-03-08 14:10:02 +00:00
|
|
|
walk_expr(self, e);
|
|
|
|
match op.node {
|
2018-07-12 07:50:09 +00:00
|
|
|
BinOpKind::And | BinOpKind::Or => self.short_circuits += 1,
|
2016-04-14 18:14:03 +00:00
|
|
|
_ => (),
|
2016-03-08 14:10:02 +00:00
|
|
|
}
|
2016-12-20 17:21:30 +00:00
|
|
|
},
|
2018-07-12 07:30:57 +00:00
|
|
|
ExprKind::Ret(_) => self.returns += 1,
|
2015-11-18 11:35:18 +00:00
|
|
|
_ => walk_expr(self, e),
|
|
|
|
}
|
|
|
|
}
|
2016-12-06 10:32:21 +00:00
|
|
|
fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
|
|
|
|
NestedVisitorMap::None
|
|
|
|
}
|
2015-11-18 11:35:18 +00:00
|
|
|
}
|
2015-12-05 08:53:00 +00:00
|
|
|
|
2017-08-09 07:30:56 +00:00
|
|
|
#[cfg(feature = "debugging")]
|
2018-08-01 20:48:41 +00:00
|
|
|
#[allow(clippy::too_many_arguments)]
|
2018-11-27 20:14:15 +00:00
|
|
|
fn report_cc_bug(
|
|
|
|
_: &LateContext<'_, '_>,
|
|
|
|
cc: u64,
|
|
|
|
narms: u64,
|
|
|
|
div: u64,
|
|
|
|
shorts: u64,
|
|
|
|
returns: u64,
|
|
|
|
span: Span,
|
|
|
|
_: NodeId,
|
|
|
|
) {
|
2017-08-09 07:30:56 +00:00
|
|
|
span_bug!(
|
|
|
|
span,
|
|
|
|
"Clippy encountered a bug calculating cyclomatic complexity: cc = {}, arms = {}, \
|
2017-09-05 09:33:04 +00:00
|
|
|
div = {}, shorts = {}, returns = {}. Please file a bug report.",
|
2017-08-09 07:30:56 +00:00
|
|
|
cc,
|
|
|
|
narms,
|
|
|
|
div,
|
|
|
|
shorts,
|
|
|
|
returns
|
|
|
|
);
|
2015-12-05 08:53:00 +00:00
|
|
|
}
|
2017-08-09 07:30:56 +00:00
|
|
|
#[cfg(not(feature = "debugging"))]
|
2018-08-01 20:48:41 +00:00
|
|
|
#[allow(clippy::too_many_arguments)]
|
2018-11-27 20:14:15 +00:00
|
|
|
fn report_cc_bug(
|
|
|
|
cx: &LateContext<'_, '_>,
|
|
|
|
cc: u64,
|
|
|
|
narms: u64,
|
|
|
|
div: u64,
|
|
|
|
shorts: u64,
|
|
|
|
returns: u64,
|
|
|
|
span: Span,
|
|
|
|
id: NodeId,
|
|
|
|
) {
|
2017-08-11 12:11:46 +00:00
|
|
|
if !is_allowed(cx, CYCLOMATIC_COMPLEXITY, id) {
|
2017-08-09 07:30:56 +00:00
|
|
|
cx.sess().span_note_without_error(
|
|
|
|
span,
|
|
|
|
&format!(
|
|
|
|
"Clippy encountered a bug calculating cyclomatic complexity \
|
2017-09-05 09:33:04 +00:00
|
|
|
(hide this message with `#[allow(cyclomatic_complexity)]`): \
|
|
|
|
cc = {}, arms = {}, div = {}, shorts = {}, returns = {}. \
|
|
|
|
Please file a bug report.",
|
2018-11-27 20:14:15 +00:00
|
|
|
cc, narms, div, shorts, returns
|
2017-08-09 07:30:56 +00:00
|
|
|
),
|
|
|
|
);
|
2015-12-05 08:53:00 +00:00
|
|
|
}
|
|
|
|
}
|