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