1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
/********************* */
/*! \file cdo.h
** \verbatim
** Top contributors (to current version):
** Morgan Deters, Clark Barrett, Tim King
** This file is part of the CVC4 project.
** Copyright (c) 2009-2019 by the authors listed in the file AUTHORS
** in the top-level source directory) and their institutional affiliations.
** All rights reserved. See the file COPYING in the top-level source
** directory for licensing information.\endverbatim
**
** \brief A context-dependent object.
**
** A context-dependent object.
**/
#include "cvc4_private.h"
#ifndef __CVC4__CONTEXT__CDO_H
#define __CVC4__CONTEXT__CDO_H
#include "base/cvc4_assert.h"
#include "context/context.h"
namespace CVC4 {
namespace context {
/**
* Most basic template for context-dependent objects. Simply makes a copy
* (using the copy constructor) of class T when saving, and copies it back
* (using operator=) during restore.
*/
template <class T>
class CDO : public ContextObj {
/**
* The data of type T being stored in this context-dependent object.
*/
T d_data;
protected:
/**
* Copy constructor - it's private to ensure it is only used by save().
* Basic CDO objects, cannot be copied-they have to be unique.
*/
CDO(const CDO<T>& cdo) : ContextObj(cdo), d_data(cdo.d_data) {}
/**
* operator= for CDO is private to ensure CDO object is not copied.
*/
CDO<T>& operator=(const CDO<T>& cdo) = delete;
/**
* Implementation of mandatory ContextObj method save: simply copies the
* current data to a copy using the copy constructor. Memory is allocated
* using the ContextMemoryManager.
*/
ContextObj* save(ContextMemoryManager* pCMM) override
{
Debug("context") << "save cdo " << this;
ContextObj* p = new(pCMM) CDO<T>(*this);
Debug("context") << " to " << p << std::endl;
return p;
}
/**
* Implementation of mandatory ContextObj method restore: simply copies the
* saved data back from the saved copy using operator= for T.
*/
void restore(ContextObj* pContextObj) override
{
//Debug("context") << "restore cdo " << this;
CDO<T>* p = static_cast<CDO<T>*>(pContextObj);
d_data = p->d_data;
//Debug("context") << " to " << get() << std::endl;
// Explicitly call destructor as it will not otherwise get called.
p->d_data.~T();
}
public:
/**
* Main constructor - uses default constructor for T to create the initial
* value of d_data.
*/
CDO(Context* context) :
ContextObj(context),
d_data(T()) {
}
/**
* Main constructor - uses default constructor for T to create the
* initial value of d_data.
*
* This version takes an argument that specifies whether this CDO<>
* was itself allocated in context memory. If it was, it is linked
* with the current scope rather than scope 0.
*
* WARNING: Read the notes in src/context/context.h on "Gotchas when
* allocating contextual objects with non-standard allocators."
*/
CDO(bool allocatedInCMM, Context* context) :
ContextObj(allocatedInCMM, context),
d_data(T()) {
}
/**
* Constructor from object of type T. Creates a ContextObj and sets the data
* to the given data value. Note that this value is only valid in the
* current Scope. If the Scope is popped, the value will revert to whatever
* is assigned by the default constructor for T
*/
CDO(Context* context, const T& data) :
ContextObj(context),
d_data(T()) {
makeCurrent();
d_data = data;
}
/**
* Constructor from object of type T. Creates a ContextObj and sets the data
* to the given data value. Note that this value is only valid in the
* current Scope. If the Scope is popped, the value will revert to whatever
* is assigned by the default constructor for T.
*
* This version takes an argument that specifies whether this CDO<>
* was itself allocated in context memory. If it was, it is linked
* with the current scope rather than scope 0.
*
* WARNING: Read the notes in src/context/context.h on "Gotchas when
* allocating contextual objects with non-standard allocators."
*/
CDO(bool allocatedInCMM, Context* context, const T& data) :
ContextObj(allocatedInCMM, context),
d_data(T()) {
makeCurrent();
d_data = data;
}
/**
* Destructor - call destroy() method
*/
~CDO() { destroy(); }
/**
* Set the data in the CDO. First call makeCurrent.
*/
void set(const T& data) {
makeCurrent();
d_data = data;
}
/**
* Get the current data from the CDO. Read-only.
*/
const T& get() const { return d_data; }
/**
* For convenience, define operator T() to be the same as get().
*/
operator T() { return get(); }
/**
* For convenience, define operator const T() to be the same as get().
*/
operator const T() const { return get(); }
/**
* For convenience, define operator= that takes an object of type T.
*/
CDO<T>& operator=(const T& data) {
set(data);
return *this;
}
};/* class CDO */
}/* CVC4::context namespace */
}/* CVC4 namespace */
#endif /* __CVC4__CONTEXT__CDO_H */
|
