Checks for functions that have safer, more secure replacements available, or are considered deprecated due to design flaws. More...
#include <UnsafeFunctionsCheck.h>
Classes | |
| struct | CheckedFunction |
Public Member Functions | |
| UnsafeFunctionsCheck (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. | |
| 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 | onEndOfTranslationUnit () override |
 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 |
Detailed Description
Checks for functions that have safer, more secure replacements available, or are considered deprecated due to design flaws.
This check relies heavily on, but is not exclusive to, the functions from the Annex K. "Bounds-checking interfaces" of C11.
http://clang.llvm.org/extra/clang-tidy/checks/bugprone/unsafe-functions.html
Definition at line 24 of file UnsafeFunctionsCheck.h.
Constructor & Destructor Documentation
◆ UnsafeFunctionsCheck()
| clang::tidy::bugprone::UnsafeFunctionsCheck::UnsafeFunctionsCheck | ( | StringRef | Name, |
| ClangTidyContext * | Context | ||
| ) |
Definition at line 183 of file UnsafeFunctionsCheck.cpp.
Member Function Documentation
◆ check()
|
overridevirtual |
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Reimplemented from clang::tidy::ClangTidyCheck.
Definition at line 262 of file UnsafeFunctionsCheck.cpp.
References clang::tidy::bugprone::AdditionalFunctionNamesId, clang::tidy::bugprone::CustomFunctionNamesId, DeclRef, clang::tidy::bugprone::DeclRefId, clang::tidy::ClangTidyCheck::diag(), FuncDecl, clang::tidy::bugprone::FunctionNamesId, clang::tidy::bugprone::FunctionNamesWithAnnexKReplacementId, clang::tidy::bugprone::getAnnexKReplacementFor(), clang::tidy::ClangTidyCheck::getLangOpts(), clang::tidy::bugprone::getRationaleFor(), clang::tidy::bugprone::getReplacementFor(), clang::tidy::bugprone::getReplacementForAdditional(), and clang::tidy::bugprone::isAnnexKAvailable().
◆ onEndOfTranslationUnit()
|
override |
Definition at line 337 of file UnsafeFunctionsCheck.cpp.
◆ registerMatchers()
|
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 201 of file UnsafeFunctionsCheck.cpp.
References clang::tidy::bugprone::AdditionalFunctionNamesId, clang::tidy::bugprone::CustomFunctionNamesId, clang::tidy::bugprone::DeclRefId, clang::tidy::bugprone::FunctionNamesId, clang::tidy::bugprone::FunctionNamesWithAnnexKReplacementId, clang::tidy::ClangTidyCheck::getLangOpts(), and clang::tidy::matchers::matchesAnyListedName().
◆ registerPPCallbacks()
|
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 331 of file UnsafeFunctionsCheck.cpp.
◆ storeOptions()
|
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 193 of file UnsafeFunctionsCheck.cpp.
References clang::tidy::bugprone::OptionNameCustomFunctions, clang::tidy::bugprone::OptionNameReportDefaultFunctions, clang::tidy::bugprone::OptionNameReportMoreUnsafeFunctions, clang::tidy::ClangTidyCheck::Options, clang::tidy::bugprone::serializeCheckedFunctions(), and clang::tidy::ClangTidyCheck::OptionsView::store().
The documentation for this class was generated from the following files:
