ledger/main.cc

#include "ledger.h"
#include "parser.h"
#include "textual.h"
#include "binary.h"
#include "qif.h"
#include "acconf.h"
#ifdef READ_GNUCASH
#include "gnucash.h"
#endif
#include "valexpr.h"
#include "format.h"
#include "walk.h"
#include "quotes.h"
#include "option.h"
#include "config.h"
#include "debug.h"
#include "timing.h"
#include "error.h"

using namespace ledger;

#include <iostream>
#include <fstream>
#include <sstream>
#include <memory>
#include <algorithm>
#include <iterator>
#include <string>
#include <cstdlib>
#include <cstring>
#include <ctime>

namespace {
  TIMER_DEF(write_cache,    "writing cache file");
  TIMER_DEF(report_gen,	    "generation of final report");
  TIMER_DEF(parse_files,    "parsing ledger files");
  TIMER_DEF(process_opts,   "processing args and environment");
  TIMER_DEF(read_cache,	    "reading cache file");
}

#if !defined(DEBUG_LEVEL) || DEBUG_LEVEL <= RELEASE

#define auto_ptr bogus_auto_ptr

// This version of auto_ptr does not delete on deconstruction.
namespace std {
  template <typename T>
  struct bogus_auto_ptr {
    T * ptr;
    bogus_auto_ptr() : ptr(NULL) {}
    explicit bogus_auto_ptr(T * _ptr) : ptr(_ptr) {}
    T& operator*() const throw() {
      return *ptr;
    }
    T * operator->() const throw() {
      return ptr;
    }
    T * get() const throw() { return ptr; }
    T * release() throw() {
      T * tmp = ptr;
      ptr = 0;
      return tmp;
    }
    void reset(T * p = 0) throw() {
      if (p != ptr) {
	delete ptr;
	ptr = p;
      }
    }
  };
}

#endif

void parse_ledger_data(journal_t * journal,
		       parser_t *  text_parser,
		       parser_t *  cache_parser)
{
  TIMER_START(parse_files);

  int entry_count = 0;

  if (! config.init_file.empty()) {
    if (parse_journal_file(config.init_file, journal))
      throw error("Entries not allowed in initialization file");
    journal->sources.pop_front(); // remove init file
  }

  if (config.use_cache && ! config.cache_file.empty() &&
      ! config.data_file.empty()) {
    config.cache_dirty = true;
    if (access(config.cache_file.c_str(), R_OK) != -1) {
      std::ifstream stream(config.cache_file.c_str());
      if (cache_parser->test(stream)) {
	entry_count += cache_parser->parse(stream, journal, NULL,
					   &config.data_file);
	if (entry_count > 0)
	  config.cache_dirty = false;
      }
    }
  }

  if (entry_count == 0 && ! config.data_file.empty()) {
    account_t * account = NULL;
    if (! config.account.empty())
      account = journal->find_account(config.account);

    if (config.data_file == "-") {
      config.use_cache = false;
      entry_count += parse_journal(std::cin, journal, account);
    } else {
      entry_count += parse_journal_file(config.data_file, journal, account);
    }

    if (! config.price_db.empty())
      if (parse_journal_file(config.price_db, journal))
	throw error("Entries not allowed in price history file");
  }

  for (strings_list::iterator i = config.price_settings.begin();
       i != config.price_settings.end();
       i++) {
    std::string conversion = "C ";
    conversion += *i;
    int i = conversion.find('=');
    if (i != -1) {
      conversion[i] = ' ';
      std::istringstream stream(conversion);
      text_parser->parse(stream, journal, journal->master);
    }
  }

  if (entry_count == 0)
    throw error("Please specify ledger file using -f,"
		" or LEDGER_FILE environment variable.");

  VALIDATE(journal->valid());

  TIMER_STOP(parse_files);
}

