clang-tidy/readability/AvoidConstParamsInDecls.h

0001 //===--- AvoidConstParamsInDecls.h - clang-tidy----------------------------===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_AVOID_CONST_PARAMS_IN_DECLS_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_AVOID_CONST_PARAMS_IN_DECLS_H
0011
0012 #include "../ClangTidyCheck.h"
0013
0014 namespace clang::tidy::readability {
0015
0016 // Detect function declarations that have const value parameters and discourage
0017 // them.
0018 class AvoidConstParamsInDecls : public ClangTidyCheck {
0019 public:
0020   AvoidConstParamsInDecls(StringRef Name, ClangTidyContext *Context)
0021       : ClangTidyCheck(Name, Context),
0022         IgnoreMacros(Options.getLocalOrGlobal("IgnoreMacros", true)) {}
0023
0024   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
0025   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0026   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0027   std::optional<TraversalKind> getCheckTraversalKind() const override {
0028     return TK_IgnoreUnlessSpelledInSource;
0029   }
0030
0031 private:
0032   const bool IgnoreMacros;
0033 };
0034
0035 } // namespace clang::tidy::readability
0036
0037 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_AVOID_CONST_PARAMS_IN_DECLS_H