GnuCash  5.6-150-g038405b370+
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 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))
 

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

These define the various reconciliations states a split can be in.

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...
 
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".
 
void xaccTransClearSplits (Transaction *trans)
 Remove all splits from the transaction. More...
 
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...
 
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...
 
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 552 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 381 of file Transaction.h.

◆ xaccTransGetBook

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

Definition at line 786 of file Transaction.h.

◆ xaccTransGetGUID

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

Definition at line 788 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 2523 of file Transaction.cpp.

2524 {
2525  guint count = 0;
2526  xaccAccountTreeForEachTransaction(gnc_book_get_root_account(book),
2527  counter_thunk, (void*)&count);
2528  return count;
2529 }
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 502 of file Transaction.cpp.

503 {
504  Transaction *trans;
505 
506  g_return_val_if_fail (book, nullptr);
507 
508  trans = GNC_TRANSACTION(g_object_new(GNC_TYPE_TRANSACTION, nullptr));
509  xaccInitTransaction (trans, book);
510  qof_event_gen (&trans->inst, QOF_EVENT_CREATE, nullptr);
511 
512  return trans;
513 }
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 2007 of file Split.cpp.

2009 {
2010  const GncGUID* guid;
2011 
2012  g_return_if_fail (split != nullptr);
2013  g_return_if_fail (other_split != nullptr);
2014 
2015  guid = qof_instance_get_guid (QOF_INSTANCE (other_split));
2016  xaccTransBeginEdit (split->parent);
2017  qof_instance_kvp_add_guid (QOF_INSTANCE (split), "lot-split",
2018  gnc_time(nullptr), "peer_guid", guid_copy(guid));
2019  mark_split (split);
2020  qof_instance_set_dirty (QOF_INSTANCE (split));
2021  xaccTransCommitEdit (split->parent);
2022 }
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:120
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 time
Definition: gnc-date.cpp:260
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 1676 of file Split.cpp.

1677 {
1678  Account *aa, *ab;
1679  if (!sa && !sb) return 0;
1680  if (!sa) return -1;
1681  if (!sb) return 1;
1682 
1683  aa = sa->acc;
1684  ab = sb->acc;
1685 
1686  return g_strcmp0(xaccAccountGetCode(aa), xaccAccountGetCode(ab));
1687 }
const char * xaccAccountGetCode(const Account *acc)
Get the account's accounting code.
Definition: Account.cpp:3306
STRUCTS.

◆ xaccSplitCompareAccountFullNames()

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

Compare two splits by full name of account.

Returns similar to strcmp.

Definition at line 1652 of file Split.cpp.

1653 {
1654  Account *aa, *ab;
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  if (aa == ab) return 0;
1662 
1663  auto path_a = gnc_account_get_all_parents (aa);
1664  auto path_b = gnc_account_get_all_parents (ab);
1665  auto mismatch_pair = std::mismatch (path_a.rbegin(), path_a.rend(),
1666  path_b.rbegin(), path_b.rend());
1667 
1668  return mismatch_pair.first == path_a.rend() ? -1
1669  : mismatch_pair.second == path_b.rend() ? 1
1670  : g_utf8_collate (xaccAccountGetName (*mismatch_pair.first),
1671  xaccAccountGetName (*mismatch_pair.second));
1672 }
STRUCTS.
const char * xaccAccountGetName(const Account *acc)
Get the account's name.
Definition: Account.cpp:3259

◆ 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 1711 of file Split.cpp.

1712 {
1713  const char *ca, *cb;
1714  if (!sa && !sb) return 0;
1715  if (!sa) return -1;
1716  if (!sb) return 1;
1717 
1718  ca = xaccSplitGetCorrAccountCode(sa);
1719  cb = xaccSplitGetCorrAccountCode(sb);
1720  return g_strcmp0(ca, cb);
1721 }
const char * xaccSplitGetCorrAccountCode(const Split *sa)
document me
Definition: Split.cpp:1635

◆ 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 1690 of file Split.cpp.

1691 {
1692  char *ca, *cb;
1693  int retval;
1694  if (!sa && !sb) return 0;
1695  if (!sa) return -1;
1696  if (!sb) return 1;
1697 
1698  /* doesn't matter what separator we use
1699  * as long as they are the same
1700  */
1701 
1704  retval = g_strcmp0(ca, cb);
1705  g_free(ca);
1706  g_free(cb);
1707  return retval;
1708 }
char * xaccSplitGetCorrAccountFullName(const Split *sa)
These functions take a split, get the corresponding split on the "other side" of the transaction...
Definition: Split.cpp:1619

◆ 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 639 of file Split.cpp.

640 {
641  if (!from_split || !to_split) return;
642  xaccTransBeginEdit (to_split->parent);
643 
644  xaccSplitSetMemo(to_split, xaccSplitGetMemo(from_split));
645  xaccSplitSetAction(to_split, xaccSplitGetAction(from_split));
646  xaccSplitSetAmount(to_split, xaccSplitGetAmount(from_split));
647  xaccSplitSetValue(to_split, xaccSplitGetValue(from_split));
648  /* Setting the account is okay here because, even though the from
649  split might not really belong to the account it claims to,
650  setting the account won't cause any event involving from. */
651  xaccSplitSetAccount(to_split, xaccSplitGetAccount(from_split));
652  /* N.B. Don't set parent. */
653 
654  qof_instance_set_dirty(QOF_INSTANCE(to_split));
655  xaccTransCommitEdit(to_split->parent);
656 }
void xaccSplitSetValue(Split *s, gnc_numeric amt)
The xaccSplitSetValue() method sets the value of this split in the transaction's commodity.
Definition: Split.cpp:1259
void xaccSplitSetAction(Split *split, const char *actn)
The Action is an arbitrary user-assigned string.
Definition: Split.cpp:1750
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.cpp:1223
void xaccSplitSetMemo(Split *split, const char *memo)
The memo is an arbitrary string associated with a split.
Definition: Split.cpp:1731
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.cpp:1924
Account * xaccSplitGetAccount(const Split *s)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: Split.cpp:936
const char * xaccSplitGetMemo(const Split *split)
Returns the memo string.
Definition: Split.cpp:1899
const char * xaccSplitGetAction(const Split *split)
Returns the action string.
Definition: Split.cpp:1905
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account's commodity.
Definition: Split.cpp:1918

◆ 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.

It begins and commits an edit on the transaction, so if after the split is removed the transaction has no more splits and if is not open it too will be destroyed, as it will if the outer edits are committed without adding transactions.

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

Definition at line 1470 of file Split.cpp.

1471 {
1472  Account *acc;
1473  Transaction *trans;
1474  GncEventData ed;
1475 
1476  if (!split) return TRUE;
1477 
1478  acc = split->acc;
1479  trans = split->parent;
1480  if (acc && !qof_instance_get_destroying(acc)
1481  && !qof_instance_get_destroying(trans)
1482  && xaccTransGetReadOnly(trans))
1483  return FALSE;
1484 
1485  xaccTransBeginEdit(trans);
1486  ed.node = split;
1487  ed.idx = xaccTransGetSplitIndex(trans, split);
1488  qof_instance_set_dirty(QOF_INSTANCE(split));
1489  qof_instance_set_destroying(split, TRUE);
1490  qof_event_gen(&trans->inst, GNC_EVENT_ITEM_REMOVED, &ed);
1491  xaccTransCommitEdit(trans);
1492 
1493  return TRUE;
1494 }
STRUCTS.
const char * xaccTransGetReadOnly(Transaction *trans)
Returns a non-NULL value if this Transaction was marked as read-only with some specific "reason" text...
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()
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 802 of file Split.cpp.

