clang-tools  6.0.0svn
Public Member Functions | List of all members
clang::tidy::performance::ForRangeCopyCheck Class Reference

A check that detects copied loop variables and suggests using const references. More...

#include <ForRangeCopyCheck.h>

Inheritance diagram for clang::tidy::performance::ForRangeCopyCheck:
Inheritance graph
[legend]
Collaboration diagram for clang::tidy::performance::ForRangeCopyCheck:
Collaboration graph
[legend]

Public Member Functions

 ForRangeCopyCheck (StringRef Name, ClangTidyContext *Context)
 
void storeOptions (ClangTidyOptions::OptionMap &Opts) override
 Should store all options supported by this check with their current values or default values for options that haven't been overridden. More...
 
void registerMatchers (ast_matchers::MatchFinder *Finder) override
 Override this to register AST matchers with Finder. More...
 
void check (const ast_matchers::MatchFinder::MatchResult &Result) override
 ClangTidyChecks that register ASTMatchers should do the actual work in here. More...
 
- Public Member Functions inherited from clang::tidy::ClangTidyCheck
 ClangTidyCheck (StringRef CheckName, ClangTidyContext *Context)
 Initializes the check with CheckName and Context. More...
 
virtual void registerPPCallbacks (CompilerInstance &Compiler)
 Override this to register PPCallbacks with Compiler. More...
 
DiagnosticBuilder diag (SourceLocation Loc, StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
 Add a diagnostic with the check's name. More...
 

Additional Inherited Members

- Protected Member Functions inherited from clang::tidy::ClangTidyCheck
StringRef getCurrentMainFile () const
 Returns the main file name of the current translation unit. More...
 
LangOptions getLangOpts () const
 Returns the language options from the context. More...
 
- Protected Attributes inherited from clang::tidy::ClangTidyCheck
OptionsView Options
 

Detailed Description

A check that detects copied loop variables and suggests using const references.

For the user-facing documentation see: http://clang.llvm.org/extra/clang-tidy/checks/performance-for-range-copy.html

Definition at line 23 of file ForRangeCopyCheck.h.

Constructor & Destructor Documentation

◆ ForRangeCopyCheck()

clang::tidy::performance::ForRangeCopyCheck::ForRangeCopyCheck ( StringRef  Name,
ClangTidyContext Context 
)

Definition at line 21 of file ForRangeCopyCheck.cpp.

Member Function Documentation

◆ check()

void clang::tidy::performance::ForRangeCopyCheck::check ( const ast_matchers::MatchFinder::MatchResult &  Result)
overridevirtual

◆ registerMatchers()

void clang::tidy::performance::ForRangeCopyCheck::registerMatchers ( ast_matchers::MatchFinder *  Finder)
overridevirtual

Override this to register AST matchers with Finder.

This should be used by clang-tidy checks that analyze code properties that dependent on AST knowledge.

You can register as many matchers as necessary with Finder. Usually, "this" will be used as callback, but you can also specify other callback classes. Thereby, different matchers can trigger different callbacks.

If you need to merge information between the different matchers, you can store these as members of the derived class. However, note that all matches occur in the order of the AST traversal.

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 29 of file ForRangeCopyCheck.cpp.

◆ storeOptions()

void clang::tidy::performance::ForRangeCopyCheck::storeOptions ( ClangTidyOptions::OptionMap Options)
overridevirtual

Should store all options supported by this check with their current values or default values for options that haven't been overridden.

The check should use Options.store() to store each option it supports whether it has the default value or it has been overridden.

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 25 of file ForRangeCopyCheck.cpp.

References clang::tidy::ClangTidyCheck::Options, and clang::tidy::OptionsView::store().


The documentation for this class was generated from the following files: