GnuCash  3.4-22-g3ab5a2b+
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 3135 of file Account.cpp.

3136 {
3137  GValue v = G_VALUE_INIT;
3138  const char *s = NULL;
3139  gnc_commodity_table *table;
3140 
3141  if (!acc) return NULL;
3142  qof_instance_get_path_kvp (QOF_INSTANCE(acc), &v, {"old-currency"});
3143  if (G_VALUE_HOLDS_STRING (&v))
3144  s = g_value_get_string (&v);
3145  if (!s) return NULL;
3146 
3148 
3149  return gnc_commodity_table_lookup_unique (table, s);
3150 }
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 4664 of file Account.cpp.

4665 {
4666  GValue v = G_VALUE_INIT;
4667  if (!acc) return NULL;
4668  if (!xaccAccountIsPriced(acc)) return NULL;
4669  qof_instance_get_path_kvp (QOF_INSTANCE (acc), &v, {"old-quote-tz"});
4670  return G_VALUE_HOLDS_STRING (&v) ? g_value_get_string (&v) : NULL;
4671 }
gboolean xaccAccountIsPriced(const Account *acc)
Returns true if the account is a stock, mutual fund or currency, otherwise false. ...
Definition: Account.cpp:4269

◆ 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 2494 of file Account.cpp.

2495 {
2496  QofBook *book;
2497  GValue v = G_VALUE_INIT;
2498  const char *s = gnc_commodity_get_unique_name (currency);
2499  gnc_commodity *commodity;
2500  gnc_commodity_table *table;
2501 
2502  if ((!acc) || (!currency)) return;
2503  g_value_init (&v, G_TYPE_STRING);
2504  g_value_set_string (&v, s);
2505  qof_instance_set_path_kvp (QOF_INSTANCE (acc), &v, {"old-currency"});
2506  mark_account (acc);
2507  xaccAccountCommitEdit(acc);
2508 
2510  commodity = gnc_commodity_table_lookup_unique (table, s);
2511 
2512  if (!commodity)
2513  {
2514  book = qof_instance_get_book(acc);
2516  currency);
2517  }
2518 }
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:1334

◆ 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 4647 of file Account.cpp.

4648 {
4649  GValue v = G_VALUE_INIT;
4650  if (!acc) return;
4651  if (!xaccAccountIsPriced(acc)) return;
4652  xaccAccountBeginEdit(acc);
4653  g_value_init (&v, G_TYPE_STRING);
4654  g_value_set_string (&v, tz);
4655  qof_instance_set_path_kvp (QOF_INSTANCE (acc), &v, {"old-quote-tz"});
4656  mark_account (acc);
4657  xaccAccountCommitEdit(acc);
4658 }
gboolean xaccAccountIsPriced(const Account *acc)
Returns true if the account is a stock, mutual fund or currency, otherwise false. ...
Definition: Account.cpp:4269
void xaccAccountBeginEdit(Account *acc)
The xaccAccountBeginEdit() subroutine is the first phase of a two-phase-commit wrapper for account up...
Definition: Account.cpp:1293
void xaccAccountCommitEdit(Account *acc)
ThexaccAccountCommitEdit() subroutine is the second phase of a two-phase-commit wrapper for account u...
Definition: Account.cpp:1334

◆ 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 5417 of file Account.cpp.

5418 {
5419  if (!imap)
5420  return nullptr;
5421  check_import_map_data (imap->book);
5422  auto first_pass = get_first_pass_probabilities(imap, tokens);
5423  if (!first_pass.size())
5424  return nullptr;
5425  auto final_probabilities = build_probabilities(first_pass);
5426  if (!final_probabilities.size())
5427  return nullptr;
5428  auto best = highest_probability(final_probabilities);
5429  if (best.account_guid == "")
5430  return nullptr;
5431  if (best.probability < threshold)
5432  return nullptr;
5433  gnc::GUID guid;
5434  try {
5435  guid = gnc::GUID::from_string(best.account_guid);
5436  } catch (gnc::guid_syntax_exception&) {
5437  return nullptr;
5438  }
5439  auto account = xaccAccountLookup (reinterpret_cast<GncGUID*>(&guid), imap->book);
5440  return account;
5441 }
Account * xaccAccountLookup(const GncGUID *guid, QofBook *book)
The xaccAccountLookup() subroutine will return the account associated with the given id...
Definition: Account.cpp:1840

