path: root/src/report.cc

/*
 * 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.
 */

#include "report.h"
#include "output.h"
#include "reconcile.h"

namespace ledger {

xact_handler_ptr
report_t::chain_xact_handlers(xact_handler_ptr base_handler,
			      const bool handle_individual_xacts)
{
  bool remember_components = false;

  xact_handler_ptr handler(base_handler);

  // format_xacts write each xact received to the
  // output stream.
  if (handle_individual_xacts) {
    // truncate_entries cuts off a certain number of _entries_ from
    // being displayed.  It does not affect calculation.
    if (head_entries || tail_entries)
      handler.reset(new truncate_entries(handler, head_entries, tail_entries));

    // filter_xacts will only pass through xacts matching the
    // `display_predicate'.
    if (! display_predicate.empty())
      handler.reset(new filter_xacts(handler, display_predicate));

    // calc_xacts computes the running total.  When this
    // appears will determine, for example, whether filtered
    // xacts are included or excluded from the running total.
    handler.reset(new calc_xacts(handler));

    // component_xacts looks for reported xact that
    // match the given `descend_expr', and then reports the
    // xacts which made up the total for that reported
    // xact.
    if (! descend_expr.empty()) {
      std::list<std::string> descend_exprs;

      std::string::size_type beg = 0;
      for (std::string::size_type pos = descend_expr.find(';');
	   pos != std::string::npos;
	   beg = pos + 1, pos = descend_expr.find(';', beg))
	descend_exprs.push_back(std::string(descend_expr, beg, pos - beg));
      descend_exprs.push_back(std::string(descend_expr, beg));

      for (std::list<std::string>::reverse_iterator i =
	     descend_exprs.rbegin();
	   i != descend_exprs.rend();
	   i++)
	handler.reset(new component_xacts(handler, *i));

      remember_components = true;
    }

    // reconcile_xacts will pass through only those
    // xacts which can be reconciled to a given balance
    // (calculated against the xacts which it receives).
    if (! reconcile_balance.empty()) {
      date_t cutoff = current_date;
      if (! reconcile_date.empty())
	cutoff = parse_date(reconcile_date);
      handler.reset(new reconcile_xacts
		    (handler, value_t(reconcile_balance), cutoff));
    }

    // filter_xacts will only pass through xacts
    // matching the `secondary_predicate'.
    if (! secondary_predicate.empty())
      handler.reset(new filter_xacts(handler, secondary_predicate));

    // sort_xacts will sort all the xacts it sees, based
    // on the `sort_order' value expression.
    if (! sort_string.empty()) {
      if (entry_sort)
	handler.reset(new sort_entries(handler, sort_string));
      else
	handler.reset(new sort_xacts(handler, sort_string));
    }

    // changed_value_xacts adds virtual xacts to the
    // list to account for changes in market value of commodities,
    // which otherwise would affect the running total unpredictably.
    if (show_revalued)
      handler.reset(new changed_value_xacts(handler, total_expr,
					    show_revalued_only));

    // collapse_xacts causes entries with multiple xacts
    // to appear as entries with a subtotaled xact for each
    // commodity used.
    if (show_collapsed)
      handler.reset(new collapse_xacts(handler, session));

    // subtotal_xacts combines all the xacts it receives
    // into one subtotal entry, which has one xact for each
    // commodity in each account.
    //
    // period_xacts is like subtotal_xacts, but it
    // subtotals according to time periods rather than totalling
    // everything.
    //
    // dow_xacts is like period_xacts, except that it
    // reports all the xacts that fall on each subsequent day
    // of the week.
    if (show_subtotal)
      handler.reset(new subtotal_xacts(handler, remember_components));

    if (days_of_the_week)
      handler.reset(new dow_xacts(handler, remember_components));
    else if (by_payee)
      handler.reset(new by_payee_xacts(handler, remember_components));

    // interval_xacts groups xacts together based on a
    // time period, such as weekly or monthly.
    if (! report_period.empty()) {
      handler.reset(new interval_xacts(handler, report_period,
					      remember_components));
      handler.reset(new sort_xacts(handler, "d"));
    }
  }

  // invert_xacts inverts the value of the xacts it
  // receives.
  if (show_inverted)
    handler.reset(new invert_xacts(handler));

  // related_xacts will pass along all xacts related
  // to the xact received.  If `show_all_related' is true,
  // then all the entry's xacts are passed; meaning that if
  // one xact of an entry is to be printed, all the
  // xact for that entry will be printed.
  if (show_related)
    handler.reset(new related_xacts(handler, show_all_related));

  // This filter_xacts will only pass through xacts
  // matching the `predicate'.
  if (! predicate.empty()) {
    DEBUG("report.predicate",
	  "Report predicate expression = " << predicate);
    handler.reset(new filter_xacts(handler, predicate));
  }

#if 0
  // budget_xacts takes a set of xacts from a data
  // file and uses them to generate "budget xacts" which
  // balance against the reported xacts.
  //
  // forecast_xacts is a lot like budget_xacts, except
  // that it adds entries only for the future, and does not balance
  // them against anything but the future balance.

  if (budget_flags) {
    budget_xacts * budget_handler
      = new budget_xacts(handler, budget_flags);
    budget_handler->add_period_entries(journal->period_entries);
    handler.reset(budget_handler);

    // Apply this before the budget handler, so that only matching
    // xacts are calculated toward the budget.  The use of
    // filter_xacts above will further clean the results so
    // that no automated xacts that don't match the filter get
    // reported.
    if (! predicate.empty())
      handler.reset(new filter_xacts(handler, predicate));
  }
  else if (! forecast_limit.empty()) {
    forecast_xacts * forecast_handler
      = new forecast_xacts(handler, forecast_limit);
    forecast_handler->add_period_entries(journal->period_entries);
    handler.reset(forecast_handler);

    // See above, under budget_xacts.
    if (! predicate.empty())
      handler.reset(new filter_xacts(handler, predicate));
  }
#endif

  if (comm_as_payee)
    handler.reset(new set_comm_as_payee(handler));
  else if (code_as_payee)
    handler.reset(new set_code_as_payee(handler));

  return handler;
}

void report_t::xacts_report(xact_handler_ptr handler)
{
  session_xacts_iterator walker(session);
  pass_down_xacts(chain_xact_handlers(handler), walker);

  if (DO_VERIFY())
    session.clean_xacts();
}

void report_t::entry_report(xact_handler_ptr handler, entry_t& entry)
{
  entry_xacts_iterator walker(entry);
  pass_down_xacts(chain_xact_handlers(handler), walker);

  if (DO_VERIFY())
    session.clean_xacts(entry);
}

void report_t::sum_all_accounts()
{
  session_xacts_iterator walker(session);
  pass_down_xacts
    (chain_xact_handlers(xact_handler_ptr(new set_account_value), false),
     walker);
  session.master->calculate_sums();
}

void report_t::accounts_report(acct_handler_ptr handler)
{
  sum_all_accounts();

  if (sort_string.empty()) {
    basic_accounts_iterator walker(*session.master);
    pass_down_accounts(handler, walker, expr_t("total"));
  } else {
    sorted_accounts_iterator walker(*session.master, sort_string);
    pass_down_accounts(handler, walker, expr_t("total"));
  }
    
  if (DO_VERIFY()) {
    session.clean_xacts();
    session.clean_accounts();
  }
}

void report_t::commodities_report(const string& format)
{
}

value_t report_t::get_amount_expr(call_scope_t& scope)
{
  return amount_expr.calc(scope);
}

value_t report_t::get_total_expr(call_scope_t& scope)
{
  return total_expr.calc(scope);
}

value_t report_t::get_display_total(call_scope_t& scope)
{
  return display_total.calc(scope);
}

value_t report_t::f_market_value(call_scope_t& args)
{
  var_t<datetime_t> date(args, 1);
  var_t<string>	    in_terms_of(args, 2);

  commodity_t * commodity = NULL;
  if (in_terms_of)
    commodity = amount_t::current_pool->find_or_create(*in_terms_of);

  DEBUG("report.market", "getting market value of: " << args[0]);

  value_t result =
    args[0].value(date ? optional<datetime_t>(*date) : optional<datetime_t>(),
		  commodity ? optional<commodity_t&>(*commodity) :
		  optional<commodity_t&>());

  DEBUG("report.market", "result is: " << result);
  return result;
}

namespace {
  value_t print_balance(call_scope_t& args)
  {
    var_t<long>	first_width(args, 1);
    var_t<long>	latter_width(args, 2);
#if 0
    var_t<bool>	bold_negative(args, 3);
#endif

    std::ostringstream out;
    args[0].strip_annotations().dump(out, *first_width, *latter_width);
    return string_value(out.str());
  }

