clang-tools 10.0.0

InconsistentDeclarationParameterNameCheck.h
Go to the documentation of this file.
1 //===- InconsistentDeclarationParameterNameCheck.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_READABILITY_INCONSISTENT_DECLARATION_PARAMETER_NAME_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_INCONSISTENT_DECLARATION_PARAMETER_NAME_H
11
12 #include "../ClangTidyCheck.h"
13
14 #include "llvm/ADT/DenseSet.h"
15
16 namespace clang {
17 namespace tidy {
18 namespace readability {
19
20 /// Checks for declarations of functions which differ in parameter names.
21 ///
22 /// For detailed documentation see:
23 /// http://clang.llvm.org/extra/clang-tidy/checks/readability-inconsistent-declaration-parameter-name.html
24 ///
25 class InconsistentDeclarationParameterNameCheck : public ClangTidyCheck {
26 public:
27 InconsistentDeclarationParameterNameCheck(StringRef Name,
28 ClangTidyContext *Context)
29 : ClangTidyCheck(Name, Context),
30 IgnoreMacros(Options.getLocalOrGlobal("IgnoreMacros", 1) != 0),
31 Strict(Options.getLocalOrGlobal("Strict", 0) != 0) {}
32
33 void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
34 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
35 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
36
37 private:
38 void markRedeclarationsAsVisited(const FunctionDecl *FunctionDeclaration);
39
40 llvm::DenseSet<const FunctionDecl *> VisitedDeclarations;
41 const bool IgnoreMacros;
42 const bool Strict;
43 };
44
45 } // namespace readability
46 } // namespace tidy
47 } // namespace clang
48
49 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_INCONSISTENT_DECLARATION_PARAMETER_NAME_H
clang::tidy::readability::InconsistentDeclarationParameterNameCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: InconsistentDeclarationParameterNameCheck.cpp:305
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:47
clang::tidy::ClangTidyCheck::Options
OptionsView Options
Definition: ClangTidyCheck.h:184
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::readability::InconsistentDeclarationParameterNameCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: InconsistentDeclarationParameterNameCheck.cpp:298
clang::tidy::readability::InconsistentDeclarationParameterNameCheck::InconsistentDeclarationParameterNameCheck
InconsistentDeclarationParameterNameCheck(StringRef Name, ClangTidyContext *Context)
Definition: InconsistentDeclarationParameterNameCheck.h:27
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::readability::InconsistentDeclarationParameterNameCheck
Checks for declarations of functions which differ in parameter names.
Definition: InconsistentDeclarationParameterNameCheck.h:25
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:77
clang::tidy::readability::InconsistentDeclarationParameterNameCheck::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: InconsistentDeclarationParameterNameCheck.cpp:292