◆ 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 2802 of file Account.cpp.

2803 {
2804  AccountPrivate *cpriv, *ppriv;
2805  Account *child, *result;
2806  GList *node;
2807 
2808  g_return_val_if_fail(GNC_IS_ACCOUNT(parent), NULL);
2809  g_return_val_if_fail(name, NULL);
2810 
2811  /* first, look for accounts hanging off the current node */
2812  ppriv = GET_PRIVATE(parent);
2813  for (node = ppriv->children; node; node = node->next)
2814  {
2815  child = static_cast<Account*>(node->data);
2816  cpriv = GET_PRIVATE(child);
2817  if (g_strcmp0(cpriv->accountName, name) == 0)
2818  return child;
2819  }
2820 
2821  /* if we are still here, then we haven't found the account yet.
2822  * Recursively search each of the child accounts next */
2823  for (node = ppriv->children; node; node = node->next)
2824  {
2825  child = static_cast<Account*>(node->data);
2826  result = gnc_account_lookup_by_name (child, name);
2827  if (result)
2828  return result;
2829  }
2830 
2831  return NULL;
2832 }
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:2802

◆ 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 4931 of file Account.cpp.

4932 {
4933  GList *descendants;
4934 
4935  descendants = gnc_account_get_descendants(account);
4936  g_list_foreach(descendants, (GFunc)do_one_account, NULL);
4937  g_list_free(descendants);
4938 }
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:2754

◆ 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 4981 of file Account.cpp.

4985 {
4986  const AccountPrivate *priv;
4987  GList *acc_p, *split_p;
4988  Transaction *trans;
4989  Split *s;
4990  int retval;
4991 
4992  if (!acc) return 0;
4993 
4994  /* depth first traversal */
4995  priv = GET_PRIVATE(acc);
4996  for (acc_p = priv->children; acc_p; acc_p = g_list_next(acc_p))
4997  {
4998  retval = gnc_account_tree_staged_transaction_traversal(static_cast <Account*> (acc_p->data),
4999  stage, thunk, cb_data);
5000  if (retval) return retval;
5001  }
5002 
5003  /* Now this account */
5004  for (split_p = priv->splits; split_p; split_p = g_list_next(split_p))
5005  {
5006  s = static_cast <Split*> (split_p->data);
5007  trans = s->parent;
5008  if (trans && (trans->marker < stage))
5009  {
5010  trans->marker = stage;
5011  if (thunk)
5012  {
5013  retval = thunk(trans, cb_data);
5014  if (retval) return retval;
5015  }
5016  }
5017  }
5018 
5019  return 0;
5020 }
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:4981

◆ 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 3709 of file Account.cpp.

3710 {
3711  gint64 nr, i;
3712 
3713  g_return_val_if_fail(GNC_IS_ACCOUNT(acc), 0);
3714 
3715  nr = g_list_length(xaccAccountGetSplitList(acc));
3716  if (include_children && (gnc_account_n_children(acc) != 0))
3717  {
3718  for (i=0; i < gnc_account_n_children(acc); i++)
3719  {
3720  nr += xaccAccountCountSplits(gnc_account_nth_child(acc, i), TRUE);
3721  }
3722  }
3723  return nr;
3724 }
SplitList * xaccAccountGetSplitList(const Account *acc)
The xaccAccountGetSplitList() routine returns a pointer to a GList of the splits in the account...
Definition: Account.cpp:3701
gint gnc_account_n_children(const Account *account)
Return the number of children of the specified account.
Definition: Account.cpp:2675
gint64 xaccAccountCountSplits(const Account *acc, gboolean include_children)
The xaccAccountCountSplits() routine returns the number of all the splits in the account.
Definition: Account.cpp:3709
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:2690

