a807e8ea9f
This commit tweaks the interface of `CheckerRegistry::addChecker` to make it more practical for plugins and tests: - The parameter `IsHidden` now defaults to `false` even in the non-templated overload (because setting it to true is unusual, especially in plugins). - The parameter `DocsUri` defaults to the dummy placeholder string `"NoDocsUri"` because (as of now) nothing queries its value from the checker registry (it's only used by the logic that generates the clang-tidy documentation, but that loads it directly from `Checkers.td` without involving the `CheckerRegistry`), so there is no reason to demand specifying this value. In addition to propagating these changes, this commit clarifies, corrects and extends lots of comments and performs various minor code quality improvements in the code of unit tests and example plugins. I originally wrote the bulk of this commit when I was planning to add an extra parameter to `addChecker` in order to implement some technical details of the CheckerFamily framework. At the end I decided against adding that extra parameter, so this cleanup was left out of the PR https://github.com/llvm/llvm-project/pull/139256 and I'm merging it now as a separate commit (after minor tweaks). This commit is mostly NFC: the only functional change is that the analyzer will be compatible with plugins that rely on the default argument values and don't specify `IsHidden` or `DocsUri`. (But existing plugin code will remain valid as well.)
55 lines
1.6 KiB
C++
55 lines
1.6 KiB
C++
#include "clang/StaticAnalyzer/Core/BugReporter/BugType.h"
|
|
#include "clang/StaticAnalyzer/Core/Checker.h"
|
|
#include "clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h"
|
|
#include "clang/StaticAnalyzer/Frontend/CheckerRegistry.h"
|
|
|
|
// This simple plugin is used by clang/test/Analysis/checker-plugins.c
|
|
// to test the use of a checker that is defined in a plugin.
|
|
|
|
using namespace clang;
|
|
using namespace ento;
|
|
|
|
namespace {
|
|
class MainCallChecker : public Checker<check::PreStmt<CallExpr>> {
|
|
|
|
const BugType BT{this, "call to main", "example analyzer plugin"};
|
|
|
|
public:
|
|
void checkPreStmt(const CallExpr *CE, CheckerContext &C) const;
|
|
};
|
|
} // end anonymous namespace
|
|
|
|
void MainCallChecker::checkPreStmt(const CallExpr *CE,
|
|
CheckerContext &C) const {
|
|
const Expr *Callee = CE->getCallee();
|
|
const FunctionDecl *FD = C.getSVal(Callee).getAsFunctionDecl();
|
|
|
|
if (!FD)
|
|
return;
|
|
|
|
// Get the name of the callee.
|
|
IdentifierInfo *II = FD->getIdentifier();
|
|
if (!II) // if no identifier, not a simple C function
|
|
return;
|
|
|
|
if (II->isStr("main")) {
|
|
ExplodedNode *N = C.generateErrorNode();
|
|
if (!N)
|
|
return;
|
|
|
|
auto report =
|
|
std::make_unique<PathSensitiveBugReport>(BT, BT.getDescription(), N);
|
|
report->addRange(Callee->getSourceRange());
|
|
C.emitReport(std::move(report));
|
|
}
|
|
}
|
|
|
|
// Register plugin!
|
|
extern "C" void clang_registerCheckers(CheckerRegistry &Registry) {
|
|
Registry.addChecker<MainCallChecker>("example.MainCallChecker",
|
|
"Example Description");
|
|
}
|
|
|
|
extern "C" const char clang_analyzerAPIVersionString[] =
|
|
CLANG_ANALYZER_API_VERSION_STRING;
|