GnuCash  3.1-61-g61071b9
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 568 of file gnc-lot.c.

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

376 {
377  LotPrivate* priv;
378  if (!lot) return NULL;
379  priv = GET_PRIVATE(lot);
380  return priv->account;
381 }

◆ 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 476 of file gnc-lot.c.

477 {
478  LotPrivate* priv;
479  GList *node;
480  gnc_numeric zero = gnc_numeric_zero();
481  gnc_numeric baln = zero;
482  if (!lot) return zero;
483 
484  priv = GET_PRIVATE(lot);
485  if (!priv->splits)
486  {
487  priv->is_closed = FALSE;
488  return zero;
489  }
490 
491  /* Sum over splits; because they all belong to same account
492  * they will have same denominator.
493  */
494  for (node = priv->splits; node; node = node->next)
495  {
496  Split *s = node->data;
497  gnc_numeric amt = xaccSplitGetAmount (s);
498  baln = gnc_numeric_add_fixed (baln, amt);
499  g_assert (gnc_numeric_check (baln) == GNC_ERROR_OK);
500  }
501 
502  /* cache a zero balance as a closed lot */
503  if (gnc_numeric_equal (baln, zero))
504  {
505  priv->is_closed = TRUE;
506  }
507  else
508  {
509  priv->is_closed = FALSE;
510  }
511 
512  return baln;
513 }
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:1904

◆ 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 518 of file gnc-lot.c.

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

◆ 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 647 of file gnc-lot.c.

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

◆ 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 659 of file gnc-lot.c.

660 {
661  LotPrivate* priv;
662  SplitList *node;
663 
664  if (!lot) return NULL;
665  priv = GET_PRIVATE(lot);
666  if (! priv->splits) return NULL;
667  priv->splits = g_list_sort (priv->splits, (GCompareFunc) xaccSplitOrderDateOnly);
668 
669  for (node = priv->splits; node->next; node = node->next)
670  ;
671 
672  return node->data;
673 }
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 406 of file gnc-lot.c.

407 {
408  LotPrivate* priv;
409  if (!lot) return NULL;
410  priv = GET_PRIVATE(lot);
411  return priv->splits;
412 }

◆ 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 426 of file gnc-lot.c.

427 {
428  GValue v = G_VALUE_INIT;
429  if (!lot) return NULL;
430  qof_instance_get_kvp (QOF_INSTANCE (lot), &v, 1, "title");
431  if (G_VALUE_HOLDS_STRING (&v))
432  return g_value_get_string (&v);
433  return NULL;
434 }
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 365 of file gnc-lot.c.

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

◆ gnc_lot_set_closed_unknown()

void gnc_lot_set_closed_unknown ( GNCLot *  )

Reset closed flag so that it will be recalculated.

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

396 {
397  LotPrivate* priv;
398  if (lot != NULL)
399  {
400  priv = GET_PRIVATE(lot);
401  priv->is_closed = LOT_CLOSED_UNKNOWN;
402  }
403 }