806 {
807  gboolean same_book;
808 
809  if (!sa && !sb) return TRUE; /* Arguable. FALSE is better, methinks */
810 
811  if (!sa || !sb)
812  {
813  PINFO ("one is nullptr");
814  return FALSE;
815  }
816 
817  if (sa == sb) return TRUE;
818 
819  same_book = qof_instance_get_book(QOF_INSTANCE(sa)) == qof_instance_get_book(QOF_INSTANCE(sb));
820 
821  if (check_guids)
822  {
823  if (qof_instance_guid_compare(sa, sb) != 0)
824  {
825  PINFO ("GUIDs differ");
826  return FALSE;
827  }
828  }
829 
830  /* If the same book, since these strings are cached we can just use pointer equality */
831  if ((same_book && sa->memo != sb->memo) || (!same_book && g_strcmp0(sa->memo, sb->memo) != 0))
832  {
833  PINFO ("memos differ: (%p)%s vs (%p)%s",
834  sa->memo, sa->memo, sb->memo, sb->memo);
835  return FALSE;
836  }
837 
838  if ((same_book && sa->action != sb->action) || (!same_book && g_strcmp0(sa->action, sb->action) != 0))
839  {
840  PINFO ("actions differ: %s vs %s", sa->action, sb->action);
841  return FALSE;
842  }
843 
844  if (qof_instance_compare_kvp (QOF_INSTANCE (sa), QOF_INSTANCE (sb)) != 0)
845  {
846  char *frame_a;
847  char *frame_b;
848 
849  frame_a = qof_instance_kvp_as_string (QOF_INSTANCE (sa));
850  frame_b = qof_instance_kvp_as_string (QOF_INSTANCE (sb));
851 
852  PINFO ("kvp frames differ:\n%s\n\nvs\n\n%s", frame_a, frame_b);
853 
854  g_free (frame_a);
855  g_free (frame_b);
856 
857  return FALSE;
858  }
859 
860  if (sa->reconciled != sb->reconciled)
861  {
862  PINFO ("reconcile flags differ: %c vs %c", sa->reconciled, sb->reconciled);
863  return FALSE;
864  }
865 
866  if (sa->date_reconciled != sb->date_reconciled)
867  {
868  PINFO ("reconciled date differs");
869  return FALSE;
870  }
871 
873  {
874  char *str_a;
875  char *str_b;
876 
879 
880  PINFO ("amounts differ: %s vs %s", str_a, str_b);
881 
882  g_free (str_a);
883  g_free (str_b);
884 
885  return FALSE;
886  }
887 
889  {
890  char *str_a;
891  char *str_b;
892 
895 
896  PINFO ("values differ: %s vs %s", str_a, str_b);
897 
898  g_free (str_a);
899  g_free (str_b);
900 
901  return FALSE;
902  }
903 
904  if (check_balances)
905  {
906  if (!xaccSplitEqualCheckBal ("", sa->balance, sb->balance))
907  return FALSE;
908  if (!xaccSplitEqualCheckBal ("cleared ", sa->cleared_balance,
909  sb->cleared_balance))
910  return FALSE;
911  if (!xaccSplitEqualCheckBal ("reconciled ", sa->reconciled_balance,
912  sb->reconciled_balance))
913  return FALSE;
914  if (!xaccSplitEqualCheckBal ("noclosing ", sa->noclosing_balance,
915  sb->noclosing_balance))
916  return FALSE;
917  }
918 
919  if (!xaccTransEqual(sa->parent, sb->parent, check_guids, check_txn_splits,
920  check_balances, FALSE))
921  {
922  PINFO ("transactions differ");
923  return FALSE;
924  }
925 
926  return TRUE;
927 }
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.
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.cpp:1924
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.cpp:1918

◆ 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 136 of file gmock-Split.cpp.

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

◆ 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 1295 of file Split.cpp.

1296 {
1297  return s ? s->balance : gnc_numeric_zero();
1298 }

◆ 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 1374 of file Split.cpp.

