Split.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_SPLIT_H
#define XACC_SPLIT_H

typedef struct _SplitClass SplitClass;

#include <time.h>

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

/* --- type macros --- */
#define GNC_TYPE_SPLIT            (gnc_split_get_type ())
#define GNC_SPLIT(o)              \
     (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_SPLIT, Split))
#define GNC_SPLIT_CLASS(k)        \
     (G_TYPE_CHECK_CLASS_CAST((k), GNC_TYPE_SPLIT, SplitClass))
#define GNC_IS_SPLIT(o)           \
     (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_SPLIT))
#define GNC_IS_SPLIT_CLASS(k)     \
     (G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_SPLIT))
#define GNC_SPLIT_GET_CLASS(o)    \
     (G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_SPLIT, SplitClass))
GType gnc_split_get_type(void);


#define CREC 'c'              
#define YREC 'y'              
#define FREC 'f'              
#define NREC 'n'              
#define VREC 'v'              
/* Convert the amount/value of the Split for viewing in the account --
 * in particular we want to convert the Split to be in to_commodity.
 * Returns the amount.
 */
gnc_numeric xaccSplitConvertAmount (const Split *split, const Account * account);

/*-----------------------------------------------------------------------
 * Splits
 *-----------------------------------------------------------------------*/

Split       * xaccMallocSplit (QofBook *book);

/* Reinit a previously malloc'd split. Split remains in the book it
   was already in, and the QofInstance portions also remain unchanged.
   It's basically the data elements that are reverted to default
   values. */
void xaccSplitReinit(Split * split);

gboolean      xaccSplitDestroy (Split *split);

QofBook *   xaccSplitGetBook (const Split *split);

Account *     xaccSplitGetAccount (const Split *split);
void xaccSplitSetAccount (Split *s, Account *acc);

Transaction * xaccSplitGetParent (const Split *split);
void xaccSplitSetParent (Split *split, Transaction *trans);

GNCLot *      xaccSplitGetLot (const Split *split);

void xaccSplitSetLot(Split* split, GNCLot* lot);


KvpFrame *xaccSplitGetSlots(const Split *split);

void xaccSplitSetSlots_nc(Split *s, KvpFrame *frm);


void          xaccSplitSetMemo (Split *split, const char *memo);

const char *  xaccSplitGetMemo (const Split *split);

void          xaccSplitSetAction (Split *split, const char *action);

const char *  xaccSplitGetAction (const Split *split);
void          xaccSplitSetReconcile (Split *split, char reconciled_flag);
char          xaccSplitGetReconcile (const Split *split);

void          xaccSplitSetDateReconciledSecs (Split *split, time_t time);
void          xaccSplitSetDateReconciledTS (Split *split, Timespec *ts);
void          xaccSplitGetDateReconciledTS (const Split *split,
        Timespec *ts);
Timespec      xaccSplitRetDateReconciledTS (const Split *split);

void         xaccSplitSetAmount (Split *split, gnc_numeric amount);

gnc_numeric   xaccSplitGetAmount (const Split * split);

void         xaccSplitSetValue (Split *split, gnc_numeric value);

gnc_numeric   xaccSplitGetValue (const Split * split);

void         xaccSplitSetSharePriceAndAmount (Split *split,
        gnc_numeric price,
        gnc_numeric amount);

gnc_numeric   xaccSplitGetSharePrice (const Split * split);

void         xaccSplitSetBaseValue (Split *split, gnc_numeric value,
                                    const gnc_commodity * base_currency);

gnc_numeric xaccSplitGetBaseValue (const Split *split,
                                   const gnc_commodity * base_currency);

gnc_numeric xaccSplitGetBalance (const Split *split);

gnc_numeric xaccSplitGetClearedBalance (const Split *split);

gnc_numeric xaccSplitGetReconciledBalance (const Split *split);

gboolean xaccSplitEqual(const Split *sa, const Split *sb,
                        gboolean check_guids,
                        gboolean check_balances,
                        gboolean check_txn_splits);

Split      * xaccSplitLookup (const GncGUID *guid, QofBook *book);
#define      xaccSplitLookupDirect(g,b) xaccSplitLookup(&(g),b)


Split * xaccSplitGetOtherSplit (const Split *split);

const char *xaccSplitGetType(const Split *s);

void xaccSplitMakeStockSplit(Split *s);

gint xaccSplitOrder (const Split *sa, const Split *sb);
gint xaccSplitOrderDateOnly (const Split *sa, const Split *sb);


/*
 * These functions compare two splits by different criteria.
 *
 * These functions were added because converting strings to guile
 * for comparisons in the transaction report is terribly inefficient.
 * More may be added here in future if it turns out that other types
 * of comparisons also induces guile slowdowns.
 */

int xaccSplitCompareAccountFullNames(const Split *sa, const Split *sb);
int xaccSplitCompareAccountCodes(const Split *sa, const Split *sb);
int xaccSplitCompareOtherAccountFullNames(const Split *sa, const Split *sb);
int xaccSplitCompareOtherAccountCodes(const Split *sa, const Split *sb);


char * xaccSplitGetCorrAccountFullName(const Split *sa);
const char * xaccSplitGetCorrAccountName(const Split *sa);
const char * xaccSplitGetCorrAccountCode(const Split *sa);

#ifdef DUMP_FUNCTIONS
void xaccSplitDump (const Split *split, const char *tag);
#endif

void         xaccSplitSetSharePrice (Split *split, gnc_numeric price);

/********************************************************************\
 * Miscellaneous utility routines.
\********************************************************************/


gnc_numeric xaccSplitVoidFormerAmount(const Split *split);

gnc_numeric xaccSplitVoidFormerValue(const Split *split);

#define SPLIT_KVP               "kvp"

#define SPLIT_DATE_RECONCILED   "date-reconciled"
#define SPLIT_BALANCE           "balance"
#define SPLIT_CLEARED_BALANCE   "cleared-balance"
#define SPLIT_RECONCILED_BALANCE        "reconciled-balance"
#define SPLIT_MEMO              "memo"
#define SPLIT_ACTION            "action"
#define SPLIT_RECONCILE         "reconcile-flag"
#define SPLIT_AMOUNT            "amount"
#define SPLIT_SHARE_PRICE       "share-price"
#define SPLIT_VALUE             "value"
#define SPLIT_TYPE              "type"
#define SPLIT_VOIDED_AMOUNT     "voided-amount"
#define SPLIT_VOIDED_VALUE      "voided-value"
#define SPLIT_LOT               "lot"
#define SPLIT_TRANS             "trans"
#define SPLIT_ACCOUNT           "account"
#define SPLIT_ACCOUNT_GUID      "account-guid" 
/* used for SORTING ONLY */
#define SPLIT_ACCT_FULLNAME     "acct-fullname"
#define SPLIT_CORR_ACCT_NAME    "corr-acct-fullname"
#define SPLIT_CORR_ACCT_CODE    "corr-acct-code"

#define xaccSplitGetGUID(X)      qof_entity_get_guid(QOF_INSTANCE(X))

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

#endif /* XACC_SPLIT_H */