Prices

Each price in the database represents an "instantaneous" quote for a given commodity with respect to another commodity. More...

Macros
#define	PRICE_TYPE_LAST   "last"
#define	PRICE_TYPE_UNK   "unknown"
#define	PRICE_TYPE_TRN   "transaction"

Typedefs
typedef GList	PriceList

Enumerations
enum	PriceSource {   PRICE_SOURCE_EDIT_DLG, PRICE_SOURCE_FQ, PRICE_SOURCE_USER_PRICE, PRICE_SOURCE_XFER_DLG_VAL,   PRICE_SOURCE_SPLIT_REG, PRICE_SOURCE_SPLIT_IMPORT, PRICE_SOURCE_STOCK_SPLIT, PRICE_SOURCE_STOCK_TRANSACTION,   PRICE_SOURCE_INVOICE, PRICE_SOURCE_TEMP, PRICE_SOURCE_INVALID }
	Price source enum. More...

Constructors
GNCPrice *	gnc_price_create (QofBook *book)
	gnc_price_create - returns a newly allocated and initialized price with a reference count of 1. More...
GNCPrice *	gnc_price_clone (GNCPrice *p, QofBook *book)
	gnc_price_clone - returns a newly allocated price that's a content-wise duplicate of the given price, p. More...
GNCPrice *	gnc_price_invert (GNCPrice *p)
	Return a newly-allocated price that's the inverse of the given price, p. More...

