GnuCash  3.1-61-g61071b9
Modules | Files | Data Structures | Macros | Typedefs | Enumerations | Functions
GnuCash Engine: Core, Non-GUI Accounting Functions

The GnuCash Engine provides a set of objects and classes that encapsulate typical financial accounting concepts. More...

Modules

 Environment
 The API in this file is used to read the environment configuration file and set up a number of environment variables based on the values found in it.
 
 Generic Preference Utilities
 The only function in this file is meant to initialize the preferences system early in the load process.
 
 
 Cap Gains
 This file implements the various routines to automatically compute and handle Cap Gains/Losses resulting from trading activities.
 
 Commodities
 A commodity is something of value that is easily tradeable or sellable; for example, currencies, stocks, bonds, grain, copper, and oil are all commodities.
 
 Lots: Core Function for AR/AP, Inventory, Stock Lots, Cap Gains
 One often needs to know that the item 'bought' in one transaction is the same one as the item 'sold' in a different transaction.
 
 Price Database
 The PriceDB is intended to be a database of price quotes, or more specifically, a database of GNCPrices.
 
 Prices
 Each price in the database represents an "instantaneous" quote for a given commodity with respect to another commodity.
 
 Business
 The Business Engine provides a set of structures for that provide small-business accounting features.
 
 Accounting Policy (FIFO/LIFO)
 This file implements Accounting Policy.
 
 Scheduled/Periodic/Recurring Transactions
 Scheduled Transactions provide a framework for remembering information about a transactions that are set to occur in the future, either once or periodically.
 
 Data Validation
 Data scrubbing, repairing and forward migration routines.
 
 Transaction, Split
 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.
 
 Transaction Logging
 The transaction logging mechanism provides a very simple, low-level logging of user input to a file.
 

Files

file  gnc-engine.h
 All type declarations for the whole Gnucash engine.
 

Data Structures

struct  GncImapInfo
 

Macros

#define ACCOUNT_MATCH_ALL_TYPE   "account-match-all"
 This is the type-override when you want to match all accounts. More...
 
#define GNC_ID_NONE   QOF_ID_NONE
 IDENTIFIERS GncGUID Identifiers can be used to reference Accounts, Transactions, Splits and other objects. More...
 
#define GNC_ID_BOOK   QOF_ID_BOOK
 
#define GNC_ID_SESSION   QOF_ID_SESSION
 
#define GNC_ID_NULL   QOF_ID_NULL
 
#define GNC_ID_ACCOUNT   "Account"
 
#define GNC_ID_COMMODITY   "Commodity"
 
#define GNC_ID_COMMODITY_NAMESPACE   "CommodityNamespace"
 
#define GNC_ID_COMMODITY_TABLE   "CommodityTable"
 
#define GNC_ID_LOT   "Lot"
 
#define GNC_ID_PERIOD   "Period"
 
#define GNC_ID_PRICE   "Price"
 
#define GNC_ID_PRICEDB   "PriceDB"
 
#define GNC_ID_SPLIT   "Split"
 
#define GNC_ID_BUDGET   "Budget"
 
#define GNC_ID_SCHEDXACTION   "SchedXaction"
 
#define GNC_ID_SXES   "SchedXactions"
 
#define GNC_ID_SXTG   "SXTGroup"
 
#define GNC_ID_SXTT   "SXTTrans"
 
#define GNC_ID_TRANS   "Trans"
 
#define GNC_INVOICE_ID   "gncInvoice"
 STRING CONSTANTS ********************************************** Used to declare constant KVP keys used in more than one class.
 
#define GNC_INVOICE_GUID   "invoice-guid"
 
#define GNC_OWNER_ID   "gncOwner"
 
#define GNC_OWNER_TYPE   "owner-type"
 
#define GNC_OWNER_GUID   "owner-guid"
 
#define GNC_SX_ID   "sched-xaction"
 

Typedefs

typedef GList AccountList
 GList of Account.
 
typedef GList LotList
 GList of GNCLots.
 
typedef GList SplitList
 GList of Split.
 
typedef GList TransList
 GList of Transaction.
 
typedef GList AccountGUIDList
 GList of GUIDs of a Account.
 
typedef GList BookGUIDList
 GList of GUIDs of a QofBook.
 
typedef void(* EngineCommitErrorCallback) (gpointer data, QofBackendError errcode)
 
typedef gint(* SplitCallback) (Split *s, gpointer data)
 
typedef gint(* TransactionCallback) (Transaction *t, void *data)
 
typedef void(* gnc_engine_init_hook_t) (int, char **)
 Function type for init hooks in the engine. More...
 

Enumerations

enum  GNCPlaceholderType { PLACEHOLDER_NONE, PLACEHOLDER_THIS, PLACEHOLDER_CHILD }
 DOCUMENT ME!
 

Functions

void gnc_engine_init (int argc, char **argv)
 PROTOTYPES. More...
 
void gnc_engine_init_static (int argc, char **argv)
 This is the statically linked-in version of gnc_engine_init. More...
 
void gnc_engine_shutdown (void)
 Called to shutdown the engine. More...
 
gboolean gnc_engine_is_initialized (void)
 check the engine is fully initialized
 
void gnc_log_default (void)
 enable default log modules
 
void gnc_engine_add_init_hook (gnc_engine_init_hook_t hook)
 Pass a function pointer to gnc_engine_add_init_hook and it will be called during the evaluation of gnc_engine_init.
 
void gnc_engine_add_commit_error_callback (EngineCommitErrorCallback cb, gpointer data)
 Set a callback function to be called in case an engine commit fails.
 
void gnc_engine_signal_commit_error (QofBackendError errcode)
 

Lookup Accounts and Subaccounts by name or code

Accountgnc_account_lookup_by_name (const Account *parent, const char *name)
 The gnc_account_lookup_by_name() subroutine fetches the account by name from the descendants of the specified account. More...
 
Accountgnc_account_lookup_by_full_name (const Account *any_account, const gchar *name)
 The gnc_account_lookup_full_name() subroutine works like gnc_account_lookup_by_name, but uses fully-qualified names using the given separator.
 
Accountgnc_account_lookup_by_code (const Account *parent, const char *code)
 The gnc_account_lookup_full_name() subroutine works like gnc_account_lookup_by_name, but uses the account code.
 

GNCAccountType conversion/checking

const char * xaccAccountTypeEnumAsString (GNCAccountType type)
 Conversion routines for the account types to/from strings that are used in persistent storage, communications. More...
 
gboolean xaccAccountStringToType (const char *str, GNCAccountType *type)
 Conversion routines for the account types to/from strings that are used in persistent storage, communications. More...
 
GNCAccountType xaccAccountStringToEnum (const char *str)
 Conversion routines for the account types to/from strings that are used in persistent storage, communications. More...
 
const char * xaccAccountGetTypeStr (GNCAccountType type)
 The xaccAccountGetTypeStr() routine returns a string suitable for use in the GUI/Interface. More...
 
guint32 xaccAccountTypesCompatibleWith (GNCAccountType type)
 Return the bitmask of account types compatible with a given type. More...
 
guint32 xaccParentAccountTypesCompatibleWith (GNCAccountType type)
 Return the bitmask of parent account types compatible with a given type. More...
 
gboolean xaccAccountTypesCompatible (GNCAccountType parent_type, GNCAccountType child_type)
 Return TRUE if accounts of type parent_type can have accounts of type child_type as children. More...
 
guint32 xaccAccountTypesValid (void)
 Returns the bitmask of the account type enums that are valid. More...
 
gboolean xaccAccountIsAssetLiabType (GNCAccountType t)
 Convenience function to check if the account is a valid Asset or Liability type, but not a business account type (meaning not an Accounts Payable/Accounts Receivable). More...
 
gboolean xaccAccountIsAPARType (GNCAccountType t)
 Convenience function to check if the account is a valid business account type (meaning an Accounts Payable/Accounts Receivable). More...
 
gboolean xaccAccountIsEquityType (GNCAccountType t)
 Convenience function to check if the account is a valid Equity type. More...
 

Account split/transaction list management

SplitListxaccAccountGetSplitList (const Account *account)
 The xaccAccountGetSplitList() routine returns a pointer to a GList of the splits in the account. More...
 
gint64 xaccAccountCountSplits (const Account *acc, gboolean include_children)
 The xaccAccountCountSplits() routine returns the number of all the splits in the account. More...
 
void xaccAccountMoveAllSplits (Account *accfrom, Account *accto)
 The xaccAccountMoveAllSplits() routine reassigns each of the splits in accfrom to accto. More...
 
gint xaccAccountForEachTransaction (const Account *account, TransactionCallback proc, void *data)
 The xaccAccountForEachTransaction() routine will traverse all of the transactions in account and call the callback function proc on each transaction. More...
 
Transaction * xaccAccountFindTransByDesc (const Account *account, const char *description)
 Returns a pointer to the transaction, not a copy. More...
 
Split * xaccAccountFindSplitByDesc (const Account *account, const char *description)
 Returns a pointer to the split, not a copy. More...
 
#define xaccAccountInsertSplit(acc, s)   xaccSplitSetAccount((s), (acc))
 The xaccAccountInsertSplit() method will insert the indicated split into the indicated account. More...
 

Account lots

