clang-tools
11.0.0
clang-tools-extra
clang-tidy
performance
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
bool
isLanguageVersionSupported
(
const
LangOptions &LangOpts)
const override
{
26
return
LangOpts.CPlusPlus11;
27
}
28
void
storeOptions
(
ClangTidyOptions::OptionMap
&Opts)
override
;
29
void
registerMatchers
(ast_matchers::MatchFinder *Finder)
override
;
30
void
check
(
const
ast_matchers::MatchFinder::MatchResult &Result)
override
;
31
32
private
:
33
// Checks if the loop variable is a const value and expensive to copy. If so
34
// suggests it be converted to a const reference.
35
bool
handleConstValueCopy(
const
VarDecl &LoopVar, ASTContext &Context);
36
37
// Checks if the loop variable is a non-const value and whether only
38
// const methods are invoked on it or whether it is only used as a const
39
// reference argument. If so it suggests it be made a const reference.
40
bool
handleCopyIsOnlyConstReferenced(
const
VarDecl &LoopVar,
41
const
CXXForRangeStmt &ForRange,
42
ASTContext &Context);
43
44
const
bool
WarnOnAllAutoCopies;
45
const
std::vector<std::string> AllowedTypes;
46
};
47
48
}
// namespace performance
49
}
// namespace tidy
50
}
// namespace clang
51
52
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_PERFORMANCE_FORRANGECOPYCHECK_H
clang::tidy::performance::ForRangeCopyCheck::ForRangeCopyCheck
ForRangeCopyCheck(StringRef Name, ClangTidyContext *Context)
Definition:
ForRangeCopyCheck.cpp:24
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition:
ClangTidyCheck.h:114
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::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:59
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition:
ClangTidyDiagnosticConsumer.h:76
Name
static constexpr llvm::StringLiteral Name
Definition:
UppercaseLiteralSuffixCheck.cpp:27
clang::tidy::performance::ForRangeCopyCheck::isLanguageVersionSupported
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override
Override this to disable registering matchers and PP callbacks if an invalid language version is bein...
Definition:
ForRangeCopyCheck.h:25
clang::tidy::performance::ForRangeCopyCheck
A check that detects copied loop variables and suggests using const references.
Definition:
ForRangeCopyCheck.h:22
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
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition:
ApplyReplacements.h:27
clang::tidy::ClangTidyOptions::OptionMap
std::map< std::string, ClangTidyValue > OptionMap
Definition:
ClangTidyOptions.h:111
Generated on Tue Jul 28 2020 16:14:02 for clang-tools by
1.8.16