clang-tools 10.0.0

UnnecessaryValueParamCheck.h
Go to the documentation of this file.
1 //===--- UnnecessaryValueParamCheck.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_PERFORMANCE_UNNECESSARY_VALUE_PARAM_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_PERFORMANCE_UNNECESSARY_VALUE_PARAM_H
11
12 #include "../ClangTidyCheck.h"
13 #include "../utils/IncludeInserter.h"
14 #include "clang/Analysis/Analyses/ExprMutationAnalyzer.h"
15
16 namespace clang {
17 namespace tidy {
18 namespace performance {
19
20 /// A check that flags value parameters of expensive to copy types that
21 /// can safely be converted to const references.
22 ///
23 /// For the user-facing documentation see:
24 /// http://clang.llvm.org/extra/clang-tidy/checks/performance-unnecessary-value-param.html
25 class UnnecessaryValueParamCheck : public ClangTidyCheck {
26 public:
27 UnnecessaryValueParamCheck(StringRef Name, ClangTidyContext *Context);
28 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
29 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
30 void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
31 Preprocessor *ModuleExpanderPP) override;
32 void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
33 void onEndOfTranslationUnit() override;
34
35 private:
36 void handleMoveFix(const ParmVarDecl &Var, const DeclRefExpr &CopyArgument,
37 const ASTContext &Context);
38
39 llvm::DenseMap<const FunctionDecl *, FunctionParmMutationAnalyzer>
40 MutationAnalyzers;
41 std::unique_ptr<utils::IncludeInserter> Inserter;
42 const utils::IncludeSorter::IncludeStyle IncludeStyle;
43 const std::vector<std::string> AllowedTypes;
44 };
45
46 } // namespace performance
47 } // namespace tidy
48 } // namespace clang
49
50 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_PERFORMANCE_UNNECESSARY_VALUE_PARAM_H
clang::tidy::utils::IncludeSorter::IncludeStyle
IncludeStyle
Supported include styles.
Definition: IncludeSorter.h:26
clang::tidy::performance::UnnecessaryValueParamCheck::storeOptions
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
Definition: UnnecessaryValueParamCheck.cpp:180
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:47
clang::tidy::performance::UnnecessaryValueParamCheck::registerPPCallbacks
void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override
Override this to register PPCallbacks in the preprocessor.
Definition: UnnecessaryValueParamCheck.cpp:173
clang::tidy::performance::UnnecessaryValueParamCheck::onEndOfTranslationUnit
void onEndOfTranslationUnit() override
Definition: UnnecessaryValueParamCheck.cpp:188
clang::tidy::performance::UnnecessaryValueParamCheck::UnnecessaryValueParamCheck
UnnecessaryValueParamCheck(StringRef Name, ClangTidyContext *Context)
Definition: UnnecessaryValueParamCheck.cpp:67
clang::tidy::performance::UnnecessaryValueParamCheck
A check that flags value parameters of expensive to copy types that can safely be converted to const ...
Definition: UnnecessaryValueParamCheck.h:25
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:27
clang::tidy::ClangTidyOptions::OptionMap
std::map< std::string, std::string > OptionMap
Definition: ClangTidyOptions.h:97
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::bugprone::PP
static Preprocessor * PP
Definition: BadSignalToKillThreadCheck.cpp:28
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:77
clang::tidy::performance::UnnecessaryValueParamCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: UnnecessaryValueParamCheck.cpp:95
clang::tidy::performance::UnnecessaryValueParamCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: UnnecessaryValueParamCheck.cpp:75