Index: clang-tools-extra/trunk/clang-tidy/misc/CMakeLists.txt =================================================================== --- clang-tools-extra/trunk/clang-tidy/misc/CMakeLists.txt +++ clang-tools-extra/trunk/clang-tidy/misc/CMakeLists.txt @@ -3,6 +3,7 @@ add_clang_library(clangTidyMiscModule ArgumentCommentCheck.cpp BoolPointerImplicitConversion.cpp + FunctionSize.cpp MiscTidyModule.cpp RedundantSmartptrGet.cpp SwappedArgumentsCheck.cpp Index: clang-tools-extra/trunk/clang-tidy/misc/FunctionSize.h =================================================================== --- clang-tools-extra/trunk/clang-tidy/misc/FunctionSize.h +++ clang-tools-extra/trunk/clang-tidy/misc/FunctionSize.h @@ -0,0 +1,46 @@ +//===--- FunctionSize.h - clang-tidy ----------------------------*- C++ -*-===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// + +#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_FUNCTIONSIZE_H +#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_FUNCTIONSIZE_H + +#include "../ClangTidy.h" + +namespace clang { +namespace tidy { + +/// \brief Checks for large functions based on various metrics. +class FunctionSizeCheck : public ClangTidyCheck { +public: + FunctionSizeCheck(StringRef Name, ClangTidyContext *Context); + + void storeOptions(ClangTidyOptions::OptionMap &Opts) override; + void registerMatchers(ast_matchers::MatchFinder *Finder) override; + void check(const ast_matchers::MatchFinder::MatchResult &Result) override; + void onEndOfTranslationUnit() override; + +private: + struct FunctionInfo { + FunctionInfo() : Lines(0), Statements(0), Branches(0) {} + unsigned Lines; + unsigned Statements; + unsigned Branches; + }; + + const unsigned LineThreshold; + const unsigned StatementThreshold; + const unsigned BranchThreshold; + + llvm::DenseMap FunctionInfos; +}; + +} // namespace tidy +} // namespace clang + +#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_FUNCTIONSIZE_H Index: clang-tools-extra/trunk/clang-tidy/misc/FunctionSize.cpp =================================================================== --- clang-tools-extra/trunk/clang-tidy/misc/FunctionSize.cpp +++ clang-tools-extra/trunk/clang-tidy/misc/FunctionSize.cpp @@ -0,0 +1,104 @@ +//===--- FunctionSize.cpp - clang-tidy ------------------------------------===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// + +#include "FunctionSize.h" +#include "clang/ASTMatchers/ASTMatchFinder.h" + +using namespace clang::ast_matchers; + +namespace clang { +namespace tidy { + +FunctionSizeCheck::FunctionSizeCheck(StringRef Name, ClangTidyContext *Context) + : ClangTidyCheck(Name, Context), + LineThreshold(Options.get("LineThreshold", -1U)), + StatementThreshold(Options.get("StatementThreshold", 800U)), + BranchThreshold(Options.get("BranchThreshold", -1U)) {} + +void FunctionSizeCheck::storeOptions(ClangTidyOptions::OptionMap &Opts) { + Options.store(Opts, "LineThreshold", LineThreshold); + Options.store(Opts, "StatementThreshold", StatementThreshold); + Options.store(Opts, "BranchThreshold", BranchThreshold); +} + +void FunctionSizeCheck::registerMatchers(MatchFinder *Finder) { + Finder->addMatcher( + functionDecl( + unless(isInstantiated()), + forEachDescendant( + stmt(unless(compoundStmt()), + hasParent(stmt(anyOf(compoundStmt(), ifStmt(), + anyOf(whileStmt(), doStmt(), + forRangeStmt(), forStmt()))))) + .bind("stmt"))).bind("func"), + this); +} + +void FunctionSizeCheck::check(const MatchFinder::MatchResult &Result) { + const auto *Func = Result.Nodes.getNodeAs("func"); + + FunctionInfo &FI = FunctionInfos[Func]; + + // Count the lines including whitespace and comments. Really simple. + if (!FI.Lines) { + if (const Stmt *Body = Func->getBody()) { + SourceManager *SM = Result.SourceManager; + if (SM->isWrittenInSameFile(Body->getLocStart(), Body->getLocEnd())) { + FI.Lines = SM->getSpellingLineNumber(Body->getLocEnd()) - + SM->getSpellingLineNumber(Body->getLocStart()); + } + } + } + + const auto *Statement = Result.Nodes.getNodeAs("stmt"); + ++FI.Statements; + + // TODO: switch cases, gotos + if (isa(Statement) || isa(Statement) || + isa(Statement) || isa(Statement) || + isa(Statement) || isa(Statement)) + ++FI.Branches; +} + +void FunctionSizeCheck::onEndOfTranslationUnit() { + // If we're above the limit emit a warning. + for (const auto &P : FunctionInfos) { + const FunctionInfo &FI = P.second; + if (FI.Lines > LineThreshold || FI.Statements > StatementThreshold || + FI.Branches > BranchThreshold) { + diag(P.first->getLocation(), + "function '%0' exceeds recommended size/complexity thresholds") + << P.first->getNameAsString(); + } + + if (FI.Lines > LineThreshold) { + diag(P.first->getLocation(), + "%0 lines including whitespace and comments (threshold %1)", + DiagnosticIDs::Note) + << FI.Lines << LineThreshold; + } + + if (FI.Statements > StatementThreshold) { + diag(P.first->getLocation(), "%0 statements (threshold %1)", + DiagnosticIDs::Note) + << FI.Statements << StatementThreshold; + } + + if (FI.Branches > BranchThreshold) { + diag(P.first->getLocation(), "%0 branches (threshold %1)", + DiagnosticIDs::Note) + << FI.Branches << BranchThreshold; + } + } + + FunctionInfos.clear(); +} + +} // namespace tidy +} // namespace clang Index: clang-tools-extra/trunk/clang-tidy/misc/MiscTidyModule.cpp =================================================================== --- clang-tools-extra/trunk/clang-tidy/misc/MiscTidyModule.cpp +++ clang-tools-extra/trunk/clang-tidy/misc/MiscTidyModule.cpp @@ -12,6 +12,7 @@ #include "../ClangTidyModuleRegistry.h" #include "ArgumentCommentCheck.h" #include "BoolPointerImplicitConversion.h" +#include "FunctionSize.h" #include "RedundantSmartptrGet.h" #include "SwappedArgumentsCheck.h" #include "UndelegatedConstructor.h" @@ -27,6 +28,7 @@ CheckFactories.registerCheck("misc-argument-comment"); CheckFactories.registerCheck( "misc-bool-pointer-implicit-conversion"); + CheckFactories.registerCheck("misc-function-size"); CheckFactories.registerCheck( "misc-redundant-smartptr-get"); CheckFactories.registerCheck( Index: clang-tools-extra/trunk/test/clang-tidy/misc-function-size.cpp =================================================================== --- clang-tools-extra/trunk/test/clang-tidy/misc-function-size.cpp +++ clang-tools-extra/trunk/test/clang-tidy/misc-function-size.cpp @@ -0,0 +1,58 @@ +// RUN: rm -rf %t +// RUN: mkdir -p %t +// RUN: sed 's#// *[A-Z-][A-Z-]*:.*#//#' %s > %t/t.cpp +// RUN: echo '{ Checks: "-*,misc-function-size", CheckOptions: [{key: misc-function-size.LineThreshold, value: 0}, {key: misc-function-size.StatementThreshold, value: 0}, {key: misc-function-size.BranchThreshold, value: 0}]}' > %t/.clang-tidy +// RUN: clang-tidy %t/t.cpp -- -std=c++11 2>&1 | FileCheck %s -implicit-check-not='{{warning:|error:|note:}}' + +void foo1() { +} + +void foo2() {;} +// CHECK: warning: function 'foo2' exceeds recommended size/complexity thresholds +// CHECK: note: 1 statements (threshold 0) + +void foo3() { +; + +} +// CHECK: warning: function 'foo3' exceeds recommended size/complexity thresholds +// CHECK: note: 3 lines including whitespace and comments (threshold 0) +// CHECK: note: 1 statements (threshold 0) + +void foo4(int i) { if (i) {} else; {} +} +// CHECK: warning: function 'foo4' exceeds recommended size/complexity thresholds +// CHECK: note: 1 lines including whitespace and comments (threshold 0) +// CHECK: note: 3 statements (threshold 0) +// CHECK: note: 1 branches (threshold 0) + +void foo5(int i) {for(;i;)while(i) +do;while(i); +} +// CHECK: warning: function 'foo5' exceeds recommended size/complexity thresholds +// CHECK: note: 2 lines including whitespace and comments (threshold 0) +// CHECK: note: 7 statements (threshold 0) +// CHECK: note: 3 branches (threshold 0) + +template T foo6(T i) {return i; +} +int x = foo6(0); +// CHECK: warning: function 'foo6' exceeds recommended size/complexity thresholds +// CHECK: note: 1 lines including whitespace and comments (threshold 0) +// CHECK: note: 1 statements (threshold 0) + +void bar1() { [](){;;;;;;;;;;;if(1){}}(); + + +} +// CHECK: warning: function 'bar1' exceeds recommended size/complexity thresholds +// CHECK: note: 3 lines including whitespace and comments (threshold 0) +// CHECK: note: 14 statements (threshold 0) +// CHECK: note: 1 branches (threshold 0) + +void bar2() { class A { void barx() {;;} }; } +// CHECK: warning: function 'bar2' exceeds recommended size/complexity thresholds +// CHECK: note: 3 statements (threshold 0) +// +// CHECK: warning: function 'barx' exceeds recommended size/complexity thresholds +// CHECK: note: 2 statements (threshold 0)