◆ 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 3734 of file Account.cpp.

3738 {
3739  AccountPrivate *priv;
3740  GList *lot_list;
3741  GList *retval = NULL;
3742 
3743  g_return_val_if_fail(GNC_IS_ACCOUNT(acc), NULL);
3744 
3745  priv = GET_PRIVATE(acc);
3746  for (lot_list = priv->lots; lot_list; lot_list = lot_list->next)
3747  {
3748  GNCLot *lot = static_cast<GNCLot*>(lot_list->data);
3749 
3750  /* If this lot is closed, then ignore it */
3751  if (gnc_lot_is_closed (lot))
3752  continue;
3753 
3754  if (match_func && !(match_func)(lot, user_data))
3755  continue;
3756 
3757  /* Ok, this is a valid lot. Add it to our list of lots */
3758  if (sort_func)
3759  retval = g_list_insert_sorted (retval, lot, sort_func);
3760  else
3761  retval = g_list_prepend (retval, lot);
3762  }
3763 
3764  return retval;
3765 }
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 4753 of file Account.cpp.

4754 {
4755  Split *split;
4756 
4757  /* Get the split which has a transaction matching the description. */
4758  finder_help_function(acc, description, &split, NULL);
4759  return split;
4760 }

◆ xaccAccountFindTransByDesc()

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

Returns a pointer to the transaction, not a copy.

Definition at line 4768 of file Account.cpp.

4769 {
4770  Transaction *trans;
4771 
4772  /* Get the translation matching the description. */
4773  finder_help_function(acc, description, NULL, &trans);
4774  return trans;
4775 }

◆ 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 5038 of file Account.cpp.

5040 {
5041  if (!acc || !proc) return 0;
5043  return xaccAccountStagedTransactionTraversal(acc, 42, proc, data);
5044 }
void xaccAccountBeginStagedTransactionTraversals(const Account *account)
xaccAccountBeginStagedTransactionTraversals() resets the traversal marker for each transaction which ...
Definition: Account.cpp:4893
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:4941

◆ 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 3926 of file Account.cpp.

3927 {
3928  GList *descendants, *node;
3929  GNCPlaceholderType ret = PLACEHOLDER_NONE;
3930 
3931  g_return_val_if_fail(GNC_IS_ACCOUNT(acc), PLACEHOLDER_NONE);
3932  if (xaccAccountGetPlaceholder(acc)) return PLACEHOLDER_THIS;
3933 
3934  descendants = gnc_account_get_descendants(acc);
3935  for (node = descendants; node; node = node->next)
3936  if (xaccAccountGetPlaceholder((Account *) node->data))
3937  {
3938  ret = PLACEHOLDER_CHILD;
3939  break;
3940  }
3941 
3942  g_list_free(descendants);
3943  return ret;
3944 }
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:2754
GNCPlaceholderType
DOCUMENT ME!
Definition: Account.h:1143
gboolean xaccAccountGetPlaceholder(const Account *acc)
Get the "placeholder" flag for an account.
Definition: Account.cpp:3914

◆ 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 3950 of file Account.cpp.

3951 {
3952  return boolean_from_key (acc, {"hidden"});
3953 }

◆ 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 3727 of file Account.cpp.

3728 {
3729  g_return_val_if_fail(GNC_IS_ACCOUNT(acc), NULL);
3730  return g_list_copy(GET_PRIVATE(acc)->lots);
3731 }

◆ 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 3914 of file Account.cpp.

3915 {
3916  return boolean_from_key(acc, {"placeholder"});
3917 }

◆ 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 3701 of file Account.cpp.

3702 {
3703  g_return_val_if_fail(GNC_IS_ACCOUNT(acc), NULL);
3704  xaccAccountSortSplits((Account*)acc, FALSE); // normally a noop
3705  return GET_PRIVATE(acc)->splits;
3706 }
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:1794