void xaccAccountInsertLot (Account *, GNCLot *)
 The xaccAccountInsertLot() method will register the indicated lot with this account. More...
 
void xaccAccountRemoveLot (Account *, GNCLot *)
 
LotListxaccAccountGetLotList (const Account *account)
 The xaccAccountGetLotList() routine returns a list of all lots in this account. More...
 
gpointer xaccAccountForEachLot (const Account *acc, gpointer(*proc)(GNCLot *lot, gpointer user_data), gpointer user_data)
 The xaccAccountForEachLot() method will apply the function 'proc' to each lot in the account. More...
 
LotListxaccAccountFindOpenLots (const Account *acc, gboolean(*match_func)(GNCLot *lot, gpointer user_data), gpointer user_data, GCompareFunc sort_func)
 Find a list of open lots that match the match_func. More...
 

Account Reconciliation information getters/setters

gboolean xaccAccountGetReconcileLastDate (const Account *account, time64 *last_date)
 DOCUMENT ME!
 
void xaccAccountSetReconcileLastDate (Account *account, time64 last_date)
 DOCUMENT ME!
 
gboolean xaccAccountGetReconcileLastInterval (const Account *account, int *months, int *days)
 DOCUMENT ME!
 
void xaccAccountSetReconcileLastInterval (Account *account, int months, int days)
 DOCUMENT ME!
 
gboolean xaccAccountGetReconcilePostponeDate (const Account *account, time64 *postpone_date)
 DOCUMENT ME!
 
void xaccAccountSetReconcilePostponeDate (Account *account, time64 postpone_date)
 DOCUMENT ME!
 
gboolean xaccAccountGetReconcilePostponeBalance (const Account *account, gnc_numeric *balance)
 DOCUMENT ME!
 
void xaccAccountSetReconcilePostponeBalance (Account *account, gnc_numeric balance)
 DOCUMENT ME!
 
void xaccAccountClearReconcilePostpone (Account *account)
 DOCUMENT ME!
 

Account Placeholder flag

gboolean xaccAccountGetPlaceholder (const Account *account)
 Get the "placeholder" flag for an account. More...
 
void xaccAccountSetPlaceholder (Account *account, gboolean val)
 Set the "placeholder" flag for an account. More...
 
GNCPlaceholderType xaccAccountGetDescendantPlaceholder (const Account *account)
 Returns PLACEHOLDER_NONE if account is NULL or neither account nor any descendant of account is a placeholder. More...
 

Account Hidden flag

gboolean xaccAccountGetHidden (const Account *acc)
 Get the "hidden" flag for an account. More...
 
void xaccAccountSetHidden (Account *acc, gboolean val)
 Set the "hidden" flag for an account. More...
 
gboolean xaccAccountIsHidden (const Account *acc)
 Should this account be "hidden". More...
 

Account Tax related getters/setters

gboolean xaccAccountGetTaxRelated (const Account *account)
 DOCUMENT ME!
 
void xaccAccountSetTaxRelated (Account *account, gboolean tax_related)
 DOCUMENT ME!
 
const char * xaccAccountGetTaxUSCode (const Account *account)
 DOCUMENT ME!
 
void xaccAccountSetTaxUSCode (Account *account, const char *code)
 DOCUMENT ME!
 
const char * xaccAccountGetTaxUSPayerNameSource (const Account *account)
 DOCUMENT ME!
 
void xaccAccountSetTaxUSPayerNameSource (Account *account, const char *source)
 DOCUMENT ME!
 
gint64 xaccAccountGetTaxUSCopyNumber (const Account *account)
 DOCUMENT ME!
 
void xaccAccountSetTaxUSCopyNumber (Account *account, gint64 copy_number)
 DOCUMENT ME!
 

Account marking

void xaccAccountSetMark (Account *account, short mark)
 Set a mark on the account. More...
 
void xaccClearMark (Account *account, short val)
 Get the mark set by xaccAccountSetMark short xaccAccountGetMark (const Account *account);. More...
 
void xaccClearMarkDown (Account *account, short val)
 The xaccClearMarkDown will clear the mark only in this and in sub-accounts. More...
 

Staged Traversal

The following functions provide support for "staged traversals" over all of the transactions in an account or group.

The idea is to be able to perform a sequence of traversals ("stages"), and perform an operation on each transaction exactly once for that stage.

Only transactions whose current "stage" is less than the stage of the current traversal will be affected, and they will be "brought up" to the current stage when they are processed.

For example, you could perform a stage 1 traversal of all the transactions in an account, and then perform a stage 1 traversal of the transactions in a second account. Presuming the traversal of the first account didn't abort prematurely, any transactions shared by both accounts would be ignored during the traversal of the second account since they had been processed while traversing the first account.

However, if you had traversed the second account using a stage of 2, then all the transactions in the second account would have been processed.

Traversal can be aborted by having the callback function return a non-zero value. The traversal is aborted immediately, and the non-zero value is returned. Note that an aborted traversal can be restarted; no information is lost due to an abort.

The initial impetus for this particular approach came from generalizing a mark/sweep practice that was already being used in FileIO.c.

Note that currently, there is a hard limit of 256 stages, which can be changed by enlarging "marker" in the transaction struct.

void gnc_account_tree_begin_staged_transaction_traversals (Account *acc)
 gnc_account_tree_begin_staged_transaction_traversals() resets the traversal marker inside every transactions of every account in the account tree originating with the specified node. More...
 
void xaccSplitsBeginStagedTransactionTraversals (SplitList *splits)
 xaccSplitsBeginStagedTransactionTraversals() resets the traversal marker for each transaction which is a parent of one of the splits in the list.
 
void xaccAccountBeginStagedTransactionTraversals (const Account *account)
 xaccAccountBeginStagedTransactionTraversals() resets the traversal marker for each transaction which is a parent of one of the splits in the account.
 
gboolean xaccTransactionTraverse (Transaction *trans, int stage)
 xaccTransactionTraverse() checks the stage of the given transaction. More...
 
int xaccAccountStagedTransactionTraversal (const Account *a, unsigned int stage, TransactionCallback thunk, void *data)
 xaccAccountStagedTransactionTraversal() calls thunk on each transaction in account a whose current marker is less than the given stage and updates each transaction's marker to be stage. More...
 
int gnc_account_tree_staged_transaction_traversal (const Account *account, unsigned int stage, TransactionCallback thunk, void *data)
 gnc_account_tree_staged_transaction_traversal() calls thunk on each transaction in the group whose current marker is less than the given stage and updates each transaction's marker to be stage. More...
 
int xaccAccountTreeForEachTransaction (Account *acc, TransactionCallback proc, void *data)
 Traverse all of the transactions in the given account group. More...
 
GncImportMatchMapgnc_account_imap_create_imap (Account *acc)
 Obtain an ImportMatchMap object from an Account or a Book.
 
Accountgnc_account_imap_find_account (GncImportMatchMap *imap, const char *category, const char *key)
 
void gnc_account_imap_add_account (GncImportMatchMap *imap, const char *category, const char *key, Account *acc)
 
void gnc_account_imap_delete_account (GncImportMatchMap *imap, const char *category, const char *key)
 
Accountgnc_account_imap_find_account_bayes (GncImportMatchMap *imap, GList *tokens)
 Look up an Account in the map using Baysian. More...
 
void gnc_account_imap_add_account_bayes (GncImportMatchMap *imap, GList *tokens, Account *acc)
 Updates the imap for a given account using a list of tokens.
 
GList * gnc_account_imap_get_info_bayes (Account *acc)
 Returns a GList of structure imap_info of all Bayesian mappings for required Account.
 
GList * gnc_account_imap_get_info (Account *acc, const char *category)
 Returns a GList of structure imap_info of all Non Bayesian mappings for required Account.
 
gchar * gnc_account_get_map_entry (Account *acc, const char *full_category)
 Returns the text string pointed to by full_category for the Account, free the returned text.
 
void gnc_account_delete_map_entry (Account *acc, char *head, char *category, char *match_string, gboolean empty)
 Delete the entry for Account pointed to by head,category and match_string, if empty is TRUE then use delete if empty.
 
void gnc_account_delete_all_bayes_maps (Account *acc)
 Delete all bayes entries for Account.
 

Deprecated Routines.

void DxaccAccountSetCurrency (Account *account, gnc_commodity *currency)
 
gnc_commodity * DxaccAccountGetCurrency (const Account *account)
 
void dxaccAccountSetQuoteTZ (Account *account, const char *tz)
 Set the timezone to be used when interpreting the results from a given Finance::Quote backend. More...
 
const char * dxaccAccountGetQuoteTZ (const Account *account)
 Get the timezone to be used when interpreting the results from a given Finance::Quote backend. More...
 

Account parameter names

#define ACCOUNT_KVP   "kvp"
 
#define ACCOUNT_NAME_   "name"
 
#define ACCOUNT_CODE_   "code"
 
#define ACCOUNT_DESCRIPTION_   "desc"
 
#define ACCOUNT_COLOR_   "color"
 
#define ACCOUNT_FILTER_   "filter"
 
#define ACCOUNT_SORT_ORDER_   "sort-order"
 
#define ACCOUNT_SORT_REVERSED_   "sort-reversed"
 
