GnuCash  4.8a-80-g9825132ea+
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 *)
 
GncInvoice * gnc_lot_get_cached_invoice (const GNCLot *lot)
 The gnc_lot_get_cached_invoice() routine returns the invoice with which this lot is associated. More...
 
void gnc_lot_set_cached_invoice (GNCLot *lot, GncInvoice *invoice)
 
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 earliest date in the lot. 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 622 of file gnc-lot.c.

623 {
624  GNCLotPrivate* priv;
625  Account * acc;
626  if (!lot || !split) return;
627  priv = GET_PRIVATE(lot);
628 
629  ENTER ("(lot=%p, split=%p) %s amt=%s val=%s", lot, split,
630  gnc_lot_get_title (lot),
631  gnc_num_dbg_to_string (split->amount),
632  gnc_num_dbg_to_string (split->value));
633  gnc_lot_begin_edit(lot);
634  acc = xaccSplitGetAccount (split);
635  qof_instance_set_dirty(QOF_INSTANCE(lot));
636  if (NULL == priv->account)
637  {
638  xaccAccountInsertLot (acc, lot);
639  }
640  else if (priv->account != acc)
641  {
642  PERR ("splits from different accounts cannot "
643  "be added to this lot!\n"
644  "\tlot account=\'%s\', split account=\'%s\'\n",
645  xaccAccountGetName(priv->account), xaccAccountGetName (acc));
646  gnc_lot_commit_edit(lot);
647  LEAVE("different accounts");
648  return;
649  }
650 
651  if (lot == split->lot)
652  {
653  gnc_lot_commit_edit(lot);
654  LEAVE("already in lot");
655  return; /* handle not-uncommon no-op */
656  }
657  if (split->lot)
658  {
659  gnc_lot_remove_split (split->lot, split);
660  }
661  xaccSplitSetLot(split, lot);
662 
663  priv->splits = g_list_append (priv->splits, split);
664 
665  /* for recomputation of is-closed */
666  priv->is_closed = LOT_CLOSED_UNKNOWN;
667  gnc_lot_commit_edit(lot);
668 
669  qof_event_gen (QOF_INSTANCE(lot), QOF_EVENT_MODIFY, NULL);
670  LEAVE("added to lot");
671 }
gchar * gnc_num_dbg_to_string(gnc_numeric n)
Convert to string.
void xaccAccountInsertLot(Account *acc, GNCLot *lot)
The xaccAccountInsertLot() method will register the indicated lot with this account.
Definition: Account.cpp:2124
#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:272
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:456
void xaccSplitSetLot(Split *split, GNCLot *lot)
Assigns the split to a specific Lot.
Definition: Split.c:1887
Account * xaccSplitGetAccount(const Split *split)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: gmock-Split.cpp:53
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282
const char * xaccAccountGetName(const Account *acc)
Get the account's name.
Definition: Account.cpp:3258
void qof_event_gen(QofInstance *entity, QofEventId event_id, gpointer event_data)
Invoke all registered event handlers using the given arguments.
Definition: qofevent.cpp:231

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

393 {
394  GNCLotPrivate* priv;
395  if (!lot) return NULL;
396  priv = GET_PRIVATE(lot);
397  return priv->account;
398 }

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

531 {
532  GNCLotPrivate* priv;
533  GList *node;
534  gnc_numeric zero = gnc_numeric_zero();
535  gnc_numeric baln = zero;
536  if (!lot) return zero;
537 
538  priv = GET_PRIVATE(lot);
539  if (!priv->splits)
540  {
541  priv->is_closed = FALSE;
542  return zero;
543  }
544 
545  /* Sum over splits; because they all belong to same account
546  * they will have same denominator.
547  */
548  for (node = priv->splits; node; node = node->next)
549  {
550  Split *s = node->data;
551  gnc_numeric amt = xaccSplitGetAmount (s);
552  baln = gnc_numeric_add_fixed (baln, amt);
553  g_assert (gnc_numeric_check (baln) == GNC_ERROR_OK);
554  }
555 
556  /* cache a zero balance as a closed lot */
557  if (gnc_numeric_equal (baln, zero))
558  {
559  priv->is_closed = TRUE;
560  }
561  else
562  {
563  priv->is_closed = FALSE;
564  }
565 
566  return baln;
567 }
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: gmock-Split.cpp:69

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

