GnuCash  2.6.99
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 580 of file gnc-lot.c.

581 {
582  LotPrivate* priv;
583  Account * acc;
584  if (!lot || !split) return;
585  priv = GET_PRIVATE(lot);
586 
587  ENTER ("(lot=%p, split=%p) %s amt=%s val=%s", lot, split,
588  gnc_lot_get_title (lot),
589  gnc_num_dbg_to_string (split->amount),
590  gnc_num_dbg_to_string (split->value));
591  gnc_lot_begin_edit(lot);
592  acc = xaccSplitGetAccount (split);
593  qof_instance_set_dirty(QOF_INSTANCE(lot));
594  if (NULL == priv->account)
595  {
596  xaccAccountInsertLot (acc, lot);
597  }
598  else if (priv->account != acc)
599  {
600  PERR ("splits from different accounts cannot "
601  "be added to this lot!\n"
602  "\tlot account=\'%s\', split account=\'%s\'\n",
603  xaccAccountGetName(priv->account), xaccAccountGetName (acc));
604  gnc_lot_commit_edit(lot);
605  LEAVE("different accounts");
606  return;
607  }
608 
609  if (lot == split->lot)
610  {
611  gnc_lot_commit_edit(lot);
612  LEAVE("already in lot");
613  return; /* handle not-uncommon no-op */
614  }
615  if (split->lot)
616  {
617  gnc_lot_remove_split (split->lot, split);
618  }
619  xaccSplitSetLot(split, lot);
620 
621  priv->splits = g_list_append (priv->splits, split);
622 
623  /* for recomputation of is-closed */
624  priv->is_closed = LOT_CLOSED_UNKNOWN;
625  gnc_lot_commit_edit(lot);
626 
627  qof_event_gen (QOF_INSTANCE(lot), QOF_EVENT_MODIFY, NULL);
628  LEAVE("added to lot");
629 }
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:1935
#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:438
void xaccSplitSetLot(Split *split, GNCLot *lot)
Assigns the split to a specific Lot.
Definition: Split.c:1901
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:3032
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 387 of file gnc-lot.c.

388 {
389  LotPrivate* priv;
390  if (!lot) return NULL;
391  priv = GET_PRIVATE(lot);
392  return priv->account;
393 }

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

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

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

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

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

660 {
661  LotPrivate* priv;
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  return priv->splits->data;
667 }

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

672 {
673  LotPrivate* priv;
674  SplitList *node;
675 
676  if (!lot) return NULL;
677  priv = GET_PRIVATE(lot);
678  if (! priv->splits) return NULL;
679  priv->splits = g_list_sort (priv->splits, (GCompareFunc) xaccSplitOrderDateOnly);
680 
681  for (node = priv->splits; node->next; node = node->next)
682  ;
683 
684  return node->data;
685 }
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 418 of file gnc-lot.c.

419 {
420  LotPrivate* priv;
421  if (!lot) return NULL;
422  priv = GET_PRIVATE(lot);
423  return priv->splits;
424 }

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

439 {
440  GValue v = G_VALUE_INIT;
441  if (!lot) return NULL;
442  qof_instance_get_kvp (QOF_INSTANCE (lot), "/title", &v);
443  if (G_VALUE_HOLDS_STRING (&v))
444  return g_value_get_string (&v);
445  return NULL;
446 }
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 377 of file gnc-lot.c.

378 {
379  LotPrivate* priv;
380  if (!lot) return TRUE;
381  priv = GET_PRIVATE(lot);
382  if (0 > priv->is_closed) gnc_lot_get_balance (lot);
383  return priv->is_closed;
384 }
gnc_numeric gnc_lot_get_balance(GNCLot *lot)
The gnc_lot_get_balance() routine returns the balance of the lot.
Definition: gnc-lot.c:488

◆ gnc_lot_set_closed_unknown()

void gnc_lot_set_closed_unknown ( GNCLot *  )

Reset closed flag so that it will be recalculated.

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

408 {
409  LotPrivate* priv;
410  if (lot != NULL)
411  {
412  priv = GET_PRIVATE(lot);
413  priv->is_closed = LOT_CLOSED_UNKNOWN;
414  }
415 }