GnuCash  3.7-134-g71bdcdfa6+
Files | Data Structures | Macros | Functions
Lots: Core Function for AR/AP, Inventory, Stock Lots, Cap Gains

One often needs to know that the item 'bought' in one transaction is the same one as the item 'sold' in a different transaction. More...

Files

file  gnc-lot.h
 

Data Structures

struct  GncLotClass
 

Macros

#define GNCLotClass   GncLotClass
 
#define GNC_TYPE_LOT   (gnc_lot_get_type ())
 
#define GNC_LOT(o)   (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_LOT, GNCLot))
 
#define GNC_LOT_CLASS(k)   (G_TYPE_CHECK_CLASS_CAST((k), GNC_TYPE_LOT, GNCLotClass))
 
#define GNC_IS_LOT(o)   (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_LOT))
 
#define GNC_IS_LOT_CLASS(k)   (G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_LOT))
 
#define GNC_LOT_GET_CLASS(o)   (G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_LOT, GNCLotClass))
 
#define gnc_lot_get_guid(X)   qof_entity_get_guid(QOF_INSTANCE(X))
 
#define LOT_IS_CLOSED   "is-closed?"
 
#define LOT_BALANCE   "balance"
 
#define LOT_TITLE   "lot-title"
 
#define LOT_NOTES   "notes"
 

Functions

GType gnc_lot_get_type (void)
 
GNCLot * gnc_lot_new (QofBook *)
 
void gnc_lot_destroy (GNCLot *)
 
GNCLot * gnc_lot_lookup (const GncGUID *guid, QofBook *book)
 
QofBook * gnc_lot_get_book (GNCLot *)
 
void gnc_lot_begin_edit (GNCLot *lot)
 
void gnc_lot_commit_edit (GNCLot *lot)
 
void gnc_lot_add_split (GNCLot *, Split *)
 The gnc_lot_add_split() routine adds a split to this lot. More...
 
void gnc_lot_remove_split (GNCLot *, Split *)
 
SplitListgnc_lot_get_split_list (const GNCLot *)
 The gnc_lot_get_split_list() routine returns a GList of all the splits in this lot. More...
 
gint gnc_lot_count_splits (const GNCLot *)
 
Accountgnc_lot_get_account (const GNCLot *)
 The gnc_lot_get_account() routine returns the account with which this lot is associated. More...
 
void gnc_lot_set_account (GNCLot *, Account *)
 
gnc_numeric gnc_lot_get_balance (GNCLot *)
 The gnc_lot_get_balance() routine returns the balance of the lot. More...
 
void gnc_lot_get_balance_before (const GNCLot *, const Split *, gnc_numeric *, gnc_numeric *)
 The gnc_lot_get_balance_before routine computes both the balance and value in the lot considering only splits in transactions prior to the one containing the given split or other splits in the same transaction. More...
 
gboolean gnc_lot_is_closed (GNCLot *)
 The gnc_lot_is_closed() routine returns a boolean flag: is this lot closed? A lot is closed if its balance is zero. More...
 
Split * gnc_lot_get_earliest_split (GNCLot *lot)
 The gnc_lot_get_earliest_split() routine is a convenience routine that helps identify the date this lot was opened. More...
 
Split * gnc_lot_get_latest_split (GNCLot *lot)
 The gnc_lot_get_latest_split() routine is a convenience routine that helps identify the date this lot was closed. More...
 
void gnc_lot_set_closed_unknown (GNCLot *)
 Reset closed flag so that it will be recalculated. More...
 
const char * gnc_lot_get_title (const GNCLot *)
 Get and set the account title, or the account notes, or the marker. More...
 
const char * gnc_lot_get_notes (const GNCLot *)
 
void gnc_lot_set_title (GNCLot *, const char *)
 
void gnc_lot_set_notes (GNCLot *, const char *)
 
GNCLot * gnc_lot_make_default (Account *acc)
 XXX: Document?
 

Detailed Description

One often needs to know that the item 'bought' in one transaction is the same one as the item 'sold' in a different transaction.

Lots are used to make this association. One Lot holds all of the splits that involve the same item. A lot is typically formed when the item is bought, and is closed when the item is sold out. A lot need not be a single item, it can be a quantity of the same thing e.g. 500 gallons of paint (sold off a few gallons at a time).

