1 //===--- FunctionCognitiveComplexityCheck.h - clang-tidy --------*- C++ -*-===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_FUNCTIONCOGNITIVECOMPLEXITYCHECK_H 10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_FUNCTIONCOGNITIVECOMPLEXITYCHECK_H 11 12 #include "../ClangTidyCheck.h" 13 14 namespace clang { 15 namespace tidy { 16 namespace readability { 17 18 /// Checks function Cognitive Complexity metric. 19 /// 20 /// There is only one configuration option: 21 /// 22 /// * `Threshold` - flag functions with Cognitive Complexity exceeding 23 /// this number. The default is `25`. 24 /// 25 /// For the user-facing documentation see: 26 /// http://clang.llvm.org/extra/clang-tidy/checks/readability-function-cognitive-complexity.html 27 class FunctionCognitiveComplexityCheck : public ClangTidyCheck { 28 public: 29 FunctionCognitiveComplexityCheck(StringRef Name, ClangTidyContext *Context); 30 31 void storeOptions(ClangTidyOptions::OptionMap &Opts) override; 32 void registerMatchers(ast_matchers::MatchFinder *Finder) override; 33 void check(const ast_matchers::MatchFinder::MatchResult &Result) override; 34 35 private: 36 const unsigned Threshold; 37 }; 38 39 } // namespace readability 40 } // namespace tidy 41 } // namespace clang 42 43 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_FUNCTIONCOGNITIVECOMPLEXITYCHECK_H 44