GnuCash  2.6.99
Files | Macros | Functions

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

Files

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

Macros

#define GNC_TYPE_SPLIT   (gnc_split_get_type ())
 
#define GNC_SPLIT(o)   (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_SPLIT, Split))
 
#define GNC_SPLIT_CLASS(k)   (G_TYPE_CHECK_CLASS_CAST((k), GNC_TYPE_SPLIT, SplitClass))
 
#define GNC_IS_SPLIT(o)   (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_SPLIT))
 
#define GNC_IS_SPLIT_CLASS(k)   (G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_SPLIT))
 
#define GNC_SPLIT_GET_CLASS(o)   (G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_SPLIT, SplitClass))
 
#define xaccSplitGetGUID(X)   qof_entity_get_guid(QOF_INSTANCE(X))
 
#define xaccSplitReturnGUID(X)   (X ? *(qof_entity_get_guid(QOF_INSTANCE(X))) : *(guid_null()))
 
#define GNC_TYPE_TRANSACTION   (gnc_transaction_get_type ())
 
#define GNC_TRANSACTION(o)   (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_TRANSACTION, Transaction))
 
#define GNC_TRANSACTION_CLASS(k)   (G_TYPE_CHECK_CLASS_CAST((k), GNC_TYPE_TRANSACTION, TransactionClass))
 
#define GNC_IS_TRANSACTION(o)   (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_TRANSACTION))
 
#define GNC_IS_TRANSACTION_CLASS(k)   (G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_TRANSACTION))
 
#define GNC_TRANSACTION_GET_CLASS(o)   (G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_TRANSACTION, TransactionClass))
 
#define GNC_IS_TRANS(obj)   GNC_IS_TRANSACTION(obj)
 
#define GNC_TRANS(obj)   GNC_TRANSACTION(obj)
 
#define RECONCILED_MATCH_TYPE   "reconciled-match"
 
#define xaccTransGetBook(X)   qof_instance_get_book (QOF_INSTANCE(X))
 
#define xaccTransGetGUID(X)   qof_entity_get_guid(QOF_INSTANCE(X))
 
#define xaccTransReturnGUID(X)   (X ? *(qof_entity_get_guid(QOF_INSTANCE(X))) : *(guid_null()))
 

Functions

GType gnc_split_get_type (void)
 
gnc_numeric xaccSplitConvertAmount (const Split *split, const Account *account)
 
GType gnc_transaction_get_type (void)
 

Split Reconciled field values

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

Split general getters/setters

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

Split Date getters/setters

void xaccSplitSetReconcile (Split *split, char reconciled_flag)
 Set the reconcile flag. More...
 
char xaccSplitGetReconcile (const Split *split)
 Returns the value of the reconcile flag. More...
 
void xaccSplitSetDateReconciledSecs (Split *split, time64 time)
 Set the date on which this split was reconciled by specifying the time as time64. More...
 
void xaccSplitSetDateReconciledTS (Split *split, Timespec *ts)
 Set the date on which this split was reconciled by specifying the time as Timespec. More...
 
void xaccSplitGetDateReconciledTS (const Split *split, Timespec *ts)
 Get the date on which this split was reconciled by having it written into the Timespec that 'ts' is pointing to. More...
 
Timespec xaccSplitRetDateReconciledTS (const Split *split)
 Returns the date (as Timespec) on which this split was reconciled. 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 xaccSplitGetClearedBalance (const Split *split)
 The cleared-balance is the currency-denominated balance of all transactions that have been marked as cleared or reconciled. More...
 
gnc_numeric xaccSplitGetReconciledBalance (const Split *split)
 Returns the reconciled-balance of this split. More...
 

Split utility functions

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

Split deprecated functions

void xaccSplitSetSharePrice (Split *split, gnc_numeric price)
 

Split voiding

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

Split Parameter names

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

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

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

Transaction Type field values

#define TXN_TYPE_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. More...
 
char xaccTransGetTxnType (const Transaction *trans)
 Returns the Transaction Type. 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 xaccTransSetAssociation (Transaction *trans, const char *assoc)
 Sets the transaction Association.
 
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 * xaccTransGetAssociation (const Transaction *trans)
 Gets the transaction association.
 
const char * xaccTransGetNotes (const Transaction *trans)
 Gets the transaction Notes. More...
 
void xaccTransSetIsClosingTxn (Transaction *trans, gboolean is_closing)
 Sets whether or not this transaction is a "closing transaction".
 
gboolean xaccTransGetIsClosingTxn (const Transaction *trans)
 Returns whether this transaction is a "closing transaction".
 
Split * xaccTransGetSplit (const Transaction *trans, int i)
 The xaccTransGetSplit() method returns a pointer to each of the splits in this transaction. 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...
 
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)
 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 (const Transaction *trans)
 Returns a non-NULL value if this Transaction was marked as read-only with some specific "reason" text. More...
 
gboolean xaccTransIsReadonlyByPostedDate (const Transaction *trans)
 Returns TRUE if this Transaction is read-only because its posted-date is older than the "auto-readonly" threshold of this book. More...
 
gboolean xaccTransInFutureByPostedDate (const Transaction *trans)
 Returns TRUE if this Transaction's posted-date is in the future.
 
int xaccTransCountSplits (const Transaction *trans)
 Returns the number of splits in this transaction. More...
 
gboolean xaccTransHasReconciledSplits (const Transaction *trans)
 FIXME: document me.
 
gboolean xaccTransHasReconciledSplitsByAccount (const Transaction *trans, const Account *account)
 FIXME: document me.
 
gboolean xaccTransHasSplitsInState (const Transaction *trans, const char state)
 FIXME: document me.
 
gboolean xaccTransHasSplitsInStateByAccount (const Transaction *trans, const char state, const Account *account)
 FIXME: document me.
 
gnc_commodity * xaccTransGetCurrency (const Transaction *trans)
 Returns the valuation commodity of this transaction. More...
 
void xaccTransSetCurrency (Transaction *trans, gnc_commodity *curr)
 Set the commodity of this transaction. More...
 
gnc_numeric xaccTransGetImbalanceValue (const Transaction *trans)
 The xaccTransGetImbalanceValue() method returns the total value of the transaction. More...
 
MonetaryList * xaccTransGetImbalance (const Transaction *trans)
 The xaccTransGetImbalance method returns a list giving the value of the transaction in each currency for which the balance is not zero. More...
 
gboolean xaccTransIsBalanced (const Transaction *trans)
 Returns true if the transaction is balanced according to the rules currently in effect. More...
 
gnc_numeric xaccTransGetAccountValue (const Transaction *trans, const Account *account)
 The xaccTransGetAccountValue() method returns the total value applied to a particular account. More...
 
gnc_numeric xaccTransGetAccountAmount (const Transaction *trans, const Account *account)
 Same as xaccTransGetAccountValue, but uses the Account's commodity. More...
 
gboolean xaccTransGetRateForCommodity (const Transaction *trans, const gnc_commodity *split_com, const Split *split_to_exclude, gnc_numeric *rate)
 
gnc_numeric xaccTransGetAccountConvRate (const Transaction *txn, const Account *acc)
 
gnc_numeric xaccTransGetAccountBalance (const Transaction *trans, const Account *account)
 Get the account balance for the specified account after the last split in the specified transaction. More...
 
int xaccTransOrder (const Transaction *ta, const Transaction *tb)
 The xaccTransOrder(ta,tb) method is useful for sorting. More...
 
int xaccTransOrder_num_action (const Transaction *ta, const char *actna, const Transaction *tb, const char *actnb)
 The xaccTransOrder_num_action(ta,actna,tb,actnb) method is useful for sorting. More...
 
#define xaccTransAppendSplit(t, s)   xaccSplitSetParent((s), (t))
 Add a split to the transaction. More...
 

Transaction date setters/getters

void xaccTransSetDate (Transaction *trans, int day, int mon, int year)
 The xaccTransSetDate() method does the same thing as xaccTransSetDate[Posted]Secs(), but takes a convenient day-month-year format. More...
 
void xaccTransSetDatePostedGDate (Transaction *trans, GDate date)
 This method modifies posted date of the transaction, specified by a GDate. More...
 
void xaccTransSetDatePostedSecs (Transaction *trans, time64 time)
 The xaccTransSetDatePostedSecs() method will modify the posted date of the transaction, specified by a time64 (see ctime(3)). More...
 
void xaccTransSetDatePostedSecsNormalized (Transaction *trans, time64 time)
 This function sets the posted date of the transaction, specified by a time64 (see ctime(3)). More...
 
void xaccTransSetDatePostedTS (Transaction *trans, const Timespec *ts)
 The xaccTransSetDatePostedTS() method does the same thing as xaccTransSetDatePostedSecs(), but takes a struct timespec64. More...
 
void xaccTransSetDateEnteredSecs (Transaction *trans, time64 time)
 Modify the date of when the transaction was entered. More...
 
void xaccTransSetDateEnteredTS (Transaction *trans, const Timespec *ts)
 Modify the date of when the transaction was entered. More...
 
void xaccTransSetDateDueTS (Transaction *trans, const Timespec *ts)
 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...
 
void xaccTransGetDatePostedTS (const Transaction *trans, Timespec *ts)
 Retrieve the posted date of the transaction. More...
 
Timespec xaccTransRetDatePostedTS (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...
 
void xaccTransGetDateEnteredTS (const Transaction *trans, Timespec *ts)
 Retrieve the date of when the transaction was entered. More...
 
Timespec xaccTransRetDateEnteredTS (const Transaction *trans)
 Retrieve the date of when the transaction was entered. More...
 
Timespec xaccTransRetDateDueTS (const Transaction *trans)
 Dates and txn-type for A/R and A/P "invoice" postings.
 
void xaccTransGetDateDueTS (const Transaction *trans, Timespec *ts)
 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 tranaction 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...
 
Timespec 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_ASSOCIATION   "assoc"
 
#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 cannnot 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 549 of file Split.h.

◆ xaccSplitReturnGUID

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

Definition at line 551 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 357 of file Transaction.h.

◆ xaccTransGetBook

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

Definition at line 768 of file Transaction.h.

◆ xaccTransGetGUID

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

Definition at line 770 of file Transaction.h.

◆ xaccTransReturnGUID

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

Definition at line 772 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 2599 of file Transaction.c.

2600 {
2601  guint count = 0;
2602  xaccAccountTreeForEachTransaction(gnc_book_get_root_account(book),
2603  counter_thunk, (void*)&count);
2604  return count;
2605 }
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 546 of file Split.c.

547 {
548  Split *split;
549  g_return_val_if_fail (book, NULL);
550 
551  split = g_object_new (GNC_TYPE_SPLIT, NULL);
552  xaccInitSplit (split, book);
553 
554  return split;
555 }

◆ 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 517 of file Transaction.c.

518 {
519  Transaction *trans;
520 
521  g_return_val_if_fail (book, NULL);
522 
523  trans = g_object_new(GNC_TYPE_TRANSACTION, NULL);
524  xaccInitTransaction (trans, book);
525  qof_event_gen (&trans->inst, QOF_EVENT_CREATE, NULL);
526 
527  return trans;
528 }
void qof_event_gen(QofInstance *entity, QofEventId event_id, gpointer event_data)
Invoke all registered event handlers using the given arguments.
Definition: qofevent.cpp:234

◆ 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 2021 of file Split.c.

2023 {
2024  const GncGUID* guid;
2025 
2026  g_return_if_fail (split != NULL);
2027  g_return_if_fail (other_split != NULL);
2028 
2029  guid = qof_instance_get_guid (QOF_INSTANCE (other_split));
2030  xaccTransBeginEdit (split->parent);
2031  qof_instance_kvp_add_guid (QOF_INSTANCE (split), "lot-split",
2032  timespec_now(), "peer_guid", guid_copy(guid));
2033  mark_split (split);
2034  qof_instance_set_dirty (QOF_INSTANCE (split));
2035  xaccTransCommitEdit (split->parent);
2036 }
const GncGUID * qof_instance_get_guid(gconstpointer inst)
Return the GncGUID of this instance.
GncGUID * guid_copy(const GncGUID *guid)
Returns a newly allocated GncGUID that matches the passed-in GUID.
Definition: guid.cpp:121
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443
Timespec timespec_now()
Returns the current clock time as a Timespec, taken from time(2).
Definition: gnc-date.cpp:1318
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 1661 of file Split.c.

1662 {
1663  Account *aa, *ab;
1664  if (!sa && !sb) return 0;
1665  if (!sa) return -1;
1666  if (!sb) return 1;
1667 
1668  aa = sa->acc;
1669  ab = sb->acc;
1670 
1671  return g_strcmp0(xaccAccountGetCode(aa), xaccAccountGetCode(ab));
1672 }
const char * xaccAccountGetCode(const Account *acc)
Get the account's accounting code.
Definition: Account.c:3087
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 1640 of file Split.c.

1641 {
1642  Account *aa, *ab;
1643  char *full_a, *full_b;
1644  int retval;
1645  if (!sa && !sb) return 0;
1646  if (!sa) return -1;
1647  if (!sb) return 1;
1648 
1649  aa = sa->acc;
1650  ab = sb->acc;
1651  full_a = gnc_account_get_full_name(aa);
1652  full_b = gnc_account_get_full_name(ab);
1653  retval = g_utf8_collate(full_a, full_b);
1654  g_free(full_a);
1655  g_free(full_b);
1656  return retval;
1657 }
STRUCTS.
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.c:3039

◆ 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 1696 of file Split.c.

1697 {
1698  const char *ca, *cb;
1699  if (!sa && !sb) return 0;
1700  if (!sa) return -1;
1701  if (!sb) return 1;
1702 
1703  ca = xaccSplitGetCorrAccountCode(sa);
1704  cb = xaccSplitGetCorrAccountCode(sb);
1705  return g_strcmp0(ca, cb);
1706 }
const char * xaccSplitGetCorrAccountCode(const Split *sa)
document me
Definition: Split.c:1622

◆ 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 1675 of file Split.c.

1676 {
1677  char *ca, *cb;
1678  int retval;
1679  if (!sa && !sb) return 0;
1680  if (!sa) return -1;
1681  if (!sb) return 1;
1682 
1683  /* doesn't matter what separator we use
1684  * as long as they are the same
1685  */
1686 
1689  retval = g_strcmp0(ca, cb);
1690  g_free(ca);
1691  g_free(cb);
1692  return retval;
1693 }
char * xaccSplitGetCorrAccountFullName(const Split *sa)
These functions take a split, get the corresponding split on the "other side" of the transaction...
Definition: Split.c:1606

◆ 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 650 of file Split.c.

651 {
652  if (!from_split || !to_split) return;
653  xaccTransBeginEdit (to_split->parent);
654 
655  xaccSplitSetMemo(to_split, xaccSplitGetMemo(from_split));
656  xaccSplitSetAction(to_split, xaccSplitGetAction(from_split));
657  xaccSplitSetAmount(to_split, xaccSplitGetAmount(from_split));
658  xaccSplitSetValue(to_split, xaccSplitGetValue(from_split));
659  /* Setting the account is okay here because, even though the from
660  split might not really belong to the account it claims to,
661  setting the account won't cause any event involving from. */
662  xaccSplitSetAccount(to_split, xaccSplitGetAccount(from_split));
663  /* N.B. Don't set parent. */
664 
665  qof_instance_set_dirty(QOF_INSTANCE(to_split));
666  xaccTransCommitEdit(to_split->parent);
667 }
void xaccSplitSetValue(Split *s, gnc_numeric amt)
The xaccSplitSetValue() method sets the value of this split in the transaction's commodity.
Definition: Split.c:1258
void xaccSplitSetAction(Split *split, const char *actn)
The Action is an arbitrary user-assigned string.
Definition: Split.c:1735
void xaccSplitSetAmount(Split *s, gnc_numeric amt)
The xaccSplitSetAmount() method sets the amount in the account's commodity that the split should have...
Definition: Split.c:1222
void xaccSplitSetMemo(Split *split, const char *memo)
The memo is an arbitrary string associated with a split.
Definition: Split.c:1716
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction's commodity.
Definition: Split.c:1935
Account * xaccSplitGetAccount(const Split *s)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: Split.c:929
const char * xaccSplitGetMemo(const Split *split)
Returns the memo string.
Definition: Split.c:1910
const char * xaccSplitGetAction(const Split *split)
Returns the action string.
Definition: Split.c:1916
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account's commodity.
Definition: Split.c:1929

◆ xaccSplitDestroy()

gboolean xaccSplitDestroy ( Split *  split)

Destructor.

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

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

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

Definition at line 1456 of file Split.c.

1457 {
1458  Account *acc;
1459  Transaction *trans;
1460  GncEventData ed;
1461 
1462  if (!split) return TRUE;
1463 
1464  acc = split->acc;
1465  trans = split->parent;
1466  if (acc && !qof_instance_get_destroying(acc)
1467  && xaccTransGetReadOnly(trans))
1468  return FALSE;
1469 
1470  xaccTransBeginEdit(trans);
1471  ed.node = split;
1472  ed.idx = xaccTransGetSplitIndex(trans, split);
1473  qof_instance_set_dirty(QOF_INSTANCE(split));
1474  qof_instance_set_destroying(split, TRUE);
1475  qof_event_gen(&trans->inst, GNC_EVENT_ITEM_REMOVED, &ed);
1476  xaccTransCommitEdit(trans);
1477 
1478  return TRUE;
1479 }
STRUCTS.
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...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443
const char * xaccTransGetReadOnly(const Transaction *trans)
Returns a non-NULL value if this Transaction was marked as read-only with some specific "reason" text...
Definition: Transaction.c:2421
int xaccTransGetSplitIndex(const Transaction *trans, const Split *split)
Inverse of xaccTransGetSplit()
Definition: Transaction.c:2228
void qof_event_gen(QofInstance *entity, QofEventId event_id, gpointer event_data)
Invoke all registered event handlers using the given arguments.
Definition: qofevent.cpp:234

◆ 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 776 of file Split.c.

780 {
781  gboolean same_book;
782 
783  if (!sa && !sb) return TRUE; /* Arguable. FALSE is better, methinks */
784 
785  if (!sa || !sb)
786  {
787  PINFO ("one is NULL");
788  return FALSE;
789  }
790 
791  if (sa == sb) return TRUE;
792 
793  same_book = qof_instance_get_book(QOF_INSTANCE(sa)) == qof_instance_get_book(QOF_INSTANCE(sb));
794 
795  if (check_guids)
796  {
797  if (qof_instance_guid_compare(sa, sb) != 0)
798  {
799  PINFO ("GUIDs differ");
800  return FALSE;
801  }
802  }
803 
804  /* If the same book, since these strings are cached we can just use pointer equality */
805  if ((same_book && sa->memo != sb->memo) || (!same_book && g_strcmp0(sa->memo, sb->memo) != 0))
806  {
807  PINFO ("memos differ: (%p)%s vs (%p)%s",
808  sa->memo, sa->memo, sb->memo, sb->memo);
809  return FALSE;
810  }
811 
812  if ((same_book && sa->action != sb->action) || (!same_book && g_strcmp0(sa->action, sb->action) != 0))
813  {
814  PINFO ("actions differ: %s vs %s", sa->action, sb->action);
815  return FALSE;
816  }
817 
818  if (qof_instance_compare_kvp (QOF_INSTANCE (sa), QOF_INSTANCE (sb)) != 0)
819  {
820  char *frame_a;
821  char *frame_b;
822 
823  frame_a = qof_instance_kvp_as_string (QOF_INSTANCE (sa));
824  frame_b = qof_instance_kvp_as_string (QOF_INSTANCE (sb));
825 
826  PINFO ("kvp frames differ:\n%s\n\nvs\n\n%s", frame_a, frame_b);
827 
828  g_free (frame_a);
829  g_free (frame_b);
830 
831  return FALSE;
832  }
833 
834  if (sa->reconciled != sb->reconciled)
835  {
836  PINFO ("reconcile flags differ: %c vs %c", sa->reconciled, sb->reconciled);
837  return FALSE;
838  }
839 
840  if (timespec_cmp(&(sa->date_reconciled), &(sb->date_reconciled)))
841  {
842  PINFO ("reconciled date differs");
843  return FALSE;
844  }
845 
847  {
848  char *str_a;
849  char *str_b;
850 
853 
854  PINFO ("amounts differ: %s vs %s", str_a, str_b);
855 
856  g_free (str_a);
857  g_free (str_b);
858 
859  return FALSE;
860  }
861 
863  {
864  char *str_a;
865  char *str_b;
866 
869 
870  PINFO ("values differ: %s vs %s", str_a, str_b);
871 
872  g_free (str_a);
873  g_free (str_b);
874 
875  return FALSE;
876  }
877 
878  if (check_balances)
879  {
880  if (!xaccSplitEqualCheckBal ("", sa->balance, sb->balance))
881  return FALSE;
882  if (!xaccSplitEqualCheckBal ("cleared ", sa->cleared_balance,
883  sb->cleared_balance))
884  return FALSE;
885  if (!xaccSplitEqualCheckBal ("reconciled ", sa->reconciled_balance,
886  sb->reconciled_balance))
887  return FALSE;
888  }
889 
890  if (!xaccTransEqual(sa->parent, sb->parent, check_guids, check_txn_splits,
891  check_balances, FALSE))
892  {
893  PINFO ("transactions differ");
894  return FALSE;
895  }
896 
897  return TRUE;
898 }
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.
#define PINFO(format, args...)
Print an informational note.
Definition: qoflog.h:249
gchar * gnc_numeric_to_string(gnc_numeric n)
Convert to string.
gint timespec_cmp(const Timespec *ta, const Timespec *tb)
comparison: if (ta < tb) -1; else if (ta > tb) 1; else 0;
Definition: gnc-date.cpp:433
gboolean xaccTransEqual(const Transaction *ta, const Transaction *tb, gboolean check_guids, gboolean check_splits, gboolean check_balances, gboolean assume_ordered)
Equality.
Definition: Transaction.c:863
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&#39;s commodity.
Definition: Split.c:1935
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&#39;s commodity.
Definition: Split.c:1929

◆ xaccSplitGetAccount()

Account* xaccSplitGetAccount ( const Split *  split)

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

Definition at line 929 of file Split.c.

930 {
931  return s ? s->acc : NULL;
932 }

◆ 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 1916 of file Split.c.

1917 {
1918  return split ? split->action : NULL;
1919 }

◆ 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 1929 of file Split.c.

1930 {
1931  return split ? split->amount : gnc_numeric_zero();
1932 }

◆ 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 1287 of file Split.c.

1288 {
1289  return s ? s->balance : gnc_numeric_zero();
1290 }

◆ 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 1360 of file Split.c.

1361 {
1362  if (!s || !s->acc || !s->parent) return gnc_numeric_zero();
1363 
1364  /* be more precise -- the value depends on the currency we want it
1365  * expressed in. */
1366  if (gnc_commodity_equiv(xaccTransGetCurrency(s->parent), base_currency))
1367  return xaccSplitGetValue(s);
1368  if (gnc_commodity_equiv(xaccAccountGetCommodity(s->acc), base_currency))
1369  return xaccSplitGetAmount(s);
1370 
1371  PERR ("inappropriate base currency %s "
1372  "given split currency=%s and commodity=%s\n",
1373  gnc_commodity_get_printname(base_currency),
1376  return gnc_numeric_zero();
1377 }
#define PERR(format, args...)
Log a serious error.
Definition: qoflog.h:237
const char * gnc_commodity_get_printname(const gnc_commodity *cm)
Retrieve the &#39;print&#39; name for the specified commodity.
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction&#39;s commodity.
Definition: Split.c:1935
gnc_commodity * xaccAccountGetCommodity(const Account *acc)
Get the account&#39;s commodity.
Definition: Account.c:3155
gnc_commodity * xaccTransGetCurrency(const Transaction *trans)
Returns the valuation commodity of this transaction.
Definition: Transaction.c:1355
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: Split.c:1929

◆ xaccSplitGetBook()

QofBook* xaccSplitGetBook ( const Split *  split)

Returns the book of this split, i.e.

the entity where this split is stored.

Definition at line 1984 of file Split.c.

1985 {
1986  return qof_instance_get_book(QOF_INSTANCE(split));
1987 }
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.

◆ 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 1293 of file Split.c.

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

◆ 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 1606 of file Split.c.

1607 {
1608  static const char *split_const = NULL;
1609  const Split *other_split;
1610 
1611  if (!get_corr_account_split(sa, &other_split))
1612  {
1613  if (!split_const)
1614  split_const = _("-- Split Transaction --");
1615 
1616  return g_strdup(split_const);
1617  }
1618  return gnc_account_get_full_name(other_split->acc);
1619 }
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.c:3039

◆ xaccSplitGetDateReconciled()

time64 xaccSplitGetDateReconciled ( const Split *  split)

Retrieve the date when the Split was reconciled.

Definition at line 1834 of file Split.c.

1835 {
1836  return split ? split->date_reconciled.tv_sec : 0;
1837 }

◆ xaccSplitGetDateReconciledTS()

void xaccSplitGetDateReconciledTS ( const Split *  split,
Timespec *  ts 
)

Get the date on which this split was reconciled by having it written into the Timespec that 'ts' is pointing to.

Definition at line 1819 of file Split.c.

1820 {
1821  if (!split || !ts) return;
1822  *ts = (split->date_reconciled);
1823 }

◆ 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 1895 of file Split.c.

1896 {
1897  return split ? split->lot : NULL;
1898 }

◆ xaccSplitGetMemo()

const char* xaccSplitGetMemo ( const Split *  split)

Returns the memo string.

Definition at line 1910 of file Split.c.

1911 {
1912  return split ? split->memo : NULL;
1913 }

◆ 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 2098 of file Split.c.

2099 {
2100  int i;
2101  Transaction *trans;
2102  int count, num_splits;
2103  Split *other = NULL;
2104  gboolean lot_split;
2105  gboolean trading_accts;
2106 
2107  if (!split) return NULL;
2108  trans = split->parent;
2109  if (!trans) return NULL;
2110 
2111  trading_accts = xaccTransUseTradingAccounts (trans);
2112  num_splits = xaccTransCountSplits(trans);
2113  count = num_splits;
2114  lot_split = qof_instance_has_slot(QOF_INSTANCE (split), "lot-split");
2115  if (!lot_split && !trading_accts && (2 != count)) return NULL;
2116 
2117  for (i = 0; i < num_splits; i++)
2118  {
2119  Split *s = xaccTransGetSplit(trans, i);
2120  if (s == split)
2121  {
2122  --count;
2123  continue;
2124  }
2125  if (qof_instance_has_slot (QOF_INSTANCE (s), "lot-split"))
2126  {
2127  --count;
2128  continue;
2129  }
2130  if (trading_accts &&
2132  {
2133  --count;
2134  continue;
2135  }
2136  other = s;
2137  }
2138  return (1 == count) ? other : NULL;
2139 }
Split * xaccTransGetSplit(const Transaction *trans, int i)
The xaccTransGetSplit() method returns a pointer to each of the splits in this transaction.
Definition: Transaction.c:2218
gboolean xaccTransUseTradingAccounts(const Transaction *trans)
Determine whether this transaction should use commodity trading accounts.
Definition: Transaction.c:1022
GNCAccountType xaccAccountGetType(const Account *acc)
Returns the account&#39;s account type.
Definition: Account.c:3010
Account used to record multiple commodity transactions.
Definition: Account.h:155
int xaccTransCountSplits(const Transaction *trans)
Returns the number of splits in this transaction.
Definition: Transaction.c:2266
Account * xaccSplitGetAccount(const Split *s)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: Split.c:929

◆ xaccSplitGetParent()

Transaction* xaccSplitGetParent ( const Split *  split)

Returns the parent transaction of the split.

Definition at line 1845 of file Split.c.

1846 {
1847  return split ? split->parent : NULL;
1848 }

◆ xaccSplitGetReconcile()

char xaccSplitGetReconcile ( const Split *  split)

Returns the value of the reconcile flag.

Definition at line 1922 of file Split.c.

1923 {
1924  return split ? split->reconciled : ' ';
1925 }

◆ 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 1299 of file Split.c.

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

◆ 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 1941 of file Split.c.

1942 {
1943  gnc_numeric amt, val, price;
1944  if (!split) return gnc_numeric_create(1, 1);
1945 
1946 
1947  /* if amount == 0 and value == 0, then return 1.
1948  * if amount == 0 and value != 0 then return 0.
1949  * otherwise return value/amount
1950  */
1951 
1952  amt = xaccSplitGetAmount(split);
1953  val = xaccSplitGetValue(split);
1954  if (gnc_numeric_zero_p(amt))
1955  {
1956  if (gnc_numeric_zero_p(val))
1957  return gnc_numeric_create(1, 1);
1958  return gnc_numeric_create(0, 1);
1959  }
1960  price = gnc_numeric_div(val, amt,
1962  GNC_HOW_DENOM_SIGFIGS(PRICE_SIGFIGS) |
1964 
1965  /* During random checks we can get some very weird prices. Let's
1966  * handle some overflow and other error conditions by returning
1967  * zero. But still print an error to let us know it happened.
1968  */
1969  if (gnc_numeric_check(price))
1970  {
1971  PERR("Computing share price failed (%d): [ %" G_GINT64_FORMAT " / %"
1972  G_GINT64_FORMAT " ] / [ %" G_GINT64_FORMAT " / %" G_GINT64_FORMAT " ]",
1973  gnc_numeric_check(price), val.num, val.denom, amt.num, amt.denom);
1974  return gnc_numeric_create(0, 1);
1975  }
1976 
1977  return price;
1978 }
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:237
gnc_numeric gnc_numeric_div(gnc_numeric a, gnc_numeric b, gint64 denom, gint how)
Division.
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:166
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction&#39;s commodity.
Definition: Split.c:1935
GNCNumericErrorCode gnc_numeric_check(gnc_numeric in)
Check for error signal in value.
#define GNC_DENOM_AUTO
Values that can be passed as the &#39;denom&#39; argument.
Definition: gnc-numeric.h:246
#define GNC_HOW_DENOM_SIGFIGS(n)
Build a &#39;how&#39; value that will generate a denominator that will keep at least n significant figures in...
Definition: gnc-numeric.h:218
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account&#39;s commodity.
Definition: Split.c:1929

◆ 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 1990 of file Split.c.

1991 {
1992  GValue v = G_VALUE_INIT;
1993  const char *split_type = NULL;
1994 
1995  if (!s) return NULL;
1996  qof_instance_get_kvp (QOF_INSTANCE (s), "split-type", &v);
1997  if (G_VALUE_HOLDS_STRING (&v))
1998  split_type = g_value_get_string (&v);
1999  return split_type ? split_type : "normal";
2000 }
void qof_instance_get_kvp(const QofInstance *inst, const gchar *key, GValue *value)
Retrieves the contents of a KVP slot into a provided GValue.

◆ xaccSplitGetValue()

gnc_numeric xaccSplitGetValue ( const Split *  split)

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

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

Definition at line 1935 of file Split.c.

1936 {
1937  return split ? split->value : gnc_numeric_zero();
1938 }

◆ 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 2045 of file Split.c.

2046 {
2047  const GncGUID* guid;
2048 
2049  g_return_val_if_fail (split != NULL, FALSE);
2050  g_return_val_if_fail (other_split != NULL, FALSE);
2051 
2052  guid = qof_instance_get_guid (QOF_INSTANCE (other_split));
2053  return qof_instance_kvp_has_guid (QOF_INSTANCE (split), "lot-split",
2054  "peer_guid", guid);
2055 }
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 1065 of file Split.c.

1066 {
1067  QofCollection *col;
1068  if (!guid || !book) return NULL;
1069  col = qof_book_get_collection (book, GNC_ID_SPLIT);
1070  return (Split *) qof_collection_lookup_entity (col, guid);
1071 }
QofInstance * qof_collection_lookup_entity(const QofCollection *col, const GncGUID *guid)
Find the entity going only from its guid.
Definition: qofid.cpp:214
QofCollection * qof_book_get_collection(const QofBook *book, QofIdType entity_type)
Return The table of entities of the given type.
Definition: qofbook.cpp:599

◆ 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 2005 of file Split.c.

2006 {
2007  GValue v = G_VALUE_INIT;
2008  xaccTransBeginEdit (s->parent);
2009 
2010  s->value = gnc_numeric_zero();
2011  g_value_init (&v, G_TYPE_STRING);
2012  g_value_set_string (&v, "stock-split");
2013  qof_instance_set_kvp (QOF_INSTANCE (s), "split-type", &v);
2014  SET_GAINS_VDIRTY(s);
2015  mark_split(s);
2016  qof_instance_set_dirty(QOF_INSTANCE(s));
2017  xaccTransCommitEdit(s->parent);
2018 }
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443
void qof_instance_set_kvp(QofInstance *inst, const gchar *key, const GValue *value)
Sets a KVP slot to a value from a GValue.

◆ 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 2075 of file Split.c.

2076 {
2077  xaccTransBeginEdit (split->parent);
2078  qof_instance_kvp_merge_guids (QOF_INSTANCE (split),
2079  QOF_INSTANCE (other_split), "lot-split");
2080  mark_split (split);
2081  qof_instance_set_dirty (QOF_INSTANCE (split));
2082  xaccTransCommitEdit (split->parent);
2083 }
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443

◆ 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 1485 of file Split.c.

1486 {
1487  int retval;
1488  int comp;
1489  char *da, *db;
1490  gboolean action_for_num;
1491 
1492  if (sa == sb) return 0;
1493  /* nothing is always less than something */
1494  if (!sa) return -1;
1495  if (!sb) return +1;
1496 
1497  /* sort in transaction order, but use split action rather than trans num
1498  * according to book option */
1500  (xaccSplitGetBook (sa));
1501  if (action_for_num)
1502  retval = xaccTransOrder_num_action (sa->parent, sa->action,
1503  sb->parent, sb->action);
1504  else
1505  retval = xaccTransOrder (sa->parent, sb->parent);
1506  if (retval) return retval;
1507 
1508  /* otherwise, sort on memo strings */
1509  da = sa->memo ? sa->memo : "";
1510  db = sb->memo ? sb->memo : "";
1511  retval = g_utf8_collate (da, db);
1512  if (retval)
1513  return retval;
1514 
1515  /* otherwise, sort on action strings */
1516  da = sa->action ? sa->action : "";
1517  db = sb->action ? sb->action : "";
1518  retval = g_utf8_collate (da, db);
1519  if (retval != 0)
1520  return retval;
1521 
1522  /* the reconciled flag ... */
1523  if (sa->reconciled < sb->reconciled) return -1;
1524  if (sa->reconciled > sb->reconciled) return +1;
1525 
1526  /* compare amounts */
1528  if (comp < 0) return -1;
1529  if (comp > 0) return +1;
1530 
1532  if (comp < 0) return -1;
1533  if (comp > 0) return +1;
1534 
1535  /* if dates differ, return */
1536  DATE_CMP(sa, sb, date_reconciled);
1537 
1538  /* else, sort on guid - keeps sort stable. */
1539  retval = qof_instance_guid_compare(sa, sb);
1540  if (retval) return retval;
1541 
1542  return 0;
1543 }
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...
Definition: qofbook.cpp:1042
int gnc_numeric_compare(gnc_numeric a, gnc_numeric b)
Returns 1 if a>b, -1 if b>a, 0 if a == b.
QofBook * xaccSplitGetBook(const Split *split)
Returns the book of this split, i.e.
Definition: Split.c:1984
int xaccTransOrder_num_action(const Transaction *ta, const char *actna, const Transaction *tb, const char *actnb)
The xaccTransOrder_num_action(ta,actna,tb,actnb) method is useful for sorting.
Definition: Transaction.c:1888
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction&#39;s commodity.
Definition: Split.c:1935
gint qof_instance_guid_compare(gconstpointer ptr1, gconstpointer ptr2)
Compare the GncGUID values of two instances.
int xaccTransOrder(const Transaction *ta, const Transaction *tb)
The xaccTransOrder(ta,tb) method is useful for sorting.
Definition: Transaction.c:1882
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account&#39;s commodity.
Definition: Split.c:1929

◆ 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 2058 of file Split.c.

2059 {
2060  const GncGUID* guid;
2061 
2062  g_return_if_fail (split != NULL);
2063  g_return_if_fail (other_split != NULL);
2064 
2065  guid = qof_instance_get_guid (QOF_INSTANCE (other_split));
2066  xaccTransBeginEdit (split->parent);
2067  qof_instance_kvp_remove_guid (QOF_INSTANCE (split), "lot-split",
2068  "peer_guid", guid);
2069  mark_split (split);
2070  qof_instance_set_dirty (QOF_INSTANCE (split));
2071  xaccTransCommitEdit (split->parent);
2072 }
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...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443
The type used to store guids in C.
Definition: guid.h:75

◆ xaccSplitRetDateReconciledTS()

Timespec xaccSplitRetDateReconciledTS ( const Split *  split)

Returns the date (as Timespec) on which this split was reconciled.

Definition at line 1826 of file Split.c.

1827 {
1828  Timespec ts = {0, 0};
1829  return split ? split->date_reconciled : ts;
1830 }

◆ 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 1735 of file Split.c.

1736 {
1737  if (!split || !actn) return;
1738  xaccTransBeginEdit (split->parent);
1739 
1740  CACHE_REPLACE(split->action, actn);
1741  qof_instance_set_dirty(QOF_INSTANCE(split));
1742  xaccTransCommitEdit(split->parent);
1743 
1744 }
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443

◆ 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 1222 of file Split.c.

1223 {
1224  if (!s) return;
1225  g_return_if_fail(gnc_numeric_check(amt) == GNC_ERROR_OK);
1226  ENTER ("(split=%p) old amt=%" G_GINT64_FORMAT "/%" G_GINT64_FORMAT
1227  " new amt=%" G_GINT64_FORMAT "/%" G_GINT64_FORMAT, s,
1228  s->amount.num, s->amount.denom, amt.num, amt.denom);
1229 
1230  xaccTransBeginEdit (s->parent);
1231  if (s->acc)
1232  {
1233  s->amount = gnc_numeric_convert(amt, get_commodity_denom(s),
1235  g_assert (gnc_numeric_check (s->amount) == GNC_ERROR_OK);
1236  }
1237  else
1238  s->amount = amt;
1239 
1240  SET_GAINS_ADIRTY(s);
1241  mark_split (s);
1242  qof_instance_set_dirty(QOF_INSTANCE(s));
1243  xaccTransCommitEdit(s->parent);
1244  LEAVE("");
1245 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
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...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:166
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271
GNCNumericErrorCode gnc_numeric_check(gnc_numeric in)
Check for error signal in value.
No error.
Definition: gnc-numeric.h:224

◆ 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 1305 of file Split.c.

1307 {
1308  const gnc_commodity *currency;
1309  const gnc_commodity *commodity;
1310 
1311  if (!s) return;
1312  xaccTransBeginEdit (s->parent);
1313 
1314  if (!s->acc)
1315  {
1316  PERR ("split must have a parent account");
1317  return;
1318  }
1319 
1320  currency = xaccTransGetCurrency (s->parent);
1321  commodity = xaccAccountGetCommodity (s->acc);
1322 
1323  /* If the base_currency is the transaction's commodity ('currency'),
1324  * set the value. If it's the account commodity, set the
1325  * amount. If both, set both. */
1326  if (gnc_commodity_equiv(currency, base_currency))
1327  {
1328  if (gnc_commodity_equiv(commodity, base_currency))
1329  {
1330  s->amount = gnc_numeric_convert(value,
1331  get_commodity_denom(s),
1333  }
1334  s->value = gnc_numeric_convert(value,
1335  get_currency_denom(s),
1337  }
1338  else if (gnc_commodity_equiv(commodity, base_currency))
1339  {
1340  s->amount = gnc_numeric_convert(value, get_commodity_denom(s),
1342  }
1343  else
1344  {
1345  PERR ("inappropriate base currency %s "
1346  "given split currency=%s and commodity=%s\n",
1347  gnc_commodity_get_printname(base_currency),
1348  gnc_commodity_get_printname(currency),
1349  gnc_commodity_get_printname(commodity));
1350  return;
1351  }
1352 
1353  SET_GAINS_A_VDIRTY(s);
1354  mark_split (s);
1355  qof_instance_set_dirty(QOF_INSTANCE(s));
1356  xaccTransCommitEdit(s->parent);
1357 }
#define PERR(format, args...)
Log a serious error.
Definition: qoflog.h:237
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...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443
const char * gnc_commodity_get_printname(const gnc_commodity *cm)
Retrieve the &#39;print&#39; name for the specified commodity.
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:166
gnc_commodity * xaccAccountGetCommodity(const Account *acc)
Get the account&#39;s commodity.
Definition: Account.c:3155
gnc_commodity * xaccTransGetCurrency(const Transaction *trans)
Returns the valuation commodity of this transaction.
Definition: Transaction.c:1355
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 1794 of file Split.c.

1795 {
1796  if (!split) return;
1797  xaccTransBeginEdit (split->parent);
1798 
1799  split->date_reconciled.tv_sec = secs;
1800  split->date_reconciled.tv_nsec = 0;
1801  qof_instance_set_dirty(QOF_INSTANCE(split));
1802  xaccTransCommitEdit(split->parent);
1803 
1804 }
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443

◆ xaccSplitSetDateReconciledTS()

void xaccSplitSetDateReconciledTS ( Split *  split,
Timespec *  ts 
)

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

Caller still owns *ts!

Definition at line 1807 of file Split.c.

1808 {
1809  if (!split || !ts) return;
1810  xaccTransBeginEdit (split->parent);
1811 
1812  split->date_reconciled = *ts;
1813  qof_instance_set_dirty(QOF_INSTANCE(split));
1814  xaccTransCommitEdit(split->parent);
1815 
1816 }
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443

◆ 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 1716 of file Split.c.

1717 {
1718  if (!split || !memo) return;
1719  xaccTransBeginEdit (split->parent);
1720 
1721  CACHE_REPLACE(split->memo, memo);
1722  qof_instance_set_dirty(QOF_INSTANCE(split));
1723  xaccTransCommitEdit(split->parent);
1724 
1725 }
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443

◆ 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 1768 of file Split.c.

1769 {
1770  if (!split || split->reconciled == recn) return;
1771  xaccTransBeginEdit (split->parent);
1772 
1773  switch (recn)
1774  {
1775  case NREC:
1776  case CREC:
1777  case YREC:
1778  case FREC:
1779  case VREC:
1780  split->reconciled = recn;
1781  mark_split (split);
1782  qof_instance_set_dirty(QOF_INSTANCE(split));
1783  xaccAccountRecomputeBalance (split->acc);
1784  break;
1785  default:
1786  PERR("Bad reconciled flag");
1787  break;
1788  }
1789  xaccTransCommitEdit(split->parent);
1790 
1791 }
#define PERR(format, args...)
Log a serious error.
Definition: qoflog.h:237
#define VREC
split is void
Definition: Split.h:71
#define YREC
The Split has been reconciled.
Definition: Split.h:68
#define FREC
frozen into accounting period
Definition: Split.h:69
void xaccAccountRecomputeBalance(Account *acc)
The following recompute the partial balances (stored with the transaction) and the total balance...
Definition: Account.c:2073
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443
#define CREC
The Split has been cleared.
Definition: Split.h:67
#define NREC
not reconciled or cleared
Definition: Split.h:70

◆ 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 1188 of file Split.c.

1189 {
1190  if (!s) return;
1191  ENTER (" ");
1192  xaccTransBeginEdit (s->parent);
1193 
1194  s->value = gnc_numeric_mul(xaccSplitGetAmount(s),
1195  price, get_currency_denom(s),
1197 
1198  SET_GAINS_VDIRTY(s);
1199  mark_split (s);
1200  qof_instance_set_dirty(QOF_INSTANCE(s));
1201  xaccTransCommitEdit(s->parent);
1202  LEAVE ("");
1203 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
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...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:166
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account&#39;s commodity.
Definition: Split.c:1929

◆ 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 1160 of file Split.c.

1161 {
1162  if (!s) return;
1163  ENTER (" ");
1164  xaccTransBeginEdit (s->parent);
1165 
1166  s->amount = gnc_numeric_convert(amt, get_commodity_denom(s),
1168  s->value = gnc_numeric_mul(s->amount, price,
1169  get_currency_denom(s), GNC_HOW_RND_ROUND_HALF_UP);
1170 
1171  SET_GAINS_A_VDIRTY(s);
1172  mark_split (s);
1173  qof_instance_set_dirty(QOF_INSTANCE(s));
1174  xaccTransCommitEdit(s->parent);
1175  LEAVE ("");
1176 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
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...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:166
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271

◆ 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 1258 of file Split.c.

1259 {
1260  gnc_numeric new_val;
1261  if (!s) return;
1262 
1263  g_return_if_fail(gnc_numeric_check(amt) == GNC_ERROR_OK);
1264  ENTER ("(split=%p) old val=%" G_GINT64_FORMAT "/%" G_GINT64_FORMAT
1265  " new val=%" G_GINT64_FORMAT "/%" G_GINT64_FORMAT, s,
1266  s->value.num, s->value.denom, amt.num, amt.denom);
1267 
1268  xaccTransBeginEdit (s->parent);
1269  new_val = gnc_numeric_convert(amt, get_currency_denom(s),
1271  if (gnc_numeric_check(new_val) == GNC_ERROR_OK &&
1272  !(gnc_numeric_zero_p (new_val) && !gnc_numeric_zero_p (amt)))
1273  s->value = new_val;
1274  else PERR("numeric error %s in converting the split value's denominator with amount %s and denom %d", gnc_numeric_errorCode_to_string(gnc_numeric_check(new_val)), gnc_numeric_to_string(amt), get_currency_denom(s));
1275 
1276  SET_GAINS_VDIRTY(s);
1277  mark_split (s);
1278  qof_instance_set_dirty(QOF_INSTANCE(s));
1279  xaccTransCommitEdit(s->parent);
1280  LEAVE ("");
1281 }
gboolean gnc_numeric_zero_p(gnc_numeric a)
Returns 1 if the given gnc_numeric is 0 (zero), else returns 0.
gchar * gnc_numeric_to_string(gnc_numeric n)
Convert to string.
#define PERR(format, args...)
Log a serious error.
Definition: qoflog.h:237
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
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;...
const char * gnc_numeric_errorCode_to_string(GNCNumericErrorCode error_code)
Returns a string representation of the given GNCNumericErrorCode.
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:166
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271
GNCNumericErrorCode gnc_numeric_check(gnc_numeric in)
Check for error signal in value.
No error.
Definition: gnc-numeric.h:224

◆ 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 2145 of file Split.c.

2146 {
2147  GValue v = G_VALUE_INIT;
2148  gnc_numeric *num = NULL;
2149  g_return_val_if_fail(split, gnc_numeric_zero());
2150  qof_instance_get_kvp (QOF_INSTANCE (split), void_former_amt_str, &v);
2151  if (G_VALUE_HOLDS_BOXED (&v))
2152  num = (gnc_numeric*)g_value_get_boxed (&v);
2153  return num ? *num : gnc_numeric_zero();
2154 }
void qof_instance_get_kvp(const QofInstance *inst, const gchar *key, GValue *value)
Retrieves the contents of a KVP slot into a provided GValue.

◆ xaccSplitVoidFormerValue()

gnc_numeric xaccSplitVoidFormerValue ( const Split *  split)

Returns the original pre-void value of a split.

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

Definition at line 2157 of file Split.c.

2158 {
2159  GValue v = G_VALUE_INIT;
2160  gnc_numeric *num = NULL;
2161  g_return_val_if_fail(split, gnc_numeric_zero());
2162  qof_instance_get_kvp (QOF_INSTANCE (split), void_former_val_str, &v);
2163  if (G_VALUE_HOLDS_BOXED (&v))
2164  num = (gnc_numeric*)g_value_get_boxed (&v);
2165  return num ? *num : gnc_numeric_zero();
2166 }
void qof_instance_get_kvp(const QofInstance *inst, const gchar *key, GValue *value)
Retrieves the contents of a KVP slot into a provided GValue.

◆ xaccTransBeginEdit()

void xaccTransBeginEdit ( Transaction *  trans)

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

If this is not done, errors will result.

Definition at line 1443 of file Transaction.c.

1444 {
1445  if (!trans) return;
1446  if (!qof_begin_edit(&trans->inst)) return;
1447 
1448  if (qof_book_shutting_down(qof_instance_get_book(trans))) return;
1449 
1451  {
1452  xaccOpenLog ();
1453  xaccTransWriteLog (trans, 'B');
1454  }
1455 
1456  /* Make a clone of the transaction; we will use this
1457  * in case we need to roll-back the edit. */
1458  trans->orig = dupe_trans (trans);
1459 }
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.
void xaccTransWriteLog(Transaction *trans, char flag)
Definition: TransLog.c:221
gboolean qof_begin_edit(QofInstance *inst)
begin_edit
gboolean qof_book_is_readonly(const QofBook *book)
Return whether the book is read only.
Definition: qofbook.cpp:584
gboolean qof_book_shutting_down(const QofBook *book)
Is the book shutting down?
Definition: qofbook.cpp:535

◆ 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 1642 of file Transaction.c.

1643 {
1644  if (!trans) return;
1645  ENTER ("(trans=%p)", trans);
1646 
1647  if (!qof_commit_edit (QOF_INSTANCE(trans)))
1648  {
1649  LEAVE("editlevel non-zero");
1650  return;
1651  }
1652 
1653  /* We increment this for the duration of the call
1654  * so other functions don't result in a recursive
1655  * call to xaccTransCommitEdit. */
1656  qof_instance_increase_editlevel(trans);
1657 
1658  if (was_trans_emptied(trans))
1659  qof_instance_set_destroying(trans, TRUE);
1660 
1661  /* Before committing the transaction, we are going to enforce certain
1662  * constraints. In particular, we want to enforce the cap-gains
1663  * and the balanced lot constraints. These constraints might
1664  * change the number of splits in this transaction, and the
1665  * transaction itself might be deleted. This is also why
1666  * we can't really enforce these constraints elsewhere: they
1667  * can cause pointers to splits and transactions to disappear out
1668  * from under the holder.
1669  */
1670  if (!qof_instance_get_destroying(trans) && scrub_data &&
1672  {
1673  /* If scrubbing gains recurses through here, don't call it again. */
1674  scrub_data = 0;
1675  /* The total value of the transaction should sum to zero.
1676  * Call the trans scrub routine to fix it. Indirectly, this
1677  * routine also performs a number of other transaction fixes too.
1678  */
1679  xaccTransScrubImbalance (trans, NULL, NULL);
1680  /* Get the cap gains into a consistent state as well. */
1681 
1682  /* Lot Scrubbing is temporarily disabled. */
1683  if (g_getenv("GNC_AUTO_SCRUB_LOTS") != NULL)
1684  xaccTransScrubGains (trans, NULL);
1685 
1686  /* Allow scrubbing in transaction commit again */
1687  scrub_data = 1;
1688  }
1689 
1690  /* Record the time of last modification */
1691  if (0 == trans->date_entered.tv_sec)
1692  {
1693  trans->date_entered.tv_sec = gnc_time(NULL);
1694  qof_instance_set_dirty(QOF_INSTANCE(trans));
1695  }
1696 
1697  qof_commit_edit_part2(QOF_INSTANCE(trans),
1698  (void (*) (QofInstance *, QofBackendError))
1699  trans_on_error,
1700  (void (*) (QofInstance *)) trans_cleanup_commit,
1701  (void (*) (QofInstance *)) do_destroy);
1702  LEAVE ("(trans=%p)", trans);
1703 }
QofBackendError
The errors that can be reported to the GUI & other front-end users.
Definition: qofbackend.h:59
gboolean qof_instance_get_destroying(gconstpointer ptr)
Retrieve the flag that indicates whether or not this object is about to be destroyed.
gboolean qof_commit_edit(QofInstance *inst)
commit_edit helpers
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
void xaccTransScrubImbalance(Transaction *trans, Account *root, Account *account)
Correct transaction imbalances.
Definition: Scrub.c:803
void xaccTransScrubGains(Transaction *trans, Account *gain_acc)
The xaccTransScrubGains() routine performs a number of cleanup functions on the indicated transaction...
Definition: Transaction.c:2823
gboolean qof_commit_edit_part2(QofInstance *inst, void(*on_error)(QofInstance *, QofBackendError), void(*on_done)(QofInstance *), void(*on_free)(QofInstance *))
part2 – deal with the backend
#define xaccTransGetBook(X)
Definition: Transaction.h:768
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271
time64 gnc_time(time64 *tbuf)
get the current local time
Definition: gnc-date.cpp:250
gboolean qof_book_shutting_down(const QofBook *book)
Is the book shutting down?
Definition: qofbook.cpp:535

◆ xaccTransCopyFromClipBoard()

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

This function explicitly must robustly handle some unusual input.

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

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

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

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

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

Definition at line 746 of file Transaction.c.

748 {
749  Timespec ts = {0,0};
750  gboolean change_accounts = FALSE;
751  GList *node;
752 
753  if (!from_trans || !to_trans)
754  return;
755 
756  change_accounts = from_acc && GNC_IS_ACCOUNT(to_acc) && from_acc != to_acc;
757  xaccTransBeginEdit(to_trans);
758 
759  FOR_EACH_SPLIT(to_trans, xaccSplitDestroy(s));
760  g_list_free(to_trans->splits);
761  to_trans->splits = NULL;
762 
763  xaccTransSetCurrency(to_trans, xaccTransGetCurrency(from_trans));
764  xaccTransSetDescription(to_trans, xaccTransGetDescription(from_trans));
765 
766  if ((xaccTransGetNum(to_trans) == NULL) || (g_strcmp0 (xaccTransGetNum(to_trans), "") == 0))
767  xaccTransSetNum(to_trans, xaccTransGetNum(from_trans));
768 
769  xaccTransSetNotes(to_trans, xaccTransGetNotes(from_trans));
770  if(!no_date)
771  {
772  xaccTransGetDatePostedTS(from_trans, &ts);
773  xaccTransSetDatePostedTS(to_trans, &ts);
774  }
775 
776  /* Each new split will be parented to 'to' */
777  for (node = from_trans->splits; node; node = node->next)
778  {
779  Split *new_split = xaccMallocSplit( qof_instance_get_book(QOF_INSTANCE(from_trans)));
780  xaccSplitCopyOnto(node->data, new_split);
781  if (change_accounts && xaccSplitGetAccount(node->data) == from_acc)
782  xaccSplitSetAccount(new_split, to_acc);
783  xaccSplitSetParent(new_split, to_trans);
784  }
785  xaccTransCommitEdit(to_trans);
786 }
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.
gboolean xaccSplitDestroy(Split *split)
Destructor.
Definition: Split.c:1456
void xaccTransSetNotes(Transaction *trans, const char *notes)
Sets the transaction Notes.
Definition: Transaction.c:2181
void xaccSplitCopyOnto(const Split *from_split, Split *to_split)
This is really a helper for xaccTransCopyOnto.
Definition: Split.c:650
void xaccTransSetDescription(Transaction *trans, const char *desc)
Sets the transaction Description.
Definition: Transaction.c:2149
void xaccTransSetNum(Transaction *trans, const char *xnum)
Sets the transaction Number (or ID) field; rather than use this function directly, see &#39;gnc_set_num_action&#39; in engine/engine-helpers.c & .h which takes a user-set book option for selecting the source for the num-cell (the transaction-number or the split-action field) in registers/reports into account automatically.
Definition: Transaction.c:2129
const char * xaccTransGetNum(const Transaction *trans)
Gets the transaction Number (or ID) field; rather than use this function directly, see &#39;gnc_get_num_action&#39; and &#39;gnc_get_action_num&#39; in engine/engine-helpers.c & .h which takes a user-set book option for selecting the source for the num-cell (the transaction-number or the split-action field) in registers/reports into account automatically.
Definition: Transaction.c:2274
void xaccTransSetCurrency(Transaction *trans, gnc_commodity *curr)
Set a new currency on a transaction.
Definition: Transaction.c:1414
const char * xaccTransGetNotes(const Transaction *trans)
Gets the transaction Notes.
Definition: Transaction.c:2297
const char * xaccTransGetDescription(const Transaction *trans)
Gets the transaction Description.
Definition: Transaction.c:2280
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443
Split * xaccMallocSplit(QofBook *book)
Constructor.
Definition: Split.c:546
Account * xaccSplitGetAccount(const Split *s)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: Split.c:929
gnc_commodity * xaccTransGetCurrency(const Transaction *trans)
Returns the valuation commodity of this transaction.
Definition: Transaction.c:1355
void xaccTransGetDatePostedTS(const Transaction *trans, Timespec *ts)
Retrieve the posted date of the transaction.
Definition: Transaction.c:2336
void xaccTransSetDatePostedTS(Transaction *trans, const Timespec *ts)
The xaccTransSetDatePostedTS() method does the same thing as xaccTransSetDatePostedSecs(), but takes a struct timespec64.
Definition: Transaction.c:2020

◆ xaccTransCopyToClipBoard()

Transaction* xaccTransCopyToClipBoard ( const Transaction *  from_trans)

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

The 'clipboard' transaction must never be dereferenced.

Definition at line 706 of file Transaction.c.

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

◆ xaccTransCountSplits()

int xaccTransCountSplits ( const Transaction *  trans)

Returns the number of splits in this transaction.

Definition at line 2266 of file Transaction.c.

2267 {
2268  gint i = 0;
2269  FOR_EACH_SPLIT(trans, i++);
2270  return i;
2271 }

◆ 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 1465 of file Transaction.c.

1466 {
1467  if (!trans) return;
1468 
1469  if (!xaccTransGetReadOnly (trans) ||
1471  {
1472  xaccTransBeginEdit(trans);
1473  qof_instance_set_destroying(trans, TRUE);
1474  xaccTransCommitEdit(trans);
1475  }
1476 }
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443
const char * xaccTransGetReadOnly(const Transaction *trans)
Returns a non-NULL value if this Transaction was marked as read-only with some specific "reason" text...
Definition: Transaction.c:2421
gboolean qof_book_shutting_down(const QofBook *book)
Is the book shutting down?
Definition: qofbook.cpp:535

◆ 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 transation 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 863 of file Transaction.c.

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

◆ xaccTransGetAccountAmount()

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

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

Definition at line 1193 of file Transaction.c.

1194 {
1195  gnc_numeric total = gnc_numeric_zero ();
1196  if (!trans || !acc) return total;
1197 
1198  total = gnc_numeric_convert (total, xaccAccountGetCommoditySCU (acc),
1200  FOR_EACH_SPLIT(trans, if (acc == xaccSplitGetAccount(s))
1201  total = gnc_numeric_add_fixed(
1202  total, xaccSplitGetAmount(s)));
1203  return total;
1204 }
int xaccAccountGetCommoditySCU(const Account *acc)
Return the SCU for the account.
Definition: Account.c:2456
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;...
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:166
Account * xaccSplitGetAccount(const Split *s)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: Split.c:929
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account&#39;s commodity.
Definition: Split.c:1929

◆ 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 1317 of file Transaction.c.

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

◆ 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 convienience to view everything at once.

Definition at line 1177 of file Transaction.c.

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

◆ 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 1355 of file Transaction.c.

1356 {
1357  return trans ? trans->common_currency : NULL;
1358 }

◆ 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 2322 of file Transaction.c.

2323 {
2324  return trans ? trans->date_posted.tv_sec : 0;
2325 }

◆ 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 2329 of file Transaction.c.

2330 {
2331  return trans ? trans->date_entered.tv_sec : 0;
2332 }

◆ xaccTransGetDateEnteredTS()

void xaccTransGetDateEnteredTS ( const Transaction *  trans,
Timespec *  ts 
)

Retrieve the date of when the transaction was entered.

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

Definition at line 2343 of file Transaction.c.

2344 {
2345  if (trans && ts)
2346  *ts = trans->date_entered;
2347 }

◆ 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 2357 of file Transaction.c.

2358 {
2359  GDate result;
2360  g_date_clear (&result, 1);
2361  if (trans)
2362  {
2363  /* Can we look up this value in the kvp slot? If yes, use it
2364  * from there because it doesn't suffer from time zone
2365  * shifts. */
2366  GValue v = G_VALUE_INIT;
2367  qof_instance_get_kvp (QOF_INSTANCE (trans), TRANS_DATE_POSTED, &v);
2368  if (G_VALUE_HOLDS_BOXED (&v))
2369  result = *(GDate*)g_value_get_boxed (&v);
2370  if (! g_date_valid (&result))
2372  }
2373  return result;
2374 }
void qof_instance_get_kvp(const QofInstance *inst, const gchar *key, GValue *value)
Retrieves the contents of a KVP slot into a provided GValue.
GDate timespec_to_gdate(Timespec ts)
Turns a Timespec into a GDate.
Definition: gnc-date.cpp:1336
Timespec xaccTransRetDatePostedTS(const Transaction *trans)
Retrieve the posted date of the transaction.
Definition: Transaction.c:2350

◆ xaccTransGetDatePostedTS()

void xaccTransGetDatePostedTS ( const Transaction *  trans,
Timespec *  ts 
)

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 2336 of file Transaction.c.

2337 {
2338  if (trans && ts)
2339  *ts = trans->date_posted;
2340 }

◆ xaccTransGetFirstAPARAcctSplit()

Split* xaccTransGetFirstAPARAcctSplit ( const Transaction *  trans)

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

Parameters
transThe transaction

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

Definition at line 2254 of file Transaction.c.

2255 {
2256  FOR_EACH_SPLIT (trans,
2257  const Account *account = xaccSplitGetAccount(s);
2259  return s;
2260  );
2261 
2262  return NULL;
2263 }
GNCAccountType xaccAccountGetType(const Account *acc)
Returns the account&#39;s account type.
Definition: Account.c:3010
STRUCTS.
gboolean xaccAccountIsAPARType(GNCAccountType t)
Convenience function to check if the account is a valid business account type (meaning an Accounts Pa...
Definition: Account.c:4268
Account * xaccSplitGetAccount(const Split *s)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: Split.c:929

◆ 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 2243 of file Transaction.c.

2244 {
2245  FOR_EACH_SPLIT (trans,
2246  const Account *account = xaccSplitGetAccount(s);
2248  return s;
2249  );
2250 
2251  return NULL;
2252 }
GNCAccountType xaccAccountGetType(const Account *acc)
Returns the account&#39;s account type.
Definition: Account.c:3010
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 *s)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: Split.c:929

◆ 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 1059 of file Transaction.c.

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

◆ 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 1043 of file Transaction.c.

1044 {
1045  gnc_numeric imbal = gnc_numeric_zero();
1046  if (!trans) return imbal;
1047 
1048  ENTER("(trans=%p)", trans);
1049  /* Could use xaccSplitsComputeValue, except that we want to use
1050  GNC_HOW_DENOM_EXACT */
1051  FOR_EACH_SPLIT(trans, imbal =
1054  LEAVE("(trans=%p) imbal=%s", trans, gnc_num_dbg_to_string(imbal));
1055  return imbal;
1056 }
gchar * gnc_num_dbg_to_string(gnc_numeric n)
Convert to string.
gnc_numeric gnc_numeric_add(gnc_numeric a, gnc_numeric b, gint64 denom, gint how)
Return a+b.
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
Use any denominator which gives an exactly correct ratio of numerator to denominator.
Definition: gnc-numeric.h:189
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction&#39;s commodity.
Definition: Split.c:1935
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271
#define GNC_DENOM_AUTO
Values that can be passed as the &#39;denom&#39; argument.
Definition: gnc-numeric.h:246

◆ 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 2297 of file Transaction.c.

2298 {
2299  GValue v = G_VALUE_INIT;
2300  if (!trans) return NULL;
2301  qof_instance_get_kvp (QOF_INSTANCE (trans), trans_notes_str, &v);
2302  if (G_VALUE_HOLDS_STRING (&v))
2303  return g_value_get_string (&v);
2304  return NULL;
2305 }
void qof_instance_get_kvp(const QofInstance *inst, const gchar *key, GValue *value)
Retrieves the contents of a KVP slot into a provided GValue.

◆ xaccTransGetReadOnly()

const char* xaccTransGetReadOnly ( const Transaction *  trans)

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

Definition at line 2421 of file Transaction.c.

2422 {
2423  /* XXX This flag should be cached in the transaction structure
2424  * for performance reasons, since its checked every trans commit.
2425  */
2426  GValue v = G_VALUE_INIT;
2427  const char *s = NULL;
2428  if (trans == NULL) return NULL;
2429  qof_instance_get_kvp (QOF_INSTANCE(trans), TRANS_READ_ONLY_REASON, &v);
2430  if (G_VALUE_HOLDS_STRING (&v))
2431  s = g_value_get_string (&v);
2432  if (s && strlen (s))
2433  return s;
2434 
2435  return NULL;
2436 }
void qof_instance_get_kvp(const QofInstance *inst, const gchar *key, GValue *value)
Retrieves the contents of a KVP slot into a provided GValue.

◆ xaccTransGetReversedBy()

Transaction* xaccTransGetReversedBy ( const Transaction *  trans)

Returns the transaction that reversed the given transaction.

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

Definition at line 2749 of file Transaction.c.

2750 {
2751  GValue v = G_VALUE_INIT;
2752  g_return_val_if_fail(trans, NULL);
2753  qof_instance_get_kvp (QOF_INSTANCE(trans), TRANS_REVERSED_BY, &v);
2754  if (G_VALUE_HOLDS_BOXED (&v))
2755  return xaccTransLookup((GncGUID*)g_value_get_boxed (&v),
2756  qof_instance_get_book(trans));
2757  return NULL;
2758 }
void qof_instance_get_kvp(const QofInstance *inst, const gchar *key, GValue *value)
Retrieves the contents of a KVP slot into a provided GValue.
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...
Definition: Transaction.c:1031
The type used to store guids in C.
Definition: guid.h:75

◆ xaccTransGetSplit()

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

The xaccTransGetSplit() method returns a pointer to each of the splits in this transaction.

Parameters
transThe transaction
iThe split number. Valid values for i are zero to (number_of__splits-1). An invalid value of i will cause NULL to be returned. A convenient way of cycling through all splits is to start at zero, and keep incrementing until a null value is returned.

Definition at line 2218 of file Transaction.c.

2219 {
2220  int j = 0;
2221  if (!trans || i < 0) return NULL;
2222 
2223  FOR_EACH_SPLIT(trans, { if (i == j) return s; j++; });
2224  return NULL;
2225 }

◆ xaccTransGetSplitList()

SplitList* xaccTransGetSplitList ( const Transaction *  trans)

The xaccTransGetSplitList() method returns a GList of the splits in a 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 2238 of file Transaction.c.

2239 {
2240  return trans ? trans->splits : NULL;
2241 }

◆ xaccTransGetTxnType()

char xaccTransGetTxnType ( const Transaction *  trans)

Returns the Transaction Type.

See TXN_TYPE_NONE, TXN_TYPE_INVOICE and TXN_TYPE_PAYMENT

Definition at line 2405 of file Transaction.c.

2406 {
2407  const char *s = NULL;
2408  GValue v = G_VALUE_INIT;
2409 
2410  if (!trans) return TXN_TYPE_NONE;
2411  qof_instance_get_kvp (QOF_INSTANCE (trans), TRANS_TXN_TYPE_KVP, &v);
2412  if (G_VALUE_HOLDS_STRING (&v))
2413  s = g_value_get_string (&v);
2414  if (s && strlen (s) == 1)
2415  return *s;
2416 
2417  return TXN_TYPE_NONE;
2418 }
void qof_instance_get_kvp(const QofInstance *inst, const gchar *key, GValue *value)
Retrieves the contents of a KVP slot into a provided GValue.
#define TXN_TYPE_NONE
No transaction type.
Definition: Transaction.h:119

◆ 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 2663 of file Transaction.c.

2664 {
2665  GValue v = G_VALUE_INIT;
2666  g_return_val_if_fail(trans, FALSE);
2667 
2668  qof_instance_get_kvp (QOF_INSTANCE (trans), void_reason_str, &v);
2669  if (G_VALUE_HOLDS_STRING (&v))
2670  return g_value_get_string (&v);
2671  return NULL;
2672 }
void qof_instance_get_kvp(const QofInstance *inst, const gchar *key, GValue *value)
Retrieves the contents of a KVP slot into a provided GValue.

◆ xaccTransGetVoidStatus()

gboolean xaccTransGetVoidStatus ( const Transaction *  transaction)

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

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

Definition at line 2650 of file Transaction.c.

2651 {
2652  const char *s = NULL;
2653  GValue v = G_VALUE_INIT;
2654  g_return_val_if_fail(trans, FALSE);
2655 
2656  qof_instance_get_kvp (QOF_INSTANCE (trans), void_reason_str, &v);
2657  if (G_VALUE_HOLDS_STRING (&v))
2658  s = g_value_get_string (&v);
2659  return s && strlen(s);
2660 }
void qof_instance_get_kvp(const QofInstance *inst, const gchar *key, GValue *value)
Retrieves the contents of a KVP slot into a provided GValue.

◆ xaccTransGetVoidTime()

Timespec xaccTransGetVoidTime ( const Transaction *  tr)

Returns the time that a transaction was voided.

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

Definition at line 2675 of file Transaction.c.

2676 {
2677  GValue v = G_VALUE_INIT;
2678  const char *s = NULL;
2679  Timespec void_time = {0, 0}, *ts;
2680 
2681  g_return_val_if_fail(tr, void_time);
2682  qof_instance_get_kvp (QOF_INSTANCE (tr), void_time_str, &v);
2683  if (G_VALUE_HOLDS_STRING (&v))
2684  s = g_value_get_string (&v);
2685  if (s)
2686  return gnc_iso8601_to_timespec_gmt (s);
2687  return void_time;
2688 }
void qof_instance_get_kvp(const QofInstance *inst, const gchar *key, GValue *value)
Retrieves the contents of a KVP slot into a provided GValue.
Timespec gnc_iso8601_to_timespec_gmt(const gchar *)
The gnc_iso8601_to_timespec_gmt() routine converts an ISO-8601 style date/time string to Timespec...

◆ xaccTransIsBalanced()

gboolean xaccTransIsBalanced ( const Transaction *  trans)

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

Definition at line 1131 of file Transaction.c.

1132 {
1133  MonetaryList *imbal_list;
1134  gboolean result;
1135  gnc_numeric imbal = gnc_numeric_zero();
1136  gnc_numeric imbal_trading = gnc_numeric_zero();
1137 
1138  if (trans == NULL) return FALSE;
1139 
1140  if (xaccTransUseTradingAccounts(trans))
1141  {
1142  /* Transaction is imbalanced if the value is imbalanced in either
1143  trading or non-trading splits. One can't be used to balance
1144  the other. */
1145  FOR_EACH_SPLIT(trans,
1146  {
1147  Account *acc = xaccSplitGetAccount(s);
1148  if (!acc || xaccAccountGetType(acc) != ACCT_TYPE_TRADING)
1149  {
1150  imbal = gnc_numeric_add(imbal, xaccSplitGetValue(s),
1152  }
1153  else
1154  {
1155  imbal_trading = gnc_numeric_add(imbal_trading, xaccSplitGetValue(s),
1157  }
1158  }
1159  );
1160  }
1161  else
1162  imbal = xaccTransGetImbalanceValue(trans);
1163 
1164  if (! gnc_numeric_zero_p(imbal) || ! gnc_numeric_zero_p(imbal_trading))
1165  return FALSE;
1166 
1167  if (!xaccTransUseTradingAccounts (trans))
1168  return TRUE;
1169 
1170  imbal_list = xaccTransGetImbalance(trans);
1171  result = imbal_list == NULL;
1172  gnc_monetary_list_free(imbal_list);
1173  return result;
1174 }
gboolean xaccTransUseTradingAccounts(const Transaction *trans)
Determine whether this transaction should use commodity trading accounts.
Definition: Transaction.c:1022
GNCAccountType xaccAccountGetType(const Account *acc)
Returns the account&#39;s account type.
Definition: Account.c:3010
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:189
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.
Definition: Transaction.c:1043
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: Split.c:1935
Account * xaccSplitGetAccount(const Split *s)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: Split.c:929
MonetaryList * xaccTransGetImbalance(const Transaction *trans)
The xaccTransGetImbalance method returns a list giving the value of the transaction in each currency ...
Definition: Transaction.c:1059
#define GNC_DENOM_AUTO
Values that can be passed as the &#39;denom&#39; argument.
Definition: gnc-numeric.h:246

◆ xaccTransIsOpen()

gboolean xaccTransIsOpen ( const Transaction *  trans)

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

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

Definition at line 1874 of file Transaction.c.

1875 {
1876  return trans ? (0 < qof_instance_get_editlevel(trans)) : FALSE;
1877 }

◆ 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 2461 of file Transaction.c.

2462 {
2463  GDate *threshold_date;
2464  GDate trans_date;
2465  const QofBook *book = xaccTransGetBook (trans);
2466  gboolean result;
2467  g_assert(trans);
2468 
2469  if (!qof_book_uses_autoreadonly(book))
2470  {
2471  return FALSE;
2472  }
2473 
2474  if (xaccTransIsSXTemplate (trans))
2475  return FALSE;
2476 
2477  threshold_date = qof_book_get_autoreadonly_gdate(book);
2478  g_assert(threshold_date); // ok because we checked uses_autoreadonly before
2479  trans_date = xaccTransGetDatePostedGDate(trans);
2480 
2481 // g_warning("there is auto-read-only with days=%d, trans_date_day=%d, threshold_date_day=%d",
2482 // qof_book_get_num_days_autofreeze(book),
2483 // g_date_get_day(&trans_date),
2484 // g_date_get_day(threshold_date));
2485 
2486  if (g_date_compare(&trans_date, threshold_date) < 0)
2487  {
2488  //g_warning("we are auto-read-only");
2489  result = TRUE;
2490  }
2491  else
2492  {
2493  result = FALSE;
2494  }
2495  g_date_free(threshold_date);
2496  return result;
2497 }
GDate * qof_book_get_autoreadonly_gdate(const QofBook *book)
Returns the GDate that is the threshold for auto-read-only.
Definition: qofbook.cpp:1070
#define xaccTransGetBook(X)
Definition: Transaction.h:768
gboolean qof_book_uses_autoreadonly(const QofBook *book)
Returns TRUE if the auto-read-only feature should be used, otherwise FALSE.
Definition: qofbook.cpp:1054
GDate xaccTransGetDatePostedGDate(const Transaction *trans)
Retrieve the posted date of the transaction.
Definition: Transaction.c:2357

◆ 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 1031 of file Transaction.c.

1032 {
1033  QofCollection *col;
1034  if (!guid || !book) return NULL;
1035  col = qof_book_get_collection (book, GNC_ID_TRANS);
1036  return (Transaction *) qof_collection_lookup_entity (col, guid);
1037 }
QofInstance * qof_collection_lookup_entity(const QofCollection *col, const GncGUID *guid)
Find the entity going only from its guid.
Definition: qofid.cpp:214
QofCollection * qof_book_get_collection(const QofBook *book, QofIdType entity_type)
Return The table of entities of the given type.
Definition: qofbook.cpp:599

◆ xaccTransOrder()

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

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

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

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

Definition at line 1882 of file Transaction.c.

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

◆ 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 1888 of file Transaction.c.

1890 {
1891  char *da, *db;
1892  int na, nb, retval;
1893 
1894  if ( ta && !tb ) return -1;
1895  if ( !ta && tb ) return +1;
1896  if ( !ta && !tb ) return 0;
1897 
1898  /* if dates differ, return */
1899  DATE_CMP(ta, tb, date_posted);
1900 
1901  /* otherwise, sort on number string */
1902  if (actna && actnb) /* split action string, if not NULL */
1903  {
1904  na = atoi(actna);
1905  nb = atoi(actnb);
1906  }
1907  else /* else transaction num string */
1908  {
1909  na = atoi(ta->num);
1910  nb = atoi(tb->num);
1911  }
1912  if (na < nb) return -1;
1913  if (na > nb) return +1;
1914 
1915  /* if dates differ, return */
1916  DATE_CMP(ta, tb, date_entered);
1917 
1918  /* otherwise, sort on description string */
1919  da = ta->description ? ta->description : "";
1920  db = tb->description ? tb->description : "";
1921  retval = g_utf8_collate (da, db);
1922  if (retval)
1923  return retval;
1924 
1925  /* else, sort on guid - keeps sort stable. */
1926  return qof_instance_guid_compare(ta, tb);
1927 }
gint qof_instance_guid_compare(gconstpointer ptr1, gconstpointer ptr2)
Compare the GncGUID values of two instances.

◆ xaccTransRetDateEnteredTS()

Timespec xaccTransRetDateEnteredTS ( 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 2377 of file Transaction.c.

2378 {
2379  Timespec ts = {0, 0};
2380  return trans ? trans->date_entered : ts;
2381 }

◆ xaccTransRetDatePostedTS()

Timespec xaccTransRetDatePostedTS ( 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 2350 of file Transaction.c.

2351 {
2352  Timespec ts = {0, 0};
2353  return trans ? trans->date_posted : ts;
2354 }

◆ xaccTransReverse()

Transaction* xaccTransReverse ( Transaction *  transaction)

xaccTransReverse creates a Transaction that reverses the given tranaction 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 2718 of file Transaction.c.

2719 {
2720  Transaction *trans;
2721  GValue v = G_VALUE_INIT;
2722  g_return_val_if_fail(orig, NULL);
2723 
2724  trans = xaccTransClone(orig);
2725  xaccTransBeginEdit(trans);
2726 
2727  /* Reverse the values on each split. Clear per-split info. */
2728  FOR_EACH_SPLIT(trans,
2729  {
2733  });
2734 
2735  /* Now update the original with a pointer to the new one */
2736  g_value_init (&v, GNC_TYPE_GUID);
2737  g_value_set_boxed (&v, xaccTransGetGUID(trans));
2738  qof_instance_set_kvp (QOF_INSTANCE (orig), TRANS_REVERSED_BY, &v);
2739 
2740  /* Make sure the reverse transaction is not read-only */
2741  xaccTransClearReadOnly(trans);
2742 
2743  qof_instance_set_dirty(QOF_INSTANCE(trans));
2744  xaccTransCommitEdit(trans);
2745  return trans;
2746 }
void xaccSplitSetValue(Split *s, gnc_numeric amt)
The xaccSplitSetValue() method sets the value of this split in the transaction&#39;s commodity.
Definition: Split.c:1258
gnc_numeric gnc_numeric_neg(gnc_numeric a)
Returns a newly created gnc_numeric that is the negative of the given gnc_numeric value...
void xaccSplitSetReconcile(Split *split, char recn)
Set the reconcile flag.
Definition: Split.c:1768
void xaccSplitSetAmount(Split *s, gnc_numeric amt)
The xaccSplitSetAmount() method sets the amount in the account&#39;s commodity that the split should have...
Definition: Split.c:1222
Transaction * xaccTransClone(const Transaction *from)
The xaccTransClone() method will create a complete copy of an existing transaction.
Definition: Transaction.c:683
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443
#define xaccTransGetGUID(X)
Definition: Transaction.h:770
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction&#39;s commodity.
Definition: Split.c:1935
void qof_instance_set_kvp(QofInstance *inst, const gchar *key, const GValue *value)
Sets a KVP slot to a value from a GValue.
#define NREC
not reconciled or cleared
Definition: Split.h:70
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account&#39;s commodity.
Definition: Split.c:1929

◆ 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 1716 of file Transaction.c.

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

◆ 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 2823 of file Transaction.c.

2824 {
2825  SplitList *node;
2826 
2827  ENTER("(trans=%p)", trans);
2828  /* Lock down posted date, its to be synced to the posted date
2829  * for the source of the cap gains. */
2830  xaccTransScrubGainsDate(trans);
2831 
2832  /* Fix up the split amount */
2833 restart:
2834  for (node = trans->splits; node; node = node->next)
2835  {
2836  Split *s = node->data;
2837 
2838  if (!xaccTransStillHasSplit(trans, s)) continue;
2839 
2840  xaccSplitDetermineGainStatus(s);
2841  if (s->gains & GAINS_STATUS_ADIRTY)
2842  {
2843  gboolean altered = FALSE;
2844  s->gains &= ~GAINS_STATUS_ADIRTY;
2845  if (s->lot)
2846  altered = xaccScrubLot(s->lot);
2847  else
2848  altered = xaccSplitAssign(s);
2849  if (altered) goto restart;
2850  }
2851  }
2852 
2853  /* Fix up gains split value */
2854  FOR_EACH_SPLIT(trans,
2855  if ((s->gains & GAINS_STATUS_VDIRTY) ||
2856  (s->gains_split &&
2857  (s->gains_split->gains & GAINS_STATUS_VDIRTY)))
2858  xaccSplitComputeCapGains(s, gain_acc);
2859  );
2860 
2861  LEAVE("(trans=%p)", trans);
2862 }
void xaccSplitComputeCapGains(Split *split, Account *gain_acc)
The xaccSplitComputeCapGains() routine computes the cap gains or losses for the indicated split...
Definition: cap-gains.c:528
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
GList SplitList
GList of Split.
Definition: gnc-engine.h:203
gboolean xaccSplitAssign(Split *split)
The`xaccSplitAssign() routine will take the indicated split and, if it doesn&#39;t already belong to a lo...
Definition: cap-gains.c:430
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271
gboolean xaccScrubLot(GNCLot *lot)
The xaccScrubLot() routine makes sure that the indicated lot is self-consistent and properly balanced...
Definition: Scrub3.c:85

◆ xaccTransSetCurrency()

void xaccTransSetCurrency ( Transaction *  trans,
gnc_commodity *  curr 
)

Set the commodity of this transaction.

Set the commodity of this transaction.

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

Parameters
transThe transaction to change
currThe new currency to set.

Definition at line 1414 of file Transaction.c.

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

◆ 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 2045 of file Transaction.c.

2046 {
2047  GDate *date;
2048  if (!trans) return;
2049  date = g_date_new_dmy(day, mon, year);
2050  if (!g_date_valid(date))
2051  {
2052  PWARN("Attempted to set invalid date %d-%d-%d; set today's date instead.",
2053  year, mon, day);
2054  g_free(date);
2055  date = gnc_g_date_new_today();
2056  }
2057  xaccTransSetDatePostedGDate(trans, *date);
2058  g_free(date);
2059 }
void xaccTransSetDatePostedGDate(Transaction *trans, GDate date)
This method modifies posted date of the transaction, specified by a GDate.
Definition: Transaction.c:1983
#define PWARN(format, args...)
Log a warning.
Definition: qoflog.h:243
GDate * gnc_g_date_new_today()
Returns a newly allocated date of the current clock time, taken from time(2).
Definition: gnc-date.cpp:1349

◆ 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 2001 of file Transaction.c.

2002 {
2003  Timespec ts = {secs, 0};
2004  if (!trans) return;
2005  xaccTransSetDateInternal(trans, &trans->date_entered, ts);
2006 }

◆ xaccTransSetDateEnteredTS()

void xaccTransSetDateEnteredTS ( Transaction *  trans,
const Timespec *  ts 
)

Modify the date of when the transaction was entered.

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

Definition at line 2038 of file Transaction.c.

2039 {
2040  if (!trans || !ts) return;
2041  xaccTransSetDateInternal(trans, &trans->date_entered, *ts);
2042 }

◆ 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 1983 of file Transaction.c.

1984 {
1985  GValue v = G_VALUE_INIT;
1986  if (!trans) return;
1987 
1988  /* We additionally save this date into a kvp frame to ensure in
1989  * the future a date which was set as *date* (without time) can
1990  * clearly be distinguished from the Timespec. */
1991  g_value_init (&v, G_TYPE_DATE);
1992  g_value_set_boxed (&v, &date);
1993  qof_instance_set_kvp (QOF_INSTANCE(trans), TRANS_DATE_POSTED, &v);
1994  /* mark dirty and commit handled by SetDateInternal */
1995  xaccTransSetDateInternal(trans, &trans->date_posted,
1996  gdate_to_timespec(date));
1997  set_gains_date_dirty (trans);
1998 }
Timespec gdate_to_timespec(GDate d)
Turns a GDate into a Timespec, returning the first second of the day.
Definition: gnc-date.cpp:1359
void qof_instance_set_kvp(QofInstance *inst, const gchar *key, const GValue *value)
Sets a KVP slot to a value from a GValue.

◆ 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 1966 of file Transaction.c.

1967 {
1968  Timespec ts = {secs, 0};
1969  if (!trans) return;
1970  xaccTransSetDateInternal(trans, &trans->date_posted, ts);
1971  set_gains_date_dirty (trans);
1972 }

◆ 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 1975 of file Transaction.c.

1976 {
1977  GDate date;
1978  gnc_gdate_set_time64(&date, time);
1979  xaccTransSetDatePostedGDate(trans, date);
1980 }
void xaccTransSetDatePostedGDate(Transaction *trans, GDate date)
This method modifies posted date of the transaction, specified by a GDate.
Definition: Transaction.c:1983
void gnc_gdate_set_time64(GDate *gd, time64 time)
Set a GDate to a time64.

◆ xaccTransSetDatePostedTS()

void xaccTransSetDatePostedTS ( Transaction *  trans,
const Timespec *  ts 
)

The xaccTransSetDatePostedTS() method does the same thing as xaccTransSetDatePostedSecs(), but takes a struct timespec64.

Definition at line 2020 of file Transaction.c.

2021 {
2022  if (!trans || !ts) return;
2023  xaccTransSetDateInternal(trans, &trans->date_posted, *ts);
2024  set_gains_date_dirty (trans);
2025 }

◆ 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 2181 of file Transaction.c.

2182 {
2183  GValue v = G_VALUE_INIT;
2184  if (!trans || !notes) return;
2185  g_value_init (&v, G_TYPE_STRING);
2186  g_value_set_string (&v, notes);
2187  xaccTransBeginEdit(trans);
2188 
2189  qof_instance_set_kvp (QOF_INSTANCE (trans), trans_notes_str, &v);
2190  qof_instance_set_dirty(QOF_INSTANCE(trans));
2191  xaccTransCommitEdit(trans);
2192 }
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443
void qof_instance_set_kvp(QofInstance *inst, const gchar *key, const GValue *value)
Sets a KVP slot to a value from a GValue.

◆ 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 2101 of file Transaction.c.

2102 {
2103  if (trans && reason)
2104  {
2105  GValue v = G_VALUE_INIT;
2106  g_value_init (&v, G_TYPE_STRING);
2107  g_value_set_string (&v, reason);
2108  xaccTransBeginEdit(trans);
2109  qof_instance_set_kvp (QOF_INSTANCE (trans), TRANS_READ_ONLY_REASON, &v);
2110  qof_instance_set_dirty(QOF_INSTANCE(trans));
2111  xaccTransCommitEdit(trans);
2112  }
2113 }
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443
void qof_instance_set_kvp(QofInstance *inst, const gchar *key, const GValue *value)
Sets a KVP slot to a value from a GValue.

◆ xaccTransSetTxnType()

void xaccTransSetTxnType ( Transaction *  trans,
char  type 
)

Set the Transaction Type.

See TXN_TYPE_NONE, TXN_TYPE_INVOICE and TXN_TYPE_PAYMENT

Definition at line 2075 of file Transaction.c.

2076 {
2077  char s[2] = {type, '\0'};
2078  GValue v = G_VALUE_INIT;
2079  g_return_if_fail(trans);
2080  g_value_init (&v, G_TYPE_STRING);
2081  g_value_set_string (&v, s);
2082  xaccTransBeginEdit(trans);
2083  qof_instance_set_kvp (QOF_INSTANCE (trans), TRANS_TXN_TYPE_KVP, &v);
2084  qof_instance_set_dirty(QOF_INSTANCE(trans));
2085  xaccTransCommitEdit(trans);
2086 }
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443
void qof_instance_set_kvp(QofInstance *inst, const gchar *key, const GValue *value)
Sets a KVP slot to a value from a GValue.

◆ 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 2691 of file Transaction.c.

2692 {
2693  GValue v = G_VALUE_INIT;
2694  const char *s = NULL;
2695  g_return_if_fail(trans);
2696 
2697  qof_instance_get_kvp (QOF_INSTANCE (trans), void_reason_str, &v);
2698  if (G_VALUE_HOLDS_STRING (&v))
2699  s = g_value_get_string (&v);
2700  if (s == NULL) return; /* Transaction isn't voided. Bail. */
2701  xaccTransBeginEdit(trans);
2702 
2703  qof_instance_get_kvp (QOF_INSTANCE (trans), void_former_notes_str, &v);
2704  if (G_VALUE_HOLDS_STRING (&v))
2705  qof_instance_set_kvp (QOF_INSTANCE (trans), trans_notes_str, &v);
2706  qof_instance_set_kvp (QOF_INSTANCE (trans), void_former_notes_str, NULL);
2707  qof_instance_set_kvp (QOF_INSTANCE (trans), void_reason_str, NULL);
2708  qof_instance_set_kvp (QOF_INSTANCE (trans), void_time_str, NULL);
2709 
2710  FOR_EACH_SPLIT(trans, xaccSplitUnvoid(s));
2711 
2712  /* Dirtying taken care of by ClearReadOnly */
2713  xaccTransClearReadOnly(trans);
2714  xaccTransCommitEdit(trans);
2715 }
void qof_instance_get_kvp(const QofInstance *inst, const gchar *key, GValue *value)
Retrieves the contents of a KVP slot into a provided GValue.
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443
void qof_instance_set_kvp(QofInstance *inst, const gchar *key, const GValue *value)
Sets a KVP slot to a value from a GValue.

◆ 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 2611 of file Transaction.c.

2612 {
2613  GValue v = G_VALUE_INIT;
2614  char iso8601_str[ISO_DATELENGTH + 1] = "";
2615 
2616  g_return_if_fail(trans && reason);
2617 
2618  /* Prevent voiding transactions that are already marked
2619  * read only, for example generated by the business features.
2620  */
2621  if (xaccTransGetReadOnly (trans))
2622  {
2623  PWARN ("Refusing to void a read-only transaction!");
2624  return;
2625  }
2626  xaccTransBeginEdit(trans);
2627  qof_instance_get_kvp (QOF_INSTANCE (trans), trans_notes_str, &v);
2628  if (G_VALUE_HOLDS_STRING (&v))
2629  qof_instance_set_kvp (QOF_INSTANCE (trans), void_former_notes_str, &v);
2630  else
2631  g_value_init (&v, G_TYPE_STRING);
2632 
2633  g_value_set_string (&v, _("Voided transaction"));
2634  qof_instance_set_kvp (QOF_INSTANCE (trans), trans_notes_str, &v);
2635  g_value_set_string (&v, reason);
2636  qof_instance_set_kvp (QOF_INSTANCE (trans), void_reason_str, &v);
2637 
2638  gnc_timespec_to_iso8601_buff (timespec_now (), iso8601_str);
2639  g_value_set_string (&v, iso8601_str);
2640  qof_instance_set_kvp (QOF_INSTANCE (trans), void_time_str, &v);
2641 
2642  FOR_EACH_SPLIT(trans, xaccSplitVoid(s));
2643 
2644  /* Dirtying taken care of by SetReadOnly */
2645  xaccTransSetReadOnly(trans, _("Transaction Voided"));
2646  xaccTransCommitEdit(trans);
2647 }
void qof_instance_get_kvp(const QofInstance *inst, const gchar *key, GValue *value)
Retrieves the contents of a KVP slot into a provided GValue.
gchar * gnc_timespec_to_iso8601_buff(Timespec ts, gchar *buff)
The gnc_timespec_to_iso8601_buff() routine takes the input UTC Timespec value and prints it as an ISO...
#define PWARN(format, args...)
Log a warning.
Definition: qoflog.h:243
void xaccTransSetReadOnly(Transaction *trans, const char *reason)
Set the transaction to be ReadOnly by setting a non-NULL value as "reason".
Definition: Transaction.c:2101
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1642
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1443
const char * xaccTransGetReadOnly(const Transaction *trans)
Returns a non-NULL value if this Transaction was marked as read-only with some specific "reason" text...
Definition: Transaction.c:2421
Timespec timespec_now()
Returns the current clock time as a Timespec, taken from time(2).
Definition: gnc-date.cpp:1318
void qof_instance_set_kvp(QofInstance *inst, const gchar *key, const GValue *value)
Sets a KVP slot to a value from a GValue.