27099982da
In the static analyzer codebase we have a traditional pattern where a single checker class (and its singleton instance) acts as the implementation of several (user-facing or modeling) checkers that have shared state and logic, but have their own names and can be enabled or disabled separately. Currently these multipart checker classes all reimplement the same boilerplate logic to store the enabled/disabled state, the name and the bug types associated with the checker parts. This commit extends `CheckerBase`, `BugType` and the checker registration process to offer an easy-to-use alternative to that boilerplate (which includes the ugly lazy initialization of `mutable std::unique_ptr<BugType>`s). In this new framework the single-part checkers are internally represented as "multipart checkers with just one part" (because this way I don't need to reimplement the same logic twice) but this does not require any changes in the code of simple single-part checkers. I do not claim that these multi-part checkers are perfect from an architectural point of view; but they won't suddenly disappear after many years of existence, so we might as well introduce a clear framework for them. (Switching to e.g. 1:1 correspondence between checker classes and checker names would be a prohibitively complex change.) This PR ports `DivZeroChecker` to the new framework as a proof of concept. I'm planning to do a series of follow-up commits to port the rest of the multi-part checker.
37 lines
1.4 KiB
C++
37 lines
1.4 KiB
C++
//== Checker.cpp - Registration mechanism for checkers -----------*- 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file defines Checker, used to create and register checkers.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState.h"
|
|
#include "clang/StaticAnalyzer/Core/Checker.h"
|
|
|
|
using namespace clang;
|
|
using namespace ento;
|
|
|
|
int ImplicitNullDerefEvent::Tag;
|
|
|
|
void CheckerBase::printState(raw_ostream &Out, ProgramStateRef State,
|
|
const char *NL, const char *Sep) const {}
|
|
|
|
CheckerProgramPointTag::CheckerProgramPointTag(StringRef CheckerName,
|
|
StringRef Msg)
|
|
: SimpleProgramPointTag(CheckerName, Msg) {}
|
|
|
|
CheckerProgramPointTag::CheckerProgramPointTag(const CheckerBase *Checker,
|
|
StringRef Msg)
|
|
: SimpleProgramPointTag(Checker->getName(), Msg) {}
|
|
|
|
raw_ostream& clang::ento::operator<<(raw_ostream &Out,
|
|
const CheckerBase &Checker) {
|
|
Out << Checker.getName();
|
|
return Out;
|
|
}
|