cprover
util/README.md
Go to the documentation of this file.
1 \ingroup module_hidden
2 \defgroup util util
3 
4 # Folder util
5 
6 \author Martin Brain, Owen Jones
7 
8 \section data_structures Data Structures
9 
10 This section discusses some of the key data-structures used in the
11 CPROVER codebase.
12 
13 \subsection irept_section Irept Data Structure
14 
15 See \ref irept for more information.
16 
17 \subsection irep_idt_section Irep_idt and Dstringt
18 
19 Inside \ref irept, strings are stored as irep_idts, or irep_namets for
20 keys to named_sub or comments. By default both irep_idt and irep_namet
21 are typedefed to \ref dstringt, unless USE_STD_STRING is set, in which
22 case they are typedefed to std::string (this can be used for debugging
23 purposes).
24 
25 \dot
26 digraph G {
27  node [shape=box];
28  rankdir="LR";
29  1 [shape=none, label=""];
30  2 [label="command line parsing"];
31  3 [shape=none, label=""];
32  1 -> 2 [label="C files or goto-binaries"];
33  2 -> 3 [label="Command line options, file names"];
34 }
35 \enddot