clang-tools  6.0.0
NonConstReferences.h
Go to the documentation of this file.
1 //===--- NonConstReferences.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_GOOGLE_NON_CONST_REFERENCES_H
11 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_NON_CONST_REFERENCES_H
12 
13 #include "../ClangTidy.h"
14 
15 namespace clang {
16 namespace tidy {
17 namespace google {
18 namespace runtime {
19 
20 /// \brief Checks the usage of non-constant references in function parameters.
21 ///
22 /// https://google.github.io/styleguide/cppguide.html#Reference_Arguments
24 public:
25  NonConstReferences(StringRef Name, ClangTidyContext *Context);
26  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
27  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
28  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
29 
30 private:
31  const std::vector<std::string> WhiteListTypes;
32 };
33 
34 } // namespace runtime
35 } // namespace google
36 } // namespace tidy
37 } // namespace clang
38 
39 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_NON_CONST_REFERENCES_H
StringHandle Name
Checks the usage of non-constant references in function parameters.
Base class for all clang-tidy checks.
Definition: ClangTidy.h:127
NonConstReferences(StringRef Name, ClangTidyContext *Context)
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
std::map< std::string, std::string > OptionMap
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.