path: root/ledger.h

#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>

#ifdef RELEASE_LEVEL
#if RELEASE_LEVEL >= 2
#include "debug.h"
#elif RELEASE_LEVEL == 0
#define NO_CLEANUP 1
#endif
#endif

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

namespace ledger {

// These flags persist with the object
#define TRANSACTION_NORMAL    0x0000
#define TRANSACTION_VIRTUAL   0x0001
#define TRANSACTION_BALANCE   0x0002
#define TRANSACTION_AUTO      0x0004

// These flags are only used during formatting, and are not saved
#define TRANSACTION_HANDLED   0x0001
#define TRANSACTION_DISPLAYED 0x0002
#define TRANSACTION_NO_TOTAL  0x0004

class entry_t;
class account_t;

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

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

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

  transaction_t(account_t *	   _account,
		const amount_t&    _amount,
		const amount_t&    _cost,
		unsigned int	   _flags = TRANSACTION_NORMAL,
		const std::string& _note  = "")
    : entry(NULL), 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) {
    xact->entry = this;
    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 long ident_t;

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

  mutable balance_pair_t value;
  mutable balance_pair_t total;
  mutable unsigned int   count;	// transactions counted toward 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),
      count(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;
  strings_list sources;

  mutable accounts_map accounts_cache;

  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,
		       account_t *	   master	 = NULL,
		       const std::string * original_file = NULL);

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

extern const unsigned long binary_magic_number;

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

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

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

extern const std::string version;

} // namespace ledger

#endif // _LEDGER_H