Transaction.h

Go to the documentation of this file.

/********************************************************************\
 * This program is free software; you can redistribute it and/or    *
 * modify it under the terms of the GNU General Public License as   *
 * published by the Free Software Foundation; either version 2 of   *
 * the License, or (at your option) any later version.              *
 *                                                                  *
 * This program is distributed in the hope that it will be useful,  *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of   *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the    *
 * GNU General Public License for more details.                     *
 *                                                                  *
 * You should have received a copy of the GNU General Public License*
 * along with this program; if not, contact:                        *
 *                                                                  *
 * Free Software Foundation           Voice:  +1-617-542-5942       *
 * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652       *
 * Boston, MA  02110-1301,  USA       gnu@gnu.org                   *
 *                                                                  *
\********************************************************************/
#ifndef XACC_TRANSACTION_H
#define XACC_TRANSACTION_H

typedef struct _TransactionClass TransactionClass;

#include <time.h>

#include "gnc-commodity.h"
#include "gnc-engine.h"
#include "gnc-pricedb.h"
#include "Split.h"

#ifdef __cplusplus
extern "C" {
#endif

/* --- type macros --- */
#define GNC_TYPE_TRANSACTION            (gnc_transaction_get_type ())
#define GNC_TRANSACTION(o)              \
     (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_TRANSACTION, Transaction))
#define GNC_TRANSACTION_CLASS(k)        \
     (G_TYPE_CHECK_CLASS_CAST((k), GNC_TYPE_TRANSACTION, TransactionClass))
#define GNC_IS_TRANSACTION(o)           \
     (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_TRANSACTION))
#define GNC_IS_TRANSACTION_CLASS(k)     \
     (G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_TRANSACTION))
#define GNC_TRANSACTION_GET_CLASS(o)    \
     (G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_TRANSACTION, TransactionClass))
GType gnc_transaction_get_type(void);


/* FIXME: These macros are not consistent with the type name */
#define GNC_IS_TRANS(obj)  GNC_IS_TRANSACTION(obj)
#define GNC_TRANS(obj)     GNC_TRANSACTION(obj)

#define TXN_TYPE_UNCACHED '?' 
#define TXN_TYPE_NONE    '\0' 
#define TXN_TYPE_INVOICE 'I'  
#define TXN_TYPE_PAYMENT 'P'  
#define TXN_TYPE_LINK    'L'  
/* --------------------------------------------------------------- */
/* Transactions */

Transaction * xaccMallocTransaction (QofBook *book);

void          xaccTransDestroy (Transaction *trans);

Transaction * xaccTransClone (const Transaction *t);

Transaction * xaccTransCloneNoKvp (const Transaction *t);

gboolean xaccTransEqual(const Transaction *ta,
                        const Transaction *tb,
                        gboolean check_guids,
                        gboolean check_splits,
                        gboolean check_balances,
                        gboolean assume_ordered);

void          xaccTransBeginEdit (Transaction *trans);

void          xaccTransCommitEdit (Transaction *trans);

void          xaccTransRollbackEdit (Transaction *trans);

gboolean      xaccTransIsOpen (const Transaction *trans);

/*@ dependent @*//*@ null @*/
Transaction * xaccTransLookup (const GncGUID *guid, QofBook *book);
#define xaccTransLookupDirect(g,b) xaccTransLookup(&(g),b)

/*################## Added for Reg2 #################*/

Transaction * xaccTransCopyToClipBoard(const Transaction *from_trans);

void xaccTransCopyOnto(const Transaction *from_trans, Transaction *to_trans);

void xaccTransCopyFromClipBoard(const Transaction *from_trans, Transaction *to_trans,
                           const Account *from_acc, Account *to_acc, gboolean no_date);

/*################## Added for Reg2 #################*/


Split * xaccTransFindSplitByAccount(const Transaction *trans,
                                    const Account *acc);

void xaccTransScrubGains (Transaction *trans, Account *gain_acc);


guint gnc_book_count_transactions(QofBook *book);

gboolean xaccTransUseTradingAccounts(const Transaction *trans);

void          xaccTransSortSplits (Transaction *trans);

void          xaccTransSetTxnType (Transaction *trans, char type);

char          xaccTransGetTxnType (Transaction *trans);

void          xaccTransSetNum (Transaction *trans, const char *num);

void          xaccTransSetDescription (Transaction *trans, const char *desc);

void          xaccTransSetDocLink (Transaction *trans, const char *doclink);

void          xaccTransSetNotes (Transaction *trans, const char *notes);

const char *  xaccTransGetNum (const Transaction *trans);
const char *  xaccTransGetDescription (const Transaction *trans);
const char *  xaccTransGetDocLink(const Transaction *trans);
const char *  xaccTransGetNotes (const Transaction *trans);


void          xaccTransSetIsClosingTxn (Transaction *trans, gboolean is_closing);

gboolean      xaccTransGetIsClosingTxn (const Transaction *trans);


#define xaccTransAppendSplit(t, s) xaccSplitSetParent((s), (t))

Split* xaccTransGetSplit (const Transaction *trans, int i);

int xaccTransGetSplitIndex(const Transaction *trans, const Split *split);

/*@ dependent @*/
SplitList *   xaccTransGetSplitList (const Transaction *trans);

SplitList *   xaccTransGetPaymentAcctSplitList (const Transaction *trans);

SplitList *   xaccTransGetAPARAcctSplitList (const Transaction *trans, gboolean strict);


gboolean      xaccTransStillHasSplit(const Transaction *trans, const Split *s);

Split *       xaccTransGetFirstPaymentAcctSplit (const Transaction *trans);

