GnuCash  4.14+
Files | Macros | Functions

A good overview of transactions, splits and accounts can be found in the texinfo documentation, together with an overview of how to use this API. More...

Files

file  Split.h
 API for Transactions and Splits (journal entries)
 
file  Transaction.h
 API for Transactions and Splits (journal entries)
 

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))
 
#define xaccSplitGetGUID(X)   qof_entity_get_guid(QOF_INSTANCE(X))
 
#define xaccSplitReturnGUID(X)   (X ? *(qof_entity_get_guid(QOF_INSTANCE(X))) : *(guid_null()))
 
#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))
 
#define GNC_IS_TRANS(obj)   GNC_IS_TRANSACTION(obj)
 
#define GNC_TRANS(obj)   GNC_TRANSACTION(obj)
 
#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()))
 

Functions

GType gnc_split_get_type (void)
 
gnc_numeric xaccSplitConvertAmount (const Split *split, const Account *account)
 
GType gnc_transaction_get_type (void)
 
void xaccTransRecordPrice (Transaction *trans, PriceSource source)
 The xaccTransRecordPrice() method iterates through the splits and and record the non-currency equivalent prices in the price database. More...
 

Split Reconciled field values

If you change these
be sure to change gnc-ui-util.c:gnc_get_reconciled_str() and
associated functions
#define CREC   'c'
 The Split has been cleared.
 
#define YREC   'y'
 The Split has been reconciled.
 
#define FREC   'f'
 frozen into accounting period
 
#define NREC   'n'
 not reconciled or cleared
 
#define VREC   'v'
 split is void
 

Split general getters/setters

Split * xaccMallocSplit (QofBook *book)
 Constructor. More...
 
void xaccSplitReinit (Split *split)
 
gboolean xaccSplitDestroy (Split *split)
 Destructor. More...
 
void xaccSplitCopyOnto (const Split *from_split, Split *to_split)
 This is really a helper for xaccTransCopyOnto. More...
 
QofBook * xaccSplitGetBook (const Split *split)
 Returns the book of this split, i.e. More...
 
AccountxaccSplitGetAccount (const Split *split)
 Returns the account of this split, which was set through xaccAccountInsertSplit(). More...
 
void xaccSplitSetAccount (Split *s, Account *acc)
 
Transaction * xaccSplitGetParent (const Split *split)
 Returns the parent transaction of the split. More...
 
void xaccSplitSetParent (Split *split, Transaction *trans)
 
GNCLot * xaccSplitGetLot (const Split *split)
 Returns the pointer to the debited/credited Lot where this split belongs to, or NULL if it doesn't belong to any. More...
 
void xaccSplitSetLot (Split *split, GNCLot *lot)
 Assigns the split to a specific Lot.
 
void xaccSplitSetMemo (Split *split, const char *memo)
 The memo is an arbitrary string associated with a split. More...
 
const char * xaccSplitGetMemo (const Split *split)
 Returns the memo string. More...
 
void xaccSplitSetAction (Split *split, const char *action)
 The Action is an arbitrary user-assigned string. More...
 
const char * xaccSplitGetAction (const Split *split)
 Returns the action string. More...
 

Split Date getters/setters

void xaccSplitSetReconcile (Split *split, char reconciled_flag)
 Set the reconcile flag. More...
 
char xaccSplitGetReconcile (const Split *split)
 Returns the value of the reconcile flag. More...
 
void xaccSplitSetDateReconciledSecs (Split *split, time64 time)
 Set the date on which this split was reconciled by specifying the time as time64. More...
 
time64 xaccSplitGetDateReconciled (const Split *split)
 Retrieve the date when the Split was reconciled. More...
 

Split amount getters/setters


'value' vs.

'amount' of a Split: The 'value' is the amount of the transaction balancing commodity (i.e. currency) involved, 'amount' is the amount of the account's commodity involved.

void xaccSplitSetAmount (Split *split, gnc_numeric amount)
 The xaccSplitSetAmount() method sets the amount in the account's commodity that the split should have. More...
 
gnc_numeric xaccSplitGetAmount (const Split *split)
 Returns the amount of the split in the account's commodity. More...
 
void xaccSplitSetValue (Split *split, gnc_numeric value)
 The xaccSplitSetValue() method sets the value of this split in the transaction's commodity. More...
 
gnc_numeric xaccSplitGetValue (const Split *split)
 Returns the value of this split in the transaction's commodity. More...
 
void xaccSplitSetSharePriceAndAmount (Split *split, gnc_numeric price, gnc_numeric amount)
 The xaccSplitSetSharePriceAndAmount() method will simultaneously update the share price and the number of shares. More...
 
gnc_numeric xaccSplitGetSharePrice (const Split *split)
 Returns the price of the split, that is, the value divided by the amount. More...
 
void xaccSplitSetBaseValue (Split *split, gnc_numeric value, const gnc_commodity *base_currency)
 Depending on the base_currency, set either the value or the amount of this split or both: If the base_currency is the transaction's commodity, set the value. More...
 
gnc_numeric xaccSplitGetBaseValue (const Split *split, const gnc_commodity *base_currency)
 Depending on the base_currency, return either the value or the amount of this split: If the base_curreny is the transaction's commodity, return the value. More...
 
gnc_numeric xaccSplitGetBalance (const Split *split)
 Returns the running balance up to and including the indicated split. More...
 
gnc_numeric xaccSplitGetNoclosingBalance (const Split *split)
 The noclosing-balance is the currency-denominated balance of all transactions except 'closing' transactions. More...
 
gnc_numeric xaccSplitGetClearedBalance (const Split *split)
 The cleared-balance is the currency-denominated balance of all transactions that have been marked as cleared or reconciled. More...
 
gnc_numeric xaccSplitGetReconciledBalance (const Split *split)
 Returns the reconciled-balance of this split. More...
 

Split utility functions

gboolean xaccSplitEqual (const Split *sa, const Split *sb, gboolean check_guids, gboolean check_balances, gboolean check_txn_splits)
 Equality. More...
 
Split * xaccSplitLookup (const GncGUID *guid, QofBook *book)
 The xaccSplitLookup() subroutine will return the split associated with the given id, or NULL if there is no such split. More...
 
GList * xaccSplitListGetUniqueTransactionsReversed (const GList *splits)
 
GList * xaccSplitListGetUniqueTransactions (const GList *splits)
 
void xaccSplitAddPeerSplit (Split *split, const Split *other_split, const time64 timestamp)
 Add a peer split to this split's lot-split list. More...
 
gboolean xaccSplitHasPeers (const Split *split)
 Does this split have peers?
 
gboolean xaccSplitIsPeerSplit (const Split *split, const Split *other_split)
 Report if a split is a peer of this one. More...
 
void xaccSplitRemovePeerSplit (Split *split, const Split *other_split)
 Remove a peer split from this split's lot-split list. More...
 
void xaccSplitMergePeerSplits (Split *split, const Split *other_split)
 Merge the other_split's peer splits into split's peers. More...
 
Split * xaccSplitGetOtherSplit (const Split *split)
 The xaccSplitGetOtherSplit() is a convenience routine that returns the other of a pair of splits. More...
 
const char * xaccSplitGetType (const Split *s)
 The xaccIsPeerSplit() is a convenience routine that returns TRUE (a non-zero value) if the two splits share a common parent transaction, else it returns FALSE (zero). More...
 
void xaccSplitMakeStockSplit (Split *s)
 Mark a split to be of type stock split - after this, you shouldn't modify the value anymore, just the amount. More...
 
gint xaccSplitOrder (const Split *sa, const Split *sb)
 The xaccSplitOrder(sa,sb) method is useful for sorting. More...
 
gint xaccSplitOrderDateOnly (const Split *sa, const Split *sb)
 
int xaccSplitCompareAccountFullNames (const Split *sa, const Split *sb)
 Compare two splits by full name of account. More...
 
int xaccSplitCompareAccountCodes (const Split *sa, const Split *sb)
 Compare two splits by code of account. More...
 
int xaccSplitCompareOtherAccountFullNames (const Split *sa, const Split *sb)
 Compare two splits by full name of the other account. More...
 
int xaccSplitCompareOtherAccountCodes (const Split *sa, const Split *sb)
 Compare two splits by code of the other account. More...
 
char * xaccSplitGetCorrAccountFullName (const Split *sa)
 These functions take a split, get the corresponding split on the "other side" of the transaction, and extract either the name or code of that split, reverting to returning a constant "Split" if the transaction has more than one split on the "other side". More...
 
const char * xaccSplitGetCorrAccountName (const Split *sa)
 document me
 
const char * xaccSplitGetCorrAccountCode (const Split *sa)
 document me
 
#define xaccSplitLookupDirect(g, b)   xaccSplitLookup(&(g),b)
 

Split deprecated functions

void xaccSplitSetSharePrice (Split *split, gnc_numeric price)
 

Split voiding

gnc_numeric xaccSplitVoidFormerAmount (const Split *split)
 Returns the original pre-void amount of a split. More...
 
gnc_numeric xaccSplitVoidFormerValue (const Split *split)
 Returns the original pre-void value of a split. More...
 

Split Parameter names

Note, if you want to get the equivalent of "ACCT_MATCH_ALL" you need to create a search on the following parameter list: SPLIT->SPLIT_TRANS->TRANS_SPLITLIST->SPLIT_ACCOUNT_GUID.

If you do this, you might want to use the ACCOUNT_MATCH_ALL_TYPE as the override so the gnome-search dialog displays the right type.

#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"
 for guid_match_all
 
#define SPLIT_ACCT_FULLNAME   "acct-fullname"
 
#define SPLIT_CORR_ACCT_NAME   "corr-acct-fullname"
 
#define SPLIT_CORR_ACCT_CODE   "corr-acct-code"
 

Transaction Type field values

#define TXN_TYPE_UNCACHED   '?' /** Transaction type not yet cached */
 
#define TXN_TYPE_NONE   '\0'
 No transaction type.
 
#define TXN_TYPE_INVOICE   'I'
 Transaction is an invoice.
 
#define TXN_TYPE_PAYMENT   'P'
 Transaction is a payment.
 
#define TXN_TYPE_LINK   'L'
 Transaction is a link between (invoice and payment) lots.
 

Transaction creation and editing

Transaction * xaccMallocTransaction (QofBook *book)
 
The xaccMallocTransaction() will malloc memory and initialize it. More...
 
void xaccTransDestroy (Transaction *trans)
 Destroys a transaction. More...
 
Transaction * xaccTransClone (const Transaction *t)
 
The xaccTransClone() method will create a complete copy of an existing transaction.
 
Transaction * xaccTransCloneNoKvp (const Transaction *t)
 
The xaccTransCloneNoKvp() method will create a complete copy of an existing transaction except that the KVP slots will be empty.
 
gboolean xaccTransEqual (const Transaction *ta, const Transaction *tb, gboolean check_guids, gboolean check_splits, gboolean check_balances, gboolean assume_ordered)
 Equality. More...
 
void xaccTransBeginEdit (Transaction *trans)
 The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of its component splits. More...
 
void xaccTransCommitEdit (Transaction *trans)
 The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are complete and should be made permanent. More...
 
void xaccTransRollbackEdit (Transaction *trans)
 The xaccTransRollbackEdit() routine rejects all edits made, and sets the transaction back to where it was before the editing started. More...
 
gboolean xaccTransIsOpen (const Transaction *trans)
 The xaccTransIsOpen() method returns TRUE if the transaction is open for editing. More...
 
Transaction * xaccTransLookup (const GncGUID *guid, QofBook *book)
 The xaccTransLookup() subroutine will return the transaction associated with the given id, or NULL if there is no such transaction. More...
 
Transaction * xaccTransCopyToClipBoard (const Transaction *from_trans)
 Copy a transaction to the 'clipboard' transaction using dupe_transaction. More...
 
void xaccTransCopyOnto (const Transaction *from_trans, Transaction *to_trans)
 Copy a transaction to another using the function below without changing any account information.
 
void xaccTransCopyFromClipBoard (const Transaction *from_trans, Transaction *to_trans, const Account *from_acc, Account *to_acc, gboolean no_date)
 This function explicitly must robustly handle some unusual input. More...
 
Split * xaccTransFindSplitByAccount (const Transaction *trans, const Account *acc)
 
void xaccTransScrubGains (Transaction *trans, Account *gain_acc)
 The xaccTransScrubGains() routine performs a number of cleanup functions on the indicated transaction, with the end-goal of setting up a consistent set of gains/losses for all the splits in the transaction. More...
 
guint gnc_book_count_transactions (QofBook *book)
 
#define xaccTransLookupDirect(g, b)   xaccTransLookup(&(g),b)
 

Transaction general getters/setters

gboolean xaccTransUseTradingAccounts (const Transaction *trans)
 Determine whether this transaction should use commodity trading accounts.
 
void xaccTransSortSplits (Transaction *trans)
 Sorts the splits in a transaction, putting the debits first, followed by the credits.
 
void xaccTransSetTxnType (Transaction *trans, char type)
 Set the Transaction Type: note the type will be saved into the Transaction kvp property as a backward compatibility measure, for previous GnuCash versions whose xaccTransGetTxnType reads from the kvp slots. More...
 
char xaccTransGetTxnType (Transaction *trans)
 Returns the Transaction Type: note this type will be derived from the transaction splits, returning TXN_TYPE_NONE, TXN_TYPE_INVOICE, TXN_TYPE_LINK, or TXN_TYPE_PAYMENT according to heuristics. More...
 
void xaccTransSetNum (Transaction *trans, const char *num)
 Sets the transaction Number (or ID) field; rather than use this function directly, see 'gnc_set_num_action' in engine/engine-helpers.c & .h which takes a user-set book option for selecting the source for the num-cell (the transaction-number or the split-action field) in registers/reports into account automatically.
 
void xaccTransSetDescription (Transaction *trans, const char *desc)
 Sets the transaction Description.
 
void xaccTransSetDocLink (Transaction *trans, const char *doclink)
 Sets the transaction Document Link.
 
void xaccTransSetNotes (Transaction *trans, const char *notes)
 Sets the transaction Notes. More...
 
const char * xaccTransGetNum (const Transaction *trans)
 Gets the transaction Number (or ID) field; rather than use this function directly, see 'gnc_get_num_action' and 'gnc_get_action_num' in engine/engine-helpers.c & .h which takes a user-set book option for selecting the source for the num-cell (the transaction-number or the split-action field) in registers/reports into account automatically.
 
const char * xaccTransGetDescription (const Transaction *trans)
 Gets the transaction Description.
 
const char * xaccTransGetDocLink (const Transaction *trans)
 Gets the transaction Document Link.
 
const char * xaccTransGetNotes (const Transaction *trans)
 Gets the transaction Notes. More...
 
void xaccTransSetIsClosingTxn (Transaction *trans, gboolean is_closing)
 Sets whether or not this transaction is a "closing transaction".
 
gboolean xaccTransGetIsClosingTxn (const Transaction *trans)
 Returns whether this transaction is a "closing transaction".
 
Split * xaccTransGetSplit (const Transaction *trans, int i)
 Return a pointer to the indexed split in this transaction's split list. More...
 
int xaccTransGetSplitIndex (const Transaction *trans, const Split *split)
 Inverse of xaccTransGetSplit()
 
SplitListxaccTransGetSplitList (const Transaction *trans)
 The xaccTransGetSplitList() method returns a GList of the splits in a transaction. More...
 
SplitListxaccTransGetPaymentAcctSplitList (const Transaction *trans)
 The xaccTransGetPaymentAcctSplitList() method returns a GList of the splits in a transaction that belong to an account which is considered a valid account for business payments. More...
 
SplitListxaccTransGetAPARAcctSplitList (const Transaction *trans, gboolean strict)
 The xaccTransGetAPARSplitList() method returns a GList of the splits in a transaction that belong to an AR or AP account. More...
 
gboolean xaccTransStillHasSplit (const Transaction *trans, const Split *s)
 
Split * xaccTransGetFirstPaymentAcctSplit (const Transaction *trans)
 The xaccTransGetFirstPaymentAcctSplit() method returns a pointer to the first split in this transaction that belongs to an account which is considered a valid account for business payments. More...
 
Split * xaccTransGetFirstAPARAcctSplit (const Transaction *trans, gboolean strict)
 The xaccTransGetFirstPaymentAcctSplit() method returns a pointer to the first split in this transaction that belongs to an AR or AP account. More...
 
void xaccTransSetReadOnly (Transaction *trans, const char *reason)
 Set the transaction to be ReadOnly by setting a non-NULL value as "reason". More...
 
void xaccTransClearReadOnly (Transaction *trans)
 
const char * xaccTransGetReadOnly (Transaction *trans)
 Returns a non-NULL value if this Transaction was marked as read-only with some specific "reason" text. More...
 
gboolean xaccTransIsReadonlyByPostedDate (const Transaction *trans)
 Returns TRUE if this Transaction is read-only because its posted-date is older than the "auto-readonly" threshold of this book. More...
 
gboolean xaccTransInFutureByPostedDate (const Transaction *trans)
 Returns TRUE if this Transaction's posted-date is in the future.
 
int xaccTransCountSplits (const Transaction *trans)
 Returns the number of splits in this transaction. More...
 
gboolean xaccTransHasReconciledSplits (const Transaction *trans)
 FIXME: document me.
 
gboolean xaccTransHasReconciledSplitsByAccount (const Transaction *trans, const Account *account)
 FIXME: document me.
 
gboolean xaccTransHasSplitsInState (const Transaction *trans, const char state)
 FIXME: document me.
 
gboolean xaccTransHasSplitsInStateByAccount (const Transaction *trans, const char state, const Account *account)
 FIXME: document me.
 
gnc_commodity * xaccTransGetCurrency (const Transaction *trans)
 Returns the valuation commodity of this transaction. More...
 
void xaccTransSetCurrency (Transaction *trans, gnc_commodity *curr)
 Set the commodity of this transaction. More...
 
gnc_numeric xaccTransGetImbalanceValue (const Transaction *trans)
 The xaccTransGetImbalanceValue() method returns the total value of the transaction. More...
 
MonetaryList * xaccTransGetImbalance (const Transaction *trans)
 The xaccTransGetImbalance method returns a list giving the value of the transaction in each currency for which the balance is not zero. More...
 
gboolean xaccTransIsBalanced (const Transaction *trans)
 Returns true if the transaction is balanced according to the rules currently in effect. More...
 
gnc_numeric xaccTransGetAccountValue (const Transaction *trans, const Account *account)
 The xaccTransGetAccountValue() method returns the total value applied to a particular account. More...
 
gnc_numeric xaccTransGetAccountAmount (const Transaction *trans, const Account *account)
 Same as xaccTransGetAccountValue, but uses the Account's commodity. More...
 
gboolean xaccTransGetRateForCommodity (const Transaction *trans, const gnc_commodity *split_com, const Split *split_to_exclude, gnc_numeric *rate)
 
gnc_numeric xaccTransGetAccountConvRate (const Transaction *txn, const Account *acc)
 
gnc_numeric xaccTransGetAccountBalance (const Transaction *trans, const Account *account)
 Get the account balance for the specified account after the last split in the specified transaction. More...
 
int xaccTransOrder (const Transaction *ta, const Transaction *tb)
 The xaccTransOrder(ta,tb) method is useful for sorting. More...
 
int xaccTransOrder_num_action (const Transaction *ta, const char *actna, const Transaction *tb, const char *actnb)
 The xaccTransOrder_num_action(ta,actna,tb,actnb) method is useful for sorting. More...
 
