clang-tools
6.0.0
llvm.src
tools
clang
tools
extra
clang-tidy
performance
ForRangeCopyCheck.h
Go to the documentation of this file.
1
//===--- ForRangeCopyCheck.h - clang-tidy------------------------*- C++ -*-===//
2
//
3
// The LLVM Compiler Infrastructure
4
//
5
// This file is distributed under the University of Illinois Open Source
6
// License. See LICENSE.TXT for details.
7
//
8
//===----------------------------------------------------------------------===//
9
10
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_PERFORMANCE_FORRANGECOPYCHECK_H
11
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_PERFORMANCE_FORRANGECOPYCHECK_H
12
13
#include "../ClangTidy.h"
14
15
namespace
clang
{
16
namespace
tidy {
17
namespace
performance {
18
19
/// A check that detects copied loop variables and suggests using const
20
/// references.
21
/// For the user-facing documentation see:
22
/// http://clang.llvm.org/extra/clang-tidy/checks/performance-for-range-copy.html
23
class
ForRangeCopyCheck
:
public
ClangTidyCheck
{
24
public
:
25
ForRangeCopyCheck
(StringRef
Name
,
ClangTidyContext
*Context);
26
void
storeOptions
(
ClangTidyOptions::OptionMap
&Opts)
override
;
27
void
registerMatchers
(ast_matchers::MatchFinder *Finder)
override
;
28
void
check
(
const
ast_matchers::MatchFinder::MatchResult &Result)
override
;
29
30
private
:
31
// Checks if the loop variable is a const value and expensive to copy. If so
32
// suggests it be converted to a const reference.
33
bool
handleConstValueCopy(
const
VarDecl &LoopVar, ASTContext &Context);
34
35
// Checks if the loop variable is a non-const value and whether only
36
// const methods are invoked on it or whether it is only used as a const
37
// reference argument. If so it suggests it be made a const reference.
38
bool
handleCopyIsOnlyConstReferenced(
const
VarDecl &LoopVar,
39
const
CXXForRangeStmt &ForRange,
40
ASTContext &Context);
41
42
const
bool
WarnOnAllAutoCopies;
43
};
44
45
}
// namespace performance
46
}
// namespace tidy
47
}
// namespace clang
48
49
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_PERFORMANCE_FORRANGECOPYCHECK_H
Name
StringHandle Name
Definition:
PreprocessorTracker.cpp:525
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition:
ClangTidy.h:127
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:25
clang::tidy::ClangTidyOptions::OptionMap
std::map< std::string, std::string > OptionMap
Definition:
ClangTidyOptions.h:99
clang::tidy::performance::ForRangeCopyCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition:
ForRangeCopyCheck.cpp:29
clang
Definition:
AndroidTidyModule.cpp:28
clang::tidy::performance::ForRangeCopyCheck
A check that detects copied loop variables and suggests using const references.
Definition:
ForRangeCopyCheck.h:23
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition:
ClangTidyDiagnosticConsumer.h:104
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:41
clang::tidy::performance::ForRangeCopyCheck::ForRangeCopyCheck
ForRangeCopyCheck(StringRef Name, ClangTidyContext *Context)
Definition:
ForRangeCopyCheck.cpp:21
Generated on Fri Mar 2 2018 13:29:34 for clang-tools by
1.8.13