clang-tools 18.0.0git
|
Warns on inclusion of files whose names suggest that they're implementation files, instead of headers. More...
#include <SuspiciousIncludeCheck.h>
Public Member Functions | |
SuspiciousIncludeCheck (StringRef Name, ClangTidyContext *Context) | |
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. | |
![]() | |
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. | |
Public Attributes | |
FileExtensionsSet | HeaderFileExtensions |
FileExtensionsSet | ImplementationFileExtensions |
Additional Inherited Members | |
![]() | |
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 |
![]() | |
OptionsView | Options |
Warns on inclusion of files whose names suggest that they're implementation files, instead of headers.
E.g:
#include "foo.cpp" // warning #include "bar.c" // warning #include "baz.h" // no diagnostic
The check supports these options:
HeaderFileExtensions
: a semicolon-separated list of filename extensions of header files (The filename extensions should not contain "." prefix) ";h;hh;hpp;hxx" by default. For extension-less header files, using an empty string or leaving an empty string between ";" if there are other filename extensions.ImplementationFileExtensions
: likewise, a semicolon-separated list of filename extensions of implementation files. "c;cc;cpp;cxx" by default.For the user-facing documentation see: http://clang.llvm.org/extra/clang-tidy/checks/bugprone/suspicious-include.html
Definition at line 36 of file SuspiciousIncludeCheck.h.
clang::tidy::bugprone::SuspiciousIncludeCheck::SuspiciousIncludeCheck | ( | StringRef | Name, |
ClangTidyContext * | Context | ||
) |
Definition at line 38 of file SuspiciousIncludeCheck.cpp.
References clang::tidy::ClangTidyCheck::configurationDiag(), clang::tidy::utils::defaultFileExtensionDelimiters(), clang::tidy::utils::defaultHeaderFileExtensions(), clang::tidy::utils::defaultImplementationFileExtensions(), clang::tidy::ClangTidyCheck::OptionsView::get(), HeaderFileExtensions, ImplementationFileExtensions, clang::tidy::ClangTidyCheck::Options, and clang::tidy::utils::parseFileExtensions().
|
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 77 of file SuspiciousIncludeCheck.cpp.
References clang::tidy::bugprone::PP.
|
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 71 of file SuspiciousIncludeCheck.cpp.
References clang::tidy::ClangTidyCheck::Options, and clang::tidy::ClangTidyCheck::OptionsView::store().
FileExtensionsSet clang::tidy::bugprone::SuspiciousIncludeCheck::HeaderFileExtensions |
Definition at line 43 of file SuspiciousIncludeCheck.h.
Referenced by SuspiciousIncludeCheck().
FileExtensionsSet clang::tidy::bugprone::SuspiciousIncludeCheck::ImplementationFileExtensions |
Definition at line 44 of file SuspiciousIncludeCheck.h.
Referenced by SuspiciousIncludeCheck().