ledger/xact.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 "xact.h"
#include "journal.h"
#include "account.h"
#include "format.h"

namespace ledger {

bool xact_t::use_effective_date = false;

xact_t::~xact_t()
{
  TRACE_DTOR(xact_t);
}

date_t xact_t::actual_date() const
{
  if (! _date && entry)
    return entry->actual_date();
  return *_date;
}

date_t xact_t::effective_date() const
{
  if (! _date_eff && entry)
    return entry->effective_date();
  return *_date_eff;
}

namespace {
  value_t get_state(xact_t& xact) {
    return long(xact.state);
  }

  value_t state_uncleared(call_scope_t&) {
    return 0L;
  }

  value_t state_cleared(call_scope_t&) {
    return 1L;
  }

  value_t state_pending(call_scope_t&) {
    return 2L;
  }

  value_t get_date(xact_t& xact) {
    return xact.date();
  }

  value_t get_payee(xact_t& xact) {
    return string_value(xact.entry->payee);
  }

  value_t get_amount(xact_t& xact) {
    return xact.amount;
  }

  value_t get_cost(xact_t& xact) {
    return xact.cost ? *xact.cost : xact.amount;
  }

  value_t get_note(xact_t& xact) {
    return string_value(xact.note ? *xact.note : ":NOTELESS:");
  }

  value_t get_account(call_scope_t& scope)
  {
    xact_t& xact(downcast<xact_t>(*scope.parent));

    var_t<long> width(scope, 0);

    string name = xact.reported_account()->fullname();

    if (width && *width > 2)
      name = format_t::truncate(name, *width - 2, true);

    if (xact.has_flags(XACT_VIRTUAL)) {
      if (xact.must_balance())
	name = string("[") + name + "]";
      else
	name = string("(") + name + ")";
    }
    return string_value(name);
  }

  value_t get_account_base(xact_t& xact) {
    return string_value(xact.reported_account()->name);
  }

  value_t get_beg_pos(xact_t& xact) {
    return long(xact.beg_pos);
  }

  value_t get_beg_line(xact_t& xact) {
    return long(xact.beg_line);
  }

  value_t get_end_pos(xact_t& xact) {
    return long(xact.end_pos);
  }

  value_t get_end_line(xact_t& xact) {
    return long(xact.end_line);
  }

  // xdata_t members...

  value_t get_total(xact_t& xact) {
    if (xact.xdata_)
      return xact.xdata_->total;
    else
      return xact.amount;
  }

  template <value_t (*Func)(xact_t&)>
  value_t get_wrapper(call_scope_t& scope) {
    return (*Func)(find_scope<xact_t>(scope));
  }
}

expr_t::ptr_op_t xact_t::lookup(const string& name)
{
  switch (name[0]) {
  case 'a':
    if (name[1] == '\0' || name == "amount")
      return WRAP_FUNCTOR(get_wrapper<&get_amount>);
    else if (name == "account")
      return WRAP_FUNCTOR(get_account);
    else if (name == "account_base")
      return WRAP_FUNCTOR(get_wrapper<&get_account_base>);
    break;

  case 'c':
    if (name == "cleared")
      return expr_t::op_t::wrap_value(0L);
    break;

  case 'd':
    if (name[1] == '\0' || name == "date")
      return WRAP_FUNCTOR(get_wrapper<&get_date>);
    break;

  case 'f':
    if (name.find("fmt_") == 0) {
      switch (name[4]) {
      case 'A':
	return WRAP_FUNCTOR(get_account);
      case 'D':
	return WRAP_FUNCTOR(get_wrapper<&get_date>);
      case 'P':
	return WRAP_FUNCTOR(get_wrapper<&get_payee>);
      }
    }
    break;

  case 'p':
    if (name == "pending")
      return expr_t::op_t::wrap_value(2L);
    break;

  case 'u':
    if (name == "uncleared")
      return expr_t::op_t::wrap_value(1L);
    break;
  }
  return entry->lookup(name);
}

bool xact_t::valid() const
{
  if (! entry) {
    DEBUG("ledger.validate", "xact_t: ! entry");
    return false;
  }

  if (state != UNCLEARED && state != CLEARED && state != PENDING) {
    DEBUG("ledger.validate", "xact_t: state is bad");
    return false;
  }

  xacts_list::const_iterator i =
    std::find(entry->xacts.begin(),
	      entry->xacts.end(), this);
  if (i == entry->xacts.end()) {
    DEBUG("ledger.validate", "xact_t: ! found");
    return false;
  }

  if (! account) {
    DEBUG("ledger.validate", "xact_t: ! account");
    return false;
  }

  if (! amount.valid()) {
    DEBUG("ledger.validate", "xact_t: ! amount.valid()");
    return false;
  }

  if (cost && ! cost->valid()) {
    DEBUG("ledger.validate", "xact_t: cost && ! cost->valid()");
    return false;
  }

  if (flags() & ~0x003f) {
    DEBUG("ledger.validate", "xact_t: flags are bad");
    return false;
  }

  return true;
}

#if 0
xact_context::xact_context(const xact_t& _xact, const string& desc) throw()
  : file_context("", 0, desc), xact(_xact)
{
  const paths_list& sources(xact.entry->journal->sources);
  unsigned int x = 0;
  foreach (const path& path, sources)
    if (x == xact.entry->src_idx) {
      file = path;
      break;
    }
  line = xact.beg_line;
}
#endif

void xact_t::add_to_value(value_t& value)
{
  if (xdata_ && xdata_->has_flags(XACT_EXT_COMPOUND)) {
    value += xdata_->value;
  }
  else if (cost || (! value.is_null() && ! value.is_realzero())) {
    value.add(amount, cost);
  }
  else {
    value = amount;
  }
}

} // namespace ledger