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.)
64 lines
2.5 KiB
C++
64 lines
2.5 KiB
C++
//===----------------------------------------------------------------------===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "CheckerRegistration.h"
|
|
#include "clang/StaticAnalyzer/Core/Checker.h"
|
|
#include "clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h"
|
|
#include "clang/StaticAnalyzer/Core/PathSensitive/ProgramStateTrait.h"
|
|
#include "clang/StaticAnalyzer/Frontend/AnalysisConsumer.h"
|
|
#include "clang/StaticAnalyzer/Frontend/CheckerRegistry.h"
|
|
#include "gtest/gtest.h"
|
|
|
|
using namespace clang;
|
|
using namespace ento;
|
|
|
|
// Some dummy trait that we can mutate back and forth to force a new State.
|
|
REGISTER_TRAIT_WITH_PROGRAMSTATE(Flag, bool)
|
|
|
|
namespace {
|
|
class FlipFlagOnCheckLocation : public Checker<check::Location> {
|
|
public:
|
|
// We make sure we alter the State every time we model a checkLocation event.
|
|
void checkLocation(SVal l, bool isLoad, const Stmt *S,
|
|
CheckerContext &C) const {
|
|
ProgramStateRef State = C.getState();
|
|
State = State->set<Flag>(!State->get<Flag>());
|
|
C.addTransition(State);
|
|
}
|
|
};
|
|
|
|
void addFlagFlipperChecker(AnalysisASTConsumer &AnalysisConsumer,
|
|
AnalyzerOptions &AnOpts) {
|
|
AnOpts.CheckersAndPackages = {{"test.FlipFlagOnCheckLocation", true}};
|
|
AnalysisConsumer.AddCheckerRegistrationFn([](CheckerRegistry &Registry) {
|
|
Registry.addChecker<FlipFlagOnCheckLocation>("test.FlipFlagOnCheckLocation",
|
|
"MockDescription");
|
|
});
|
|
}
|
|
|
|
TEST(ObjCTest, CheckLocationEventsShouldMaterializeInObjCForCollectionStmts) {
|
|
// Previously, the `ExprEngine::hasMoreIteration` may fired an assertion
|
|
// because we forgot to handle correctly the resulting nodes of the
|
|
// check::Location callback for the ObjCForCollectionStmts.
|
|
// This caused inconsistencies in the graph and triggering the assertion.
|
|
// See #124477 for more details.
|
|
std::string Diags;
|
|
EXPECT_TRUE(runCheckerOnCodeWithArgs<addFlagFlipperChecker>(
|
|
R"(
|
|
@class NSArray, NSDictionary, NSString;
|
|
extern void NSLog(NSString *format, ...) __attribute__((format(__NSString__, 1, 2)));
|
|
void entrypoint(NSArray *bowl) {
|
|
for (NSString *fruit in bowl) { // no-crash
|
|
NSLog(@"Fruit: %@", fruit);
|
|
}
|
|
})",
|
|
{"-x", "objective-c"}, Diags));
|
|
}
|
|
|
|
} // namespace
|