GnuCash  2.7.0
Files | Data Structures | Macros | Typedefs | Functions

A commodity is something of value that is easily tradeable or sellable; for example, currencies, stocks, bonds, grain, copper, and oil are all commodities. More...

Files

file  gnc-commodity.h
 Commodity handling public routines.
 

Data Structures

struct  gnc_monetary
 

Macros

#define GNC_TYPE_COMMODITY   (gnc_commodity_get_type ())
 
#define GNC_COMMODITY(o)   (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_COMMODITY, gnc_commodity))
 
#define GNC_COMMODITY_CLASS(k)   (G_TYPE_CHECK_CLASS_CAST((k), GNC_TYPE_COMMODITY, gnc_commodityClass))
 
#define GNC_IS_COMMODITY(o)   (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_COMMODITY))
 
#define GNC_IS_COMMODITY_CLASS(k)   (G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_COMMODITY))
 
#define GNC_COMMODITY_GET_CLASS(o)   (G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_COMMODITY, gnc_commodityClass))
 
#define GNC_TYPE_COMMODITY_NAMESPACE   (gnc_commodity_namespace_get_type ())
 
#define GNC_COMMODITY_NAMESPACE(o)   (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_COMMODITY_NAMESPACE, gnc_commodity_namespace))
 
#define GNC_COMMODITY_NAMESPACE_CLASS(k)   (G_TYPE_CHECK_CLASS_CAST((k), GNC_TYPE_COMMODITY_NAMESPACE, gnc_commodity_namespaceClass))
 
#define GNC_IS_COMMODITY_NAMESPACE(o)   (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_COMMODITY_NAMESPACE))
 
#define GNC_IS_COMMODITY_NAMESPACE_CLASS(k)   (G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_COMMODITY_NAMESPACE))
 
#define GNC_COMMODITY_NAMESPACE_GET_CLASS(o)   (G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_COMMODITY_NAMESPACE, gnc_commodity_namespaceClass))
 
#define GNC_COMMODITY_TABLE   "gnc_commodity_table"
 
#define GNC_COMMODITY_NS_LEGACY   "GNC_LEGACY_CURRENCIES"
 The commodity namespace definitions are used to tag a commodity by its type, or a stocks by the exchange where it is traded. More...
 
#define GNC_COMMODITY_NS_TEMPLATE   "template"
 
#define GNC_COMMODITY_NS_ISO   "ISO4217"
 
#define GNC_COMMODITY_NS_CURRENCY   "CURRENCY"
 
#define GNC_COMMODITY_NS_NASDAQ   "NASDAQ"
 
#define GNC_COMMODITY_NS_NYSE   "NYSE"
 
#define GNC_COMMODITY_NS_EUREX   "EUREX"
 
#define GNC_COMMODITY_NS_MUTUAL   "FUND"
 
#define GNC_COMMODITY_NS_AMEX   "AMEX"
 
#define GNC_COMMODITY_NS_ASX   "ASX"
 
#define GNC_COMMODITY_NS_NONCURRENCY   _("All non-currency")
 
#define GNC_COMMODITY_NS_ISO_GUI   N_("Currencies")
 

Typedefs

typedef GList CommodityList
 

Functions

GType gnc_commodity_get_type (void)
 
GType gnc_commodity_namespace_get_type (void)
 

Commodity Quote Source functions

enum  QuoteSourceType {
  SOURCE_SINGLE = 0, SOURCE_MULTI, SOURCE_UNKNOWN, SOURCE_MAX,
  SOURCE_CURRENCY = SOURCE_MAX
}
 The quote source type enum account types are used to determine how the transaction data in the account is displayed. More...
 
gboolean gnc_quote_source_fq_installed (void)
 This function indicates whether or not the Finance::Quote module is installed on a users computer. More...
 
void gnc_quote_source_set_fq_installed (const GList *sources_list)
 Update gnucash internal tables based on what Finance::Quote sources are installed. More...
 
gint gnc_quote_source_num_entries (QuoteSourceType type)
 Return the number of entries for a given type of quote source. More...
 
gnc_quote_source * gnc_quote_source_add_new (const char *name, gboolean supported)
 Create a new quote source. More...
 
gnc_quote_source * gnc_quote_source_lookup_by_internal (const char *internal_name)
 Given the internal (gnucash or F::Q) name of a quote source, find the data structure identified by this name. More...
 
gnc_quote_source * gnc_quote_source_lookup_by_ti (QuoteSourceType type, gint index)
 Given the type/index of a quote source, find the data structure identified by this pair. More...
 
gboolean gnc_quote_source_get_supported (const gnc_quote_source *source)
 Given a gnc_quote_source data structure, return the flag that indicates whether this particular quote source is supported by the user's F::Q installation. More...
 
QuoteSourceType gnc_quote_source_get_type (const gnc_quote_source *source)
 Given a gnc_quote_source data structure, return the type of this particular quote source. More...
 
gint gnc_quote_source_get_index (const gnc_quote_source *source)
 Given a gnc_quote_source data structure, return the index of this particular quote source within its type. More...
 
const char * gnc_quote_source_get_user_name (const gnc_quote_source *source)
 Given a gnc_quote_source data structure, return the user friendly name of this quote source. More...
 
const char * gnc_quote_source_get_internal_name (const gnc_quote_source *source)
 Given a gnc_quote_source data structure, return the internal name of this quote source. More...
 

Commodity Creation

gnc_commodity * gnc_commodity_new (QofBook *book, const char *fullname, const char *commodity_namespace, const char *mnemonic, const char *cusip, int fraction)
 Create a new commodity. More...
 
void gnc_commodity_destroy (gnc_commodity *cm)
 Destroy a commodity. More...
 
void gnc_commodity_copy (gnc_commodity *dest, const gnc_commodity *src)
 Copy src into dest.
 
gnc_commodity * gnc_commodity_clone (const gnc_commodity *src, QofBook *dest_book)
 allocate and copy
 

Commodity Accessor Routines - Get

const char * gnc_commodity_get_mnemonic (const gnc_commodity *cm)
 Retrieve the mnemonic for the specified commodity. More...
 
const char * gnc_commodity_get_namespace (const gnc_commodity *cm)
 Retrieve the namespace for the specified commodity. More...
 
gnc_commodity_namespace * gnc_commodity_get_namespace_ds (const gnc_commodity *cm)
 Retrieve the namespace data strucure for the specified commodity. More...
 
const char * gnc_commodity_get_fullname (const gnc_commodity *cm)
 Retrieve the full name for the specified commodity. More...
 
const char * gnc_commodity_get_printname (const gnc_commodity *cm)
 Retrieve the 'print' name for the specified commodity. More...
 
const char * gnc_commodity_get_cusip (const gnc_commodity *cm)
 Retrieve the 'exchange code' for the specified commodity. More...
 
const char * gnc_commodity_get_unique_name (const gnc_commodity *cm)
 Retrieve the 'unique' name for the specified commodity. More...
 
int gnc_commodity_get_fraction (const gnc_commodity *cm)
 Retrieve the fraction for the specified commodity. More...
 
gboolean gnc_commodity_get_quote_flag (const gnc_commodity *cm)
 Retrieve the automatic price quote flag for the specified commodity. More...
 
gnc_quote_source * gnc_commodity_get_quote_source (const gnc_commodity *cm)
 Retrieve the automatic price quote source for the specified commodity. More...
 
gnc_quote_source * gnc_commodity_get_default_quote_source (const gnc_commodity *cm)
 
const char * gnc_commodity_get_quote_tz (const gnc_commodity *cm)
 Retrieve the automatic price quote timezone for the specified commodity. More...
 
const char * gnc_commodity_get_user_symbol (const gnc_commodity *cm)
 Retrieve the user-defined symbol for the specified commodity. More...
 
const char * gnc_commodity_get_default_symbol (const gnc_commodity *cm)
 Retrieve the default symbol for the specified commodity. More...
 
const char * gnc_commodity_get_nice_symbol (const gnc_commodity *cm)
 Retrieve a symbol for the specified commodity, suitable for display to the user. More...
 

Commodity Accessor Routines - Set

void gnc_commodity_set_mnemonic (gnc_commodity *cm, const char *mnemonic)
 Set the mnemonic for the specified commodity. More...
 
void gnc_commodity_set_namespace (gnc_commodity *cm, const char *new_namespace)
 Set the namespace for the specified commodity. More...
 
void gnc_commodity_set_fullname (gnc_commodity *cm, const char *fullname)
 Set the full name for the specified commodity. More...
 
void gnc_commodity_set_cusip (gnc_commodity *cm, const char *cusip)
 Set the 'exchange code' for the specified commodity. More...
 
void gnc_commodity_set_fraction (gnc_commodity *cm, int smallest_fraction)
 Set the fraction for the specified commodity. More...
 
void gnc_commodity_user_set_quote_flag (gnc_commodity *cm, const gboolean flag)
 Set the automatic price quote flag for the specified commodity, based on user input. More...
 
void gnc_commodity_set_quote_flag (gnc_commodity *cm, const gboolean flag)
 Set the automatic price quote flag for the specified commodity. More...
 
void gnc_commodity_set_quote_source (gnc_commodity *cm, gnc_quote_source *src)
 Set the automatic price quote source for the specified commodity. More...
 
void gnc_commodity_set_quote_tz (gnc_commodity *cm, const char *tz)
 Set the automatic price quote timezone for the specified commodity. More...
 
void gnc_commodity_set_user_symbol (gnc_commodity *cm, const char *user_symbol)
 Set a user-defined symbol for the specified commodity. More...
 

Commodity Usage Count Adjustment Routines

void gnc_commodity_increment_usage_count (gnc_commodity *cm)
 Increment a commodity's internal counter that tracks how many accounts are using that commodity. More...
 
void gnc_commodity_decrement_usage_count (gnc_commodity *cm)
 Decrement a commodity's internal counter that tracks how many accounts are using that commodity. More...
 

Commodity Comparison

gboolean gnc_commodity_equiv (const gnc_commodity *a, const gnc_commodity *b)
 This routine returns TRUE if the two commodities are equivalent. More...
 
gboolean gnc_commodity_equal (const gnc_commodity *a, const gnc_commodity *b)
 This routine returns TRUE if the two commodities are equal. More...
 
int gnc_commodity_compare (const gnc_commodity *a, const gnc_commodity *b)
 This routine returns 0 if the two commodities are equal, 1 otherwise. More...
 
int gnc_commodity_compare_void (const void *a, const void *b)
 A wrapper around gnc_commodity_compare() which offers the function declaration that is needed for g_list_find_custom(), which needs void pointers instead of gnc_commodity ones.
 

Currency Checks

gboolean gnc_commodity_namespace_is_iso (const char *commodity_namespace)
 Checks to see if the specified commodity namespace is the namespace for ISO 4217 currencies. More...
 
gboolean gnc_commodity_is_iso (const gnc_commodity *cm)
 Checks to see if the specified commodity is an ISO 4217 recognized currency. More...
 
gboolean gnc_commodity_is_currency (const gnc_commodity *cm)
 Checks to see if the specified commodity is an ISO 4217 recognized currency or a legacy currency. More...
 

Commodity Table

gnc_commodity_table * gnc_commodity_table_get_table (QofBook *book)
 Returns the commodity table associated with a book.
 

Commodity Table Lookup functions

gnc_commodity * gnc_commodity_table_lookup (const gnc_commodity_table *table, const char *commodity_namespace, const char *mnemonic)
 
gnc_commodity * gnc_commodity_table_lookup_unique (const gnc_commodity_table *table, const char *unique_name)
 
gnc_commodity * gnc_commodity_table_find_full (const gnc_commodity_table *t, const char *commodity_namespace, const char *fullname)
 
