summaryrefslogtreecommitdiff
path: root/ledger.h
blob: 8cf41be3c4722009c1a9a8a1b39aa6d13ae5e2fd (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
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
#ifndef _LEDGER_H
#define _LEDGER_H

//////////////////////////////////////////////////////////////////////
//
// Ledger Accounting Tool
//
//   A command-line tool for general double-entry accounting.
//
// Copyright (c) 2003,2004 John Wiegley <johnw@newartisans.com>
//

#include <map>
#include <list>
#include <string>
#include <ctime>
#include <iostream>

#include "amount.h"
#include "balance.h"

#ifdef RELEASE_LEVEL
#if RELEASE_LEVEL >= 2
#include "debug.h"
#endif
#endif

namespace ledger {

#define TRANSACTION_NORMAL    0x00
#define TRANSACTION_VIRTUAL   0x01
#define TRANSACTION_BALANCE   0x02
#define TRANSACTION_AUTO      0x04

#define TRANSACTION_HANDLED   0x10
#define TRANSACTION_DISPLAYED 0x20
#define TRANSACTION_NO_TOTAL  0x40

class entry_t;
class account_t;

class transaction_t
{
 public:
  entry_t *	 entry;
  account_t *	 account;
  amount_t	 amount;
  amount_t	 cost;
  unsigned int	 flags;
  std::string	 note;

  mutable balance_pair_t total;
  mutable unsigned int   index;
  mutable unsigned int	 dflags;

  transaction_t(entry_t * _entry, account_t * _account)
    : entry(_entry), account(_account), flags(TRANSACTION_NORMAL),
      index(0), dflags(0) {}

  transaction_t(entry_t *	   _entry,
		account_t *	   _account,
		const amount_t&    _amount,
		const amount_t&    _cost,
		unsigned int	   _flags = TRANSACTION_NORMAL,
		const std::string& _note  = "")
    : entry(_entry), account(_account), amount(_amount),
      cost(_cost), flags(_flags), note(_note), index(0), dflags(0) {}
};


typedef std::list<transaction_t *> transactions_list;

class entry_t
{
 public:
  enum entry_state_t {
    UNCLEARED, CLEARED, PENDING
  };

  std::time_t	    date;
  entry_state_t     state;
  std::string	    code;
  std::string	    payee;
  transactions_list transactions;

  entry_t() : date(-1), state(UNCLEARED) {}

  ~entry_t() {
    for (transactions_list::iterator i = transactions.begin();
	 i != transactions.end();
	 i++)
      delete *i;
  }

  void add_transaction(transaction_t * xact) {
    transactions.push_back(xact);
  }
  bool remove_transaction(transaction_t * xact) {
    transactions.remove(xact);
    return true;
  }
};


#define ACCOUNT_DISPLAYED 0x1

typedef std::map<const std::string, account_t *> accounts_map;
typedef std::pair<const std::string, account_t *> accounts_pair;

class account_t
{
 public:
  typedef unsigned short ident_t;

  account_t *	    parent;
  std::string	    name;
  std::string	    note;
  unsigned char     depth;
  accounts_map	    accounts;
  transactions_list transactions;

  mutable balance_pair_t value;
  mutable balance_pair_t total;
  mutable ident_t        ident;
  mutable unsigned short dflags;
  mutable std::string	 _fullname;

  static ident_t    next_ident;

  account_t(account_t *        _parent,
	    const std::string& _name = "",
	    const std::string& _note = "")
    : parent(_parent), name(_name), note(_note),
      depth(parent ? parent->depth + 1 : 0), dflags(0) {}

  ~account_t();

  std::string fullname() const;

  void add_account(account_t * acct) {
    acct->ident = next_ident++;
    accounts.insert(accounts_pair(acct->name, acct));
  }
  bool remove_account(account_t * acct) {
    accounts_map::size_type n = accounts.erase(acct->name);
    return n > 0;
  }

  account_t * find_account(const std::string& name, bool auto_create = true);

  operator std::string() const {
    return fullname();
  }

  // These functions should only be called from journal_t::add_entry
  // and journal_t::remove_entry; or from the various parsers.
  void add_transaction(transaction_t * xact) {
    transactions.push_back(xact);
  }
  bool remove_transaction(transaction_t * xact);

  friend class journal_t;
};

inline std::ostream& operator<<(std::ostream& out, const account_t& acct) {
  out << acct.fullname();
  return out;
}


typedef std::list<entry_t *>   entries_list;
typedef std::list<std::string> strings_list;

class journal_t
{
 public:
  account_t *		 master;
  entries_list		 entries;
  mutable accounts_map	 accounts_cache;
  std::list<std::string> sources;

  journal_t() {
    master = new account_t(NULL, "");
    master->ident = 0;
    account_t::next_ident = 1;
  }

  ~journal_t();

  void add_account(account_t * acct) {
    master->add_account(acct);
  }
  bool remove_account(account_t * acct) {
    return master->remove_account(acct);
  }

  account_t * find_account(const std::string& name, bool auto_create = true) {
    accounts_map::iterator c = accounts_cache.find(name);
    if (c != accounts_cache.end())
      return (*c).second;

    account_t * account = master->find_account(name, auto_create);
    accounts_cache.insert(accounts_pair(name, account));
    return account;
  }
  account_t * find_account(const std::string& name) const {
    // With auto_create false, the other `find_account' will not
    // change the object.
    return const_cast<journal_t *>(this)->find_account(name, false);
  }

  bool add_entry(entry_t * entry);
  bool remove_entry(entry_t * entry);

  entry_t * derive_entry(strings_list::iterator begin,
			 strings_list::iterator end) const;
};

int parse_journal_file(const std::string& path, journal_t * journal);

unsigned int parse_textual_journal(std::istream& in,
				   journal_t *	 ledger,
				   account_t *	 master = NULL);

extern unsigned long binary_magic_number;

unsigned int read_binary_journal(std::istream&	in,
				 journal_t *	journal,
				 account_t *	master = NULL);

void write_binary_journal(std::ostream&	 out,
			  journal_t *	 journal,
			  strings_list * files = NULL);

extern const std::string version;

} // namespace ledger

#endif // _LEDGER_H