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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
/*
* Copyright (c) 2003-2023, John Wiegley. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* - Neither the name of New Artisans LLC nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* @addtogroup expr
*/
/**
* @file exprbase.h
* @author John Wiegley
*
* @ingroup expr
*
* This class provides basic behavior for all the domain specific expression
* languages used in Leger:
*
* | Typename | Description | result_type | Derives |
* |-------------+----------------------------+-----------------+-------------|
* | expr_t | Value expressions | value_t | |
* | predicate_t | Special form of expr_t | bool | expr_t |
* | query_t | Report queries | bool | predicate_t |
* | period_t | Time periods and durations | date_interval_t | |
* | draft_t | Partially filled xacts | xact_t * | |
* | format_t | Format strings | string | |
*/
#pragma once
#include "utils.h"
#include "amount.h"
namespace ledger {
DECLARE_EXCEPTION(parse_error, std::runtime_error);
DECLARE_EXCEPTION(compile_error, std::runtime_error);
DECLARE_EXCEPTION(calc_error, std::runtime_error);
DECLARE_EXCEPTION(usage_error, std::runtime_error);
class scope_t;
class call_scope_t;
template <typename ResultType>
class expr_base_t
{
public:
typedef ResultType result_type;
typedef function<result_type (call_scope_t&)> func_t;
protected:
scope_t * context;
string str;
bool compiled;
virtual result_type real_calc(scope_t& scope) = 0;
public:
expr_base_t(const expr_base_t& other)
: context(other.context), str(other.str), compiled(false) {
TRACE_CTOR(expr_base_t, "copy");
}
expr_base_t(scope_t * _context = NULL)
: context(_context), compiled(false)
{
TRACE_CTOR(expr_base_t, "scope_t *");
}
virtual ~expr_base_t() {
TRACE_DTOR(expr_base_t);
}
expr_base_t& operator=(const expr_base_t& _expr) {
if (this != &_expr) {
str = _expr.str;
context = _expr.context;
compiled = _expr.compiled;
}
return *this;
}
expr_base_t& operator=(const string& _expr) {
parse(_expr);
return *this;
}
virtual operator bool() const throw() {
return ! str.empty();
}
virtual string text() const throw() {
return str;
}
void set_text(const string& txt) {
str = txt;
compiled = false;
}
void parse(const string& expr_str,
const parse_flags_t& flags = PARSE_DEFAULT) {
std::istringstream stream(expr_str);
return parse(stream, flags, expr_str);
}
virtual void parse(std::istream&,
const parse_flags_t& = PARSE_DEFAULT,
const optional<string>& original_string = none) {
set_text(original_string ? *original_string : "<stream>");
}
virtual void mark_uncompiled() {
compiled = false;
}
void recompile(scope_t& scope) {
compiled = false;
compile(scope);
}
virtual void compile(scope_t& scope) {
if (! compiled) {
// Derived classes need to do something here.
context = &scope;
compiled = true;
}
}
result_type operator()(scope_t& scope) {
return calc(scope);
}
result_type calc(scope_t& scope)
{
if (! compiled) {
#if DEBUG_ON
if (SHOW_DEBUG("expr.compile")) {
DEBUG("expr.compile", "Before compilation:");
dump(*_log_stream);
}
#endif // DEBUG_ON
DEBUG("expr.compile", "Compiling: " << str);
compile(scope);
#if DEBUG_ON
if (SHOW_DEBUG("expr.compile")) {
DEBUG("expr.compile", "After compilation:");
dump(*_log_stream);
}
#endif // DEBUG_ON
}
DEBUG("expr.calc", "Calculating: " << str);
return real_calc(scope);
}
result_type calc() {
assert(context);
return calc(*context);
}
scope_t * get_context() {
return context;
}
void set_context(scope_t * scope) {
context = scope;
}
virtual string context_to_str() const {
return empty_string;
}
string print_to_str() const {
std::ostringstream out;
print(out);
return out.str();
}
string dump_to_str() const {
std::ostringstream out;
dump(out);
return out.str();
}
string preview_to_str(scope_t&) const {
std::ostringstream out;
preview(out);
return out.str();
}
virtual void print(std::ostream&) const {}
virtual void dump(std::ostream&) const {}
result_type preview(std::ostream& out, scope_t& scope) const {
out << _("--- Input expression ---") << std::endl;
out << text() << std::endl;
out << std::endl << _("--- Text as parsed ---") << std::endl;
print(out);
out << std::endl;
out << std::endl << _("--- Expression tree ---") << std::endl;
dump(out);
out << std::endl << _("--- Compiled tree ---") << std::endl;
compile(scope);
dump(out);
out << std::endl << _("--- Result value ---") << std::endl;
return calc();
}
};
template <typename ResultType>
std::ostream& operator<<(std::ostream& out,
const expr_base_t<ResultType>& expr) {
expr.print(out);
return out;
}
} // namespace ledger
|