1 //! calculate cyclomatic complexity and warn about overly complex functions
7 use rustc::hir::intravisit::{Visitor, walk_expr, NestedVisitorMap};
8 use syntax::ast::{Attribute, NodeId};
9 use syntax::codemap::Span;
11 use utils::{in_macro, LimitStack, span_help_and_lint, paths, match_type};
13 /// **What it does:** Checks for methods with high cyclomatic complexity.
15 /// **Why is this bad?** Methods of high cyclomatic complexity tend to be badly
16 /// readable. Also LLVM will usually optimize small methods better.
18 /// **Known problems:** Sometimes it's hard to find a way to reduce the complexity.
20 /// **Example:** No. You'll see it when you get the warning.
22 pub CYCLOMATIC_COMPLEXITY,
24 "functions that should be split up into multiple functions"
27 pub struct CyclomaticComplexity {
31 impl CyclomaticComplexity {
32 pub fn new(limit: u64) -> Self {
33 CyclomaticComplexity { limit: LimitStack::new(limit) }
37 impl LintPass for CyclomaticComplexity {
38 fn get_lints(&self) -> LintArray {
39 lint_array!(CYCLOMATIC_COMPLEXITY)
43 impl CyclomaticComplexity {
44 fn check<'a, 'tcx: 'a>(&mut self, cx: &'a LateContext<'a, 'tcx>, body: &'tcx Body, span: Span) {
49 let cfg = CFG::new(cx.tcx, body);
50 let expr = &body.value;
51 let n = cfg.graph.len_nodes() as u64;
52 let e = cfg.graph.len_edges() as u64;
54 // the function has unreachable code, other lints should catch this
58 let mut helper = CCHelper {
65 helper.visit_expr(expr);
66 let CCHelper { match_arms, divergence, short_circuits, returns, .. } = helper;
67 let ret_ty = cx.tables.node_id_to_type(expr.id);
68 let ret_adjust = if match_type(cx, ret_ty, &paths::RESULT) {
74 if cc + divergence < match_arms + short_circuits {
75 report_cc_bug(cx, cc, match_arms, divergence, short_circuits, ret_adjust, span);
77 let mut rust_cc = cc + divergence - match_arms - short_circuits;
78 // prevent degenerate cases where unreachable code contains `return` statements
79 if rust_cc >= ret_adjust {
80 rust_cc -= ret_adjust;
82 if rust_cc > self.limit.limit() {
83 span_help_and_lint(cx,
84 CYCLOMATIC_COMPLEXITY,
86 &format!("the function has a cyclomatic complexity of {}", rust_cc),
87 "you could split it up into multiple smaller functions");
93 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for CyclomaticComplexity {
96 cx: &LateContext<'a, 'tcx>,
97 _: intravisit::FnKind<'tcx>,
103 let def_id = cx.tcx.hir.local_def_id(node_id);
104 if !cx.tcx.has_attr(def_id, "test") {
105 self.check(cx, body, span);
109 fn enter_lint_attrs(&mut self, cx: &LateContext<'a, 'tcx>, attrs: &'tcx [Attribute]) {
110 self.limit.push_attrs(cx.sess(), attrs, "cyclomatic_complexity");
112 fn exit_lint_attrs(&mut self, cx: &LateContext<'a, 'tcx>, attrs: &'tcx [Attribute]) {
113 self.limit.pop_attrs(cx.sess(), attrs, "cyclomatic_complexity");
117 struct CCHelper<'a, 'tcx: 'a> {
121 short_circuits: u64, // && and ||
122 cx: &'a LateContext<'a, 'tcx>,
125 impl<'a, 'tcx> Visitor<'tcx> for CCHelper<'a, 'tcx> {
126 fn visit_expr(&mut self, e: &'tcx Expr) {
128 ExprMatch(_, ref arms, _) => {
130 let arms_n: u64 = arms.iter().map(|arm| arm.pats.len() as u64).sum();
132 self.match_arms += arms_n - 2;
135 ExprCall(ref callee, _) => {
137 let ty = self.cx.tables.node_id_to_type(callee.id);
141 let sig = ty.fn_sig(self.cx.tcx);
142 if sig.skip_binder().output().sty == ty::TyNever {
143 self.divergence += 1;
149 ExprClosure(..) => (),
150 ExprBinary(op, _, _) => {
153 BiAnd | BiOr => self.short_circuits += 1,
157 ExprRet(_) => self.returns += 1,
158 _ => walk_expr(self, e),
161 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
162 NestedVisitorMap::None
166 #[cfg(feature="debugging")]
167 fn report_cc_bug(_: &LateContext, cc: u64, narms: u64, div: u64, shorts: u64, returns: u64, span: Span) {
169 "Clippy encountered a bug calculating cyclomatic complexity: cc = {}, arms = {}, \
170 div = {}, shorts = {}, returns = {}. Please file a bug report.",
177 #[cfg(not(feature="debugging"))]
178 fn report_cc_bug(cx: &LateContext, cc: u64, narms: u64, div: u64, shorts: u64, returns: u64, span: Span) {
179 if cx.current_level(CYCLOMATIC_COMPLEXITY) != Level::Allow {
180 cx.sess().span_note_without_error(span,
181 &format!("Clippy encountered a bug calculating cyclomatic complexity \
182 (hide this message with `#[allow(cyclomatic_complexity)]`): \
183 cc = {}, arms = {}, div = {}, shorts = {}, returns = {}. \
184 Please file a bug report.",