cprover
cpp_id.h
Go to the documentation of this file.
1 /*******************************************************************\
2 
3 Module: C++ Language Type Checking
4 
5 Author: Daniel Kroening, kroening@cs.cmu.edu
6 
7 \*******************************************************************/
8 
11 
12 #ifndef CPROVER_CPP_CPP_ID_H
13 #define CPROVER_CPP_CPP_ID_H
14 
15 #include <list>
16 #include <map>
17 #include <string>
18 #include <set>
19 #include <iosfwd>
20 
21 #include <util/expr.h>
22 #include <util/invariant.h>
23 #include <util/std_types.h>
24 
25 class cpp_scopet;
26 
27 class cpp_idt
28 {
29 public:
30  cpp_idt();
31 
32  enum class id_classt
33  {
34  UNKNOWN,
35  SYMBOL,
36  TYPEDEF,
37  CLASS,
38  ENUM,
39  TEMPLATE,
41  NAMESPACE,
44  ROOT_SCOPE,
45  };
46 
49 
51 
52  bool is_class() const
53  {
54  return id_class==id_classt::CLASS;
55  }
56 
57  bool is_enum() const
58  {
59  return id_class==id_classt::ENUM;
60  }
61 
62  bool is_namespace() const
63  {
65  }
66 
67  bool is_typedef() const
68  {
70  }
71 
72  bool is_template_scope() const
73  {
75  }
76 
78 
79  // if it is a member or method, what class is it in?
82 
83  // scope data
84  std::string prefix, suffix;
85  unsigned compound_counter;
86 
88  {
89  PRECONDITION(parent!=nullptr);
90  return *parent;
91  }
92 
93  void set_parent(cpp_idt &_parent)
94  {
95  assert(_parent.is_scope);
96  parent=&_parent;
97  }
98 
99  void clear()
100  {
101  *this=cpp_idt();
102  }
103 
104  void print(std::ostream &out, unsigned indent=0) const;
105  void print_fields(std::ostream &out, unsigned indent=0) const;
106 
107 protected:
108  typedef std::multimap<irep_idt, cpp_idt> cpp_id_mapt;
110 
111  // These are used for base classes and 'using' clauses.
112  typedef std::vector<cpp_idt *> scope_listt;
115 };
116 
117 std::ostream &operator<<(std::ostream &out, const cpp_idt &cpp_id);
118 std::ostream &operator<<(std::ostream &out, const cpp_idt::id_classt &id_class);
119 
120 #endif // CPROVER_CPP_CPP_ID_H
dstringt
dstringt has one field, an unsigned integer no which is an index into a static table of strings.
Definition: dstring.h:37
cpp_idt::class_identifier
irep_idt class_identifier
Definition: cpp_id.h:80
cpp_idt::is_class
bool is_class() const
Definition: cpp_id.h:52
cpp_scopet
Definition: cpp_scope.h:21
cpp_idt::is_typedef
bool is_typedef() const
Definition: cpp_id.h:67
cpp_idt::id_classt::CLASS
@ CLASS
cpp_idt::id_classt::UNKNOWN
@ UNKNOWN
cpp_idt::cpp_id_mapt
std::multimap< irep_idt, cpp_idt > cpp_id_mapt
Definition: cpp_id.h:108
cpp_idt::id_classt::TEMPLATE
@ TEMPLATE
cpp_idt::this_expr
exprt this_expr
Definition: cpp_id.h:81
cpp_idt::scope_listt
std::vector< cpp_idt * > scope_listt
Definition: cpp_id.h:112
cpp_idt::identifier
irep_idt identifier
Definition: cpp_id.h:77
invariant.h
exprt
Base class for all expressions.
Definition: expr.h:54
cpp_idt::suffix
std::string suffix
Definition: cpp_id.h:84
cpp_idt::id_classt::BLOCK_SCOPE
@ BLOCK_SCOPE
cpp_idt::parent
cpp_idt * parent
Definition: cpp_id.h:114
cpp_idt::sub
cpp_id_mapt sub
Definition: cpp_id.h:109
cpp_idt
Definition: cpp_id.h:28
cpp_idt::id_classt
id_classt
Definition: cpp_id.h:33
expr.h
cpp_idt::is_scope
bool is_scope
Definition: cpp_id.h:48
cpp_idt::is_method
bool is_method
Definition: cpp_id.h:47
cpp_idt::id_classt::SYMBOL
@ SYMBOL
cpp_idt::secondary_scopes
scope_listt secondary_scopes
Definition: cpp_id.h:113
cpp_idt::compound_counter
unsigned compound_counter
Definition: cpp_id.h:85
cpp_idt::id_classt::TEMPLATE_PARAMETER
@ TEMPLATE_PARAMETER
PRECONDITION
#define PRECONDITION(CONDITION)
Definition: invariant.h:464
std_types.h
Pre-defined types.
cpp_idt::is_constructor
bool is_constructor
Definition: cpp_id.h:48
cpp_idt::get_parent
cpp_idt & get_parent() const
Definition: cpp_id.h:87
cpp_idt::id_classt::ROOT_SCOPE
@ ROOT_SCOPE
cpp_idt::set_parent
void set_parent(cpp_idt &_parent)
Definition: cpp_id.h:93
cpp_idt::is_member
bool is_member
Definition: cpp_id.h:47
cpp_idt::is_namespace
bool is_namespace() const
Definition: cpp_id.h:62
cpp_idt::clear
void clear()
Definition: cpp_id.h:99
operator<<
std::ostream & operator<<(std::ostream &out, const cpp_idt &cpp_id)
Definition: cpp_id.cpp:94
cpp_idt::id_classt::TEMPLATE_SCOPE
@ TEMPLATE_SCOPE
cpp_idt::using_scopes
scope_listt using_scopes
Definition: cpp_id.h:113
cpp_idt::is_enum
bool is_enum() const
Definition: cpp_id.h:57
cpp_idt::print_fields
void print_fields(std::ostream &out, unsigned indent=0) const
Definition: cpp_id.cpp:46
cpp_idt::id_classt::TYPEDEF
@ TYPEDEF
cpp_idt::is_static_member
bool is_static_member
Definition: cpp_id.h:47
cpp_idt::id_class
id_classt id_class
Definition: cpp_id.h:50
cpp_idt::cpp_idt
cpp_idt()
Definition: cpp_id.cpp:20
cpp_idt::prefix
std::string prefix
Definition: cpp_id.h:84
cpp_idt::print
void print(std::ostream &out, unsigned indent=0) const
Definition: cpp_id.cpp:33
cpp_idt::is_template_scope
bool is_template_scope() const
Definition: cpp_id.h:72
cpp_idt::base_name
irep_idt base_name
Definition: cpp_id.h:77
cpp_idt::id_classt::ENUM
@ ENUM
cpp_idt::id_classt::NAMESPACE
@ NAMESPACE