item_handler<transaction_t> *
chain_formatters(const std::string& command,
		 item_handler<transaction_t> * base_formatter,
		 std::list<item_handler<transaction_t> *>& ptrs)
{
  item_handler<transaction_t> * formatter = NULL;

  // format_transactions write each transaction received to the
  // output stream.
  if (command == "b" || command == "E") {
    ptrs.push_back(formatter = base_formatter);
  } else {
    ptrs.push_back(formatter = base_formatter);

    // filter_transactions will only pass through transactions
    // matching the `display_predicate'.
    if (! config.display_predicate.empty())
      ptrs.push_back(formatter =
		     new filter_transactions(formatter,
					     config.display_predicate));

    // calc_transactions computes the running total.  When this
    // appears will determine, for example, whether filtered
    // transactions are included or excluded from the running total.
    ptrs.push_back(formatter =
		   new calc_transactions(formatter, config.show_inverted));

    // sort_transactions will sort all the transactions it sees, based
    // on the `sort_order' value expression.
    if (config.sort_order)
      ptrs.push_back(formatter =
		     new sort_transactions(formatter, config.sort_order));

    // changed_value_transactions adds virtual transactions to the
    // list to account for changes in market value of commodities,
    // which otherwise would affect the running total unpredictably.
    if (config.show_revalued)
      ptrs.push_back(formatter =
		     new changed_value_transactions(formatter,
						    config.show_revalued_only));

    // collapse_transactions causes entries with multiple transactions
    // to appear as entries with a subtotaled transaction for each
    // commodity used.
    if (config.show_collapsed)
      ptrs.push_back(formatter = new collapse_transactions(formatter));

    // subtotal_transactions combines all the transactions it receives
    // into one subtotal entry, which has one transaction for each
    // commodity in each account.
    //
    // interval_transactions is like subtotal_transactions, but it
    // subtotals according to time intervals rather than totalling
    // everything.
    //
    // dow_transactions is like interval_transactions, except that it
    // reports all the transactions that fall on each subsequent day
    // of the week.
    if (config.show_subtotal)
      ptrs.push_back(formatter = new subtotal_transactions(formatter));
    else if (config.report_interval)
      ptrs.push_back(formatter =
		     new interval_transactions(formatter,
					       config.report_interval));
    else if (config.days_of_the_week)
      ptrs.push_back(formatter = new dow_transactions(formatter));
  }

  // related_transactions will pass along all transactions related
  // to the transaction received.  If `show_all_related' is true,
  // then all the entry's transactions are passed; meaning that if
  // one transaction of an entry is to be printed, all the
  // transaction for that entry will be printed.
  if (config.show_related)
    ptrs.push_back(formatter =
		   new related_transactions(formatter,
					    config.show_all_related));

  // This filter_transactions will only pass through transactions
  // matching the `predicate'.
  if (! config.predicate.empty())
    ptrs.push_back(formatter = new filter_transactions(formatter,
						       config.predicate));

  return formatter;
}