#define ACCOUNT_NOTES_   "notes"
 
#define ACCOUNT_BALANCE_   "balance"
 
#define ACCOUNT_CLEARED_   "cleared"
 
#define ACCOUNT_RECONCILED_   "reconciled"
 
#define ACCOUNT_PRESENT_   "present"
 
#define ACCOUNT_FUTURE_MINIMUM_   "future-minimum"
 
#define ACCOUNT_TAX_RELATED   "tax-related-p"
 
#define ACCOUNT_TYPE_   "account-type"
 
#define ACCOUNT_SCU   "smallest-commodity-unit"
 
#define ACCOUNT_NSCU   "non-standard-scu"
 
#define ACCOUNT_PARENT   "parent-account"
 

QofLogModule identifiers

#define GNC_MOD_ROOT   "gnc"
 
#define GNC_MOD_ENGINE   "gnc.engine"
 
#define GNC_MOD_ACCOUNT   "gnc.account"
 
#define GNC_MOD_SX   "gnc.engine.sx"
 
#define GNC_MOD_QUERY   "gnc.query"
 
#define GNC_MOD_SCRUB   "gnc.scrub"
 
#define GNC_MOD_LOT   "gnc.lots"
 
#define GNC_MOD_COMMODITY   "gnc.commodity"
 
#define GNC_MOD_BACKEND   "gnc.backend"
 
#define GNC_MOD_PRICE   "gnc.pricedb"
 
#define GNC_MOD_BUSINESS   "gnc.business"
 
#define GNC_MOD_IO   "gnc.io"
 
#define GNC_MOD_BOOK   "gnc.book-period"
 
#define GNC_MOD_GUI   "gnc.gui"
 
#define GNC_MOD_GUI_SX   "gnc.gui.sx"
 
#define GNC_MOD_GUILE   "gnc.guile"
 
#define GNC_MOD_LEDGER   "gnc.ledger"
 
#define GNC_MOD_REGISTER   "gnc.register"
 
#define GNC_MOD_HTML   "gnc.html"
 
#define GNC_MOD_PREFS   "gnc.pref"
 
#define GNC_MOD_IMPORT   "gnc.import"
 
#define GNC_MOD_ASSISTANT   "gnc.assistant"
 
#define GNC_MOD_TEST   "gnc.tests"
 
#define GNC_MOD_BUDGET   "gnc.budget"
 

Detailed Description

The GnuCash Engine provides a set of objects and classes that encapsulate typical financial accounting concepts.

The GnuCash GUI is expected to manipulate these objects through the provided engine API.

Macro Definition Documentation

◆ ACCOUNT_MATCH_ALL_TYPE

#define ACCOUNT_MATCH_ALL_TYPE   "account-match-all"

This is the type-override when you want to match all accounts.

Used in the gnome-search parameter list. Be careful when you use this.

Definition at line 1521 of file Account.h.

◆ GNC_ID_NONE

#define GNC_ID_NONE   QOF_ID_NONE

IDENTIFIERS GncGUID Identifiers can be used to reference Accounts, Transactions, Splits and other objects.

These Gnucash types are referred to as Gnucash entities. GncGUID Identifiers are globally-unique and permanent, i.e., once an entity has been assigned an identifier, it retains that same identifier for its lifetime.

  • Identifiers are 'typed' with strings. The ids used in gnucash are defined below. An id with type GNC_ID_NONE does not refer to any entity, although that may change as new ids are created. An id with type GNC_ID_NULL does not refer to any entity, and will never refer to any entity. An identifier with any other type may refer to an actual entity, but that is not guaranteed. If an id does refer to an entity, the type of the entity will match the type of the identifier.

Definition at line 91 of file gnc-engine.h.

◆ xaccAccountInsertSplit

#define xaccAccountInsertSplit (   acc,
 
)    xaccSplitSetAccount((s), (acc))

The xaccAccountInsertSplit() method will insert the indicated split into the indicated account.

If the split already belongs to another account, it will be removed from that account first.

Definition at line 990 of file Account.h.

Typedef Documentation

◆ gnc_engine_init_hook_t

typedef void(* gnc_engine_init_hook_t) (int, char **)

Function type for init hooks in the engine.

Definition at line 221 of file gnc-engine.h.

Function Documentation

◆ DxaccAccountGetCurrency()

gnc_commodity* DxaccAccountGetCurrency ( const Account account)
Deprecated:
The current API associates only one thing with an account: the 'commodity'.

Use xaccAccountGetCommodity() to fetch it.

Definition at line 3129 of file Account.cpp.

3130 {
3131  GValue v = G_VALUE_INIT;
3132  const char *s = NULL;
3133  gnc_commodity_table *table;
3134 
3135  if (!acc) return NULL;
3136  qof_instance_get_path_kvp (QOF_INSTANCE(acc), &v, {"old-currency"});
3137  if (G_VALUE_HOLDS_STRING (&v))
3138  s = g_value_get_string (&v);
3139  if (!s) return NULL;
3140 
3142 
3143  return gnc_commodity_table_lookup_unique (table, s);
3144 }
gnc_commodity_table * gnc_commodity_table_get_table(QofBook *book)
Returns the commodity table associated with a book.
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.

◆ dxaccAccountGetQuoteTZ()

const char* dxaccAccountGetQuoteTZ ( const Account account)

Get the timezone to be used when interpreting the results from a given Finance::Quote backend.

Unfortunately, the upstream sources don't label their output, so the user has to specify this bit.

Deprecated:
Price quote information is now stored on the commodity, not the account.

Definition at line 4673 of file Account.cpp.

4674 {
4675  GValue v = G_VALUE_INIT;
4676  if (!acc) return NULL;
4677  if (!xaccAccountIsPriced(acc)) return NULL;
4678  qof_instance_get_path_kvp (QOF_INSTANCE (acc), &v, {"old-quote-tz"});
4679  return G_VALUE_HOLDS_STRING (&v) ? g_value_get_string (&v) : NULL;
4680 }
gboolean xaccAccountIsPriced(const Account *acc)
Returns true if the account is a stock, mutual fund or currency, otherwise false. ...
Definition: Account.cpp:4278

◆ DxaccAccountSetCurrency()

void DxaccAccountSetCurrency ( Account account,
gnc_commodity *  currency 
)
Deprecated:
The current API associates only one thing with an account: the 'commodity'.

Use xaccAccountGetCommodity() to fetch it.

These two funcs take control of their gnc_commodity args. Don't free

Definition at line 2488 of file Account.cpp.

2489 {
2490  QofBook *book;
2491  GValue v = G_VALUE_INIT;
2492  const char *s = gnc_commodity_get_unique_name (currency);
2493  gnc_commodity *commodity;
2494  gnc_commodity_table *table;
2495 
2496  if ((!acc) || (!currency)) return;
2497  g_value_init (&v, G_TYPE_STRING);
2498  g_value_set_string (&v, s);
2499  qof_instance_set_path_kvp (QOF_INSTANCE (acc), &v, {"old-currency"});
2500  mark_account (acc);
2501  xaccAccountCommitEdit(acc);
2502 
2504  commodity = gnc_commodity_table_lookup_unique (table, s);
2505 
2506  if (!commodity)
2507  {
2508  book = qof_instance_get_book(acc);
2510  currency);
2511  }
2512 }
gnc_commodity * gnc_commodity_table_insert(gnc_commodity_table *table, gnc_commodity *comm)
Add a new commodity to the commodity table.
gnc_commodity_table * gnc_commodity_table_get_table(QofBook *book)
Returns the commodity table associated with a book.
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.
const char * gnc_commodity_get_unique_name(const gnc_commodity *cm)
Retrieve the 'unique' name for the specified commodity.
void xaccAccountCommitEdit(Account *acc)
ThexaccAccountCommitEdit() subroutine is the second phase of a two-phase-commit wrapper for account u...
Definition: Account.cpp:1328

◆ dxaccAccountSetQuoteTZ()

void dxaccAccountSetQuoteTZ ( Account account,
const char *  tz 
)

Set the timezone to be used when interpreting the results from a given Finance::Quote backend.

Unfortunately, the upstream sources don't label their output, so the user has to specify this bit.

Deprecated:
Price quote information is now stored on the commodity, not the account.

Definition at line 4656 of file Account.cpp.

4657 {
4658  GValue v = G_VALUE_INIT;
4659  if (!acc) return;
4660  if (!xaccAccountIsPriced(acc)) return;
4661  xaccAccountBeginEdit(acc);
4662  g_value_init (&v, G_TYPE_STRING);
4663  g_value_set_string (&v, tz);
4664  qof_instance_set_path_kvp (QOF_INSTANCE (acc), &v, {"old-quote-tz"});
4665  mark_account (acc);
4666  xaccAccountCommitEdit(acc);
4667 }
gboolean xaccAccountIsPriced(const Account *acc)
Returns true if the account is a stock, mutual fund or currency, otherwise false. ...
Definition: Account.cpp:4278
void xaccAccountBeginEdit(Account *acc)
The xaccAccountBeginEdit() subroutine is the first phase of a two-phase-commit wrapper for account up...
Definition: Account.cpp:1287
void xaccAccountCommitEdit(Account *acc)
ThexaccAccountCommitEdit() subroutine is the second phase of a two-phase-commit wrapper for account u...
Definition: Account.cpp:1328

◆ gnc_account_imap_find_account_bayes()

Account* gnc_account_imap_find_account_bayes ( GncImportMatchMap imap,
GList *  tokens 
)

Look up an Account in the map using Baysian.

Look up an Account in the map using Baysian.

Definition at line 5426 of file Account.cpp.

5427 {
5428  if (!imap)
5429  return nullptr;
5430  check_import_map_data (imap->book);
5431  auto first_pass = get_first_pass_probabilities(imap, tokens);
5432  if (!first_pass.size())
5433  return nullptr;
5434  auto final_probabilities = build_probabilities(first_pass);
5435  if (!final_probabilities.size())
5436  return nullptr;
5437  auto best = highest_probability(final_probabilities);
5438  if (best.account_guid == "")
5439  return nullptr;
5440  if (best.probability < threshold)
5441  return nullptr;
5442  gnc::GUID guid;
5443  try {
5444  guid = gnc::GUID::from_string(best.account_guid);
5445  } catch (gnc::guid_syntax_exception&) {
5446  return nullptr;
5447  }
5448  auto account = xaccAccountLookup (reinterpret_cast<GncGUID*>(&guid), imap->book);
5449  return account;
5450 }
Account * xaccAccountLookup(const GncGUID *guid, QofBook *book)
The xaccAccountLookup() subroutine will return the account associated with the given id...
Definition: Account.cpp:1834

◆ gnc_account_lookup_by_name()

Account* gnc_account_lookup_by_name ( const Account parent,
const char *  name 
)

The gnc_account_lookup_by_name() subroutine fetches the account by name from the descendants of the specified account.

The immediate children are searched first. If there is no match,, then a recursive search of all descendants is performed looking for a match.

Returns
A pointer to the account with the specified name, or NULL if the account was not found.

Definition at line 2796 of file Account.cpp.

2797 {
2798  AccountPrivate *cpriv, *ppriv;
2799  Account *child, *result;
2800  GList *node;
2801 
2802  g_return_val_if_fail(GNC_IS_ACCOUNT(parent), NULL);
2803  g_return_val_if_fail(name, NULL);
2804 
2805  /* first, look for accounts hanging off the current node */
2806  ppriv = GET_PRIVATE(parent);
2807  for (node = ppriv->children; node; node = node->next)
2808  {
2809  child = static_cast<Account*>(node->data);
2810  cpriv = GET_PRIVATE(child);
2811  if (g_strcmp0(cpriv->accountName, name) == 0)
2812  return child;
2813  }
2814 
2815  /* if we are still here, then we haven't found the account yet.
2816  * Recursively search each of the child accounts next */
2817  for (node = ppriv->children; node; node = node->next)
2818  {
2819  child = static_cast<Account*>(node->data);
2820  result = gnc_account_lookup_by_name (child, name);
2821  if (result)
2822  return result;
2823  }
2824 
2825  return NULL;
2826 }
STRUCTS.
Account * gnc_account_lookup_by_name(const Account *parent, const char *name)
The gnc_account_lookup_by_name() subroutine fetches the account by name from the descendants of the s...
Definition: Account.cpp:2796

◆ gnc_account_tree_begin_staged_transaction_traversals()

void gnc_account_tree_begin_staged_transaction_traversals ( Account acc)

gnc_account_tree_begin_staged_transaction_traversals() resets the traversal marker inside every transactions of every account in the account tree originating with the specified node.

This is done so that a new sequence of staged traversals can begin.

Definition at line 4940 of file Account.cpp.

4941 {
4942  GList *descendants;
4943 
4944  descendants = gnc_account_get_descendants(account);
4945  g_list_foreach(descendants, (GFunc)do_one_account, NULL);
4946  g_list_free(descendants);
4947 }
GList * gnc_account_get_descendants(const Account *account)
This routine returns a flat list of all of the accounts that are descendants of the specified account...
Definition: Account.cpp:2748

◆ gnc_account_tree_staged_transaction_traversal()

int gnc_account_tree_staged_transaction_traversal ( const Account account,
unsigned int  stage,
TransactionCallback  thunk,
void *  data 
)

gnc_account_tree_staged_transaction_traversal() calls thunk on each transaction in the group whose current marker is less than the given stage and updates each transaction's marker to be stage.

The traversal will stop if thunk returns a non-zero value. gnc_account_tree_staged_transaction_traversal() function will return zero or the non-zero value returned by thunk. This API does not handle handle recursive traversals.

Warning
For performance reasons, the transaction callback thunk must never destroy any of the transaction's splits, nor assign any of them to a different account. To do so risks a crash.

Definition at line 4990 of file Account.cpp.

4994 {
4995  const AccountPrivate *priv;
4996  GList *acc_p, *split_p;
4997  Transaction *trans;
4998  Split *s;
4999  int retval;
5000 
5001  if (!acc) return 0;
5002 
5003  /* depth first traversal */
5004  priv = GET_PRIVATE(acc);
5005  for (acc_p = priv->children; acc_p; acc_p = g_list_next(acc_p))
5006  {
5007  retval = gnc_account_tree_staged_transaction_traversal(static_cast <Account*> (acc_p->data),
5008  stage, thunk, cb_data);
5009  if (retval) return retval;
5010  }
5011 
5012  /* Now this account */
5013  for (split_p = priv->splits; split_p; split_p = g_list_next(split_p))
5014  {
5015  s = static_cast <Split*> (split_p->data);
5016  trans = s->parent;
5017  if (trans && (trans->marker < stage))
5018  {
5019  trans->marker = stage;
5020  if (thunk)
5021  {
5022  retval = thunk(trans, cb_data);
5023  if (retval) return retval;
5024  }
5025  }
5026  }
5027 
5028  return 0;
5029 }
int gnc_account_tree_staged_transaction_traversal(const Account *acc, unsigned int stage, TransactionCallback thunk, void *cb_data)
gnc_account_tree_staged_transaction_traversal() calls thunk on each transaction in the group whose cu...
Definition: Account.cpp:4990

◆ gnc_engine_init()

void gnc_engine_init ( int  argc,
char **  argv 
)

PROTOTYPES.

gnc_engine_init should be called before gnc engine functions can be used.

Definition at line 116 of file gnc-engine.c.

117 {
118  if (1 == engine_is_initialized) return;
119 
120  gnc_engine_init_part1();
121  gnc_engine_init_part2();
122  gnc_engine_init_part3(argc, argv);
123 }

◆ gnc_engine_init_static()

void gnc_engine_init_static ( int  argc,
char **  argv 
)

This is the statically linked-in version of gnc_engine_init.

It is identical to that function except that it doesn't load any backend library.

Definition at line 126 of file gnc-engine.c.

127 {
128  if (1 == engine_is_initialized) return;
129 
130  gnc_engine_init_part1();
131  gnc_engine_init_part3(argc, argv);
132 }

◆ gnc_engine_shutdown()

void gnc_engine_shutdown ( void  )

Called to shutdown the engine.

Definition at line 141 of file gnc-engine.c.

142 {
144  qof_close();
145  engine_is_initialized = 0;
146 }
void qof_log_shutdown(void)
Be nice, close the logfile if possible.
Definition: qoflog.cpp:204
void qof_close(void)
Safely close down the Query Object Framework.
Definition: qofutil.cpp:269

◆ xaccAccountCountSplits()

gint64 xaccAccountCountSplits ( const Account acc,
gboolean  include_children 
)

The xaccAccountCountSplits() routine returns the number of all the splits in the account.

Parameters
accthe account for which to count the splits
include_childrenalso count splits in descendants (TRUE) or for this account only (FALSE).

Definition at line 3717 of file Account.cpp.

3718 {
3719  gint64 nr, i;
3720 
3721  nr = 0;
3722  g_return_val_if_fail(GNC_IS_ACCOUNT(acc), 0);
3723 
3724  nr = g_list_length(xaccAccountGetSplitList(acc));
3725  if (include_children && (gnc_account_n_children(acc) != 0))
3726  {
3727  for (i=0; i < gnc_account_n_children(acc); i++)
3728  {
3729  nr += xaccAccountCountSplits(gnc_account_nth_child(acc, i), TRUE);
3730  }
3731  }
3732  return nr;
3733 }
SplitList * xaccAccountGetSplitList(const Account *acc)
The xaccAccountGetSplitList() routine returns a pointer to a GList of the splits in the account...
Definition: Account.cpp:3709
gint gnc_account_n_children(const Account *account)
Return the number of children of the specified account.
Definition: Account.cpp:2669
gint64 xaccAccountCountSplits(const Account *acc, gboolean include_children)
The xaccAccountCountSplits() routine returns the number of all the splits in the account.
Definition: Account.cpp:3717
Account * gnc_account_nth_child(const Account *parent, gint num)
Return the n&#39;th child account of the specified parent account.
Definition: Account.cpp:2684

◆ xaccAccountFindOpenLots()

LotList* xaccAccountFindOpenLots ( const Account acc,
gboolean(*)(GNCLot *lot, gpointer user_data)  match_func,
gpointer  user_data,
GCompareFunc  sort_func 
)

Find a list of open lots that match the match_func.

Sort according to sort_func. If match_func is NULL, then all open lots are returned. If sort_func is NULL, then the returned list has no particular order. The caller must free to returned list.

Definition at line 3743 of file Account.cpp.

3747 {
3748  AccountPrivate *priv;
3749  GList *lot_list;
3750  GList *retval = NULL;
3751 
3752  g_return_val_if_fail(GNC_IS_ACCOUNT(acc), NULL);
3753 
3754  priv = GET_PRIVATE(acc);
3755  for (lot_list = priv->lots; lot_list; lot_list = lot_list->next)
3756  {
3757  GNCLot *lot = static_cast<GNCLot*>(lot_list->data);
3758 
3759  /* If this lot is closed, then ignore it */
3760  if (gnc_lot_is_closed (lot))
3761  continue;
3762 
3763  if (match_func && !(match_func)(lot, user_data))
3764  continue;
3765 
3766  /* Ok, this is a valid lot. Add it to our list of lots */
3767  if (sort_func)
3768  retval = g_list_insert_sorted (retval, lot, sort_func);
3769  else
3770  retval = g_list_prepend (retval, lot);
3771  }
3772 
3773  return retval;
3774 }
gboolean gnc_lot_is_closed(GNCLot *lot)
The gnc_lot_is_closed() routine returns a boolean flag: is this lot closed? A lot is closed if its ba...
Definition: gnc-lot.c:365

◆ xaccAccountFindSplitByDesc()

Split* xaccAccountFindSplitByDesc ( const Account account,
const char *  description 
)

Returns a pointer to the split, not a copy.

Definition at line 4762 of file Account.cpp.

4763 {
4764  Split *split;
4765 
4766  /* Get the split which has a transaction matching the description. */
4767  finder_help_function(acc, description, &split, NULL);
4768  return split;
4769 }

◆ xaccAccountFindTransByDesc()

Transaction* xaccAccountFindTransByDesc ( const Account account,
const char *  description 
)

Returns a pointer to the transaction, not a copy.

Definition at line 4777 of file Account.cpp.

4778 {
4779  Transaction *trans;
4780 
4781  /* Get the translation matching the description. */
4782  finder_help_function(acc, description, NULL, &trans);
4783  return trans;
4784 }

◆ xaccAccountForEachLot()

gpointer xaccAccountForEachLot ( const Account acc,
gpointer(*)(GNCLot *lot, gpointer user_data)  proc,
gpointer  user_data 
)

The xaccAccountForEachLot() method will apply the function 'proc' to each lot in the account.

If 'proc' returns a non-NULL value, further application will be stopped, and the resulting value will be returned. There is no guaranteed order over which the Lots will be traversed.

◆ xaccAccountForEachTransaction()

gint xaccAccountForEachTransaction ( const Account account,
TransactionCallback  proc,
void *  data 
)

The xaccAccountForEachTransaction() routine will traverse all of the transactions in account and call the callback function proc on each transaction.

Processing will continue if-and-only-if proc returns 0. The user data pointer data will be passed on to the callback function proc.

This function does not descend recursively to traverse transactions in child accounts.

proc will be called exactly once for each transaction that is pointed to by at least one split in the given account.

The result of this function will be 0 if and only if every relevant transaction was traversed exactly once. Else the return value is the last non-zero value returned by proc.

Warning
For performance reasons, the transaction callback proc must never destroy any of the transaction's splits, nor assign any of them to a different account. To do so risks a crash.
The traversal occurs only over the transactions that are locally cached in the local gnucash engine. If the gnucash engine is attached to a remote database, the database may contain (many) transactions that are not mirrored in the local cache. This routine will not cause an SQL database query to be performed; it will not traverse transactions present only in the remote database.

Definition at line 5047 of file Account.cpp.

5049 {
5050  if (!acc || !proc) return 0;
5052  return xaccAccountStagedTransactionTraversal(acc, 42, proc, data);
5053 }
void xaccAccountBeginStagedTransactionTraversals(const Account *account)
xaccAccountBeginStagedTransactionTraversals() resets the traversal marker for each transaction which ...
Definition: Account.cpp:4902
int xaccAccountStagedTransactionTraversal(const Account *acc, unsigned int stage, TransactionCallback thunk, void *cb_data)
xaccAccountStagedTransactionTraversal() calls thunk on each transaction in account a whose current ma...
Definition: Account.cpp:4950

◆ xaccAccountGetDescendantPlaceholder()

GNCPlaceholderType xaccAccountGetDescendantPlaceholder ( const Account account)

Returns PLACEHOLDER_NONE if account is NULL or neither account nor any descendant of account is a placeholder.

If account is a placeholder, returns PLACEHOLDER_THIS. Otherwise, if any descendant of account is a placeholder, return PLACEHOLDER_CHILD.

Definition at line 3935 of file Account.cpp.

3936 {
3937  GList *descendants, *node;
3938  GNCPlaceholderType ret = PLACEHOLDER_NONE;
3939 
3940  g_return_val_if_fail(GNC_IS_ACCOUNT(acc), PLACEHOLDER_NONE);
3941  if (xaccAccountGetPlaceholder(acc)) return PLACEHOLDER_THIS;
3942 
3943  descendants = gnc_account_get_descendants(acc);
3944  for (node = descendants; node; node = node->next)
3945  if (xaccAccountGetPlaceholder((Account *) node->data))
3946  {
3947  ret = PLACEHOLDER_CHILD;
3948  break;
3949  }
3950 
3951  g_list_free(descendants);
3952  return ret;
3953 }
STRUCTS.
GList * gnc_account_get_descendants(const Account *account)
This routine returns a flat list of all of the accounts that are descendants of the specified account...
Definition: Account.cpp:2748
GNCPlaceholderType
DOCUMENT ME!
Definition: Account.h:1143
gboolean xaccAccountGetPlaceholder(const Account *acc)
Get the "placeholder" flag for an account.
Definition: Account.cpp:3923

◆ xaccAccountGetHidden()

gboolean xaccAccountGetHidden ( const Account acc)

Get the "hidden" flag for an account.

If this flag is set then the account (and any children) will be hidden from the user unless they explicitly ask to see them.

Parameters
accThe account whose flag should be retrieved.
Returns
The current state of the account's "hidden" flag.

Definition at line 3959 of file Account.cpp.

3960 {
3961  return boolean_from_key (acc, {"hidden"});
3962 }

◆ xaccAccountGetLotList()

LotList* xaccAccountGetLotList ( const Account account)

The xaccAccountGetLotList() routine returns a list of all lots in this account.

Parameters
accountThe account whose lots should be returned.
Returns
A GList of lot pointers, or NULL if there are no lots in this account children. It is the callers responsibility to free any returned list with the g_list_free() function.

Definition at line 3736 of file Account.cpp.

3737 {
3738  g_return_val_if_fail(GNC_IS_ACCOUNT(acc), NULL);
3739  return g_list_copy(GET_PRIVATE(acc)->lots);
3740 }

◆ xaccAccountGetPlaceholder()

gboolean xaccAccountGetPlaceholder ( const Account account)

Get the "placeholder" flag for an account.

If this flag is set then the account may not be modified by the user.

Parameters
accountThe account whose flag should be retrieved.
Returns
The current state of the account's "placeholder" flag.

Definition at line 3923 of file Account.cpp.

3924 {
3925  return boolean_from_key(acc, {"placeholder"});
3926 }

◆ xaccAccountGetSplitList()

SplitList* xaccAccountGetSplitList ( const Account account)

The xaccAccountGetSplitList() routine returns a pointer to a GList of the splits in the account.

Note
This GList is the account's internal data structure: do not delete it when done; treat it as a read-only structure. Note that some routines (such as xaccAccountRemoveSplit()) modify this list directly, and could leave you with a corrupted pointer.
This should be changed so that the returned value is a copy of the list. No other part of the code should have access to the internal data structure used by this object.

Definition at line 3709 of file Account.cpp.

3710 {
3711  g_return_val_if_fail(GNC_IS_ACCOUNT(acc), NULL);
3712  xaccAccountSortSplits((Account*)acc, FALSE); // normally a noop
3713  return GET_PRIVATE(acc)->splits;
3714 }
STRUCTS.
void xaccAccountSortSplits(Account *acc, gboolean force)
The xaccAccountSortSplits() routine will resort the account&#39;s splits if the sort is dirty...
Definition: Account.cpp:1788

◆ xaccAccountGetTypeStr()

const char* xaccAccountGetTypeStr ( GNCAccountType  type)

The xaccAccountGetTypeStr() routine returns a string suitable for use in the GUI/Interface.

These strings should be translated to the local language.

Definition at line 4126 of file Account.cpp.

4127 {
4128  if (type < 0 || NUM_ACCOUNT_TYPES <= type ) return "";
4129  return _(account_type_name [type]);
4130 }
stop here; the following types just aren&#39;t ready for prime time
Definition: Account.h:164

◆ xaccAccountInsertLot()

void xaccAccountInsertLot ( Account ,
GNCLot *   
)

The xaccAccountInsertLot() method will register the indicated lot with this account.

Any splits later inserted into this lot must belong to this account. If the lot is already in another account, the lot, and all of the splits in it, will be moved from that account to this account.

Definition at line 1927 of file Account.cpp.

1928 {
1929  AccountPrivate *priv, *opriv;
1930  Account * old_acc = NULL;
1931  Account* lot_account;
1932 
1933  /* errors */
1934  g_return_if_fail(GNC_IS_ACCOUNT(acc));
1935  g_return_if_fail(GNC_IS_LOT(lot));
1936 
1937  /* optimizations */
1938  lot_account = gnc_lot_get_account(lot);
1939  if (lot_account == acc)
1940  return;
1941 
1942  ENTER ("(acc=%p, lot=%p)", acc, lot);
1943 
1944  /* pull it out of the old account */
1945  if (lot_account)
1946  {
1947  old_acc = lot_account;
1948  opriv = GET_PRIVATE(old_acc);
1949  opriv->lots = g_list_remove(opriv->lots, lot);
1950  }
1951 
1952  priv = GET_PRIVATE(acc);
1953  priv->lots = g_list_prepend(priv->lots, lot);
1954  gnc_lot_set_account(lot, acc);
1955 
1956  /* Don't move the splits to the new account. The caller will do this
1957  * if appropriate, and doing it here will not work if we are being
1958  * called from gnc_book_close_period since xaccAccountInsertSplit
1959  * will try to balance capital gains and things aren't ready for that. */
1960 
1961  qof_event_gen (QOF_INSTANCE(lot), QOF_EVENT_ADD, NULL);
1962  qof_event_gen (&acc->inst, QOF_EVENT_MODIFY, NULL);
1963 
1964  LEAVE ("(acc=%p, lot=%p)", acc, lot);
1965 }
STRUCTS.
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:266
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:276
Account * gnc_lot_get_account(const GNCLot *lot)
The gnc_lot_get_account() routine returns the account with which this lot is associated.
Definition: gnc-lot.c:375
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

◆ xaccAccountIsAPARType()

gboolean xaccAccountIsAPARType ( GNCAccountType  t)

Convenience function to check if the account is a valid business account type (meaning an Accounts Payable/Accounts Receivable).

Definition at line 4254 of file Account.cpp.

4255 {
4256  switch (t)
4257  {
4258  case ACCT_TYPE_RECEIVABLE:
4259  case ACCT_TYPE_PAYABLE:
4260  return TRUE;
4261  default:
4262  return FALSE;
4263  }
4264 }
A/P account type.
Definition: Account.h:154
A/R account type.
Definition: Account.h:152

◆ xaccAccountIsAssetLiabType()

gboolean xaccAccountIsAssetLiabType ( GNCAccountType  t)

Convenience function to check if the account is a valid Asset or Liability type, but not a business account type (meaning not an Accounts Payable/Accounts Receivable).

Definition at line 4241 of file Account.cpp.

4242 {
4243  switch (t)
4244  {
4245  case ACCT_TYPE_RECEIVABLE:
4246  case ACCT_TYPE_PAYABLE:
4247  return FALSE;
4248  default:
4251  }
4252 }
gboolean xaccAccountTypesCompatible(GNCAccountType parent_type, GNCAccountType child_type)
Return TRUE if accounts of type parent_type can have accounts of type child_type as children...
Definition: Account.cpp:4223
A/P account type.
Definition: Account.h:154
asset (and liability) accounts indicate generic, generalized accounts that are none of the above...
Definition: Account.h:119
liability (and asset) accounts indicate generic, generalized accounts that are none of the above...
Definition: Account.h:122
A/R account type.
Definition: Account.h:152

◆ xaccAccountIsEquityType()

gboolean xaccAccountIsEquityType ( GNCAccountType  t)

Convenience function to check if the account is a valid Equity type.

Definition at line 4266 of file Account.cpp.

4267 {
4268  switch (t)
4269  {
4270  case ACCT_TYPE_EQUITY:
4271  return TRUE;
4272  default:
4273  return FALSE;
4274  }
4275 }
Equity account is used to balance the balance sheet.
Definition: Account.h:149

◆ xaccAccountIsHidden()

gboolean xaccAccountIsHidden ( const Account acc)

Should this account be "hidden".

If this flag is set for this account (or any parent account) then the account should be hidden from the user unless they explicitly ask to see it. This function is different from the xaccAccountGetHidden() function because it checks the flag in parent accounts in addition to this account.

Parameters
accThe account whose flag should be retrieved.
Returns
Whether or not this account should be "hidden".

Definition at line 3971 of file Account.cpp.

3972 {
3973  AccountPrivate *priv;
3974 
3975  g_return_val_if_fail(GNC_IS_ACCOUNT(acc), FALSE);
3976 
3977  if (xaccAccountGetHidden(acc))
3978  return TRUE;
3979  priv = GET_PRIVATE(acc);
3980  while ((acc = priv->parent) != NULL)
3981  {
3982  priv = GET_PRIVATE(acc);
3983  if (xaccAccountGetHidden(acc))
3984  return TRUE;
3985  }
3986  return FALSE;
3987 }
gboolean xaccAccountGetHidden(const Account *acc)
Get the "hidden" flag for an account.
Definition: Account.cpp:3959

◆ xaccAccountMoveAllSplits()

void xaccAccountMoveAllSplits ( Account accfrom,
Account accto 
)

The xaccAccountMoveAllSplits() routine reassigns each of the splits in accfrom to accto.

Definition at line 1987 of file Account.cpp.

1988 {
1989  AccountPrivate *from_priv;
1990 
1991  /* errors */
1992  g_return_if_fail(GNC_IS_ACCOUNT(accfrom));
1993  g_return_if_fail(GNC_IS_ACCOUNT(accto));
1994 
1995  /* optimizations */
1996  from_priv = GET_PRIVATE(accfrom);
1997  if (!from_priv->splits || accfrom == accto)
1998  return;
1999 
2000  /* check for book mix-up */
2001  g_return_if_fail (qof_instance_books_equal(accfrom, accto));
2002  ENTER ("(accfrom=%p, accto=%p)", accfrom, accto);
2003 
2004  xaccAccountBeginEdit(accfrom);
2005  xaccAccountBeginEdit(accto);
2006  /* Begin editing both accounts and all transactions in accfrom. */
2007  g_list_foreach(from_priv->splits, (GFunc)xaccPreSplitMove, NULL);
2008 
2009  /* Concatenate accfrom's lists of splits and lots to accto's lists. */
2010  //to_priv->splits = g_list_concat(to_priv->splits, from_priv->splits);
2011  //to_priv->lots = g_list_concat(to_priv->lots, from_priv->lots);
2012 
2013  /* Set appropriate flags. */
2014  //from_priv->balance_dirty = TRUE;
2015  //from_priv->sort_dirty = FALSE;
2016  //to_priv->balance_dirty = TRUE;
2017  //to_priv->sort_dirty = TRUE;
2018 
2019  /*
2020  * Change each split's account back pointer to accto.
2021  * Convert each split's amount to accto's commodity.
2022  * Commit to editing each transaction.
2023  */
2024  g_list_foreach(from_priv->splits, (GFunc)xaccPostSplitMove, (gpointer)accto);
2025 
2026  /* Finally empty accfrom. */
2027  g_assert(from_priv->splits == NULL);
2028  g_assert(from_priv->lots == NULL);
2029  xaccAccountCommitEdit(accfrom);
2030  xaccAccountCommitEdit(accto);
2031 
2032  LEAVE ("(accfrom=%p, accto=%p)", accfrom, accto);
2033 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:266
gboolean qof_instance_books_equal(gconstpointer ptr1, gconstpointer ptr2)
See if two QofInstances share the same book.
void xaccAccountBeginEdit(Account *acc)
The xaccAccountBeginEdit() subroutine is the first phase of a two-phase-commit wrapper for account up...
Definition: Account.cpp:1287
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:276
void xaccAccountCommitEdit(Account *acc)
ThexaccAccountCommitEdit() subroutine is the second phase of a two-phase-commit wrapper for account u...
Definition: Account.cpp:1328

◆ xaccAccountSetHidden()

void xaccAccountSetHidden ( Account acc,
gboolean  val 
)

Set the "hidden" flag for an account.

If this flag is set then the account (and any children) will be hidden from the user unless they explicitly ask to see them.

Parameters
accThe account whose flag should be retrieved.
valThe new state for the account's "hidden" flag.

Definition at line 3965 of file Account.cpp.

3966 {
3967  set_boolean_key (acc, {"hidden"}, val);
3968 }

◆ xaccAccountSetMark()

void xaccAccountSetMark ( Account account,
short  mark 
)

Set a mark on the account.

The meaning of this mark is completely undefined. Its presented here as a utility for the programmer, to use as desired. Handy for performing customer traversals over the account tree. The mark is not stored in the database/file format. When accounts are newly created, the mark is set to zero.

Definition at line 1846 of file Account.cpp.

1847 {
1848  AccountPrivate *priv;
1849 
1850  g_return_if_fail(GNC_IS_ACCOUNT(acc));
1851 
1852  priv = GET_PRIVATE(acc);
1853  priv->mark = m;
1854 }

◆ xaccAccountSetPlaceholder()

void xaccAccountSetPlaceholder ( Account account,
gboolean  val 
)

Set the "placeholder" flag for an account.

If this flag is set then the account may not be modified by the user.

Parameters
accountThe account whose flag should be retrieved.
valThe new state for the account's "placeholder" flag.

Definition at line 3929 of file Account.cpp.

3930 {
3931  set_boolean_key(acc, {"placeholder"}, val);
3932 }

◆ xaccAccountStagedTransactionTraversal()

int xaccAccountStagedTransactionTraversal ( const Account a,
unsigned int  stage,
TransactionCallback  thunk,
void *  data 
)

xaccAccountStagedTransactionTraversal() calls thunk on each transaction in account a whose current marker is less than the given stage and updates each transaction's marker to be stage.

The traversal will stop if thunk returns a non-zero value. xaccAccountStagedTransactionTraversal() function will return zero or the non-zero value returned by thunk. This API does not handle handle recursive traversals.

Warning
For performance reasons, the transaction callback thunk must never destroy any of the transaction's splits, nor assign any of them to a different account. To do so risks a crash.

Definition at line 4950 of file Account.cpp.

4954 {
4955  AccountPrivate *priv;
4956  GList *split_p;
4957  GList *next;
4958  Transaction *trans;
4959  Split *s;
4960  int retval;
4961 
4962  if (!acc) return 0;
4963 
4964  priv = GET_PRIVATE(acc);
4965  for (split_p = priv->splits; split_p; split_p = next)
4966  {
4967  /* Get the next element in the split list now, just in case some
4968  * naughty thunk destroys the one we're using. This reduces, but
4969  * does not eliminate, the possibility of undefined results if
4970  * a thunk removes splits from this account. */
4971  next = g_list_next(split_p);
4972 
4973  s = static_cast <Split*> (split_p->data);
4974  trans = s->parent;
4975  if (trans && (trans->marker < stage))
4976  {
4977  trans->marker = stage;
4978  if (thunk)
4979  {
4980  retval = thunk(trans, cb_data);
4981  if (retval) return retval;
4982  }
4983  }
4984  }
4985 
4986  return 0;
4987 }

◆ xaccAccountStringToEnum()

GNCAccountType xaccAccountStringToEnum ( const char *  str)

Conversion routines for the account types to/from strings that are used in persistent storage, communications.

These strings should not be translated to the local language. Typical conversion is "INCOME" -> ACCT_TYPE_INCOME.

Definition at line 4087 of file Account.cpp.

4088 {
4089  GNCAccountType type;
4090  gboolean rc;
4091  rc = xaccAccountStringToType(str, &type);
4092  if (FALSE == rc) return ACCT_TYPE_INVALID;
4093  return type;
4094 }
gboolean xaccAccountStringToType(const char *str, GNCAccountType *type)
Conversion routines for the account types to/from strings that are used in persistent storage...
Definition: Account.cpp:4053
GNCAccountType
The account types are used to determine how the transaction data in the account is displayed...
Definition: Account.h:105
Not a type.
Definition: Account.h:107

◆ xaccAccountStringToType()

gboolean xaccAccountStringToType ( const char *  str,
GNCAccountType type 
)

Conversion routines for the account types to/from strings that are used in persistent storage, communications.

These strings should not be translated to the local language. Typical conversion is "INCOME" -> ACCT_TYPE_INCOME.

Definition at line 4053 of file Account.cpp.

4054 {
4055 
4056  GNC_RETURN_ON_MATCH(NONE);
4057  GNC_RETURN_ON_MATCH(BANK);
4058  GNC_RETURN_ON_MATCH(CASH);
4059  GNC_RETURN_ON_MATCH(CREDIT);
4060  GNC_RETURN_ON_MATCH(ASSET);
4061  GNC_RETURN_ON_MATCH(LIABILITY);
4062  GNC_RETURN_ON_MATCH(STOCK);
4063  GNC_RETURN_ON_MATCH(MUTUAL);
4064  GNC_RETURN_ON_MATCH(CURRENCY);
4065  GNC_RETURN_ON_MATCH(INCOME);
4066  GNC_RETURN_ON_MATCH(EXPENSE);
4067  GNC_RETURN_ON_MATCH(EQUITY);
4068  GNC_RETURN_ON_MATCH(RECEIVABLE);
4069  GNC_RETURN_ON_MATCH(PAYABLE);
4070  GNC_RETURN_ON_MATCH(ROOT);
4071  GNC_RETURN_ON_MATCH(TRADING);
4072  GNC_RETURN_ON_MATCH(CHECKING);
4073  GNC_RETURN_ON_MATCH(SAVINGS);
4074  GNC_RETURN_ON_MATCH(MONEYMRKT);
4075  GNC_RETURN_ON_MATCH(CREDITLINE);
4076 
4077  PERR("asked to translate unknown account type string %s.\n",
4078  str ? str : "(null)");
4079 
4080  return(FALSE);
4081 }
#define PERR(format, args...)
Log a serious error.
Definition: qoflog.h:242

◆ xaccAccountTreeForEachTransaction()

int xaccAccountTreeForEachTransaction ( Account acc,
TransactionCallback  proc,
void *  data 
)

Traverse all of the transactions in the given account group.

Continue processing IF proc returns 0. This function will descend recursively to traverse transactions in the children of the accounts in the group.

Proc will be called exactly once for each transaction that is pointed to by at least one split in any account in the hierarchy topped by the root Account acc.

The result of this function will be 0 IF every relevant transaction was traversed exactly once; otherwise, the return value is the last non-zero value returned by the callback.

Warning
For performance reasons, the transaction callback proc must never destroy any of the transaction's splits, nor assign any of them to a different account. To do so risks a crash.
The traversal occurs only over the transactions that are locally cached in the local gnucash engine. If the gnucash engine is attached to a remote database, the database may contain (many) transactions that are not mirrored in the local cache. This routine will not cause an SQL database query to be performed; it will not traverse transactions present only in the remote database.

Note that this routine is just a trivial wrapper for

gnc_account_tree_begin_staged_transaction_traversals(g); gnc_account_tree_staged_transaction_traversal(g, 42, proc, data);

◆ xaccAccountTypeEnumAsString()

const char* xaccAccountTypeEnumAsString ( GNCAccountType  type)

Conversion routines for the account types to/from strings that are used in persistent storage, communications.

These strings should not be translated to the local language. Typical conversion is ACCT_TYPE_INCOME -> "INCOME".

Definition at line 4016 of file Account.cpp.

4017 {
4018  switch (type)
4019  {
4020  GNC_RETURN_ENUM_AS_STRING(NONE);
4021  GNC_RETURN_ENUM_AS_STRING(BANK);
4022  GNC_RETURN_ENUM_AS_STRING(CASH);
4023  GNC_RETURN_ENUM_AS_STRING(CREDIT);
4024  GNC_RETURN_ENUM_AS_STRING(ASSET);
4025  GNC_RETURN_ENUM_AS_STRING(LIABILITY);
4026  GNC_RETURN_ENUM_AS_STRING(STOCK);
4027  GNC_RETURN_ENUM_AS_STRING(MUTUAL);
4028  GNC_RETURN_ENUM_AS_STRING(CURRENCY);
4029  GNC_RETURN_ENUM_AS_STRING(INCOME);
4030  GNC_RETURN_ENUM_AS_STRING(EXPENSE);
4031  GNC_RETURN_ENUM_AS_STRING(EQUITY);
4032  GNC_RETURN_ENUM_AS_STRING(RECEIVABLE);
4033  GNC_RETURN_ENUM_AS_STRING(PAYABLE);
4034  GNC_RETURN_ENUM_AS_STRING(ROOT);
4035  GNC_RETURN_ENUM_AS_STRING(TRADING);
4036  GNC_RETURN_ENUM_AS_STRING(CHECKING);
4037  GNC_RETURN_ENUM_AS_STRING(SAVINGS);
4038  GNC_RETURN_ENUM_AS_STRING(MONEYMRKT);
4039  GNC_RETURN_ENUM_AS_STRING(CREDITLINE);
4040  default:
4041  PERR ("asked to translate unknown account type %d.\n", type);
4042  break;
4043  }
4044  return(NULL);
4045 }
#define PERR(format, args...)
Log a serious error.
Definition: qoflog.h:242

◆ xaccAccountTypesCompatible()

gboolean xaccAccountTypesCompatible ( GNCAccountType  parent_type,
GNCAccountType  child_type 
)

Return TRUE if accounts of type parent_type can have accounts of type child_type as children.

Definition at line 4223 of file Account.cpp.

4225 {
4226  return ((xaccParentAccountTypesCompatibleWith (parent_type) &
4227  (1 << child_type))
4228  != 0);
4229 }
guint32 xaccParentAccountTypesCompatibleWith(GNCAccountType type)
Return the bitmask of parent account types compatible with a given type.
Definition: Account.cpp:4176

◆ xaccAccountTypesCompatibleWith()

guint32 xaccAccountTypesCompatibleWith ( GNCAccountType  type)

Return the bitmask of account types compatible with a given type.

That is, you could switch to any of the account types in the compatible list without unwanted side-effects.

Definition at line 4136 of file Account.cpp.

4137 {
4138  switch (type)
4139  {
4140  case ACCT_TYPE_BANK:
4141  case ACCT_TYPE_CASH:
4142  case ACCT_TYPE_ASSET:
4143  case ACCT_TYPE_CREDIT:
4144  case ACCT_TYPE_LIABILITY:
4145  case ACCT_TYPE_INCOME:
4146  case ACCT_TYPE_EXPENSE:
4147  case ACCT_TYPE_EQUITY:
4148  return
4149  (1 << ACCT_TYPE_BANK) |
4150  (1 << ACCT_TYPE_CASH) |
4151  (1 << ACCT_TYPE_ASSET) |
4152  (1 << ACCT_TYPE_CREDIT) |
4153  (1 << ACCT_TYPE_LIABILITY) |
4154  (1 << ACCT_TYPE_INCOME) |
4155  (1 << ACCT_TYPE_EXPENSE) |
4156  (1 << ACCT_TYPE_EQUITY);
4157  case ACCT_TYPE_STOCK:
4158  case ACCT_TYPE_MUTUAL:
4159  case ACCT_TYPE_CURRENCY:
4160  return
4161  (1 << ACCT_TYPE_STOCK) |
4162  (1 << ACCT_TYPE_MUTUAL) |
4163  (1 << ACCT_TYPE_CURRENCY);
4164  case ACCT_TYPE_RECEIVABLE:
4165  return (1 << ACCT_TYPE_RECEIVABLE);
4166  case ACCT_TYPE_PAYABLE:
4167  return (1 << ACCT_TYPE_PAYABLE);
4168  case ACCT_TYPE_TRADING:
4169  return (1 << ACCT_TYPE_TRADING);
4170  default:
4171  PERR("bad account type: %d", type);
4172  return 0;
4173  }
4174 }
Expense accounts are used to denote expenses.
Definition: Account.h:146
Mutual Fund accounts will typically be shown in registers which show three columns: price...
Definition: Account.h:128
#define PERR(format, args...)
Log a serious error.
Definition: qoflog.h:242
The cash account type is used to denote a shoe-box or pillowcase stuffed with * cash.
Definition: Account.h:113
Account used to record multiple commodity transactions.
Definition: Account.h:158
Stock accounts will typically be shown in registers which show three columns: price, number of shares, and value.
Definition: Account.h:125
Income accounts are used to denote income.
Definition: Account.h:143
The bank account type denotes a savings or checking account held at a bank.
Definition: Account.h:110
A/P account type.
Definition: Account.h:154
asset (and liability) accounts indicate generic, generalized accounts that are none of the above...
Definition: Account.h:119
The currency account type indicates that the account is a currency trading account.
Definition: Account.h:132
liability (and asset) accounts indicate generic, generalized accounts that are none of the above...
Definition: Account.h:122
A/R account type.
Definition: Account.h:152
Equity account is used to balance the balance sheet.
Definition: Account.h:149
The Credit card account is used to denote credit (e.g.
Definition: Account.h:116

◆ xaccAccountTypesValid()

guint32 xaccAccountTypesValid ( void  )

Returns the bitmask of the account type enums that are valid.

Deprecated and root account types are stripped.

Definition at line 4232 of file Account.cpp.

4233 {
4234  guint32 mask = (1 << NUM_ACCOUNT_TYPES) - 1;
4235  mask &= ~((1 << ACCT_TYPE_CURRENCY) | /* DEPRECATED */
4236  (1 << ACCT_TYPE_ROOT)); /* ROOT */
4237 
4238  return mask;
4239 }
stop here; the following types just aren&#39;t ready for prime time
Definition: Account.h:164
The currency account type indicates that the account is a currency trading account.
Definition: Account.h:132
The hidden root account of an account tree.
Definition: Account.h:156

◆ xaccClearMark()

void xaccClearMark ( Account account,
short  val 
)

Get the mark set by xaccAccountSetMark short xaccAccountGetMark (const Account *account);.

The xaccClearMark will find the root account, and clear the mark in the entire account tree.

Definition at line 1857 of file Account.cpp.

1858 {
1859  Account *root;
1860 
1861  g_return_if_fail(GNC_IS_ACCOUNT(acc));
1862 
1863  root = gnc_account_get_root(acc);
1864  xaccClearMarkDown(root ? root : acc, val);
1865 }
STRUCTS.
void xaccClearMarkDown(Account *acc, short val)
The xaccClearMarkDown will clear the mark only in this and in sub-accounts.
Definition: Account.cpp:1868
Account * gnc_account_get_root(Account *acc)
This routine returns the root account of the account tree that the specified account belongs to...
Definition: Account.cpp:2623

◆ xaccClearMarkDown()

void xaccClearMarkDown ( Account account,
short  val 
)

The xaccClearMarkDown will clear the mark only in this and in sub-accounts.

Definition at line 1868 of file Account.cpp.

1869 {
1870  AccountPrivate *priv;
1871  GList *node;
1872 
1873  g_return_if_fail(GNC_IS_ACCOUNT(acc));
1874 
1875  priv = GET_PRIVATE(acc);
1876  priv->mark = val;
1877  for (node = priv->children; node; node = node->next)
1878  {
1879  xaccClearMarkDown(static_cast<Account*>(node->data), val);
1880  }
1881 }
void xaccClearMarkDown(Account *acc, short val)
The xaccClearMarkDown will clear the mark only in this and in sub-accounts.
Definition: Account.cpp:1868

◆ xaccParentAccountTypesCompatibleWith()

guint32 xaccParentAccountTypesCompatibleWith ( GNCAccountType  type)

Return the bitmask of parent account types compatible with a given type.

Definition at line 4176 of file Account.cpp.

4177 {
4178  switch (type)
4179  {
4180  case ACCT_TYPE_BANK:
4181  case ACCT_TYPE_CASH:
4182  case ACCT_TYPE_ASSET:
4183  case ACCT_TYPE_STOCK:
4184  case ACCT_TYPE_MUTUAL:
4185  case ACCT_TYPE_CURRENCY:
4186  case ACCT_TYPE_CREDIT:
4187  case ACCT_TYPE_LIABILITY:
4188  case ACCT_TYPE_RECEIVABLE:
4189  case ACCT_TYPE_PAYABLE:
4190  return
4191  (1 << ACCT_TYPE_BANK) |
4192  (1 << ACCT_TYPE_CASH) |
4193  (1 << ACCT_TYPE_ASSET) |
4194  (1 << ACCT_TYPE_STOCK) |
4195  (1 << ACCT_TYPE_MUTUAL) |
4196  (1 << ACCT_TYPE_CURRENCY) |
4197  (1 << ACCT_TYPE_CREDIT) |
4198  (1 << ACCT_TYPE_LIABILITY) |
4199  (1 << ACCT_TYPE_RECEIVABLE) |
4200  (1 << ACCT_TYPE_PAYABLE) |
4201  (1 << ACCT_TYPE_ROOT);
4202  case ACCT_TYPE_INCOME:
4203  case ACCT_TYPE_EXPENSE:
4204  return
4205  (1 << ACCT_TYPE_INCOME) |
4206  (1 << ACCT_TYPE_EXPENSE) |
4207  (1 << ACCT_TYPE_ROOT);
4208  case ACCT_TYPE_EQUITY:
4209  return
4210  (1 << ACCT_TYPE_EQUITY) |
4211  (1 << ACCT_TYPE_ROOT);
4212  case ACCT_TYPE_TRADING:
4213  return
4214  (1 << ACCT_TYPE_TRADING) |
4215  (1 << ACCT_TYPE_ROOT);
4216  default:
4217  PERR("bad account type: %d", type);
4218  return 0;
4219  }
4220 }
Expense accounts are used to denote expenses.
Definition: Account.h:146
Mutual Fund accounts will typically be shown in registers which show three columns: price...
Definition: Account.h:128
#define PERR(format, args...)
Log a serious error.
Definition: qoflog.h:242
The cash account type is used to denote a shoe-box or pillowcase stuffed with * cash.
Definition: Account.h:113
Account used to record multiple commodity transactions.
Definition: Account.h:158
Stock accounts will typically be shown in registers which show three columns: price, number of shares, and value.
Definition: Account.h:125
Income accounts are used to denote income.
Definition: Account.h:143
The bank account type denotes a savings or checking account held at a bank.
Definition: Account.h:110
A/P account type.
Definition: Account.h:154
asset (and liability) accounts indicate generic, generalized accounts that are none of the above...
Definition: Account.h:119
The currency account type indicates that the account is a currency trading account.
Definition: Account.h:132
liability (and asset) accounts indicate generic, generalized accounts that are none of the above...
Definition: Account.h:122
A/R account type.
Definition: Account.h:152
Equity account is used to balance the balance sheet.
Definition: Account.h:149
The hidden root account of an account tree.
Definition: Account.h:156
The Credit card account is used to denote credit (e.g.
Definition: Account.h:116

◆ xaccTransactionTraverse()

gboolean xaccTransactionTraverse ( Transaction *  trans,
int  stage 
)

xaccTransactionTraverse() checks the stage of the given transaction.

If the transaction hasn't reached the given stage, the transaction is updated to that stage and the function returns TRUE. Otherwise no change is made and the function returns FALSE.

Definition at line 4913 of file Account.cpp.

4914 {
4915  if (trans == NULL) return FALSE;
4916 
4917  if (trans->marker < stage)
4918  {
4919  trans->marker = stage;
4920  return TRUE;
4921  }
4922 
4923  return FALSE;
4924 }