  string args_to_predicate(value_t::sequence_t::const_iterator begin,
			   value_t::sequence_t::const_iterator end)
  {
    string acct_value_expr;
    string payee_value_expr;
    string note_value_expr;

    string * value_expr;

    enum regexp_kind_t {
      ACCOUNT_REGEXP,
      PAYEE_REGEXP,
      NOTE_REGEXP
    }
    kind = ACCOUNT_REGEXP;

    value_expr = &acct_value_expr;

    for ( ; begin != end; begin++) {
      const string& arg((*begin).as_string());

      if (arg == "--") {
	kind = PAYEE_REGEXP;
	value_expr = &payee_value_expr;
      }
      else if (arg == "/") {
	kind = NOTE_REGEXP;
	value_expr = &note_value_expr;
      }
      else {
	if (! value_expr->empty())
	  *value_expr += "|";

	switch (kind) {
	case ACCOUNT_REGEXP:
	  *value_expr += "account =~ ";
	  break;
	case PAYEE_REGEXP:
	  *value_expr += "payee =~ ";
	  break;
	case NOTE_REGEXP:
	  *value_expr += "note =~ ";
	  break;
	}

	const char * p = arg.c_str();
	if (*p == '-') {
	  *value_expr += "!";
	  p++;
	}

	*value_expr += "/";
	if (kind == NOTE_REGEXP) *value_expr += ":";
	while (*p) {
	  if (*p == '/')
	    *value_expr += "\\";
	  *value_expr += *p;
	  p++;
	}
	if (kind == NOTE_REGEXP) *value_expr += ":";
	*value_expr += "/";
      }
    }

    string final_value_expr;

    if (! acct_value_expr.empty()) {
      if (! payee_value_expr.empty() ||
	  ! note_value_expr.empty())
	final_value_expr = string("(") + acct_value_expr + ")";
      else
	final_value_expr = acct_value_expr;
    }

    if (! payee_value_expr.empty()) {
      if (! acct_value_expr.empty())
	final_value_expr += string("&(") + payee_value_expr + ")";
      else if (! note_value_expr.empty())
	final_value_expr = string("(") + payee_value_expr + ")";
      else
	final_value_expr = payee_value_expr;
    }

    if (! note_value_expr.empty()) {
      if (! acct_value_expr.empty() ||
	  ! payee_value_expr.empty())
	final_value_expr += string("&(") + note_value_expr + ")";
      else if (acct_value_expr.empty() &&
	       payee_value_expr.empty())
	final_value_expr = note_value_expr;
    }

    DEBUG("report.predicate",
	  "Regexp predicate expression = " << final_value_expr);

    return final_value_expr;
  }

