clang  3.7.0
BugType.h
Go to the documentation of this file.
1 //===--- BugType.h - Bug Information Desciption ----------------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file defines BugType, a class representing a bug type.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_CLANG_STATICANALYZER_CORE_BUGREPORTER_BUGTYPE_H
15 #define LLVM_CLANG_STATICANALYZER_CORE_BUGREPORTER_BUGTYPE_H
16 
17 #include "clang/Basic/LLVM.h"
20 #include "llvm/ADT/FoldingSet.h"
21 #include <string>
22 
23 namespace clang {
24 
25 namespace ento {
26 
27 class BugReporter;
28 class ExplodedNode;
29 class ExprEngine;
30 
31 class BugType {
32 private:
33  const CheckName Check;
34  const std::string Name;
35  const std::string Category;
36  bool SuppressonSink;
37 
38  virtual void anchor();
39 public:
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) {}
45  virtual ~BugType() {}
46 
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(); }
51 
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
54  /// by a sink node.
55  bool isSuppressOnSink() const { return SuppressonSink; }
56  void setSuppressOnSink(bool x) { SuppressonSink = x; }
57 
58  virtual void FlushReports(BugReporter& BR);
59 };
60 
61 class BuiltinBug : public BugType {
62  const std::string desc;
63  void anchor() override;
64 public:
65  BuiltinBug(class CheckName check, const char *name, const char *description)
66  : BugType(check, name, categories::LogicError), desc(description) {}
67 
68  BuiltinBug(const CheckerBase *checker, const char *name,
69  const char *description)
70  : BugType(checker, name, categories::LogicError), desc(description) {}
71 
72  BuiltinBug(const CheckerBase *checker, const char *name)
73  : BugType(checker, name, categories::LogicError), desc(name) {}
74 
75  StringRef getDescription() const { return desc; }
76 };
77 
78 } // end GR namespace
79 
80 } // end clang namespace
81 #endif
BuiltinBug(class CheckName check, const char *name, const char *description)
Definition: BugType.h:65
StringRef getCategory() const
Definition: BugType.h:49
StringRef getName() const
BugType(const CheckerBase *checker, StringRef name, StringRef cat)
Definition: BugType.h:42
StringRef getDescription() const
Definition: BugType.h:75
virtual ~BugType()
Definition: BugType.h:45
virtual void FlushReports(BugReporter &BR)
BuiltinBug(const CheckerBase *checker, const char *name)
Definition: BugType.h:72
BugType(class CheckName check, StringRef name, StringRef cat)
Definition: BugType.h:40
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified...
bool isSuppressOnSink() const
Definition: BugType.h:55
void setSuppressOnSink(bool x)
Definition: BugType.h:56
StringRef getName() const
Definition: BugType.h:48
#define false
Definition: stdbool.h:33
StringRef getCheckName() const
Definition: BugType.h:50
BuiltinBug(const CheckerBase *checker, const char *name, const char *description)
Definition: BugType.h:68