◆ 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 4117 of file Account.cpp.

4118 {
4119  if (type < 0 || NUM_ACCOUNT_TYPES <= type ) return "";
4120  return _(account_type_name [type]);
4121 }
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 1933 of file Account.cpp.

1934 {
1935  AccountPrivate *priv, *opriv;
1936  Account * old_acc = NULL;
1937  Account* lot_account;
1938 
1939  /* errors */
1940  g_return_if_fail(GNC_IS_ACCOUNT(acc));
1941  g_return_if_fail(GNC_IS_LOT(lot));
1942 
1943  /* optimizations */
1944  lot_account = gnc_lot_get_account(lot);
1945  if (lot_account == acc)
1946  return;
1947 
1948  ENTER ("(acc=%p, lot=%p)", acc, lot);
1949 
1950  /* pull it out of the old account */
1951  if (lot_account)
1952  {
1953  old_acc = lot_account;
1954  opriv = GET_PRIVATE(old_acc);
1955  opriv->lots = g_list_remove(opriv->lots, lot);
1956  }
1957 
1958  priv = GET_PRIVATE(acc);
1959  priv->lots = g_list_prepend(priv->lots, lot);
1960  gnc_lot_set_account(lot, acc);
1961 
1962  /* Don't move the splits to the new account. The caller will do this
1963  * if appropriate, and doing it here will not work if we are being
1964  * called from gnc_book_close_period since xaccAccountInsertSplit
1965  * will try to balance capital gains and things aren't ready for that. */
1966 
1967  qof_event_gen (QOF_INSTANCE(lot), QOF_EVENT_ADD, NULL);
1968  qof_event_gen (&acc->inst, QOF_EVENT_MODIFY, NULL);
1969 
1970  LEAVE ("(acc=%p, lot=%p)", acc, lot);
1971 }
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 4245 of file Account.cpp.

4246 {
4247  switch (t)
4248  {
4249  case ACCT_TYPE_RECEIVABLE:
4250  case ACCT_TYPE_PAYABLE:
4251  return TRUE;
4252  default:
4253  return FALSE;
4254  }
4255 }
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 4232 of file Account.cpp.

4233 {
4234  switch (t)
4235  {
4236  case ACCT_TYPE_RECEIVABLE:
4237  case ACCT_TYPE_PAYABLE:
4238  return FALSE;
4239  default:
4242  }
4243 }
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:4214
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 4257 of file Account.cpp.

4258 {
4259  switch (t)
4260  {
4261  case ACCT_TYPE_EQUITY:
4262  return TRUE;
4263  default:
4264  return FALSE;
4265  }
4266 }
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 3962 of file Account.cpp.

3963 {
3964  AccountPrivate *priv;
3965 
3966  g_return_val_if_fail(GNC_IS_ACCOUNT(acc), FALSE);
3967 
3968  if (xaccAccountGetHidden(acc))
3969  return TRUE;
3970  priv = GET_PRIVATE(acc);
3971  while ((acc = priv->parent) != NULL)
3972  {
3973  priv = GET_PRIVATE(acc);
3974  if (xaccAccountGetHidden(acc))
3975  return TRUE;
3976  }
3977  return FALSE;
3978 }
gboolean xaccAccountGetHidden(const Account *acc)
Get the "hidden" flag for an account.
Definition: Account.cpp:3950

◆ xaccAccountMoveAllSplits()

void xaccAccountMoveAllSplits ( Account accfrom,
Account accto 
)

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

Definition at line 1993 of file Account.cpp.

