clang-tools  14.0.0git
Public Member Functions | List of all members
clang::tidy::portability::RestrictSystemIncludesCheck Class Reference

Checks for allowed includes and suggests removal of any others. More...

#include <RestrictSystemIncludesCheck.h>

Inheritance diagram for clang::tidy::portability::RestrictSystemIncludesCheck:
Inheritance graph
[legend]
Collaboration diagram for clang::tidy::portability::RestrictSystemIncludesCheck:
Collaboration graph
[legend]

Public Member Functions

 RestrictSystemIncludesCheck (StringRef Name, ClangTidyContext *Context, std::string DefaultAllowedIncludes="*")
 
void registerPPCallbacks (const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override
 Override this to register PPCallbacks in the preprocessor. More...
 
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. More...
 
bool contains (StringRef FileName)
 
- Public Member Functions inherited from clang::tidy::ClangTidyCheck
 ClangTidyCheck (StringRef CheckName, ClangTidyContext *Context)
 Initializes the check with CheckName and Context. More...
 
virtual bool isLanguageVersionSupported (const LangOptions &LangOpts) const
 Override this to disable registering matchers and PP callbacks if an invalid language version is being used. More...
 
virtual void registerMatchers (ast_matchers::MatchFinder *Finder)
 Override this to register AST matchers with Finder. More...
 
virtual void check (const ast_matchers::MatchFinder::MatchResult &Result)
 ClangTidyChecks that register ASTMatchers should do the actual work in here. More...
 
DiagnosticBuilder diag (SourceLocation Loc, StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
 Add a diagnostic with the check's name. More...
 
DiagnosticBuilder diag (StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
 Add a diagnostic with the check's name. More...
 
DiagnosticBuilder configurationDiag (StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning) const
 Adds a diagnostic to report errors in the check's configuration. More...
 

Additional Inherited Members

- Protected Member Functions inherited from clang::tidy::ClangTidyCheck
StringRef getCurrentMainFile () const
 Returns the main file name of the current translation unit. More...
 
const LangOptions & getLangOpts () const
 Returns the language options from the context. More...
 
- Protected Attributes inherited from clang::tidy::ClangTidyCheck
OptionsView Options
 

Detailed Description

Checks for allowed includes and suggests removal of any others.

If no includes are specified, the check will exit without issuing any warnings.

For the user-facing documentation see: http://clang.llvm.org/extra/clang-tidy/checks/portability-restrict-system-includes.html

Definition at line 25 of file RestrictSystemIncludesCheck.h.

Constructor & Destructor Documentation

◆ RestrictSystemIncludesCheck()

clang::tidy::portability::RestrictSystemIncludesCheck::RestrictSystemIncludesCheck ( StringRef  Name,
ClangTidyContext Context,
std::string  DefaultAllowedIncludes = "*" 
)
inline

Definition at line 27 of file RestrictSystemIncludesCheck.h.

Member Function Documentation

◆ contains()

bool clang::tidy::portability::RestrictSystemIncludesCheck::contains ( StringRef  FileName)
inline

Definition at line 36 of file RestrictSystemIncludesCheck.h.

References clang::tidy::GlobList::contains(), and FileName.

◆ registerPPCallbacks()

void clang::tidy::portability::RestrictSystemIncludesCheck::registerPPCallbacks ( const SourceManager &  SM,
Preprocessor *  PP,
Preprocessor *  ModuleExpanderPP 
)
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 67 of file RestrictSystemIncludesCheck.cpp.

References clang::tidy::bugprone::PP, and SM.

◆ storeOptions()

void clang::tidy::portability::RestrictSystemIncludesCheck::storeOptions ( ClangTidyOptions::OptionMap Options)
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 73 of file RestrictSystemIncludesCheck.cpp.


The documentation for this class was generated from the following files: