cprover
expr2c_class.h
Go to the documentation of this file.
1 /*******************************************************************\
2 
3 Module:
4 
5 Author: Daniel Kroening, kroening@kroening.com
6 
7 \*******************************************************************/
8 
9 
10 #ifndef CPROVER_ANSI_C_EXPR2C_CLASS_H
11 #define CPROVER_ANSI_C_EXPR2C_CLASS_H
12 
13 #include "expr2c.h"
14 
15 #include <string>
16 #include <unordered_map>
17 #include <unordered_set>
18 
19 #include <util/bitvector_expr.h>
20 #include <util/byte_operators.h>
21 #include <util/mathematical_expr.h>
22 #include <util/std_code.h>
23 #include <util/std_expr.h>
24 
25 class qualifierst;
26 class namespacet;
27 
28 class expr2ct
29 {
30 public:
31  explicit expr2ct(
32  const namespacet &_ns,
36  {
37  }
38  virtual ~expr2ct() { }
39 
40  virtual std::string convert(const typet &src);
41  virtual std::string convert(const exprt &src);
42 
43  void get_shorthands(const exprt &expr);
44 
45  std::string
46  convert_with_identifier(const typet &src, const std::string &identifier);
47 
48 protected:
49  const namespacet &ns;
51 
52  virtual std::string convert_rec(
53  const typet &src,
54  const qualifierst &qualifiers,
55  const std::string &declarator);
56 
57  virtual std::string convert_struct_type(
58  const typet &src,
59  const std::string &qualifiers_str,
60  const std::string &declarator_str);
61 
62  std::string convert_struct_type(
63  const typet &src,
64  const std::string &qualifer_str,
65  const std::string &declarator_str,
66  bool inc_struct_body,
67  bool inc_padding_components);
68 
69  virtual std::string convert_array_type(
70  const typet &src,
71  const qualifierst &qualifiers,
72  const std::string &declarator_str);
73 
74  std::string convert_array_type(
75  const typet &src,
76  const qualifierst &qualifiers,
77  const std::string &declarator_str,
78  bool inc_size_if_possible);
79 
80  static std::string indent_str(unsigned indent);
81 
82  std::unordered_map<irep_idt, std::unordered_set<irep_idt>> ns_collision;
83  std::unordered_map<irep_idt, irep_idt> shorthands;
84 
85  unsigned sizeof_nesting;
86 
87  irep_idt id_shorthand(const irep_idt &identifier) const;
88 
89  std::string convert_typecast(
90  const typecast_exprt &src, unsigned &precedence);
91 
93  const exprt &src,
94  unsigned &precedence);
95 
97  const exprt &src,
98  unsigned &precedence);
99 
100  std::string convert_binary(
101  const binary_exprt &,
102  const std::string &symbol,
103  unsigned precedence,
104  bool full_parentheses);
105 
106  std::string convert_multi_ary(
107  const exprt &src, const std::string &symbol,
108  unsigned precedence, bool full_parentheses);
109 
110  std::string convert_cond(
111  const exprt &src, unsigned precedence);
112 
114  const exprt &src, unsigned precedence);
115 
117  const exprt &src, unsigned precedence);
118 
119  std::string convert_member(
120  const member_exprt &src, unsigned precedence);
121 
122  std::string convert_array_of(const exprt &src, unsigned precedence);
123 
124  std::string convert_trinary(
125  const ternary_exprt &src,
126  const std::string &symbol1,
127  const std::string &symbol2,
128  unsigned precedence);
129 
130  std::string convert_overflow(
131  const exprt &src, unsigned &precedence);
132 
133  std::string convert_quantifier(
134  const quantifier_exprt &,
135  const std::string &symbol,
136  unsigned precedence);
137 
138  std::string convert_with(
139  const exprt &src, unsigned precedence);
140 
141  std::string convert_update(const update_exprt &, unsigned precedence);
142 
144  const exprt &src);
145 
147  const exprt &src);
148 
149  std::string convert_index(
150  const exprt &src, unsigned precedence);
151 
152  std::string
153  convert_byte_extract(const byte_extract_exprt &, unsigned precedence);
154 
155  std::string
156  convert_byte_update(const byte_update_exprt &, unsigned precedence);
157 
158  std::string convert_extractbit(const extractbit_exprt &, unsigned precedence);
159 
160  std::string
161  convert_extractbits(const extractbits_exprt &src, unsigned precedence);
162 
163  std::string convert_unary(
164  const unary_exprt &,
165  const std::string &symbol,
166  unsigned precedence);
167 
168  std::string convert_unary_post(
169  const exprt &src, const std::string &symbol,
170  unsigned precedence);
171 
175  std::string convert_function(const exprt &src, const std::string &symbol);
176 
177  std::string convert_complex(
178  const exprt &src,
179  unsigned precedence);
180 
181  std::string convert_comma(
182  const exprt &src,
183  unsigned precedence);
184 
185  std::string convert_Hoare(const exprt &src);
186 
187  std::string convert_code(const codet &src);
188  virtual std::string convert_code(const codet &src, unsigned indent);
189  std::string convert_code_label(const code_labelt &src, unsigned indent);
190  // NOLINTNEXTLINE(whitespace/line_length)
191  std::string convert_code_switch_case(const code_switch_caset &src, unsigned indent);
192  std::string convert_code_asm(const code_asmt &src, unsigned indent);
193  std::string convert_code_assign(const code_assignt &src, unsigned indent);
194  // NOLINTNEXTLINE(whitespace/line_length)
195  std::string convert_code_ifthenelse(const code_ifthenelset &src, unsigned indent);
196  std::string convert_code_for(const code_fort &src, unsigned indent);
197  std::string convert_code_while(const code_whilet &src, unsigned indent);
198  std::string convert_code_dowhile(const code_dowhilet &src, unsigned indent);
199  std::string convert_code_block(const code_blockt &src, unsigned indent);
200  std::string convert_code_expression(const codet &src, unsigned indent);
201  std::string convert_code_return(const codet &src, unsigned indent);
202  std::string convert_code_goto(const codet &src, unsigned indent);
203  std::string convert_code_assume(const codet &src, unsigned indent);
204  std::string convert_code_assert(const codet &src, unsigned indent);
205  std::string convert_code_break(unsigned indent);
206  std::string convert_code_switch(const codet &src, unsigned indent);
207  std::string convert_code_continue(unsigned indent);
208  std::string convert_code_decl(const codet &src, unsigned indent);
209  std::string convert_code_decl_block(const codet &src, unsigned indent);
210  std::string convert_code_dead(const codet &src, unsigned indent);
211  // NOLINTNEXTLINE(whitespace/line_length)
212  std::string convert_code_function_call(const code_function_callt &src, unsigned indent);
213  std::string convert_code_lock(const codet &src, unsigned indent);
214  std::string convert_code_unlock(const codet &src, unsigned indent);
215  std::string convert_code_printf(const codet &src, unsigned indent);
216  std::string convert_code_fence(const codet &src, unsigned indent);
217  std::string convert_code_input(const codet &src, unsigned indent);
218  std::string convert_code_output(const codet &src, unsigned indent);
219  std::string convert_code_array_set(const codet &src, unsigned indent);
220  std::string convert_code_array_copy(const codet &src, unsigned indent);
221  std::string convert_code_array_replace(const codet &src, unsigned indent);
222 
223  virtual std::string convert_with_precedence(
224  const exprt &src, unsigned &precedence);
225 
226  std::string
230  std::string convert_allocate(const exprt &src, unsigned &precedence);
231  std::string convert_nondet(const exprt &src, unsigned &precedence);
232  std::string convert_prob_coin(const exprt &src, unsigned &precedence);
233  std::string convert_prob_uniform(const exprt &src, unsigned &precedence);
234  // NOLINTNEXTLINE(whitespace/line_length)
235  std::string convert_statement_expression(const exprt &src, unsigned &precendence);
236 
237  virtual std::string convert_symbol(const exprt &src);
238  std::string convert_predicate_symbol(const exprt &src);
239  std::string convert_predicate_next_symbol(const exprt &src);
240  std::string convert_predicate_passive_symbol(const exprt &src);
242  std::string convert_quantified_symbol(const exprt &src);
243  std::string convert_nondet_bool();
244  std::string convert_object_descriptor(const exprt &src, unsigned &precedence);
245  std::string convert_literal(const exprt &src);
246  // NOLINTNEXTLINE(whitespace/line_length)
247  virtual std::string convert_constant(const constant_exprt &src, unsigned &precedence);
248  virtual std::string convert_constant_bool(bool boolean_value);
249 
250  std::string convert_norep(const exprt &src, unsigned &precedence);
251 
252  virtual std::string convert_struct(const exprt &src, unsigned &precedence);
253  std::string convert_union(const exprt &src, unsigned &precedence);
254  std::string convert_vector(const exprt &src, unsigned &precedence);
255  std::string convert_array(const exprt &src);
256  std::string convert_array_list(const exprt &src, unsigned &precedence);
257  std::string convert_initializer_list(const exprt &src);
258  std::string convert_designated_initializer(const exprt &src);
259  std::string convert_concatenation(const exprt &src, unsigned &precedence);
260  std::string convert_sizeof(const exprt &src, unsigned &precedence);
261  std::string convert_let(const let_exprt &, unsigned precedence);
262 
263  std::string convert_struct(
264  const exprt &src,
265  unsigned &precedence,
266  bool include_padding_components);
267 };
268 
269 #endif // CPROVER_ANSI_C_EXPR2C_CLASS_H
dstringt
dstringt has one field, an unsigned integer no which is an index into a static table of strings.
Definition: dstring.h:37
expr2ct::convert_code_while
std::string convert_code_while(const code_whilet &src, unsigned indent)
code_blockt
A codet representing sequential composition of program statements.
Definition: std_code.h:170
expr2ct::convert_prob_uniform
std::string convert_prob_uniform(const exprt &src, unsigned &precedence)
code_switch_caset
codet representation of a switch-case, i.e. a case statement within a switch.
Definition: std_code.h:1471
expr2ct::convert_code_fence
std::string convert_code_fence(const codet &src, unsigned indent)
expr2ct::convert_cond
std::string convert_cond(const exprt &src, unsigned precedence)
byte_update_exprt
Expression corresponding to op() where the bytes starting at position offset (given in number of byte...
Definition: byte_operators.h:81
code_whilet
codet representing a while statement.
Definition: std_code.h:928
nondet_symbol_exprt
Expression to hold a nondeterministic choice.
Definition: std_expr.h:209
expr2ct::convert_union
std::string convert_union(const exprt &src, unsigned &precedence)
code_asmt
codet representation of an inline assembler statement.
Definition: std_code.h:1701
code_fort
codet representation of a for statement.
Definition: std_code.h:1052
expr2ct::convert_struct_type
virtual std::string convert_struct_type(const typet &src, const std::string &qualifiers_str, const std::string &declarator_str)
expr2ct::convert_statement_expression
std::string convert_statement_expression(const exprt &src, unsigned &precendence)
expr2ct::convert_struct
std::string convert_struct(const exprt &src, unsigned &precedence, bool include_padding_components)
typet
The type of an expression, extends irept.
Definition: type.h:28
ternary_exprt
An expression with three operands.
Definition: std_expr.h:53
expr2ct::convert_comma
std::string convert_comma(const exprt &src, unsigned precedence)
expr2ct::convert_pointer_arithmetic
std::string convert_pointer_arithmetic(const exprt &src, unsigned &precedence)
expr2ct::convert_code_assert
std::string convert_code_assert(const codet &src, unsigned indent)
expr2ct::convert_with_identifier
std::string convert_with_identifier(const typet &src, const std::string &identifier)
side_effect_expr_function_callt
A side_effect_exprt representation of a function call side effect.
Definition: std_code.h:2140
expr2ct::convert_quantifier
std::string convert_quantifier(const quantifier_exprt &, const std::string &symbol, unsigned precedence)
expr2ct::convert_code_function_call
std::string convert_code_function_call(const code_function_callt &src, unsigned indent)
expr2ct::convert_update
std::string convert_update(const update_exprt &, unsigned precedence)
expr2ct::convert_let
std::string convert_let(const let_exprt &, unsigned precedence)
expr2ct::convert_byte_extract
std::string convert_byte_extract(const byte_extract_exprt &, unsigned precedence)
expr2ct::convert_code_decl
std::string convert_code_decl(const codet &src, unsigned indent)
expr2ct::convert_nondet_bool
std::string convert_nondet_bool()
expr2ct::convert_code_decl_block
std::string convert_code_decl_block(const codet &src, unsigned indent)
expr2ct::convert_code_expression
std::string convert_code_expression(const codet &src, unsigned indent)
expr2ct::convert_array_type
std::string convert_array_type(const typet &src, const qualifierst &qualifiers, const std::string &declarator_str, bool inc_size_if_possible)
exprt
Base class for all expressions.
Definition: expr.h:54
expr2ct::convert_quantified_symbol
std::string convert_quantified_symbol(const exprt &src)
unary_exprt
Generic base class for unary expressions.
Definition: std_expr.h:281
expr2ct::convert_array_list
std::string convert_array_list(const exprt &src, unsigned &precedence)
binary_exprt
A base class for binary expressions.
Definition: std_expr.h:550
expr2c_configurationt::default_configuration
static expr2c_configurationt default_configuration
This prints a human readable C like syntax that closely mirrors the internals of the GOTO program.
Definition: expr2c.h:71
expr2ct::expr2ct
expr2ct(const namespacet &_ns, const expr2c_configurationt &configuration=expr2c_configurationt::default_configuration)
Definition: expr2c_class.h:31
expr2ct::convert_code_input
std::string convert_code_input(const codet &src, unsigned indent)
quantifier_exprt
A base class for quantifier expressions.
Definition: mathematical_expr.h:265
expr2ct::convert_Hoare
std::string convert_Hoare(const exprt &src)
expr2ct::convert_code
std::string convert_code(const codet &src)
expr2ct::convert_array_of
std::string convert_array_of(const exprt &src, unsigned precedence)
expr2ct::convert_code
virtual std::string convert_code(const codet &src, unsigned indent)
expr2ct::convert_unary_post
std::string convert_unary_post(const exprt &src, const std::string &symbol, unsigned precedence)
expr2ct::~expr2ct
virtual ~expr2ct()
Definition: expr2c_class.h:38
expr2ct::convert_code_ifthenelse
std::string convert_code_ifthenelse(const code_ifthenelset &src, unsigned indent)
qualifierst
Definition: c_qualifiers.h:19
expr2ct::convert_code_switch_case
std::string convert_code_switch_case(const code_switch_caset &src, unsigned indent)
expr2ct::convert_predicate_symbol
std::string convert_predicate_symbol(const exprt &src)
expr2ct::shorthands
std::unordered_map< irep_idt, irep_idt > shorthands
Definition: expr2c_class.h:83
code_ifthenelset
codet representation of an if-then-else statement.
Definition: std_code.h:778
expr2ct::convert_trinary
std::string convert_trinary(const ternary_exprt &src, const std::string &symbol1, const std::string &symbol2, unsigned precedence)
expr2ct::convert_code_assign
std::string convert_code_assign(const code_assignt &src, unsigned indent)
expr2ct::sizeof_nesting
unsigned sizeof_nesting
Definition: expr2c_class.h:85
expr2ct::convert_with_precedence
virtual std::string convert_with_precedence(const exprt &src, unsigned &precedence)
expr2ct::convert_array_type
virtual std::string convert_array_type(const typet &src, const qualifierst &qualifiers, const std::string &declarator_str)
expr2ct::convert_overflow
std::string convert_overflow(const exprt &src, unsigned &precedence)
expr2ct::ns_collision
std::unordered_map< irep_idt, std::unordered_set< irep_idt > > ns_collision
Definition: expr2c_class.h:82
namespacet
A namespacet is essentially one or two symbol tables bound together, to allow for symbol lookups in t...
Definition: namespace.h:92
expr2ct::convert_constant_bool
virtual std::string convert_constant_bool(bool boolean_value)
expr2ct::convert_typecast
std::string convert_typecast(const typecast_exprt &src, unsigned &precedence)
code_function_callt
codet representation of a function call statement.
Definition: std_code.h:1215
expr2ct::convert_predicate_passive_symbol
std::string convert_predicate_passive_symbol(const exprt &src)
expr2ct
Definition: expr2c_class.h:29
expr2ct::convert
virtual std::string convert(const typet &src)
Definition: expr2c.cpp:187
byte_operators.h
Expression classes for byte-level operators.
code_dowhilet
codet representation of a do while statement.
Definition: std_code.h:990
expr2ct::convert_code_array_set
std::string convert_code_array_set(const codet &src, unsigned indent)
expr2ct::convert_code_for
std::string convert_code_for(const code_fort &src, unsigned indent)
expr2ct::convert_member_designator
std::string convert_member_designator(const exprt &src)
expr2ct::convert_array_member_value
std::string convert_array_member_value(const exprt &src, unsigned precedence)
expr2ct::convert_nondet_symbol
std::string convert_nondet_symbol(const nondet_symbol_exprt &)
expr2ct::convert_code_printf
std::string convert_code_printf(const codet &src, unsigned indent)
expr2ct::convert_function
std::string convert_function(const exprt &src, const std::string &symbol)
expr2c.h
code_labelt
codet representation of a label for branch targets.
Definition: std_code.h:1407
expr2ct::convert_pointer_difference
std::string convert_pointer_difference(const exprt &src, unsigned &precedence)
expr2ct::convert
virtual std::string convert(const exprt &src)
expr2ct::convert_prob_coin
std::string convert_prob_coin(const exprt &src, unsigned &precedence)
expr2ct::convert_code_asm
std::string convert_code_asm(const code_asmt &src, unsigned indent)
function_application_exprt
Application of (mathematical) function.
Definition: mathematical_expr.h:194
expr2ct::convert_code_lock
std::string convert_code_lock(const codet &src, unsigned indent)
expr2ct::convert_code_label
std::string convert_code_label(const code_labelt &src, unsigned indent)
expr2ct::convert_unary
std::string convert_unary(const unary_exprt &, const std::string &symbol, unsigned precedence)
expr2ct::convert_symbol
virtual std::string convert_symbol(const exprt &src)
expr2ct::convert_extractbits
std::string convert_extractbits(const extractbits_exprt &src, unsigned precedence)
expr2ct::convert_struct
virtual std::string convert_struct(const exprt &src, unsigned &precedence)
expr2ct::convert_array
std::string convert_array(const exprt &src)
expr2ct::convert_code_goto
std::string convert_code_goto(const codet &src, unsigned indent)
expr2ct::convert_predicate_next_symbol
std::string convert_predicate_next_symbol(const exprt &src)
expr2ct::convert_index
std::string convert_index(const exprt &src, unsigned precedence)
expr2ct::convert_byte_update
std::string convert_byte_update(const byte_update_exprt &, unsigned precedence)
expr2ct::convert_code_assume
std::string convert_code_assume(const codet &src, unsigned indent)
expr2ct::convert_struct_type
std::string convert_struct_type(const typet &src, const std::string &qualifer_str, const std::string &declarator_str, bool inc_struct_body, bool inc_padding_components)
expr2ct::convert_initializer_list
std::string convert_initializer_list(const exprt &src)
expr2ct::convert_side_effect_expr_function_call
std::string convert_side_effect_expr_function_call(const side_effect_expr_function_callt &src)
expr2ct::configuration
const expr2c_configurationt & configuration
Definition: expr2c_class.h:50
std_code.h
optionalt
nonstd::optional< T > optionalt
Definition: optional.h:35
update_exprt
Operator to update elements in structs and arrays.
Definition: std_expr.h:2356
expr2ct::convert_code_continue
std::string convert_code_continue(unsigned indent)
expr2ct::convert_code_break
std::string convert_code_break(unsigned indent)
expr2ct::convert_code_array_copy
std::string convert_code_array_copy(const codet &src, unsigned indent)
expr2ct::convert_extractbit
std::string convert_extractbit(const extractbit_exprt &, unsigned precedence)
expr2ct::convert_constant
virtual std::string convert_constant(const constant_exprt &src, unsigned &precedence)
extractbit_exprt
Extracts a single bit of a bit-vector operand.
Definition: bitvector_expr.h:363
expr2ct::convert_norep
std::string convert_norep(const exprt &src, unsigned &precedence)
expr2ct::indent_str
static std::string indent_str(unsigned indent)
expr2ct::convert_literal
std::string convert_literal(const exprt &src)
member_exprt
Extract member of struct or union.
Definition: std_expr.h:2527
expr2ct::ns
const namespacet & ns
Definition: expr2c_class.h:49
expr2ct::convert_function_application
std::string convert_function_application(const function_application_exprt &src)
expr2ct::convert_with
std::string convert_with(const exprt &src, unsigned precedence)
expr2ct::convert_code_block
std::string convert_code_block(const code_blockt &src, unsigned indent)
expr2ct::convert_code_array_replace
std::string convert_code_array_replace(const codet &src, unsigned indent)
expr2ct::convert_code_unlock
std::string convert_code_unlock(const codet &src, unsigned indent)
expr2ct::convert_nondet
std::string convert_nondet(const exprt &src, unsigned &precedence)
expr2ct::convert_function
optionalt< std::string > convert_function(const exprt &src)
Returns a string if src is a function with a known conversion, else returns nullopt.
expr2ct::get_shorthands
void get_shorthands(const exprt &expr)
Definition: expr2c.cpp:118
expr2ct::convert_code_dowhile
std::string convert_code_dowhile(const code_dowhilet &src, unsigned indent)
expr2ct::convert_object_descriptor
std::string convert_object_descriptor(const exprt &src, unsigned &precedence)
byte_extract_exprt
Expression of type type extracted from some object op starting at position offset (given in number of...
Definition: byte_operators.h:29
expr2ct::convert_sizeof
std::string convert_sizeof(const exprt &src, unsigned &precedence)
expr2ct::id_shorthand
irep_idt id_shorthand(const irep_idt &identifier) const
Definition: expr2c.cpp:77
expr2ct::convert_code_dead
std::string convert_code_dead(const codet &src, unsigned indent)
expr2ct::convert_concatenation
std::string convert_concatenation(const exprt &src, unsigned &precedence)
extractbits_exprt
Extracts a sub-range of a bit-vector operand.
Definition: bitvector_expr.h:430
expr2ct::convert_struct_member_value
std::string convert_struct_member_value(const exprt &src, unsigned precedence)
expr2ct::convert_rec
virtual std::string convert_rec(const typet &src, const qualifierst &qualifiers, const std::string &declarator)
Definition: expr2c.cpp:192
expr2ct::convert_index_designator
std::string convert_index_designator(const exprt &src)
expr2c_configurationt
Used for configuring the behaviour of expr2c and type2c.
Definition: expr2c.h:21
typecast_exprt
Semantic type conversion.
Definition: std_expr.h:1780
expr2ct::convert_code_switch
std::string convert_code_switch(const codet &src, unsigned indent)
expr2ct::convert_member
std::string convert_member(const member_exprt &src, unsigned precedence)
code_assignt
A codet representing an assignment in the program.
Definition: std_code.h:295
constant_exprt
A constant literal expression.
Definition: std_expr.h:2667
std_expr.h
API to expression classes.
expr2ct::convert_multi_ary
std::string convert_multi_ary(const exprt &src, const std::string &symbol, unsigned precedence, bool full_parentheses)
expr2ct::convert_complex
std::string convert_complex(const exprt &src, unsigned precedence)
expr2ct::convert_code_output
std::string convert_code_output(const codet &src, unsigned indent)
expr2ct::convert_designated_initializer
std::string convert_designated_initializer(const exprt &src)
expr2ct::convert_vector
std::string convert_vector(const exprt &src, unsigned &precedence)
expr2ct::convert_binary
std::string convert_binary(const binary_exprt &, const std::string &symbol, unsigned precedence, bool full_parentheses)
let_exprt
A let expression.
Definition: std_expr.h:2804
bitvector_expr.h
API to expression classes for bitvectors.
expr2ct::convert_allocate
std::string convert_allocate(const exprt &src, unsigned &precedence)
expr2ct::convert_code_return
std::string convert_code_return(const codet &src, unsigned indent)
mathematical_expr.h
API to expression classes for 'mathematical' expressions.
codet
Data structure for representing an arbitrary statement in a program.
Definition: std_code.h:35