#define xaccTransAppendSplit(t, s)   xaccSplitSetParent((s), (t))
 Add a split to the transaction. More...
 

Transaction date setters/getters

void xaccTransSetDate (Transaction *trans, int day, int mon, int year)
 The xaccTransSetDate() method does the same thing as xaccTransSetDate[Posted]Secs(), but takes a convenient day-month-year format. More...
 
void xaccTransSetDatePostedGDate (Transaction *trans, GDate date)
 This method modifies posted date of the transaction, specified by a GDate. More...
 
void xaccTransSetDatePostedSecs (Transaction *trans, time64 time)
 The xaccTransSetDatePostedSecs() method will modify the posted date of the transaction, specified by a time64 (see ctime(3)). More...
 
void xaccTransSetDatePostedSecsNormalized (Transaction *trans, time64 time)
 This function sets the posted date of the transaction, specified by a time64 (see ctime(3)). More...
 
void xaccTransSetDateEnteredSecs (Transaction *trans, time64 time)
 Modify the date of when the transaction was entered. More...
 
void xaccTransSetDateDue (Transaction *trans, time64 time)
 Dates and txn-type for A/R and A/P "invoice" postings.
 
time64 xaccTransGetDate (const Transaction *trans)
 Retrieve the posted date of the transaction. More...
 
time64 xaccTransRetDatePosted (const Transaction *trans)
 Retrieve the posted date of the transaction. More...
 
GDate xaccTransGetDatePostedGDate (const Transaction *trans)
 Retrieve the posted date of the transaction. More...
 
time64 xaccTransGetDateEntered (const Transaction *trans)
 Retrieve the date of when the transaction was entered. More...
 
time64 xaccTransRetDateEntered (const Transaction *trans)
 Retrieve the date of when the transaction was entered. More...
 
time64 xaccTransRetDateDue (const Transaction *trans)
 Dates and txn-type for A/R and A/P "invoice" postings.
 

Transaction voiding

void xaccTransVoid (Transaction *transaction, const char *reason)
 xaccTransVoid voids a transaction. More...
 
void xaccTransUnvoid (Transaction *transaction)
 xaccTransUnvoid restores a voided transaction to its original state. More...
 
Transaction * xaccTransReverse (Transaction *transaction)
 xaccTransReverse creates a Transaction that reverses the given transaction by inverting all the numerical values in the given transaction. More...
 
Transaction * xaccTransGetReversedBy (const Transaction *trans)
 Returns the transaction that reversed the given transaction. More...
 
gboolean xaccTransGetVoidStatus (const Transaction *transaction)
 Retrieve information on whether or not a transaction has been voided. More...
 
const char * xaccTransGetVoidReason (const Transaction *transaction)
 Returns the user supplied textual reason why a transaction was voided. More...
 
time64 xaccTransGetVoidTime (const Transaction *tr)
 Returns the time that a transaction was voided. More...
 

Transaction Parameter names

#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 */
 

Detailed Description

A good overview of transactions, splits and accounts can be found in the texinfo documentation, together with an overview of how to use this API.

Splits, or "Ledger Entries" are the fundamental accounting units. Each Split consists of an amount (number of dollar bills, number of shares, etc.), the value of that amount expressed in a (possibly) different currency than the amount, a Memo, a pointer to the parent Transaction, a pointer to the debited Account, a reconciled flag and timestamp, an "Action" field, and a key-value frame which can store arbitrary data.

Transactions embody the notion of "double entry" accounting. A Transaction consists of a date, a description, an ID number, a list of one or more Splits, and a key-value frame. The transaction also specifies the currency with which all of the splits will be valued. When double-entry rules are enforced, the sum total value of the splits are zero. If there are only two splits, then the value of one must be positive, the other negative: this denotes that one account is debited, and another is credited by an equal amount. By forcing the value of the splits to always 'add up' to zero, we can guarantee that the balances of the accounts are always correctly balanced.

The engine does not enforce double-entry accounting, but provides an API to enable user-code to find unbalanced transactions and 'repair' them so that they are in balance.

Note the sum of the values of Splits in a Transaction is always computed with respect to a currency; thus splits can be balanced even when they are in different currencies, as long as they share a common currency. This feature allows currency-trading accounts to be established.

Every Split must point to its parent Transaction, and that Transaction must in turn include that Split in the Transaction's list of Splits. A Split can belong to at most one Transaction. These relationships are enforced by the engine. The engine user cannot accidentally destroy this relationship as long as they stick to using the API and never access internal structures directly.

Splits are grouped into Accounts which are also known as "Ledgers" in accounting practice. Each Account consists of a list of Splits that debit that Account. To ensure consistency, if a Split points to an Account, then the Account must point to the Split, and vice-versa. A Split can belong to at most one Account. Besides merely containing a list of Splits, the Account structure also gives the Account a name, a code number, description and notes fields, a key-value frame, a pointer to the commodity that is used for all splits in this account. The commodity can be the name of anything traded and tradable: a stock (e.g. "IBM", "McDonald's"), a currency (e.g. "USD", "GBP"), or anything added to the commodity table.

Accounts can be arranged in a hierarchical tree. The nodes of the tree are called "Account Groups". By accounting convention, the value of an Account is equal to the value of all of its Splits plus the value of all of its sub-Accounts.

Macro Definition Documentation

◆ xaccSplitGetGUID

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

Definition at line 554 of file Split.h.

◆ xaccSplitReturnGUID

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

Definition at line 556 of file Split.h.

◆ xaccTransAppendSplit

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

Add a split to the transaction.

The xaccTransAppendSplit() method will append the indicated split to the collection of splits in this transaction.

Note
If the split is already a part of another transaction, it will be removed from that transaction first.

Definition at line 370 of file Transaction.h.

◆ xaccTransGetBook

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

Definition at line 791 of file Transaction.h.

◆ xaccTransGetGUID

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

Definition at line 793 of file Transaction.h.

◆ xaccTransReturnGUID

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

Definition at line 795 of file Transaction.h.

Function Documentation

◆ gnc_book_count_transactions()

guint gnc_book_count_transactions ( QofBook *  book)
Warning
XXX FIXME gnc_book_count_transactions is a utility function, probably needs to be moved to a utility file somewhere.

Definition at line 2721 of file Transaction.c.

2722 {
2723  guint count = 0;
2724  xaccAccountTreeForEachTransaction(gnc_book_get_root_account(book),
2725  counter_thunk, (void*)&count);
2726  return count;
2727 }
int xaccAccountTreeForEachTransaction(Account *acc, TransactionCallback proc, void *data)
Traverse all of the transactions in the given account group.

◆ xaccMallocSplit()

Split* xaccMallocSplit ( QofBook *  book)

Constructor.

Definition at line 37 of file gmock-Split.cpp.

38 {
39  SCOPED_TRACE("");
40  QofMockBook* mockbook = qof_mockbook(book);
41  return mockbook ? mockbook->malloc_split() : nullptr;
42 }

◆ xaccMallocTransaction()

Transaction* xaccMallocTransaction ( QofBook *  book)


The xaccMallocTransaction() will malloc memory and initialize it.

Once created, it is usually unsafe to merely "free" this memory; the xaccTransDestroy() method should be called.

Definition at line 503 of file Transaction.c.

504 {
505  Transaction *trans;
506 
507  g_return_val_if_fail (book, NULL);
508 
509  trans = g_object_new(GNC_TYPE_TRANSACTION, NULL);
510  xaccInitTransaction (trans, book);
511  qof_event_gen (&trans->inst, QOF_EVENT_CREATE, NULL);
512 
513  return trans;
514 }
void qof_event_gen(QofInstance *entity, QofEventId event_id, gpointer event_data)
Invoke all registered event handlers using the given arguments.
Definition: qofevent.cpp:231

◆ xaccSplitAddPeerSplit()

void xaccSplitAddPeerSplit ( Split *  split,
const Split *  other_split,
const time64  timestamp 
)

Add a peer split to this split's lot-split list.

Parameters
other_splitThe split whose guid to add
timestampThe time to be recorded for the split.

Definition at line 2014 of file Split.c.

2016 {
2017  const GncGUID* guid;
2018 
2019  g_return_if_fail (split != NULL);
2020  g_return_if_fail (other_split != NULL);
2021 
2022  guid = qof_instance_get_guid (QOF_INSTANCE (other_split));
2023  xaccTransBeginEdit (split->parent);
2024  qof_instance_kvp_add_guid (QOF_INSTANCE (split), "lot-split",
2025  gnc_time(NULL), "peer_guid", guid_copy(guid));
2026  mark_split (split);
2027  qof_instance_set_dirty (QOF_INSTANCE (split));
2028  xaccTransCommitEdit (split->parent);
2029 }
const GncGUID * qof_instance_get_guid(gconstpointer inst)
Return the GncGUID of this instance.
GncGUID * guid_copy(const GncGUID *guid)
Returns a newly allocated GncGUID that matches the passed-in GUID.
Definition: guid.cpp:121
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
time64 gnc_time(time64 *tbuf)
get the current local time
Definition: gnc-date.cpp:273
The type used to store guids in C.
Definition: guid.h:75

◆ xaccSplitCompareAccountCodes()

int xaccSplitCompareAccountCodes ( const Split *  sa,
const Split *  sb 
)

Compare two splits by code of account.

Returns similar to strcmp.

Definition at line 1671 of file Split.c.

1672 {
1673  Account *aa, *ab;
1674  if (!sa && !sb) return 0;
1675  if (!sa) return -1;
1676  if (!sb) return 1;
1677 
1678  aa = sa->acc;
1679  ab = sb->acc;
1680 
1681  return g_strcmp0(xaccAccountGetCode(aa), xaccAccountGetCode(ab));
1682 }
const char * xaccAccountGetCode(const Account *acc)
Get the account's accounting code.
Definition: Account.cpp:3362

◆ xaccSplitCompareAccountFullNames()

int xaccSplitCompareAccountFullNames ( const Split *  sa,
const Split *  sb 
)

Compare two splits by full name of account.

Returns similar to strcmp.

Definition at line 1650 of file Split.c.

1651 {
1652  Account *aa, *ab;
1653  char *full_a, *full_b;
1654  int retval;
1655  if (!sa && !sb) return 0;
1656  if (!sa) return -1;
1657  if (!sb) return 1;
1658 
1659  aa = sa->acc;
1660  ab = sb->acc;
1661  full_a = gnc_account_get_full_name(aa);
1662  full_b = gnc_account_get_full_name(ab);
1663  retval = g_utf8_collate(full_a, full_b);
1664  g_free(full_a);
1665  g_free(full_b);
1666  return retval;
1667 }
gchar * gnc_account_get_full_name(const Account *account)
The gnc_account_get_full_name routine returns the fully qualified name of the account using the given...
Definition: Account.cpp:3314

◆ xaccSplitCompareOtherAccountCodes()

int xaccSplitCompareOtherAccountCodes ( const Split *  sa,
const Split *  sb 
)

Compare two splits by code of the other account.

Returns similar to strcmp. This function attempts to find the split on the other side of a transaction and compare on it.

Definition at line 1706 of file Split.c.

1707 {
1708  const char *ca, *cb;
1709  if (!sa && !sb) return 0;
1710  if (!sa) return -1;
1711  if (!sb) return 1;
1712 
1713  ca = xaccSplitGetCorrAccountCode(sa);
1714  cb = xaccSplitGetCorrAccountCode(sb);
1715  return g_strcmp0(ca, cb);
1716 }
const char * xaccSplitGetCorrAccountCode(const Split *sa)
document me
Definition: Split.c:1633

◆ xaccSplitCompareOtherAccountFullNames()

int xaccSplitCompareOtherAccountFullNames ( const Split *  sa,
const Split *  sb 
)

Compare two splits by full name of the other account.

Returns similar to strcmp. This function attempts to find the split on the other side of a transaction and compare on it.

Definition at line 1685 of file Split.c.

1686 {
1687  char *ca, *cb;
1688  int retval;
1689  if (!sa && !sb) return 0;
1690  if (!sa) return -1;
1691  if (!sb) return 1;
1692 
1693  /* doesn't matter what separator we use
1694  * as long as they are the same
1695  */
1696 
1699  retval = g_strcmp0(ca, cb);
1700  g_free(ca);
1701  g_free(cb);
1702  return retval;
1703 }
char * xaccSplitGetCorrAccountFullName(const Split *sa)
These functions take a split, get the corresponding split on the "other side" of the transaction...
Definition: Split.c:1617

◆ xaccSplitCopyOnto()

void xaccSplitCopyOnto ( const Split *  from_split,
Split *  to_split 
)

This is really a helper for xaccTransCopyOnto.

It doesn't reparent the 'to' split to from's transaction, because xaccTransCopyOnto is responsible for parenting the split to the correct transaction. Also, from's parent transaction may not even be a valid transaction, so this function may not modify anything about 'from' or from's transaction.

Definition at line 641 of file Split.c.

642 {
643  if (!from_split || !to_split) return;
644  xaccTransBeginEdit (to_split->parent);
645 
646  xaccSplitSetMemo(to_split, xaccSplitGetMemo(from_split));
647  xaccSplitSetAction(to_split, xaccSplitGetAction(from_split));
648  xaccSplitSetAmount(to_split, xaccSplitGetAmount(from_split));
649  xaccSplitSetValue(to_split, xaccSplitGetValue(from_split));
650  /* Setting the account is okay here because, even though the from
651  split might not really belong to the account it claims to,
652  setting the account won't cause any event involving from. */
653  xaccSplitSetAccount(to_split, xaccSplitGetAccount(from_split));
654  /* N.B. Don't set parent. */
655 
656  qof_instance_set_dirty(QOF_INSTANCE(to_split));
657  xaccTransCommitEdit(to_split->parent);
658 }
void xaccSplitSetValue(Split *s, gnc_numeric amt)
The xaccSplitSetValue() method sets the value of this split in the transaction's commodity.
Definition: Split.c:1264
void xaccSplitSetAction(Split *split, const char *actn)
The Action is an arbitrary user-assigned string.
Definition: Split.c:1745
void xaccSplitSetAmount(Split *s, gnc_numeric amt)
The xaccSplitSetAmount() method sets the amount in the account's commodity that the split should have...
Definition: Split.c:1228
void xaccSplitSetMemo(Split *split, const char *memo)
The memo is an arbitrary string associated with a split.
Definition: Split.c:1726
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction's commodity.
Definition: Split.c:1919
Account * xaccSplitGetAccount(const Split *s)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: Split.c:938
const char * xaccSplitGetMemo(const Split *split)
Returns the memo string.
Definition: Split.c:1894
const char * xaccSplitGetAction(const Split *split)
Returns the action string.
Definition: Split.c:1900
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account's commodity.
Definition: Split.c:1913

◆ xaccSplitDestroy()

gboolean xaccSplitDestroy ( Split *  split)

Destructor.

The xaccSplitDestroy() method will update its parent account and transaction in a consistent manner, resulting in the complete unlinking of the split, and the freeing of its associated memory. The goal of this routine is to perform the removal and destruction of the split in an atomic fashion, with no chance of accidentally leaving the accounting structure out-of-balance or otherwise inconsistent.

If the deletion of the split leaves the transaction with no splits, then the transaction will be marked for deletion. (It will not be deleted until the xaccTransCommitEdit() routine is called.)

Returns
TRUE upon successful deletion of the split. FALSE when the parenting Transaction is a read-only one.

Definition at line 1468 of file Split.c.

1469 {
1470  Account *acc;
1471  Transaction *trans;
1472  GncEventData ed;
1473 
1474  if (!split) return TRUE;
1475 
1476  acc = split->acc;
1477  trans = split->parent;
1478  if (acc && !qof_instance_get_destroying(acc)
1479  && !qof_instance_get_destroying(trans)
1480  && xaccTransGetReadOnly(trans))
1481  return FALSE;
1482 
1483  xaccTransBeginEdit(trans);
1484  ed.node = split;
1485  ed.idx = xaccTransGetSplitIndex(trans, split);
1486  qof_instance_set_dirty(QOF_INSTANCE(split));
1487  qof_instance_set_destroying(split, TRUE);
1488  qof_event_gen(&trans->inst, GNC_EVENT_ITEM_REMOVED, &ed);
1489  xaccTransCommitEdit(trans);
1490 
1491  return TRUE;
1492 }
const char * xaccTransGetReadOnly(Transaction *trans)
Returns a non-NULL value if this Transaction was marked as read-only with some specific "reason" text...
Definition: Transaction.c:2547
gboolean qof_instance_get_destroying(gconstpointer ptr)
Retrieve the flag that indicates whether or not this object is about to be destroyed.
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
int xaccTransGetSplitIndex(const Transaction *trans, const Split *split)
Inverse of xaccTransGetSplit()
Definition: Transaction.c:2269
void qof_event_gen(QofInstance *entity, QofEventId event_id, gpointer event_data)
Invoke all registered event handlers using the given arguments.
Definition: qofevent.cpp:231

◆ xaccSplitEqual()

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

Equality.

Parameters
saFirst split to compare
sbSecond split to compare
check_guidsIf TRUE, try a guid_equal() on the GUIDs of both splits if their pointers are not equal in the first place.
check_balancesIf TRUE, compare balances between the two splits. Balances are recalculated whenever a split is added or removed from an account, so YMMV on whether this should be set.
check_txn_splitsIf the pointers are not equal, but everything else so far is equal (including memo, amount, value, kvp), then, when comparing the parenting transactions with xaccTransEqual(), set its argument check_splits to be TRUE.

Definition at line 771 of file Split.c.