1994 {
1995  AccountPrivate *from_priv;
1996 
1997  /* errors */
1998  g_return_if_fail(GNC_IS_ACCOUNT(accfrom));
1999  g_return_if_fail(GNC_IS_ACCOUNT(accto));
2000 
2001  /* optimizations */
2002  from_priv = GET_PRIVATE(accfrom);
2003  if (!from_priv->splits || accfrom == accto)
2004  return;
2005 
2006  /* check for book mix-up */
2007  g_return_if_fail (qof_instance_books_equal(accfrom, accto));
2008  ENTER ("(accfrom=%p, accto=%p)", accfrom, accto);
2009 
2010  xaccAccountBeginEdit(accfrom);
2011  xaccAccountBeginEdit(accto);
2012  /* Begin editing both accounts and all transactions in accfrom. */
2013  g_list_foreach(from_priv->splits, (GFunc)xaccPreSplitMove, NULL);
2014 
2015  /* Concatenate accfrom's lists of splits and lots to accto's lists. */
2016  //to_priv->splits = g_list_concat(to_priv->splits, from_priv->splits);
2017  //to_priv->lots = g_list_concat(to_priv->lots, from_priv->lots);
2018 
2019  /* Set appropriate flags. */
2020  //from_priv->balance_dirty = TRUE;
2021  //from_priv->sort_dirty = FALSE;
2022  //to_priv->balance_dirty = TRUE;
2023  //to_priv->sort_dirty = TRUE;
2024 
2025  /*
2026  * Change each split's account back pointer to accto.
2027  * Convert each split's amount to accto's commodity.
2028  * Commit to editing each transaction.
2029  */
2030  g_list_foreach(from_priv->splits, (GFunc)xaccPostSplitMove, (gpointer)accto);
2031 
2032  /* Finally empty accfrom. */
2033  g_assert(from_priv->splits == NULL);
2034  g_assert(from_priv->lots == NULL);
2035  xaccAccountCommitEdit(accfrom);
2036  xaccAccountCommitEdit(accto);
2037 
2038  LEAVE ("(accfrom=%p, accto=%p)", accfrom, accto);
2039 }
#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:1293
#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:1334

◆ 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 3956 of file Account.cpp.

3957 {
3958  set_boolean_key (acc, {"hidden"}, val);
3959 }

◆ 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 1852 of file Account.cpp.

1853 {
1854  AccountPrivate *priv;
1855 
1856  g_return_if_fail(GNC_IS_ACCOUNT(acc));
1857 
1858  priv = GET_PRIVATE(acc);
1859  priv->mark = m;
1860 }

◆ 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 3920 of file Account.cpp.

3921 {
3922  set_boolean_key(acc, {"placeholder"}, val);
3923 }

◆ 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 4941 of file Account.cpp.

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

◆ 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 4078 of file Account.cpp.

4079 {
4080  GNCAccountType type;
4081  gboolean rc;
4082  rc = xaccAccountStringToType(str, &type);
4083  if (FALSE == rc) return ACCT_TYPE_INVALID;
4084  return type;
4085 }
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:4044
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 4044 of file Account.cpp.

4045 {
4046 
4047  GNC_RETURN_ON_MATCH(NONE);
4048  GNC_RETURN_ON_MATCH(BANK);
4049  GNC_RETURN_ON_MATCH(CASH);
4050  GNC_RETURN_ON_MATCH(CREDIT);
4051  GNC_RETURN_ON_MATCH(ASSET);
4052  GNC_RETURN_ON_MATCH(LIABILITY);
4053  GNC_RETURN_ON_MATCH(STOCK);
4054  GNC_RETURN_ON_MATCH(MUTUAL);
4055  GNC_RETURN_ON_MATCH(CURRENCY);
4056  GNC_RETURN_ON_MATCH(INCOME);
4057  GNC_RETURN_ON_MATCH(EXPENSE);
4058  GNC_RETURN_ON_MATCH(EQUITY);
4059  GNC_RETURN_ON_MATCH(RECEIVABLE);
4060  GNC_RETURN_ON_MATCH(PAYABLE);
4061  GNC_RETURN_ON_MATCH(ROOT);
4062  GNC_RETURN_ON_MATCH(TRADING);
4063  GNC_RETURN_ON_MATCH(CHECKING);
4064  GNC_RETURN_ON_MATCH(SAVINGS);
4065  GNC_RETURN_ON_MATCH(MONEYMRKT);
4066  GNC_RETURN_ON_MATCH(CREDITLINE);
4067 
4068  PERR("asked to translate unknown account type string %s.\n",
4069  str ? str : "(null)");
4070 
4071  return(FALSE);
4072 }
#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 4007 of file Account.cpp.