gnc_commodity * gnc_commodity_find_commodity_by_guid (const GncGUID *guid, QofBook *book)
 

Commodity Table Maintenance functions

gnc_commodity * gnc_commodity_table_insert (gnc_commodity_table *table, gnc_commodity *comm)
 Add a new commodity to the commodity table. More...
 
void gnc_commodity_table_remove (gnc_commodity_table *table, gnc_commodity *comm)
 Remove a commodity from the commodity table. More...
 
gboolean gnc_commodity_table_add_default_data (gnc_commodity_table *table, QofBook *book)
 Add all the standard namespaces and currencies to the commodity table. More...
 

Commodity Table Namespace functions

const char * gnc_commodity_namespace_get_name (const gnc_commodity_namespace *ns)
 Return the textual name of a namespace data strucure. More...
 
const char * gnc_commodity_namespace_get_gui_name (const gnc_commodity_namespace *ns)
 Return the textual name of a namespace data strucure in a form suitable to present to the user. More...
 
GList * gnc_commodity_namespace_get_commodity_list (const gnc_commodity_namespace *ns)
 Return a list of all commodity data structures in the specified namespace. More...
 
int gnc_commodity_table_has_namespace (const gnc_commodity_table *table, const char *commodity_namespace)
 Test to see if the indicated namespace exits in the commodity table. More...
 
GList * gnc_commodity_table_get_namespaces (const gnc_commodity_table *t)
 Return a list of all namespaces in the commodity table. More...
 
GList * gnc_commodity_table_get_namespaces_list (const gnc_commodity_table *t)
 Return a list of all namespace data structures in the commodity table. More...
 
gnc_commodity_namespace * gnc_commodity_table_add_namespace (gnc_commodity_table *table, const char *commodity_namespace, QofBook *book)
 This function adds a new string to the list of commodity namespaces. More...
 
gnc_commodity_namespace * gnc_commodity_table_find_namespace (const gnc_commodity_table *table, const char *commodity_namespace)
 This function finds a commodity namespace in the set of existing commodity namespaces. More...
 
void gnc_commodity_table_delete_namespace (gnc_commodity_table *table, const char *commodity_namespace)
 This function deletes a string from the list of commodity namespaces. More...
 

Commodity Table Accessor functions

guint gnc_commodity_table_get_size (const gnc_commodity_table *tbl)
 Returns the number of commodities in the commodity table. More...
 
CommodityList * gnc_commodity_table_get_commodities (const gnc_commodity_table *table, const char *commodity_namespace)
 Return a list of all commodities in the commodity table that are in the given namespace. More...
 
CommodityList * gnc_commodity_table_get_quotable_commodities (const gnc_commodity_table *table)
 This function returns a list of commodities for which price quotes should be retrieved. More...
 
gboolean gnc_commodity_table_foreach_commodity (const gnc_commodity_table *table, gboolean(*f)(gnc_commodity *cm, gpointer user_data), gpointer user_data)
 Call a function once for each commodity in the commodity table. More...
 

Commodity Table Private/Internal-Use Only Routines

gnc_commodity_table * gnc_commodity_table_new (void)
 You proably shouldn't be using gnc_commodity_table_new() directly, its for internal use only. More...
 
void gnc_commodity_table_destroy (gnc_commodity_table *table)
 
gnc_commodity * gnc_commodity_obtain_twin (const gnc_commodity *findlike, QofBook *book)
 Given the commodity 'findlike', this routine will find and return the equivalent commodity (commodity with the same 'unique name') in the indicated book. More...
 
gboolean gnc_commodity_table_register (void)
 You should probably not be using gnc_commodity_table_register() It is an internal routine for registering the gncObject for the commodity table.
 
void gnc_commodity_begin_edit (gnc_commodity *cm)
 
void gnc_commodity_commit_edit (gnc_commodity *cm)
 
#define gnc_commodity_get_kvp_frame(cm)   qof_instance_get_slots(QOF_INSTANCE(cm))
 Get the internal KVP from of the currency. More...
 

Monetary value, commodity identity and numeric value

typedef GList MonetaryList
 

Manipulate MonetaryList lists

MonetaryList * gnc_monetary_list_add_monetary (MonetaryList *list, gnc_monetary mon)
 Add a gnc_monetary to the list.
 
MonetaryList * gnc_monetary_list_delete_zeros (MonetaryList *list)
 Delete all the zero-value entries from a list. More...
 
void gnc_monetary_list_free (MonetaryList *list)
 Free a monetary list and all the items it points to. More...
 

Detailed Description

A commodity is something of value that is easily tradeable or sellable; for example, currencies, stocks, bonds, grain, copper, and oil are all commodities.

This file provides an API for defining a commodities, and for working with collections of commodities. All GnuCash financial transactions must identify the commodity that is being traded.

