diff options
Diffstat (limited to 'xact.h')
| -rw-r--r-- | xact.h | 143 |
1 files changed, 143 insertions, 0 deletions
@@ -0,0 +1,143 @@ +/* + * Copyright (c) 2003-2008, 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. + */ + +#ifndef _XACT_H +#define _XACT_H + +#include "utils.h" +#include "scope.h" + +namespace ledger { + +// These flags persist with the object +#define XACT_NORMAL 0x0000 +#define XACT_VIRTUAL 0x0001 +#define XACT_BALANCE 0x0002 +#define XACT_AUTO 0x0004 +#define XACT_BULK_ALLOC 0x0008 +#define XACT_CALCULATED 0x0010 +#define XACT_GENERATED 0x0020 + +class entry_t; +class account_t; + +class xact_t : public supports_flags<>, public scope_t +{ + public: + enum state_t { UNCLEARED, CLEARED, PENDING }; + + entry_t * entry; + state_t state; + account_t * account; + optional<datetime_t> _date; + optional<datetime_t> _date_eff; + amount_t amount; + optional<expr_t> amount_expr; + optional<amount_t> cost; + optional<expr_t> cost_expr; + optional<string> note; + istream_pos_type beg_pos; + unsigned long beg_line; + istream_pos_type end_pos; + unsigned long end_line; + + mutable void * data; + static bool use_effective_date; + + xact_t(account_t * _account = NULL, + flags_t _flags = XACT_NORMAL) + : supports_flags<>(_flags), entry(NULL), + state(UNCLEARED), account(_account), + beg_pos(0), beg_line(0), end_pos(0), end_line(0), data(NULL) + { + TRACE_CTOR(xact_t, "account_t *, flags_t"); + } + xact_t(account_t * _account, + const amount_t& _amount, + flags_t _flags = XACT_NORMAL, + const optional<string>& _note = none) + : supports_flags<>(_flags), entry(NULL), state(UNCLEARED), + account(_account), amount(_amount), note(_note), + beg_pos(0), beg_line(0), end_pos(0), end_line(0), data(NULL) + { + TRACE_CTOR(xact_t, + "account_t *, const amount_t&, flags_t, const string&"); + } + xact_t(const xact_t& xact) + : supports_flags<>(xact), + entry(xact.entry), + state(xact.state), + account(xact.account), + _date(xact._date), + _date_eff(xact._date_eff), + amount(xact.amount), + cost(xact.cost), + note(xact.note), + beg_pos(xact.beg_pos), + beg_line(xact.beg_line), + end_pos(xact.end_pos), + end_line(xact.end_line), + data(xact.data) // jww (2008-07-19): What are the copy semantics? + { + TRACE_CTOR(xact_t, "copy"); + } + ~xact_t(); + + datetime_t actual_date() const; + datetime_t effective_date() const; + datetime_t date() const { + if (use_effective_date) + return effective_date(); + else + return actual_date(); + } + + bool must_balance() const { + return ! has_flags(XACT_VIRTUAL) || has_flags(XACT_BALANCE); + } + + virtual expr_t::ptr_op_t lookup(const string& name); + + bool valid() const; +}; + +class xact_context : public file_context { + public: + const xact_t& xact; + + xact_context(const xact_t& _xact, + const string& desc = "") throw(); + virtual ~xact_context() throw() {} +}; + +} // namespace ledger + +#endif // _XACT_H |