Split *       xaccTransGetFirstAPARAcctSplit (const Transaction *trans, gboolean strict);

void          xaccTransSetReadOnly (Transaction *trans, const char *reason);
void          xaccTransClearReadOnly (Transaction *trans);

const char *  xaccTransGetReadOnly (Transaction *trans);

gboolean xaccTransIsReadonlyByPostedDate(const Transaction *trans);

/*################## Added for Reg2 #################*/

gboolean xaccTransInFutureByPostedDate (const Transaction *trans);

/*################## Added for Reg2 #################*/

int           xaccTransCountSplits (const Transaction *trans);

gboolean      xaccTransHasReconciledSplits (const Transaction *trans);
gboolean      xaccTransHasReconciledSplitsByAccount (const Transaction *trans,
        const Account *account);

gboolean      xaccTransHasSplitsInState (const Transaction *trans, const char state);
gboolean      xaccTransHasSplitsInStateByAccount (const Transaction *trans,
        const char state,
        const Account *account);


/*@ dependent @*/
gnc_commodity * xaccTransGetCurrency (const Transaction *trans);

void xaccTransSetCurrency (Transaction *trans, gnc_commodity *curr);

gnc_numeric xaccTransGetImbalanceValue (const Transaction * trans);

MonetaryList *xaccTransGetImbalance (const Transaction * trans);

gboolean xaccTransIsBalanced(const Transaction * trans);

gnc_numeric xaccTransGetAccountValue (const Transaction *trans,
                                      const Account *account);

gnc_numeric xaccTransGetAccountAmount (const Transaction *trans,
                                       const Account *account);

/*################## Added for Reg2 #################*/
/* Gets the amt/val rate, i.e. rate from the transaction currency to
   the 'split_com' */
gboolean
xaccTransGetRateForCommodity(const Transaction *trans,
                             const gnc_commodity *split_com,
                             const Split *split_to_exclude, gnc_numeric *rate);
/*################## Added for Reg2 #################*/

/* Compute the conversion rate for the transaction to this account.
 * Any "split value" (which is in the transaction currency),
 * multiplied by this conversion rate, will give you the value you
 * should display for this account.
 *
 * If 'acc' is NULL, return unity.
 */
gnc_numeric xaccTransGetAccountConvRate(const Transaction *txn, const Account *acc);

gnc_numeric xaccTransGetAccountBalance (const Transaction *trans,
                                        const Account *account);

int  xaccTransOrder     (const Transaction *ta, const Transaction *tb);


int  xaccTransOrder_num_action (const Transaction *ta, const char *actna,
                                const Transaction *tb, const char *actnb);

void          xaccTransSetDate (Transaction *trans,
                                int day, int mon, int year);

void xaccTransSetDatePostedGDate (Transaction *trans, GDate date);

void          xaccTransSetDatePostedSecs (Transaction *trans, time64 time);

void          xaccTransSetDatePostedSecsNormalized (Transaction *trans, time64 time);

void          xaccTransSetDateEnteredSecs (Transaction *trans, time64 time);

void          xaccTransSetDateDue (Transaction * trans, time64 time);

time64        xaccTransGetDate (const Transaction *trans);
time64        xaccTransRetDatePosted   (const Transaction *trans);
GDate      xaccTransGetDatePostedGDate (const Transaction *trans);

/*################## Added for Reg2 #################*/
time64        xaccTransGetDateEntered (const Transaction *trans);
/*################## Added for Reg2 #################*/
time64        xaccTransRetDateEntered (const Transaction *trans);

time64        xaccTransRetDateDue (const Transaction *trans);
/********************************************************************\
 * Miscellaneous utility routines.
\********************************************************************/


void xaccTransVoid(Transaction *transaction,
                   const char *reason);

void xaccTransUnvoid(Transaction *transaction);

Transaction * xaccTransReverse(Transaction *transaction);

Transaction * xaccTransGetReversedBy(const Transaction *trans);

gboolean xaccTransGetVoidStatus(const Transaction *transaction);

const char *xaccTransGetVoidReason(const Transaction *transaction);

time64 xaccTransGetVoidTime(const Transaction *tr);
#define TRANS_KVP       "kvp"
#define TRANS_NUM       "num"
#define TRANS_DESCRIPTION   "desc"
#define TRANS_DATE_ENTERED  "date-entered"
#define TRANS_DATE_POSTED   "date-posted"
#define TRANS_DATE_DUE      "date-due"
#define TRANS_IMBALANCE     "trans-imbalance"
#define TRANS_IS_BALANCED   "trans-balanced?"
#define TRANS_IS_CLOSING        "trans-is-closing?"
#define TRANS_NOTES     "notes"
#define TRANS_DOCLINK       "doclink"
#define TRANS_TYPE      "type"
#define TRANS_VOID_STATUS   "void-p"
#define TRANS_VOID_REASON   "void-reason"
#define TRANS_VOID_TIME     "void-time"
#define TRANS_SPLITLIST     "split-list" /* for guid_match_all */

#ifdef DUMP_FUNCTIONS
void xaccTransDump (const Transaction *trans, const char *tag);
#endif

void xaccTransRecordPrice (Transaction *trans, PriceSource source);


#define RECONCILED_MATCH_TYPE   "reconciled-match"

#define xaccTransGetBook(X)      qof_instance_get_book (QOF_INSTANCE(X))

#define xaccTransGetGUID(X)      qof_entity_get_guid(QOF_INSTANCE(X))

#define xaccTransReturnGUID(X) (X ? *(qof_entity_get_guid(QOF_INSTANCE(X))) : *(guid_null()))

#ifdef __cplusplus
} /* extern "C" */
#endif

#endif /* XACC_TRANSACTION_H */