775 {
776  gboolean same_book;
777 
778  if (!sa && !sb) return TRUE; /* Arguable. FALSE is better, methinks */
779 
780  if (!sa || !sb)
781  {
782  PINFO ("one is NULL");
783  return FALSE;
784  }
785 
786  if (sa == sb) return TRUE;
787 
788  same_book = qof_instance_get_book(QOF_INSTANCE(sa)) == qof_instance_get_book(QOF_INSTANCE(sb));
789 
790  if (check_guids)
791  {
792  if (qof_instance_guid_compare(sa, sb) != 0)
793  {
794  PINFO ("GUIDs differ");
795  return FALSE;
796  }
797  }
798 
799  /* If the same book, since these strings are cached we can just use pointer equality */
800  if ((same_book && sa->memo != sb->memo) || (!same_book && g_strcmp0(sa->memo, sb->memo) != 0))
801  {
802  PINFO ("memos differ: (%p)%s vs (%p)%s",
803  sa->memo, sa->memo, sb->memo, sb->memo);
804  return FALSE;
805  }
806 
807  if ((same_book && sa->action != sb->action) || (!same_book && g_strcmp0(sa->action, sb->action) != 0))
808  {
809  PINFO ("actions differ: %s vs %s", sa->action, sb->action);
810  return FALSE;
811  }
812 
813  if (qof_instance_compare_kvp (QOF_INSTANCE (sa), QOF_INSTANCE (sb)) != 0)
814  {
815  char *frame_a;
816  char *frame_b;
817 
818  frame_a = qof_instance_kvp_as_string (QOF_INSTANCE (sa));
819  frame_b = qof_instance_kvp_as_string (QOF_INSTANCE (sb));
820 
821  PINFO ("kvp frames differ:\n%s\n\nvs\n\n%s", frame_a, frame_b);
822 
823  g_free (frame_a);
824  g_free (frame_b);
825 
826  return FALSE;
827  }
828 
829  if (sa->reconciled != sb->reconciled)
830  {
831  PINFO ("reconcile flags differ: %c vs %c", sa->reconciled, sb->reconciled);
832  return FALSE;
833  }
834 
835  if (sa->date_reconciled != sb->date_reconciled)
836  {
837  PINFO ("reconciled date differs");
838  return FALSE;
839  }
840 
842  {
843  char *str_a;
844  char *str_b;
845 
848 
849  PINFO ("amounts differ: %s vs %s", str_a, str_b);
850 
851  g_free (str_a);
852  g_free (str_b);
853 
854  return FALSE;
855  }
856 
858  {
859  char *str_a;
860  char *str_b;
861 
864 
865  PINFO ("values differ: %s vs %s", str_a, str_b);
866 
867  g_free (str_a);
868  g_free (str_b);
869 
870  return FALSE;
871  }
872 
873  if (check_balances)
874  {
875  if (!xaccSplitEqualCheckBal ("", sa->balance, sb->balance))
876  return FALSE;
877  if (!xaccSplitEqualCheckBal ("cleared ", sa->cleared_balance,
878  sb->cleared_balance))
879  return FALSE;
880  if (!xaccSplitEqualCheckBal ("reconciled ", sa->reconciled_balance,
881  sb->reconciled_balance))
882  return FALSE;
883  if (!xaccSplitEqualCheckBal ("noclosing ", sa->noclosing_balance,
884  sb->noclosing_balance))
885  return FALSE;
886  }
887 
888  if (!xaccTransEqual(sa->parent, sb->parent, check_guids, check_txn_splits,
889  check_balances, FALSE))
890  {
891  PINFO ("transactions differ");
892  return FALSE;
893  }
894 
895  return TRUE;
896 }
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.
#define PINFO(format, args...)
Print an informational note.
Definition: qoflog.h:256
gchar * gnc_numeric_to_string(gnc_numeric n)
Convert to string.
gboolean xaccTransEqual(const Transaction *ta, const Transaction *tb, gboolean check_guids, gboolean check_splits, gboolean check_balances, gboolean assume_ordered)
Equality.
Definition: Transaction.c:858
gboolean gnc_numeric_eq(gnc_numeric a, gnc_numeric b)
Equivalence predicate: Returns TRUE (1) if a and b are exactly the same (have the same numerator and ...
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction's commodity.
Definition: Split.c:1919
gint qof_instance_guid_compare(gconstpointer ptr1, gconstpointer ptr2)
Compare the GncGUID values of two instances.
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account's commodity.
Definition: Split.c:1913

◆ xaccSplitGetAccount()

Account* xaccSplitGetAccount ( const Split *  split)

Returns the account of this split, which was set through xaccAccountInsertSplit().

Definition at line 53 of file gmock-Split.cpp.

54 {
55  SCOPED_TRACE("");
56  auto mocksplit = gnc_mocksplit(split);
57  return mocksplit ? mocksplit->get_account() : nullptr;
58 }

◆ xaccSplitGetAction()

const char* xaccSplitGetAction ( const Split *  split)

Returns the action string.

Rather than use this function directly, see 'gnc_get_num_action' and 'gnc_get_action_num'in engine/engine-helpers.c & .h which takes a user-set book option for selecting the source for the num-cell (the transaction-number or the split-action field) in registers/reports into account automatically

Definition at line 129 of file gmock-Split.cpp.

130 {
131  SCOPED_TRACE("");
132  auto mocksplit = gnc_mocksplit(split);
133  return mocksplit ? mocksplit->get_action() : "";
134 }

◆ xaccSplitGetAmount()

gnc_numeric xaccSplitGetAmount ( const Split *  split)

Returns the amount of the split in the account's commodity.

Note that for cap-gains splits, this is slaved to the transaction that is causing the gains to occur.

Definition at line 69 of file gmock-Split.cpp.

70 {
71  SCOPED_TRACE("");
72  auto mocksplit = gnc_mocksplit(split);
73  return mocksplit ? mocksplit->get_amount() : gnc_numeric_zero();
74 }

◆ xaccSplitGetBalance()

gnc_numeric xaccSplitGetBalance ( const Split *  split)

Returns the running balance up to and including the indicated split.

The balance is the currency-denominated balance. For accounts with non-unit share prices, it is correctly adjusted for share prices.

Returns the running balance up to & including the indicated split.

Definition at line 1293 of file Split.c.

1294 {
1295  return s ? s->balance : gnc_numeric_zero();
1296 }

◆ xaccSplitGetBaseValue()

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

Depending on the base_currency, return either the value or the amount of this split: If the base_curreny is the transaction's commodity, return the value.

If it is the account's commodity, return the amount. If it is neither print a warning message and return gnc_numeric_zero().

Definition at line 1372 of file Split.c.

1373 {
1374  if (!s || !s->acc || !s->parent) return gnc_numeric_zero();
1375 
1376  /* be more precise -- the value depends on the currency we want it
1377  * expressed in. */
1378  if (gnc_commodity_equiv(xaccTransGetCurrency(s->parent), base_currency))
1379  return xaccSplitGetValue(s);
1380  if (gnc_commodity_equiv(xaccAccountGetCommodity(s->acc), base_currency))
1381  return xaccSplitGetAmount(s);
1382 
1383  PERR ("inappropriate base currency %s "
1384  "given split currency=%s and commodity=%s\n",
1385  gnc_commodity_get_printname(base_currency),
1388  return gnc_numeric_zero();
1389 }
#define PERR(format, args...)
Log a serious error.
Definition: qoflog.h:244
const char * gnc_commodity_get_printname(const gnc_commodity *cm)
Retrieve the 'print' name for the specified commodity.
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction's commodity.
Definition: Split.c:1919
gnc_commodity * xaccAccountGetCommodity(const Account *acc)
Get the account's commodity.
Definition: Account.cpp:3454
gnc_commodity * xaccTransGetCurrency(const Transaction *trans)
Returns the valuation commodity of this transaction.
Definition: Transaction.c:1350
gboolean gnc_commodity_equiv(const gnc_commodity *a, const gnc_commodity *b)
This routine returns TRUE if the two commodities are equivalent.
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account's commodity.
Definition: Split.c:1913

◆ xaccSplitGetBook()

QofBook* xaccSplitGetBook ( const Split *  split)

Returns the book of this split, i.e.

the entity where this split is stored.

Definition at line 45 of file gmock-Split.cpp.

46 {
47  SCOPED_TRACE("");
48  auto mocksplit = gnc_mocksplit(split);
49  return mocksplit ? mocksplit->get_book() : nullptr;
50 }

◆ xaccSplitGetClearedBalance()

gnc_numeric xaccSplitGetClearedBalance ( const Split *  split)

The cleared-balance is the currency-denominated balance of all transactions that have been marked as cleared or reconciled.

It is correctly adjusted for price fluctuations.

Returns the running balance up to & including the indicated split.

Definition at line 1305 of file Split.c.

1306 {
1307  return s ? s->cleared_balance : gnc_numeric_zero();
1308 }

◆ xaccSplitGetCorrAccountFullName()

char* xaccSplitGetCorrAccountFullName ( const Split *  sa)

These functions take a split, get the corresponding split on the "other side" of the transaction, and extract either the name or code of that split, reverting to returning a constant "Split" if the transaction has more than one split on the "other side".

These were added for the transaction report, and is in C because the code was already written in C for the above functions and duplication is silly.

Note that this will only return a real value in case of a two-split transaction as that is the only situation in which a reliable value can be returned. In other situations "-- Split Transaction --" will be returned as Account Name or "Split" for Account Code.

Definition at line 1617 of file Split.c.

1618 {
1619  static const char *split_const = NULL;
1620  const Split *other_split;
1621 
1622  if (!get_corr_account_split(sa, &other_split))
1623  {
1624  if (!split_const)
1625  split_const = _("-- Split Transaction --");
1626 
1627  return g_strdup(split_const);
1628  }
1629  return gnc_account_get_full_name(other_split->acc);
1630 }
gchar * gnc_account_get_full_name(const Account *account)
The gnc_account_get_full_name routine returns the fully qualified name of the account using the given...
Definition: Account.cpp:3314

◆ xaccSplitGetDateReconciled()

time64 xaccSplitGetDateReconciled ( const Split *  split)

Retrieve the date when the Split was reconciled.

Definition at line 1818 of file Split.c.

1819 {
1820  return split ? split->date_reconciled : 0;
1821 }

◆ xaccSplitGetLot()

GNCLot* xaccSplitGetLot ( const Split *  split)

Returns the pointer to the debited/credited Lot where this split belongs to, or NULL if it doesn't belong to any.

Definition at line 1879 of file Split.c.

1880 {
1881  return split ? split->lot : NULL;
1882 }

◆ xaccSplitGetMemo()

const char* xaccSplitGetMemo ( const Split *  split)

Returns the memo string.

Definition at line 99 of file gmock-Split.cpp.

100 {
101  SCOPED_TRACE("");
102  auto mocksplit = gnc_mocksplit(split);
103  return mocksplit ? mocksplit->get_memo() : "";
104 }

◆ xaccSplitGetNoclosingBalance()

gnc_numeric xaccSplitGetNoclosingBalance ( const Split *  split)

The noclosing-balance is the currency-denominated balance of all transactions except 'closing' transactions.

It is correctly adjusted for price fluctuations.

Returns the running balance up to & including the indicated split.

Definition at line 1299 of file Split.c.

1300 {
1301  return s ? s->noclosing_balance : gnc_numeric_zero();
1302 }

◆ xaccSplitGetOtherSplit()

Split* xaccSplitGetOtherSplit ( const Split *  split)

The xaccSplitGetOtherSplit() is a convenience routine that returns the other of a pair of splits.

If there are more than two splits, it returns NULL.

Definition at line 137 of file gmock-Split.cpp.

138 {
139  SCOPED_TRACE("");
140  auto mocksplit = gnc_mocksplit(split);
141  return mocksplit ? mocksplit->get_other_split() : nullptr;
142 }

◆ xaccSplitGetParent()

Transaction* xaccSplitGetParent ( const Split *  split)

Returns the parent transaction of the split.

Definition at line 145 of file gmock-Split.cpp.

146 {
147  SCOPED_TRACE("");
148  auto mocksplit = gnc_mocksplit(split);
149  return mocksplit ? mocksplit->get_parent() : nullptr;
150 }

◆ xaccSplitGetReconcile()

char xaccSplitGetReconcile ( const Split *  split)

Returns the value of the reconcile flag.

Definition at line 107 of file gmock-Split.cpp.

108 {
109  SCOPED_TRACE("");
110  auto mocksplit = gnc_mocksplit(split);
111  return mocksplit ? mocksplit->get_reconcile() : VREC;
112 }
#define VREC
split is void
Definition: Split.h:75

◆ xaccSplitGetReconciledBalance()

gnc_numeric xaccSplitGetReconciledBalance ( const Split *  split)

Returns the reconciled-balance of this split.

The reconciled-balance is the currency-denominated balance of all transactions that have been marked as reconciled.

Returns the running balance up to & including the indicated split.

Definition at line 1311 of file Split.c.

1312 {
1313  return s ? s->reconciled_balance : gnc_numeric_zero();
1314 }

◆ xaccSplitGetSharePrice()

gnc_numeric xaccSplitGetSharePrice ( const Split *  split)

Returns the price of the split, that is, the value divided by the amount.

If the amount is zero, returns a gnc_numeric of value one.

Definition at line 1925 of file Split.c.

1926 {
1927  gnc_numeric amt, val, price;
1928  if (!split) return gnc_numeric_create(0, 1);
1929 
1930 
1931  /* if amount == 0, return 0
1932  * otherwise return value/amount
1933  */
1934 
1935  amt = xaccSplitGetAmount(split);
1936  val = xaccSplitGetValue(split);
1937  if (gnc_numeric_zero_p(amt))
1938  return gnc_numeric_create(0, 1);
1939 
1940  price = gnc_numeric_div(val, amt,
1943 
1944  /* During random checks we can get some very weird prices. Let's
1945  * handle some overflow and other error conditions by returning
1946  * zero. But still print an error to let us know it happened.
1947  */
1948  if (gnc_numeric_check(price))
1949  {
1950  PERR("Computing share price failed (%d): [ %" G_GINT64_FORMAT " / %"
1951  G_GINT64_FORMAT " ] / [ %" G_GINT64_FORMAT " / %" G_GINT64_FORMAT " ]",
1952  gnc_numeric_check(price), val.num, val.denom, amt.num, amt.denom);
1953  return gnc_numeric_create(0, 1);
1954  }
1955 
1956  return price;
1957 }
gboolean gnc_numeric_zero_p(gnc_numeric a)
Returns 1 if the given gnc_numeric is 0 (zero), else returns 0.
#define PERR(format, args...)
Log a serious error.
Definition: qoflog.h:244
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:166
gnc_numeric gnc_numeric_div(gnc_numeric a, gnc_numeric b, gint64 denom, gint how)
Division.
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction's commodity.
Definition: Split.c:1919
GNCNumericErrorCode gnc_numeric_check(gnc_numeric in)
Check for error signal in value.
#define GNC_DENOM_AUTO
Values that can be passed as the 'denom' argument.
Definition: gnc-numeric.h:246
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account's commodity.
Definition: Split.c:1913

◆ xaccSplitGetType()

const char* xaccSplitGetType ( const Split *  s)

The xaccIsPeerSplit() is a convenience routine that returns TRUE (a non-zero value) if the two splits share a common parent transaction, else it returns FALSE (zero).

gboolean xaccIsPeerSplit (const Split *split_1, const Split *split_2); Returns the split type, which is either the string "normal", or "stock-split" for a split from a stock split (pun intended? :-).

Definition at line 1969 of file Split.c.

1970 {
1971  if (!s) return NULL;
1972  if (s->split_type == is_unset)
1973  {
1974  GValue v = G_VALUE_INIT;
1975  Split *split = (Split*) s;
1976  const char* type;
1977  qof_instance_get_kvp (QOF_INSTANCE (s), &v, 1, "split-type");
1978  type = G_VALUE_HOLDS_STRING (&v) ? g_value_get_string (&v) : NULL;
1979  if (!type || !g_strcmp0 (type, split_type_normal))
1980  split->split_type = (char*) split_type_normal;
1981  else if (!g_strcmp0 (type, split_type_stock_split))
1982  split->split_type = (char*) split_type_stock_split;
1983  else
1984  {
1985  PERR ("unexpected split-type %s, reset to normal.", type);
1986  split->split_type = split_type_normal;
1987  }
1988  g_value_unset (&v);
1989  }
1990  return s->split_type;
1991 }
#define PERR(format, args...)
Log a serious error.
Definition: qoflog.h:244
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.

◆ xaccSplitGetValue()

gnc_numeric xaccSplitGetValue ( const Split *  split)

Returns the value of this split in the transaction's commodity.

Note that for cap-gains splits, this is slaved to the transaction that is causing the gains to occur.

Definition at line 84 of file gmock-Split.cpp.

85 {
86  SCOPED_TRACE("");
87  auto mocksplit = gnc_mocksplit(split);
88  return mocksplit ? mocksplit->get_value() : gnc_numeric_zero();
89 }

◆ xaccSplitIsPeerSplit()

gboolean xaccSplitIsPeerSplit ( const Split *  split,
const Split *  other_split 
)

Report if a split is a peer of this one.

Parameters
other_splitThe split to test for being a peer of this one.
Returns
: True if other_split is registered as a peer of this one.

Definition at line 2038 of file Split.c.

2039 {
2040  const GncGUID* guid;
2041 
2042  g_return_val_if_fail (split != NULL, FALSE);
2043  g_return_val_if_fail (other_split != NULL, FALSE);
2044 
2045  guid = qof_instance_get_guid (QOF_INSTANCE (other_split));
2046  return qof_instance_kvp_has_guid (QOF_INSTANCE (split), "lot-split",
2047  "peer_guid", guid);
2048 }
const GncGUID * qof_instance_get_guid(gconstpointer inst)
Return the GncGUID of this instance.
The type used to store guids in C.
Definition: guid.h:75

◆ xaccSplitLookup()

Split* xaccSplitLookup ( const GncGUID guid,
QofBook *  book 
)

The xaccSplitLookup() subroutine will return the split associated with the given id, or NULL if there is no such split.

Definition at line 1074 of file Split.c.

1075 {
1076  QofCollection *col;
1077  if (!guid || !book) return NULL;
1078  col = qof_book_get_collection (book, GNC_ID_SPLIT);
1079  return (Split *) qof_collection_lookup_entity (col, guid);
1080 }
QofInstance * qof_collection_lookup_entity(const QofCollection *col, const GncGUID *guid)
Find the entity going only from its guid.
Definition: qofid.cpp:215
QofCollection * qof_book_get_collection(const QofBook *book, QofIdType entity_type)
Return The table of entities of the given type.
Definition: qofbook.cpp:606

◆ xaccSplitMakeStockSplit()

void xaccSplitMakeStockSplit ( Split *  s)

Mark a split to be of type stock split - after this, you shouldn't modify the value anymore, just the amount.

Definition at line 1996 of file Split.c.

1997 {
1998  GValue v = G_VALUE_INIT;
1999  xaccTransBeginEdit (s->parent);
2000 
2001  s->value = gnc_numeric_zero();
2002  g_value_init (&v, G_TYPE_STRING);
2003  g_value_set_static_string (&v, split_type_stock_split);
2004  s->split_type = split_type_stock_split;
2005  qof_instance_set_kvp (QOF_INSTANCE (s), &v, 1, "split-type");
2006  SET_GAINS_VDIRTY(s);
2007  mark_split(s);
2008  qof_instance_set_dirty(QOF_INSTANCE(s));
2009  xaccTransCommitEdit(s->parent);
2010  g_value_unset (&v);
2011 }
void qof_instance_set_kvp(QofInstance *, GValue const *value, unsigned count,...)
Sets a KVP slot to a value from a GValue.
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...

◆ xaccSplitMergePeerSplits()

void xaccSplitMergePeerSplits ( Split *  split,
const Split *  other_split 
)

Merge the other_split's peer splits into split's peers.

Parameters
other_splitThe split donating the peer splits.

Definition at line 2068 of file Split.c.

2069 {
2070  xaccTransBeginEdit (split->parent);
2071  qof_instance_kvp_merge_guids (QOF_INSTANCE (split),
2072  QOF_INSTANCE (other_split), "lot-split");
2073  mark_split (split);
2074  qof_instance_set_dirty (QOF_INSTANCE (split));
2075  xaccTransCommitEdit (split->parent);
2076 }
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...

◆ xaccSplitOrder()

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

The xaccSplitOrder(sa,sb) method is useful for sorting.

if sa and sb have different transactions, return their xaccTransOrder return a negative value if split sa has a smaller currency-value than sb, return a positive value if split sa has a larger currency-value than sb, return a negative value if split sa has a smaller share-price than sb, return a positive value if split sa has a larger share-price than sb, then compares memo and action using the strcmp() c-library routine, returning what strcmp would return. Then it compares the reconciled flags, then the reconciled dates, Finally, it returns zero if all of the above match.

Definition at line 1498 of file Split.c.

1499 {
1500  int retval;
1501  int comp;
1502  const char *da, *db;
1503  gboolean action_for_num;
1504 
1505  if (sa == sb) return 0;
1506  /* nothing is always less than something */
1507  if (!sa) return -1;
1508  if (!sb) return +1;
1509 
1510  /* sort in transaction order, but use split action rather than trans num
1511  * according to book option */
1513  (xaccSplitGetBook (sa));
1514  if (action_for_num)
1515  retval = xaccTransOrder_num_action (sa->parent, sa->action,
1516  sb->parent, sb->action);
1517  else
1518  retval = xaccTransOrder (sa->parent, sb->parent);
1519  if (retval) return retval;
1520 
1521  /* otherwise, sort on memo strings */
1522  da = sa->memo ? sa->memo : "";
1523  db = sb->memo ? sb->memo : "";
1524  retval = g_utf8_collate (da, db);
1525  if (retval)
1526  return retval;
1527 
1528  /* otherwise, sort on action strings */
1529  da = sa->action ? sa->action : "";
1530  db = sb->action ? sb->action : "";
1531  retval = g_utf8_collate (da, db);
1532  if (retval != 0)
1533  return retval;
1534 
1535  /* the reconciled flag ... */
1536  if (sa->reconciled < sb->reconciled) return -1;
1537  if (sa->reconciled > sb->reconciled) return +1;
1538 
1539  /* compare amounts */
1541  if (comp < 0) return -1;
1542  if (comp > 0) return +1;
1543 
1545  if (comp < 0) return -1;
1546  if (comp > 0) return +1;
1547 
1548  /* if dates differ, return */
1549  if (sa->date_reconciled < sb->date_reconciled)
1550  return -1;
1551  else if (sa->date_reconciled > sb->date_reconciled)
1552  return 1;
1553 
1554  /* else, sort on guid - keeps sort stable. */
1555  retval = qof_instance_guid_compare(sa, sb);
1556  if (retval) return retval;
1557 
1558  return 0;
1559 }
gboolean qof_book_use_split_action_for_num_field(const QofBook *book)
Returns TRUE if this book uses split action field as the &#39;Num&#39; field, FALSE if it uses transaction nu...
int gnc_numeric_compare(gnc_numeric a, gnc_numeric b)
Returns 1 if a>b, -1 if b>a, 0 if a == b.
QofBook * xaccSplitGetBook(const Split *split)
Returns the book of this split, i.e.
Definition: Split.c:1963
int xaccTransOrder_num_action(const Transaction *ta, const char *actna, const Transaction *tb, const char *actnb)
The xaccTransOrder_num_action(ta,actna,tb,actnb) method is useful for sorting.
Definition: Transaction.c:1918
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction&#39;s commodity.
Definition: Split.c:1919
gint qof_instance_guid_compare(gconstpointer ptr1, gconstpointer ptr2)
Compare the GncGUID values of two instances.
int xaccTransOrder(const Transaction *ta, const Transaction *tb)
The xaccTransOrder(ta,tb) method is useful for sorting.
Definition: Transaction.c:1882
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account&#39;s commodity.
Definition: Split.c:1913

◆ xaccSplitRemovePeerSplit()

void xaccSplitRemovePeerSplit ( Split *  split,
const Split *  other_split 
)

Remove a peer split from this split's lot-split list.

Parameters
other_splitThe split whose guid to remove

Definition at line 2051 of file Split.c.

2052 {
2053  const GncGUID* guid;
2054 
2055  g_return_if_fail (split != NULL);
2056  g_return_if_fail (other_split != NULL);
2057 
2058  guid = qof_instance_get_guid (QOF_INSTANCE (other_split));
2059  xaccTransBeginEdit (split->parent);
2060  qof_instance_kvp_remove_guid (QOF_INSTANCE (split), "lot-split",
2061  "peer_guid", guid);
2062  mark_split (split);
2063  qof_instance_set_dirty (QOF_INSTANCE (split));
2064  xaccTransCommitEdit (split->parent);
2065 }
const GncGUID * qof_instance_get_guid(gconstpointer inst)
Return the GncGUID of this instance.
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
The type used to store guids in C.
Definition: guid.h:75

◆ xaccSplitSetAction()

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

The Action is an arbitrary user-assigned string.

The action field is an arbitrary user-assigned value. It is meant to be a very short (one to ten character) string that signifies the "type" of this split, such as e.g. Buy, Sell, Div, Withdraw, Deposit, ATM, Check, etc. The idea is that this field can be used to create custom reports or graphs of data. Note that the business features auto-fill this value, but doesn't depend on it. Rather than use this function directly, see 'gnc_set_num_action' in engine/engine-helpers.c & .h which takes a user-set book option for selecting the source for the num-cell (the transaction-number or the split-action field) in registers/reports into account automatically

Definition at line 1745 of file Split.c.

1746 {
1747  if (!split || !actn) return;
1748  xaccTransBeginEdit (split->parent);
1749 
1750  CACHE_REPLACE(split->action, actn);
1751  qof_instance_set_dirty(QOF_INSTANCE(split));
1752  xaccTransCommitEdit(split->parent);
1753 
1754 }
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...

◆ xaccSplitSetAmount()

void xaccSplitSetAmount ( Split *  split,
gnc_numeric  amount 
)

The xaccSplitSetAmount() method sets the amount in the account's commodity that the split should have.

The following four setter functions set the prices and amounts. All of the routines always maintain balance: that is, invoking any of them will cause other splits in the transaction to be modified so that the net value of the transaction is zero.

IMPORTANT: The split should be parented by an account before any of these routines are invoked! This is because the actual setting of amounts/values requires SCU settings from the account. If these are not available, then amounts/values will be set to -1/0, which is an invalid value. I believe this order dependency is a bug, but I'm too lazy to find, fix & test at the moment ...

Note
If you use this on a newly created transaction, make sure that the 'value' is also set so that it doesn't remain zero.

Definition at line 77 of file gmock-Split.cpp.

78 {
79  ASSERT_TRUE(GNC_IS_MOCKSPLIT(split));
80  gnc_mocksplit(split)->set_amount(amt);
81 }

◆ xaccSplitSetBaseValue()

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

Depending on the base_currency, set either the value or the amount of this split or both: If the base_currency is the transaction's commodity, set the value.

If it is the account's commodity, set the amount. If both, set both.

Note
WATCH OUT: When using this function and the transaction's and account's commodities are different, the amount or the value will be left as zero. This might screw up the multi-currency handling code in the register. So please think twice whether you need this function – using xaccSplitSetValue() together with xaccSplitSetAmount() is definitely the better and safer solution!

Definition at line 1317 of file Split.c.

1319 {
1320  const gnc_commodity *currency;
1321  const gnc_commodity *commodity;
1322 
1323  if (!s) return;
1324  xaccTransBeginEdit (s->parent);
1325 
1326  if (!s->acc)
1327  {
1328  PERR ("split must have a parent account");
1329  return;
1330  }
1331 
1332  currency = xaccTransGetCurrency (s->parent);
1333  commodity = xaccAccountGetCommodity (s->acc);
1334 
1335  /* If the base_currency is the transaction's commodity ('currency'),
1336  * set the value. If it's the account commodity, set the
1337  * amount. If both, set both. */
1338  if (gnc_commodity_equiv(currency, base_currency))
1339  {
1340  if (gnc_commodity_equiv(commodity, base_currency))
1341  {
1342  s->amount = gnc_numeric_convert(value,
1343  get_commodity_denom(s),
1345  }
1346  s->value = gnc_numeric_convert(value,
1347  get_currency_denom(s),
1349  }
1350  else if (gnc_commodity_equiv(commodity, base_currency))
1351  {
1352  s->amount = gnc_numeric_convert(value, get_commodity_denom(s),
1354  }
1355  else
1356  {
1357  PERR ("inappropriate base currency %s "
1358  "given split currency=%s and commodity=%s\n",
1359  gnc_commodity_get_printname(base_currency),
1360  gnc_commodity_get_printname(currency),
1361  gnc_commodity_get_printname(commodity));
1362  return;
1363  }
1364 
1365  SET_GAINS_A_VDIRTY(s);
1366  mark_split (s);
1367  qof_instance_set_dirty(QOF_INSTANCE(s));
1368  xaccTransCommitEdit(s->parent);
1369 }
#define PERR(format, args...)
Log a serious error.
Definition: qoflog.h:244
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:166
gnc_numeric gnc_numeric_convert(gnc_numeric n, gint64 denom, gint how)
Change the denominator of a gnc_numeric value to the specified denominator under standard arguments &#39;...
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
const char * gnc_commodity_get_printname(const gnc_commodity *cm)
Retrieve the &#39;print&#39; name for the specified commodity.
gnc_commodity * xaccAccountGetCommodity(const Account *acc)
Get the account&#39;s commodity.
Definition: Account.cpp:3454
gnc_commodity * xaccTransGetCurrency(const Transaction *trans)
Returns the valuation commodity of this transaction.
Definition: Transaction.c:1350
gboolean gnc_commodity_equiv(const gnc_commodity *a, const gnc_commodity *b)
This routine returns TRUE if the two commodities are equivalent.

◆ xaccSplitSetDateReconciledSecs()

void xaccSplitSetDateReconciledSecs ( Split *  split,
time64  time 
)

Set the date on which this split was reconciled by specifying the time as time64.

Definition at line 122 of file gmock-Split.cpp.

123 {
124  ASSERT_TRUE(GNC_IS_MOCKSPLIT(split));
125  gnc_mocksplit(split)->set_date_reconciled_secs(secs);
126 }

◆ xaccSplitSetMemo()

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

The memo is an arbitrary string associated with a split.

It is intended to hold a short (zero to forty character) string that is displayed by the GUI along with this split. Users typically type in free form text from the GUI.

Definition at line 1726 of file Split.c.

1727 {
1728  if (!split || !memo) return;
1729  xaccTransBeginEdit (split->parent);
1730 
1731  CACHE_REPLACE(split->memo, memo);
1732  qof_instance_set_dirty(QOF_INSTANCE(split));
1733  xaccTransCommitEdit(split->parent);
1734 
1735 }
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...

◆ xaccSplitSetReconcile()

void xaccSplitSetReconcile ( Split *  split,
char  reconciled_flag 
)

Set the reconcile flag.

The Reconcile flag is a single char, whose values are typically are 'n', 'y', 'c'. In Transaction.h, macros are defined for typical values (e.g. CREC, YREC).

Definition at line 115 of file gmock-Split.cpp.

116 {
117  ASSERT_TRUE(GNC_IS_MOCKSPLIT(split));
118  gnc_mocksplit(split)->set_reconcile(recn);
119 }

◆ xaccSplitSetSharePrice()

void xaccSplitSetSharePrice ( Split *  split,
gnc_numeric  price 
)
Deprecated:
The xaccSplitSetSharePrice() method sets the price of the split.

DEPRECATED - set the value and amount instead.

Definition at line 1190 of file Split.c.

1191 {
1192  if (!s) return;
1193 
1194  if (gnc_numeric_zero_p (price))
1195  return;
1196 
1197  ENTER (" ");
1198  xaccTransBeginEdit (s->parent);
1199 
1200  s->value = gnc_numeric_mul(xaccSplitGetAmount(s),
1201  price, get_currency_denom(s),
1203 
1204  SET_GAINS_VDIRTY(s);
1205  mark_split (s);
1206  qof_instance_set_dirty(QOF_INSTANCE(s));
1207  xaccTransCommitEdit(s->parent);
1208  LEAVE ("");
1209 }
gboolean gnc_numeric_zero_p(gnc_numeric a)
Returns 1 if the given gnc_numeric is 0 (zero), else returns 0.
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:166
gnc_numeric gnc_numeric_mul(gnc_numeric a, gnc_numeric b, gint64 denom, gint how)
Multiply a times b, returning the product.
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account&#39;s commodity.
Definition: Split.c:1913

◆ xaccSplitSetSharePriceAndAmount()

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

The xaccSplitSetSharePriceAndAmount() method will simultaneously update the share price and the number of shares.

This is a utility routine that is equivalent to a xaccSplitSetSharePrice() followed by and xaccSplitSetAmount(), except that it incurs the processing overhead of balancing only once, instead of twice.

Definition at line 1162 of file Split.c.

1163 {
1164  if (!s) return;
1165  ENTER (" ");
1166  xaccTransBeginEdit (s->parent);
1167 
1168  s->amount = gnc_numeric_convert(amt, get_commodity_denom(s),
1170  s->value = gnc_numeric_mul(s->amount, price,
1171  get_currency_denom(s), GNC_HOW_RND_ROUND_HALF_UP);
1172 
1173  SET_GAINS_A_VDIRTY(s);
1174  mark_split (s);
1175  qof_instance_set_dirty(QOF_INSTANCE(s));
1176  xaccTransCommitEdit(s->parent);
1177  LEAVE ("");
1178 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:166
gnc_numeric gnc_numeric_convert(gnc_numeric n, gint64 denom, gint how)
Change the denominator of a gnc_numeric value to the specified denominator under standard arguments &#39;...
gnc_numeric gnc_numeric_mul(gnc_numeric a, gnc_numeric b, gint64 denom, gint how)
Multiply a times b, returning the product.
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282

◆ xaccSplitSetValue()

void xaccSplitSetValue ( Split *  split,
gnc_numeric  value 
)

The xaccSplitSetValue() method sets the value of this split in the transaction's commodity.

Note
If you use this on a newly created transaction, make sure that the 'amount' is also set so that it doesn't remain zero.

Definition at line 92 of file gmock-Split.cpp.

93 {
94  ASSERT_TRUE(GNC_IS_MOCKSPLIT(split));
95  gnc_mocksplit(split)->set_value(val);
96 }

◆ xaccSplitVoidFormerAmount()

gnc_numeric xaccSplitVoidFormerAmount ( const Split *  split)

Returns the original pre-void amount of a split.

Parameters
splitThe split in question.
Returns
A gnc_numeric containing the original value of this split. Returns a gnc_numeric of zero upon error.

Definition at line 2121 of file Split.c.

2122 {
2123  GValue v = G_VALUE_INIT;
2124  gnc_numeric *num = NULL;
2125  gnc_numeric retval;
2126  g_return_val_if_fail(split, gnc_numeric_zero());
2127  qof_instance_get_kvp (QOF_INSTANCE (split), &v, 1, void_former_amt_str);
2128  if (G_VALUE_HOLDS_BOXED (&v))
2129  num = (gnc_numeric*)g_value_get_boxed (&v);
2130  retval = num ? *num : gnc_numeric_zero();
2131  g_value_unset (&v);
2132  return retval;
2133 }
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.

◆ xaccSplitVoidFormerValue()

gnc_numeric xaccSplitVoidFormerValue ( const Split *  split)

Returns the original pre-void value of a split.

Parameters
splitThe split in question.
Returns
A gnc_numeric containing the original amount of this split. Returns a gnc_numeric of zero upon error.

Definition at line 2136 of file Split.c.

2137 {
2138  GValue v = G_VALUE_INIT;
2139  gnc_numeric *num = NULL;
2140  gnc_numeric retval;
2141  g_return_val_if_fail(split, gnc_numeric_zero());
2142  qof_instance_get_kvp (QOF_INSTANCE (split), &v, 1, void_former_val_str);
2143  if (G_VALUE_HOLDS_BOXED (&v))
2144  num = (gnc_numeric*)g_value_get_boxed (&v);
2145  retval = num ? *num : gnc_numeric_zero();
2146  g_value_unset (&v);
2147  return retval;
2148 }
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.

◆ xaccTransBeginEdit()

void xaccTransBeginEdit ( Transaction *  trans)

The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of its component splits.

If this is not done, errors will result.

Definition at line 35 of file gmock-Transaction.cpp.

36 {
37  ASSERT_TRUE(GNC_IS_MOCKTRANSACTION(trans));
38  gnc_mocktransaction(trans)->begin_edit();
39 }

◆ xaccTransCommitEdit()

void xaccTransCommitEdit ( Transaction *  trans)

The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are complete and should be made permanent.

Note this routine may result in the deletion of the transaction, if the transaction is "empty" (has no splits), or of xaccTransDestroy() was called on the transaction.

Definition at line 42 of file gmock-Transaction.cpp.

43 {
44  ASSERT_TRUE(GNC_IS_MOCKTRANSACTION(trans));
45  gnc_mocktransaction(trans)->commit_edit();
46 }

◆ xaccTransCopyFromClipBoard()

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

This function explicitly must robustly handle some unusual input.

'from_trans' may be a duped trans (see xaccDupeTransaction), so its splits may not really belong to the accounts that they say they do.

'from_acc' need not be a valid account. It may be an already freed Account. Therefore, it must not be dereferenced at all.

Neither 'from_trans', nor 'from_acc', nor any of 'from's splits may be modified in any way.

'no_date' if TRUE will not copy the date posted.

The 'to_trans' transaction will end up with valid copies of from's splits. In addition, the copies of any of from's splits that were in from_acc (or at least claimed to be) will end up in to_acc.

Definition at line 746 of file Transaction.c.

748 {
749  gboolean change_accounts = FALSE;
750  GList *node;
751 
752  if (!from_trans || !to_trans)
753  return;
754 
755  change_accounts = from_acc && GNC_IS_ACCOUNT(to_acc) && from_acc != to_acc;
756  xaccTransBeginEdit(to_trans);
757 
758  FOR_EACH_SPLIT(to_trans, xaccSplitDestroy(s));
759  g_list_free(to_trans->splits);
760  to_trans->splits = NULL;
761 
762  xaccTransSetCurrency(to_trans, xaccTransGetCurrency(from_trans));
763  xaccTransSetDescription(to_trans, xaccTransGetDescription(from_trans));
764 
765  if ((xaccTransGetNum(to_trans) == NULL) || (g_strcmp0 (xaccTransGetNum(to_trans), "") == 0))
766  xaccTransSetNum(to_trans, xaccTransGetNum(from_trans));
767 
768  xaccTransSetNotes(to_trans, xaccTransGetNotes(from_trans));
769  xaccTransSetDocLink(to_trans, xaccTransGetDocLink (from_trans));
770  if(!no_date)
771  {
772  xaccTransSetDatePostedSecs(to_trans, xaccTransRetDatePosted (from_trans));
773  }
774 
775  /* Each new split will be parented to 'to' */
776  for (node = from_trans->splits; node; node = node->next)
777  {
778  Split *new_split = xaccMallocSplit( qof_instance_get_book(QOF_INSTANCE(from_trans)));
779  xaccSplitCopyOnto(node->data, new_split);
780  if (change_accounts && xaccSplitGetAccount(node->data) == from_acc)
781  xaccSplitSetAccount(new_split, to_acc);
782  xaccSplitSetParent(new_split, to_trans);
783  }
784  xaccTransCommitEdit(to_trans);
785 }
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.
gboolean xaccSplitDestroy(Split *split)
Destructor.
Definition: Split.c:1468
void xaccTransSetNotes(Transaction *trans, const char *notes)
Sets the transaction Notes.
Definition: Transaction.c:2219
void xaccSplitCopyOnto(const Split *from_split, Split *to_split)
This is really a helper for xaccTransCopyOnto.
Definition: Split.c:641
void xaccTransSetDescription(Transaction *trans, const char *desc)
Sets the transaction Description.
Definition: Transaction.c:2178
void xaccTransSetNum(Transaction *trans, const char *xnum)
Sets the transaction Number (or ID) field; rather than use this function directly, see &#39;gnc_set_num_action&#39; in engine/engine-helpers.c & .h which takes a user-set book option for selecting the source for the num-cell (the transaction-number or the split-action field) in registers/reports into account automatically.
Definition: Transaction.c:2158
const char * xaccTransGetNum(const Transaction *trans)
Gets the transaction Number (or ID) field; rather than use this function directly, see &#39;gnc_get_num_action&#39; and &#39;gnc_get_action_num&#39; in engine/engine-helpers.c & .h which takes a user-set book option for selecting the source for the num-cell (the transaction-number or the split-action field) in registers/reports into account automatically.
Definition: Transaction.c:2371
const char * xaccTransGetDocLink(const Transaction *trans)
Gets the transaction Document Link.
Definition: Transaction.c:2383
void xaccTransSetCurrency(Transaction *trans, gnc_commodity *curr)
Set a new currency on a transaction.
Definition: Transaction.c:1409
const char * xaccTransGetNotes(const Transaction *trans)
Gets the transaction Notes.
Definition: Transaction.c:2396
time64 xaccTransRetDatePosted(const Transaction *trans)
Retrieve the posted date of the transaction.
Definition: Transaction.c:2443
const char * xaccTransGetDescription(const Transaction *trans)
Gets the transaction Description.
Definition: Transaction.c:2377
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1637
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1438
Split * xaccMallocSplit(QofBook *book)
Constructor.
Definition: gmock-Split.cpp:37
void xaccTransSetDatePostedSecs(Transaction *trans, time64 secs)
The xaccTransSetDatePostedSecs() method will modify the posted date of the transaction, specified by a time64 (see ctime(3)).
Definition: Transaction.c:2005
Account * xaccSplitGetAccount(const Split *split)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: gmock-Split.cpp:53
gnc_commodity * xaccTransGetCurrency(const Transaction *trans)
Returns the valuation commodity of this transaction.
Definition: Transaction.c:1350
void xaccTransSetDocLink(Transaction *trans, const char *doclink)
Sets the transaction Document Link.
Definition: Transaction.c:2189

◆ xaccTransCopyToClipBoard()

Transaction* xaccTransCopyToClipBoard ( const Transaction *  from_trans)

Copy a transaction to the 'clipboard' transaction using dupe_transaction.

The 'clipboard' transaction must never be dereferenced.

Definition at line 706 of file Transaction.c.

707 {
708  Transaction *to_trans;
709 
710  if (!from_trans)
711  return NULL;
712 
713  to_trans = dupe_trans(from_trans);
714  return to_trans;
715 }

◆ xaccTransCountSplits()

int xaccTransCountSplits ( const Transaction *  trans)

Returns the number of splits in this transaction.

Definition at line 2362 of file Transaction.c.

2363 {
2364  gint i = 0;
2365  g_return_val_if_fail (trans != NULL, 0);
2366  FOR_EACH_SPLIT(trans, i++);
2367  return i;
2368 }

◆ xaccTransDestroy()

void xaccTransDestroy ( Transaction *  trans)

Destroys a transaction.

Each split in transaction trans is removed from its account and destroyed as well.

If the transaction has not already been opened for editing with xaccTransBeginEdit() then the changes are committed immediately. Otherwise, the caller must follow up with either xaccTransCommitEdit(), in which case the transaction and split memory will be freed, or xaccTransRollbackEdit(), in which case nothing at all is freed, and everything is put back into original order.

Parameters
transthe transaction to destroy

Definition at line 142 of file gmock-Transaction.cpp.

143 {
144  ASSERT_TRUE(GNC_IS_MOCKTRANSACTION(trans));
145  gnc_mocktransaction(trans)->destroy();
146 }

◆ xaccTransEqual()

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

Equality.

Parameters
taFirst transaction to compare
tbSecond transaction to compare
check_guidsIf TRUE, try a guid_equal() on the GUIDs of both transactions if their pointers are not equal in the first place. Also passed to subsidiary calls to xaccSplitEqual.
check_splitsIf TRUE, after checking the transaction data structures for equality, also check all splits attached to the transaction for equality.
check_balancesIf TRUE, when checking splits also compare balances between the two splits. Balances are recalculated whenever a split is added or removed from an account, so YMMV on whether this should be set.
assume_orderedIf TRUE, assume that the splits in each transaction appear in the same order. This saves some time looking up splits by GncGUID, and is required for checking duplicated transactions because all the splits have new GUIDs.

Definition at line 858 of file Transaction.c.

863 {
864  gboolean same_book;
865 
866  if (!ta && !tb) return TRUE; /* Arguable. FALSE may be better. */
867 
868  if (!ta || !tb)
869  {
870  PINFO ("one is NULL");
871  return FALSE;
872  }
873 
874  if (ta == tb) return TRUE;
875 
876  same_book = qof_instance_get_book(QOF_INSTANCE(ta)) == qof_instance_get_book(QOF_INSTANCE(tb));
877 
878  if (check_guids)
879  {
880  if (qof_instance_guid_compare(ta, tb) != 0)
881  {
882  PINFO ("GUIDs differ");
883  return FALSE;
884  }
885  }
886 
887  if (!gnc_commodity_equal(ta->common_currency, tb->common_currency))
888  {
889  PINFO ("commodities differ %s vs %s",
890  gnc_commodity_get_unique_name (ta->common_currency),
891  gnc_commodity_get_unique_name (tb->common_currency));
892  return FALSE;
893  }
894 
895  if (ta->date_entered != tb->date_entered)
896  {
897  char buf1[100];
898  char buf2[100];
899 
900  (void)gnc_time64_to_iso8601_buff(ta->date_entered, buf1);
901  (void)gnc_time64_to_iso8601_buff(tb->date_entered, buf2);
902  PINFO ("date entered differs: '%s' vs '%s'", buf1, buf2);
903  return FALSE;
904  }
905 
906  if (ta->date_posted != tb->date_posted)
907  {
908  char buf1[100];
909  char buf2[100];
910 
911  (void)gnc_time64_to_iso8601_buff(ta->date_posted, buf1);
912  (void)gnc_time64_to_iso8601_buff(tb->date_posted, buf2);
913  PINFO ("date posted differs: '%s' vs '%s'", buf1, buf2);
914  return FALSE;
915  }
916 
917  /* If the same book, since we use cached strings, we can just compare pointer
918  * equality for num and description
919  */
920  if ((same_book && ta->num != tb->num) || (!same_book && g_strcmp0(ta->num, tb->num) != 0))
921  {
922  PINFO ("num differs: %s vs %s", ta->num, tb->num);
923  return FALSE;
924  }
925 
926  if ((same_book && ta->description != tb->description)
927  || (!same_book && g_strcmp0(ta->description, tb->description)))
928  {
929  PINFO ("descriptions differ: %s vs %s", ta->description, tb->description);
930  return FALSE;
931  }
932 
933  if (qof_instance_compare_kvp (QOF_INSTANCE (ta), QOF_INSTANCE (tb)) != 0)
934  {
935  char *frame_a;
936  char *frame_b;
937 
938  frame_a = qof_instance_kvp_as_string (QOF_INSTANCE (ta));
939  frame_b = qof_instance_kvp_as_string (QOF_INSTANCE (tb));
940 
941 
942  PINFO ("kvp frames differ:\n%s\n\nvs\n\n%s", frame_a, frame_b);
943 
944  g_free (frame_a);
945  g_free (frame_b);
946 
947  return FALSE;
948  }
949 
950  if (check_splits)
951  {
952  if ((!ta->splits && tb->splits) || (!tb->splits && ta->splits))
953  {
954  PINFO ("only one has splits");
955  return FALSE;
956  }
957 
958  if (ta->splits && tb->splits)
959  {
960  GList *node_a, *node_b;
961 
962  for (node_a = ta->splits, node_b = tb->splits;
963  node_a;
964  node_a = node_a->next, node_b = node_b->next)
965  {
966  Split *split_a = node_a->data;
967  Split *split_b;
968 
969  /* don't presume that the splits are in the same order */
970  if (!assume_ordered)
971  node_b = g_list_find_custom (tb->splits, split_a,
972  compare_split_guids);
973 
974  if (!node_b)
975  {
976  gchar guidstr[GUID_ENCODING_LENGTH+1];
977  guid_to_string_buff (xaccSplitGetGUID (split_a),guidstr);
978 
979  PINFO ("first has split %s and second does not",guidstr);
980  return FALSE;
981  }
982 
983  split_b = node_b->data;
984 
985  if (!xaccSplitEqual (split_a, split_b, check_guids, check_balances,
986  FALSE))
987  {
988  char str_a[GUID_ENCODING_LENGTH + 1];
989  char str_b[GUID_ENCODING_LENGTH + 1];
990 
991  guid_to_string_buff (xaccSplitGetGUID (split_a), str_a);
992  guid_to_string_buff (xaccSplitGetGUID (split_b), str_b);
993 
994  PINFO ("splits %s and %s differ", str_a, str_b);
995  return FALSE;
996  }
997  }
998 
999  if (g_list_length (ta->splits) != g_list_length (tb->splits))
1000  {
1001  PINFO ("different number of splits");
1002  return FALSE;
1003  }
1004  }
1005  }
1006 
1007  return TRUE;
1008 }
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.
#define PINFO(format, args...)
Print an informational note.
Definition: qoflog.h:256
gboolean gnc_commodity_equal(const gnc_commodity *a, const gnc_commodity *b)
This routine returns TRUE if the two commodities are equal.
gchar * guid_to_string_buff(const GncGUID *guid, gchar *str)
The guid_to_string_buff() routine puts a null-terminated string encoding of the id into the memory po...
Definition: guid.cpp:174
gboolean xaccSplitEqual(const Split *sa, const Split *sb, gboolean check_guids, gboolean check_balances, gboolean check_txn_splits)
Equality.
Definition: Split.c:771
#define GUID_ENCODING_LENGTH
Number of characters needed to encode a guid as a string not including the null terminator.
Definition: guid.h:84
#define xaccSplitGetGUID(X)
Definition: Split.h:554
gint qof_instance_guid_compare(gconstpointer ptr1, gconstpointer ptr2)
Compare the GncGUID values of two instances.
const char * gnc_commodity_get_unique_name(const gnc_commodity *cm)
Retrieve the &#39;unique&#39; name for the specified commodity.
char * gnc_time64_to_iso8601_buff(time64 time, char *buff)
The gnc_time64_to_iso8601_buff() routine takes the input UTC time64 value and prints it as an ISO-860...
Definition: gnc-date.cpp:1142

◆ xaccTransGetAccountAmount()

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

Same as xaccTransGetAccountValue, but uses the Account's commodity.

Definition at line 1188 of file Transaction.c.

1189 {
1190  gnc_numeric total = gnc_numeric_zero ();
1191  if (!trans || !acc) return total;
1192 
1193  total = gnc_numeric_convert (total, xaccAccountGetCommoditySCU (acc),
1195  FOR_EACH_SPLIT(trans, if (acc == xaccSplitGetAccount(s))
1196  total = gnc_numeric_add_fixed(
1197  total, xaccSplitGetAmount(s)));
1198  return total;
1199 }
int xaccAccountGetCommoditySCU(const Account *acc)
Return the SCU for the account.
Definition: Account.cpp:2707
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:166
gnc_numeric gnc_numeric_convert(gnc_numeric n, gint64 denom, gint how)
Change the denominator of a gnc_numeric value to the specified denominator under standard arguments &#39;...
Account * xaccSplitGetAccount(const Split *split)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: gmock-Split.cpp:53
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account&#39;s commodity.
Definition: gmock-Split.cpp:69

◆ xaccTransGetAccountBalance()

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

Get the account balance for the specified account after the last split in the specified transaction.

Definition at line 1312 of file Transaction.c.

1314 {
1315  GList *node;
1316  Split *last_split = NULL;
1317 
1318  // Not really the appropriate error value.
1319  g_return_val_if_fail(account && trans, gnc_numeric_error(GNC_ERROR_ARG));
1320 
1321  for (node = trans->splits; node; node = node->next)
1322  {
1323  Split *split = node->data;
1324 
1325  if (!xaccTransStillHasSplit(trans, split))
1326  continue;
1327  if (xaccSplitGetAccount(split) != account)
1328  continue;
1329 
1330  if (!last_split)
1331  {
1332  last_split = split;
1333  continue;
1334  }
1335 
1336  /* This test needs to correspond to the comparison function used when
1337  sorting the splits for computing the running balance. */
1338  if (xaccSplitOrder (last_split, split) < 0)
1339  last_split = split;
1340  }
1341 
1342  return xaccSplitGetBalance (last_split);
1343 }
gint xaccSplitOrder(const Split *sa, const Split *sb)
The xaccSplitOrder(sa,sb) method is useful for sorting.
Definition: Split.c:1498
gnc_numeric xaccSplitGetBalance(const Split *s)
Returns the running balance up to and including the indicated split.
Definition: Split.c:1293
gnc_numeric gnc_numeric_error(GNCNumericErrorCode error_code)
Create a gnc_numeric object that signals the error condition noted by error_code, rather than a numbe...
Argument is not a valid number.
Definition: gnc-numeric.h:225
Account * xaccSplitGetAccount(const Split *split)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: gmock-Split.cpp:53

◆ xaccTransGetAccountValue()

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

The xaccTransGetAccountValue() method returns the total value applied to a particular account.

In some cases there may be multiple Splits in a single Transaction applied to one account (in particular when trying to balance Lots) – this function is just a convenience to view everything at once.

Definition at line 1172 of file Transaction.c.

1174 {
1175  gnc_numeric total = gnc_numeric_zero ();
1176  if (!trans || !acc) return total;
1177 
1178  FOR_EACH_SPLIT(trans, if (acc == xaccSplitGetAccount(s))
1179 {
1180  total = gnc_numeric_add (total, xaccSplitGetValue (s),
1183  });
1184  return total;
1185 }
gnc_numeric gnc_numeric_add(gnc_numeric a, gnc_numeric b, gint64 denom, gint how)
Return a+b.
Use any denominator which gives an exactly correct ratio of numerator to denominator.
Definition: gnc-numeric.h:189
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction&#39;s commodity.
Definition: gmock-Split.cpp:84
Account * xaccSplitGetAccount(const Split *split)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: gmock-Split.cpp:53
#define GNC_DENOM_AUTO
Values that can be passed as the &#39;denom&#39; argument.
Definition: gnc-numeric.h:246

◆ xaccTransGetAPARAcctSplitList()

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

The xaccTransGetAPARSplitList() method returns a GList of the splits in a transaction that belong to an AR or AP account.

Parameters
transThe transaction
strictThis slightly modifies the test to only consider splits in an AR or AP account and the split is part of a business lot
Returns
The list of splits. This list must be freed when you are done with it.

Definition at line 2299 of file Transaction.c.

2300 {
2301  GList *apar_splits = NULL;
2302  if (!trans) return NULL;
2303 
2304  FOR_EACH_SPLIT (trans,
2305  const Account *account = xaccSplitGetAccount(s);
2306  if (account && xaccAccountIsAPARType(xaccAccountGetType(account)))
2307  {
2308 
2309  if (!strict)
2310  apar_splits = g_list_prepend (apar_splits, s);
2311  else
2312  {
2313  GncOwner owner;
2314  GNCLot *lot = xaccSplitGetLot(s);
2315  if (lot &&
2316  (gncInvoiceGetInvoiceFromLot (lot) ||
2317  gncOwnerGetOwnerFromLot (lot, &owner)))
2318  apar_splits = g_list_prepend (apar_splits, s);
2319  }
2320  }
2321  );
2322 
2323  apar_splits = g_list_reverse (apar_splits);
2324  return apar_splits;
2325 }
GNCAccountType xaccAccountGetType(const Account *acc)
Returns the account&#39;s account type.
Definition: Account.cpp:3285
gboolean gncOwnerGetOwnerFromLot(GNCLot *lot, GncOwner *owner)
Get the owner from the lot.
Definition: gncOwner.c:637
gboolean xaccAccountIsAPARType(GNCAccountType t)
Convenience function to check if the account is a valid business account type (meaning an Accounts Pa...
Definition: Account.cpp:4694
GncInvoice * gncInvoiceGetInvoiceFromLot(GNCLot *lot)
Given a LOT, find and return the Invoice attached to the lot.
Definition: gncInvoice.c:1314
Account * xaccSplitGetAccount(const Split *split)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: gmock-Split.cpp:53
GNCLot * xaccSplitGetLot(const Split *split)
Returns the pointer to the debited/credited Lot where this split belongs to, or NULL if it doesn&#39;t be...
Definition: Split.c:1879

◆ xaccTransGetCurrency()

gnc_commodity* xaccTransGetCurrency ( const Transaction *  trans)

Returns the valuation commodity of this transaction.

Each transaction's valuation commodity, or 'currency' is, by definition, the common currency in which all splits in the transaction can be valued. The total value of the transaction must be zero when all splits are valued in this currency.

Note
What happens if the Currency isn't set? Ans: bad things.

Definition at line 1350 of file Transaction.c.

1351 {
1352  return trans ? trans->common_currency : NULL;
1353 }

◆ xaccTransGetDate()

time64 xaccTransGetDate ( const Transaction *  trans)

Retrieve the posted date of the transaction.

The posted date is the date when this transaction was posted at the bank. (Although having different function names, GetDate and GetDatePosted refer to the same single date.)

Definition at line 73 of file gmock-Transaction.cpp.

74 {
75  SCOPED_TRACE("");
76  auto mocktrans = gnc_mocktransaction(trans);
77  return mocktrans ? mocktrans->get_date() : 0;
78 }

◆ xaccTransGetDateEntered()

time64 xaccTransGetDateEntered ( const Transaction *  trans)

Retrieve the date of when the transaction was entered.

The entered date is the date when the register entry was made.

Definition at line 2436 of file Transaction.c.

2437 {
2438  return trans ? trans->date_entered : 0;
2439 }

◆ xaccTransGetDatePostedGDate()

GDate xaccTransGetDatePostedGDate ( const Transaction *  trans)

Retrieve the posted date of the transaction.

The posted date is the date when this transaction was posted at the bank.

Definition at line 2449 of file Transaction.c.

2450 {
2451  GDate result;
2452  g_date_clear (&result, 1);
2453  if (trans)
2454  {
2455  /* Can we look up this value in the kvp slot? If yes, use it
2456  * from there because it doesn't suffer from time zone
2457  * shifts. */
2458  GValue v = G_VALUE_INIT;
2459  qof_instance_get_kvp (QOF_INSTANCE (trans), &v, 1, TRANS_DATE_POSTED);
2460  if (G_VALUE_HOLDS_BOXED (&v))
2461  result = *(GDate*)g_value_get_boxed (&v);
2462  g_value_unset (&v);
2463  if (! g_date_valid (&result) || gdate_to_time64 (result) == INT64_MAX)
2464  {
2465  /* Well, this txn doesn't have a valid GDate saved in a slot.
2466  * time64_to_gdate() uses local time and we want UTC so we have
2467  * to write it out.
2468  */
2469  time64 time = xaccTransGetDate(trans);
2470  struct tm *stm = gnc_gmtime(&time);
2471  if (stm)
2472  {
2473  g_date_set_dmy(&result, stm->tm_mday,
2474  (GDateMonth)(stm->tm_mon + 1),
2475  stm->tm_year + 1900);
2476  free(stm);
2477  }
2478  }
2479  }
2480  return result;
2481 }
time64 xaccTransGetDate(const Transaction *trans)
Retrieve the posted date of the transaction.
Definition: Transaction.c:2429
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.
time64 gdate_to_time64(GDate d)
Turns a GDate into a time64, returning the first second of the day.
Definition: gnc-date.cpp:1257
struct tm * gnc_gmtime(const time64 *secs)
fill out a time struct from a 64-bit time value
Definition: gnc-date.cpp:189
gint64 time64
Many systems, including Microsoft Windows and BSD-derived Unixes like Darwin, are retaining the int-3...
Definition: gnc-date.h:93

◆ xaccTransGetFirstAPARAcctSplit()

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

The xaccTransGetFirstPaymentAcctSplit() method returns a pointer to the first split in this transaction that belongs to an AR or AP account.

Parameters
transThe transaction
strictThis slightly modifies the test to only consider splits in an AR or AP account and the split is part of a business lot

If there is no such split in the transaction NULL will be returned.

Definition at line 2338 of file Transaction.c.

2339 {
2340  FOR_EACH_SPLIT (trans,
2341  const Account *account = xaccSplitGetAccount(s);
2342  if (account && xaccAccountIsAPARType(xaccAccountGetType(account)))
2343  {
2344  GNCLot *lot;
2345  GncOwner owner;
2346 
2347  if (!strict)
2348  return s;
2349 
2350  lot = xaccSplitGetLot(s);
2351  if (lot &&
2352  (gncInvoiceGetInvoiceFromLot (lot) ||
2353  gncOwnerGetOwnerFromLot (lot, &owner)))
2354  return s;
2355  }
2356  );
2357 
2358  return NULL;
2359 }
GNCAccountType xaccAccountGetType(const Account *acc)
Returns the account&#39;s account type.
Definition: Account.cpp:3285
gboolean gncOwnerGetOwnerFromLot(GNCLot *lot, GncOwner *owner)
Get the owner from the lot.
Definition: gncOwner.c:637
gboolean xaccAccountIsAPARType(GNCAccountType t)
Convenience function to check if the account is a valid business account type (meaning an Accounts Pa...
Definition: Account.cpp:4694
GncInvoice * gncInvoiceGetInvoiceFromLot(GNCLot *lot)
Given a LOT, find and return the Invoice attached to the lot.
Definition: gncInvoice.c:1314
Account * xaccSplitGetAccount(const Split *split)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: gmock-Split.cpp:53
GNCLot * xaccSplitGetLot(const Split *split)
Returns the pointer to the debited/credited Lot where this split belongs to, or NULL if it doesn&#39;t be...
Definition: Split.c:1879

◆ xaccTransGetFirstPaymentAcctSplit()

Split* xaccTransGetFirstPaymentAcctSplit ( const Transaction *  trans)

The xaccTransGetFirstPaymentAcctSplit() method returns a pointer to the first split in this transaction that belongs to an account which is considered a valid account for business payments.

Parameters
transThe transaction

If there is no such split in the transaction NULL will be returned.

Definition at line 2327 of file Transaction.c.

2328 {
2329  FOR_EACH_SPLIT (trans,
2330  const Account *account = xaccSplitGetAccount(s);
2331  if (account && gncBusinessIsPaymentAcctType(xaccAccountGetType(account)))
2332  return s;
2333  );
2334 
2335  return NULL;
2336 }
GNCAccountType xaccAccountGetType(const Account *acc)
Returns the account&#39;s account type.
Definition: Account.cpp:3285
gboolean gncBusinessIsPaymentAcctType(GNCAccountType type)
Returns whether the given account type is a valid type to use in business payments.
Definition: gncBusiness.c:92
Account * xaccSplitGetAccount(const Split *split)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: gmock-Split.cpp:53

◆ xaccTransGetImbalance()

MonetaryList* xaccTransGetImbalance ( const Transaction *  trans)

The xaccTransGetImbalance method returns a list giving the value of the transaction in each currency for which the balance is not zero.

If the use of currency accounts is disabled, then this will be only the common currency for the transaction and xaccTransGetImbalance becomes equivalent to xaccTransGetImbalanceValue. Otherwise it will return a list containing the imbalance in each currency.

Definition at line 1054 of file Transaction.c.

1055 {
1056  /* imbal_value is used if either (1) the transaction has a non currency
1057  split or (2) all the splits are in the same currency. If there are
1058  no non-currency splits and not all splits are in the same currency then
1059  imbal_list is used to compute the imbalance. */
1060  MonetaryList *imbal_list = NULL;
1061  gnc_numeric imbal_value = gnc_numeric_zero();
1062  gboolean trading_accts;
1063 
1064  if (!trans) return imbal_list;
1065 
1066  ENTER("(trans=%p)", trans);
1067 
1068  trading_accts = xaccTransUseTradingAccounts (trans);
1069 
1070  /* If using trading accounts and there is at least one split that is not
1071  in the transaction currency or a split that has a price or exchange
1072  rate other than 1, then compute the balance in each commodity in the
1073  transaction. Otherwise (all splits are in the transaction's currency)
1074  then compute the balance using the value fields.
1075 
1076  Optimize for the common case of only one currency and a balanced
1077  transaction. */
1078  FOR_EACH_SPLIT(trans,
1079  {
1080  gnc_commodity *commodity;
1082  if (trading_accts &&
1083  (imbal_list ||
1084  ! gnc_commodity_equiv(commodity, trans->common_currency) ||
1086  {
1087  /* Need to use (or already are using) a list of imbalances in each of
1088  the currencies used in the transaction. */
1089  if (! imbal_list)
1090  {
1091  /* All previous splits have been in the transaction's common
1092  currency, so imbal_value is in this currency. */
1093  imbal_list = gnc_monetary_list_add_value(imbal_list,
1094  trans->common_currency,
1095  imbal_value);
1096  }
1097  imbal_list = gnc_monetary_list_add_value(imbal_list, commodity,
1098  xaccSplitGetAmount(s));
1099  }
1100 
1101  /* Add it to the value accumulator in case we need it. */
1102  imbal_value = gnc_numeric_add(imbal_value, xaccSplitGetValue(s),
1104  } );
1105 
1106 
1107  if (!imbal_list && !gnc_numeric_zero_p(imbal_value))
1108  {
1109  /* Not balanced and no list, create one. If we found multiple currencies
1110  and no non-currency commodity then imbal_list will already exist and
1111  we won't get here. */
1112  imbal_list = gnc_monetary_list_add_value(imbal_list,
1113  trans->common_currency,
1114  imbal_value);
1115  }
1116 
1117  /* Delete all the zero entries from the list, perhaps leaving an
1118  empty list */
1119  imbal_list = gnc_monetary_list_delete_zeros(imbal_list);
1120 
1121  LEAVE("(trans=%p), imbal=%p", trans, imbal_list);
1122  return imbal_list;
1123 }
gboolean gnc_numeric_equal(gnc_numeric a, gnc_numeric b)
Equivalence predicate: Returns TRUE (1) if a and b represent the same number.
gboolean xaccTransUseTradingAccounts(const Transaction *trans)
Determine whether this transaction should use commodity trading accounts.
Definition: Transaction.c:1017
gnc_numeric gnc_numeric_add(gnc_numeric a, gnc_numeric b, gint64 denom, gint how)
Return a+b.
gboolean gnc_numeric_zero_p(gnc_numeric a)
Returns 1 if the given gnc_numeric is 0 (zero), else returns 0.
Use any denominator which gives an exactly correct ratio of numerator to denominator.
Definition: gnc-numeric.h:189
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
MonetaryList * gnc_monetary_list_delete_zeros(MonetaryList *list)
Delete all entries in the list that have zero value.
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction&#39;s commodity.
Definition: gmock-Split.cpp:84
Account * xaccSplitGetAccount(const Split *split)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: gmock-Split.cpp:53
gnc_commodity * xaccAccountGetCommodity(const Account *acc)
Get the account&#39;s commodity.
Definition: Account.cpp:3454
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282
#define GNC_DENOM_AUTO
Values that can be passed as the &#39;denom&#39; argument.
Definition: gnc-numeric.h:246
gboolean gnc_commodity_equiv(const gnc_commodity *a, const gnc_commodity *b)
This routine returns TRUE if the two commodities are equivalent.
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account&#39;s commodity.
Definition: gmock-Split.cpp:69

◆ xaccTransGetImbalanceValue()

gnc_numeric xaccTransGetImbalanceValue ( const Transaction *  trans)

The xaccTransGetImbalanceValue() method returns the total value of the transaction.

In a pure double-entry system, this imbalance should be exactly zero, and if it is not, something is broken. However, when double-entry semantics are not enforced, unbalanced transactions can sneak in, and this routine can be used to find out how much things are off by. The value returned is denominated in the currency that is returned by the xaccTransFindCommonCurrency() method.

If the use of currency exchange accounts is enabled then the a a transaction must be balanced in each currency it uses to be considered to be balanced. The method xaccTransGetImbalance is used by most code to take this into consideration. This method is only used in a few places that want the transaction value even if currency exchange accounts are enabled.

Definition at line 118 of file gmock-Transaction.cpp.

119 {
120  SCOPED_TRACE("");
121  auto mocktrans = gnc_mocktransaction(trans);
122  return mocktrans ? mocktrans->get_imbalance_value() : gnc_numeric_zero();
123 }

◆ xaccTransGetNotes()

const char* xaccTransGetNotes ( const Transaction *  trans)

Gets the transaction Notes.

The Notes field is only visible in the register in double-line mode

Definition at line 103 of file gmock-Transaction.cpp.

104 {
105  SCOPED_TRACE("");
106  auto mocktrans = gnc_mocktransaction(trans);
107  return mocktrans ? mocktrans->get_notes() : "";
108 }

◆ xaccTransGetPaymentAcctSplitList()

SplitList* xaccTransGetPaymentAcctSplitList ( const Transaction *  trans)

The xaccTransGetPaymentAcctSplitList() method returns a GList of the splits in a transaction that belong to an account which is considered a valid account for business payments.

Parameters
transThe transaction
Returns
The list of splits. This list must be freed when you are done with it.

Definition at line 2285 of file Transaction.c.

2286 {
2287  GList *pay_splits = NULL;
2288  FOR_EACH_SPLIT (trans,
2289  const Account *account = xaccSplitGetAccount(s);
2290  if (account && gncBusinessIsPaymentAcctType(xaccAccountGetType(account)))
2291  pay_splits = g_list_prepend (pay_splits, s);
2292  );
2293 
2294  pay_splits = g_list_reverse (pay_splits);
2295  return pay_splits;
2296 }
GNCAccountType xaccAccountGetType(const Account *acc)
Returns the account&#39;s account type.
Definition: Account.cpp:3285
gboolean gncBusinessIsPaymentAcctType(GNCAccountType type)
Returns whether the given account type is a valid type to use in business payments.
Definition: gncBusiness.c:92
Account * xaccSplitGetAccount(const Split *split)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: gmock-Split.cpp:53

◆ xaccTransGetReadOnly()

const char* xaccTransGetReadOnly ( Transaction *  trans)

Returns a non-NULL value if this Transaction was marked as read-only with some specific "reason" text.

Definition at line 2547 of file Transaction.c.

2548 {
2549  if (!trans)
2550  return NULL;
2551 
2552  GValue v = G_VALUE_INIT;
2553  qof_instance_get_kvp (QOF_INSTANCE(trans), &v, 1, TRANS_READ_ONLY_REASON);
2554  const char *readonly_reason = G_VALUE_HOLDS_STRING (&v) ?
2555  g_value_get_string (&v) : NULL;
2556  g_value_unset (&v);
2557  return readonly_reason;
2558 }
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.

◆ xaccTransGetReversedBy()

Transaction* xaccTransGetReversedBy ( const Transaction *  trans)

Returns the transaction that reversed the given transaction.

Parameters
transa Transaction that has been reversed
Returns
the transaction that reversed the given transaction, or NULL if the given transaction has not been reversed.

Definition at line 2878 of file Transaction.c.

2879 {
2880  GValue v = G_VALUE_INIT;
2881  Transaction *retval = NULL;
2882  g_return_val_if_fail(trans, NULL);
2883  qof_instance_get_kvp (QOF_INSTANCE(trans), &v, 1, TRANS_REVERSED_BY);
2884  if (G_VALUE_HOLDS_BOXED (&v))
2885  {
2886  GncGUID* guid = g_value_get_boxed (&v);
2887  retval = xaccTransLookup(guid, qof_instance_get_book (trans));
2888  }
2889  g_value_unset (&v);
2890  return retval;
2891 }
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.
Transaction * xaccTransLookup(const GncGUID *guid, QofBook *book)
The xaccTransLookup() subroutine will return the transaction associated with the given id...
Definition: Transaction.c:1026
The type used to store guids in C.
Definition: guid.h:75

◆ xaccTransGetSplit()

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

Return a pointer to the indexed split in this transaction's split list.

Note that the split list is a linked list and that indexed access is O(N). Do not use this method for iteration.

Parameters
transThe transaction
iThe split number. Valid values for i are zero to (number_of__splits-1).
Returns
A Split* or NULL if i is out of range.

Definition at line 49 of file gmock-Transaction.cpp.

50 {
51  SCOPED_TRACE("");
52  auto mocktrans = gnc_mocktransaction(trans);
53  return mocktrans ? mocktrans->get_split(i) : nullptr;
54 }

◆ xaccTransGetSplitList()

SplitList* xaccTransGetSplitList ( const Transaction *  trans)

The xaccTransGetSplitList() method returns a GList of the splits in a transaction.

Parameters
transThe transaction
Returns
The list of splits. This list must NOT be modified. Do NOT free this list when you are done with it.

Definition at line 57 of file gmock-Transaction.cpp.

58 {
59  g_return_val_if_fail(GNC_IS_MOCKTRANSACTION(trans), NULL);
60  return trans ? ((MockTransaction*)trans)->get_split_list() : NULL;
61 }

◆ xaccTransGetTxnType()

char xaccTransGetTxnType ( Transaction *  trans)

Returns the Transaction Type: note this type will be derived from the transaction splits, returning TXN_TYPE_NONE, TXN_TYPE_INVOICE, TXN_TYPE_LINK, or TXN_TYPE_PAYMENT according to heuristics.

It does not query the transaction kvp slots.

See TXN_TYPE_NONE, TXN_TYPE_INVOICE and TXN_TYPE_PAYMENT

Definition at line 2507 of file Transaction.c.

2508 {
2509  gboolean has_nonAPAR_amount = FALSE;
2510 
2511  if (!trans) return TXN_TYPE_NONE;
2512 
2513  if (trans->txn_type != TXN_TYPE_UNCACHED)
2514  return trans->txn_type;
2515 
2516  trans->txn_type = TXN_TYPE_NONE;
2517  for (GList *n = xaccTransGetSplitList (trans); n; n = g_list_next (n))
2518  {
2519  Account *acc = xaccSplitGetAccount (n->data);
2520 
2521  if (!acc)
2522  continue;
2523 
2526  has_nonAPAR_amount = TRUE;
2527  else if (trans->txn_type == TXN_TYPE_NONE)
2528  {
2529  GNCLot *lot = xaccSplitGetLot (n->data);
2530  GncInvoice *invoice = gncInvoiceGetInvoiceFromLot (lot);
2531  GncOwner owner;
2532 
2533  if (invoice && trans == gncInvoiceGetPostedTxn (invoice))
2534  trans->txn_type = TXN_TYPE_INVOICE;
2535  else if (invoice || gncOwnerGetOwnerFromLot (lot, &owner))
2536  trans->txn_type = TXN_TYPE_PAYMENT;
2537  }
2538  }
2539 
2540  if (!has_nonAPAR_amount && (trans->txn_type == TXN_TYPE_PAYMENT))
2541  trans->txn_type = TXN_TYPE_LINK;
2542 
2543  return trans->txn_type;
2544 }
#define TXN_TYPE_INVOICE
Transaction is an invoice.
Definition: Transaction.h:126
GNCAccountType xaccAccountGetType(const Account *acc)
Returns the account&#39;s account type.
Definition: Account.cpp:3285
gboolean gnc_numeric_zero_p(gnc_numeric a)
Returns 1 if the given gnc_numeric is 0 (zero), else returns 0.
#define TXN_TYPE_NONE
No transaction type.
Definition: Transaction.h:125
gboolean gncOwnerGetOwnerFromLot(GNCLot *lot, GncOwner *owner)
Get the owner from the lot.
Definition: gncOwner.c:637
gboolean xaccAccountIsAPARType(GNCAccountType t)
Convenience function to check if the account is a valid business account type (meaning an Accounts Pa...
Definition: Account.cpp:4694
#define TXN_TYPE_LINK
Transaction is a link between (invoice and payment) lots.
Definition: Transaction.h:128
#define TXN_TYPE_PAYMENT
Transaction is a payment.
Definition: Transaction.h:127
GncInvoice * gncInvoiceGetInvoiceFromLot(GNCLot *lot)
Given a LOT, find and return the Invoice attached to the lot.
Definition: gncInvoice.c:1314
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction&#39;s commodity.
Definition: gmock-Split.cpp:84
Account * xaccSplitGetAccount(const Split *split)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: gmock-Split.cpp:53
SplitList * xaccTransGetSplitList(const Transaction *trans)
The xaccTransGetSplitList() method returns a GList of the splits in a transaction.
Definition: Transaction.c:2279
GNCLot * xaccSplitGetLot(const Split *split)
Returns the pointer to the debited/credited Lot where this split belongs to, or NULL if it doesn&#39;t be...
Definition: Split.c:1879

◆ xaccTransGetVoidReason()

const char* xaccTransGetVoidReason ( const Transaction *  transaction)

Returns the user supplied textual reason why a transaction was voided.

Parameters
transactionThe transaction in question.
Returns
A pointer to the user supplied reason for voiding.

Definition at line 2780 of file Transaction.c.

2781 {
2782  g_return_val_if_fail (trans, NULL);
2783 
2784  GValue v = G_VALUE_INIT;
2785  qof_instance_get_kvp (QOF_INSTANCE (trans), &v, 1, void_reason_str);
2786  const char *void_reason = G_VALUE_HOLDS_STRING (&v) ? g_value_get_string (&v) : NULL;
2787  g_value_unset (&v);
2788 
2789  return void_reason;
2790 }
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.

◆ xaccTransGetVoidStatus()

gboolean xaccTransGetVoidStatus ( const Transaction *  transaction)

Retrieve information on whether or not a transaction has been voided.

Parameters
transactionThe transaction in question.
Returns
TRUE if the transaction is void, FALSE otherwise. Also returns FALSE upon an error.

Definition at line 2773 of file Transaction.c.

2774 {
2775  const char *s = xaccTransGetVoidReason (trans);
2776  return (s && *s);
2777 }
const char * xaccTransGetVoidReason(const Transaction *trans)
Returns the user supplied textual reason why a transaction was voided.
Definition: Transaction.c:2780

◆ xaccTransGetVoidTime()

time64 xaccTransGetVoidTime ( const Transaction *  tr)

Returns the time that a transaction was voided.

Parameters
trThe transaction in question.
Returns
A time64 containing the time that this transaction was voided. Returns a time of zero upon error.

Definition at line 2793 of file Transaction.c.

2794 {
2795  GValue v = G_VALUE_INIT;
2796  const char *s = NULL;
2797  time64 void_time = 0;
2798 
2799  g_return_val_if_fail(tr, void_time);
2800  qof_instance_get_kvp (QOF_INSTANCE (tr), &v, 1, void_time_str);
2801  if (G_VALUE_HOLDS_STRING (&v))
2802  {
2803  s = g_value_get_string (&v);
2804  if (s)
2805  void_time = gnc_iso8601_to_time64_gmt (s);
2806  }
2807  g_value_unset (&v);
2808  return void_time;
2809 }
time64 gnc_iso8601_to_time64_gmt(const gchar *)
The gnc_iso8601_to_time64_gmt() routine converts an ISO-8601 style date/time string to time64...
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.
gint64 time64
Many systems, including Microsoft Windows and BSD-derived Unixes like Darwin, are retaining the int-3...
Definition: gnc-date.h:93

◆ xaccTransIsBalanced()

gboolean xaccTransIsBalanced ( const Transaction *  trans)

Returns true if the transaction is balanced according to the rules currently in effect.

Definition at line 1126 of file Transaction.c.

1127 {
1128  MonetaryList *imbal_list;
1129  gboolean result;
1130  gnc_numeric imbal = gnc_numeric_zero();
1131  gnc_numeric imbal_trading = gnc_numeric_zero();
1132 
1133  if (trans == NULL) return FALSE;
1134 
1135  if (xaccTransUseTradingAccounts(trans))
1136  {
1137  /* Transaction is imbalanced if the value is imbalanced in either
1138  trading or non-trading splits. One can't be used to balance
1139  the other. */
1140  FOR_EACH_SPLIT(trans,
1141  {
1142  Account *acc = xaccSplitGetAccount(s);
1143  if (!acc || xaccAccountGetType(acc) != ACCT_TYPE_TRADING)
1144  {
1145  imbal = gnc_numeric_add(imbal, xaccSplitGetValue(s),
1147  }
1148  else
1149  {
1150  imbal_trading = gnc_numeric_add(imbal_trading, xaccSplitGetValue(s),
1152  }
1153  }
1154  );
1155  }
1156  else
1157  imbal = xaccTransGetImbalanceValue(trans);
1158 
1159  if (! gnc_numeric_zero_p(imbal) || ! gnc_numeric_zero_p(imbal_trading))
1160  return FALSE;
1161 
1162  if (!xaccTransUseTradingAccounts (trans))
1163  return TRUE;
1164 
1165  imbal_list = xaccTransGetImbalance(trans);
1166  result = imbal_list == NULL;
1167  gnc_monetary_list_free(imbal_list);
1168  return result;
1169 }
gboolean xaccTransUseTradingAccounts(const Transaction *trans)
Determine whether this transaction should use commodity trading accounts.
Definition: Transaction.c:1017
GNCAccountType xaccAccountGetType(const Account *acc)
Returns the account&#39;s account type.
Definition: Account.cpp:3285
gnc_numeric gnc_numeric_add(gnc_numeric a, gnc_numeric b, gint64 denom, gint how)
Return a+b.
gboolean gnc_numeric_zero_p(gnc_numeric a)
Returns 1 if the given gnc_numeric is 0 (zero), else returns 0.
Use any denominator which gives an exactly correct ratio of numerator to denominator.
Definition: gnc-numeric.h:189
Account used to record multiple commodity transactions.
Definition: Account.h:158
gnc_numeric xaccTransGetImbalanceValue(const Transaction *trans)
The xaccTransGetImbalanceValue() method returns the total value of the transaction.
Definition: Transaction.c:1038
void gnc_monetary_list_free(MonetaryList *list)
Free a MonetaryList and all the monetaries it points to.
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction&#39;s commodity.
Definition: gmock-Split.cpp:84
Account * xaccSplitGetAccount(const Split *split)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: gmock-Split.cpp:53
MonetaryList * xaccTransGetImbalance(const Transaction *trans)
The xaccTransGetImbalance method returns a list giving the value of the transaction in each currency ...
Definition: Transaction.c:1054
#define GNC_DENOM_AUTO
Values that can be passed as the &#39;denom&#39; argument.
Definition: gnc-numeric.h:246

◆ xaccTransIsOpen()

gboolean xaccTransIsOpen ( const Transaction *  trans)

The xaccTransIsOpen() method returns TRUE if the transaction is open for editing.

Otherwise, it returns false. XXX this routine should probably be deprecated. its, umm, hard to imagine legitimate uses (but it is used by the import/export code for reasons I can't understand.)

Definition at line 134 of file gmock-Transaction.cpp.

135 {
136  SCOPED_TRACE("");
137  auto mocktrans = gnc_mocktransaction(trans);
138  return mocktrans ? mocktrans->is_open() : FALSE;
139 }

◆ xaccTransIsReadonlyByPostedDate()

gboolean xaccTransIsReadonlyByPostedDate ( const Transaction *  trans)

Returns TRUE if this Transaction is read-only because its posted-date is older than the "auto-readonly" threshold of this book.

See qof_book_uses_autofreeze() and qof_book_get_autofreeze_gdate().

Definition at line 2583 of file Transaction.c.

2584 {
2585  GDate *threshold_date;
2586  GDate trans_date;
2587  const QofBook *book = xaccTransGetBook (trans);
2588  gboolean result;
2589  g_assert(trans);
2590 
2591  if (!qof_book_uses_autoreadonly(book))
2592  {
2593  return FALSE;
2594  }
2595 
2596  if (xaccTransIsSXTemplate (trans))
2597  return FALSE;
2598 
2599  threshold_date = qof_book_get_autoreadonly_gdate(book);
2600  g_assert(threshold_date); // ok because we checked uses_autoreadonly before
2601  trans_date = xaccTransGetDatePostedGDate(trans);
2602 
2603 // g_warning("there is auto-read-only with days=%d, trans_date_day=%d, threshold_date_day=%d",
2604 // qof_book_get_num_days_autofreeze(book),
2605 // g_date_get_day(&trans_date),
2606 // g_date_get_day(threshold_date));
2607 
2608  if (g_date_compare(&trans_date, threshold_date) < 0)
2609  {
2610  //g_warning("we are auto-read-only");
2611  result = TRUE;
2612  }
2613  else
2614  {
2615  result = FALSE;
2616  }
2617  g_date_free(threshold_date);
2618  return result;
2619 }
GDate * qof_book_get_autoreadonly_gdate(const QofBook *book)
Returns the GDate that is the threshold for auto-read-only.
Definition: qofbook.cpp:1114
#define xaccTransGetBook(X)
Definition: Transaction.h:791
gboolean qof_book_uses_autoreadonly(const QofBook *book)
Returns TRUE if the auto-read-only feature should be used, otherwise FALSE.
Definition: qofbook.cpp:1088
GDate xaccTransGetDatePostedGDate(const Transaction *trans)
Retrieve the posted date of the transaction.
Definition: Transaction.c:2449

◆ xaccTransLookup()

Transaction* xaccTransLookup ( const GncGUID guid,
QofBook *  book 
)

The xaccTransLookup() subroutine will return the transaction associated with the given id, or NULL if there is no such transaction.

Definition at line 1026 of file Transaction.c.

1027 {
1028  QofCollection *col;
1029  if (!guid || !book) return NULL;
1030  col = qof_book_get_collection (book, GNC_ID_TRANS);
1031  return (Transaction *) qof_collection_lookup_entity (col, guid);
1032 }
QofInstance * qof_collection_lookup_entity(const QofCollection *col, const GncGUID *guid)
Find the entity going only from its guid.
Definition: qofid.cpp:215
QofCollection * qof_book_get_collection(const QofBook *book, QofIdType entity_type)
Return The table of entities of the given type.
Definition: qofbook.cpp:606

◆ xaccTransOrder()

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

The xaccTransOrder(ta,tb) method is useful for sorting.

Orders ta and tb return <0 if ta sorts before tb return >0 if ta sorts after tb return 0 if they are absolutely equal

The comparrison uses the following fields, in order: date posted (compare as a date) num field (compare as an integer) date entered (compare as a date) description field (comcpare as a string using strcmp()) GncGUID (compare as a guid) Finally, it returns zero if all of the above match. Note that it does NOT compare its member splits. Note also that it calls xaccTransOrder_num_action with actna and actnb set as NULL.

Definition at line 1882 of file Transaction.c.

1883 {
1884  return xaccTransOrder_num_action (ta, NULL, tb, NULL);
1885 }
int xaccTransOrder_num_action(const Transaction *ta, const char *actna, const Transaction *tb, const char *actnb)
The xaccTransOrder_num_action(ta,actna,tb,actnb) method is useful for sorting.
Definition: Transaction.c:1918

◆ xaccTransOrder_num_action()

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

The xaccTransOrder_num_action(ta,actna,tb,actnb) method is useful for sorting.

Orders ta and tb return <0 if ta sorts before tb return >0 if ta sorts after tb return 0 if they are absolutely equal

The comparrison uses the following fields, in order: date posted (compare as a date) if actna and actnb are NULL, num field (compare as an integer) else actna and actnb (compare as an integer) date entered (compare as a date) description field (comcpare as a string using strcmp()) GncGUID (compare as a guid) Finally, it returns zero if all of the above match. Note that it does NOT compare its member splits (except action as specified above).

Definition at line 1918 of file Transaction.c.

1920 {
1921  const char *da, *db;
1922  int retval;
1923  int64_t na, nb;
1924 
1925  if ( ta && !tb ) return -1;
1926  if ( !ta && tb ) return +1;
1927  if ( !ta && !tb ) return 0;
1928 
1929  if (ta->date_posted != tb->date_posted)
1930  return (ta->date_posted > tb->date_posted) - (ta->date_posted < tb->date_posted);
1931 
1932  /* Always sort closing transactions after normal transactions */
1933  {
1934  gboolean ta_is_closing = xaccTransGetIsClosingTxn (ta);
1935  gboolean tb_is_closing = xaccTransGetIsClosingTxn (tb);
1936  if (ta_is_closing != tb_is_closing)
1937  return (ta_is_closing - tb_is_closing);
1938  }
1939 
1940  /* otherwise, sort on number string */
1941  if (actna && actnb) /* split action string, if not NULL */
1942  {
1943  retval = order_by_int64_or_string (actna, actnb);
1944  }
1945  else /* else transaction num string */
1946  {
1947  retval = order_by_int64_or_string (ta->num, tb->num);
1948  }
1949  if (retval)
1950  return retval;
1951 
1952  if (ta->date_entered != tb->date_entered)
1953  return (ta->date_entered > tb->date_entered) - (ta->date_entered < tb->date_entered);
1954 
1955  /* otherwise, sort on description string */
1956  da = ta->description ? ta->description : "";
1957  db = tb->description ? tb->description : "";
1958  retval = g_utf8_collate (da, db);
1959  if (retval)
1960  return retval;
1961 
1962  /* else, sort on guid - keeps sort stable. */
1963  return qof_instance_guid_compare(ta, tb);
1964 }
gboolean xaccTransGetIsClosingTxn(const Transaction *trans)
Returns whether this transaction is a "closing transaction".
Definition: Transaction.c:2409
gint qof_instance_guid_compare(gconstpointer ptr1, gconstpointer ptr2)
Compare the GncGUID values of two instances.

◆ xaccTransRecordPrice()

void xaccTransRecordPrice ( Transaction *  trans,
PriceSource  source 
)

The xaccTransRecordPrice() method iterates through the splits and and record the non-currency equivalent prices in the price database.

Parameters
transThe transaction whose price is recorded
sourceThe price priority level

Definition at line 149 of file gmock-Transaction.cpp.

150 {
151  g_return_if_fail(GNC_IS_MOCKTRANSACTION(trans));
152  ((MockTransaction*)trans)->recordPrice();
153 }

◆ xaccTransRetDateEntered()

time64 xaccTransRetDateEntered ( const Transaction *  trans)

Retrieve the date of when the transaction was entered.

The entered date is the date when the register entry was made.

Definition at line 2484 of file Transaction.c.

2485 {
2486  return trans ? trans->date_entered : 0;
2487 }

◆ xaccTransRetDatePosted()

time64 xaccTransRetDatePosted ( const Transaction *  trans)

Retrieve the posted date of the transaction.

The posted date is the date when this transaction was posted at the bank. (Although having different function names, GetDate and GetDatePosted refer to the same single date.)

Definition at line 2443 of file Transaction.c.

2444 {
2445  return trans ? trans->date_posted : 0;
2446 }

◆ xaccTransReverse()

Transaction* xaccTransReverse ( Transaction *  transaction)

xaccTransReverse creates a Transaction that reverses the given transaction by inverting all the numerical values in the given transaction.

This function cancels out the effect of an earlier transaction. This will be needed by write only accounts as a way to void a previous transaction (since you can't alter the existing transaction).

Parameters
transactionThe transaction to create a reverse of.
Returns
a new transaction which reverses the given transaction

Definition at line 2838 of file Transaction.c.

2839 {
2840  Transaction *trans;
2841  GValue v = G_VALUE_INIT;
2842  g_return_val_if_fail(orig, NULL);
2843 
2844  /* First edit, dirty, and commit orig to ensure that any trading
2845  * splits are correctly balanced.
2846  */
2847  xaccTransBeginEdit (orig);
2848  qof_instance_set_dirty (QOF_INSTANCE (orig));
2849  xaccTransCommitEdit (orig);
2850 
2851  trans = xaccTransClone(orig);
2852  g_return_val_if_fail (trans, NULL);
2853  xaccTransBeginEdit(trans);
2854 
2855  /* Reverse the values on each split. Clear per-split info. */
2856  FOR_EACH_SPLIT(trans,
2857  {
2861  });
2862 
2863  /* Now update the original with a pointer to the new one */
2864  g_value_init (&v, GNC_TYPE_GUID);
2865  g_value_set_static_boxed (&v, xaccTransGetGUID(trans));
2866  qof_instance_set_kvp (QOF_INSTANCE (orig), &v, 1, TRANS_REVERSED_BY);
2867  g_value_unset (&v);
2868 
2869  /* Make sure the reverse transaction is not read-only */
2870  xaccTransClearReadOnly(trans);
2871 
2872  qof_instance_set_dirty(QOF_INSTANCE(trans));
2873  xaccTransCommitEdit(trans);
2874  return trans;
2875 }
void xaccSplitSetValue(Split *split, gnc_numeric val)
The xaccSplitSetValue() method sets the value of this split in the transaction&#39;s commodity.
Definition: gmock-Split.cpp:92
void qof_instance_set_kvp(QofInstance *, GValue const *value, unsigned count,...)
Sets a KVP slot to a value from a GValue.
gnc_numeric gnc_numeric_neg(gnc_numeric a)
Returns a newly created gnc_numeric that is the negative of the given gnc_numeric value...
void xaccSplitSetReconcile(Split *split, char recn)
Set the reconcile flag.
void xaccSplitSetAmount(Split *split, gnc_numeric amt)
The xaccSplitSetAmount() method sets the amount in the account&#39;s commodity that the split should have...
Definition: gmock-Split.cpp:77
Transaction * xaccTransClone(const Transaction *from)
The xaccTransClone() method will create a complete copy of an existing transaction.
Definition: Transaction.c:674
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1637
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1438
#define xaccTransGetGUID(X)
Definition: Transaction.h:793
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction&#39;s commodity.
Definition: gmock-Split.cpp:84
#define NREC
not reconciled or cleared
Definition: Split.h:74
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account&#39;s commodity.
Definition: gmock-Split.cpp:69

◆ xaccTransRollbackEdit()

void xaccTransRollbackEdit ( Transaction *  trans)

The xaccTransRollbackEdit() routine rejects all edits made, and sets the transaction back to where it was before the editing started.

This includes restoring any deleted splits, removing any added splits, and undoing the effects of xaccTransDestroy, as well as restoring share quantities, memos, descriptions, etc.

Todo:
Fix transrollbackedit in QOF so that rollback is exposed via the API.

Definition at line 1713 of file Transaction.c.

1714 {
1715  GList *node, *onode;
1716  QofBackend *be;
1717  Transaction *orig;
1718  GList *slist;
1719  int num_preexist, i;
1720 
1721 /* FIXME: This isn't quite the right way to handle nested edits --
1722  * there should be a stack of transaction states that are popped off
1723  * and restored at each level -- but it does prevent restoring to the
1724  * editlevel 0 state until one is returning to editlevel 0, and
1725  * thereby prevents a crash caused by trans->orig getting NULLed too
1726  * soon.
1727  */
1728  if (!qof_instance_get_editlevel (QOF_INSTANCE (trans))) return;
1729  if (qof_instance_get_editlevel (QOF_INSTANCE (trans)) > 1) {
1730  qof_instance_decrease_editlevel (QOF_INSTANCE (trans));
1731  return;
1732  }
1733 
1734  ENTER ("trans addr=%p\n", trans);
1735 
1736  check_open(trans);
1737 
1738  /* copy the original values back in. */
1739 
1740  orig = trans->orig;
1741  SWAP_STR(trans->num, orig->num);
1742  SWAP_STR(trans->description, orig->description);
1743  trans->date_entered = orig->date_entered;
1744  trans->date_posted = orig->date_posted;
1745  SWAP(trans->common_currency, orig->common_currency);
1746  qof_instance_swap_kvp (QOF_INSTANCE (trans), QOF_INSTANCE (orig));
1747 
1748  /* The splits at the front of trans->splits are exactly the same
1749  splits as in the original, but some of them may have changed, so
1750  we restore only those. */
1751 /* FIXME: Runs off the transaction's splits, so deleted splits are not
1752  * restored!
1753  */
1754  num_preexist = g_list_length(orig->splits);
1755  slist = g_list_copy(trans->splits);
1756  for (i = 0, node = slist, onode = orig->splits; node;
1757  i++, node = node->next, onode = onode ? onode->next : NULL)
1758  {
1759  Split *s = node->data;
1760 
1761  if (!qof_instance_is_dirty(QOF_INSTANCE(s)))
1762  continue;
1763 
1764  if (i < num_preexist && onode)
1765  {
1766  Split *so = onode->data;
1767 
1768  xaccSplitRollbackEdit(s);
1769  SWAP_STR(s->action, so->action);
1770  SWAP_STR(s->memo, so->memo);
1771  qof_instance_copy_kvp (QOF_INSTANCE (s), QOF_INSTANCE (so));
1772  s->reconciled = so->reconciled;
1773  s->amount = so->amount;
1774  s->value = so->value;
1775  s->lot = so->lot;
1776  s->gains_split = so->gains_split;
1777  //SET_GAINS_A_VDIRTY(s);
1778  s->date_reconciled = so->date_reconciled;
1779  qof_instance_mark_clean(QOF_INSTANCE(s));
1780  }
1781  else
1782  {
1783  /* Potentially added splits */
1784  if (trans != xaccSplitGetParent(s))
1785  {
1786  trans->splits = g_list_remove(trans->splits, s);
1787  /* New split added, but then moved to another
1788  transaction */
1789  continue;
1790  }
1791  xaccSplitRollbackEdit(s);
1792  trans->splits = g_list_remove(trans->splits, s);
1793  g_assert(trans != xaccSplitGetParent(s));
1794  /* NB: our memory management policy here is that a new split
1795  added to the transaction which is then rolled-back still
1796  belongs to the engine. Specifically, it's freed by the
1797  transaction to which it was added. Don't add the Split to
1798  more than one transaction during the begin/commit block! */
1799  if (NULL == xaccSplitGetParent(s))
1800  {
1801  xaccFreeSplit(s); // a newly malloc'd split
1802  }
1803  }
1804  }
1805  g_list_free(slist);
1806 
1807  // orig->splits may still have duped splits so free them
1808  for (node = orig->splits; node; node = node->next)
1809  xaccFreeSplit(node->data);
1810  g_list_free(orig->splits);
1811  orig->splits = NULL;
1812 
1813  /* Now that the engine copy is back to its original version,
1814  * get the backend to fix it in the database */
1818  if (qof_backend_can_rollback (be))
1819  {
1820  QofBackendError errcode;
1821 
1822  /* clear errors */
1823  do
1824  {
1825  errcode = qof_backend_get_error (be);
1826  }
1827  while (ERR_BACKEND_NO_ERR != errcode);
1828 
1829  qof_backend_rollback_instance (be, &(trans->inst));
1830 
1831  errcode = qof_backend_get_error (be);
1832  if (ERR_BACKEND_MOD_DESTROY == errcode)
1833  {
1834  /* The backend is asking us to delete this transaction.
1835  * This typically happens because another (remote) user
1836  * has deleted this transaction, and we haven't found
1837  * out about it until this user tried to edit it.
1838  */
1839  xaccTransDestroy (trans);
1840  do_destroy (trans);
1841 
1842  /* push error back onto the stack */
1843  qof_backend_set_error (be, errcode);
1844  LEAVE ("deleted trans addr=%p\n", trans);
1845  return;
1846  }
1847  if (ERR_BACKEND_NO_ERR != errcode)
1848  {
1849  PERR ("Rollback Failed. Ouch!");
1850  /* push error back onto the stack */
1851  qof_backend_set_error (be, errcode);
1852  }
1853  }
1854 
1856  xaccTransWriteLog (trans, 'R');
1857 
1858  xaccFreeTransaction (trans->orig);
1859 
1860  trans->orig = NULL;
1861  qof_instance_set_destroying(trans, FALSE);
1862 
1863  /* Put back to zero. */
1864  qof_instance_decrease_editlevel(trans);
1865  /* FIXME: The register code seems to depend on the engine to
1866  generate an event during rollback, even though the state is just
1867  reverting to what it was. */
1868  gen_event_trans (trans);
1869 
1870  LEAVE ("trans addr=%p\n", trans);
1871 }
commit of object update failed because another user has deleted the object
Definition: qofbackend.h:77
#define qof_instance_is_dirty
Return value of is_dirty flag.
Definition: qofinstance.h:162
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.
QofBackendError
The errors that can be reported to the GUI & other front-end users.
Definition: qofbackend.h:57
void xaccTransWriteLog(Transaction *trans, char flag)
Definition: TransLog.c:223
void qof_backend_set_error(QofBackend *qof_be, QofBackendError err)
Set the error on the specified QofBackend.
Transaction * xaccSplitGetParent(const Split *split)
Returns the parent transaction of the split.
#define PERR(format, args...)
Log a serious error.
Definition: qoflog.h:244
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
QofBackendError qof_backend_get_error(QofBackend *qof_be)
Get the last backend error.
void xaccTransDestroy(Transaction *trans)
Destroys a transaction.
Definition: Transaction.c:1460
gboolean qof_book_is_readonly(const QofBook *book)
Return whether the book is read only.
Definition: qofbook.cpp:582
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282
QofBackend * qof_book_get_backend(const QofBook *book)
Retrieve the backend used by this book.
Definition: qofbook.cpp:526

◆ xaccTransScrubGains()

void xaccTransScrubGains ( Transaction *  trans,
Account gain_acc 
)

The xaccTransScrubGains() routine performs a number of cleanup functions on the indicated transaction, with the end-goal of setting up a consistent set of gains/losses for all the splits in the transaction.

This includes making sure that the lot assignments of all the splits are good, and that the lots balance appropriately.

Definition at line 2953 of file Transaction.c.

2954 {
2955  SplitList *node;
2956 
2957  ENTER("(trans=%p)", trans);
2958  /* Lock down posted date, its to be synced to the posted date
2959  * for the source of the cap gains. */
2960  xaccTransScrubGainsDate(trans);
2961 
2962  /* Fix up the split amount */
2963 restart:
2964  for (node = trans->splits; node; node = node->next)
2965  {
2966  Split *s = node->data;
2967 
2968  if (!xaccTransStillHasSplit(trans, s)) continue;
2969 
2970  xaccSplitDetermineGainStatus(s);
2971  if (s->gains & GAINS_STATUS_ADIRTY)
2972  {
2973  gboolean altered = FALSE;
2974  s->gains &= ~GAINS_STATUS_ADIRTY;
2975  if (s->lot)
2976  altered = xaccScrubLot(s->lot);
2977  else
2978  altered = xaccSplitAssign(s);
2979  if (altered) goto restart;
2980  }
2981  }
2982 
2983  /* Fix up gains split value */
2984  FOR_EACH_SPLIT(trans,
2985  if ((s->gains & GAINS_STATUS_VDIRTY) ||
2986  (s->gains_split &&
2987  (s->gains_split->gains & GAINS_STATUS_VDIRTY)))
2988  xaccSplitComputeCapGains(s, gain_acc);
2989  );
2990 
2991  LEAVE("(trans=%p)", trans);
2992 }
void xaccSplitComputeCapGains(Split *split, Account *gain_acc)
The xaccSplitComputeCapGains() routine computes the cap gains or losses for the indicated split...
Definition: cap-gains.c:528
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
GList SplitList
GList of Split.
Definition: gnc-engine.h:211
gboolean xaccSplitAssign(Split *split)
The`xaccSplitAssign() routine will take the indicated split and, if it doesn&#39;t already belong to a lo...
Definition: cap-gains.c:428
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282
gboolean xaccScrubLot(GNCLot *lot)
The xaccScrubLot() routine makes sure that the indicated lot is self-consistent and properly balanced...
Definition: Scrub3.c:85

◆ xaccTransSetCurrency()

void xaccTransSetCurrency ( Transaction *  trans,
gnc_commodity *  curr 
)

Set the commodity of this transaction.

Set the commodity of this transaction.

When we do that to a transaction with splits we need to re-value all of the splits in the new currency.

Parameters
transThe transaction to change
currThe new currency to set.

Definition at line 1409 of file Transaction.c.

1410 {
1411  gnc_commodity *old_curr = trans->common_currency;
1412  if (!trans || !curr || trans->common_currency == curr) return;
1413  xaccTransBeginEdit(trans);
1414 
1415  trans->common_currency = curr;
1416  if (old_curr != NULL && trans->splits != NULL)
1417  {
1418  gnc_numeric rate = find_new_rate(trans, curr);
1419  if (!gnc_numeric_zero_p (rate))
1420  {
1421  FOR_EACH_SPLIT(trans, split_set_new_value(s, curr, old_curr, rate));
1422  }
1423  else
1424  {
1425  FOR_EACH_SPLIT(trans, xaccSplitSetValue(s, xaccSplitGetValue(s)));
1426  }
1427  }
1428 
1429  qof_instance_set_dirty(QOF_INSTANCE(trans));
1430  mark_trans(trans); /* Dirty balance of every account in trans */
1431  xaccTransCommitEdit(trans);
1432 }
void xaccSplitSetValue(Split *split, gnc_numeric val)
The xaccSplitSetValue() method sets the value of this split in the transaction&#39;s commodity.
Definition: gmock-Split.cpp:92
gboolean gnc_numeric_zero_p(gnc_numeric a)
Returns 1 if the given gnc_numeric is 0 (zero), else returns 0.
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1637
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1438
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction&#39;s commodity.
Definition: gmock-Split.cpp:84

◆ xaccTransSetDate()

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

The xaccTransSetDate() method does the same thing as xaccTransSetDate[Posted]Secs(), but takes a convenient day-month-year format.

(Footnote: this shouldn't matter to a user, but anyone modifying the engine should understand that when xaccTransCommitEdit() is called, the date order of each of the component splits will be checked, and will be restored in ascending date order.)

Definition at line 2066 of file Transaction.c.

2067 {
2068  GDate *date;
2069  if (!trans) return;
2070  date = g_date_new_dmy(day, mon, year);
2071  if (!g_date_valid(date))
2072  {
2073  PWARN("Attempted to set invalid date %d-%d-%d; set today's date instead.",
2074  year, mon, day);
2075  g_free(date);
2076  date = gnc_g_date_new_today();
2077  }
2078  xaccTransSetDatePostedGDate(trans, *date);
2079  g_free(date);
2080 }
void xaccTransSetDatePostedGDate(Transaction *trans, GDate date)
This method modifies posted date of the transaction, specified by a GDate.
Definition: Transaction.c:2021
#define PWARN(format, args...)
Log a warning.
Definition: qoflog.h:250
GDate * gnc_g_date_new_today()
Returns a newly allocated date of the current clock time, taken from time(2).
Definition: gnc-date.cpp:1229

◆ xaccTransSetDateEnteredSecs()

void xaccTransSetDateEnteredSecs ( Transaction *  trans,
time64  time 
)

Modify the date of when the transaction was entered.

The entered date is the date when the register entry was made.

Definition at line 2040 of file Transaction.c.

2041 {
2042  if (!trans) return;
2043  xaccTransSetDateInternal(trans, &trans->date_entered, secs);
2044 }

◆ xaccTransSetDatePostedGDate()

void xaccTransSetDatePostedGDate ( Transaction *  trans,
GDate  date 
)

This method modifies posted date of the transaction, specified by a GDate.

The posted date is the date when this transaction was posted at the bank.

This is identical to xaccTransSetDate(), but different from xaccTransSetDatePostedSecs which artificially introduces the time-of-day part, which needs to be ignored.

Definition at line 2021 of file Transaction.c.

2022 {
2023  GValue v = G_VALUE_INIT;
2024  if (!trans) return;
2025 
2026  /* We additionally save this date into a kvp frame to ensure in
2027  * the future a date which was set as *date* (without time) can
2028  * clearly be distinguished from the time64. */
2029  g_value_init (&v, G_TYPE_DATE);
2030  g_value_set_static_boxed (&v, &date);
2031  qof_instance_set_kvp (QOF_INSTANCE(trans), &v, 1, TRANS_DATE_POSTED);
2032  g_value_unset (&v);
2033  /* mark dirty and commit handled by SetDateInternal */
2034  xaccTransSetDateInternal(trans, &trans->date_posted,
2035  gdate_to_time64(date));
2036  set_gains_date_dirty (trans);
2037 }
void qof_instance_set_kvp(QofInstance *, GValue const *value, unsigned count,...)
Sets a KVP slot to a value from a GValue.
time64 gdate_to_time64(GDate d)
Turns a GDate into a time64, returning the first second of the day.
Definition: gnc-date.cpp:1257

◆ xaccTransSetDatePostedSecs()

void xaccTransSetDatePostedSecs ( Transaction *  trans,
time64  time 
)

The xaccTransSetDatePostedSecs() method will modify the posted date of the transaction, specified by a time64 (see ctime(3)).

The posted date is the date when this transaction was posted at the bank.

Please do not use this function, as the extra time-of-day part messes up a lot of places. Rather, please use xaccTransSetDatePostedGDate() or xaccTransSetDatePostedSecsNormalized().

Definition at line 2005 of file Transaction.c.

2006 {
2007  if (!trans) return;
2008  xaccTransSetDateInternal(trans, &trans->date_posted, secs);
2009  set_gains_date_dirty(trans);
2010 }

◆ xaccTransSetDatePostedSecsNormalized()

void xaccTransSetDatePostedSecsNormalized ( Transaction *  trans,
time64  time 
)

This function sets the posted date of the transaction, specified by a time64 (see ctime(3)).

Contrary to xaccTransSetDatePostedSecs(), the time will be normalized to only the date part, and the time-of-day will be ignored. The resulting date is the same as if it had been set as a GDate through xaccTransSetDatePostedGDate().

Please prefer this function over xaccTransSetDatePostedSecs().

The posted date is the date when this transaction was posted at the bank.

Definition at line 81 of file gmock-Transaction.cpp.

82 {
83  ASSERT_TRUE(GNC_IS_MOCKTRANSACTION(trans));
84  gnc_mocktransaction(trans)->set_date_posted_secs_normalized(time);
85 }

◆ xaccTransSetNotes()

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

Sets the transaction Notes.

The Notes field is only visible in the register in double-line mode

Definition at line 111 of file gmock-Transaction.cpp.

112 {
113  ASSERT_TRUE(GNC_IS_MOCKTRANSACTION(trans));
114  gnc_mocktransaction(trans)->set_notes(notes);
115 }

◆ xaccTransSetReadOnly()

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

Set the transaction to be ReadOnly by setting a non-NULL value as "reason".

FIXME: If "reason" is NULL, this function does nothing, instead of removing the readonly flag; the actual removal is possible only through xaccTransClearReadOnly().

Definition at line 2129 of file Transaction.c.

2130 {
2131  if (trans && reason)
2132  {
2133  GValue v = G_VALUE_INIT;
2134  g_value_init (&v, G_TYPE_STRING);
2135  g_value_set_static_string (&v, reason);
2136  xaccTransBeginEdit(trans);
2137  qof_instance_set_kvp (QOF_INSTANCE (trans), &v, 1, TRANS_READ_ONLY_REASON);
2138  qof_instance_set_dirty(QOF_INSTANCE(trans));
2139  g_value_unset (&v);
2140  xaccTransCommitEdit(trans);
2141  }
2142 }
void qof_instance_set_kvp(QofInstance *, GValue const *value, unsigned count,...)
Sets a KVP slot to a value from a GValue.
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1637
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1438

◆ xaccTransSetTxnType()

void xaccTransSetTxnType ( Transaction *  trans,
char  type 
)

Set the Transaction Type: note the type will be saved into the Transaction kvp property as a backward compatibility measure, for previous GnuCash versions whose xaccTransGetTxnType reads from the kvp slots.

See TXN_TYPE_NONE, TXN_TYPE_INVOICE and TXN_TYPE_PAYMENT

Definition at line 2097 of file Transaction.c.

2098 {
2099  char s[2] = {type, '\0'};
2100  GValue v = G_VALUE_INIT;
2101  g_return_if_fail(trans);
2102  g_value_init (&v, G_TYPE_STRING);
2103  qof_instance_get_kvp (QOF_INSTANCE (trans), &v, 1, TRANS_TXN_TYPE_KVP);
2104  if (!g_strcmp0 (s, g_value_get_string (&v)))
2105  {
2106  g_value_unset (&v);
2107  return;
2108  }
2109  g_value_set_static_string (&v, s);
2110  xaccTransBeginEdit(trans);
2111  qof_instance_set_kvp (QOF_INSTANCE (trans), &v, 1, TRANS_TXN_TYPE_KVP);
2112  qof_instance_set_dirty(QOF_INSTANCE(trans));
2113  g_value_unset (&v);
2114  xaccTransCommitEdit(trans);
2115 }
void qof_instance_set_kvp(QofInstance *, GValue const *value, unsigned count,...)
Sets a KVP slot to a value from a GValue.
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1637
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1438

◆ xaccTransUnvoid()

void xaccTransUnvoid ( Transaction *  transaction)

xaccTransUnvoid restores a voided transaction to its original state.

At some point when gnucash is enhanced to support an audit trail (i.e. write only transactions) this command should be automatically disabled when the audit trail feature is enabled.

Parameters
transactionThe transaction to restore from voided state.

Definition at line 2812 of file Transaction.c.

2813 {
2814  GValue v = G_VALUE_INIT;
2815  const char *s = NULL;
2816  g_return_if_fail(trans);
2817 
2818  s = xaccTransGetVoidReason (trans);
2819  if (s == NULL) return; /* Transaction isn't voided. Bail. */
2820  xaccTransBeginEdit(trans);
2821 
2822  qof_instance_get_kvp (QOF_INSTANCE (trans), &v, 1, void_former_notes_str);
2823  if (G_VALUE_HOLDS_STRING (&v))
2824  qof_instance_set_kvp (QOF_INSTANCE (trans), &v, 1, trans_notes_str);
2825  qof_instance_set_kvp (QOF_INSTANCE (trans), NULL, 1, void_former_notes_str);
2826  qof_instance_set_kvp (QOF_INSTANCE (trans), NULL, 1, void_reason_str);
2827  qof_instance_set_kvp (QOF_INSTANCE (trans), NULL, 1, void_time_str);
2828  g_value_unset (&v);
2829 
2830  FOR_EACH_SPLIT(trans, xaccSplitUnvoid(s));
2831 
2832  /* Dirtying taken care of by ClearReadOnly */
2833  xaccTransClearReadOnly(trans);
2834  xaccTransCommitEdit(trans);
2835 }
void qof_instance_set_kvp(QofInstance *, GValue const *value, unsigned count,...)
Sets a KVP slot to a value from a GValue.
const char * xaccTransGetVoidReason(const Transaction *trans)
Returns the user supplied textual reason why a transaction was voided.
Definition: Transaction.c:2780
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1637
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1438

◆ xaccTransVoid()

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

xaccTransVoid voids a transaction.

A void transaction has no values, is unaffected by reconciliation, and, by default is not included in any queries. A voided transaction may not be altered.

Parameters
transactionThe transaction to void.
reasonThe textual reason why this transaction is being voided.

Definition at line 2733 of file Transaction.c.

2734 {
2735  GValue v = G_VALUE_INIT;
2736  char iso8601_str[ISO_DATELENGTH + 1] = "";
2737 
2738  g_return_if_fail(trans && reason);
2739 
2740  /* Prevent voiding transactions that are already marked
2741  * read only, for example generated by the business features.
2742  */
2743  if (xaccTransGetReadOnly (trans))
2744  {
2745  PWARN ("Refusing to void a read-only transaction!");
2746  return;
2747  }
2748  xaccTransBeginEdit(trans);
2749  qof_instance_get_kvp (QOF_INSTANCE (trans), &v, 1, trans_notes_str);
2750  if (G_VALUE_HOLDS_STRING (&v))
2751  qof_instance_set_kvp (QOF_INSTANCE (trans), &v, 1, void_former_notes_str);
2752  else
2753  g_value_init (&v, G_TYPE_STRING);
2754 
2755  g_value_set_static_string (&v, _("Voided transaction"));
2756  qof_instance_set_kvp (QOF_INSTANCE (trans), &v, 1, trans_notes_str);
2757  g_value_set_static_string (&v, reason);
2758  qof_instance_set_kvp (QOF_INSTANCE (trans), &v, 1, void_reason_str);
2759 
2760  gnc_time64_to_iso8601_buff (gnc_time(NULL), iso8601_str);
2761  g_value_set_static_string (&v, iso8601_str);
2762  qof_instance_set_kvp (QOF_INSTANCE (trans), &v, 1, void_time_str);
2763  g_value_unset (&v);
2764 
2765  FOR_EACH_SPLIT(trans, xaccSplitVoid(s));
2766 
2767  /* Dirtying taken care of by SetReadOnly */
2768  xaccTransSetReadOnly(trans, _("Transaction Voided"));
2769  xaccTransCommitEdit(trans);
2770 }
void qof_instance_set_kvp(QofInstance *, GValue const *value, unsigned count,...)
Sets a KVP slot to a value from a GValue.
const char * xaccTransGetReadOnly(Transaction *trans)
Returns a non-NULL value if this Transaction was marked as read-only with some specific "reason" text...
Definition: Transaction.c:2547
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.
#define PWARN(format, args...)
Log a warning.
Definition: qoflog.h:250
void xaccTransSetReadOnly(Transaction *trans, const char *reason)
Set the transaction to be ReadOnly by setting a non-NULL value as "reason".
Definition: Transaction.c:2129
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1637
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1438
time64 gnc_time(time64 *tbuf)
get the current local time
Definition: gnc-date.cpp:273
char * gnc_time64_to_iso8601_buff(time64 time, char *buff)
The gnc_time64_to_iso8601_buff() routine takes the input UTC time64 value and prints it as an ISO-860...
Definition: gnc-date.cpp:1142