4008 {
4009  switch (type)
4010  {
4011  GNC_RETURN_ENUM_AS_STRING(NONE);
4012  GNC_RETURN_ENUM_AS_STRING(BANK);
4013  GNC_RETURN_ENUM_AS_STRING(CASH);
4014  GNC_RETURN_ENUM_AS_STRING(CREDIT);
4015  GNC_RETURN_ENUM_AS_STRING(ASSET);
4016  GNC_RETURN_ENUM_AS_STRING(LIABILITY);
4017  GNC_RETURN_ENUM_AS_STRING(STOCK);
4018  GNC_RETURN_ENUM_AS_STRING(MUTUAL);
4019  GNC_RETURN_ENUM_AS_STRING(CURRENCY);
4020  GNC_RETURN_ENUM_AS_STRING(INCOME);
4021  GNC_RETURN_ENUM_AS_STRING(EXPENSE);
4022  GNC_RETURN_ENUM_AS_STRING(EQUITY);
4023  GNC_RETURN_ENUM_AS_STRING(RECEIVABLE);
4024  GNC_RETURN_ENUM_AS_STRING(PAYABLE);
4025  GNC_RETURN_ENUM_AS_STRING(ROOT);
4026  GNC_RETURN_ENUM_AS_STRING(TRADING);
4027  GNC_RETURN_ENUM_AS_STRING(CHECKING);
4028  GNC_RETURN_ENUM_AS_STRING(SAVINGS);
4029  GNC_RETURN_ENUM_AS_STRING(MONEYMRKT);
4030  GNC_RETURN_ENUM_AS_STRING(CREDITLINE);
4031  default:
4032  PERR ("asked to translate unknown account type %d.\n", type);
4033  break;
4034  }
4035  return(NULL);
4036 }
#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 4214 of file Account.cpp.

4216 {
4217  return ((xaccParentAccountTypesCompatibleWith (parent_type) &
4218  (1 << child_type))
4219  != 0);
4220 }
guint32 xaccParentAccountTypesCompatibleWith(GNCAccountType type)
Return the bitmask of parent account types compatible with a given type.
Definition: Account.cpp:4167

◆ 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 4127 of file Account.cpp.

4128 {
4129  switch (type)
4130  {
4131  case ACCT_TYPE_BANK:
4132  case ACCT_TYPE_CASH:
4133  case ACCT_TYPE_ASSET:
4134  case ACCT_TYPE_CREDIT:
4135  case ACCT_TYPE_LIABILITY:
4136  case ACCT_TYPE_INCOME:
4137  case ACCT_TYPE_EXPENSE:
4138  case ACCT_TYPE_EQUITY:
4139  return
4140  (1 << ACCT_TYPE_BANK) |
4141  (1 << ACCT_TYPE_CASH) |
4142  (1 << ACCT_TYPE_ASSET) |
4143  (1 << ACCT_TYPE_CREDIT) |
4144  (1 << ACCT_TYPE_LIABILITY) |
4145  (1 << ACCT_TYPE_INCOME) |
4146  (1 << ACCT_TYPE_EXPENSE) |
4147  (1 << ACCT_TYPE_EQUITY);
4148  case ACCT_TYPE_STOCK:
4149  case ACCT_TYPE_MUTUAL:
4150  case ACCT_TYPE_CURRENCY:
4151  return
4152  (1 << ACCT_TYPE_STOCK) |
4153  (1 << ACCT_TYPE_MUTUAL) |
4154  (1 << ACCT_TYPE_CURRENCY);
4155  case ACCT_TYPE_RECEIVABLE:
4156  return (1 << ACCT_TYPE_RECEIVABLE);
4157  case ACCT_TYPE_PAYABLE:
4158  return (1 << ACCT_TYPE_PAYABLE);
4159  case ACCT_TYPE_TRADING:
4160  return (1 << ACCT_TYPE_TRADING);
4161  default:
4162  PERR("bad account type: %d", type);
4163  return 0;
4164  }
4165 }
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 4223 of file Account.cpp.