Lots are required to correctly implement invoices, inventory, depreciation and stock market investment gains. See the file src/doc/lots.txt for a detailed implementation overview.

A lot is "closed" when the number of items in the lot has gone to zero. It is very easy to compute the gains/losses for a closed lot: it is the sum-total of the values of the items put into/taken out of the lot. (Realized) Gains on still-open lots can be computed by pro-rating the purchase prices.

Lots are nothing more than a collection or grouping of splits in an account. All of the splits in a lot must belong to the same account; there's no mix-n-match. Thus, in this sense, a lot belongs to an account as well.

Lots have an implicit "opening date": the date of the earliest split in the lot. The "close date" is the date of the split that brought the lot item balance down to zero.

Function Documentation

◆ gnc_lot_add_split()

void gnc_lot_add_split ( GNCLot *  ,
Split *   
)

The gnc_lot_add_split() routine adds a split to this lot.

Note that all splits in a lot must also be in the same account. Note that this routine adds the split unconditionally, with no regard for the accounting policy. To enforce a particular accounting policy, use the xaccSplitAssignToLot() routine instead.

Definition at line 566 of file gnc-lot.c.

567 {
568  GNCLotPrivate* priv;
569  Account * acc;
570  if (!lot || !split) return;
571  priv = GET_PRIVATE(lot);
572 
573  ENTER ("(lot=%p, split=%p) %s amt=%s val=%s", lot, split,
574  gnc_lot_get_title (lot),
575  gnc_num_dbg_to_string (split->amount),
576  gnc_num_dbg_to_string (split->value));
577  gnc_lot_begin_edit(lot);
578  acc = xaccSplitGetAccount (split);
579  qof_instance_set_dirty(QOF_INSTANCE(lot));
580  if (NULL == priv->account)
581  {
582  xaccAccountInsertLot (acc, lot);
583  }
584  else if (priv->account != acc)
585  {
586  PERR ("splits from different accounts cannot "
587  "be added to this lot!\n"
588  "\tlot account=\'%s\', split account=\'%s\'\n",
589  xaccAccountGetName(priv->account), xaccAccountGetName (acc));
590  gnc_lot_commit_edit(lot);
591  LEAVE("different accounts");
592  return;
593  }
594 
595  if (lot == split->lot)
596  {
597  gnc_lot_commit_edit(lot);
598  LEAVE("already in lot");
599  return; /* handle not-uncommon no-op */
600  }
601  if (split->lot)
602  {
603  gnc_lot_remove_split (split->lot, split);
604  }
605  xaccSplitSetLot(split, lot);
606 
607  priv->splits = g_list_append (priv->splits, split);
608 
609  /* for recomputation of is-closed */
610  priv->is_closed = LOT_CLOSED_UNKNOWN;
611  gnc_lot_commit_edit(lot);
612 
613  qof_event_gen (QOF_INSTANCE(lot), QOF_EVENT_MODIFY, NULL);
614  LEAVE("added to lot");
615 }
gchar * gnc_num_dbg_to_string(gnc_numeric n)
Convert to string.
STRUCTS.
void xaccAccountInsertLot(Account *acc, GNCLot *lot)
The xaccAccountInsertLot() method will register the indicated lot with this account.
Definition: Account.cpp:1931
#define PERR(format, args...)
Log a serious error.
Definition: qoflog.h:244
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:268
const char * gnc_lot_get_title(const GNCLot *lot)
Get and set the account title, or the account notes, or the marker.
Definition: gnc-lot.c:424
void xaccSplitSetLot(Split *split, GNCLot *lot)
Assigns the split to a specific Lot.
Definition: Split.c:1856
Account * xaccSplitGetAccount(const Split *s)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: Split.c:912
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:278
const char * xaccAccountGetName(const Account *acc)
Get the account's name.
Definition: Account.cpp:3028
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_lot_get_account()

Account* gnc_lot_get_account ( const GNCLot *  )

The gnc_lot_get_account() routine returns the account with which this lot is associated.

Definition at line 373 of file gnc-lot.c.

