xact.h

Go to the documentation of this file.

/*
 * Copyright (c) 2003-2023, 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.
 */
 
#pragma once
 
#include "item.h"
#include "predicate.h"
 
namespace ledger {
 
class post_t;
class journal_t;
class parse_context_t;
 
typedef std::list<post_t *> posts_list;
 
class xact_base_t : public item_t
{
public:
  journal_t * journal;
  posts_list  posts;
 
  xact_base_t() : item_t(), journal(NULL) {
    TRACE_CTOR(xact_base_t, "");
  }
  xact_base_t(const xact_base_t& e);
 
  virtual ~xact_base_t();
 
  virtual void add_post(post_t * post);
  virtual bool remove_post(post_t * post);
 
  posts_list::iterator posts_begin() {
    return posts.begin();
  }
  posts_list::iterator posts_end() {
    return posts.end();
  }
 
  value_t magnitude() const;
 
  bool finalize();
  bool verify();
 
  bool has_xdata();
  void clear_xdata();
 
  virtual bool valid() const {
    return true;
  }
};
 
class xact_t : public xact_base_t
{
public:
  optional<string> code;
  string           payee;
 
#if DOCUMENT_MODEL
  mutable void * data;
#endif
 
  xact_t()
#if DOCUMENT_MODEL
    : data(NULL)
#endif
  {
    TRACE_CTOR(xact_t, "");
  }
  xact_t(const xact_t& e);
 
  virtual ~xact_t() {
    TRACE_DTOR(xact_t);
  }
 
  virtual string description() {
    if (pos) {
      std::ostringstream buf;
      buf << _f("transaction at line %1%") % pos->beg_line;
      return buf.str();
    } else {
      return string(_("generated transaction"));
    }
  }
 
  virtual void add_post(post_t * post);
 
  virtual expr_t::ptr_op_t lookup(const symbol_t::kind_t kind,
                                  const string& name);
 
  virtual bool valid() const;
 
  string hash(string nonce, hash_type_t hash_type) const;
};
 
class auto_xact_t : public xact_base_t
{
public:
  predicate_t            predicate;
  bool                   try_quick_match;
  std::map<string, bool> memoized_results;
 
  optional<expr_t::check_expr_list> check_exprs;
 
  struct deferred_tag_data_t {
    string   tag_data;
    bool     overwrite_existing;
    post_t * apply_to_post;
 
    deferred_tag_data_t(string _tag_data,
                        bool   _overwrite_existing)
      : tag_data(_tag_data), overwrite_existing(_overwrite_existing),
        apply_to_post(NULL) {}
  };
 
  typedef std::list<deferred_tag_data_t> deferred_notes_list;
 
  optional<deferred_notes_list> deferred_notes;
  post_t * active_post;
 
  auto_xact_t() : try_quick_match(true), active_post(NULL) {
    TRACE_CTOR(auto_xact_t, "");
  }
  auto_xact_t(const auto_xact_t& other)
    : xact_base_t(), predicate(other.predicate),
      try_quick_match(other.try_quick_match),
      active_post(other.active_post) {
    TRACE_CTOR(auto_xact_t, "copy");
  }
  auto_xact_t(const predicate_t& _predicate)
    : predicate(_predicate), try_quick_match(true), active_post(NULL)
  {
    TRACE_CTOR(auto_xact_t, "const predicate_t&");
  }
 
  virtual ~auto_xact_t() {
    TRACE_DTOR(auto_xact_t);
  }
 
  virtual string description() {
    if (pos) {
      std::ostringstream buf;
      buf << _f("automated transaction at line %1%") % pos->beg_line;
      return buf.str();
    } else {
      return string(_("generated automated transaction"));
    }
  }
 
  virtual void parse_tags(const char * p, scope_t&,
                          bool overwrite_existing = true) {
    if (! deferred_notes)
      deferred_notes = deferred_notes_list();
    deferred_notes->push_back(deferred_tag_data_t(p, overwrite_existing));
    deferred_notes->back().apply_to_post = active_post;
  }
 
  virtual void extend_xact(xact_base_t& xact, parse_context_t& context);
};
 
class period_xact_t : public xact_base_t
{
 public:
  date_interval_t period;
  string          period_string;
 
  period_xact_t() {
    TRACE_CTOR(period_xact_t, "");
  }
  period_xact_t(const period_xact_t& e)
    : xact_base_t(e), period(e.period), period_string(e.period_string) {
    TRACE_CTOR(period_xact_t, "copy");
  }
  period_xact_t(const string& _period)
    : period(_period), period_string(_period) {
    TRACE_CTOR(period_xact_t, "const string&");
  }
 
  virtual ~period_xact_t() {
    TRACE_DTOR(period_xact_t);
  }
 
  virtual string description() {
    if (pos) {
      std::ostringstream buf;
      buf << _f("periodic transaction at line %1%") % pos->beg_line;
      return buf.str();
    } else {
      return string(_("generated periodic transaction"));
    }
  }
};
 
typedef std::list<xact_t *>        xacts_list;
typedef std::list<auto_xact_t *>   auto_xacts_list;
typedef std::list<period_xact_t *> period_xacts_list;
 
void put_xact(property_tree::ptree& pt, const xact_t& xact);
 
} // namespace ledger