  template <class Type        = xact_t,
	    class handler_ptr = xact_handler_ptr,
	    void (report_t::*report_method)(handler_ptr) =
	    &report_t::xacts_report>
  class reporter
  {
    shared_ptr<item_handler<Type> > handler;

  public:
    reporter(item_handler<Type> * _handler)
      : handler(_handler) {}

    value_t operator()(call_scope_t& args)
    {
      report_t& report(find_scope<report_t>(args));

      if (args.value().size() > 0)
	report.append_predicate
	  (args_to_predicate(args.value().as_sequence().begin(),
			     args.value().as_sequence().end()));

      (report.*report_method)(handler_ptr(handler));

      return true;
    }
  };
}

expr_t::ptr_op_t report_t::lookup(const string& name)
{
  const char * p = name.c_str();
  switch (*p) {
  case 'a':
    if (std::strcmp(p, "amount_expr") == 0)
      return MAKE_FUNCTOR(report_t::get_amount_expr);
    break;

  case 'c':
    if (std::strncmp(p, "cmd_", 4) == 0) {

#define FORMAT(str) \
    (format_string.empty() ? session. str : format_string)

#if 0
      // Commands yet to implement:
      //
      // entry
      // dump
      // output
      // prices
      // pricesdb
      // csv
      // emacs | lisp
      // xml
#endif

      p = p + 4;
      switch (*p) {
      case 'b':
	if (*(p + 1) == '\0' ||
	    std::strcmp(p, "bal") == 0 ||
	    std::strcmp(p, "balance") == 0)
	  return expr_t::op_t::wrap_functor
	    (reporter<account_t, acct_handler_ptr, &report_t::accounts_report>
	     (new format_accounts(*this, FORMAT(balance_format))));

      case 'e':
	if (std::strcmp(p, "equity") == 0)
	  return expr_t::op_t::wrap_functor
	    (reporter<account_t, acct_handler_ptr, &report_t::accounts_report>
	     (new format_equity(*this, FORMAT(print_format))));

      case 'p':
	if (*(p + 1) == '\0' ||
	    std::strcmp(p, "print") == 0)
	  return WRAP_FUNCTOR
	    (reporter<>(new format_xacts(*this, FORMAT(print_format))));
	break;

      case 'r':
	if (*(p + 1) == '\0' ||
	    std::strcmp(p, "reg") == 0 ||
	    std::strcmp(p, "register") == 0)
	  return WRAP_FUNCTOR
	    (reporter<>(new format_xacts(*this, FORMAT(register_format))));
	break;
      }
    }
    break;

  case 'd':
    if (std::strcmp(p, "display_total") == 0)
	return MAKE_FUNCTOR(report_t::get_display_total);
    break;

  case 'm':
    if (std::strcmp(p, "market_value") == 0)
      return MAKE_FUNCTOR(report_t::f_market_value);
    break;

  case 'o':
    if (std::strncmp(p, "opt_", 4) == 0) {
      p = p + 4;
      switch (*p) {
      case 'a':
	if (std::strcmp(p, "amount_") == 0)
	  return MAKE_FUNCTOR(report_t::option_amount_);
	else if (std::strcmp(p, "ansi") == 0)
	  return MAKE_FUNCTOR(report_t::option_ansi);
	else if (std::strcmp(p, "ansi-invert") == 0)
	  return MAKE_FUNCTOR(report_t::option_ansi_invert);
	break;

      case 'b':
	if (std::strcmp(p, "b_") == 0 ||
	    std::strcmp(p, "begin_") == 0)
	  return MAKE_FUNCTOR(report_t::option_begin_);
	else if (std::strcmp(p, "base") == 0)
	  return MAKE_FUNCTOR(report_t::option_base);
	else if (std::strcmp(p, "by-payee") == 0)
	  return MAKE_FUNCTOR(report_t::option_by_payee);
	break;

      case 'c':
	if (! *(p + 1) || std::strcmp(p, "current") == 0)
	  return MAKE_FUNCTOR(report_t::option_current);
	else if (std::strcmp(p, "collapse") == 0)
	  return MAKE_FUNCTOR(report_t::option_collapse);
	else if (std::strcmp(p, "cleared") == 0)
	  return MAKE_FUNCTOR(report_t::option_cleared);
	else if (std::strcmp(p, "cost") == 0)
	  return MAKE_FUNCTOR(report_t::option_cost);
	else if (std::strcmp(p, "comm-as-payee") == 0)
	  return MAKE_FUNCTOR(report_t::option_comm_as_payee);
	else if (std::strcmp(p, "code-as-payee") == 0)
	  return MAKE_FUNCTOR(report_t::option_code_as_payee);
	break;

      case 'd':
	if (std::strcmp(p, "daily") == 0)
	  return MAKE_FUNCTOR(report_t::option_daily);
	else if (std::strcmp(p, "dow") == 0)
	  return MAKE_FUNCTOR(report_t::option_dow);
	else if (std::strcmp(p, "date-format_") == 0)
	  return MAKE_FUNCTOR(report_t::option_date_format_);
	break;

      case 'e':
	if (std::strcmp(p, "e_") == 0 ||
	    std::strcmp(p, "end_") == 0)
	  return MAKE_FUNCTOR(report_t::option_end_);
	else if (std::strcmp(p, "empty") == 0)
	  return MAKE_FUNCTOR(report_t::option_empty);
	break;

      case 'f':
	if (std::strcmp(p, "format_") == 0)
	  return MAKE_FUNCTOR(report_t::option_format_);
	break;

      case 'h':
	if (std::strcmp(p, "head_") == 0)
	  return MAKE_FUNCTOR(report_t::option_head_);
	break;

      case 'i':
	if (std::strcmp(p, "input-date-format_") == 0)
	  return MAKE_FUNCTOR(report_t::option_input_date_format_);
	break;

      case 'j':
	if (! *(p + 1))
	  return MAKE_FUNCTOR(report_t::option_amount_data);
	break;

      case 'l':
	if (std::strcmp(p, "l_") == 0
	    || std::strcmp(p, "limit_") == 0)
	  return MAKE_FUNCTOR(report_t::option_limit_);
	break;

      case 'm':
	if (std::strcmp(p, "monthly") == 0)
	  return MAKE_FUNCTOR(report_t::option_monthly);
	else if (std::strcmp(p, "market") == 0)
	  return MAKE_FUNCTOR(report_t::option_market);
	break;

      case 'n':
	if (std::strcmp(p, "n") == 0)
	  return MAKE_FUNCTOR(report_t::option_collapse);
	break;

      case 'p':
	if (std::strcmp(p, "p_") == 0 ||
	    std::strcmp(p, "period_") == 0)
	  return MAKE_FUNCTOR(report_t::option_period_);
	else if (std::strcmp(p, "period_sort_") == 0)
	  return MAKE_FUNCTOR(report_t::option_period_sort_);
	else if (std::strcmp(p, "price") == 0)
	  return MAKE_FUNCTOR(report_t::option_price);
	else if (std::strcmp(p, "price_db_") == 0)
	  return MAKE_FUNCTOR(report_t::option_price_db_);
	break;

      case 'q':
	if (std::strcmp(p, "quarterly") == 0)
	  return MAKE_FUNCTOR(report_t::option_quarterly);
	else if (std::strcmp(p, "quantity") == 0)
	  return MAKE_FUNCTOR(report_t::option_quantity);
	break;

      case 'r':
	if (std::strcmp(p, "r") == 0 ||
	    std::strcmp(p, "related") == 0)
	  return MAKE_FUNCTOR(report_t::option_related);
	break;

      case 's':
	if (std::strcmp(p, "s") == 0 ||
	    std::strcmp(p, "subtotal") == 0)
	  return MAKE_FUNCTOR(report_t::option_subtotal);
	else if (std::strcmp(p, "sort_") == 0)
	  return MAKE_FUNCTOR(report_t::option_sort_);
	else if (std::strcmp(p, "sort_entries_") == 0)
	  return MAKE_FUNCTOR(report_t::option_sort_entries_);
	else if (std::strcmp(p, "sort_all_") == 0)
	  return MAKE_FUNCTOR(report_t::option_sort_all_);
	break;

      case 't':
	if (std::strcmp(p, "t_") == 0)
	  return MAKE_FUNCTOR(report_t::option_amount_);
	else if (std::strcmp(p, "total_") == 0)
	  return MAKE_FUNCTOR(report_t::option_total_);
	else if (std::strcmp(p, "totals") == 0)
	  return MAKE_FUNCTOR(report_t::option_totals);
	else if (std::strcmp(p, "tail_") == 0)
	  return MAKE_FUNCTOR(report_t::option_tail_);
	break;

      case 'u':
	if (std::strcmp(p, "uncleared") == 0)
	  return MAKE_FUNCTOR(report_t::option_uncleared);
	break;

      case 'w':
	if (std::strcmp(p, "weekly") == 0)
	  return MAKE_FUNCTOR(report_t::option_weekly);
	break;

      case 'x':
	if (std::strcmp(p, "x"))
	  return MAKE_FUNCTOR(report_t::option_comm_as_payee);
	break;

      case 'y':
	if (std::strcmp(p, "yearly") == 0)
	  return MAKE_FUNCTOR(report_t::option_yearly);
	else if (std::strcmp(p, "y_") == 0)
	  return MAKE_FUNCTOR(report_t::option_date_format_);
	break;

      case 'B':
	if (! *(p + 1))
	  return MAKE_FUNCTOR(report_t::option_cost);
	break;

      case 'C':
	if (! *(p + 1))
	  return MAKE_FUNCTOR(report_t::option_cleared);
	break;

      case 'E':
	if (! *(p + 1))
	  return MAKE_FUNCTOR(report_t::option_empty);
	break;

      case 'F':
	if (std::strcmp(p, "F_") == 0)
	  return MAKE_FUNCTOR(report_t::option_format_);
	break;

      case 'I':
	if (! *(p + 1))
	  return MAKE_FUNCTOR(report_t::option_price);
	break;

      case 'J':
	if (! *(p + 1))
	  return MAKE_FUNCTOR(report_t::option_total_data);
	break;

      case 'M':
	if (! *(p + 1))
	  return MAKE_FUNCTOR(report_t::option_monthly);
	break;

      case 'O':
	if (! *(p + 1))
	  return MAKE_FUNCTOR(report_t::option_quantity);
	break;

      case 'P':
	if (! *(p + 1))
	  return MAKE_FUNCTOR(report_t::option_by_payee);
	break;

      case 'S':
	if (std::strcmp(p, "S_") == 0)
	  return MAKE_FUNCTOR(report_t::option_sort_);
	break;

      case 'T':
	if (std::strcmp(p, "T_") == 0)
	  return MAKE_FUNCTOR(report_t::option_total_);
	break;

      case 'U':
	if (! *(p + 1))
	  return MAKE_FUNCTOR(report_t::option_uncleared);
	break;

      case 'V':
	if (! *(p + 1))
	  return MAKE_FUNCTOR(report_t::option_market);
	break;

      case 'W':
	if (! *(p + 1))
	  return MAKE_FUNCTOR(report_t::option_weekly);
	break;

      case 'Y':
	if (! *(p + 1))
	  return MAKE_FUNCTOR(report_t::option_yearly);
	break;
      }
    }
    break;

  case 'p':
    if (std::strcmp(p, "print_balance") == 0)
      return WRAP_FUNCTOR(print_balance);
    break;

  case 't':
    if (std::strcmp(p, "total_expr") == 0)
	return MAKE_FUNCTOR(report_t::get_total_expr);
    break;
  }

  return session.lookup(name);
}

} // namespace ledger