374 {
375  GNCLotPrivate* priv;
376  if (!lot) return NULL;
377  priv = GET_PRIVATE(lot);
378  return priv->account;
379 }

◆ gnc_lot_get_balance()

gnc_numeric gnc_lot_get_balance ( GNCLot *  )

The gnc_lot_get_balance() routine returns the balance of the lot.

The commodity in which this balance is expressed is the commodity of the account.

Definition at line 474 of file gnc-lot.c.

475 {
476  GNCLotPrivate* priv;
477  GList *node;
478  gnc_numeric zero = gnc_numeric_zero();
479  gnc_numeric baln = zero;
480  if (!lot) return zero;
481 
482  priv = GET_PRIVATE(lot);
483  if (!priv->splits)
484  {
485  priv->is_closed = FALSE;
486  return zero;
487  }
488 
489  /* Sum over splits; because they all belong to same account
490  * they will have same denominator.
491  */
492  for (node = priv->splits; node; node = node->next)
493  {
494  Split *s = node->data;
495  gnc_numeric amt = xaccSplitGetAmount (s);
496  baln = gnc_numeric_add_fixed (baln, amt);
497  g_assert (gnc_numeric_check (baln) == GNC_ERROR_OK);
498  }
499 
500  /* cache a zero balance as a closed lot */
501  if (gnc_numeric_equal (baln, zero))
502  {
503  priv->is_closed = TRUE;
504  }
505  else
506  {
507  priv->is_closed = FALSE;
508  }
509 
510  return baln;
511 }
gboolean gnc_numeric_equal(gnc_numeric a, gnc_numeric b)
Equivalence predicate: Returns TRUE (1) if a and b represent the same number.
GNCNumericErrorCode gnc_numeric_check(gnc_numeric in)
Check for error signal in value.
No error.
Definition: gnc-numeric.h:224
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account's commodity.
Definition: Split.c:1884

◆ gnc_lot_get_balance_before()

void gnc_lot_get_balance_before ( const GNCLot *  ,
const Split *  ,
gnc_numeric *  ,
gnc_numeric *   
)

The gnc_lot_get_balance_before routine computes both the balance and value in the lot considering only splits in transactions prior to the one containing the given split or other splits in the same transaction.

The first return value is the amount and the second is the value.

Definition at line 516 of file gnc-lot.c.

518 {
519  GNCLotPrivate* priv;
520  GList *node;
521  gnc_numeric zero = gnc_numeric_zero();
522  gnc_numeric amt = zero;
523  gnc_numeric val = zero;
524 
525  *amount = amt;
526  *value = val;
527  if (lot == NULL) return;
528 
529  priv = GET_PRIVATE(lot);
530  if (priv->splits)
531  {
532  Transaction *ta, *tb;
533  const Split *target;
534  /* If this is a gains split, find the source of the gains and use
535  its transaction for the comparison. Gains splits are in separate
536  transactions that may sort after non-gains transactions. */
537  target = xaccSplitGetGainsSourceSplit (split);
538  if (target == NULL)
539  target = split;
540  tb = xaccSplitGetParent (target);
541  for (node = priv->splits; node; node = node->next)
542  {
543  Split *s = node->data;
544  Split *source = xaccSplitGetGainsSourceSplit (s);
545  if (source == NULL)
546  source = s;
547  ta = xaccSplitGetParent (source);
548  if ((ta == tb && source != target) ||
549  xaccTransOrder (ta, tb) < 0)
550  {
551  gnc_numeric tmpval = xaccSplitGetAmount (s);
552  amt = gnc_numeric_add_fixed (amt, tmpval);
553  tmpval = xaccSplitGetValue (s);
554  val = gnc_numeric_add_fixed (val, tmpval);
555  }
556  }
557  }
558 
559  *amount = amt;
560  *value = val;
561 }
Split * xaccSplitGetGainsSourceSplit(const Split *split)
The xaccSplitGetGainsSourceSplit() routine returns the split that is the source of the cap gains in t...
Definition: cap-gains.c:505
Transaction * xaccSplitGetParent(const Split *split)
Returns the parent transaction of the split.
Definition: Split.c:1800
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction&#39;s commodity.
Definition: Split.c:1890
int xaccTransOrder(const Transaction *ta, const Transaction *tb)
The xaccTransOrder(ta,tb) method is useful for sorting.
Definition: Transaction.c:1873
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account&#39;s commodity.
Definition: Split.c:1884

◆ gnc_lot_get_earliest_split()

Split* gnc_lot_get_earliest_split ( GNCLot *  lot)

The gnc_lot_get_earliest_split() routine is a convenience routine that helps identify the date this lot was opened.

It simply loops over all of the splits in the lot, and returns the split with the earliest split->transaction->date_posted.

Definition at line 645 of file gnc-lot.c.

646 {
647  GNCLotPrivate* priv;
648  if (!lot) return NULL;
649  priv = GET_PRIVATE(lot);
650  if (! priv->splits) return NULL;
651  priv->splits = g_list_sort (priv->splits, (GCompareFunc) xaccSplitOrderDateOnly);
652  return priv->splits->data;
653 }

◆ gnc_lot_get_latest_split()

Split* gnc_lot_get_latest_split ( GNCLot *  lot)

The gnc_lot_get_latest_split() routine is a convenience routine that helps identify the date this lot was closed.

It simply loops over all of the splits in the lot, and returns the split with the latest split->transaction->date_posted.

Definition at line 657 of file gnc-lot.c.

658 {
659  GNCLotPrivate* priv;
660  SplitList *node;
661 
662  if (!lot) return NULL;
663  priv = GET_PRIVATE(lot);
664  if (! priv->splits) return NULL;
665  priv->splits = g_list_sort (priv->splits, (GCompareFunc) xaccSplitOrderDateOnly);
666 
667  for (node = priv->splits; node->next; node = node->next)
668  ;
669 
670  return node->data;
671 }
GList SplitList
GList of Split.
Definition: gnc-engine.h:207

◆ gnc_lot_get_split_list()

SplitList* gnc_lot_get_split_list ( const GNCLot *  )

The gnc_lot_get_split_list() routine returns a GList of all the splits in this lot.

Do not free this list when done; it is a pointer straight into the lots internal list. Do not add to or remove from this list directly. Calling either gnc_lot_add_split() or gnc_lot_remove_split() will invalidate the returned pointer.

Definition at line 404 of file gnc-lot.c.

405 {
406  GNCLotPrivate* priv;
407  if (!lot) return NULL;
408  priv = GET_PRIVATE(lot);
409  return priv->splits;
410 }

◆ gnc_lot_get_title()

const char* gnc_lot_get_title ( const GNCLot *  )

Get and set the account title, or the account notes, or the marker.

Definition at line 424 of file gnc-lot.c.

425 {
426  GValue v = G_VALUE_INIT;
427  if (!lot) return NULL;
428  qof_instance_get_kvp (QOF_INSTANCE (lot), &v, 1, "title");
429  if (G_VALUE_HOLDS_STRING (&v))
430  return g_value_get_string (&v);
431  return NULL;
432 }
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.

◆ gnc_lot_is_closed()

gboolean gnc_lot_is_closed ( GNCLot *  )

The gnc_lot_is_closed() routine returns a boolean flag: is this lot closed? A lot is closed if its balance is zero.

This routine is faster than using gnc_lot_get_balance() because once the balance goes to zero, this fact is cached.

Definition at line 363 of file gnc-lot.c.

364 {
365  GNCLotPrivate* priv;
366  if (!lot) return TRUE;
367  priv = GET_PRIVATE(lot);
368  if (0 > priv->is_closed) gnc_lot_get_balance (lot);
369  return priv->is_closed;
370 }
gnc_numeric gnc_lot_get_balance(GNCLot *lot)
The gnc_lot_get_balance() routine returns the balance of the lot.
Definition: gnc-lot.c:474

◆ gnc_lot_set_closed_unknown()

void gnc_lot_set_closed_unknown ( GNCLot *  )

Reset closed flag so that it will be recalculated.

Definition at line 393 of file gnc-lot.c.

394 {
395  GNCLotPrivate* priv;
396  if (lot != NULL)
397  {
398  priv = GET_PRIVATE(lot);
399  priv->is_closed = LOT_CLOSED_UNKNOWN;
400  }
401 }