blob: 56c517a872fa58a9f2ebff1a1b94efcf548b91e2 (
plain)
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
|
/********************* */
/*! \file managed_ostreams.h
** \verbatim
** Top contributors (to current version):
** Tim King
** This file is part of the CVC4 project.
** Copyright (c) 2009-2016 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 Wrappers to handle memory management of ostreams.
**
** This file contains wrappers to handle special cases of managing memory
** related to ostreams.
**/
#include "cvc4_private.h"
#ifndef __CVC4__MANAGED_OSTREAMS_H
#define __CVC4__MANAGED_OSTREAMS_H
#include <ostream>
#include "options/open_ostream.h"
#include "smt/update_ostream.h"
namespace CVC4 {
/** This abstracts the management of ostream memory and initialization. */
class ManagedOstream {
public:
/** Initially getManagedOstream() == NULL. */
ManagedOstream();
virtual ~ManagedOstream();
/** Returns the pointer to the managed ostream. */
std::ostream* getManagedOstream() const { return d_managed; }
/** Returns the name of the ostream geing managed. */
virtual const char* getName() const = 0;
/**
* Set opens a file with filename, initializes the stream.
* If the opened ostream is marked as managed, this calls manage(stream).
* If the opened ostream is not marked as managed, this calls manage(NULL).
*/
void set(const std::string& filename);
/** If this is associated with an option, return the string value. */
virtual std::string defaultSource() const { return ""; }
protected:
/**
* Opens an ostream using OstreamOpener with the name getName() with the
* special cases added by addSpecialCases().
*/
std::pair<bool, std::ostream*> open(const std::string& filename) const;
/**
* Updates the value of managed pointer. Whenever this changes,
* beforeRelease() is called on the old value.
*/
void manage(std::ostream* new_managed_value);
/** Initializes an output stream. Not necessarily managed. */
virtual void initialize(std::ostream* outStream) {}
/** Adds special cases to an ostreamopener. */
virtual void addSpecialCases(OstreamOpener* opener) const {}
private:
std::ostream* d_managed;
}; /* class ManagedOstream */
class SetToDefaultSourceListener : public Listener {
public:
SetToDefaultSourceListener(ManagedOstream* managedOstream)
: d_managedOstream(managedOstream){}
virtual void notify() {
d_managedOstream->set(d_managedOstream->defaultSource());
}
private:
ManagedOstream* d_managedOstream;
};
/**
* This controls the memory associated with --dump-to.
* This is is assumed to recieve a set whenever diagnosticChannelName
* is updated.
*/
class ManagedDumpOStream : public ManagedOstream {
public:
ManagedDumpOStream(){}
~ManagedDumpOStream();
virtual const char* getName() const { return "dump-to"; }
virtual std::string defaultSource() const;
protected:
/** Initializes an output stream. Not necessarily managed. */
virtual void initialize(std::ostream* outStream);
/** Adds special cases to an ostreamopener. */
virtual void addSpecialCases(OstreamOpener* opener) const;
};/* class ManagedDumpOStream */
/**
* When d_managedRegularChannel is non-null, it owns the memory allocated
* with the regular-output-channel. This is set when
* options::regularChannelName is set.
*/
class ManagedRegularOutputChannel : public ManagedOstream {
public:
ManagedRegularOutputChannel(){}
/** Assumes Options are in scope. */
~ManagedRegularOutputChannel();
virtual const char* getName() const { return "regular-output-channel"; }
virtual std::string defaultSource() const;
protected:
/** Initializes an output stream. Not necessarily managed. */
virtual void initialize(std::ostream* outStream);
/** Adds special cases to an ostreamopener. */
virtual void addSpecialCases(OstreamOpener* opener) const;
};/* class ManagedRegularOutputChannel */
/**
* This controls the memory associated with diagnostic-output-channel.
* This is is assumed to recieve a set whenever options::diagnosticChannelName
* is updated.
*/
class ManagedDiagnosticOutputChannel : public ManagedOstream {
public:
ManagedDiagnosticOutputChannel(){}
/** Assumes Options are in scope. */
~ManagedDiagnosticOutputChannel();
virtual const char* getName() const { return "diagnostic-output-channel"; }
virtual std::string defaultSource() const;
protected:
/** Initializes an output stream. Not necessarily managed. */
virtual void initialize(std::ostream* outStream);
/** Adds special cases to an ostreamopener. */
virtual void addSpecialCases(OstreamOpener* opener) const;
};/* class ManagedRegularOutputChannel */
/** This controls the memory associated with replay-log. */
class ManagedReplayLogOstream : public ManagedOstream {
public:
ManagedReplayLogOstream();
~ManagedReplayLogOstream();
std::ostream* getReplayLog() const { return d_replayLog; }
virtual const char* getName() const { return "replay-log"; }
virtual std::string defaultSource() const;
protected:
/** Initializes an output stream. Not necessarily managed. */
virtual void initialize(std::ostream* outStream);
/** Adds special cases to an ostreamopener. */
virtual void addSpecialCases(OstreamOpener* opener) const;
private:
std::ostream* d_replayLog;
};/* class ManagedRegularOutputChannel */
}/* CVC4 namespace */
#endif /* __CVC4__MANAGED_OSTREAMS_H */
|