Warning
The system used here does not follow the object handling and identification system (GncGUID's, Entities, etc.) that the other parts of GnuCash use. The API really should be ported over. This would allow us to get rid of the commodity table routines defined below.

Macro Definition Documentation

◆ gnc_commodity_get_kvp_frame

#define gnc_commodity_get_kvp_frame (   cm)    qof_instance_get_slots(QOF_INSTANCE(cm))

Get the internal KVP from of the currency.

You should rather use the individual accessors for individual properties

Definition at line 982 of file gnc-commodity.h.

◆ GNC_COMMODITY_NS_LEGACY

#define GNC_COMMODITY_NS_LEGACY   "GNC_LEGACY_CURRENCIES"

The commodity namespace definitions are used to tag a commodity by its type, or a stocks by the exchange where it is traded.

The LEGACY name is only used by the file i/o routines, and is converted to another commodity namespace before it is seen by the rest of the system. The ISO namespace represents currencies. With the exception of the NASDAQ namespace (which is used once in the binary importer) the rest of the namespace declarations are only used to populate an option menu in the commodity selection window.

Definition at line 98 of file gnc-commodity.h.

Enumeration Type Documentation

◆ QuoteSourceType

The quote source type enum account types are used to determine how the transaction data in the account is displayed.

These values can be safely changed from one release to the next.

Enumerator
SOURCE_SINGLE 

This quote source pulls from a single specific web site.

For example, the yahoo_australia source only pulls from the yahoo web site.

SOURCE_MULTI 

This quote source may pull from multiple web sites.

For example, the australia source may pull from ASX, yahoo, etc.

SOURCE_UNKNOWN 

This is a locally installed quote source that gnucash knows nothing about.

May pull from single or multiple locations.

SOURCE_CURRENCY 

The special currency quote source.

Definition at line 124 of file gnc-commodity.h.

125 {
126  SOURCE_SINGLE = 0,
130  SOURCE_MULTI,
137  SOURCE_MAX,
138  SOURCE_CURRENCY = SOURCE_MAX,
This quote source pulls from a single specific web site.
The special currency quote source.
This is a locally installed quote source that gnucash knows nothing about.
QuoteSourceType
The quote source type enum account types are used to determine how the transaction data in the accoun...
This quote source may pull from multiple web sites.

Function Documentation

◆ gnc_commodity_compare()

int gnc_commodity_compare ( const gnc_commodity *  a,
const gnc_commodity *  b 
)

This routine returns 0 if the two commodities are equal, 1 otherwise.

Commodities are equal if they have the same namespace, mnemonic, fullname, exchange private code and fraction. This function is useful for list-traversal comparison purposes where The semantics are 0, <0, or >0 (equal, greater than, less than) rather than "true or false"

Definition at line 1636 of file gnc-commodity.c.

1637 {
1638  if (gnc_commodity_equal(a, b))
1639  {
1640  return 0;
1641  }
1642  else
1643  {
1644  return 1;
1645  }
1646 }
gboolean gnc_commodity_equal(const gnc_commodity *a, const gnc_commodity *b)
This routine returns TRUE if the two commodities are equal.

◆ gnc_commodity_decrement_usage_count()

void gnc_commodity_decrement_usage_count ( gnc_commodity *  cm)

Decrement a commodity's internal counter that tracks how many accounts are using that commodity.

For currencies, this may have the side effect of disabling the commodity's quote flag.

Parameters
cmA pointer to a commodity data structure.

Definition at line 1522 of file gnc-commodity.c.

1523 {
1524  CommodityPrivate* priv;
1525 
1526  ENTER("(cm=%p)", cm);
1527 
1528  if (!cm)
1529  {
1530  LEAVE("");
1531  return;
1532  }
1533 
1534  priv = GET_PRIVATE(cm);
1535 
1536  if (priv->usage_count == 0)
1537  {
1538  PWARN("usage_count already zero");
1539  LEAVE("");
1540  return;
1541  }
1542 
1543  priv->usage_count--;
1544  if ((priv->usage_count == 0) && priv->quote_flag
1545  && gnc_commodity_get_auto_quote_control_flag(cm)
1546  && gnc_commodity_is_iso(cm))
1547  {
1548  /* if this is a currency with auto quote control enabled and no more
1549  * accounts reference this currency, disable quote retrieval */
1550  gnc_commodity_set_quote_flag(cm, FALSE);
1551  }
1552  LEAVE("(usage_count=%d)", priv->usage_count);
1553 }
void gnc_commodity_set_quote_flag(gnc_commodity *cm, const gboolean flag)
Set the automatic price quote flag for the specified commodity.
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
#define PWARN(format, args...)
Log a warning.
Definition: qoflog.h:243
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271
gboolean gnc_commodity_is_iso(const gnc_commodity *cm)
Checks to see if the specified commodity is an ISO 4217 recognized currency.

◆ gnc_commodity_destroy()

void gnc_commodity_destroy ( gnc_commodity *  cm)

Destroy a commodity.

Release all memory attached to this data structure.

Note
This function does not (can not) check to see if the commodity is referenced anywhere.
Parameters
cmThe commodity to destroy.

Definition at line 934 of file gnc-commodity.c.

935 {
936  gnc_commodity_begin_edit(cm);
937  qof_instance_set_destroying(cm, TRUE);
938  gnc_commodity_commit_edit(cm);
939 }

◆ gnc_commodity_equal()

gboolean gnc_commodity_equal ( const gnc_commodity *  a,
const gnc_commodity *  b 
)

This routine returns TRUE if the two commodities are equal.

Commodities are equal if they have the same namespace, mnemonic, fullname, exchange private code and fraction.

Definition at line 1581 of file gnc-commodity.c.

1582 {
1583  CommodityPrivate* priv_a;
1584  CommodityPrivate* priv_b;
1585  gboolean same_book;
1586 
1587  if (a == b) return TRUE;
1588 
1589  if (!a || !b)
1590  {
1591  DEBUG ("one is NULL");
1592  return FALSE;
1593  }
1594 
1595  priv_a = GET_PRIVATE(a);
1596  priv_b = GET_PRIVATE(b);
1597  same_book = qof_instance_get_book(QOF_INSTANCE(a)) == qof_instance_get_book(QOF_INSTANCE(b));
1598 
1599  if ((same_book && priv_a->name_space != priv_b->name_space)
1600  || (!same_book && g_strcmp0( gnc_commodity_namespace_get_name(priv_a->name_space),
1601  gnc_commodity_namespace_get_name(priv_b->name_space)) != 0))
1602  {
1603  DEBUG ("namespaces differ: %p(%s) vs %p(%s)",
1604  priv_a->name_space, gnc_commodity_namespace_get_name(priv_a->name_space),
1605  priv_b->name_space, gnc_commodity_namespace_get_name(priv_b->name_space));
1606  return FALSE;
1607  }
1608 
1609  if (g_strcmp0(priv_a->mnemonic, priv_b->mnemonic) != 0)
1610  {
1611  DEBUG ("mnemonics differ: %s vs %s", priv_a->mnemonic, priv_b->mnemonic);
1612  return FALSE;
1613  }
1614 
1615  if (g_strcmp0(priv_a->fullname, priv_b->fullname) != 0)
1616  {
1617  DEBUG ("fullnames differ: %s vs %s", priv_a->fullname, priv_b->fullname);
1618  return FALSE;
1619  }
1620 
1621  if (g_strcmp0(priv_a->cusip, priv_b->cusip) != 0)
1622  {
1623  DEBUG ("cusips differ: %s vs %s", priv_a->cusip, priv_b->cusip);
1624  return FALSE;
1625  }
1626 
1627  if (priv_a->fraction != priv_b->fraction)
1628  {
1629  DEBUG ("fractions differ: %d vs %d", priv_a->fraction, priv_b->fraction);
1630  return FALSE;
1631  }
1632 
1633  return TRUE;
1634 }
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.
#define DEBUG(format, args...)
Print a debugging message.
Definition: qoflog.h:255
const char * gnc_commodity_namespace_get_name(const gnc_commodity_namespace *ns)
Return the textual name of a namespace data strucure.

◆ gnc_commodity_equiv()

gboolean gnc_commodity_equiv ( const gnc_commodity *  a,
const gnc_commodity *  b 
)

This routine returns TRUE if the two commodities are equivalent.

Commodities are equivalent if they have the same namespace and mnemonic. Equivalent commodities may belong to different exchanges, may have different fullnames, and may have different fractions.

Definition at line 1565 of file gnc-commodity.c.

1566 {
1567  CommodityPrivate* priv_a;
1568  CommodityPrivate* priv_b;
1569 
1570  if (a == b) return TRUE;
1571  if (!a || !b) return FALSE;
1572 
1573  priv_a = GET_PRIVATE(a);
1574  priv_b = GET_PRIVATE(b);
1575  if (priv_a->name_space != priv_b->name_space) return FALSE;
1576  if (g_strcmp0(priv_a->mnemonic, priv_b->mnemonic) != 0) return FALSE;
1577  return TRUE;
1578 }

◆ gnc_commodity_get_cusip()

const char* gnc_commodity_get_cusip ( const gnc_commodity *  cm)

Retrieve the 'exchange code' for the specified commodity.

This will be a pointer to a null terminated string of the form "AXQ14728", etc. This field is often used when presenting information to the user.

Note
This is a unique code that specifies a particular item or set of shares of a commodity, not a code that specifies a stock exchange. That is the namespace field.
Parameters
cmA pointer to a commodity data structure.
Returns
A pointer to the exchange code for this commodity. This string is owned by the engine and should not be freed by the caller.

Definition at line 1059 of file gnc-commodity.c.

1060 {
1061  if (!cm) return NULL;
1062  return GET_PRIVATE(cm)->cusip;
1063 }

◆ gnc_commodity_get_default_symbol()

const char* gnc_commodity_get_default_symbol ( const gnc_commodity *  cm)

Retrieve the default symbol for the specified commodity.

This will be a pointer to a nul terminated string like "£", "US$", etc. Note that for the locale currency, you probably want to look at the system-provided symbol first. See gnc_commodity_get_nice_symbol.

Parameters
cmA pointer to a commodity data structure.
Returns
A pointer to the default symbol for this commodity.

Definition at line 1158 of file gnc-commodity.c.

1159 {
1160  if (!cm) return NULL;
1161  return GET_PRIVATE(cm)->default_symbol;
1162 }

◆ gnc_commodity_get_fraction()

int gnc_commodity_get_fraction ( const gnc_commodity *  cm)

Retrieve the fraction for the specified commodity.

This will be an integer value specifying the number of fractional units that one of these commodities can be divided into. Should always be a power of 10.

Parameters
cmA pointer to a commodity data structure.
Returns
The number of fractional units that one of these commodities can be divided into.

Definition at line 1070 of file gnc-commodity.c.

1071 {
1072  if (!cm) return 0;
1073  return GET_PRIVATE(cm)->fraction;
1074 }

◆ gnc_commodity_get_fullname()

const char* gnc_commodity_get_fullname ( const gnc_commodity *  cm)

Retrieve the full name for the specified commodity.

This will be a pointer to a null terminated string of the form "Acme Systems, Inc.", etc.

Parameters
cmA pointer to a commodity data structure.
Returns
A pointer to the full name for this commodity. This string is owned by the engine and should not be freed by the caller.

Definition at line 1035 of file gnc-commodity.c.

1036 {
1037  if (!cm) return NULL;
1038  return GET_PRIVATE(cm)->fullname;
1039 }

◆ gnc_commodity_get_mnemonic()

const char* gnc_commodity_get_mnemonic ( const gnc_commodity *  cm)

Retrieve the mnemonic for the specified commodity.

This will be a pointer to a null terminated string of the form "ACME", "QWER", etc.

Parameters
cmA pointer to a commodity data structure.
Returns
A pointer to the mnemonic for this commodity. This string is owned by the engine and should not be freed by the caller.

Definition at line 994 of file gnc-commodity.c.

995 {
996  if (!cm) return NULL;
997  return GET_PRIVATE(cm)->mnemonic;
998 }

◆ gnc_commodity_get_namespace()

const char* gnc_commodity_get_namespace ( const gnc_commodity *  cm)

Retrieve the namespace for the specified commodity.

This will be a pointer to a null terminated string of the form "AMEX", "NASDAQ", etc.

Parameters
cmA pointer to a commodity data structure.
Returns
A pointer to the namespace for this commodity. This string is owned by the engine and should not be freed by the caller.

Definition at line 1017 of file gnc-commodity.c.

1018 {
1019  if (!cm) return NULL;
1020  return gnc_commodity_namespace_get_name(GET_PRIVATE(cm)->name_space);
1021 }
const char * gnc_commodity_namespace_get_name(const gnc_commodity_namespace *ns)
Return the textual name of a namespace data strucure.

◆ gnc_commodity_get_namespace_ds()

gnc_commodity_namespace* gnc_commodity_get_namespace_ds ( const gnc_commodity *  cm)

Retrieve the namespace data strucure for the specified commodity.

This will be a pointer to another data structure.

Parameters
cmA pointer to a commodity data structure.
Returns
A pointer to the namespace data structure for this commodity.

Definition at line 1024 of file gnc-commodity.c.

1025 {
1026  if (!cm) return NULL;
1027  return GET_PRIVATE(cm)->name_space;
1028 }

◆ gnc_commodity_get_nice_symbol()

const char* gnc_commodity_get_nice_symbol ( const gnc_commodity *  cm)

Retrieve a symbol for the specified commodity, suitable for display to the user.

This will be a pointer to a nul terminated string like "£", "US$", etc. That function is locale-aware and will base its choice of symbol on the user-configured symbol, the locale a

Parameters
cmA pointer to a commodity data structure.
Returns
A pointer to the symbol for this commodity.

Definition at line 1168 of file gnc-commodity.c.

1169 {
1170  const char *nice_symbol;
1171  struct lconv *lc;
1172  if (!cm) return NULL;
1173 
1174  nice_symbol = gnc_commodity_get_user_symbol(cm);
1175  if (nice_symbol && *nice_symbol)
1176  return nice_symbol;
1177 
1178  lc = gnc_localeconv();
1179  nice_symbol = lc->currency_symbol;
1180  if (!g_strcmp0(gnc_commodity_get_mnemonic(cm), lc->int_curr_symbol))
1181  return nice_symbol;
1182 
1183  nice_symbol = gnc_commodity_get_default_symbol(cm);
1184  if (nice_symbol && *nice_symbol)
1185  return nice_symbol;
1186 
1187  return gnc_commodity_get_mnemonic(cm);
1188 }
const char * gnc_commodity_get_mnemonic(const gnc_commodity *cm)
Retrieve the mnemonic for the specified commodity.
const char * gnc_commodity_get_user_symbol(const gnc_commodity *cm)
Retrieve the user-defined symbol for the specified commodity.
const char * gnc_commodity_get_default_symbol(const gnc_commodity *cm)
Retrieve the default symbol for the specified commodity.

◆ gnc_commodity_get_printname()

const char* gnc_commodity_get_printname ( const gnc_commodity *  cm)

Retrieve the 'print' name for the specified commodity.

This will be a pointer to a null terminated string of the form "Acme Systems, Inc. (ACME)", etc.

Parameters
cmA pointer to a commodity data structure.
Returns
A pointer to the print name for this commodity. This string is owned by the engine and should not be freed by the caller.

Definition at line 1005 of file gnc-commodity.c.

1006 {
1007  if (!cm) return NULL;
1008  return GET_PRIVATE(cm)->printname;
1009 }

◆ gnc_commodity_get_quote_flag()

gboolean gnc_commodity_get_quote_flag ( const gnc_commodity *  cm)

Retrieve the automatic price quote flag for the specified commodity.

This flag indicates whether stock quotes should be retrieved for the specified stock.

Parameters
cmA pointer to a commodity data structure.
Returns
TRUE if quotes should be pulled for this commodity, FALSE otherwise.

Definition at line 1098 of file gnc-commodity.c.

1099 {
1100  if (!cm) return FALSE;
1101  return (GET_PRIVATE(cm)->quote_flag);
1102 }

◆ gnc_commodity_get_quote_source()

gnc_quote_source* gnc_commodity_get_quote_source ( const gnc_commodity *  cm)

Retrieve the automatic price quote source for the specified commodity.

This will be a pointer to a null terminated string of the form "Yahoo (Asia)", etc.

Parameters
cmA pointer to a commodity data structure.
Returns
A pointer to the price quote source for this commodity.

Definition at line 1109 of file gnc-commodity.c.

1110 {
1111  CommodityPrivate* priv;
1112 
1113  if (!cm) return NULL;
1114  priv = GET_PRIVATE(cm);
1115  if (!priv->quote_source && gnc_commodity_is_iso(cm))
1116  return &currency_quote_source;
1117  return priv->quote_source;
1118 }
gboolean gnc_commodity_is_iso(const gnc_commodity *cm)
Checks to see if the specified commodity is an ISO 4217 recognized currency.

◆ gnc_commodity_get_quote_tz()

const char* gnc_commodity_get_quote_tz ( const gnc_commodity *  cm)

Retrieve the automatic price quote timezone for the specified commodity.

This will be a pointer to a null terminated string of the form "America/New_York", etc.

Parameters
cmA pointer to a commodity data structure.
Returns
A pointer to the price quote timezone for this commodity. This string is owned by the engine and should not be freed by the caller.

Definition at line 1134 of file gnc-commodity.c.

1135 {
1136  if (!cm) return NULL;
1137  return GET_PRIVATE(cm)->quote_tz;
1138 }

◆ gnc_commodity_get_unique_name()

const char* gnc_commodity_get_unique_name ( const gnc_commodity *  cm)

Retrieve the 'unique' name for the specified commodity.

This will be a pointer to a null terminated string of the form "AMEX::ACME", etc. This field is often used when performing comparisons or other functions invisible to the user.

Parameters
cmA pointer to a commodity data structure.
Returns
A pointer to the 'unique' name for this commodity. This string is owned by the engine and should not be freed by the caller.

Definition at line 1047 of file gnc-commodity.c.

1048 {
1049  if (!cm) return NULL;
1050  return GET_PRIVATE(cm)->unique_name;
1051 }

◆ gnc_commodity_get_user_symbol()

const char* gnc_commodity_get_user_symbol ( const gnc_commodity *  cm)

Retrieve the user-defined symbol for the specified commodity.

This will be a pointer to a nul terminated string like "£", "US$", etc.

Parameters
cmA pointer to a commodity data structure.
Returns
A pointer to the user-defined symbol for this commodity. NULL means that the user didn't define any symbol, and that fallback to e.g. the mnemonic is in order. This string is owned by the engine and should not be freed by the caller.

Definition at line 1144 of file gnc-commodity.c.

1145 {
1146  GValue v = G_VALUE_INIT;
1147  if (!cm) return NULL;
1148  qof_instance_get_kvp (QOF_INSTANCE(cm), "user_symbol", &v);
1149  if (G_VALUE_HOLDS_STRING (&v))
1150  return g_value_get_string (&v);
1151  return NULL;
1152 }
void qof_instance_get_kvp(const QofInstance *inst, const gchar *key, GValue *value)
Retrieves the contents of a KVP slot into a provided GValue.

◆ gnc_commodity_increment_usage_count()

void gnc_commodity_increment_usage_count ( gnc_commodity *  cm)

Increment a commodity's internal counter that tracks how many accounts are using that commodity.

For currencies, this may have the side effect of enabling the commodity's quote flag.

Parameters
cmA pointer to a commodity data structure.

Definition at line 1487 of file gnc-commodity.c.

1488 {
1489  CommodityPrivate* priv;
1490 
1491  ENTER("(cm=%p)", cm);
1492 
1493  if (!cm)
1494  {
1495  LEAVE("");
1496  return;
1497  }
1498 
1499  priv = GET_PRIVATE(cm);
1500 
1501  if ((priv->usage_count == 0) && !priv->quote_flag
1502  && gnc_commodity_get_auto_quote_control_flag(cm)
1503  && gnc_commodity_is_iso(cm))
1504  {
1505  /* compatibility hack - Gnucash 1.8 gets currency quotes when a
1506  non-default currency is assigned to an account. */
1507  gnc_commodity_begin_edit(cm);
1508  gnc_commodity_set_quote_flag(cm, TRUE);
1510  gnc_commodity_get_default_quote_source(cm));
1511  gnc_commodity_commit_edit(cm);
1512  }
1513  priv->usage_count++;
1514  LEAVE("(usage_count=%d)", priv->usage_count);
1515 }
void gnc_commodity_set_quote_flag(gnc_commodity *cm, const gboolean flag)
Set the automatic price quote flag for the specified commodity.
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
void gnc_commodity_set_quote_source(gnc_commodity *cm, gnc_quote_source *src)
Set the automatic price quote source for the specified commodity.
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271
gboolean gnc_commodity_is_iso(const gnc_commodity *cm)
Checks to see if the specified commodity is an ISO 4217 recognized currency.

◆ gnc_commodity_is_currency()

gboolean gnc_commodity_is_currency ( const gnc_commodity *  cm)

Checks to see if the specified commodity is an ISO 4217 recognized currency or a legacy currency.

Parameters
cmThe commodity to check.
Returns
TRUE if the commodity represents a currency, FALSE otherwise.

Definition at line 2099 of file gnc-commodity.c.

2100 {
2101  const char *ns_name;
2102  if (!cm) return FALSE;
2103 
2104  ns_name = gnc_commodity_namespace_get_name(GET_PRIVATE(cm)->name_space);
2105  return (!g_strcmp0(ns_name, GNC_COMMODITY_NS_LEGACY) ||
2106  !g_strcmp0(ns_name, GNC_COMMODITY_NS_CURRENCY));
2107 }
const char * gnc_commodity_namespace_get_name(const gnc_commodity_namespace *ns)
Return the textual name of a namespace data strucure.
#define GNC_COMMODITY_NS_LEGACY
The commodity namespace definitions are used to tag a commodity by its type, or a stocks by the excha...
Definition: gnc-commodity.h:98

◆ gnc_commodity_is_iso()

gboolean gnc_commodity_is_iso ( const gnc_commodity *  cm)

Checks to see if the specified commodity is an ISO 4217 recognized currency.

Parameters
cmThe commodity to check.
Returns
TRUE if the commodity represents a currency, FALSE otherwise.

Definition at line 2087 of file gnc-commodity.c.

2088 {
2089  CommodityPrivate* priv;
2090 
2091  if (!cm) return FALSE;
2092 
2093  priv = GET_PRIVATE(cm);
2094  if ( !priv->name_space) return FALSE;
2095  return priv->name_space->iso4217;
2096 }

◆ gnc_commodity_namespace_get_commodity_list()

GList* gnc_commodity_namespace_get_commodity_list ( const gnc_commodity_namespace *  ns)

Return a list of all commodity data structures in the specified namespace.

Returns
A pointer to the list of structures. NULL if an invalid argument was supplied.
Note
This list is owned by the engine. The caller must not free the list.

Definition at line 1675 of file gnc-commodity.c.

1676 {
1677  if (!name_space)
1678  return NULL;
1679 
1680  return name_space->cm_list;
1681 }

◆ gnc_commodity_namespace_get_gui_name()

const char* gnc_commodity_namespace_get_gui_name ( const gnc_commodity_namespace *  ns)

Return the textual name of a namespace data strucure in a form suitable to present to the user.

Parameters
nsA pointer to the namespace data strucure.
Returns
A pointer to the gui friendly name of the namespace. This string is owned by the engine and should not be freed by the caller.

The returned string is marked for translation, but not translated yet. If you want it translated pass the return value on to gettext.

Definition at line 1665 of file gnc-commodity.c.

1666 {
1667  if (ns == NULL)
1668  return NULL;
1669  if (g_strcmp0 (ns->name, GNC_COMMODITY_NS_CURRENCY) == 0)
1670  return GNC_COMMODITY_NS_ISO_GUI;
1671  return ns->name;
1672 }

◆ gnc_commodity_namespace_get_name()

const char* gnc_commodity_namespace_get_name ( const gnc_commodity_namespace *  ns)

Return the textual name of a namespace data strucure.

Parameters
nsA pointer to the namespace data strucure.
Returns
A pointer to the name of the namespace. This string is owned by the engine and should not be freed by the caller.

Definition at line 1657 of file gnc-commodity.c.

1658 {
1659  if (ns == NULL)
1660  return NULL;
1661  return ns->name;
1662 }

◆ gnc_commodity_namespace_is_iso()

gboolean gnc_commodity_namespace_is_iso ( const char *  commodity_namespace)

Checks to see if the specified commodity namespace is the namespace for ISO 4217 currencies.

Parameters
commodity_namespaceThe string to check.
Returns
TRUE if the string indicates an ISO currency, FALSE otherwise.

Definition at line 1684 of file gnc-commodity.c.

1685 {
1686  return ((g_strcmp0(name_space, GNC_COMMODITY_NS_ISO) == 0) ||
1687  (g_strcmp0(name_space, GNC_COMMODITY_NS_CURRENCY) == 0));
1688 }

◆ gnc_commodity_new()

gnc_commodity* gnc_commodity_new ( QofBook *  book,
const char *  fullname,
const char *  commodity_namespace,
const char *  mnemonic,
const char *  cusip,
int  fraction 
)

Create a new commodity.

This function allocates a new commodity data structure, populates it with the data provided, and then generates the dynamic names that exist as part of a commodity.

Note
This function does not check to see if the commodity exists before adding a new commodity.
Parameters
bookThe book that the new commodity will belong to.
fullnameThe complete name of this commodity. E.G. "Acme Systems, Inc."
commodity_namespaceAn aggregation of commodities. E.G. ISO4217, Nasdaq, Downbelow, etc.
mnemonicAn abbreviation for this stock. For publicly traced stocks, this field should contain the stock ticker symbol. This field is used to get online price quotes, so it must match the stock ticker symbol used by the exchange where you want to get automatic stock quote updates. E.G. ACME, ACME.US, etc.
cusipA string containing the CUSIP code or similar UNIQUE code for this commodity like the ISIN. The stock ticker is NOT appropriate as that goes in the mnemonic field.
fractionThe smallest division of this commodity allowed. I.E. If this is 1, then the commodity must be traded in whole units; if 100 then the commodity may be traded in 0.01 units, etc.
Returns
A pointer to the new commodity.

Definition at line 841 of file gnc-commodity.c.

844 {
845  gnc_commodity * retval = g_object_new(GNC_TYPE_COMMODITY, NULL);
846 
847  qof_instance_init_data (&retval->inst, GNC_ID_COMMODITY, book);
848  gnc_commodity_begin_edit(retval);
849 
850  if ( name_space != NULL )
851  {
852  /* Prevent setting anything except template in namespace template. */
853  if (g_strcmp0 (name_space, GNC_COMMODITY_NS_TEMPLATE) == 0 &&
854  g_strcmp0 (mnemonic, "template") != 0)
855  {
856  PWARN("Converting commodity %s from namespace template to "
857  "namespace User", mnemonic);
858  name_space = "User";
859  }
860  gnc_commodity_set_namespace(retval, name_space);
861  if (gnc_commodity_namespace_is_iso(name_space))
862  {
865  }
866  }
867  gnc_commodity_set_fullname(retval, fullname);
868  gnc_commodity_set_mnemonic(retval, mnemonic);
869  gnc_commodity_set_cusip(retval, cusip);
870  gnc_commodity_set_fraction(retval, fraction);
871  mark_commodity_dirty (retval);
872  gnc_commodity_commit_edit(retval);
873 
874  qof_event_gen (&retval->inst, QOF_EVENT_CREATE, NULL);
875 
876  return retval;
877 }
void gnc_commodity_set_fraction(gnc_commodity *cm, int fraction)
Set the fraction for the specified commodity.
#define PWARN(format, args...)
Log a warning.
Definition: qoflog.h:243
void qof_instance_init_data(QofInstance *inst, QofIdType type, QofBook *book)
Initialise the settings associated with an instance.
void gnc_commodity_set_quote_source(gnc_commodity *cm, gnc_quote_source *src)
Set the automatic price quote source for the specified commodity.
void gnc_commodity_set_cusip(gnc_commodity *cm, const char *cusip)
Set the &#39;exchange code&#39; for the specified commodity.
gboolean gnc_commodity_namespace_is_iso(const char *name_space)
Checks to see if the specified commodity namespace is the namespace for ISO 4217 currencies.
gnc_quote_source * gnc_quote_source_lookup_by_internal(const char *name)
Given the internal (gnucash or F::Q) name of a quote source, find the data structure identified by th...
void gnc_commodity_set_fullname(gnc_commodity *cm, const char *fullname)
Set the full name for the specified commodity.
void gnc_commodity_set_mnemonic(gnc_commodity *cm, const char *mnemonic)
Set the mnemonic for the specified commodity.
void gnc_commodity_set_namespace(gnc_commodity *cm, const char *name_space)
Set the namespace for the specified commodity.
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

◆ gnc_commodity_obtain_twin()

gnc_commodity* gnc_commodity_obtain_twin ( const gnc_commodity *  findlike,
QofBook *  book 
)

Given the commodity 'findlike', this routine will find and return the equivalent commodity (commodity with the same 'unique name') in the indicated book.

This routine is primarily useful for setting up clones of things across multiple books.

Definition at line 1724 of file gnc-commodity.c.

1725 {
1726  gnc_commodity *twin;
1727  const char * ucom;
1728  gnc_commodity_table * comtbl;
1729 
1730  if (!from) return NULL;
1731  comtbl = gnc_commodity_table_get_table (book);
1732  if (!comtbl) return NULL;
1733 
1734  ucom = gnc_commodity_get_unique_name (from);
1735  twin = gnc_commodity_table_lookup_unique (comtbl, ucom);
1736  if (!twin)
1737  {
1738  twin = gnc_commodity_clone (from, book);
1739  twin = gnc_commodity_table_insert (comtbl, twin);
1740  }
1741  return twin;
1742 }
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.
gnc_commodity * gnc_commodity_clone(const gnc_commodity *src, QofBook *dest_book)
allocate and copy
const char * gnc_commodity_get_unique_name(const gnc_commodity *cm)
Retrieve the &#39;unique&#39; name for the specified commodity.

◆ gnc_commodity_set_cusip()

void gnc_commodity_set_cusip ( gnc_commodity *  cm,
const char *  cusip 
)

Set the 'exchange code' for the specified commodity.

This should be a pointer to a null terminated string of the form "AXQ14728", etc.

Note
This is a unique code that specifies a particular item or set of shares of a commodity, not a code that specifies a stock exchange. That is the namespace field.
Parameters
cmA pointer to a commodity data structure.
cusipA pointer to the cusip or other exchange specific data for this commodity. This string belongs to the caller and will be duplicated by the engine.

Definition at line 1270 of file gnc-commodity.c.

1272 {
1273  CommodityPrivate* priv;
1274 
1275  if (!cm) return;
1276 
1277  priv = GET_PRIVATE(cm);
1278  if (priv->cusip == cusip) return;
1279 
1280  gnc_commodity_begin_edit(cm);
1281  CACHE_REMOVE (priv->cusip);
1282  priv->cusip = CACHE_INSERT (cusip);
1283  mark_commodity_dirty(cm);
1284  gnc_commodity_commit_edit(cm);
1285 }

◆ gnc_commodity_set_fraction()

void gnc_commodity_set_fraction ( gnc_commodity *  cm,
int  smallest_fraction 
)

Set the fraction for the specified commodity.

This should be an integer value specifying the number of fractional units that one of these commodities can be divided into. Should always be a power of 10.

Parameters
cmA pointer to a commodity data structure.
smallest_fractionThe number of fractional units that one of these commodities can be divided into.

Definition at line 1292 of file gnc-commodity.c.

1293 {
1294  if (!cm) return;
1295  gnc_commodity_begin_edit(cm);
1296  GET_PRIVATE(cm)->fraction = fraction;
1297  mark_commodity_dirty(cm);
1298  gnc_commodity_commit_edit(cm);
1299 }

◆ gnc_commodity_set_fullname()

void gnc_commodity_set_fullname ( gnc_commodity *  cm,
const char *  fullname 
)

Set the full name for the specified commodity.

This should be a pointer to a null terminated string of the form "Acme Systems, Inc.", etc.

Parameters
cmA pointer to a commodity data structure.
fullnameA pointer to the full name for this commodity. This string belongs to the caller and will be duplicated by the engine.

Definition at line 1248 of file gnc-commodity.c.

1249 {
1250  CommodityPrivate* priv;
1251 
1252  if (!cm) return;
1253  priv = GET_PRIVATE(cm);
1254  if (priv->fullname == fullname) return;
1255 
1256  CACHE_REMOVE (priv->fullname);
1257  priv->fullname = CACHE_INSERT (fullname);
1258 
1259  gnc_commodity_begin_edit(cm);
1260  mark_commodity_dirty(cm);
1261  reset_printname(priv);
1262  gnc_commodity_commit_edit(cm);
1263 }

◆ gnc_commodity_set_mnemonic()

void gnc_commodity_set_mnemonic ( gnc_commodity *  cm,
const char *  mnemonic 
)

Set the mnemonic for the specified commodity.

This should be a pointer to a null terminated string of the form "ACME", "QWER", etc.

Parameters
cmA pointer to a commodity data structure.
mnemonicA pointer to the mnemonic for this commodity. This string belongs to the caller and will be duplicated by the engine.

Definition at line 1195 of file gnc-commodity.c.

1196 {
1197  CommodityPrivate* priv;
1198 
1199  if (!cm) return;
1200  priv = GET_PRIVATE(cm);
1201  if (priv->mnemonic == mnemonic) return;
1202 
1203  gnc_commodity_begin_edit(cm);
1204  CACHE_REMOVE (priv->mnemonic);
1205  priv->mnemonic = CACHE_INSERT(mnemonic);
1206 
1207  mark_commodity_dirty (cm);
1208  reset_printname(priv);
1209  reset_unique_name(priv);
1210  gnc_commodity_commit_edit(cm);
1211 }

◆ gnc_commodity_set_namespace()

void gnc_commodity_set_namespace ( gnc_commodity *  cm,
const char *  new_namespace 
)

Set the namespace for the specified commodity.

This should be a pointer to a null terminated string of the form "AMEX", "NASDAQ", etc.

Parameters
cmA pointer to a commodity data structure.
new_namespaceA pointer to the namespace for this commodity. This string belongs to the caller and will be duplicated by the engine.

Definition at line 1218 of file gnc-commodity.c.

1219 {
1220  QofBook *book;
1221  gnc_commodity_table *table;
1222  gnc_commodity_namespace *nsp;
1223  CommodityPrivate* priv;
1224 
1225  if (!cm) return;
1226  priv = GET_PRIVATE(cm);
1227  book = qof_instance_get_book (&cm->inst);
1228  table = gnc_commodity_table_get_table(book);
1229  nsp = gnc_commodity_table_add_namespace(table, name_space, book);
1230  if (priv->name_space == nsp)
1231  return;
1232 
1233  gnc_commodity_begin_edit(cm);
1234  priv->name_space = nsp;
1235  if (nsp->iso4217)
1236  priv->quote_source = gnc_quote_source_lookup_by_internal("currency");
1237  mark_commodity_dirty(cm);
1238  reset_printname(priv);
1239  reset_unique_name(priv);
1240  gnc_commodity_commit_edit(cm);
1241 }
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.
gnc_commodity_namespace * gnc_commodity_table_add_namespace(gnc_commodity_table *table, const char *name_space, QofBook *book)
This function adds a new string to the list of commodity namespaces.
gnc_quote_source * gnc_quote_source_lookup_by_internal(const char *name)
Given the internal (gnucash or F::Q) name of a quote source, find the data structure identified by th...

◆ gnc_commodity_set_quote_flag()

void gnc_commodity_set_quote_flag ( gnc_commodity *  cm,
const gboolean  flag 
)

Set the automatic price quote flag for the specified commodity.

This flag indicates whether stock quotes should be retrieved for the specified stock.

Parameters
cmA pointer to a commodity data structure.
flagTRUE if quotes should be pulled for this commodity, FALSE otherwise.

Definition at line 1372 of file gnc-commodity.c.

1373 {
1374  ENTER ("(cm=%p, flag=%d)", cm, flag);
1375 
1376  if (!cm) return;
1377  gnc_commodity_begin_edit(cm);
1378  GET_PRIVATE(cm)->quote_flag = flag;
1379  mark_commodity_dirty(cm);
1380  gnc_commodity_commit_edit(cm);
1381  LEAVE(" ");
1382 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271

◆ gnc_commodity_set_quote_source()

void gnc_commodity_set_quote_source ( gnc_commodity *  cm,
gnc_quote_source *  src 
)

Set the automatic price quote source for the specified commodity.

This should be a pointer to a null terminated string of the form "Yahoo (Asia)", etc. Legal values can be found in the quote_sources array in the file gnc-ui-util.c.

Parameters
cmA pointer to a commodity data structure.
srcA pointer to the price quote source for this commodity.

Definition at line 1389 of file gnc-commodity.c.

1390 {
1391  ENTER ("(cm=%p, src=%p(%s))", cm, src, src ? src->internal_name : "unknown");
1392 
1393  if (!cm) return;
1394  gnc_commodity_begin_edit(cm);
1395  GET_PRIVATE(cm)->quote_source = src;
1396  mark_commodity_dirty(cm);
1397  gnc_commodity_commit_edit(cm);
1398  LEAVE(" ");
1399 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271

◆ gnc_commodity_set_quote_tz()

void gnc_commodity_set_quote_tz ( gnc_commodity *  cm,
const char *  tz 
)

Set the automatic price quote timezone for the specified commodity.

This should be a pointer to a null terminated string of the form "America/New_York", etc. Legal values can be found in the known_timezones array in the file src/gnome-utils/dialog-commodity.c.

Parameters
cmA pointer to a commodity data structure.
tzA pointer to the price quote timezone for this commodity. This string belongs to the caller and will be duplicated by the engine.

Definition at line 1406 of file gnc-commodity.c.

1407 {
1408  CommodityPrivate* priv;
1409 
1410  if (!cm) return;
1411 
1412  ENTER ("(cm=%p, tz=%s)", cm, tz ? tz : "(null)");
1413 
1414  priv = GET_PRIVATE(cm);
1415 
1416  if (tz == priv->quote_tz)
1417  {
1418  LEAVE("Already correct TZ");
1419  return;
1420  }
1421 
1422  gnc_commodity_begin_edit(cm);
1423  CACHE_REMOVE (priv->quote_tz);
1424  priv->quote_tz = CACHE_INSERT (tz);
1425  mark_commodity_dirty(cm);
1426  gnc_commodity_commit_edit(cm);
1427  LEAVE(" ");
1428 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271

◆ gnc_commodity_set_user_symbol()

void gnc_commodity_set_user_symbol ( gnc_commodity *  cm,
const char *  user_symbol 
)

Set a user-defined symbol for the specified commodity.

This should be a pointer to a nul terminated string like "£", "US$", etc.

Parameters
cmA pointer to a commodity data structure.
tzA pointer to the symbol for this commodity. This string belongs to the caller and will be duplicated by the engine.

Definition at line 1435 of file gnc-commodity.c.

1436 {
1437  struct lconv *lc;
1438  GValue v = G_VALUE_INIT;
1439  if (!cm) return;
1440 
1441  ENTER ("(cm=%p, symbol=%s)", cm, user_symbol ? user_symbol : "(null)");
1442 
1443  gnc_commodity_begin_edit(cm);
1444 
1445  lc = gnc_localeconv();
1446  if (!user_symbol || !*user_symbol)
1447  user_symbol = NULL;
1448  else if (!g_strcmp0(lc->int_curr_symbol, gnc_commodity_get_mnemonic(cm)) &&
1449  !g_strcmp0(lc->currency_symbol, user_symbol))
1450  /* if the user gives the ISO symbol for the locale currency or the
1451  * default symbol, actually remove the user symbol */
1452  user_symbol = NULL;
1453  else if (!g_strcmp0(user_symbol, gnc_commodity_get_default_symbol(cm)))
1454  user_symbol = NULL;
1455  if (user_symbol)
1456  {
1457  g_value_init (&v, G_TYPE_STRING);
1458  g_value_set_string (&v, user_symbol);
1459  qof_instance_set_kvp (QOF_INSTANCE(cm), "user_symbol", &v);
1460  }
1461  else
1462  qof_instance_set_kvp (QOF_INSTANCE(cm), "user_symbol", NULL);
1463 
1464  mark_commodity_dirty(cm);
1465  gnc_commodity_commit_edit(cm);
1466 
1467  LEAVE(" ");
1468 }
const char * gnc_commodity_get_mnemonic(const gnc_commodity *cm)
Retrieve the mnemonic for the specified commodity.
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
const char * gnc_commodity_get_default_symbol(const gnc_commodity *cm)
Retrieve the default symbol for the specified commodity.
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271
void qof_instance_set_kvp(QofInstance *inst, const gchar *key, const GValue *value)
Sets a KVP slot to a value from a GValue.

◆ gnc_commodity_table_add_default_data()

gboolean gnc_commodity_table_add_default_data ( gnc_commodity_table *  table,
QofBook *  book 
)

Add all the standard namespaces and currencies to the commodity table.

This routine creates the namespaces for the NYSE, NASDAQ, etc. It also adds all of the ISO 4217 currencies to the commodity table.

Parameters
tableA pointer to the commodity table.
bookUnused.

Definition at line 2434 of file gnc-commodity.c.

2435 {
2436  QofCollection *col;
2437  gnc_commodity* c;
2438 
2439  ENTER ("table=%p", table);
2440  gnc_commodity_table_add_namespace(table, GNC_COMMODITY_NS_AMEX, book);
2441  gnc_commodity_table_add_namespace(table, GNC_COMMODITY_NS_NYSE, book);
2442  gnc_commodity_table_add_namespace(table, GNC_COMMODITY_NS_NASDAQ, book);
2443  gnc_commodity_table_add_namespace(table, GNC_COMMODITY_NS_EUREX, book);
2444  gnc_commodity_table_add_namespace(table, GNC_COMMODITY_NS_MUTUAL, book);
2445  gnc_commodity_table_add_namespace(table, GNC_COMMODITY_NS_TEMPLATE, book);
2446  c = gnc_commodity_new(book, "template", GNC_COMMODITY_NS_TEMPLATE, "template", "template", 1);
2447  gnc_commodity_table_insert(table, c);
2448 
2449 #include "iso-4217-currencies.c"
2450 
2451  /* We've just created the default namespaces and currencies. Mark
2452  * these collections as clean because there is no USER entered data
2453  * in these collections as of yet. */
2454  col = qof_book_get_collection(book, GNC_ID_COMMODITY);
2456  col = qof_book_get_collection(book, GNC_ID_COMMODITY_NAMESPACE);
2458 
2459  LEAVE ("table=%p", table);
2460  return TRUE;
2461 }
gnc_commodity * gnc_commodity_table_insert(gnc_commodity_table *table, gnc_commodity *comm)
Add a new commodity to the commodity table.
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
gnc_commodity_namespace * gnc_commodity_table_add_namespace(gnc_commodity_table *table, const char *name_space, QofBook *book)
This function adds a new string to the list of commodity namespaces.
gnc_commodity * gnc_commodity_new(QofBook *book, const char *fullname, const char *name_space, const char *mnemonic, const char *cusip, int fraction)
Create a new commodity.
void qof_collection_mark_clean(QofCollection *)
reset value of dirty flag
Definition: qofid.cpp:261
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271
QofCollection * qof_book_get_collection(const QofBook *book, QofIdType entity_type)
Return The table of entities of the given type.
Definition: qofbook.cpp:599

◆ gnc_commodity_table_add_namespace()

gnc_commodity_namespace* gnc_commodity_table_add_namespace ( gnc_commodity_table *  table,
const char *  commodity_namespace,
QofBook *  book 
)

This function adds a new string to the list of commodity namespaces.

If the new namespace already exists, nothing happens.

Parameters
tableA pointer to the commodity table
commodity_namespaceThe new namespace to be added.
bookThe book that the new namespace will belong to.
Returns
A pointer to the newly created namespace.

Definition at line 2254 of file gnc-commodity.c.

2257 {
2258  gnc_commodity_namespace * ns = NULL;
2259 
2260  if (!table) return NULL;
2261 
2262  name_space = gnc_commodity_table_map_namespace(name_space);
2263  ns = gnc_commodity_table_find_namespace(table, name_space);
2264  if (!ns)
2265  {
2266  ns = g_object_new(GNC_TYPE_COMMODITY_NAMESPACE, NULL);
2267  ns->cm_table = g_hash_table_new(g_str_hash, g_str_equal);
2268  ns->name = CACHE_INSERT((gpointer)name_space);
2269  ns->iso4217 = gnc_commodity_namespace_is_iso(name_space);
2270  qof_instance_init_data (&ns->inst, GNC_ID_COMMODITY_NAMESPACE, book);
2271  qof_event_gen (&ns->inst, QOF_EVENT_CREATE, NULL);
2272 
2273  g_hash_table_insert(table->ns_table,
2274  (gpointer) ns->name,
2275  (gpointer) ns);
2276  table->ns_list = g_list_append(table->ns_list, ns);
2277  qof_event_gen (&ns->inst, QOF_EVENT_ADD, NULL);
2278  }
2279  return ns;
2280 }
void qof_instance_init_data(QofInstance *inst, QofIdType type, QofBook *book)
Initialise the settings associated with an instance.
gboolean gnc_commodity_namespace_is_iso(const char *name_space)
Checks to see if the specified commodity namespace is the namespace for ISO 4217 currencies.
gnc_commodity_namespace * gnc_commodity_table_find_namespace(const gnc_commodity_table *table, const char *name_space)
This function finds a commodity namespace in the set of existing commodity namespaces.
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

◆ gnc_commodity_table_delete_namespace()

void gnc_commodity_table_delete_namespace ( gnc_commodity_table *  table,
const char *  commodity_namespace 
)

This function deletes a string from the list of commodity namespaces.

If the namespace does not exist, nothing happens.

Parameters
tableA pointer to the commodity table
commodity_namespaceThe namespace to be deleted.
Note
This routine will destroy any commodities that exist as part of this namespace. Use it carefully.

Definition at line 2319 of file gnc-commodity.c.

2321 {
2322  gnc_commodity_namespace * ns;
2323 
2324  if (!table) return;
2325 
2326  ns = gnc_commodity_table_find_namespace(table, name_space);
2327  if (!ns)
2328  return;
2329 
2330  qof_event_gen (&ns->inst, QOF_EVENT_REMOVE, NULL);
2331  g_hash_table_remove(table->ns_table, name_space);
2332  table->ns_list = g_list_remove(table->ns_list, ns);
2333 
2334  g_list_free(ns->cm_list);
2335  ns->cm_list = NULL;
2336 
2337  g_hash_table_foreach_remove(ns->cm_table, ns_helper, NULL);
2338  g_hash_table_destroy(ns->cm_table);
2339  CACHE_REMOVE(ns->name);
2340 
2341  qof_event_gen (&ns->inst, QOF_EVENT_DESTROY, NULL);
2342  /* qof_instance_release(&ns->inst); */
2343  g_object_unref(ns);
2344 }
gnc_commodity_namespace * gnc_commodity_table_find_namespace(const gnc_commodity_table *table, const char *name_space)
This function finds a commodity namespace in the set of existing commodity namespaces.
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

◆ gnc_commodity_table_find_namespace()

gnc_commodity_namespace* gnc_commodity_table_find_namespace ( const gnc_commodity_table *  table,
const char *  commodity_namespace 
)

This function finds a commodity namespace in the set of existing commodity namespaces.

Parameters
tableA pointer to the commodity table
commodity_namespaceThe new namespace to be added.
Returns
The a pointer to the namespace found, or NULL if the namespace doesn't exist.

Definition at line 2284 of file gnc-commodity.c.

2286 {
2287  if (!table || !name_space)
2288  return NULL;
2289 
2290  name_space = gnc_commodity_table_map_namespace(name_space);
2291  return g_hash_table_lookup(table->ns_table, (gpointer)name_space);
2292 }

◆ gnc_commodity_table_foreach_commodity()

gboolean gnc_commodity_table_foreach_commodity ( const gnc_commodity_table *  table,
gboolean(*)(gnc_commodity *cm, gpointer user_data)  f,
gpointer  user_data 
)

Call a function once for each commodity in the commodity table.

This table walk returns whenever the end of the table is reached, or the function returns FALSE.

Parameters
tableA pointer to the commodity table
fThe function to call for each commodity.
user_dataA pointer that is passed into the function unchanged by the table walk routine.

◆ gnc_commodity_table_get_commodities()

CommodityList* gnc_commodity_table_get_commodities ( const gnc_commodity_table *  table,
const char *  commodity_namespace 
)

Return a list of all commodities in the commodity table that are in the given namespace.

Parameters
tableA pointer to the commodity table
commodity_namespaceA string indicating which commodities should be returned. It is a required argument.
Returns
A pointer to the list of commodities. NULL if an invalid argument was supplied, or the namespace could not be found.
Note
It is the callers responsibility to free the list.

Definition at line 2135 of file gnc-commodity.c.

2137 {
2138  gnc_commodity_namespace * ns = NULL;
2139 
2140  if (!table)
2141  return NULL;
2142  if (g_strcmp0(name_space, GNC_COMMODITY_NS_NONCURRENCY) == 0)
2143  return commodity_table_get_all_noncurrency_commodities(table);
2144  ns = gnc_commodity_table_find_namespace(table, name_space);
2145  if (!ns)
2146  return NULL;
2147 
2148  return g_hash_table_values(ns->cm_table);
2149 }
gnc_commodity_namespace * gnc_commodity_table_find_namespace(const gnc_commodity_table *table, const char *name_space)
This function finds a commodity namespace in the set of existing commodity namespaces.

◆ gnc_commodity_table_get_namespaces()

GList* gnc_commodity_table_get_namespaces ( const gnc_commodity_table *  t)

Return a list of all namespaces in the commodity table.

This returns both system and user defined namespaces.

Returns
A pointer to the list of names. NULL if an invalid argument was supplied.
Note
It is the callers responsibility to free the list.

Definition at line 2063 of file gnc-commodity.c.

2064 {
2065  if (!table)
2066  return NULL;
2067 
2068  return g_hash_table_keys(table->ns_table);
2069 }

◆ gnc_commodity_table_get_namespaces_list()

GList* gnc_commodity_table_get_namespaces_list ( const gnc_commodity_table *  t)

Return a list of all namespace data structures in the commodity table.

This returns both system and user defined namespace structures.

Returns
A pointer to the list of structures. NULL if an invalid argument was supplied.
Note
This list is owned by the engine. The caller must not free the list.

Definition at line 2072 of file gnc-commodity.c.

2073 {
2074  if (!table)
2075  return NULL;
2076 
2077  return table->ns_list;
2078 }

◆ gnc_commodity_table_get_quotable_commodities()

CommodityList* gnc_commodity_table_get_quotable_commodities ( const gnc_commodity_table *  table)

This function returns a list of commodities for which price quotes should be retrieved.

It will scan the entire commodity table (or a subset) and check each commodity to see if the price_quote_flag field has been set. All matching commodities are queued onto a list, and the head of that list is returned. Use the command-line given expression as a filter on the commodities to be returned. If non-null, only commodities in namespace that match the specified regular expression are checked. If none was given, all commodities are checked.

Parameters
tableA pointer to the commodity table
Returns
A pointer to a list of commodities. NULL if invalid arguments were supplied or if there no commodities are flagged for quote retrieval.
Note
It is the callers responsibility to free the list.

Definition at line 2183 of file gnc-commodity.c.

2184 {
2185  gnc_commodity_namespace * ns = NULL;
2186  const char *name_space;
2187  GList * nslist, * tmp;
2188  GList * l = NULL;
2189  regex_t pattern;
2190  const char *expression = gnc_prefs_get_namespace_regexp();
2191 
2192  ENTER("table=%p, expression=%s", table, expression);
2193  if (!table)
2194  return NULL;
2195 
2196  if (expression && *expression)
2197  {
2198  if (regcomp(&pattern, expression, REG_EXTENDED | REG_ICASE) != 0)
2199  {
2200  LEAVE("Cannot compile regex");
2201  return NULL;
2202  }
2203 
2204  nslist = gnc_commodity_table_get_namespaces(table);
2205  for (tmp = nslist; tmp; tmp = tmp->next)
2206  {
2207  name_space = tmp->data;
2208  if (regexec(&pattern, name_space, 0, NULL, 0) == 0)
2209  {
2210  DEBUG("Running list of %s commodities", name_space);
2211  ns = gnc_commodity_table_find_namespace(table, name_space);
2212  if (ns)
2213  {
2214  g_hash_table_foreach(ns->cm_table, &get_quotables_helper1, (gpointer) &l);
2215  }
2216  }
2217  }
2218  g_list_free(nslist);
2219  regfree(&pattern);
2220  }
2221  else
2222  {
2223  gnc_commodity_table_foreach_commodity(table, get_quotables_helper2,
2224  (gpointer) &l);
2225  }
2226  LEAVE("list head %p", l);
2227  return l;
2228 }
gboolean gnc_commodity_table_foreach_commodity(const gnc_commodity_table *table, gboolean(*f)(gnc_commodity *cm, gpointer user_data), gpointer user_data)
Call a function once for each commodity in the commodity table.
#define DEBUG(format, args...)
Print a debugging message.
Definition: qoflog.h:255
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
GList * gnc_commodity_table_get_namespaces(const gnc_commodity_table *table)
Return a list of all namespaces in the commodity table.
gnc_commodity_namespace * gnc_commodity_table_find_namespace(const gnc_commodity_table *table, const char *name_space)
This function finds a commodity namespace in the set of existing commodity namespaces.
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271

◆ gnc_commodity_table_get_size()

guint gnc_commodity_table_get_size ( const gnc_commodity_table *  tbl)

Returns the number of commodities in the commodity table.

Parameters
tblA pointer to the commodity table
Returns
The number of commodities in the table. 0 if there are no commodities, or the routine was passed a bad argument.

Definition at line 1767 of file gnc-commodity.c.

1768 {
1769  guint count = 0;
1770  g_return_val_if_fail(tbl, 0);
1771  g_return_val_if_fail(tbl->ns_table, 0);
1772 
1773  g_hash_table_foreach(tbl->ns_table, count_coms, (gpointer)&count);
1774 
1775  return count;
1776 }

◆ gnc_commodity_table_has_namespace()

int gnc_commodity_table_has_namespace ( const gnc_commodity_table *  table,
const char *  commodity_namespace 
)

Test to see if the indicated namespace exits in the commodity table.

Parameters
tableA pointer to the commodity table
commodity_namespaceThe new namespace to check.
Returns
1 if the namespace exists. 0 if it doesn't exist, or the routine was passed a bad argument.

Definition at line 2006 of file gnc-commodity.c.

2008 {
2009  gnc_commodity_namespace * nsp = NULL;
2010 
2011  if (!table || !name_space)
2012  {
2013  return 0;
2014  }
2015 
2016  nsp = gnc_commodity_table_find_namespace(table, name_space);
2017  if (nsp)
2018  {
2019  return 1;
2020  }
2021  else
2022  {
2023  return 0;
2024  }
2025 }
gnc_commodity_namespace * gnc_commodity_table_find_namespace(const gnc_commodity_table *table, const char *name_space)
This function finds a commodity namespace in the set of existing commodity namespaces.

◆ gnc_commodity_table_insert()

gnc_commodity* gnc_commodity_table_insert ( gnc_commodity_table *  table,
gnc_commodity *  comm 
)

Add a new commodity to the commodity table.

This routine handles the cases where the commodity already exists in the database (does nothing), or another entries has the same namespace and mnemonic (updates the existing entry).

Parameters
tableA pointer to the commodity table
commA pointer to the commodity to add.
Returns
The added commodity. Null on error.
Note
The commodity pointer passed to this function should not be used after its return, as it may have been destroyed. Use the return value which is guaranteed to be valid.

Definition at line 1893 of file gnc-commodity.c.

1895 {
1896  gnc_commodity_namespace * nsp = NULL;
1897  gnc_commodity *c;
1898  const char *ns_name;
1899  CommodityPrivate* priv;
1900  QofBook *book;
1901 
1902  if (!table) return NULL;
1903  if (!comm) return NULL;
1904 
1905  priv = GET_PRIVATE(comm);
1906 
1907  ENTER ("(table=%p, comm=%p) %s %s", table, comm,
1908  (priv->mnemonic == NULL ? "(null)" : priv->mnemonic),
1909  (priv->fullname == NULL ? "(null)" : priv->fullname));
1910  ns_name = gnc_commodity_namespace_get_name(priv->name_space);
1911  c = gnc_commodity_table_lookup (table, ns_name, priv->mnemonic);
1912 
1913  if (c)
1914  {
1915  if (c == comm)
1916  {
1917  LEAVE("already in table");
1918  return c;
1919  }
1920 
1921  /* Backward compatibility support for currencies that have
1922  * recently changed. */
1923  if (priv->name_space->iso4217)
1924  {
1925  guint i;
1926  for (i = 0; i < GNC_NEW_ISO_CODES; i++)
1927  {
1928  if (!priv->mnemonic
1929  || !strcmp(priv->mnemonic, gnc_new_iso_codes[i].old_code))
1930  {
1931  gnc_commodity_set_mnemonic(comm, gnc_new_iso_codes[i].new_code);
1932  break;
1933  }
1934  }
1935  }
1936  gnc_commodity_copy (c, comm);
1937  gnc_commodity_destroy (comm);
1938  LEAVE("found at %p", c);
1939  return c;
1940  }
1941 
1942  /* Prevent setting anything except template in namespace template. */
1943  if (g_strcmp0 (ns_name, GNC_COMMODITY_NS_TEMPLATE) == 0 &&
1944  g_strcmp0 (priv->mnemonic, "template") != 0)
1945  {
1946  PWARN("Converting commodity %s from namespace template to "
1947  "namespace User", priv->mnemonic);
1948  gnc_commodity_set_namespace (comm, "User");
1949  ns_name = "User";
1950  mark_commodity_dirty (comm);
1951  }
1952 
1953  book = qof_instance_get_book (&comm->inst);
1954  nsp = gnc_commodity_table_add_namespace(table, ns_name, book);
1955 
1956  PINFO ("insert %p %s into nsp=%p %s", priv->mnemonic, priv->mnemonic,
1957  nsp->cm_table, nsp->name);
1958  g_hash_table_insert(nsp->cm_table,
1959  CACHE_INSERT(priv->mnemonic),
1960  (gpointer)comm);
1961  nsp->cm_list = g_list_append(nsp->cm_list, comm);
1962 
1963  qof_event_gen (&comm->inst, QOF_EVENT_ADD, NULL);
1964  LEAVE ("(table=%p, comm=%p)", table, comm);
1965  return comm;
1966 }
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.
#define PINFO(format, args...)
Print an informational note.
Definition: qoflog.h:249
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
gnc_commodity_namespace * gnc_commodity_table_add_namespace(gnc_commodity_table *table, const char *name_space, QofBook *book)
This function adds a new string to the list of commodity namespaces.
const char * gnc_commodity_namespace_get_name(const gnc_commodity_namespace *ns)
Return the textual name of a namespace data strucure.
#define PWARN(format, args...)
Log a warning.
Definition: qoflog.h:243
void gnc_commodity_set_mnemonic(gnc_commodity *cm, const char *mnemonic)
Set the mnemonic for the specified commodity.
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271
void gnc_commodity_set_namespace(gnc_commodity *cm, const char *name_space)
Set the namespace for the specified commodity.
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
void gnc_commodity_copy(gnc_commodity *dest, const gnc_commodity *src)
Copy src into dest.
void gnc_commodity_destroy(gnc_commodity *cm)
Destroy a commodity.

◆ gnc_commodity_table_new()

gnc_commodity_table* gnc_commodity_table_new ( void  )

You proably shouldn't be using gnc_commodity_table_new() directly, its for internal use only.

You should probably be using gnc_commodity_table_get_table()

Definition at line 1704 of file gnc-commodity.c.

1705 {
1706  gnc_commodity_table * retval = g_new0(gnc_commodity_table, 1);
1707  retval->ns_table = g_hash_table_new(&g_str_hash, &g_str_equal);
1708  retval->ns_list = NULL;
1709  return retval;
1710 }

◆ gnc_commodity_table_remove()

void gnc_commodity_table_remove ( gnc_commodity_table *  table,
gnc_commodity *  comm 
)

Remove a commodity from the commodity table.

If the commodity to remove doesn't exist, nothing happens.

Parameters
tableA pointer to the commodity table
commA pointer to the commodity to remove.

Definition at line 1974 of file gnc-commodity.c.

1976 {
1977  gnc_commodity_namespace * nsp;
1978  gnc_commodity *c;
1979  CommodityPrivate* priv;
1980  const char *ns_name;
1981 
1982  if (!table) return;
1983  if (!comm) return;
1984 
1985  priv = GET_PRIVATE(comm);
1986  ns_name = gnc_commodity_namespace_get_name(priv->name_space);
1987  c = gnc_commodity_table_lookup (table, ns_name, priv->mnemonic);
1988  if (c != comm) return;
1989 
1990  qof_event_gen (&comm->inst, QOF_EVENT_REMOVE, NULL);
1991 
1992  nsp = gnc_commodity_table_find_namespace(table, ns_name);
1993  if (!nsp) return;
1994 
1995  nsp->cm_list = g_list_remove(nsp->cm_list, comm);
1996  g_hash_table_remove (nsp->cm_table, priv->mnemonic);
1997  /* XXX minor mem leak, should remove the key as well */
1998 }
const char * gnc_commodity_namespace_get_name(const gnc_commodity_namespace *ns)
Return the textual name of a namespace data strucure.
gnc_commodity_namespace * gnc_commodity_table_find_namespace(const gnc_commodity_table *table, const char *name_space)
This function finds a commodity namespace in the set of existing commodity namespaces.
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

◆ gnc_commodity_user_set_quote_flag()

void gnc_commodity_user_set_quote_flag ( gnc_commodity *  cm,
const gboolean  flag 
)

Set the automatic price quote flag for the specified commodity, based on user input.

This flag indicates whether stock quotes should be retrieved for the specified stock.

It is necessary to have a separate function to distinguish when this setting is being modified by a user so that the auto-enabling/auto-disabling of currencies can be handled properly.

Parameters
cmA pointer to a commodity data structure.
flagTRUE if quotes should be pulled for this commodity, FALSE otherwise.

Definition at line 1336 of file gnc-commodity.c.

1337 {
1338  CommodityPrivate* priv;
1339 
1340  ENTER ("(cm=%p, flag=%d)", cm, flag);
1341 
1342  if (!cm)
1343  {
1344  LEAVE("");
1345  return;
1346  }
1347 
1348  priv = GET_PRIVATE(cm);
1349  gnc_commodity_begin_edit(cm);
1350  gnc_commodity_set_quote_flag(cm, flag);
1351  if (gnc_commodity_is_iso(cm))
1352  {
1353  /* For currencies, disable auto quote control if the quote flag is being
1354  * changed from its default value and enable it if the quote flag is being
1355  * reset to its default value. The defaults for the quote flag are
1356  * disabled if no accounts are using the currency, and true otherwise.
1357  * Thus enable auto quote control if flag is FALSE and there are not any
1358  * accounts using this currency OR flag is TRUE and there are accounts
1359  * using this currency; otherwise disable auto quote control */
1360  gnc_commodity_set_auto_quote_control_flag(cm,
1361  (!flag && (priv->usage_count == 0)) || (flag && (priv->usage_count != 0)));
1362  }
1363  gnc_commodity_commit_edit(cm);
1364  LEAVE("");
1365 }
void gnc_commodity_set_quote_flag(gnc_commodity *cm, const gboolean flag)
Set the automatic price quote flag for the specified commodity.
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271
gboolean gnc_commodity_is_iso(const gnc_commodity *cm)
Checks to see if the specified commodity is an ISO 4217 recognized currency.

◆ gnc_monetary_list_delete_zeros()

MonetaryList* gnc_monetary_list_delete_zeros ( MonetaryList *  list)

Delete all the zero-value entries from a list.

Delete all the zero-value entries from a list.

Return list pointer will be a null pointer if there are no non-zero entries

Definition at line 2593 of file gnc-commodity.c.

2594 {
2595  MonetaryList *node, *next;
2596  for (node = list; node; node = next)
2597  {
2598  gnc_monetary *mon = node->data;
2599  next = node->next;
2600  if (gnc_numeric_zero_p(mon->value))
2601  {
2602  g_free(mon);
2603  list = g_list_delete_link(list, node);
2604  }
2605  }
2606  return list;
2607 }
gboolean gnc_numeric_zero_p(gnc_numeric a)
Returns 1 if the given gnc_numeric is 0 (zero), else returns 0.

◆ gnc_monetary_list_free()

void gnc_monetary_list_free ( MonetaryList *  list)

Free a monetary list and all the items it points to.

Free a monetary list and all the items it points to.

Definition at line 2611 of file gnc-commodity.c.

2612 {
2613  MonetaryList *tmp;
2614  for (tmp = list; tmp; tmp = tmp->next)
2615  {
2616  g_free(tmp->data);
2617  }
2618 
2619  g_list_free(list);
2620 }

◆ gnc_quote_source_add_new()

gnc_quote_source* gnc_quote_source_add_new ( const char *  name,
gboolean  supported 
)

Create a new quote source.

This is called by the F::Q startup code or the XML parsing code to add new entries to the list of available quote sources.

Parameters
nameThe internal name for this new quote source.
supportedTRUE if this quote source is supported by F::Q. Should only be set by the F::Q startup routine.
Returns
A pointer to the newly created quote source.

Definition at line 321 of file gnc-commodity.c.

322 {
323  gnc_quote_source *new_source;
324 
325  DEBUG("Creating new source %s", (source_name == NULL ? "(null)" : source_name));
326  new_source = malloc(sizeof(gnc_quote_source));
327  new_source->supported = supported;
328  new_source->type = SOURCE_UNKNOWN;
329  new_source->index = g_list_length(new_quote_sources);
330 
331  /* This name can be changed if/when support for this price source is
332  * integrated into gnucash. */
333  new_source->user_name = g_strdup(source_name);
334 
335  /* This name is permanent and must be kept the same if/when support
336  * for this price source is integrated into gnucash (i.e. for a
337  * nice user name). */
338  new_source->old_internal_name = g_strdup(source_name);
339  new_source->internal_name = g_strdup(source_name);
340  new_quote_sources = g_list_append(new_quote_sources, new_source);
341  return new_source;
342 }
#define DEBUG(format, args...)
Print a debugging message.
Definition: qoflog.h:255
This is a locally installed quote source that gnucash knows nothing about.

◆ gnc_quote_source_fq_installed()

gboolean gnc_quote_source_fq_installed ( void  )

This function indicates whether or not the Finance::Quote module is installed on a users computer.

This includes any other related modules that gnucash need to process F::Q information.

Returns
TRUE is F::Q is installed properly.

Definition at line 261 of file gnc-commodity.c.

262 {
263  return fq_is_installed;
264 }

◆ gnc_quote_source_get_index()

gint gnc_quote_source_get_index ( const gnc_quote_source *  source)

Given a gnc_quote_source data structure, return the index of this particular quote source within its type.

Parameters
sourceThe quote source in question.
Returns
The index of this quote source in its type.

Definition at line 461 of file gnc-commodity.c.

462 {
463  ENTER("%p", source);
464  if (!source)
465  {
466  LEAVE("bad source");
467  return 0;
468  }
469 
470  LEAVE("index is %d", source->index);
471  return source->index;
472 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271

◆ gnc_quote_source_get_internal_name()

const char* gnc_quote_source_get_internal_name ( const gnc_quote_source *  source)

Given a gnc_quote_source data structure, return the internal name of this quote source.

This is the name used by both gnucash and by Finance::Quote. E.G. "yahoo_australia" or "australia"

Parameters
sourceThe quote source in question.
Returns
The internal name.

Definition at line 502 of file gnc-commodity.c.

503 {
504  ENTER("%p", source);
505  if (!source)
506  {
507  LEAVE("bad source");
508  return NULL;
509  }
510  LEAVE("internal name %s", source->internal_name);
511  return source->internal_name;
512 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271

◆ gnc_quote_source_get_supported()

gboolean gnc_quote_source_get_supported ( const gnc_quote_source *  source)

Given a gnc_quote_source data structure, return the flag that indicates whether this particular quote source is supported by the user's F::Q installation.

Parameters
sourceThe quote source in question.
Returns
TRUE if the user's computer supports this quote source.

Definition at line 475 of file gnc-commodity.c.

476 {
477  ENTER("%p", source);
478  if (!source)
479  {
480  LEAVE("bad source");
481  return FALSE;
482  }
483 
484  LEAVE("%ssupported", source && source->supported ? "" : "not ");
485  return source->supported;
486 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271

◆ gnc_quote_source_get_type()

QuoteSourceType gnc_quote_source_get_type ( const gnc_quote_source *  source)

Given a gnc_quote_source data structure, return the type of this particular quote source.

(SINGLE, MULTI, UNKNOWN)

Parameters
sourceThe quote source in question.
Returns
The type of this quote source.

Definition at line 447 of file gnc-commodity.c.

448 {
449  ENTER("%p", source);
450  if (!source)
451  {
452  LEAVE("bad source");
453  return SOURCE_SINGLE;
454  }
455 
456  LEAVE("type is %d", source->type);
457  return source->type;
458 }
This quote source pulls from a single specific web site.
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271

◆ gnc_quote_source_get_user_name()

const char* gnc_quote_source_get_user_name ( const gnc_quote_source *  source)

Given a gnc_quote_source data structure, return the user friendly name of this quote source.

E.G. "Yahoo Australia" or "Australia (Yahoo, ASX, ...)"

Parameters
sourceThe quote source in question.
Returns
The user friendly name.

Definition at line 489 of file gnc-commodity.c.

490 {
491  ENTER("%p", source);
492  if (!source)
493  {
494  LEAVE("bad source");
495  return NULL;
496  }
497  LEAVE("user name %s", source->user_name);
498  return source->user_name;
499 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271

◆ gnc_quote_source_lookup_by_internal()

gnc_quote_source* gnc_quote_source_lookup_by_internal ( const char *  internal_name)

Given the internal (gnucash or F::Q) name of a quote source, find the data structure identified by this name.

Parameters
internal_nameThe name of this quote source.
Returns
A pointer to the price quote source that has the specified internal name.

Definition at line 396 of file gnc-commodity.c.

397 {
398  gnc_quote_source *source;
399  GList *node;
400  gint i;
401 
402  if ((name == NULL) || (g_strcmp0(name, "") == 0))
403  {
404  return NULL;
405  }
406 
407  if (g_strcmp0(name, currency_quote_source.internal_name) == 0)
408  return &currency_quote_source;
409  if (g_strcmp0(name, currency_quote_source.old_internal_name) == 0)
410  return &currency_quote_source;
411 
412  for (i = 0; i < num_single_quote_sources; i++)
413  {
414  if (g_strcmp0(name, single_quote_sources[i].internal_name) == 0)
415  return &single_quote_sources[i];
416  if (g_strcmp0(name, single_quote_sources[i].old_internal_name) == 0)
417  return &single_quote_sources[i];
418  }
419 
420  for (i = 0; i < num_multiple_quote_sources; i++)
421  {
422  if (g_strcmp0(name, multiple_quote_sources[i].internal_name) == 0)
423  return &multiple_quote_sources[i];
424  if (g_strcmp0(name, multiple_quote_sources[i].old_internal_name) == 0)
425  return &multiple_quote_sources[i];
426  }
427 
428  for (i = 0, node = new_quote_sources; node; node = node->next, i++)
429  {
430  source = node->data;
431  if (g_strcmp0(name, source->internal_name) == 0)
432  return source;
433  if (g_strcmp0(name, source->old_internal_name) == 0)
434  return source;
435  }
436 
437  DEBUG("gnc_quote_source_lookup_by_internal: Unknown source %s", name);
438  return NULL;
439 }
#define DEBUG(format, args...)
Print a debugging message.
Definition: qoflog.h:255

◆ gnc_quote_source_lookup_by_ti()

gnc_quote_source* gnc_quote_source_lookup_by_ti ( QuoteSourceType  type,
gint  index 
)

Given the type/index of a quote source, find the data structure identified by this pair.

Parameters
typeThe type of this quote source.
indexThe index of this quote source within its type.
Returns
A pointer to the price quote source that has the specified type/index.

Definition at line 350 of file gnc-commodity.c.

351 {
352  gnc_quote_source *source;
353  GList *node;
354 
355  ENTER("type/index is %d/%d", type, index);
356  switch (type)
357  {
358  case SOURCE_CURRENCY:
359  LEAVE("found %s", currency_quote_source.user_name);
360  return &currency_quote_source;
361  break;
362 
363  case SOURCE_SINGLE:
364  if (index < num_single_quote_sources)
365  {
366  LEAVE("found %s", single_quote_sources[index].user_name);
367  return &single_quote_sources[index];
368  }
369  break;
370 
371  case SOURCE_MULTI:
372  if (index < num_multiple_quote_sources)
373  {
374  LEAVE("found %s", multiple_quote_sources[index].user_name);
375  return &multiple_quote_sources[index];
376  }
377  break;
378 
379  case SOURCE_UNKNOWN:
380  default:
381  node = g_list_nth(new_quote_sources, index);
382  if (node)
383  {
384  source = node->data;
385  LEAVE("found %s", source->user_name);
386  return source;
387  }
388  break;
389  }
390 
391  LEAVE("not found");
392  return NULL;
393 }
This quote source pulls from a single specific web site.
The special currency quote source.
This is a locally installed quote source that gnucash knows nothing about.
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
This quote source may pull from multiple web sites.
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271

◆ gnc_quote_source_num_entries()

gint gnc_quote_source_num_entries ( QuoteSourceType  type)

Return the number of entries for a given type of quote source.

Parameters
typeThe quote source type whose count should be returned.
Returns
The number of entries for this type of quote source.

Definition at line 271 of file gnc-commodity.c.

272 {
273  if (type == SOURCE_CURRENCY)
274  return 1;
275 
276  if (type == SOURCE_SINGLE)
277  return num_single_quote_sources;
278 
279  if (type == SOURCE_MULTI)
280  return num_multiple_quote_sources;
281 
282  return g_list_length(new_quote_sources);
283 }
This quote source pulls from a single specific web site.
The special currency quote source.
This quote source may pull from multiple web sites.

◆ gnc_quote_source_set_fq_installed()

void gnc_quote_source_set_fq_installed ( const GList *  sources_list)

Update gnucash internal tables based on what Finance::Quote sources are installed.

Sources that have been explicitly coded into gnucash are marked sensitive/insensitive based upon whether they are present. New sources that gnucash doesn't know about are added to its internal tables.

Parameters
sources_listA list of strings containing the source names as they are known to F::Q.

Definition at line 521 of file gnc-commodity.c.

522 {
523  gnc_quote_source *source;
524  char *source_name;
525  const GList *node;
526 
527  ENTER(" ");
528  fq_is_installed = TRUE;
529 
530  if (!sources_list)
531  return;
532 
533  for (node = sources_list; node; node = node->next)
534  {
535  source_name = node->data;
536 
537  source = gnc_quote_source_lookup_by_internal(source_name);
538  if (source != NULL)
539  {
540  DEBUG("Found source %s: %s", source_name, source->user_name);
541  source->supported = TRUE;
542  continue;
543  }
544 
545  gnc_quote_source_add_new(source_name, TRUE);
546  }
547  LEAVE(" ");
548 }
gnc_quote_source * gnc_quote_source_add_new(const char *source_name, gboolean supported)
Create a new quote source.
#define DEBUG(format, args...)
Print a debugging message.
Definition: qoflog.h:255
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:261
gnc_quote_source * gnc_quote_source_lookup_by_internal(const char *name)
Given the internal (gnucash or F::Q) name of a quote source, find the data structure identified by th...
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:271