574 {
575  GNCLotPrivate* priv;
576  GList *node;
577  gnc_numeric zero = gnc_numeric_zero();
578  gnc_numeric amt = zero;
579  gnc_numeric val = zero;
580 
581  *amount = amt;
582  *value = val;
583  if (lot == NULL) return;
584 
585  priv = GET_PRIVATE(lot);
586  if (priv->splits)
587  {
588  Transaction *ta, *tb;
589  const Split *target;
590  /* If this is a gains split, find the source of the gains and use
591  its transaction for the comparison. Gains splits are in separate
592  transactions that may sort after non-gains transactions. */
593  target = xaccSplitGetGainsSourceSplit (split);
594  if (target == NULL)
595  target = split;
596  tb = xaccSplitGetParent (target);
597  for (node = priv->splits; node; node = node->next)
598  {
599  Split *s = node->data;
600  Split *source = xaccSplitGetGainsSourceSplit (s);
601  if (source == NULL)
602  source = s;
603  ta = xaccSplitGetParent (source);
604  if ((ta == tb && source != target) ||
605  xaccTransOrder (ta, tb) < 0)
606  {
607  gnc_numeric tmpval = xaccSplitGetAmount (s);
608  amt = gnc_numeric_add_fixed (amt, tmpval);
609  tmpval = xaccSplitGetValue (s);
610  val = gnc_numeric_add_fixed (val, tmpval);
611  }
612  }
613  }
614 
615  *amount = amt;
616  *value = val;
617 }
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.
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction&#39;s commodity.
Definition: gmock-Split.cpp:84
int xaccTransOrder(const Transaction *ta, const Transaction *tb)
The xaccTransOrder(ta,tb) method is useful for sorting.
Definition: Transaction.c:1894
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account&#39;s commodity.
Definition: gmock-Split.cpp:69

◆ gnc_lot_get_cached_invoice()

GncInvoice* gnc_lot_get_cached_invoice ( const GNCLot *  lot)

The gnc_lot_get_cached_invoice() routine returns the invoice with which this lot is associated.

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

401 {
402  if (!lot) return NULL;
403  return GET_PRIVATE(lot)->cached_invoice;
404 }

◆ 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 earliest date in the lot.

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

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

702 {
703  GNCLotPrivate* priv;
704  if (!lot) return NULL;
705  priv = GET_PRIVATE(lot);
706  if (! priv->splits) return NULL;
707  priv->splits = g_list_sort (priv->splits, (GCompareFunc) xaccSplitOrderDateOnly);
708  return priv->splits->data;
709 }

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

714 {
715  GNCLotPrivate* priv;
716  SplitList *node;
717 
718  if (!lot) return NULL;
719  priv = GET_PRIVATE(lot);
720  if (! priv->splits) return NULL;
721  priv->splits = g_list_sort (priv->splits, (GCompareFunc) xaccSplitOrderDateOnly);
722 
723  for (node = priv->splits; node->next; node = node->next)
724  ;
725 
726  return node->data;
727 }
GList SplitList
GList of Split.
Definition: gnc-engine.h:211

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

437 {
438  GNCLotPrivate* priv;
439  if (!lot) return NULL;
440  priv = GET_PRIVATE(lot);
441  return priv->splits;
442 }

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

457 {
458  GNCLotPrivate* priv;
459  if (!lot) return NULL;
460  priv = GET_PRIVATE (lot);
461  if (priv->title == is_unset)
462  {
463  GNCLotPrivate* priv = GET_PRIVATE (lot);
464  GValue v = G_VALUE_INIT;
465  qof_instance_get_kvp (QOF_INSTANCE (lot), &v, 1, "title");
466  priv->title = G_VALUE_HOLDS_STRING (&v) ? g_value_dup_string (&v) : NULL;
467  g_value_unset (&v);
468  }
469  return priv->title;
470 }
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 382 of file gnc-lot.c.

383 {
384  GNCLotPrivate* priv;
385  if (!lot) return TRUE;
386  priv = GET_PRIVATE(lot);
387  if (0 > priv->is_closed) gnc_lot_get_balance (lot);
388  return priv->is_closed;
389 }
gnc_numeric gnc_lot_get_balance(GNCLot *lot)
The gnc_lot_get_balance() routine returns the balance of the lot.
Definition: gnc-lot.c:530

◆ gnc_lot_set_closed_unknown()

void gnc_lot_set_closed_unknown ( GNCLot *  )

Reset closed flag so that it will be recalculated.

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

426 {
427  GNCLotPrivate* priv;
428  if (lot != NULL)
429  {
430  priv = GET_PRIVATE(lot);
431  priv->is_closed = LOT_CLOSED_UNKNOWN;
432  }
433 }