4224 {
4225  guint32 mask = (1 << NUM_ACCOUNT_TYPES) - 1;
4226  mask &= ~((1 << ACCT_TYPE_CURRENCY) | /* DEPRECATED */
4227  (1 << ACCT_TYPE_ROOT)); /* ROOT */
4228 
4229  return mask;
4230 }
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 1863 of file Account.cpp.

1864 {
1865  Account *root;
1866 
1867  g_return_if_fail(GNC_IS_ACCOUNT(acc));
1868 
1869  root = gnc_account_get_root(acc);
1870  xaccClearMarkDown(root ? root : acc, val);
1871 }
STRUCTS.
void xaccClearMarkDown(Account *acc, short val)
The xaccClearMarkDown will clear the mark only in this and in sub-accounts.
Definition: Account.cpp:1874
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:2629

◆ xaccClearMarkDown()

void xaccClearMarkDown ( Account account,
short  val 
)

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

Definition at line 1874 of file Account.cpp.

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

◆ xaccParentAccountTypesCompatibleWith()

guint32 xaccParentAccountTypesCompatibleWith ( GNCAccountType  type)

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

Definition at line 4167 of file Account.cpp.

4168 {
4169  switch (type)
4170  {
4171  case ACCT_TYPE_BANK:
4172  case ACCT_TYPE_CASH:
4173  case ACCT_TYPE_ASSET:
4174  case ACCT_TYPE_STOCK:
4175  case ACCT_TYPE_MUTUAL:
4176  case ACCT_TYPE_CURRENCY:
4177  case ACCT_TYPE_CREDIT:
4178  case ACCT_TYPE_LIABILITY:
4179  case ACCT_TYPE_RECEIVABLE:
4180  case ACCT_TYPE_PAYABLE:
4181  return
4182  (1 << ACCT_TYPE_BANK) |
4183  (1 << ACCT_TYPE_CASH) |
4184  (1 << ACCT_TYPE_ASSET) |
4185  (1 << ACCT_TYPE_STOCK) |
4186  (1 << ACCT_TYPE_MUTUAL) |
4187  (1 << ACCT_TYPE_CURRENCY) |
4188  (1 << ACCT_TYPE_CREDIT) |
4189  (1 << ACCT_TYPE_LIABILITY) |
4190  (1 << ACCT_TYPE_RECEIVABLE) |
4191  (1 << ACCT_TYPE_PAYABLE) |
4192  (1 << ACCT_TYPE_ROOT);
4193  case ACCT_TYPE_INCOME:
4194  case ACCT_TYPE_EXPENSE:
4195  return
4196  (1 << ACCT_TYPE_INCOME) |
4197  (1 << ACCT_TYPE_EXPENSE) |
4198  (1 << ACCT_TYPE_ROOT);
4199  case ACCT_TYPE_EQUITY:
4200  return
4201  (1 << ACCT_TYPE_EQUITY) |
4202  (1 << ACCT_TYPE_ROOT);
4203  case ACCT_TYPE_TRADING:
4204  return
4205  (1 << ACCT_TYPE_TRADING) |
4206  (1 << ACCT_TYPE_ROOT);
4207  default:
4208  PERR("bad account type: %d", type);
4209  return 0;
4210  }
4211 }
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 4904 of file Account.cpp.

4905 {
4906  if (trans == NULL) return FALSE;
4907 
4908  if (trans->marker < stage)
4909  {
4910  trans->marker = stage;
4911  return TRUE;
4912  }
4913 
4914  return FALSE;
4915 }