Find macro usage that is considered problematic because better language constructs exist for the task. More...
#include <MacroUsageCheck.h>
Public Member Functions | |
| MacroUsageCheck (StringRef Name, ClangTidyContext *Context) | |
| bool | isLanguageVersionSupported (const LangOptions &LangOpts) const override |
| Override this to disable registering matchers and PP callbacks if an invalid language version is being used. | |
| void | storeOptions (ClangTidyOptions::OptionMap &Opts) override |
| Should store all options supported by this check with their current values or default values for options that haven't been overridden. | |
| void | registerPPCallbacks (const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override |
Override this to register PPCallbacks in the preprocessor. | |
| void | warnMacro (const MacroDirective *MD, StringRef MacroName) |
| void | warnNaming (const MacroDirective *MD, StringRef MacroName) |
 Public Member Functions inherited from clang::tidy::ClangTidyCheck | |
| ClangTidyCheck (StringRef CheckName, ClangTidyContext *Context) | |
Initializes the check with CheckName and Context. | |
| virtual bool | isLanguageVersionSupported (const LangOptions &LangOpts) const |
| Override this to disable registering matchers and PP callbacks if an invalid language version is being used. | |
| virtual void | registerPPCallbacks (const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) |
Override this to register PPCallbacks in the preprocessor. | |
| virtual void | registerMatchers (ast_matchers::MatchFinder *Finder) |
Override this to register AST matchers with Finder. | |
| virtual void | check (const ast_matchers::MatchFinder::MatchResult &Result) |
ClangTidyChecks that register ASTMatchers should do the actual work in here. | |
| DiagnosticBuilder | diag (SourceLocation Loc, StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning) |
| Add a diagnostic with the check's name. | |
| DiagnosticBuilder | diag (StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning) |
| Add a diagnostic with the check's name. | |
| DiagnosticBuilder | configurationDiag (StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning) const |
| Adds a diagnostic to report errors in the check's configuration. | |
| virtual void | storeOptions (ClangTidyOptions::OptionMap &Options) |
| Should store all options supported by this check with their current values or default values for options that haven't been overridden. | |
Additional Inherited Members | |
| Protected Member Functions inherited from clang::tidy::ClangTidyCheck | |
| StringRef | getCurrentMainFile () const |
| Returns the main file name of the current translation unit. | |
| const LangOptions & | getLangOpts () const |
| Returns the language options from the context. | |
| bool | areDiagsSelfContained () const |
| Returns true when the check is run in a use case when only 1 fix will be applied at a time. | |
| StringRef | getID () const override |
| Protected Attributes inherited from clang::tidy::ClangTidyCheck | |
| OptionsView | Options |
Detailed Description
Find macro usage that is considered problematic because better language constructs exist for the task.
For the user-facing documentation see: http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines/macro-usage.html
Definition at line 25 of file MacroUsageCheck.h.
Constructor & Destructor Documentation
◆ MacroUsageCheck()
|
inline |
Definition at line 27 of file MacroUsageCheck.h.
Member Function Documentation
◆ isLanguageVersionSupported()
|
inlineoverridevirtual |
Override this to disable registering matchers and PP callbacks if an invalid language version is being used.
For example if a check is examining overloaded functions then this should be overridden to return false when the CPlusPlus flag is not set in LangOpts.
Reimplemented from clang::tidy::ClangTidyCheck.
Definition at line 32 of file MacroUsageCheck.h.
◆ registerPPCallbacks()
|
overridevirtual |
Override this to register PPCallbacks in the preprocessor.
This should be used for clang-tidy checks that analyze preprocessor- dependent properties, e.g. include directives and macro definitions.
This will only be executed if the function isLanguageVersionSupported returns true.
There are two Preprocessors to choose from that differ in how they handle modular #includes:
- PP is the real Preprocessor. It doesn't walk into modular #includes and thus doesn't generate PPCallbacks for their contents.
- ModuleExpanderPP preprocesses the whole translation unit in the non-modular mode, which allows it to generate PPCallbacks not only for the main file and textual headers, but also for all transitively included modular headers when the analysis runs with modules enabled. When modules are not enabled ModuleExpanderPP just points to the real preprocessor.
Reimplemented from clang::tidy::ClangTidyCheck.
Definition at line 72 of file MacroUsageCheck.cpp.
◆ storeOptions()
|
overridevirtual |
Should store all options supported by this check with their current values or default values for options that haven't been overridden.
The check should use Options.store() to store each option it supports whether it has the default value or it has been overridden.
Reimplemented from clang::tidy::ClangTidyCheck.
Definition at line 66 of file MacroUsageCheck.cpp.
References clang::tidy::ClangTidyCheck::Options, and clang::tidy::ClangTidyCheck::OptionsView::store().
◆ warnMacro()
| void clang::tidy::cppcoreguidelines::MacroUsageCheck::warnMacro | ( | const MacroDirective * | MD, |
| StringRef | MacroName | ||
| ) |
Definition at line 79 of file MacroUsageCheck.cpp.
References clang::tidy::ClangTidyCheck::diag(), Info, and MacroName.
◆ warnNaming()
| void clang::tidy::cppcoreguidelines::MacroUsageCheck::warnNaming | ( | const MacroDirective * | MD, |
| StringRef | MacroName | ||
| ) |
Definition at line 100 of file MacroUsageCheck.cpp.
References clang::tidy::ClangTidyCheck::diag(), and MacroName.
The documentation for this class was generated from the following files:
