46 #ifndef GNC_COMMODITY_H 47 #define GNC_COMMODITY_H 55 #include <glib/gi18n.h> 66 #define GNC_TYPE_COMMODITY (gnc_commodity_get_type ()) 67 #define GNC_COMMODITY(o) \ 68 (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_COMMODITY, gnc_commodity)) 69 #define GNC_COMMODITY_CLASS(k) \ 70 (G_TYPE_CHECK_CLASS_CAST((k), GNC_TYPE_COMMODITY, gnc_commodityClass)) 71 #define GNC_IS_COMMODITY(o) \ 72 (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_COMMODITY)) 73 #define GNC_IS_COMMODITY_CLASS(k) \ 74 (G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_COMMODITY)) 75 #define GNC_COMMODITY_GET_CLASS(o) \ 76 (G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_COMMODITY, gnc_commodityClass)) 77 GType gnc_commodity_get_type(
void);
80 #define GNC_TYPE_COMMODITY_NAMESPACE (gnc_commodity_namespace_get_type ()) 81 #define GNC_COMMODITY_NAMESPACE(o) \ 82 (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_COMMODITY_NAMESPACE, gnc_commodity_namespace)) 83 #define GNC_COMMODITY_NAMESPACE_CLASS(k) \ 84 (G_TYPE_CHECK_CLASS_CAST((k), GNC_TYPE_COMMODITY_NAMESPACE, gnc_commodity_namespaceClass)) 85 #define GNC_IS_COMMODITY_NAMESPACE(o) \ 86 (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_COMMODITY_NAMESPACE)) 87 #define GNC_IS_COMMODITY_NAMESPACE_CLASS(k) \ 88 (G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_COMMODITY_NAMESPACE)) 89 #define GNC_COMMODITY_NAMESPACE_GET_CLASS(o) \ 90 (G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_COMMODITY_NAMESPACE, gnc_commodity_namespaceClass)) 91 GType gnc_commodity_namespace_get_type(
void);
94 #define GNC_COMMODITY_TABLE "gnc_commodity_table" 107 #define GNC_COMMODITY_NS_LEGACY "GNC_LEGACY_CURRENCIES" 108 #define GNC_COMMODITY_NS_TEMPLATE "template" 110 #define GNC_COMMODITY_NS_ISO "ISO4217" 111 #define GNC_COMMODITY_NS_CURRENCY "CURRENCY" 112 #define GNC_COMMODITY_NS_NONCURRENCY "NONCURRENCY" 114 #define GNC_COMMODITY_NS_NONISO_GUI NC_("Commodity Type", "All non-currency") 115 #define GNC_COMMODITY_NS_ISO_GUI NC_("Commodity Type", "Currencies") 120 #define GNC_COMMODITY_MAX_FRACTION 1000000000 122 typedef GList CommodityList;
175 const GList *sources_list);
312 const char * fullname,
313 const char * commodity_namespace,
314 const char * mnemonic,
457 gnc_quote_source* gnc_commodity_get_default_quote_source(
const gnc_commodity *cm);
590 const gboolean flag);
742 gnc_commodity * gnc_commodity_table_lookup(
const gnc_commodity_table *
table,
743 const char * commodity_namespace,
744 const char * mnemonic);
746 gnc_commodity_table_lookup_unique(
const gnc_commodity_table *
table,
747 const char * unique_name);
748 gnc_commodity * gnc_commodity_table_find_full(
const gnc_commodity_table * t,
749 const char * commodity_namespace,
750 const char * fullname);
753 gnc_commodity * gnc_commodity_find_commodity_by_guid(
const GncGUID *guid,
779 gnc_commodity * comm);
788 gnc_commodity * comm);
846 const char * commodity_namespace);
877 const char * commodity_namespace,
889 const char * commodity_namespace);
901 const char * commodity_namespace);
929 const gnc_commodity_table *
table,
const char * commodity_namespace);
949 const gnc_commodity_table *
table);
962 gboolean (*f)(gnc_commodity *cm,
978 void gnc_commodity_table_destroy(gnc_commodity_table *
table);
993 void gnc_commodity_begin_edit (gnc_commodity *cm);
994 void gnc_commodity_commit_edit (gnc_commodity *cm);
999 #define gnc_commodity_get_kvp_frame(cm) \ 1000 qof_instance_get_slots(QOF_INSTANCE(cm)) 1009 gnc_commodity *commodity;
1019 typedef GList MonetaryList;
1025 gnc_monetary gnc_monetary_create(gnc_commodity *commod, gnc_numeric val)
1028 out.commodity = commod;
1038 gnc_commodity * gnc_monetary_commodity(gnc_monetary a)
1044 gnc_numeric gnc_monetary_value(gnc_monetary a)
1059 MonetaryList *gnc_monetary_list_add_value(MonetaryList *list,
1060 gnc_commodity *commod,
1064 gnc_monetary_create(commod, value));
gnc_commodity * gnc_commodity_table_insert(gnc_commodity_table *table, gnc_commodity *comm)
Add a new commodity to the commodity table.
const char * gnc_commodity_get_cusip(const gnc_commodity *cm)
Retrieve the 'exchange code' for the specified commodity.
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.
gnc_commodity_table * gnc_commodity_table_get_table(QofBook *book)
Returns the commodity table associated with a book.
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...
int gnc_commodity_get_fraction(const gnc_commodity *cm)
Retrieve the fraction for the specified commodity.
gboolean gnc_commodity_table_add_default_data(gnc_commodity_table *table, QofBook *book)
Add all the standard namespaces and currencies to the commodity table.
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...
const char * gnc_commodity_get_mnemonic(const gnc_commodity *cm)
Retrieve the mnemonic for the specified commodity.
This quote source pulls from a single specific web site.
gnc_quote_source * gnc_quote_source_add_new(const char *name, gboolean supported)
Create a new quote source.
const char * gnc_commodity_namespace_get_gui_name(const gnc_commodity_namespace *ns)
Return the textual name of a namespace data structure in a form suitable to present to the user...
gboolean gnc_commodity_get_quote_flag(const gnc_commodity *cm)
Retrieve the automatic price quote flag for the specified commodity.
const char * gnc_commodity_get_user_symbol(const gnc_commodity *cm)
Retrieve the user-defined symbol for the specified commodity.
void gnc_commodity_set_quote_tz(gnc_commodity *cm, const char *tz)
Set the automatic price quote timezone for the specified commodity.
void gnc_commodity_decrement_usage_count(gnc_commodity *cm)
Decrement a commodity's internal counter that tracks how many accounts are using that commodity...
const char * gnc_commodity_get_quote_tz(const gnc_commodity *cm)
Retrieve the automatic price quote timezone for the specified commodity.
void gnc_commodity_set_fraction(gnc_commodity *cm, int smallest_fraction)
Set the fraction for the specified commodity.
gboolean gnc_commodity_equal(const gnc_commodity *a, const gnc_commodity *b)
This routine returns TRUE if the two commodities are equal.
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...
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...
The special currency quote source.
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_l...
gnc_commodity * gnc_commodity_clone(const gnc_commodity *src, QofBook *dest_book)
allocate and copy
This is a locally installed quote source that gnucash knows nothing about.
const char * gnc_commodity_get_namespace(const gnc_commodity *cm)
Retrieve the namespace for the specified commodity.
void gnc_commodity_set_quote_flag(gnc_commodity *cm, const gboolean flag)
Set the automatic price quote flag for the specified commodity.
QuoteSourceType
The quote source type enum account types are used to determine how the transaction data in the accoun...
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...
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.
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.
GList * gnc_commodity_namespace_get_commodity_list(const gnc_commodity_namespace *ns)
Return a list of all commodity data structures in the specified namespace.
void gnc_commodity_set_user_symbol(gnc_commodity *cm, const char *user_symbol)
Set a user-defined symbol for the specified commodity.
const char * gnc_commodity_namespace_get_name(const gnc_commodity_namespace *ns)
Return the textual name of a namespace data structure.
void gnc_quote_source_set_fq_installed(const char *version_string, const GList *sources_list)
Update gnucash internal tables based on what Finance::Quote sources are installed.
MonetaryList * gnc_monetary_list_delete_zeros(MonetaryList *list)
Delete all the zero-value entries from a list.
void gnc_commodity_set_quote_source(gnc_commodity *cm, gnc_quote_source *src)
Set the automatic price quote source for the specified commodity.
gint gnc_quote_source_num_entries(QuoteSourceType type)
Return the number of entries for a given type of quote source.
GList * gnc_commodity_table_get_namespaces(const gnc_commodity_table *t)
Return a list of all namespaces in the commodity table.
gboolean gnc_commodity_table_register(void)
You should probably not be using gnc_commodity_table_register() It is an internal routine for registe...
void gnc_commodity_increment_usage_count(gnc_commodity *cm)
Increment a commodity's internal counter that tracks how many accounts are using that commodity...
void gnc_commodity_set_cusip(gnc_commodity *cm, const char *cusip)
Set the 'exchange code' for the specified commodity.
void gnc_monetary_list_free(MonetaryList *list)
Free a monetary list and all the items it points to.
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.
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.
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.
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.
const char * gnc_commodity_get_fullname(const gnc_commodity *cm)
Retrieve the full name for the specified commodity.
const char * gnc_commodity_get_nice_symbol(const gnc_commodity *cm)
Retrieve a symbol for the specified commodity, suitable for display to the user.
All type declarations for the whole Gnucash engine.
const char * gnc_quote_source_fq_version(void)
This function returns the version of the Finance::Quote module installed on a user's computer...
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.
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 th...
const char * gnc_commodity_get_printname(const gnc_commodity *cm)
Retrieve the 'print' name for the specified commodity.
int gnc_commodity_compare(const gnc_commodity *a, const gnc_commodity *b)
This routine returns 0 if the two commodities are equal, 1 otherwise.
void gnc_commodity_set_fullname(gnc_commodity *cm, const char *fullname)
Set the full name for the specified commodity.
This quote source may pull from multiple web sites.
gnc_quote_source * gnc_commodity_get_quote_source(const gnc_commodity *cm)
Retrieve the automatic price quote source for the specified commodity.
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.
void gnc_commodity_set_mnemonic(gnc_commodity *cm, const char *mnemonic)
Set the mnemonic for the specified commodity.
const char * gnc_commodity_get_default_symbol(const gnc_commodity *cm)
Retrieve the default symbol for the specified commodity.
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.
gnc_commodity_table * gnc_commodity_table_new(void)
You probably shouldn't be using gnc_commodity_table_new() directly, it's for internal use only...
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 ...
gnc_commodity_namespace * gnc_commodity_get_namespace_ds(const gnc_commodity *cm)
Retrieve the namespace data structure for the specified commodity.
const char * gnc_commodity_get_unique_name(const gnc_commodity *cm)
Retrieve the 'unique' name for the specified commodity.
MonetaryList * gnc_monetary_list_add_monetary(MonetaryList *list, gnc_monetary mon)
Add a gnc_monetary to the list.
void gnc_commodity_table_remove(gnc_commodity_table *table, gnc_commodity *comm)
Remove a commodity from the commodity table.
void gnc_commodity_set_namespace(gnc_commodity *cm, const char *new_namespace)
Set the namespace for the specified commodity.
guint gnc_commodity_table_get_size(const gnc_commodity_table *tbl)
Returns the number of commodities in the commodity table.
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.
The type used to store guids in C.
void gnc_commodity_copy(gnc_commodity *dest, const gnc_commodity *src)
Copy src into dest.
GList * gnc_commodity_table_get_namespaces_list(const gnc_commodity_table *t)
Return a list of all namespace data structures in the commodity 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...
void gnc_commodity_destroy(gnc_commodity *cm)
Destroy a commodity.
gboolean gnc_commodity_equiv(const gnc_commodity *a, const gnc_commodity *b)
This routine returns TRUE if the two commodities are equivalent.
gboolean gnc_commodity_is_iso(const gnc_commodity *cm)
Checks to see if the specified commodity is an ISO 4217 recognized currency.
gboolean gnc_quote_source_fq_installed(void)
This function indicates whether or not the Finance::Quote module is installed on a user's computer...