Enforces consistent style for enumerators' initialization, covering three styles: none, first only, or all initialized explicitly. More...
#include <EnumInitialValueCheck.h>
Public Member Functions | |
| EnumInitialValueCheck (StringRef Name, ClangTidyContext *Context) | |
| 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 | registerMatchers (ast_matchers::MatchFinder *Finder) override |
Override this to register AST matchers with Finder. | |
| void | check (const ast_matchers::MatchFinder::MatchResult &Result) override |
ClangTidyChecks that register ASTMatchers should do the actual work in here. | |
| std::optional< TraversalKind > | getCheckTraversalKind () const override |
 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
Enforces consistent style for enumerators' initialization, covering three styles: none, first only, or all initialized explicitly.
For the user-facing documentation see: http://clang.llvm.org/extra/clang-tidy/checks/readability/enum-initial-value.html
Definition at line 21 of file EnumInitialValueCheck.h.
Constructor & Destructor Documentation
◆ EnumInitialValueCheck()
| clang::tidy::readability::EnumInitialValueCheck::EnumInitialValueCheck | ( | StringRef | Name, |
| ClangTidyContext * | Context | ||
| ) |
Definition at line 135 of file EnumInitialValueCheck.cpp.
Member Function Documentation
◆ check()
|
overridevirtual |
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Reimplemented from clang::tidy::ClangTidyCheck.
Definition at line 167 of file EnumInitialValueCheck.cpp.
References clang::tidy::readability::cleanInitialValue(), clang::tidy::ClangTidyCheck::diag(), clang::tidy::ClangTidyCheck::getLangOpts(), and Loc.
◆ getCheckTraversalKind()
|
inlineoverride |
Definition at line 27 of file EnumInitialValueCheck.h.
◆ registerMatchers()
|
overridevirtual |
Override this to register AST matchers with Finder.
This should be used by clang-tidy checks that analyze code properties that dependent on AST knowledge.
You can register as many matchers as necessary with Finder. Usually, "this" will be used as callback, but you can also specify other callback classes. Thereby, different matchers can trigger different callbacks.
This will only be executed if the function isLanguageVersionSupported returns true.
If you need to merge information between the different matchers, you can store these as members of the derived class. However, note that all matches occur in the order of the AST traversal.
Reimplemented from clang::tidy::ClangTidyCheck.
Definition at line 150 of file EnumInitialValueCheck.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 143 of file EnumInitialValueCheck.cpp.
References clang::tidy::ClangTidyCheck::Options, and clang::tidy::ClangTidyCheck::OptionsView::store().
The documentation for this class was generated from the following files:
