GnuCash  2.7.1
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 574 of file gnc-lot.c.

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

382 {
383  LotPrivate* priv;
384  if (!lot) return NULL;
385  priv = GET_PRIVATE(lot);
386  return priv->account;
387 }

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

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

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

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

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

654 {
655  LotPrivate* priv;
656  if (!lot) return NULL;
657  priv = GET_PRIVATE(lot);
658  if (! priv->splits) return NULL;
659  priv->splits = g_list_sort (priv->splits, (GCompareFunc) xaccSplitOrderDateOnly);
660  return priv->splits->data;
661 }

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

666 {
667  LotPrivate* priv;
668  SplitList *node;
669 
670  if (!lot) return NULL;
671  priv = GET_PRIVATE(lot);
672  if (! priv->splits) return NULL;
673  priv->splits = g_list_sort (priv->splits, (GCompareFunc) xaccSplitOrderDateOnly);
674 
675  for (node = priv->splits; node->next; node = node->next)
676  ;
677 
678  return node->data;
679 }
GList SplitList
GList of Split.
Definition: gnc-engine.h:203

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

413 {
414  LotPrivate* priv;
415  if (!lot) return NULL;
416  priv = GET_PRIVATE(lot);
417  return priv->splits;
418 }

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

433 {
434  GValue v = G_VALUE_INIT;
435  if (!lot) return NULL;
436  qof_instance_get_kvp (QOF_INSTANCE (lot), "/title", &v);
437  if (G_VALUE_HOLDS_STRING (&v))
438  return g_value_get_string (&v);
439  return NULL;
440 }
void qof_instance_get_kvp(const QofInstance *inst, const gchar *key, GValue *value)
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 371 of file gnc-lot.c.

372 {
373  LotPrivate* priv;
374  if (!lot) return TRUE;
375  priv = GET_PRIVATE(lot);
376  if (0 > priv->is_closed) gnc_lot_get_balance (lot);
377  return priv->is_closed;
378 }
gnc_numeric gnc_lot_get_balance(GNCLot *lot)
The gnc_lot_get_balance() routine returns the balance of the lot.
Definition: gnc-lot.c:482

◆ gnc_lot_set_closed_unknown()

void gnc_lot_set_closed_unknown ( GNCLot *  )

Reset closed flag so that it will be recalculated.

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

402 {
403  LotPrivate* priv;
404  if (lot != NULL)
405  {
406  priv = GET_PRIVATE(lot);
407  priv->is_closed = LOT_CLOSED_UNKNOWN;
408  }
409 }