clang-tools 10.0.0

ForRangeCopyCheck.h
Go to the documentation of this file.
1 //===--- ForRangeCopyCheck.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_FORRANGECOPYCHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_PERFORMANCE_FORRANGECOPYCHECK_H
11
12 #include "../ClangTidyCheck.h"
13
14 namespace clang {
15 namespace tidy {
16 namespace performance {
17
18 /// A check that detects copied loop variables and suggests using const
19 /// references.
20 /// For the user-facing documentation see:
21 /// http://clang.llvm.org/extra/clang-tidy/checks/performance-for-range-copy.html
22 class ForRangeCopyCheck : public ClangTidyCheck {
23 public:
24 ForRangeCopyCheck(StringRef Name, ClangTidyContext *Context);
25 void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
26 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
27 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
28
29 private:
30 // Checks if the loop variable is a const value and expensive to copy. If so
31 // suggests it be converted to a const reference.
32 bool handleConstValueCopy(const VarDecl &LoopVar, ASTContext &Context);
33
34 // Checks if the loop variable is a non-const value and whether only
35 // const methods are invoked on it or whether it is only used as a const
36 // reference argument. If so it suggests it be made a const reference.
37 bool handleCopyIsOnlyConstReferenced(const VarDecl &LoopVar,
38 const CXXForRangeStmt &ForRange,
39 ASTContext &Context);
40
41 const bool WarnOnAllAutoCopies;
42 const std::vector<std::string> AllowedTypes;
43 };
44
45 } // namespace performance
46 } // namespace tidy
47 } // namespace clang
48
49 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_PERFORMANCE_FORRANGECOPYCHECK_H
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:47
clang::tidy::performance::ForRangeCopyCheck::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: ForRangeCopyCheck.cpp:30
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::tidy::performance::ForRangeCopyCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: ForRangeCopyCheck.cpp:36
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::performance::ForRangeCopyCheck
A check that detects copied loop variables and suggests using const references.
Definition: ForRangeCopyCheck.h:22
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:77
clang::tidy::performance::ForRangeCopyCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: ForRangeCopyCheck.cpp:51
clang::tidy::performance::ForRangeCopyCheck::ForRangeCopyCheck
ForRangeCopyCheck(StringRef Name, ClangTidyContext *Context)
Definition: ForRangeCopyCheck.cpp:24