1 //===--- BugType.h - Bug Information Desciption ----------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines BugType, a class representing a bug type.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CLANG_STATICANALYZER_CORE_BUGREPORTER_BUGTYPE_H
15 #define LLVM_CLANG_STATICANALYZER_CORE_BUGREPORTER_BUGTYPE_H
17 #include "clang/Basic/LLVM.h"
18 #include "clang/StaticAnalyzer/Core/BugReporter/CommonBugCategories.h"
19 #include "clang/StaticAnalyzer/Core/Checker.h"
20 #include "llvm/ADT/FoldingSet.h"
33 const CheckName Check;
34 const std::string Name;
35 const std::string Category;
38 virtual void anchor();
40 BugType(class CheckName check, StringRef name, StringRef cat)
41 : Check(check), Name(name), Category(cat), SuppressonSink(false) {}
42 BugType(const CheckerBase *checker, StringRef name, StringRef cat)
43 : Check(checker->getCheckName()), Name(name), Category(cat),
44 SuppressonSink(false) {}
47 // FIXME: Should these be made strings as well?
48 StringRef getName() const { return Name; }
49 StringRef getCategory() const { return Category; }
50 StringRef getCheckName() const { return Check.getName(); }
52 /// isSuppressOnSink - Returns true if bug reports associated with this bug
53 /// type should be suppressed if the end node of the report is post-dominated
55 bool isSuppressOnSink() const { return SuppressonSink; }
56 void setSuppressOnSink(bool x) { SuppressonSink = x; }
58 virtual void FlushReports(BugReporter& BR);
61 class BuiltinBug : public BugType {
62 const std::string desc;
63 void anchor() override;
65 BuiltinBug(class CheckName check, const char *name, const char *description)
66 : BugType(check, name, categories::LogicError), desc(description) {}
68 BuiltinBug(const CheckerBase *checker, const char *name,
69 const char *description)
70 : BugType(checker, name, categories::LogicError), desc(description) {}
72 BuiltinBug(const CheckerBase *checker, const char *name)
73 : BugType(checker, name, categories::LogicError), desc(name) {}
75 StringRef getDescription() const { return desc; }
80 } // end clang namespace