1375 {
1376  if (!s || !s->acc || !s->parent) return gnc_numeric_zero();
1377 
1378  /* be more precise -- the value depends on the currency we want it
1379  * expressed in. */
1380  if (gnc_commodity_equiv(xaccTransGetCurrency(s->parent), base_currency))
1381  return xaccSplitGetValue(s);
1382  if (gnc_commodity_equiv(xaccAccountGetCommodity(s->acc), base_currency))
1383  return xaccSplitGetAmount(s);
1384 
1385  PERR ("inappropriate base currency %s "
1386  "given split currency=%s and commodity=%s\n",
1387  gnc_commodity_get_printname(base_currency),
1390  return gnc_numeric_zero();
1391 }
#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.cpp:1924
gnc_commodity * xaccAccountGetCommodity(const Account *acc)
Get the account's commodity.
Definition: Account.cpp:3371
gnc_commodity * xaccTransGetCurrency(const Transaction *trans)
Returns the valuation commodity of this transaction.
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.cpp:1918

◆ 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 1307 of file Split.cpp.

1308 {
1309  return s ? s->cleared_balance : gnc_numeric_zero();
1310 }

◆ 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 1619 of file Split.cpp.

1620 {
1621  static const char *split_const = nullptr;
1622  const Split *other_split;
1623 
1624  if (!get_corr_account_split(sa, &other_split))
1625  {
1626  if (!split_const)
1627  split_const = _("-- Split Transaction --");
1628 
1629  return g_strdup(split_const);
1630  }
1631  return gnc_account_get_full_name(other_split->acc);
1632 }
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:3275

◆ xaccSplitGetDateReconciled()

time64 xaccSplitGetDateReconciled ( const Split *  split)

Retrieve the date when the Split was reconciled.

Definition at line 1823 of file Split.cpp.

1824 {
1825  return split ? split->date_reconciled : 0;
1826 }

◆ 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 1884 of file Split.cpp.

1885 {
1886  return split ? split->lot : nullptr;
1887 }

◆ 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 1301 of file Split.cpp.

1302 {
1303  return s ? s->noclosing_balance : gnc_numeric_zero();
1304 }

◆ 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 144 of file gmock-Split.cpp.

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

◆ xaccSplitGetParent()

Transaction* xaccSplitGetParent ( const Split *  split)

Returns the parent transaction of the split.

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

153 {
154  SCOPED_TRACE("");
155  auto mocksplit = gnc_mocksplit(split);
156  return mocksplit ? mocksplit->get_parent() : nullptr;
157 }

◆ xaccSplitGetReconcile()

char xaccSplitGetReconcile ( const Split *  split)

Returns the value of the reconcile flag.

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

115 {
116  SCOPED_TRACE("");
117  auto mocksplit = gnc_mocksplit(split);
118  return mocksplit ? mocksplit->get_reconcile() : VREC;
119 }
#define VREC
split is void
Definition: Split.h:77

◆ 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 1313 of file Split.cpp.

1314 {
1315  return s ? s->reconciled_balance : gnc_numeric_zero();
1316 }

◆ 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 1930 of file Split.cpp.

1931 {
1932  gnc_numeric amt, val, price;
1933  if (!split) return gnc_numeric_create(0, 1);
1934 
1935 
1936  /* if amount == 0, return 0
1937  * otherwise return value/amount
1938  */
1939 
1940  amt = xaccSplitGetAmount(split);
1941  val = xaccSplitGetValue(split);
1942  if (gnc_numeric_zero_p(amt))
1943  return gnc_numeric_create(0, 1);
1944 
1945  price = gnc_numeric_div(val, amt,
1948 
1949  /* During random checks we can get some very weird prices. Let's
1950  * handle some overflow and other error conditions by returning
1951  * zero. But still print an error to let us know it happened.
1952  */
1953  if (gnc_numeric_check(price))
1954  {
1955  PERR("Computing share price failed (%d): [ %" G_GINT64_FORMAT " / %"
1956  G_GINT64_FORMAT " ] / [ %" G_GINT64_FORMAT " / %" G_GINT64_FORMAT " ]",
1957  gnc_numeric_check(price), val.num, val.denom, amt.num, amt.denom);
1958  return gnc_numeric_create(0, 1);
1959  }
1960 
1961  return price;
1962 }
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
gnc_numeric gnc_numeric_div(gnc_numeric x, gnc_numeric y, gint64 denom, gint how)
Division.
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction's commodity.
Definition: Split.cpp:1924
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:165
GNCNumericErrorCode gnc_numeric_check(gnc_numeric a)
Check for error signal in value.
#define GNC_DENOM_AUTO
Values that can be passed as the 'denom' argument.
Definition: gnc-numeric.h:245
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account's commodity.
Definition: Split.cpp:1918

◆ 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 1974 of file Split.cpp.

1975 {
1976  if (!s) return nullptr;
1977 
1978  auto type{qof_instance_get_path_kvp<const char*> (QOF_INSTANCE(s), {"split-type"})};
1979 
1980  if (!type || !g_strcmp0 (*type, split_type_normal))
1981  return split_type_normal;
1982 
1983  if (!g_strcmp0 (*type, split_type_stock_split))
1984  return split_type_stock_split;
1985 
1986  PERR ("unexpected split-type %s, reset to normal.", *type);
1987  return split_type_normal;
1988 }
#define PERR(format, args...)
Log a serious error.
Definition: qoflog.h:244

◆ 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 2031 of file Split.cpp.

2032 {
2033  const GncGUID* guid;
2034 
2035  g_return_val_if_fail (split != nullptr, FALSE);
2036  g_return_val_if_fail (other_split != nullptr, FALSE);
2037 
2038  guid = qof_instance_get_guid (QOF_INSTANCE (other_split));
2039  return qof_instance_kvp_has_guid (QOF_INSTANCE (split), "lot-split",
2040  "peer_guid", guid);
2041 }
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 1071 of file Split.cpp.

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

◆ 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 1993 of file Split.cpp.

1994 {
1995  xaccTransBeginEdit (s->parent);
1996 
1997  s->value = gnc_numeric_zero();
1998  qof_instance_set_path_kvp<const char*> (QOF_INSTANCE(s), g_strdup(split_type_stock_split),
1999  {"split-type"});
2000  SET_GAINS_VDIRTY(s);
2001  mark_split(s);
2002  qof_instance_set_dirty(QOF_INSTANCE(s));
2003  xaccTransCommitEdit(s->parent);
2004 }
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 2061 of file Split.cpp.

2062 {
2063  xaccTransBeginEdit (split->parent);
2064  qof_instance_kvp_merge_guids (QOF_INSTANCE (split),
2065  QOF_INSTANCE (other_split), "lot-split");
2066  mark_split (split);
2067  qof_instance_set_dirty (QOF_INSTANCE (split));
2068  xaccTransCommitEdit (split->parent);
2069 }
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 1500 of file Split.cpp.

1501 {
1502  int retval;
1503  int comp;
1504  const char *da, *db;
1505  gboolean action_for_num;
1506 
1507  if (sa == sb) return 0;
1508  /* nothing is always less than something */
1509  if (!sa) return -1;
1510  if (!sb) return +1;
1511 
1512  /* sort in transaction order, but use split action rather than trans num
1513  * according to book option */
1515  (xaccSplitGetBook (sa));
1516  if (action_for_num)
1517  retval = xaccTransOrder_num_action (sa->parent, sa->action,
1518  sb->parent, sb->action);
1519  else
1520  retval = xaccTransOrder (sa->parent, sb->parent);
1521  if (retval) return retval;
1522 
1523  /* otherwise, sort on memo strings */
1524  da = sa->memo ? sa->memo : "";
1525  db = sb->memo ? sb->memo : "";
1526  retval = g_utf8_collate (da, db);
1527  if (retval)
1528  return retval;
1529 
1530  /* otherwise, sort on action strings */
1531  da = sa->action ? sa->action : "";
1532  db = sb->action ? sb->action : "";
1533  retval = g_utf8_collate (da, db);
1534  if (retval != 0)
1535  return retval;
1536 
1537  /* the reconciled flag ... */
1538  if (sa->reconciled < sb->reconciled) return -1;
1539  if (sa->reconciled > sb->reconciled) return +1;
1540 
1541  /* compare amounts */
1543  if (comp < 0) return -1;
1544  if (comp > 0) return +1;
1545 
1547  if (comp < 0) return -1;
1548  if (comp > 0) return +1;
1549 
1550  /* if dates differ, return */
1551  if (sa->date_reconciled < sb->date_reconciled)
1552  return -1;
1553  else if (sa->date_reconciled > sb->date_reconciled)
1554  return 1;
1555 
1556  /* else, sort on guid - keeps sort stable. */
1557  retval = qof_instance_guid_compare(sa, sb);
1558  if (retval) return retval;
1559 
1560  return 0;
1561 }
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...
gint 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.cpp:1968
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.
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction&#39;s commodity.
Definition: Split.cpp:1924
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.
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account&#39;s commodity.
Definition: Split.cpp:1918

◆ 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 2044 of file Split.cpp.

2045 {
2046  const GncGUID* guid;
2047 
2048  g_return_if_fail (split != nullptr);
2049  g_return_if_fail (other_split != nullptr);
2050 
2051  guid = qof_instance_get_guid (QOF_INSTANCE (other_split));
2052  xaccTransBeginEdit (split->parent);
2053  qof_instance_kvp_remove_guid (QOF_INSTANCE (split), "lot-split",
2054  "peer_guid", guid);
2055  mark_split (split);
2056  qof_instance_set_dirty (QOF_INSTANCE (split));
2057  xaccTransCommitEdit (split->parent);
2058 }
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 1750 of file Split.cpp.

1751 {
1752  if (!split || !actn) return;
1753  xaccTransBeginEdit (split->parent);
1754 
1755  CACHE_REPLACE(split->action, actn);
1756  qof_instance_set_dirty(QOF_INSTANCE(split));
1757  xaccTransCommitEdit(split->parent);
1758 
1759 }
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 1319 of file Split.cpp.

1321 {
1322  const gnc_commodity *currency;
1323  const gnc_commodity *commodity;
1324 
1325  if (!s) return;
1326  xaccTransBeginEdit (s->parent);
1327 
1328  if (!s->acc)
1329  {
1330  PERR ("split must have a parent account");
1331  return;
1332  }
1333 
1334  currency = xaccTransGetCurrency (s->parent);
1335  commodity = xaccAccountGetCommodity (s->acc);
1336 
1337  /* If the base_currency is the transaction's commodity ('currency'),
1338  * set the value. If it's the account commodity, set the
1339  * amount. If both, set both. */
1340  if (gnc_commodity_equiv(currency, base_currency))
1341  {
1342  if (gnc_commodity_equiv(commodity, base_currency))
1343  {
1344  s->amount = gnc_numeric_convert(value,
1345  get_commodity_denom(s),
1347  }
1348  s->value = gnc_numeric_convert(value,
1349  get_currency_denom(s),
1351  }
1352  else if (gnc_commodity_equiv(commodity, base_currency))
1353  {
1354  s->amount = gnc_numeric_convert(value, get_commodity_denom(s),
1356  }
1357  else
1358  {
1359  PERR ("inappropriate base currency %s "
1360  "given split currency=%s and commodity=%s\n",
1361  gnc_commodity_get_printname(base_currency),
1362  gnc_commodity_get_printname(currency),
1363  gnc_commodity_get_printname(commodity));
1364  return;
1365  }
1366 
1367  SET_GAINS_A_VDIRTY(s);
1368  mark_split (s);
1369  qof_instance_set_dirty(QOF_INSTANCE(s));
1370  xaccTransCommitEdit(s->parent);
1371 }
#define PERR(format, args...)
Log a serious error.
Definition: qoflog.h:244
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:3371
gnc_commodity * xaccTransGetCurrency(const Transaction *trans)
Returns the valuation commodity of this transaction.
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:165
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 129 of file gmock-Split.cpp.

130 {
131  ASSERT_TRUE(GNC_IS_MOCKSPLIT(split));
132  gnc_mocksplit(split)->set_date_reconciled_secs(secs);
133 }

◆ 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 107 of file gmock-Split.cpp.

108 {
109  ASSERT_TRUE(GNC_IS_MOCKSPLIT(split));
110  gnc_mocksplit(split)->set_memo(memo);
111 }

◆ 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 122 of file gmock-Split.cpp.

123 {
124  ASSERT_TRUE(GNC_IS_MOCKSPLIT(split));
125  gnc_mocksplit(split)->set_reconcile(recn);
126 }

◆ 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 1185 of file Split.cpp.

1186 {
1187  if (!s) return;
1188 
1189  if (gnc_numeric_zero_p (price))
1190  return;
1191 
1192  ENTER (" ");
1193  xaccTransBeginEdit (s->parent);
1194 
1195  s->value = gnc_numeric_mul(xaccSplitGetAmount(s),
1196  price, get_currency_denom(s),
1198 
1199  SET_GAINS_VDIRTY(s);
1200  mark_split (s);
1201  qof_instance_set_dirty(QOF_INSTANCE(s));
1202  xaccTransCommitEdit(s->parent);
1203  LEAVE ("");
1204 }
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
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
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:165
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account&#39;s commodity.
Definition: Split.cpp:1918

◆ 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 1157 of file Split.cpp.

1158 {
1159  if (!s) return;
1160  ENTER (" ");
1161  xaccTransBeginEdit (s->parent);
1162 
1163  s->amount = gnc_numeric_convert(amt, get_commodity_denom(s),
1165  s->value = gnc_numeric_mul(s->amount, price,
1166  get_currency_denom(s), GNC_HOW_RND_ROUND_HALF_UP);
1167 
1168  SET_GAINS_A_VDIRTY(s);
1169  mark_split (s);
1170  qof_instance_set_dirty(QOF_INSTANCE(s));
1171  xaccTransCommitEdit(s->parent);
1172  LEAVE ("");
1173 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
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
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:165

◆ 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 2114 of file Split.cpp.

2115 {
2116  g_return_val_if_fail(split, gnc_numeric_zero());
2117  auto num{qof_instance_get_path_kvp<gnc_numeric> (QOF_INSTANCE(split), {void_former_amt_str})};
2118  return num ? *num : gnc_numeric_zero();
2119 }

◆ 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 2122 of file Split.cpp.

2123 {
2124  g_return_val_if_fail(split, gnc_numeric_zero());
2125  auto num{qof_instance_get_path_kvp<gnc_numeric> (QOF_INSTANCE(split), {void_former_val_str})};
2126  return num ? *num : gnc_numeric_zero();
2127 }

◆ 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 }

◆ xaccTransClearSplits()

void xaccTransClearSplits ( Transaction *  trans)

Remove all splits from the transaction.

Clears the split list of the transaction. All splits that the transaction still owns will be destroyed, and others will be unlinked.

Opens and commits an edit on the transaction, so this will destroy the transaction if it isn't already open, as will committing the outer edits if new splits are not added before hand.

Definition at line 2093 of file Transaction.cpp.

2094 {
2095  xaccTransBeginEdit(trans);
2096  /* We only own the splits that still think they belong to us. This is done
2097  in 2 steps. In the first, the splits are marked as being destroyed, but they
2098  are not destroyed yet. In the second, the destruction is committed which will
2099  do the actual destruction. If both steps are done for a split before they are
2100  done for the next split, then a split will still be on the split list after it
2101  has been freed. This can cause other parts of the code (e.g. in xaccSplitDestroy())
2102  to reference the split after it has been freed. */
2103  for (auto node = trans->splits; node; node = node->next)
2104  {
2105  auto s = GNC_SPLIT(node->data);
2106  if (s && s->parent == trans)
2107  {
2108  xaccSplitDestroy(s);
2109  }
2110  }
2111  for (auto node = trans->splits; node; node = node->next)
2112  {
2113  auto s = GNC_SPLIT(node->data);
2114  if (s && s->parent == trans)
2115  {
2116  xaccSplitCommitEdit(s);
2117  }
2118  }
2119  g_list_free (trans->splits);
2120  trans->splits = nullptr;
2121 
2122  xaccTransCommitEdit(trans);
2123 }
gboolean xaccSplitDestroy(Split *split)
Destructor.
Definition: Split.cpp:1470
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...

◆ 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 738 of file Transaction.cpp.

740 {
741  gboolean change_accounts = FALSE;
742  GList *node;
743 
744  if (!from_trans || !to_trans)
745  return;
746 
747  change_accounts = from_acc && GNC_IS_ACCOUNT(to_acc) && from_acc != to_acc;
748  xaccTransBeginEdit(to_trans);
749 
750  xaccTransClearSplits(to_trans);
751  xaccTransSetCurrency(to_trans, xaccTransGetCurrency(from_trans));
752  xaccTransSetDescription(to_trans, xaccTransGetDescription(from_trans));
753 
754  if ((xaccTransGetNum(to_trans) == nullptr) || (g_strcmp0 (xaccTransGetNum(to_trans), "") == 0))
755  xaccTransSetNum(to_trans, xaccTransGetNum(from_trans));
756 
757  xaccTransSetNotes(to_trans, xaccTransGetNotes(from_trans));
758  xaccTransSetDocLink(to_trans, xaccTransGetDocLink (from_trans));
759  if(!no_date)
760  {
761  xaccTransSetDatePostedSecs(to_trans, xaccTransRetDatePosted (from_trans));
762  }
763 
764  /* Each new split will be parented to 'to' */
765  for (node = from_trans->splits; node; node = node->next)
766  {
767  Split *new_split = xaccMallocSplit( qof_instance_get_book(QOF_INSTANCE(from_trans)));
768  xaccSplitCopyOnto(GNC_SPLIT(node->data), new_split);
769  if (change_accounts && xaccSplitGetAccount(GNC_SPLIT(node->data)) == from_acc)
770  xaccSplitSetAccount(new_split, to_acc);
771  xaccSplitSetParent(new_split, to_trans);
772  }
773  xaccTransCommitEdit(to_trans);
774 }
void xaccTransClearSplits(Transaction *trans)
Remove all splits from the transaction.
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.
void xaccTransSetNotes(Transaction *trans, const char *notes)
Sets the transaction Notes.
void xaccSplitCopyOnto(const Split *from_split, Split *to_split)
This is really a helper for xaccTransCopyOnto.
Definition: Split.cpp:639
void xaccTransSetDescription(Transaction *trans, const char *desc)
Sets the transaction Description.
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.
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.
const char * xaccTransGetDocLink(const Transaction *trans)
Gets the transaction Document Link.
void xaccTransSetCurrency(Transaction *trans, gnc_commodity *curr)
Set a new currency on a transaction.
const char * xaccTransGetNotes(const Transaction *trans)
Gets the transaction Notes.
time64 xaccTransRetDatePosted(const Transaction *trans)
Retrieve the posted date of the transaction.
const char * xaccTransGetDescription(const Transaction *trans)
Gets the transaction Description.
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...
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)).
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.
void xaccTransSetDocLink(Transaction *trans, const char *doclink)
Sets the transaction Document Link.

◆ 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 698 of file Transaction.cpp.

699 {
700  Transaction *to_trans;
701 
702  if (!from_trans)
703  return nullptr;
704 
705  to_trans = dupe_trans(from_trans);
706  return to_trans;
707 }

◆ xaccTransCountSplits()

int xaccTransCountSplits ( const Transaction *  trans)

Returns the number of splits in this transaction.

Definition at line 2229 of file Transaction.cpp.

2230 {
2231  gint i = 0;
2232  g_return_val_if_fail (trans != nullptr, 0);
2233  FOR_EACH_SPLIT(trans, i++);
2234  return i;
2235 }

◆ 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 150 of file gmock-Transaction.cpp.

151 {
152  ASSERT_TRUE(GNC_IS_MOCKTRANSACTION(trans));
153  gnc_mocktransaction(trans)->destroy();
154 }

◆ 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 843 of file Transaction.cpp.

848 {
849  gboolean same_book;
850 
851  if (!ta && !tb) return TRUE; /* Arguable. FALSE may be better. */
852 
853  if (!ta || !tb)
854  {
855  PINFO ("one is nullptr");
856  return FALSE;
857  }
858 
859  if (ta == tb) return TRUE;
860 
861  same_book = qof_instance_get_book(QOF_INSTANCE(ta)) == qof_instance_get_book(QOF_INSTANCE(tb));
862 
863  if (check_guids)
864  {
865  if (qof_instance_guid_compare(ta, tb) != 0)
866  {
867  PINFO ("GUIDs differ");
868  return FALSE;
869  }
870  }
871 
872  if (!gnc_commodity_equal(ta->common_currency, tb->common_currency))
873  {
874  PINFO ("commodities differ %s vs %s",
875  gnc_commodity_get_unique_name (ta->common_currency),
876  gnc_commodity_get_unique_name (tb->common_currency));
877  return FALSE;
878  }
879 
880  if (ta->date_entered != tb->date_entered)
881  {
882  char buf1[100];
883  char buf2[100];
884 
885  (void)gnc_time64_to_iso8601_buff(ta->date_entered, buf1);
886  (void)gnc_time64_to_iso8601_buff(tb->date_entered, buf2);
887  PINFO ("date entered differs: '%s' vs '%s'", buf1, buf2);
888  return FALSE;
889  }
890 
891  if (ta->date_posted != tb->date_posted)
892  {
893  char buf1[100];
894  char buf2[100];
895 
896  (void)gnc_time64_to_iso8601_buff(ta->date_posted, buf1);
897  (void)gnc_time64_to_iso8601_buff(tb->date_posted, buf2);
898  PINFO ("date posted differs: '%s' vs '%s'", buf1, buf2);
899  return FALSE;
900  }
901 
902  /* If the same book, since we use cached strings, we can just compare pointer
903  * equality for num and description
904  */
905  if ((same_book && ta->num != tb->num) || (!same_book && g_strcmp0(ta->num, tb->num) != 0))
906  {
907  PINFO ("num differs: %s vs %s", ta->num, tb->num);
908  return FALSE;
909  }
910 
911  if ((same_book && ta->description != tb->description)
912  || (!same_book && g_strcmp0(ta->description, tb->description)))
913  {
914  PINFO ("descriptions differ: %s vs %s", ta->description, tb->description);
915  return FALSE;
916  }
917 
918  if (qof_instance_compare_kvp (QOF_INSTANCE (ta), QOF_INSTANCE (tb)) != 0)
919  {
920  char *frame_a;
921  char *frame_b;
922 
923  frame_a = qof_instance_kvp_as_string (QOF_INSTANCE (ta));
924  frame_b = qof_instance_kvp_as_string (QOF_INSTANCE (tb));
925 
926 
927  PINFO ("kvp frames differ:\n%s\n\nvs\n\n%s", frame_a, frame_b);
928 
929  g_free (frame_a);
930  g_free (frame_b);
931 
932  return FALSE;
933  }
934 
935  if (check_splits)
936  {
937  if ((!ta->splits && tb->splits) || (!tb->splits && ta->splits))
938  {
939  PINFO ("only one has splits");
940  return FALSE;
941  }
942 
943  if (ta->splits && tb->splits)
944  {
945  GList *node_a, *node_b;
946 
947  for (node_a = ta->splits, node_b = tb->splits;
948  node_a;
949  node_a = node_a->next, node_b = node_b->next)
950  {
951  Split *split_a = GNC_SPLIT(node_a->data);
952  Split *split_b;
953 
954  /* don't presume that the splits are in the same order */
955  if (!assume_ordered)
956  node_b = g_list_find_custom (tb->splits, split_a,
957  compare_split_guids);
958 
959  if (!node_b)
960  {
961  gchar guidstr[GUID_ENCODING_LENGTH+1];
962  guid_to_string_buff (xaccSplitGetGUID (split_a),guidstr);
963 
964  PINFO ("first has split %s and second does not",guidstr);
965  return FALSE;
966  }
967 
968  split_b = GNC_SPLIT(node_b->data);
969 
970  if (!xaccSplitEqual (split_a, split_b, check_guids, check_balances,
971  FALSE))
972  {
973  char str_a[GUID_ENCODING_LENGTH + 1];
974  char str_b[GUID_ENCODING_LENGTH + 1];
975 
976  guid_to_string_buff (xaccSplitGetGUID (split_a), str_a);
977  guid_to_string_buff (xaccSplitGetGUID (split_b), str_b);
978 
979  PINFO ("splits %s and %s differ", str_a, str_b);
980  return FALSE;
981  }
982  }
983 
984  if (g_list_length (ta->splits) != g_list_length (tb->splits))
985  {
986  PINFO ("different number of splits");
987  return FALSE;
988  }
989  }
990  }
991 
992  return TRUE;
993 }
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:173
gboolean xaccSplitEqual(const Split *sa, const Split *sb, gboolean check_guids, gboolean check_balances, gboolean check_txn_splits)
Equality.
Definition: Split.cpp:802
#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:552
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:1146

◆ xaccTransGetAccountAmount()

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

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

Definition at line 1173 of file Transaction.cpp.

1174 {
1175  gnc_numeric total = gnc_numeric_zero ();
1176  if (!trans || !acc) return total;
1177 
1178  total = gnc_numeric_convert (total, xaccAccountGetCommoditySCU (acc),
1180  FOR_EACH_SPLIT(trans, if (acc == xaccSplitGetAccount(s))
1181  total = gnc_numeric_add_fixed(
1182  total, xaccSplitGetAmount(s)));
1183  return total;
1184 }
int xaccAccountGetCommoditySCU(const Account *acc)
Return the SCU for the account.
Definition: Account.cpp:2716
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
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:165
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 1247 of file Transaction.cpp.

1249 {
1250  GList *node;
1251  Split *last_split = nullptr;
1252 
1253  // Not really the appropriate error value.
1254  g_return_val_if_fail(account && trans, gnc_numeric_error(GNC_ERROR_ARG));
1255 
1256  for (node = trans->splits; node; node = node->next)
1257  {
1258  Split *split = GNC_SPLIT(node->data);
1259 
1260  if (!xaccTransStillHasSplit(trans, split))
1261  continue;
1262  if (xaccSplitGetAccount(split) != account)
1263  continue;
1264 
1265  if (!last_split)
1266  {
1267  last_split = split;
1268  continue;
1269  }
1270 
1271  /* This test needs to correspond to the comparison function used when
1272  sorting the splits for computing the running balance. */
1273  if (xaccSplitOrder (last_split, split) < 0)
1274  last_split = split;
1275  }
1276 
1277  return xaccSplitGetBalance (last_split);
1278 }
gint xaccSplitOrder(const Split *sa, const Split *sb)
The xaccSplitOrder(sa,sb) method is useful for sorting.
Definition: Split.cpp:1500
gnc_numeric xaccSplitGetBalance(const Split *s)
Returns the running balance up to and including the indicated split.
Definition: Split.cpp:1295
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:224
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 1157 of file Transaction.cpp.

1159 {
1160  gnc_numeric total = gnc_numeric_zero ();
1161  if (!trans || !acc) return total;
1162 
1163  FOR_EACH_SPLIT(trans, if (acc == xaccSplitGetAccount(s))
1164 {
1165  total = gnc_numeric_add (total, xaccSplitGetValue (s),
1168  });
1169  return total;
1170 }
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:188
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:245

◆ 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 2166 of file Transaction.cpp.

2167 {
2168  GList *apar_splits = nullptr;
2169  if (!trans) return nullptr;
2170 
2171  FOR_EACH_SPLIT (trans,
2172  const Account *account = xaccSplitGetAccount(s);
2173  if (account && xaccAccountIsAPARType(xaccAccountGetType(account)))
2174  {
2175 
2176  if (!strict)
2177  apar_splits = g_list_prepend (apar_splits, s);
2178  else
2179  {
2180  GncOwner owner;
2181  GNCLot *lot = xaccSplitGetLot(s);
2182  if (lot &&
2183  (gncInvoiceGetInvoiceFromLot (lot) ||
2184  gncOwnerGetOwnerFromLot (lot, &owner)))
2185  apar_splits = g_list_prepend (apar_splits, s);
2186  }
2187  }
2188  );
2189 
2190  apar_splits = g_list_reverse (apar_splits);
2191  return apar_splits;
2192 }
GNCAccountType xaccAccountGetType(const Account *acc)
Returns the account&#39;s account type.
Definition: Account.cpp:3237
STRUCTS.
gboolean gncOwnerGetOwnerFromLot(GNCLot *lot, GncOwner *owner)
Get the owner from the lot.
Definition: gncOwner.c:636
gboolean xaccAccountIsAPARType(GNCAccountType t)
Convenience function to check if the account is a valid business account type (meaning an Accounts Pa...
Definition: Account.cpp:4482
GncInvoice * gncInvoiceGetInvoiceFromLot(GNCLot *lot)
Given a LOT, find and return the Invoice attached to the lot.
Definition: gncInvoice.c:1288
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.cpp:1884

◆ 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 134 of file gmock-Transaction.cpp.

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

◆ 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 2279 of file Transaction.cpp.

2280 {
2281  return trans ? trans->date_entered : 0;
2282 }

◆ 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 2292 of file Transaction.cpp.

2293 {
2294  GDate result;
2295  g_date_clear (&result, 1);
2296  if (trans)
2297  {
2298  /* Can we look up this value in the kvp slot? If yes, use it
2299  * from there because it doesn't suffer from time zone
2300  * shifts. */
2301  if (auto res = qof_instance_get_path_kvp<GDate> (QOF_INSTANCE(trans), {TRANS_DATE_POSTED}))
2302  result = *res;
2303  if (! g_date_valid (&result) || gdate_to_time64 (result) == INT64_MAX)
2304  {
2305  /* Well, this txn doesn't have a valid GDate saved in a slot.
2306  * time64_to_gdate() uses local time and we want UTC so we have
2307  * to write it out.
2308  */
2309  time64 time = xaccTransGetDate(trans);
2310  struct tm *stm = gnc_gmtime(&time);
2311  if (stm)
2312  {
2313  g_date_set_dmy(&result, stm->tm_mday,
2314  (GDateMonth)(stm->tm_mon + 1),
2315  stm->tm_year + 1900);
2316  free(stm);
2317  }
2318  }
2319  }
2320  return result;
2321 }
time64 xaccTransGetDate(const Transaction *trans)
Retrieve the posted date of the transaction.
time64 gdate_to_time64(GDate d)
Turns a GDate into a time64, returning the first second of the day.
Definition: gnc-date.cpp:1259
struct tm * gnc_gmtime(const time64 *secs)
fill out a time struct from a 64-bit time value
Definition: gnc-date.cpp:176
gint64 time64
Most systems that are currently maintained, including Microsoft Windows, BSD-derived Unixes and Linux...
Definition: gnc-date.h:87

◆ 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 2205 of file Transaction.cpp.

2206 {
2207  FOR_EACH_SPLIT (trans,
2208  const Account *account = xaccSplitGetAccount(s);
2209  if (account && xaccAccountIsAPARType(xaccAccountGetType(account)))
2210  {
2211  GNCLot *lot;
2212  GncOwner owner;
2213 
2214  if (!strict)
2215  return s;
2216 
2217  lot = xaccSplitGetLot(s);
2218  if (lot &&
2219  (gncInvoiceGetInvoiceFromLot (lot) ||
2220  gncOwnerGetOwnerFromLot (lot, &owner)))
2221  return s;
2222  }
2223  );
2224 
2225  return nullptr;
2226 }
GNCAccountType xaccAccountGetType(const Account *acc)
Returns the account&#39;s account type.
Definition: Account.cpp:3237
STRUCTS.
gboolean gncOwnerGetOwnerFromLot(GNCLot *lot, GncOwner *owner)
Get the owner from the lot.
Definition: gncOwner.c:636
gboolean xaccAccountIsAPARType(GNCAccountType t)
Convenience function to check if the account is a valid business account type (meaning an Accounts Pa...
Definition: Account.cpp:4482
GncInvoice * gncInvoiceGetInvoiceFromLot(GNCLot *lot)
Given a LOT, find and return the Invoice attached to the lot.
Definition: gncInvoice.c:1288
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.cpp:1884

◆ 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 2194 of file Transaction.cpp.

2195 {
2196  FOR_EACH_SPLIT (trans,
2197  const Account *account = xaccSplitGetAccount(s);
2198  if (account && gncBusinessIsPaymentAcctType(xaccAccountGetType(account)))
2199  return s;
2200  );
2201 
2202  return nullptr;
2203 }
GNCAccountType xaccAccountGetType(const Account *acc)
Returns the account&#39;s account type.
Definition: Account.cpp:3237
STRUCTS.
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 1039 of file Transaction.cpp.

1040 {
1041  /* imbal_value is used if either (1) the transaction has a non currency
1042  split or (2) all the splits are in the same currency. If there are
1043  no non-currency splits and not all splits are in the same currency then
1044  imbal_list is used to compute the imbalance. */
1045  MonetaryList *imbal_list = nullptr;
1046  gnc_numeric imbal_value = gnc_numeric_zero();
1047  gboolean trading_accts;
1048 
1049  if (!trans) return imbal_list;
1050 
1051  ENTER("(trans=%p)", trans);
1052 
1053  trading_accts = xaccTransUseTradingAccounts (trans);
1054 
1055  /* If using trading accounts and there is at least one split that is not
1056  in the transaction currency or a split that has a price or exchange
1057  rate other than 1, then compute the balance in each commodity in the
1058  transaction. Otherwise (all splits are in the transaction's currency)
1059  then compute the balance using the value fields.
1060 
1061  Optimize for the common case of only one currency and a balanced
1062  transaction. */
1063  FOR_EACH_SPLIT(trans,
1064  {
1065  gnc_commodity *commodity;
1067  if (trading_accts &&
1068  (imbal_list ||
1069  ! gnc_commodity_equiv(commodity, trans->common_currency) ||
1071  {
1072  /* Need to use (or already are using) a list of imbalances in each of
1073  the currencies used in the transaction. */
1074  if (! imbal_list)
1075  {
1076  /* All previous splits have been in the transaction's common
1077  currency, so imbal_value is in this currency. */
1078  imbal_list = gnc_monetary_list_add_value(imbal_list,
1079  trans->common_currency,
1080  imbal_value);
1081  }
1082  imbal_list = gnc_monetary_list_add_value(imbal_list, commodity,
1083  xaccSplitGetAmount(s));
1084  }
1085 
1086  /* Add it to the value accumulator in case we need it. */
1087  imbal_value = gnc_numeric_add(imbal_value, xaccSplitGetValue(s),
1089  } );
1090 
1091 
1092  if (!imbal_list && !gnc_numeric_zero_p(imbal_value))
1093  {
1094  /* Not balanced and no list, create one. If we found multiple currencies
1095  and no non-currency commodity then imbal_list will already exist and
1096  we won't get here. */
1097  imbal_list = gnc_monetary_list_add_value(imbal_list,
1098  trans->common_currency,
1099  imbal_value);
1100  }
1101 
1102  /* Delete all the zero entries from the list, perhaps leaving an
1103  empty list */
1104  imbal_list = gnc_monetary_list_delete_zeros(imbal_list);
1105 
1106  LEAVE("(trans=%p), imbal=%p", trans, imbal_list);
1107  return imbal_list;
1108 }
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.
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:188
#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:3371
#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:245
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 2152 of file Transaction.cpp.

2153 {
2154  GList *pay_splits = nullptr;
2155  FOR_EACH_SPLIT (trans,
2156  const Account *account = xaccSplitGetAccount(s);
2157  if (account && gncBusinessIsPaymentAcctType(xaccAccountGetType(account)))
2158  pay_splits = g_list_prepend (pay_splits, s);
2159  );
2160 
2161  pay_splits = g_list_reverse (pay_splits);
2162  return pay_splits;
2163 }
GNCAccountType xaccAccountGetType(const Account *acc)
Returns the account&#39;s account type.
Definition: Account.cpp:3237
STRUCTS.
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 2377 of file Transaction.cpp.

2378 {
2379  return get_kvp_string_path (trans, {TRANS_READ_ONLY_REASON});
2380 }

◆ 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 2645 of file Transaction.cpp.

2646 {
2647  g_return_val_if_fail(trans, nullptr);
2648  auto g = qof_instance_get_path_kvp<GncGUID*> (QOF_INSTANCE(trans), {TRANS_REVERSED_BY});
2649  return g ? xaccTransLookup (*g, qof_instance_get_book (trans)) : nullptr;
2650 }
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.
Transaction * xaccTransLookup(const GncGUID *guid, QofBook *book)
The xaccTransLookup() subroutine will return the transaction associated with the given id...

◆ 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 2338 of file Transaction.cpp.

2339 {
2340  gboolean has_nonAPAR_split = FALSE;
2341 
2342  if (!trans) return TXN_TYPE_NONE;
2343 
2344  if (trans->txn_type != TXN_TYPE_UNCACHED)
2345  return trans->txn_type;
2346 
2347  trans->txn_type = TXN_TYPE_NONE;
2348  for (GList *n = xaccTransGetSplitList (trans); n; n = g_list_next (n))
2349  {
2350  Account *acc = xaccSplitGetAccount (GNC_SPLIT(n->data));
2351 
2352  if (!acc)
2353  continue;
2354 
2356  has_nonAPAR_split = TRUE;
2357  else if (trans->txn_type == TXN_TYPE_NONE)
2358  {
2359  GNCLot *lot = xaccSplitGetLot (GNC_SPLIT(n->data));
2360  GncInvoice *invoice = gncInvoiceGetInvoiceFromLot (lot);
2361  GncOwner owner;
2362 
2363  if (invoice && trans == gncInvoiceGetPostedTxn (invoice))
2364  trans->txn_type = TXN_TYPE_INVOICE;
2365  else if (invoice || gncOwnerGetOwnerFromLot (lot, &owner))
2366  trans->txn_type = TXN_TYPE_PAYMENT;
2367  }
2368  }
2369 
2370  if (!has_nonAPAR_split && (trans->txn_type == TXN_TYPE_PAYMENT))
2371  trans->txn_type = TXN_TYPE_LINK;
2372 
2373  return trans->txn_type;
2374 }
#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:3237
STRUCTS.
#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:636
gboolean xaccAccountIsAPARType(GNCAccountType t)
Convenience function to check if the account is a valid business account type (meaning an Accounts Pa...
Definition: Account.cpp:4482
#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:1288
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.
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.cpp:1884

◆ 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 2573 of file Transaction.cpp.

2574 {
2575  return get_kvp_string_path (trans, {void_reason_str});
2576 }

◆ 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 2566 of file Transaction.cpp.

2567 {
2568  const char *s = xaccTransGetVoidReason (trans);
2569  return (s && *s);
2570 }
const char * xaccTransGetVoidReason(const Transaction *trans)
Returns the user supplied textual reason why a transaction was voided.

◆ 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 2579 of file Transaction.cpp.

2580 {
2581  auto void_str{get_kvp_string_path (tr, {void_time_str})};
2582  return void_str ? gnc_iso8601_to_time64_gmt (void_str) : 0;
2583 }
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...

◆ xaccTransIsBalanced()

gboolean xaccTransIsBalanced ( const Transaction *  trans)

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

Definition at line 1111 of file Transaction.cpp.

1112 {
1113  MonetaryList *imbal_list;
1114  gboolean result;
1115  gnc_numeric imbal = gnc_numeric_zero();
1116  gnc_numeric imbal_trading = gnc_numeric_zero();
1117 
1118  if (trans == nullptr) return FALSE;
1119 
1120  if (xaccTransUseTradingAccounts(trans))
1121  {
1122  /* Transaction is imbalanced if the value is imbalanced in either
1123  trading or non-trading splits. One can't be used to balance
1124  the other. */
1125  FOR_EACH_SPLIT(trans,
1126  {
1127  Account *acc = xaccSplitGetAccount(s);
1128  if (!acc || xaccAccountGetType(acc) != ACCT_TYPE_TRADING)
1129  {
1130  imbal = gnc_numeric_add(imbal, xaccSplitGetValue(s),
1132  }
1133  else
1134  {
1135  imbal_trading = gnc_numeric_add(imbal_trading, xaccSplitGetValue(s),
1137  }
1138  }
1139  );
1140  }
1141  else
1142  imbal = xaccTransGetImbalanceValue(trans);
1143 
1144  if (! gnc_numeric_zero_p(imbal) || ! gnc_numeric_zero_p(imbal_trading))
1145  return FALSE;
1146 
1147  if (!xaccTransUseTradingAccounts (trans))
1148  return TRUE;
1149 
1150  imbal_list = xaccTransGetImbalance(trans);
1151  result = imbal_list == nullptr;
1152  gnc_monetary_list_free(imbal_list);
1153  return result;
1154 }
gboolean xaccTransUseTradingAccounts(const Transaction *trans)
Determine whether this transaction should use commodity trading accounts.
GNCAccountType xaccAccountGetType(const Account *acc)
Returns the account&#39;s account type.
Definition: Account.cpp:3237
STRUCTS.
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:188
Account used to record multiple commodity transactions.
Definition: Account.h:155
gnc_numeric xaccTransGetImbalanceValue(const Transaction *trans)
The xaccTransGetImbalanceValue() method returns the total value of the transaction.
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 ...
#define GNC_DENOM_AUTO
Values that can be passed as the &#39;denom&#39; argument.
Definition: gnc-numeric.h:245

◆ 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 142 of file gmock-Transaction.cpp.

143 {
144  SCOPED_TRACE("");
145  auto mocktrans = gnc_mocktransaction(trans);
146  return mocktrans ? mocktrans->is_open() : FALSE;
147 }

◆ 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 2405 of file Transaction.cpp.

2406 {
2407  GDate *threshold_date;
2408  GDate trans_date;
2409  const QofBook *book = xaccTransGetBook (trans);
2410  gboolean result;
2411  g_assert(trans);
2412 
2413  if (!qof_book_uses_autoreadonly(book))
2414  {
2415  return FALSE;
2416  }
2417 
2418  if (xaccTransIsSXTemplate (trans))
2419  return FALSE;
2420 
2421  threshold_date = qof_book_get_autoreadonly_gdate(book);
2422  g_assert(threshold_date); // ok because we checked uses_autoreadonly before
2423  trans_date = xaccTransGetDatePostedGDate(trans);
2424 
2425 // g_warning("there is auto-read-only with days=%d, trans_date_day=%d, threshold_date_day=%d",
2426 // qof_book_get_num_days_autofreeze(book),
2427 // g_date_get_day(&trans_date),
2428 // g_date_get_day(threshold_date));
2429 
2430  if (g_date_compare(&trans_date, threshold_date) < 0)
2431  {
2432  //g_warning("we are auto-read-only");
2433  result = TRUE;
2434  }
2435  else
2436  {
2437  result = FALSE;
2438  }
2439  g_date_free(threshold_date);
2440  return result;
2441 }
GDate * qof_book_get_autoreadonly_gdate(const QofBook *book)
Returns the GDate that is the threshold for auto-read-only.
Definition: qofbook.cpp:988
#define xaccTransGetBook(X)
Definition: Transaction.h:786
gboolean qof_book_uses_autoreadonly(const QofBook *book)
Returns TRUE if the auto-read-only feature should be used, otherwise FALSE.
Definition: qofbook.cpp:962
GDate xaccTransGetDatePostedGDate(const Transaction *trans)
Retrieve the posted date of the transaction.

◆ 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 1011 of file Transaction.cpp.

1012 {
1013  QofCollection *col;
1014  if (!guid || !book) return nullptr;
1015  col = qof_book_get_collection (book, GNC_ID_TRANS);
1016  return (Transaction *) qof_collection_lookup_entity (col, guid);
1017 }
QofInstance * qof_collection_lookup_entity(const QofCollection *col, const GncGUID *guid)
Find the entity going only from its guid.
Definition: qofid.cpp:212
QofCollection * qof_book_get_collection(const QofBook *book, QofIdType entity_type)
Return The table of entities of the given type.
Definition: qofbook.cpp:521

◆ 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 1790 of file Transaction.cpp.

1791 {
1792  return xaccTransOrder_num_action (ta, nullptr, tb, nullptr);
1793 }
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.

◆ 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 1826 of file Transaction.cpp.

1828 {
1829  const char *da, *db;
1830  int retval;
1831 
1832  if ( ta && !tb ) return -1;
1833  if ( !ta && tb ) return +1;
1834  if ( !ta && !tb ) return 0;
1835 
1836  if (ta->date_posted != tb->date_posted)
1837  return (ta->date_posted > tb->date_posted) - (ta->date_posted < tb->date_posted);
1838 
1839  /* Always sort closing transactions after normal transactions */
1840  {
1841  gboolean ta_is_closing = xaccTransGetIsClosingTxn (ta);
1842  gboolean tb_is_closing = xaccTransGetIsClosingTxn (tb);
1843  if (ta_is_closing != tb_is_closing)
1844  return (ta_is_closing - tb_is_closing);
1845  }
1846 
1847  /* otherwise, sort on number string */
1848  if (actna && actnb) /* split action string, if not nullptr */
1849  {
1850  retval = order_by_int64_or_string (actna, actnb);
1851  }
1852  else /* else transaction num string */
1853  {
1854  retval = order_by_int64_or_string (ta->num, tb->num);
1855  }
1856  if (retval)
1857  return retval;
1858 
1859  if (ta->date_entered != tb->date_entered)
1860  return (ta->date_entered > tb->date_entered) - (ta->date_entered < tb->date_entered);
1861 
1862  /* otherwise, sort on description string */
1863  da = ta->description ? ta->description : "";
1864  db = tb->description ? tb->description : "";
1865  retval = g_utf8_collate (da, db);
1866  if (retval)
1867  return retval;
1868 
1869  /* else, sort on guid - keeps sort stable. */
1870  return qof_instance_guid_compare(ta, tb);
1871 }
gboolean xaccTransGetIsClosingTxn(const Transaction *trans)
Returns whether this transaction is a "closing transaction".
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 157 of file gmock-Transaction.cpp.

158 {
159  g_return_if_fail(GNC_IS_MOCKTRANSACTION(trans));
160  ((MockTransaction*)trans)->recordPrice();
161 }

◆ 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 2324 of file Transaction.cpp.

2325 {
2326  return trans ? trans->date_entered : 0;
2327 }

◆ 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 2286 of file Transaction.cpp.

2287 {
2288  return trans ? trans->date_posted : 0;
2289 }

◆ 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 2608 of file Transaction.cpp.

2609 {
2610  Transaction *trans;
2611  g_return_val_if_fail(orig, nullptr);
2612 
2613  /* First edit, dirty, and commit orig to ensure that any trading
2614  * splits are correctly balanced.
2615  */
2616  xaccTransBeginEdit (orig);
2617  qof_instance_set_dirty (QOF_INSTANCE (orig));
2618  xaccTransCommitEdit (orig);
2619 
2620  trans = xaccTransClone(orig);
2621  g_return_val_if_fail (trans, nullptr);
2622  xaccTransBeginEdit(trans);
2623 
2624  /* Reverse the values on each split. Clear per-split info. */
2625  FOR_EACH_SPLIT(trans,
2626  {
2630  });
2631 
2632  /* Now update the original with a pointer to the new one */
2633  qof_instance_set_path_kvp<GncGUID*> (QOF_INSTANCE (orig), guid_copy(xaccTransGetGUID(trans)),
2634  {TRANS_REVERSED_BY});
2635 
2636  /* Make sure the reverse transaction is not read-only */
2637  xaccTransClearReadOnly(trans);
2638 
2639  qof_instance_set_dirty(QOF_INSTANCE(trans));
2640  xaccTransCommitEdit(trans);
2641  return trans;
2642 }
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
gnc_numeric gnc_numeric_neg(gnc_numeric a)
Returns a newly created gnc_numeric that is the negative of the given gnc_numeric value...
GncGUID * guid_copy(const GncGUID *guid)
Returns a newly allocated GncGUID that matches the passed-in GUID.
Definition: guid.cpp:120
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.
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 xaccTransGetGUID(X)
Definition: Transaction.h:788
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:76
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 1623 of file Transaction.cpp.

1624 {
1625  GList *node, *onode;
1626  QofBackend *be;
1627  Transaction *orig;
1628  GList *slist;
1629  int num_preexist, i;
1630 
1631 /* FIXME: This isn't quite the right way to handle nested edits --
1632  * there should be a stack of transaction states that are popped off
1633  * and restored at each level -- but it does prevent restoring to the
1634  * editlevel 0 state until one is returning to editlevel 0, and
1635  * thereby prevents a crash caused by trans->orig getting nullptred too
1636  * soon.
1637  */
1638  if (!qof_instance_get_editlevel (QOF_INSTANCE (trans))) return;
1639  if (qof_instance_get_editlevel (QOF_INSTANCE (trans)) > 1) {
1640  qof_instance_decrease_editlevel (QOF_INSTANCE (trans));
1641  return;
1642  }
1643 
1644  ENTER ("trans addr=%p\n", trans);
1645 
1646  check_open(trans);
1647 
1648  /* copy the original values back in. */
1649 
1650  orig = trans->orig;
1651  std::swap (trans->num, orig->num);
1652  std::swap (trans->description, orig->description);
1653  trans->date_entered = orig->date_entered;
1654  trans->date_posted = orig->date_posted;
1655  std::swap (trans->common_currency, orig->common_currency);
1656  qof_instance_swap_kvp (QOF_INSTANCE (trans), QOF_INSTANCE (orig));
1657 
1658  /* The splits at the front of trans->splits are exactly the same
1659  splits as in the original, but some of them may have changed, so
1660  we restore only those. */
1661 /* FIXME: Runs off the transaction's splits, so deleted splits are not
1662  * restored!
1663  */
1664  num_preexist = g_list_length(orig->splits);
1665  slist = g_list_copy(trans->splits);
1666  for (i = 0, node = slist, onode = orig->splits; node;
1667  i++, node = node->next, onode = onode ? onode->next : nullptr)
1668  {
1669  Split *s = GNC_SPLIT(node->data);
1670 
1671  if (!qof_instance_is_dirty(QOF_INSTANCE(s)))
1672  continue;
1673 
1674  if (i < num_preexist && onode)
1675  {
1676  Split *so = GNC_SPLIT(onode->data);
1677 
1678  xaccSplitRollbackEdit(s);
1679  std::swap (s->action, so->action);
1680  std::swap (s->memo, so->memo);
1681  qof_instance_copy_kvp (QOF_INSTANCE (s), QOF_INSTANCE (so));
1682  s->reconciled = so->reconciled;
1683  s->amount = so->amount;
1684  s->value = so->value;
1685  s->lot = so->lot;
1686  s->gains_split = so->gains_split;
1687  //SET_GAINS_A_VDIRTY(s);
1688  s->date_reconciled = so->date_reconciled;
1689  qof_instance_mark_clean(QOF_INSTANCE(s));
1690  }
1691  else
1692  {
1693  /* Potentially added splits */
1694  if (trans != xaccSplitGetParent(s))
1695  {
1696  trans->splits = g_list_remove(trans->splits, s);
1697  /* New split added, but then moved to another
1698  transaction */
1699  continue;
1700  }
1701  xaccSplitRollbackEdit(s);
1702  trans->splits = g_list_remove(trans->splits, s);
1703  g_assert(trans != xaccSplitGetParent(s));
1704  /* NB: our memory management policy here is that a new split
1705  added to the transaction which is then rolled-back still
1706  belongs to the engine. Specifically, it's freed by the
1707  transaction to which it was added. Don't add the Split to
1708  more than one transaction during the begin/commit block! */
1709  if (nullptr == xaccSplitGetParent(s))
1710  {
1711  xaccFreeSplit(s); // a newly malloc'd split
1712  }
1713  }
1714  }
1715  g_list_free(slist);
1716 
1717  // orig->splits may still have duped splits so free them
1718  g_list_free_full (orig->splits, (GDestroyNotify)xaccFreeSplit);
1719  orig->splits = nullptr;
1720 
1721  /* Now that the engine copy is back to its original version,
1722  * get the backend to fix it in the database */
1726  if (qof_backend_can_rollback (be))
1727  {
1728  QofBackendError errcode;
1729 
1730  /* clear errors */
1731  do
1732  {
1733  errcode = qof_backend_get_error (be);
1734  }
1735  while (ERR_BACKEND_NO_ERR != errcode);
1736 
1737  qof_backend_rollback_instance (be, &(trans->inst));
1738 
1739  errcode = qof_backend_get_error (be);
1740  if (ERR_BACKEND_MOD_DESTROY == errcode)
1741  {
1742  /* The backend is asking us to delete this transaction.
1743  * This typically happens because another (remote) user
1744  * has deleted this transaction, and we haven't found
1745  * out about it until this user tried to edit it.
1746  */
1747  xaccTransDestroy (trans);
1748  do_destroy (QOF_INSTANCE(trans));
1749 
1750  /* push error back onto the stack */
1751  qof_backend_set_error (be, errcode);
1752  LEAVE ("deleted trans addr=%p\n", trans);
1753  return;
1754  }
1755  if (ERR_BACKEND_NO_ERR != errcode)
1756  {
1757  PERR ("Rollback Failed. Ouch!");
1758  /* push error back onto the stack */
1759  qof_backend_set_error (be, errcode);
1760  }
1761  }
1762 
1764  xaccTransWriteLog (trans, 'R');
1765 
1766  xaccFreeTransaction (trans->orig);
1767 
1768  trans->orig = nullptr;
1769  qof_instance_set_destroying(trans, FALSE);
1770 
1771  /* Put back to zero. */
1772  qof_instance_decrease_editlevel(trans);
1773  /* FIXME: The register code seems to depend on the engine to
1774  generate an event during rollback, even though the state is just
1775  reverting to what it was. */
1776  gen_event_trans (trans);
1777 
1778  LEAVE ("trans addr=%p\n", trans);
1779 }
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:166
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.cpp: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.
gboolean qof_book_is_readonly(const QofBook *book)
Return whether the book is read only.
Definition: qofbook.cpp:497
#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:440

◆ 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 2695 of file Transaction.cpp.

2696 {
2697  SplitList *node;
2698 
2699  ENTER("(trans=%p)", trans);
2700  /* Lock down posted date, its to be synced to the posted date
2701  * for the source of the cap gains. */
2702  xaccTransScrubGainsDate(trans);
2703 
2704  /* Fix up the split amount */
2705 restart:
2706  for (node = trans->splits; node; node = node->next)
2707  {
2708  Split *s = GNC_SPLIT(node->data);
2709 
2710  if (!xaccTransStillHasSplit(trans, s)) continue;
2711 
2712  xaccSplitDetermineGainStatus(s);
2713  if (s->gains & GAINS_STATUS_ADIRTY)
2714  {
2715  gboolean altered = FALSE;
2716  s->gains &= ~GAINS_STATUS_ADIRTY;
2717  if (s->lot)
2718  altered = xaccScrubLot(s->lot);
2719  else
2720  altered = xaccSplitAssign(s);
2721  if (altered) goto restart;
2722  }
2723  }
2724 
2725  /* Fix up gains split value */
2726  FOR_EACH_SPLIT(trans,
2727  if ((s->gains & GAINS_STATUS_VDIRTY) ||
2728  (s->gains_split &&
2729  (s->gains_split->gains & GAINS_STATUS_VDIRTY)))
2730  xaccSplitComputeCapGains(s, gain_acc);
2731  );
2732 
2733  LEAVE("(trans=%p)", trans);
2734 }
void xaccSplitComputeCapGains(Split *split, Account *gain_acc)
The xaccSplitComputeCapGains() routine computes the cap gains or losses for the indicated split...
Definition: cap-gains.cpp:526
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
GList SplitList
GList of Split.
Definition: gnc-engine.h:207
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.cpp:426
#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.cpp: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 1344 of file Transaction.cpp.

1345 {
1346  gnc_commodity *old_curr = trans->common_currency;
1347  if (!trans || !curr || trans->common_currency == curr) return;
1348  xaccTransBeginEdit(trans);
1349 
1350  trans->common_currency = curr;
1351  if (old_curr != nullptr && trans->splits != nullptr)
1352  {
1353  gnc_numeric rate = find_new_rate(trans, curr);
1354  if (!gnc_numeric_zero_p (rate))
1355  {
1356  FOR_EACH_SPLIT(trans, split_set_new_value(s, curr, old_curr, rate));
1357  }
1358  else
1359  {
1360  FOR_EACH_SPLIT(trans, xaccSplitSetValue(s, xaccSplitGetValue(s)));
1361  }
1362  }
1363 
1364  qof_instance_set_dirty(QOF_INSTANCE(trans));
1365  mark_trans(trans); /* Dirty balance of every account in trans */
1366  xaccTransCommitEdit(trans);
1367 }
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...
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&#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 1969 of file Transaction.cpp.

1970 {
1971  GDate *date;
1972  if (!trans) return;
1973  date = g_date_new_dmy(day, static_cast<GDateMonth>(mon), year);
1974  if (!g_date_valid(date))
1975  {
1976  PWARN("Attempted to set invalid date %d-%d-%d; set today's date instead.",
1977  year, mon, day);
1978  g_free(date);
1979  date = gnc_g_date_new_today();
1980  }
1981  xaccTransSetDatePostedGDate(trans, *date);
1982  g_free(date);
1983 }
void xaccTransSetDatePostedGDate(Transaction *trans, GDate date)
This method modifies posted date of the transaction, specified by a GDate.
#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:1231

◆ 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 1962 of file Transaction.cpp.

1963 {
1964  if (!trans) return;
1965  xaccTransSetDateInternal(trans, &trans->date_entered, secs);
1966 }

◆ 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 1946 of file Transaction.cpp.

1947 {
1948  if (!trans) return;
1949 
1950  /* We additionally save this date into a kvp frame to ensure in
1951  * the future a date which was set as *date* (without time) can
1952  * clearly be distinguished from the time64. */
1953  qof_instance_set_path_kvp<GDate> (QOF_INSTANCE(trans), date, {TRANS_DATE_POSTED});
1954  qof_instance_set_dirty (QOF_INSTANCE(trans));
1955  /* mark dirty and commit handled by SetDateInternal */
1956  xaccTransSetDateInternal(trans, &trans->date_posted,
1957  gdate_to_time64(date));
1958  set_gains_date_dirty (trans);
1959 }
time64 gdate_to_time64(GDate d)
Turns a GDate into a time64, returning the first second of the day.
Definition: gnc-date.cpp:1259

◆ 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 1930 of file Transaction.cpp.

1931 {
1932  if (!trans) return;
1933  xaccTransSetDateInternal(trans, &trans->date_posted, secs);
1934  set_gains_date_dirty(trans);
1935 }

◆ 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 2008 of file Transaction.cpp.

2009 {
2010  if (trans && reason)
2011  set_kvp_string_path (trans, {TRANS_READ_ONLY_REASON}, reason);
2012 }

◆ 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 1996 of file Transaction.cpp.

1997 {
1998  char s[2] = {type, '\0'};
1999  set_kvp_string_path (trans, {TRANS_TXN_TYPE_KVP}, s);
2000 }

◆ 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 2586 of file Transaction.cpp.

2587 {
2588  g_return_if_fail(trans);
2589 
2590  if (xaccTransGetVoidReason (trans) == nullptr)
2591  return; /* Transaction isn't voided. Bail. */
2592 
2593  xaccTransBeginEdit(trans);
2594 
2595  set_kvp_string_path (trans, {trans_notes_str}, get_kvp_string_path (trans, {void_former_notes_str}));
2596  set_kvp_string_path (trans, {void_former_notes_str}, nullptr);
2597  set_kvp_string_path (trans, {void_reason_str}, nullptr);
2598  set_kvp_string_path (trans, {void_time_str}, nullptr);
2599 
2600  FOR_EACH_SPLIT(trans, xaccSplitUnvoid(s));
2601 
2602  /* Dirtying taken care of by ClearReadOnly */
2603  xaccTransClearReadOnly(trans);
2604  xaccTransCommitEdit(trans);
2605 }
const char * xaccTransGetVoidReason(const Transaction *trans)
Returns the user supplied textual reason why a transaction was voided.
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...

◆ 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 2535 of file Transaction.cpp.

2536 {
2537  g_return_if_fail(trans && reason);
2538 
2539  /* Prevent voiding transactions that are already marked
2540  * read only, for example generated by the business features.
2541  */
2542  if (xaccTransGetReadOnly (trans))
2543  {
2544  PWARN ("Refusing to void a read-only transaction!");
2545  return;
2546  }
2547  xaccTransBeginEdit(trans);
2548 
2549  char iso8601_str[ISO_DATELENGTH + 1] = "";
2550  gnc_time64_to_iso8601_buff (gnc_time(nullptr), iso8601_str);
2551 
2552  if (auto s = get_kvp_string_path (trans, {trans_notes_str}))
2553  set_kvp_string_path (trans, {void_former_notes_str}, s);
2554  set_kvp_string_path (trans, {trans_notes_str}, _("Voided transaction"));
2555  set_kvp_string_path (trans, {void_reason_str}, reason);
2556  set_kvp_string_path (trans, {void_time_str}, iso8601_str);
2557 
2558  FOR_EACH_SPLIT(trans, xaccSplitVoid(s));
2559 
2560  /* Dirtying taken care of by SetReadOnly */
2561  xaccTransSetReadOnly(trans, _("Transaction Voided"));
2562  xaccTransCommitEdit(trans);
2563 }
const char * xaccTransGetReadOnly(Transaction *trans)
Returns a non-NULL value if this Transaction was marked as read-only with some specific "reason" text...
#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".
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 time
Definition: gnc-date.cpp:260
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:1146