clang-tools  14.0.0git
Classes | Public Member Functions | List of all members
clang::tidy::google::readability::TodoCommentCheck Class Reference

Finds TODO comments without a username or bug number. More...

#include <TodoCommentCheck.h>

Inheritance diagram for clang::tidy::google::readability::TodoCommentCheck:
Inheritance graph
Collaboration diagram for clang::tidy::google::readability::TodoCommentCheck:
Collaboration graph


class  TodoCommentHandler

Public Member Functions

 TodoCommentCheck (StringRef Name, ClangTidyContext *Context)
 ~TodoCommentCheck ()
void registerPPCallbacks (const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override
 Override this to register PPCallbacks in the preprocessor. More...
- 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...
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. 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

Finds TODO comments without a username or bug number.

Corresponding check: 'readability/todo'

For the user-facing documentation see:

Definition at line 25 of file TodoCommentCheck.h.

Constructor & Destructor Documentation

◆ TodoCommentCheck()

clang::tidy::google::readability::TodoCommentCheck::TodoCommentCheck ( StringRef  Name,
ClangTidyContext Context 

Definition at line 53 of file TodoCommentCheck.cpp.

◆ ~TodoCommentCheck()

clang::tidy::google::readability::TodoCommentCheck::~TodoCommentCheck ( )

Member Function Documentation

◆ registerPPCallbacks()

void clang::tidy::google::readability::TodoCommentCheck::registerPPCallbacks ( const SourceManager &  SM,
Preprocessor *  PP,
Preprocessor *  ModuleExpanderPP 

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 60 of file TodoCommentCheck.cpp.

References clang::tidy::bugprone::PP.

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