blob: f668ab18fea52a63fbf05e1f42fc7f8aeeaed5c3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
//===--- FunctionSizeCheck.h - clang-tidy -----------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_FUNCTIONSIZECHECK_H
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_FUNCTIONSIZECHECK_H
#include "../ClangTidyCheck.h"
namespace clang::tidy::readability {
/// Checks for large functions based on various metrics.
///
/// These options are supported:
///
/// * `LineThreshold` - flag functions exceeding this number of lines. The
/// default is `-1` (ignore the number of lines).
/// * `StatementThreshold` - flag functions exceeding this number of
/// statements. This may differ significantly from the number of lines for
/// macro-heavy code. The default is `800`.
/// * `BranchThreshold` - flag functions exceeding this number of control
/// statements. The default is `-1` (ignore the number of branches).
/// * `ParameterThreshold` - flag functions having a high number of
/// parameters. The default is `-1` (ignore the number of parameters).
/// * `NestingThreshold` - flag compound statements which create next nesting
/// level after `NestingThreshold`. This may differ significantly from the
/// expected value for macro-heavy code. The default is `-1` (ignore the
/// nesting level).
/// * `VariableThreshold` - flag functions having a high number of variable
/// declarations. The default is `-1` (ignore the number of variables).
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;
private:
const std::optional<unsigned> LineThreshold;
const std::optional<unsigned> StatementThreshold;
const std::optional<unsigned> BranchThreshold;
const std::optional<unsigned> ParameterThreshold;
const std::optional<unsigned> NestingThreshold;
const std::optional<unsigned> VariableThreshold;
const bool CountMemberInitAsStmt;
static constexpr std::optional<unsigned> DefaultLineThreshold = std::nullopt;
static constexpr std::optional<unsigned> DefaultStatementThreshold = 800U;
static constexpr std::optional<unsigned> DefaultBranchThreshold =
std::nullopt;
static constexpr std::optional<unsigned> DefaultParameterThreshold =
std::nullopt;
static constexpr std::optional<unsigned> DefaultNestingThreshold =
std::nullopt;
static constexpr std::optional<unsigned> DefaultVariableThreshold =
std::nullopt;
static constexpr bool DefaultCountMemberInitAsStmt = true;
};
} // namespace clang::tidy::readability
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_FUNCTIONSIZECHECK_H
|
