clang-tools 10.0.0

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