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
|
/*
* Copyright (c) 2003-2009, 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 data
*/
/**
* @file xact.h
* @author John Wiegley
*
* @ingroup data
*
* @brief Brief
*
* Long.
*/
#ifndef _XACT_H
#define _XACT_H
#include "item.h"
namespace ledger {
class entry_t;
class account_t;
class xact_t;
typedef std::list<xact_t *> xacts_list;
/**
* @brief Brief
*
* Long.
*/
class xact_t : public item_t
{
public:
#define XACT_VIRTUAL 0x10 // the account was specified with (parens)
#define XACT_MUST_BALANCE 0x20 // the account was specified with [brackets]
#define XACT_AUTO 0x40 // transaction created by automated entry
#define XACT_CALCULATED 0x80 // transaction's amount was auto-calculated
entry_t * entry; // only set for xacts of regular entries
account_t * account;
amount_t amount; // can be null until finalization
optional<amount_t> cost;
optional<amount_t> assigned_amount;
xact_t(account_t * _account = NULL,
flags_t _flags = ITEM_NORMAL)
: item_t(_flags),
entry(NULL), account(_account)
{
TRACE_CTOR(xact_t, "account_t *, flags_t");
}
xact_t(account_t * _account,
const amount_t& _amount,
flags_t _flags = ITEM_NORMAL,
const optional<string>& _note = none)
: item_t(_flags, _note),
entry(NULL), account(_account), amount(_amount)
{
TRACE_CTOR(xact_t, "account_t *, const amount_t&, flags_t, const optional<string>&");
}
xact_t(const xact_t& xact)
: item_t(xact),
entry(xact.entry),
account(xact.account),
amount(xact.amount),
cost(xact.cost),
assigned_amount(xact.assigned_amount),
xdata_(xact.xdata_)
{
TRACE_CTOR(xact_t, "copy");
}
~xact_t() {
TRACE_DTOR(xact_t);
}
virtual bool has_tag(const string& tag) const;
virtual bool has_tag(const mask_t& tag_mask,
const optional<mask_t>& value_mask = none) const;
virtual optional<string> get_tag(const string& tag) const;
virtual optional<string> get_tag(const mask_t& tag_mask,
const optional<mask_t>& value_mask = none) const;
virtual date_t date() const;
virtual optional<date_t> effective_date() const;
virtual state_t state() const;
bool must_balance() const {
return ! has_flags(XACT_VIRTUAL) || has_flags(XACT_MUST_BALANCE);
}
virtual expr_t::ptr_op_t lookup(const string& name);
bool valid() const;
struct xdata_t : public supports_flags<>
{
#define XACT_EXT_RECEIVED 0x01
#define XACT_EXT_HANDLED 0x02
#define XACT_EXT_TO_DISPLAY 0x04
#define XACT_EXT_DISPLAYED 0x08
#define XACT_EXT_NO_TOTAL 0x10
#define XACT_EXT_SORT_CALC 0x20
#define XACT_EXT_COMPOUND 0x40
#define XACT_EXT_MATCHES 0x80
value_t total;
std::size_t count;
value_t value;
date_t date;
account_t * account;
void * ptr;
std::list<sort_value_t> sort_values;
xdata_t()
: supports_flags<>(), count(0), account(NULL), ptr(NULL) {
TRACE_CTOR(xact_t::xdata_t, "");
}
xdata_t(const xdata_t& other)
: supports_flags<>(other.flags()),
total(other.total),
count(other.count),
value(other.value),
date(other.date),
account(other.account),
ptr(NULL),
sort_values(other.sort_values)
{
TRACE_CTOR(xact_t::xdata_t, "copy");
}
~xdata_t() throw() {
TRACE_DTOR(xact_t::xdata_t);
}
};
// This variable holds optional "extended data" which is usually produced
// only during reporting, and only for the transaction set being reported.
// It's a memory-saving measure to delay allocation until the last possible
// moment.
mutable optional<xdata_t> xdata_;
bool has_xdata() const {
return xdata_;
}
void clear_xdata() {
xdata_ = none;
}
xdata_t& xdata() {
if (! xdata_)
xdata_ = xdata_t();
return *xdata_;
}
void add_to_value(value_t& value, expr_t& expr);
account_t * reported_account() {
if (xdata_)
if (account_t * acct = xdata_->account)
return acct;
return account;
}
const account_t * reported_account() const {
return const_cast<xact_t *>(this)->reported_account();
}
friend class entry_t;
};
} // namespace ledger
#endif // _XACT_H
|
