clang-tools-extra/clang-tidy/readability/InconsistentDeclarationParameterNameCheck.h

   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::tidy::readability {
  17
  18 /// Checks for declarations of functions which differ in parameter names.
  19 ///
  20 /// For detailed documentation see:
  21 /// http://clang.llvm.org/extra/clang-tidy/checks/readability/inconsistent-declaration-parameter-name.html
  22 ///
  23 class InconsistentDeclarationParameterNameCheck : public ClangTidyCheck {
  24 public:
  25   InconsistentDeclarationParameterNameCheck(StringRef Name,
  26                                             ClangTidyContext *Context)
  27       : ClangTidyCheck(Name, Context),
  28         IgnoreMacros(Options.getLocalOrGlobal("IgnoreMacros", true)),
  29         Strict(Options.getLocalOrGlobal("Strict", false)) {}
  30
  31   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
  32   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  33   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  34   std::optional<TraversalKind> getCheckTraversalKind() const override {
  35     return TK_IgnoreUnlessSpelledInSource;
  36   }
  37
  38 private:
  39   void markRedeclarationsAsVisited(const FunctionDecl *OriginalDeclaration);
  40
  41   llvm::DenseSet<const FunctionDecl *> VisitedDeclarations;
  42   const bool IgnoreMacros;
  43   const bool Strict;
  44 };
  45
  46 } // namespace clang::tidy::readability
  47
  48 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_INCONSISTENT_DECLARATION_PARAMETER_NAME_H