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

Finds function calls where it is possible to cause a not null-terminated result. More...

#include <NotNullTerminatedResultCheck.h>

Inheritance diagram for clang::tidy::bugprone::NotNullTerminatedResultCheck:
Inheritance graph
[legend]
Collaboration diagram for clang::tidy::bugprone::NotNullTerminatedResultCheck:
Collaboration graph
[legend]

Public Member Functions

 NotNullTerminatedResultCheck (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. More...
 
void registerMatchers (ast_matchers::MatchFinder *Finder) override
 Override this to register AST matchers with Finder. More...
 
void check (const ast_matchers::MatchFinder::MatchResult &Result) override
 ClangTidyChecks that register ASTMatchers should do the actual work in here. More...
 
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...
 
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

Finds function calls where it is possible to cause a not null-terminated result.

Usually the proper length of a string is 'strlen(src) + 1' or equal length of this expression, because the null terminator needs an extra space. Without the null terminator it can result in undefined behaviour when the string is read.

For the user-facing documentation see: http://clang.llvm.org/extra/clang-tidy/checks/bugprone-not-null-terminated-result.html

Definition at line 26 of file NotNullTerminatedResultCheck.h.

Constructor & Destructor Documentation

◆ NotNullTerminatedResultCheck()

clang::tidy::bugprone::NotNullTerminatedResultCheck::NotNullTerminatedResultCheck ( StringRef  Name,
ClangTidyContext Context 
)

Definition at line 500 of file NotNullTerminatedResultCheck.cpp.

Member Function Documentation

◆ check()

void clang::tidy::bugprone::NotNullTerminatedResultCheck::check ( const ast_matchers::MatchFinder::MatchResult &  Result)
overridevirtual

ClangTidyChecks that register ASTMatchers should do the actual work in here.

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 792 of file NotNullTerminatedResultCheck.cpp.

◆ registerMatchers()

void clang::tidy::bugprone::NotNullTerminatedResultCheck::registerMatchers ( ast_matchers::MatchFinder *  Finder)
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 544 of file NotNullTerminatedResultCheck.cpp.

◆ registerPPCallbacks()

void clang::tidy::bugprone::NotNullTerminatedResultCheck::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 510 of file NotNullTerminatedResultCheck.cpp.

◆ storeOptions()

void clang::tidy::bugprone::NotNullTerminatedResultCheck::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 505 of file NotNullTerminatedResultCheck.cpp.


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