summaryrefslogtreecommitdiff
path: root/journal.h
diff options
context:
space:
mode:
Diffstat (limited to 'journal.h')
-rw-r--r--journal.h256
1 files changed, 139 insertions, 117 deletions
diff --git a/journal.h b/journal.h
index c04a4ea9..86ae58fd 100644
--- a/journal.h
+++ b/journal.h
@@ -1,3 +1,34 @@
+/*
+ * Copyright (c) 2003-2007, 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 _JOURNAL_H
#define _JOURNAL_H
@@ -19,52 +50,64 @@ namespace ledger {
class entry_t;
class account_t;
-class transaction_t
+class transaction_t : public supports_flags<>
{
public:
enum state_t { UNCLEARED, CLEARED, PENDING };
- entry_t * entry;
- datetime_t _date;
- datetime_t _date_eff;
- account_t * account;
- amount_t amount;
- value_expr amount_expr;
- amount_t * cost;
- string cost_expr;
- state_t state;
- unsigned short flags;
- 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;
-
- transaction_t(account_t * _account = NULL)
- : entry(NULL), account(_account), cost(NULL),
- state(UNCLEARED), flags(TRANSACTION_NORMAL),
- beg_pos(0), beg_line(0), end_pos(0), end_line(0), data(NULL) {
- DEBUG("ledger.memory.ctors", "ctor transaction_t");
- }
- transaction_t(account_t * _account,
- const amount_t& _amount,
- unsigned int _flags = TRANSACTION_NORMAL,
- const string& _note = "")
- : entry(NULL), account(_account), amount(_amount), cost(NULL),
- state(UNCLEARED), flags(_flags),
- note(_note), beg_pos(0), beg_line(0), end_pos(0), end_line(0),
- data(NULL) {
- DEBUG("ledger.memory.ctors", "ctor transaction_t");
- }
- transaction_t(const transaction_t& xact)
- : entry(xact.entry), account(xact.account), amount(xact.amount),
- cost(xact.cost ? new amount_t(*xact.cost) : NULL),
- state(xact.state), flags(xact.flags), note(xact.note),
- beg_pos(0), beg_line(0), end_pos(0), end_line(0), data(NULL) {
- DEBUG("ledger.memory.ctors", "ctor transaction_t");
+ entry_t * entry;
+ state_t state;
+ account_t * account;
+ optional<datetime_t> _date;
+ optional<datetime_t> _date_eff;
+ amount_t amount;
+ value_expr amount_expr;
+ optional<amount_t> cost;
+ optional<value_expr> 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;
+
+ explicit transaction_t(account_t * _account = NULL)
+ : supports_flags<>(TRANSACTION_NORMAL), entry(NULL),
+ state(UNCLEARED), account(_account),
+ beg_pos(0), beg_line(0), end_pos(0), end_line(0), data(NULL)
+ {
+ TRACE_CTOR(transaction_t, "account_t *");
+ }
+ explicit transaction_t(account_t * _account,
+ const amount_t& _amount,
+ unsigned int _flags = TRANSACTION_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(transaction_t,
+ "account_t *, const amount_t&, unsigned int, const string&");
+ }
+ explicit transaction_t(const transaction_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(transaction_t, "copy");
}
~transaction_t();
@@ -77,13 +120,6 @@ class transaction_t
return actual_date();
}
- bool operator==(const transaction_t& xact) {
- return this == &xact;
- }
- bool operator!=(const transaction_t& xact) {
- return ! (*this == xact);
- }
-
bool valid() const;
};
@@ -115,24 +151,24 @@ class entry_base_t
entry_base_t() : journal(NULL),
beg_pos(0), beg_line(0), end_pos(0), end_line(0)
{
- DEBUG("ledger.memory.ctors", "ctor entry_base_t");
+ TRACE_CTOR(entry_base_t, "");
}
entry_base_t(const entry_base_t& e) : journal(NULL),
beg_pos(0), beg_line(0), end_pos(0), end_line(0)
{
- DEBUG("ledger.memory.ctors", "ctor entry_base_t");
+ TRACE_CTOR(entry_base_t, "copy");
for (transactions_list::const_iterator i = e.transactions.begin();
i != e.transactions.end();
i++)
transactions.push_back(new transaction_t(**i));
}
virtual ~entry_base_t() {
- DEBUG("ledger.memory.dtors", "dtor entry_base_t");
+ TRACE_DTOR(entry_base_t);
for (transactions_list::iterator i = transactions.begin();
i != transactions.end();
i++)
- if (! ((*i)->flags & TRANSACTION_BULK_ALLOC))
- delete *i;
+ if (! (*i)->has_flags(TRANSACTION_BULK_ALLOC))
+ checked_delete(*i);
else
(*i)->~transaction_t();
}
@@ -153,28 +189,28 @@ class entry_base_t
class entry_t : public entry_base_t
{
- public:
- datetime_t _date;
- datetime_t _date_eff;
- string code;
- string payee;
+public:
+ datetime_t _date;
+ optional<datetime_t> _date_eff;
+ optional<string> code;
+ string payee;
entry_t() {
- DEBUG("ledger.memory.ctors", "ctor entry_t");
+ TRACE_CTOR(entry_t, "");
}
entry_t(const entry_t& e);
virtual ~entry_t() {
- DEBUG("ledger.memory.dtors", "dtor entry_t");
+ TRACE_DTOR(entry_t);
}
datetime_t actual_date() const {
return _date;
}
datetime_t effective_date() const {
- if (! is_valid(_date_eff))
+ if (! _date_eff)
return _date;
- return _date_eff;
+ return *_date_eff;
}
datetime_t date() const {
if (transaction_t::use_effective_date)
@@ -200,8 +236,8 @@ class entry_context : public error_context {
const entry_base_t& entry;
entry_context(const entry_base_t& _entry,
- const string& desc = "") throw()
- : error_context(desc), entry(_entry) {}
+ const string& _desc = "") throw()
+ : error_context(_desc), entry(_entry) {}
virtual ~entry_context() throw() {}
virtual void describe(std::ostream& out) const throw();
@@ -214,15 +250,18 @@ class item_predicate;
class auto_entry_t : public entry_base_t
{
public:
- item_predicate<transaction_t> * predicate;
- string predicate_string;
+ item_predicate<transaction_t> predicate;
- auto_entry_t() : predicate(NULL) {
- DEBUG("ledger.memory.ctors", "ctor auto_entry_t");
+ auto_entry_t();
+ auto_entry_t(const string& _predicate)
+ : predicate(_predicate)
+ {
+ TRACE_CTOR(auto_entry_t, "const string&");
}
- auto_entry_t(const string& _predicate);
- virtual ~auto_entry_t();
+ virtual ~auto_entry_t() {
+ TRACE_DTOR(auto_entry_t);
+ }
virtual void extend_entry(entry_base_t& entry, bool post);
virtual bool valid() const {
@@ -230,7 +269,6 @@ public:
}
};
-class journal_t;
struct auto_entry_finalizer_t : public entry_finalizer_t {
journal_t * journal;
auto_entry_finalizer_t(journal_t * _journal) : journal(_journal) {}
@@ -245,19 +283,19 @@ class period_entry_t : public entry_base_t
string period_string;
period_entry_t() {
- DEBUG("ledger.memory.ctors", "ctor period_entry_t");
+ TRACE_CTOR(period_entry_t, "");
}
period_entry_t(const string& _period)
: period(_period), period_string(_period) {
- DEBUG("ledger.memory.ctors", "ctor period_entry_t");
+ TRACE_CTOR(period_entry_t, "const string&");
}
period_entry_t(const period_entry_t& e)
: entry_base_t(e), period(e.period), period_string(e.period_string) {
- DEBUG("ledger.memory.ctors", "ctor period_entry_t");
+ TRACE_CTOR(period_entry_t, "copy");
}
virtual ~period_entry_t() {
- DEBUG("ledger.memory.dtors", "dtor period_entry_t");
+ TRACE_DTOR(period_entry_t);
}
virtual bool valid() const {
@@ -267,44 +305,39 @@ class period_entry_t : public entry_base_t
typedef std::map<const string, account_t *> accounts_map;
-typedef std::pair<const string, account_t *> accounts_pair;
class account_t
{
public:
typedef unsigned long ident_t;
- journal_t * journal;
- account_t * parent;
- string name;
- string note;
- unsigned short depth;
- accounts_map accounts;
+ journal_t * journal;
+ account_t * parent;
+ string name;
+ optional<string> note;
+ unsigned short depth;
+ accounts_map accounts;
mutable void * data;
mutable ident_t ident;
- mutable string _fullname;
+ mutable string _fullname;
account_t(account_t * _parent = NULL,
const string& _name = "",
- const string& _note = "")
+ const optional<string> _note = none)
: parent(_parent), name(_name), note(_note),
depth(parent ? parent->depth + 1 : 0), data(NULL), ident(0) {
- DEBUG("ledger.memory.ctors", "ctor account_t " << this);
+ TRACE_CTOR(account_t, "account_t *, const string&, const string&");
}
~account_t();
- bool operator==(const account_t& account) {
- return this == &account;
- }
- bool operator!=(const account_t& account) {
- return ! (*this == account);
+ operator string() const {
+ return fullname();
}
-
string fullname() const;
void add_account(account_t * acct) {
- accounts.insert(accounts_pair(acct->name, acct));
+ accounts.insert(accounts_map::value_type(acct->name, acct));
acct->journal = journal;
}
bool remove_account(account_t * acct) {
@@ -315,10 +348,6 @@ class account_t
account_t * find_account(const string& name, bool auto_create = true);
- operator string() const {
- return fullname();
- }
-
bool valid() const;
friend class journal_t;
@@ -331,7 +360,8 @@ struct func_finalizer_t : public entry_finalizer_t {
typedef bool (*func_t)(entry_t& entry, bool post);
func_t func;
func_finalizer_t(func_t _func) : func(_func) {}
- func_finalizer_t(const func_finalizer_t& other) : func(other.func) {}
+ func_finalizer_t(const func_finalizer_t& other) :
+ entry_finalizer_t(), func(other.func) {}
virtual bool operator()(entry_t& entry, bool post) {
return func(entry, post);
}
@@ -364,19 +394,19 @@ bool run_hooks(std::list<T>& list, Data& item, bool post) {
typedef std::list<entry_t *> entries_list;
typedef std::list<auto_entry_t *> auto_entries_list;
typedef std::list<period_entry_t *> period_entries_list;
+typedef std::list<path> paths_list;
typedef std::list<string> strings_list;
-typedef std::list<path> paths_list;
class journal_t
{
public:
- account_t * master;
- account_t * basket;
- entries_list entries;
- paths_list sources;
- path price_db;
- char * item_pool;
- char * item_pool_end;
+ account_t * master;
+ account_t * basket;
+ entries_list entries;
+ paths_list sources;
+ optional<path> price_db;
+ char * item_pool;
+ char * item_pool_end;
auto_entries_list auto_entries;
period_entries_list period_entries;
@@ -384,21 +414,13 @@ class journal_t
std::list<entry_finalizer_t *> entry_finalize_hooks;
- journal_t() : basket(NULL) {
- DEBUG("ledger.memory.ctors", "ctor journal_t");
+ journal_t() : basket(NULL), item_pool(NULL), item_pool_end(NULL) {
+ TRACE_CTOR(journal_t, "");
master = new account_t(NULL, "");
master->journal = this;
- item_pool = item_pool_end = NULL;
}
~journal_t();
- bool operator==(const journal_t& journal) {
- return this == &journal;
- }
- bool operator!=(const journal_t& journal) {
- return ! (*this == journal);
- }
-
void add_account(account_t * acct) {
master->add_account(acct);
acct->journal = this;
@@ -414,7 +436,7 @@ class journal_t
return (*c).second;
account_t * account = master->find_account(name, auto_create);
- accounts_cache.insert(accounts_pair(name, account));
+ accounts_cache.insert(accounts_map::value_type(name, account));
account->journal = this;
return account;
}