int parse_and_report(int argc, char * argv[], char * envp[])
{
  std::auto_ptr<journal_t> journal(new journal_t);

  // Parse command-line arguments, and those set in the environment

  TIMER_START(process_opts);

  std::list<std::string> args;
  process_arguments(config_options, argc - 1, argv + 1, false, args);

  if (args.empty()) {
    option_help(std::cerr);
    return 1;
  }
  strings_list::iterator arg = args.begin();

  config.use_cache = config.data_file.empty();

  process_environment(config_options, envp, "LEDGER_");

#if 1
  // These are here for backwards compatability, but are deprecated.

  if (const char * p = std::getenv("LEDGER"))
    process_option(config_options, "file", p);
  if (const char * p = std::getenv("PRICE_HIST"))
    process_option(config_options, "price-db", p);
  if (const char * p = std::getenv("PRICE_EXP"))
    process_option(config_options, "price-exp", p);
#endif

  TIMER_STOP(process_opts);

  // Parse initialization files, ledger data, price database, etc.

  std::auto_ptr<binary_parser_t>  bin_parser(new binary_parser_t);
#ifdef READ_GNUCASH
  std::auto_ptr<gnucash_parser_t> gnucash_parser(new gnucash_parser_t);
#endif
  std::auto_ptr<qif_parser_t>     qif_parser(new qif_parser_t);
  std::auto_ptr<textual_parser_t> text_parser(new textual_parser_t);

  register_parser(bin_parser.get());
#ifdef READ_GNUCASH
  register_parser(gnucash_parser.get());
#endif
  register_parser(qif_parser.get());
  register_parser(text_parser.get());

  parse_ledger_data(journal.get(), text_parser.get(), bin_parser.get());

  // Read the command word, canonicalize it to its one letter form,
  // then configure the system based on the kind of report to be
  // generated

  std::string command = *arg++;

  if (command == "balance" || command == "bal" || command == "b")
    command = "b";
  else if (command == "register" || command == "reg" || command == "r")
    command = "r";
  else if (command == "print" || command == "p")
    command = "p";
  else if (command == "entry")
    command = "e";
  else if (command == "equity")
    command = "E";
  else
    throw error(std::string("Unrecognized command '") + command + "'");

  config.process_options(command, arg, args.end());

  std::auto_ptr<entry_t> new_entry;
  if (command == "e") {
    new_entry.reset(journal->derive_entry(arg, args.end()));
    if (! new_entry.get())
      return 1;
  }

  // Walk the entries based on the report type and the options

  TIMER_START(report_gen);

  item_handler<transaction_t> * formatter;
  std::list<item_handler<transaction_t> *> formatter_ptrs;

  if (command == "b" || command == "E") {
    formatter = new set_account_value;
    formatter = chain_formatters(command, formatter, formatter_ptrs);
  } else {
    std::ostream& out(config.output_stream ?
		      *config.output_stream : std::cout);
    formatter = new format_transactions(out, config.format, config.nformat);
    formatter = chain_formatters(command, formatter, formatter_ptrs);
  }

  if (command == "e")
    walk_transactions(new_entry->transactions, *formatter);
  else
    walk_entries(journal->entries, *formatter);

  formatter->flush();

  // For the balance and equity reports, output the sum totals.

  std::ostream& out(config.output_stream ?
		    *config.output_stream : std::cout);

  if (command == "b") {
    format_account acct_formatter(out, config.format,
				  config.display_predicate);
    sum_accounts(*journal->master);
    walk_accounts(*journal->master, acct_formatter, config.sort_order);
    acct_formatter.flush();

    if (journal->master->data) {
      ACCT_DATA(journal->master)->value = ACCT_DATA(journal->master)->total;

      if (ACCT_DATA(journal->master)->dflags & ACCOUNT_TO_DISPLAY) {
	out << "--------------------\n";
	config.format.format(out, details_t(*journal->master));
      }
    }
  }
  else if (command == "E") {
    format_equity acct_formatter(out, config.format, config.nformat,
				 config.display_predicate);
    sum_accounts(*journal->master);
    walk_accounts(*journal->master, acct_formatter, config.sort_order);
    acct_formatter.flush();
  }

#if DEBUG_LEVEL >= BETA
  for (std::list<item_handler<transaction_t> *>::iterator i
	 = formatter_ptrs.begin();
       i != formatter_ptrs.end();
       i++)
    delete *i;

  // Cleanup the data handlers that might be present on some objects.

  clear_transaction_data xact_cleanup;
  walk_entries(journal->entries, xact_cleanup);

  clear_account_data acct_cleanup;
  walk_accounts(*journal->master, acct_cleanup);
#endif

  TIMER_STOP(report_gen);

  // Write out the binary cache, if need be

  TIMER_START(write_cache);

  if (config.use_cache && config.cache_dirty && ! config.cache_file.empty()) {
    std::ofstream stream(config.cache_file.c_str());
    write_binary_journal(stream, journal.get(), &journal->sources);
  }

  TIMER_STOP(write_cache);

  return 0;
}

int main(int argc, char * argv[], char * envp[])
{
  try {
    return parse_and_report(argc, argv, envp);
  }
  catch (error& err) {
    std::cerr << "Error: " << err.what() << std::endl;
    return 1;
  }
  catch (int& val) {
    return val;			// this acts like a std::setjmp
  }
}

// main.cc ends here.