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::tidy::readability {
15 
16 /// Checks function Cognitive Complexity metric.
17 ///
18 /// There are the following configuration option:
19 ///
20 ///   * `Threshold` - flag functions with Cognitive Complexity exceeding
21 ///     this number. The default is `25`.
22 ///   * `DescribeBasicIncrements`- if set to `true`, then for each function
23 ///     exceeding the complexity threshold the check will issue additional
24 ///     diagnostics on every piece of code (loop, `if` statement, etc.) which
25 ///     contributes to that complexity.
26 //      Default is `true`
27 ///   * `IgnoreMacros` - if set to `true`, the check will ignore code inside
28 ///     macros. Default is `false`.
29 ///
30 /// For the user-facing documentation see:
31 /// http://clang.llvm.org/extra/clang-tidy/checks/readability/function-cognitive-complexity.html
32 class FunctionCognitiveComplexityCheck : public ClangTidyCheck {
33 public:
34   FunctionCognitiveComplexityCheck(StringRef Name, ClangTidyContext *Context);
35 
36   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
37   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
38   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
getCheckTraversalKind()39   std::optional<TraversalKind> getCheckTraversalKind() const override {
40     return TK_IgnoreUnlessSpelledInSource;
41   }
42 
43 private:
44   const unsigned Threshold;
45   const bool DescribeBasicIncrements;
46   const bool IgnoreMacros;
47 };
48 
49 } // namespace clang::tidy::readability
50 
51 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_FUNCTIONCOGNITIVECOMPLEXITYCHECK_H
52