Finds macros that can have unexpected behaviour due to missing parentheses. More...
#include <MacroParenthesesCheck.h>
Public Member Functions | |
| MacroParenthesesCheck (StringRef Name, ClangTidyContext *Context) | |
| void | registerPPCallbacks (const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override |
Override this to register PPCallbacks in the preprocessor. | |
 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
Finds macros that can have unexpected behaviour due to missing parentheses.
Macros are expanded by the preprocessor as-is. As a result, there can be unexpected behaviour; operators may be evaluated in unexpected order and unary operators may become binary operators, etc.
When the replacement list has an expression, it is recommended to surround it with parentheses. This ensures that the macro result is evaluated completely before it is used.
It is also recommended to surround macro arguments in the replacement list with parentheses. This ensures that the argument value is calculated properly.
Definition at line 29 of file MacroParenthesesCheck.h.
Constructor & Destructor Documentation
◆ MacroParenthesesCheck()
|
inline |
Definition at line 31 of file MacroParenthesesCheck.h.
Member Function Documentation
◆ 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 264 of file MacroParenthesesCheck.cpp.
References clang::tidy::bugprone::PP.
The documentation for this class was generated from the following files:
