clang-tools 20.0.0git
AvoidConstParamsInDecls.h
Go to the documentation of this file.
1//===--- AvoidConstParamsInDecls.h - clang-tidy----------------------------===//
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_AVOID_CONST_PARAMS_IN_DECLS_H
10#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_AVOID_CONST_PARAMS_IN_DECLS_H
11
12#include "../ClangTidyCheck.h"
13
15
16// Detect function declarations that have const value parameters and discourage
17// them.
19public:
21 : ClangTidyCheck(Name, Context),
22 IgnoreMacros(Options.getLocalOrGlobal("IgnoreMacros", true)) {}
23
24 void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
25 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
26 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
27 std::optional<TraversalKind> getCheckTraversalKind() const override {
28 return TK_IgnoreUnlessSpelledInSource;
29 }
30
31private:
32 const bool IgnoreMacros;
33};
34
35} // namespace clang::tidy::readability
36
37#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_AVOID_CONST_PARAMS_IN_DECLS_H
llvm::SmallString< 256U > Name
Base class for all clang-tidy checks.
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
std::optional< TraversalKind > getCheckTraversalKind() const override
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
AvoidConstParamsInDecls(StringRef Name, ClangTidyContext *Context)
llvm::StringMap< ClangTidyValue > OptionMap