ledger/src/account.h

/*
 * Copyright (c) 2003-2009, 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.
 */

/**
 * @addtogroup data
 */

/**
 * @file   account.h
 * @author John Wiegley
 *
 * @ingroup data
 *
 * @brief Brief
 *
 * Long.
 */
#ifndef _ACCOUNT_H
#define _ACCOUNT_H

#include "scope.h"

namespace ledger {

class session_t;
class account_t;
class xact_t;
class post_t;

typedef std::deque<post_t *>                posts_deque;
typedef std::map<const string, account_t *> accounts_map;

/**
 * @brief Brief
 *
 * Long.
 */
class account_t : public scope_t
{
 public:
  account_t *	   parent;
  string	   name;
  optional<string> note;
  unsigned short   depth;
  accounts_map	   accounts;
  posts_deque	   posts;
  bool		   known;

  mutable void *   data;
  mutable string   _fullname;

  account_t(account_t *             _parent = NULL,
	    const string&           _name   = "",
	    const optional<string>& _note   = none)
    : scope_t(), parent(_parent), name(_name), note(_note),
      depth(static_cast<unsigned short>(parent ? parent->depth + 1 : 0)),
      known(false), data(NULL) {
    TRACE_CTOR(account_t, "account_t *, const string&, const string&");
  }
  account_t(const account_t& other)
    : scope_t(),
      parent(other.parent),
      name(other.name),
      note(other.note),
      depth(other.depth),
      accounts(other.accounts),
      known(other.known),
      data(NULL) {
    TRACE_CTOR(account_t, "copy");
    assert(other.data == NULL);
  }
  ~account_t();

  operator string() const {
    return fullname();
  }
  string fullname() const;
  string partial_name(bool flat = false) const;

  void add_account(account_t * acct) {
    accounts.insert(accounts_map::value_type(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 string& name, bool auto_create = true);
  account_t * find_account_re(const string& regexp);

  void add_post(post_t * post) {
    posts.push_back(post);
  }

  virtual expr_t::ptr_op_t lookup(const string& name);

  bool valid() const;

  friend class journal_t;

  struct xdata_t : public supports_flags<>
  {
#define ACCOUNT_EXT_SORT_CALC	     0x01
#define ACCOUNT_EXT_HAS_NON_VIRTUALS 0x02
#define ACCOUNT_EXT_HAS_UNB_VIRTUALS 0x04
#define ACCOUNT_EXT_AUTO_VIRTUALIZE  0x08
#define ACCOUNT_EXT_VISITED          0x10
#define ACCOUNT_EXT_MATCHING         0x20
#define ACCOUNT_EXT_TO_DISPLAY	     0x40
#define ACCOUNT_EXT_DISPLAYED	     0x80

    struct details_t
    {
      value_t		 total;
      bool		 calculated;
      bool		 gathered;

      // The following are only calculated if --totals is enabled
      std::size_t	 posts_count;
      std::size_t	 posts_virtuals_count;
      std::size_t	 posts_cleared_count;
      std::size_t	 posts_last_7_count;
      std::size_t	 posts_last_30_count;
      std::size_t	 posts_this_month_count;

      date_t		 earliest_post;
      date_t		 earliest_cleared_post;
      date_t		 latest_post;
      date_t		 latest_cleared_post;

      std::size_t	 last_size;

      // The following are only calculated if --gather is enabled
      std::set<path>	 filenames;
      std::set<string>	 accounts_referenced;
      std::set<string>	 payees_referenced;

      details_t()
	: calculated(false),
	  gathered(false),

	  posts_count(0),
	  posts_virtuals_count(0),
	  posts_cleared_count(0),
	  posts_last_7_count(0),
	  posts_last_30_count(0),
	  posts_this_month_count(0),

	  last_size(0) {}

      details_t& operator+=(const details_t& other);

      void update(post_t& post, bool gather_all = false);
    };

    details_t self_details;
    details_t family_details;

    std::list<sort_value_t> sort_values;

    xdata_t() : supports_flags<>()
    {
      TRACE_CTOR(account_t::xdata_t, "");
    }
    xdata_t(const xdata_t& other)
      : supports_flags<>(other.flags()),
	self_details(other.self_details),
	family_details(other.family_details),
	sort_values(other.sort_values)
    {
      TRACE_CTOR(account_t::xdata_t, "copy");
    }

    ~xdata_t() throw() {
      TRACE_DTOR(account_t::xdata_t);
    }
  };

  // This variable holds optional "extended data" which is usually produced
  // only during reporting, and only for the posting set being reported.
  // It's a memory-saving measure to delay allocation until the last possible
  // moment.
  mutable optional<xdata_t> xdata_;

  bool has_xdata() const {
    return xdata_;
  }
  void clear_xdata() {
    xdata_ = none;
  }
  xdata_t& xdata() {
    if (! xdata_)
      xdata_ = xdata_t();
    return *xdata_;
  }
  const xdata_t& xdata() const {
    assert(xdata_);
    return *xdata_;
  }

  value_t self_total(const optional<expr_t&>& expr = none) const;
  value_t family_total(const optional<expr_t&>& expr = none) const;

  const xdata_t::details_t& self_details(bool gather_all = true) const;
  const xdata_t::details_t& family_details(bool gather_all = true) const;

  bool has_flags(xdata_t::flags_t flags) const {
    return xdata_ && xdata_->has_flags(flags);
  }
  std::size_t children_with_flags(xdata_t::flags_t flags) const;
};

std::ostream& operator<<(std::ostream& out, const account_t& account);

} // namespace ledger

#endif // _ACCOUNT_H