Memory Management
void	gnc_price_ref (GNCPrice *p)
	gnc_price_ref - indicate your need for a given price to stick around (i.e. More...
void	gnc_price_unref (GNCPrice *p)
	gnc_price_unref - indicate you're finished with a price (i.e. More...

Setters
All of the setters store copies of the data given, with the exception of the commodity field which just stores the pointer given. It is assumed that commodities are a global resource and are pointer unique. Invocations of the setters should be wrapped with calls to gnc_price_begin_edit() and commit_edit(). The begin/commit calls help ensure that the local price db is synchronized with the backend.
void	gnc_price_begin_edit (GNCPrice *p)
void	gnc_price_commit_edit (GNCPrice *p)
void	gnc_price_set_commodity (GNCPrice *p, gnc_commodity *c)
void	gnc_price_set_currency (GNCPrice *p, gnc_commodity *c)
void	gnc_price_set_time64 (GNCPrice *p, time64 t)
void	gnc_price_set_source (GNCPrice *p, PriceSource source)
void	gnc_price_set_source_string (GNCPrice *p, const char *s)
void	gnc_price_set_typestr (GNCPrice *p, const char *type)
void	gnc_price_set_value (GNCPrice *p, gnc_numeric value)

Getters
All of the getters return data that's internal to the GNCPrice, not copies, so don't free these values.
GNCPrice *	gnc_price_lookup (const GncGUID *guid, QofBook *book)
gnc_commodity *	gnc_price_get_commodity (const GNCPrice *p)
gnc_commodity *	gnc_price_get_currency (const GNCPrice *p)
time64	gnc_price_get_time64 (const GNCPrice *p)
PriceSource	gnc_price_get_source (const GNCPrice *p)
const char *	gnc_price_get_source_string (const GNCPrice *p)
const char *	gnc_price_get_typestr (const GNCPrice *p)
gnc_numeric	gnc_price_get_value (const GNCPrice *p)
gboolean	gnc_price_equal (const GNCPrice *p1, const GNCPrice *p2)
#define	gnc_price_get_guid(X)   qof_entity_get_guid(QOF_INSTANCE(X))
#define	gnc_price_return_guid(X)   (*(qof_entity_get_guid(QOF_INSTANCE(X))))
#define	gnc_price_get_book(X)   qof_instance_get_book(QOF_INSTANCE(X))

Internal/Debugging
void	gnc_price_print (GNCPrice *db, FILE *f, int indent)
	This simple function can be useful for debugging the price code.
void	gnc_pricedb_print_contents (GNCPriceDB *db, FILE *f)
	This simple function can be useful for debugging the pricedb code.

Denominator Constants Price policy: In order to avoid rounding
problems, currency prices (often called exchange rates) are saved in terms of the smaller currency, so that price > 1, with a fixed denominator of 1/1000. Commodity prices in currency are always expressed as value per unit of the commodity with a fixed denominator of the pricing currency's SCU * 10000.
#define	CURRENCY_DENOM   10000
#define	COMMODITY_DENOM_MULT   10000

GNCPrice lists
The database communicates multiple prices in and out via gnc price lists. These are just time sorted GLists of GNCPrice pointers. Functions for manipulating these lists are provided. These functions are helpful in that they handle maintaining proper reference counts on behalf of the price list for every price being held in a given list. I.e. insert "refs" the prices being inserted, remove and destroy "unref" the prices that will no longer be referred to by the list.
gboolean	gnc_price_list_insert (PriceList **prices, GNCPrice *p, gboolean check_dupl)
	gnc_price_list_insert - insert a price into the given list, calling gnc_price_ref on it during the process. More...
gboolean	gnc_price_list_remove (PriceList **prices, GNCPrice *p)
	gnc_price_list_remove - remove the price, p, from the given list, calling gnc_price_unref on it during the process. More...
void	gnc_price_list_destroy (PriceList *prices)
	gnc_price_list_destroy - destroy the given price list, calling gnc_price_unref on all the prices included in the list. More...
gboolean	gnc_price_list_equal (PriceList *prices1, PriceList *prices2)

Detailed Description

Each price in the database represents an "instantaneous" quote for a given commodity with respect to another commodity.

For example, a given price might represent the value of LNUX in USD on 2001-02-03.

Fields:

• commodity: the item being priced.
• currency: the denomination of the value of the item being priced.
• value: the value of the item being priced.
• time: the time the price was valid.
• source: a string describing the source of the quote. These strings will be something like this: "Finance::Quote", "user:misc", "user:foo", etc. If the quote came from a user, as a matter of policy, you must prefix the string you give with "user:". For now, the only other reserved values are "Finance::Quote" and "old-file-import". Any string used must be added to the source_list array in dialog-price-edit-db.c so that it can be properly translated. (There are unfortunately many strings in users' databases, so this string must be translated on output instead of always being used in untranslated form).
• type: the type of quote - types possible right now are bid, ask, last, nav, transaction, and unknown. 'Transaction' is set when the price is created from an amount and value in a Split and is not available for users to set via the GUI.

Implementation Details:

Note

For source and type, NULL and the empty string are considered the same, so if one of these is "", then after a file save/restore, it might be NULL. Behave accordingly.

GNCPrices are reference counted. When you gnc_price_create one or clone it, the new price's count is set to 1. When you are finished with a price, call gnc_price_unref. If you hand the price pointer to some other code that needs to keep it, make sure it calls gnc_price_ref to indicate its interest in that price, and calls gnc_price_unref when it's finished with the price. For those unfamiliar with reference counting, basically each price stores an integer count which starts at 1 and is incremented every time someone calls gnc_price_ref. Conversely, the count is decremented every time someone calls gnc_price_unref. If the count ever reaches 0, the price is destroyed.

All of the getters return data that's internal to the GNCPrice, not copies, so don't free these values.

All of the setters store copies of the data given, with the exception of the commodity field which just stores the pointer given. It is assumed that commodities are a global resource and are pointer unique.

Enumeration Type Documentation

PriceSource

enum PriceSource

Price source enum.

Be sure to keep in sync with the source_name array in gnc-pricedb.c. These are in preference order, so for example a quote with PRICE_SOURCE_EDIT_DLG will overwrite one with PRICE_SOURCE_FQ but not the other way around.

Definition at line 169 of file gnc-pricedb.h.

{
    PRICE_SOURCE_EDIT_DLG,         // "user:price-editor"
    PRICE_SOURCE_FQ,               // "Finance::Quote"
    PRICE_SOURCE_USER_PRICE,       // "user:price"
    PRICE_SOURCE_XFER_DLG_VAL,     // "user:xfer-dialog"
    PRICE_SOURCE_SPLIT_REG,        // "user:split-register"
    PRICE_SOURCE_SPLIT_IMPORT,     // "user:split-import"
    PRICE_SOURCE_STOCK_SPLIT,      // "user:stock-split"
    PRICE_SOURCE_STOCK_TRANSACTION,// "user:stock-transaction"
    PRICE_SOURCE_INVOICE,          // "user:invoice-post"
    PRICE_SOURCE_TEMP,             // "temporary"
    PRICE_SOURCE_INVALID,          // "invalid"
} PriceSource;

Function Documentation

gnc_price_clone()

GNCPrice* gnc_price_clone	(	GNCPrice *	p,
		QofBook *	book
	)

gnc_price_clone - returns a newly allocated price that's a content-wise duplicate of the given price, p.

The returned clone will have a reference count of 1.

Definition at line 353 of file gnc-pricedb.cpp.

{
    /* the clone doesn't belong to a PriceDB */
    GNCPrice *new_p;

    g_return_val_if_fail (book, nullptr);

    ENTER ("pr=%p", p);

    if (!p)
    {
        LEAVE ("return nullptr");
        return nullptr;
    }

    new_p = gnc_price_create(book);
    if (!new_p)
    {
        LEAVE ("return nullptr");
        return nullptr;
    }

    qof_instance_copy_version(new_p, p);

    gnc_price_begin_edit(new_p);
    /* never ever clone guid's */
    gnc_price_set_commodity(new_p, gnc_price_get_commodity(p));
    gnc_price_set_time64(new_p, gnc_price_get_time64(p));
    gnc_price_set_source(new_p, gnc_price_get_source(p));
    gnc_price_set_typestr(new_p, gnc_price_get_typestr(p));
    gnc_price_set_value(new_p, gnc_price_get_value(p));
    gnc_price_set_currency(new_p, gnc_price_get_currency(p));
    gnc_price_commit_edit(new_p);
    LEAVE ("return cloned price %p", new_p);
    return(new_p);
}

gnc_price_create()

GNCPrice* gnc_price_create

(

QofBook *

book

)

gnc_price_create - returns a newly allocated and initialized price with a reference count of 1.

Definition at line 294 of file gnc-pricedb.cpp.

{
    GNCPrice *p;

    g_return_val_if_fail (book, nullptr);

    ENTER(" ");
    p = static_cast<GNCPrice*>(g_object_new(GNC_TYPE_PRICE, nullptr));

    qof_instance_init_data (&p->inst, GNC_ID_PRICE, book);
    qof_event_gen (&p->inst, QOF_EVENT_CREATE, nullptr);
    LEAVE ("price created %p", p);
    return p;
}

gnc_price_invert()

GNCPrice* gnc_price_invert

(

GNCPrice *

p

)

Return a newly-allocated price that's the inverse of the given price, p.

Inverse means that the commodity and currency are swapped and the value is the numeric inverse of the original's. The source is set to PRICE_SOURCE_TEMP to prevent it being saved in the pricedb.

Parameters

p	The price to invert

Returns

a new price, with a ref-count of 1. Don't forget to unref it!

Definition at line 391 of file gnc-pricedb.cpp.

{
    QofBook *book = qof_instance_get_book (QOF_INSTANCE(p));
    GNCPrice *new_p = gnc_price_create (book);
    qof_instance_copy_version(new_p, p);
    gnc_price_begin_edit(new_p);
    gnc_price_set_time64(new_p, gnc_price_get_time64(p));
    gnc_price_set_source(new_p, PRICE_SOURCE_TEMP);
    gnc_price_set_typestr(new_p, gnc_price_get_typestr(p));
    gnc_price_set_commodity(new_p, gnc_price_get_currency(p));
    gnc_price_set_currency(new_p, gnc_price_get_commodity(p));
    gnc_price_set_value(new_p, gnc_numeric_invert(gnc_price_get_value(p)));
    gnc_price_commit_edit(new_p);
    return new_p;
}

gnc_price_list_destroy()

void gnc_price_list_destroy

(

PriceList *

prices

)

gnc_price_list_destroy - destroy the given price list, calling gnc_price_unref on all the prices included in the list.

Definition at line 741 of file gnc-pricedb.cpp.

{
    g_list_free_full (prices, (GDestroyNotify)gnc_price_unref);
}

gnc_price_list_insert()

gboolean gnc_price_list_insert	(	PriceList **	prices,
		GNCPrice *	p,
		gboolean	check_dupl
	)

gnc_price_list_insert - insert a price into the given list, calling gnc_price_ref on it during the process.

Definition at line 705 of file gnc-pricedb.cpp.

{
    if (!prices || !p) return FALSE;
    gnc_price_ref(p);

    if (check_dupl && g_list_find_custom (*prices, p, (GCompareFunc)price_is_duplicate))
        return true;

    auto result_list = g_list_insert_sorted(*prices, p, compare_prices_by_date);
    if (!result_list)
        return false;

    *prices = result_list;
    return true;
}

gnc_price_list_remove()

gboolean gnc_price_list_remove	(	PriceList **	prices,
		GNCPrice *	p
	)

gnc_price_list_remove - remove the price, p, from the given list, calling gnc_price_unref on it during the process.

Definition at line 722 of file gnc-pricedb.cpp.

{
    GList *result_list;
    GList *found_element;

    if (!prices || !p) return FALSE;

    found_element = g_list_find(*prices, p);
    if (!found_element) return TRUE;

    result_list = g_list_remove_link(*prices, found_element);
    gnc_price_unref((GNCPrice *) found_element->data);
    g_list_free(found_element);

    *prices = result_list;
    return TRUE;
}

gnc_price_ref()

void gnc_price_ref

(

GNCPrice *

p

)

gnc_price_ref - indicate your need for a given price to stick around (i.e.

increase its reference count by 1).

Definition at line 323 of file gnc-pricedb.cpp.

{
    if (!p) return;
    p->refcount++;
}

gnc_price_unref()

void gnc_price_unref

(

GNCPrice *

p

)

gnc_price_unref - indicate you're finished with a price (i.e.

decrease its reference count by 1).

Definition at line 330 of file gnc-pricedb.cpp.

{
    if (!p) return;
    if (p->refcount == 0)
    {
        return;
    }

    p->refcount--;

    if (p->refcount <= 0)
    {
        if (nullptr != p->db)
        {
            PERR("last unref while price in database");
        }
        gnc_price_destroy (p);
    }
}