clang-tools 20.0.0git
|
Checks for unused and missing includes. More...
#include <IncludeCleanerCheck.h>
Public Member Functions | |
IncludeCleanerCheck (StringRef Name, ClangTidyContext *Context) | |
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. | |
void | registerPPCallbacks (const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override |
Override this to register PPCallbacks in the preprocessor. | |
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. | |
bool | isLanguageVersionSupported (const LangOptions &LangOpts) const override |
Override this to disable registering matchers and PP callbacks if an invalid language version is being used. | |
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 |
Checks for unused and missing includes.
Generates findings only for the main file of a translation unit. Findings correspond to https://clangd.llvm.org/design/include-cleaner.
For the user-facing documentation see: http://clang.llvm.org/extra/clang-tidy/checks/misc/include-cleaner.html
Definition at line 33 of file IncludeCleanerCheck.h.
clang::tidy::misc::IncludeCleanerCheck::IncludeCleanerCheck | ( | StringRef | Name, |
ClangTidyContext * | Context | ||
) |
Definition at line 57 of file IncludeCleanerCheck.cpp.
References clang::tidy::ClangTidyCheck::configurationDiag().
|
overridevirtual |
ClangTidyChecks
that register ASTMatchers should do the actual work in here.
Reimplemented from clang::tidy::ClangTidyCheck.
Definition at line 114 of file IncludeCleanerCheck.cpp.
|
overridevirtual |
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 80 of file IncludeCleanerCheck.cpp.
|
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 85 of file IncludeCleanerCheck.cpp.
|
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:
Reimplemented from clang::tidy::ClangTidyCheck.
Definition at line 89 of file IncludeCleanerCheck.cpp.
|
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 74 of file IncludeCleanerCheck.cpp.
References clang::tidy::ClangTidyCheck::Options, clang::tidy::utils::options::serializeStringList(), and clang::tidy::ClangTidyCheck::OptionsView::store().