GnuCash  3.1-61-g61071b9
Files | Data Structures | Macros | Typedefs | Functions

A QOF Book is a dataset. More...

Files

file  qofbook.h
 Encapsulate all the information about a dataset.
 

Data Structures

struct  QofBook
 QofBook reference. More...
 
struct  QofBookClass
 

Macros

#define __KVP_VALUE
 
#define QOF_TYPE_BOOK   (qof_book_get_type ())
 
#define QOF_BOOK(o)   (G_TYPE_CHECK_INSTANCE_CAST ((o), QOF_TYPE_BOOK, QofBook))
 
#define QOF_BOOK_CLASS(k)   (G_TYPE_CHECK_CLASS_CAST((k), QOF_TYPE_BOOK, QofBookClass))
 
#define QOF_IS_BOOK(o)   (G_TYPE_CHECK_INSTANCE_TYPE ((o), QOF_TYPE_BOOK))
 
#define QOF_IS_BOOK_CLASS(k)   (G_TYPE_CHECK_CLASS_TYPE ((k), QOF_TYPE_BOOK))
 
#define QOF_BOOK_GET_CLASS(o)   (G_TYPE_INSTANCE_GET_CLASS ((o), QOF_TYPE_BOOK, QofBookClass))
 
#define QOF_BOOK_RETURN_ENTITY(book, guid, e_type, c_type)
 Encapsulates all the information about a dataset manipulated by QOF. More...
 
#define qof_book_get_guid(X)   qof_entity_get_guid (QOF_INSTANCE(X))
 deprecated
 

Typedefs

typedef void(* QofBookDirtyCB) (QofBook *, gboolean dirty, gpointer user_data)
 
typedef void(* GNCOptionSave) (GNCOptionDB *, QofBook *, gboolean)
 
typedef void(* GNCOptionLoad) (GNCOptionDB *, QofBook *)
 
typedef GList QofBookList
 GList of QofBook.
 
typedef void(* QofBookFinalCB) (QofBook *, gpointer key, gpointer user_data)
 
typedef void(* QofCollectionForeachCB) (QofCollection *, gpointer user_data)
 Invoke the indicated callback on each collection in the book. More...
 

Functions

GType qof_book_get_type (void)
 
gboolean qof_book_register (void)
 Register the book object with the QOF object system. More...
 
QofBook * qof_book_new (void)
 Allocate, initialise and return a new QofBook. More...
 
void qof_book_destroy (QofBook *book)
 End any editing sessions associated with book, and free all memory associated with it. More...
 
void qof_book_mark_closed (QofBook *book)
 Close a book to editing. More...
 
QofCollection * qof_book_get_collection (const QofBook *, QofIdType)
 Return The table of entities of the given type. More...
 
void qof_book_foreach_collection (const QofBook *, QofCollectionForeachCB, gpointer)
 
void qof_book_set_data (QofBook *book, const gchar *key, gpointer data)
 The qof_book_set_data() allows arbitrary pointers to structs to be stored in QofBook. More...
 
void qof_book_set_data_fin (QofBook *book, const gchar *key, gpointer data, QofBookFinalCB)
 Same as qof_book_set_data(), except that the callback will be called when the book is destroyed. More...
 
gpointer qof_book_get_data (const QofBook *book, const gchar *key)
 Retrieves arbitrary pointers to structs stored by qof_book_set_data. More...
 
gboolean qof_book_is_readonly (const QofBook *book)
 Return whether the book is read only. More...
 
void qof_book_mark_readonly (QofBook *book)
 Mark the book as read only. More...
 
gboolean qof_book_use_trading_accounts (const QofBook *book)
 Returns flag indicating whether this book uses trading accounts.
 
const gchar * qof_book_get_book_currency_name (QofBook *book)
 Returns pointer to book-currency name for book, if one exists in the KVP, or NULL; does not validate contents nor determine if there is a valid default gain/loss policy, both of which are required, for the 'book-currency' currency accounting method to apply. More...
 
const gchar * qof_book_get_default_gains_policy (QofBook *book)
 Returns pointer to default gain/loss policy for book, if one exists in the KVP, or NULL; does not validate contents nor determine if there is a valid book-currency, both of which are required, for the 'book-currency' currency accounting method to apply. More...
 
const GncGUIDqof_book_get_default_gain_loss_acct_guid (QofBook *book)
 Returns pointer to default gain/loss account GUID for book, if one exists in the KVP, or NULL; does not validate contents nor determine if there is a valid book-currency, both of which are required, for the 'book-currency' currency accounting method to apply. More...
 
gboolean qof_book_uses_autoreadonly (const QofBook *book)
 Returns TRUE if the auto-read-only feature should be used, otherwise FALSE. More...
 
gint qof_book_get_num_days_autoreadonly (const QofBook *book)
 Returns the number of days for auto-read-only transactions. More...
 
GDate * qof_book_get_autoreadonly_gdate (const QofBook *book)
 Returns the GDate that is the threshold for auto-read-only. More...
 
gboolean qof_book_use_split_action_for_num_field (const QofBook *book)
 Returns TRUE if this book uses split action field as the 'Num' field, FALSE if it uses transaction number field.
 
gboolean qof_book_shutting_down (const QofBook *book)
 Is the book shutting down?
 
gboolean qof_book_session_not_saved (const QofBook *book)
 qof_book_not_saved() returns the value of the session_dirty flag, set when changes to any object in the book are committed (qof_backend->commit_edit has been called) and the backend hasn't yet written out the changes. More...
 
void qof_book_mark_session_saved (QofBook *book)
 The qof_book_mark_saved() routine marks the book as having been saved (to a file, to a database). More...
 
void qof_book_mark_session_dirty (QofBook *book)
 The qof_book_mark_dirty() routine marks the book as having been modified. More...
 
time64 qof_book_get_session_dirty_time (const QofBook *book)
 Retrieve the earliest modification time on the book. More...
 
void qof_book_set_dirty_cb (QofBook *book, QofBookDirtyCB cb, gpointer user_data)
 Set the function to call when a book transitions from clean to dirty, or vice versa.
 
gint64 qof_book_get_counter (QofBook *book, const char *counter_name)
 This will get the named counter for this book. More...
 
gchar * qof_book_increment_and_format_counter (QofBook *book, const char *counter_name)
 This will increment the named counter for this book and format it. More...
 
gchar * qof_book_normalize_counter_format (const gchar *format, gchar **err_msg)
 Validate a counter format string. More...
 
char * qof_book_get_counter_format (const QofBook *book, const char *counter_name)
 Get the format string to use for the named counter. More...
 
const char * qof_book_get_string_option (const QofBook *book, const char *opt_name)
 
void qof_book_set_string_option (QofBook *book, const char *opt_name, const char *opt_val)
 
GHashTable * qof_book_get_features (QofBook *book)
 Access functions for reading and setting the used-features on this book.
 
void qof_book_set_feature (QofBook *book, const gchar *key, const gchar *descr)
 
void qof_book_begin_edit (QofBook *book)
 
void qof_book_commit_edit (QofBook *book)
 
void qof_book_save_options (QofBook *book, GNCOptionSave save_cb, GNCOptionDB *odb, gboolean clear)
 Save a GNCOptionsDB back to the book's KVP. More...
 
void qof_book_set_option (QofBook *book, KvpValue *value, GSList *path)
 Save a single option value. More...
 
KvpValue * qof_book_get_option (QofBook *book, GSList *path)
 Read a single option value. More...
 
void qof_book_options_delete (QofBook *book, GSList *path)
 Delete the options. More...
 

Detailed Description

A QOF Book is a dataset.

It provides a single handle through which all the various collections of entities can be found. In particular, given only the type of the entity, the collection can be found.

Books also provide the 'natural' place to working with a storage backend, as a book can encapsulate everything held in storage.

Macro Definition Documentation

◆ QOF_BOOK_RETURN_ENTITY

#define QOF_BOOK_RETURN_ENTITY (   book,
  guid,
  e_type,
  c_type 
)
Value:
{ \
QofInstance *val = NULL; \
if ((guid != NULL) && (book != NULL)) { \
const QofCollection *col; \
col = qof_book_get_collection (book, e_type); \
val = qof_collection_lookup_entity (col, guid); \
} \
return (c_type *) val; \
}
QofInstance * qof_collection_lookup_entity(const QofCollection *col, const GncGUID *guid)
Find the entity going only from its guid.
Definition: qofid.cpp:214
QofCollection * qof_book_get_collection(const QofBook *, QofIdType)
Return The table of entities of the given type.
Definition: qofbook.cpp:554

Encapsulates all the information about a dataset manipulated by QOF.

This is the top-most structure used for anchoring data. This macro looks up an entity by GncGUID and returns a pointer to the entity by ending with a "return" statement. Hence, this macro can only be used as the last statement in the definition of a function, but not somewhere inline in the code.

Definition at line 168 of file qofbook.h.

Typedef Documentation

◆ QofCollectionForeachCB

typedef void(* QofCollectionForeachCB) (QofCollection *, gpointer user_data)

Invoke the indicated callback on each collection in the book.

Definition at line 220 of file qofbook.h.

Function Documentation

◆ qof_book_destroy()

void qof_book_destroy ( QofBook *  book)

End any editing sessions associated with book, and free all memory associated with it.

Definition at line 379 of file qofbook.cpp.

380 {
381  GHashTable* cols;
382 
383  if (!book) return;
384  ENTER ("book=%p", book);
385 
386  book->shutting_down = TRUE;
387  qof_event_force (&book->inst, QOF_EVENT_DESTROY, NULL);
388 
389  /* Call the list of finalizers, let them do their thing.
390  * Do this before tearing into the rest of the book.
391  */
392  g_hash_table_foreach (book->data_table_finalizers, book_final, book);
393 
394  qof_object_book_end (book);
395 
396  g_hash_table_destroy (book->data_table_finalizers);
397  book->data_table_finalizers = NULL;
398  g_hash_table_destroy (book->data_tables);
399  book->data_tables = NULL;
400 
401  /* qof_instance_release (&book->inst); */
402 
403  /* Note: we need to save this hashtable until after we remove ourself
404  * from it, otherwise we'll crash in our dispose() function when we
405  * DO remove ourself from the collection but the collection had already
406  * been destroyed.
407  */
408  cols = book->hash_of_collections;
409  g_object_unref (book);
410  g_hash_table_destroy (cols);
411  /*book->hash_of_collections = NULL;*/
412 
413  LEAVE ("book=%p", book);
414 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:266
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:276

◆ qof_book_get_autoreadonly_gdate()

GDate* qof_book_get_autoreadonly_gdate ( const QofBook *  book)

Returns the GDate that is the threshold for auto-read-only.

Any txn with posted-date lesser than this date should be considered read-only.

If the auto-read-only feature is not used (qof_book_uses_autoreadonly() returns FALSE), NULL is returned here.

The returned object was allocated newly; the caller must g_date_free() the object afterwards.

Definition at line 1025 of file qofbook.cpp.

1026 {
1027  gint num_days;
1028  GDate* result = NULL;
1029 
1030  g_assert(book);
1031  num_days = qof_book_get_num_days_autoreadonly(book);
1032  if (num_days > 0)
1033  {
1034  result = gnc_g_date_new_today();
1035  g_date_subtract_days(result, num_days);
1036  }
1037  return result;
1038 }
gint qof_book_get_num_days_autoreadonly(const QofBook *book)
Returns the number of days for auto-read-only transactions.
Definition: qofbook.cpp:1015
GDate * gnc_g_date_new_today()
Returns a newly allocated date of the current clock time, taken from time(2).
Definition: gnc-date.cpp:1388

◆ qof_book_get_book_currency_name()

const gchar* qof_book_get_book_currency_name ( QofBook *  book)

Returns pointer to book-currency name for book, if one exists in the KVP, or NULL; does not validate contents nor determine if there is a valid default gain/loss policy, both of which are required, for the 'book-currency' currency accounting method to apply.

Use instead 'gnc_book_get_book_currency_name' which does these validations.

Definition at line 941 of file qofbook.cpp.

942 {
943  const gchar *opt = NULL;
944  qof_instance_get (QOF_INSTANCE (book),
945  "book-currency", &opt,
946  NULL);
947  return opt;
948 }
void qof_instance_get(const QofInstance *inst, const gchar *first_prop,...)
Wrapper for g_object_get.

◆ qof_book_get_collection()

QofCollection* qof_book_get_collection ( const QofBook *  ,
QofIdType   
)

Return The table of entities of the given type.

When an object's constructor calls qof_instance_init(), a reference to the object is stored in the book. The book stores all the references to initialized instances, sorted by type. This function returns a collection of the references for the specified type.

If the collection doesn't yet exist for the indicated type, it is created. Thus, this routine is gaurenteed to return a non-NULL value. (Unless the system malloc failed (out of memory) in which case what happens??).

Definition at line 554 of file qofbook.cpp.

555 {
556  QofCollection *col;
557 
558  if (!book || !entity_type) return NULL;
559 
560  col = static_cast<QofCollection*>(g_hash_table_lookup (book->hash_of_collections, entity_type));
561  if (!col)
562  {
563  col = qof_collection_new (entity_type);
564  g_hash_table_insert(
565  book->hash_of_collections,
566  qof_string_cache_insert(entity_type), col);
567  }
568  return col;
569 }
char * qof_string_cache_insert(const char *key)
You can use this function with g_hash_table_insert(), for the key (or value), as long as you use the ...
QofCollection * qof_collection_new(QofIdType type)
create a new collection of entities of type
Definition: qofid.cpp:50

◆ qof_book_get_counter()

gint64 qof_book_get_counter ( QofBook *  book,
const char *  counter_name 
)

This will get the named counter for this book.

The return value is -1 on error or the current value of the counter.

Definition at line 613 of file qofbook.cpp.

614 {
615  KvpFrame *kvp;
616  KvpValue *value;
617 
618  if (!book)
619  {
620  PWARN ("No book!!!");
621  return -1;
622  }
623 
624  if (!counter_name || *counter_name == '\0')
625  {
626  PWARN ("Invalid counter name.");
627  return -1;
628  }
629 
630  /* Use the KVP in the book */
631  kvp = qof_instance_get_slots (QOF_INSTANCE (book));
632 
633  if (!kvp)
634  {
635  PWARN ("Book has no KVP_Frame");
636  return -1;
637  }
638 
639  value = kvp->get_slot({"counters", counter_name});
640  if (value)
641  {
642  /* found it */
643  return value->get<int64_t>();
644  }
645  else
646  {
647  /* New counter */
648  return 0;
649  }
650 }
#define PWARN(format, args...)
Log a warning.
Definition: qoflog.h:248

◆ qof_book_get_counter_format()

char* qof_book_get_counter_format ( const QofBook *  book,
const char *  counter_name 
)

Get the format string to use for the named counter.

The return value is NULL on error or the format string of the counter. The returned string should be freed by the caller.

Definition at line 714 of file qofbook.cpp.

715 {
716  KvpFrame *kvp;
717  const char *user_format = NULL;
718  gchar *norm_format = NULL;
719  KvpValue *value;
720  gchar *error = NULL;
721 
722  if (!book)
723  {
724  PWARN ("No book!!!");
725  return NULL;
726  }
727 
728  if (!counter_name || *counter_name == '\0')
729  {
730  PWARN ("Invalid counter name.");
731  return NULL;
732  }
733 
734  /* Get the KVP from the current book */
735  kvp = qof_instance_get_slots (QOF_INSTANCE (book));
736 
737  if (!kvp)
738  {
739  PWARN ("Book has no KVP_Frame");
740  return NULL;
741  }
742 
743  /* Get the format string */
744  value = kvp->get_slot({"counter_formats", counter_name});
745  if (value)
746  {
747  user_format = value->get<const char*>();
748  norm_format = qof_book_normalize_counter_format(user_format, &error);
749  if (!norm_format)
750  {
751  PWARN("Invalid counter format string. Format string: '%s' Counter: '%s' Error: '%s')", user_format, counter_name, error);
752  /* Invalid format string */
753  user_format = NULL;
754  g_free(error);
755  }
756  }
757 
758  /* If no (valid) format string was found, use the default format
759  * string */
760  if (!norm_format)
761  {
762  /* Use the default format */
763  norm_format = g_strdup ("%.6" PRIi64);
764  }
765  return norm_format;
766 }
#define PWARN(format, args...)
Log a warning.
Definition: qoflog.h:248
gchar * qof_book_normalize_counter_format(const gchar *p, gchar **err_msg)
Validate a counter format string.
Definition: qofbook.cpp:769

◆ qof_book_get_data()

gpointer qof_book_get_data ( const QofBook *  book,
const gchar *  key 
)

Retrieves arbitrary pointers to structs stored by qof_book_set_data.

◆ qof_book_get_default_gain_loss_acct_guid()

const GncGUID* qof_book_get_default_gain_loss_acct_guid ( QofBook *  book)

Returns pointer to default gain/loss account GUID for book, if one exists in the KVP, or NULL; does not validate contents nor determine if there is a valid book-currency, both of which are required, for the 'book-currency' currency accounting method to apply.

Use instead 'gnc_book_get_default_gain_loss_acct' which does these validations.

Definition at line 971 of file qofbook.cpp.

972 {
973  GncGUID *guid = NULL;
974  qof_instance_get (QOF_INSTANCE (book),
975  "default-gain-loss-account-guid", &guid,
976  NULL);
977  return guid;
978 
979 }
void qof_instance_get(const QofInstance *inst, const gchar *first_prop,...)
Wrapper for g_object_get.
The type used to store guids in C.
Definition: guid.h:75

◆ qof_book_get_default_gains_policy()

const gchar* qof_book_get_default_gains_policy ( QofBook *  book)

Returns pointer to default gain/loss policy for book, if one exists in the KVP, or NULL; does not validate contents nor determine if there is a valid book-currency, both of which are required, for the 'book-currency' currency accounting method to apply.

Use instead 'gnc_book_get_default_gains_policy' which does these validations.

Definition at line 956 of file qofbook.cpp.

957 {
958  const gchar *opt = NULL;
959  qof_instance_get (QOF_INSTANCE (book),
960  "default-gains-policy", &opt,
961  NULL);
962  return opt;
963 }
void qof_instance_get(const QofInstance *inst, const gchar *first_prop,...)
Wrapper for g_object_get.

◆ qof_book_get_num_days_autoreadonly()

gint qof_book_get_num_days_autoreadonly ( const QofBook *  book)

Returns the number of days for auto-read-only transactions.

If zero, the auto-read-only feature should be disabled (and qof_book_uses_autoreadonly() returns FALSE).

Definition at line 1015 of file qofbook.cpp.

1016 {
1017  g_assert(book);
1018  double tmp;
1019  qof_instance_get (QOF_INSTANCE (book),
1020  "autoreadonly-days", &tmp,
1021  NULL);
1022  return (gint) tmp;
1023 }
void qof_instance_get(const QofInstance *inst, const gchar *first_prop,...)
Wrapper for g_object_get.

◆ qof_book_get_option()

KvpValue* qof_book_get_option ( QofBook *  book,
GSList *  path 
)

Read a single option value.

Used from Scheme, the KvpValue<–>SCM translation is handled by the functions in kvp-scm.c and automated by SWIG. The starting element is set as KVP_OPTION_PATH in qofbookslots.h.

Parameters
bookThe book.
pathA GSList of keys which form a path under KVP_OPTION_PATH.

Definition at line 1188 of file qofbook.cpp.

1189 {
1190  KvpFrame *root = qof_instance_get_slots(QOF_INSTANCE (book));
1191  return root->get_slot(gslist_to_option_path(path));
1192 }

◆ qof_book_get_session_dirty_time()

time64 qof_book_get_session_dirty_time ( const QofBook *  book)

Retrieve the earliest modification time on the book.

Definition at line 464 of file qofbook.cpp.

465 {
466  return book->dirty_time;
467 }

◆ qof_book_increment_and_format_counter()

gchar* qof_book_increment_and_format_counter ( QofBook *  book,
const char *  counter_name 
)

This will increment the named counter for this book and format it.

The return value is NULL on error or the formatted (new) value of the counter. The caller should free the result with g_gree.

Definition at line 653 of file qofbook.cpp.

654 {
655  KvpFrame *kvp;
656  KvpValue *value;
657  gint64 counter;
658  gchar* format;
659  gchar* result;
660 
661  if (!book)
662  {
663  PWARN ("No book!!!");
664  return NULL;
665  }
666 
667  if (!counter_name || *counter_name == '\0')
668  {
669  PWARN ("Invalid counter name.");
670  return NULL;
671  }
672 
673  /* Get the current counter value from the KVP in the book. */
674  counter = qof_book_get_counter(book, counter_name);
675 
676  /* Check if an error occurred */
677  if (counter < 0)
678  return NULL;
679 
680  /* Increment the counter */
681  counter++;
682 
683  /* Get the KVP from the current book */
684  kvp = qof_instance_get_slots (QOF_INSTANCE (book));
685 
686  if (!kvp)
687  {
688  PWARN ("Book has no KVP_Frame");
689  return NULL;
690  }
691 
692  /* Save off the new counter */
693  qof_book_begin_edit(book);
694  value = new KvpValue(counter);
695  delete kvp->set_path({"counters", counter_name}, value);
696  qof_instance_set_dirty (QOF_INSTANCE (book));
697  qof_book_commit_edit(book);
698 
699  format = qof_book_get_counter_format(book, counter_name);
700 
701  if (!format)
702  {
703  PWARN("Cannot get format for counter");
704  return NULL;
705  }
706 
707  /* Generate a string version of the counter */
708  result = g_strdup_printf(format, counter);
709  g_free (format);
710  return result;
711 }
char * qof_book_get_counter_format(const QofBook *book, const char *counter_name)
Get the format string to use for the named counter.
Definition: qofbook.cpp:714
#define PWARN(format, args...)
Log a warning.
Definition: qoflog.h:248
gint64 qof_book_get_counter(QofBook *book, const char *counter_name)
This will get the named counter for this book.
Definition: qofbook.cpp:613

◆ qof_book_is_readonly()

gboolean qof_book_is_readonly ( const QofBook *  book)

Return whether the book is read only.

Definition at line 539 of file qofbook.cpp.

540 {
541  g_return_val_if_fail( book != NULL, TRUE );
542  return book->read_only;
543 }

◆ qof_book_mark_closed()

void qof_book_mark_closed ( QofBook *  book)

Close a book to editing.

It is up to the application to check this flag, and once marked closed, books cannnot be marked as open.

Definition at line 603 of file qofbook.cpp.

604 {
605  if (!book)
606  {
607  return;
608  }
609  book->book_open = 'n';
610 }

◆ qof_book_mark_readonly()

void qof_book_mark_readonly ( QofBook *  book)

Mark the book as read only.

Definition at line 546 of file qofbook.cpp.

547 {
548  g_return_if_fail( book != NULL );
549  book->read_only = TRUE;
550 }

◆ qof_book_mark_session_dirty()

void qof_book_mark_session_dirty ( QofBook *  book)

The qof_book_mark_dirty() routine marks the book as having been modified.

It can be used by frontend when the used has made a change at the book level.

Definition at line 441 of file qofbook.cpp.

442 {
443  if (!book) return;
444  if (!book->session_dirty)
445  {
446  /* Set the session dirty upfront, because the callback will check. */
447  book->session_dirty = TRUE;
448  book->dirty_time = gnc_time (NULL);
449  if (book->dirty_cb)
450  book->dirty_cb(book, TRUE, book->dirty_data);
451  }
452 }
time64 gnc_time(time64 *tbuf)
get the current local time
Definition: gnc-date.cpp:248

◆ qof_book_mark_session_saved()

void qof_book_mark_session_saved ( QofBook *  book)

The qof_book_mark_saved() routine marks the book as having been saved (to a file, to a database).

Used by backends to mark the notsaved flag as FALSE just after loading. Can also be used by the frontend when the used has said to abandon any changes.

Definition at line 427 of file qofbook.cpp.

428 {
429  if (!book) return;
430 
431  book->dirty_time = 0;
432  if (book->session_dirty)
433  {
434  /* Set the session clean upfront, because the callback will check. */
435  book->session_dirty = FALSE;
436  if (book->dirty_cb)
437  book->dirty_cb(book, FALSE, book->dirty_data);
438  }
439 }

◆ qof_book_new()

QofBook* qof_book_new ( void  )

Allocate, initialise and return a new QofBook.

Books contain references to all of the top-level object containers.

Definition at line 345 of file qofbook.cpp.

346 {
347  QofBook *book;
348 
349  ENTER (" ");
350  book = static_cast<QofBook*>(g_object_new(QOF_TYPE_BOOK, NULL));
351  qof_object_book_begin (book);
352 
353  qof_event_gen (&book->inst, QOF_EVENT_CREATE, NULL);
354  LEAVE ("book=%p", book);
355  return book;
356 }
void qof_object_book_begin(QofBook *book)
To be called from within the book.
Definition: qofobject.cpp:95
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:266
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:276
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

◆ qof_book_normalize_counter_format()

gchar* qof_book_normalize_counter_format ( const gchar *  format,
gchar **  err_msg 
)

Validate a counter format string.

If valid, returns a normalized format string, that is whatever long int specifier was used will be replaced with the value of the posix "PRIx64" macro. If not valid returns NULL and optionally set an error message is a non-null err_msg parameter was passed. The caller should free the returned format string and error message with g_free.

Definition at line 769 of file qofbook.cpp.

770 {
771  const gchar *valid_formats [] = {
772  G_GINT64_FORMAT,
773  "lli",
774  "I64i",
775  PRIi64,
776  "li",
777  NULL,
778  };
779  int i = 0;
780  gchar *normalized_spec = NULL;
781 
782  while (valid_formats[i])
783  {
784 
785  if (err_msg && *err_msg)
786  {
787  g_free (*err_msg);
788  *err_msg = NULL;
789  }
790 
791  normalized_spec = qof_book_normalize_counter_format_internal(p, valid_formats[i], err_msg);
792  if (normalized_spec)
793  return normalized_spec; /* Found a valid format specifier, return */
794  i++;
795  }
796 
797  return NULL;
798 }
gchar * qof_book_normalize_counter_format_internal(const gchar *p, const gchar *gint64_format, gchar **err_msg)
Validate a counter format string with a given format specifier.
Definition: qofbook.cpp:801

◆ qof_book_options_delete()

void qof_book_options_delete ( QofBook *  book,
GSList *  path 
)

Delete the options.

Primarily used from Scheme to clear out the options before saving a new set.

Parameters
bookThe book.
listA GList of keys which from a path under KVP_OPTION_PATH. If GList is Null, the whole option is deleted.

Definition at line 1195 of file qofbook.cpp.

1196 {
1197  KvpFrame *root = qof_instance_get_slots(QOF_INSTANCE (book));
1198  if (path != nullptr)
1199  {
1200  Path path_v {KVP_OPTION_PATH};
1201  Path tmp_path;
1202  for (auto item = path; item != nullptr; item = g_slist_next(item))
1203  tmp_path.push_back(static_cast<const char*>(item->data));
1204  delete root->set_path(gslist_to_option_path(path), nullptr);
1205  }
1206  else
1207  delete root->set_path({KVP_OPTION_PATH}, nullptr);
1208 }

◆ qof_book_register()

gboolean qof_book_register ( void  )

Register the book object with the QOF object system.

Definition at line 1211 of file qofbook.cpp.

1212 {
1213  static QofParam params[] =
1214  {
1215  { QOF_PARAM_GUID, QOF_TYPE_GUID, (QofAccessFunc)qof_entity_get_guid, NULL },
1216  { QOF_PARAM_KVP, QOF_TYPE_KVP, (QofAccessFunc)qof_instance_get_slots, NULL },
1217  { NULL },
1218  };
1219 
1220  qof_class_register (QOF_ID_BOOK, NULL, params);
1221 
1222  return TRUE;
1223 }
void qof_class_register(QofIdTypeConst obj_name, QofSortFunc default_sort_function, const QofParam *params)
This function registers a new object class with the Qof subsystem.
Definition: qofclass.cpp:89
gpointer(* QofAccessFunc)(gpointer object, const QofParam *param)
The QofAccessFunc defines an arbitrary function pointer for access functions.
Definition: qofclass.h:177
const GncGUID * qof_entity_get_guid(gconstpointer ent)
#define QOF_PARAM_KVP
"Known" Object Parameters – some objects might support these
Definition: qofquery.h:113

◆ qof_book_save_options()

void qof_book_save_options ( QofBook *  book,
GNCOptionSave  save_cb,
GNCOptionDB *  odb,
gboolean  clear 
)

Save a GNCOptionsDB back to the book's KVP.

Parameters
bookThe book.
save_cbA callback function that does the saving.
odbThe GNCOptionsDB to save from.
clearShould the GNCOptionsDB be emptied after the save?

Definition at line 1139 of file qofbook.cpp.

1141 {
1142  /* Wrap this in begin/commit so that it commits only once instead of doing
1143  * so for every option. Qof_book_set_option will take care of dirtying the
1144  * book.
1145  */
1146  qof_book_begin_edit (book);
1147  save_cb (odb, book, clear);
1148  qof_book_commit_edit (book);
1149 }

◆ qof_book_session_not_saved()

gboolean qof_book_session_not_saved ( const QofBook *  book)

qof_book_not_saved() returns the value of the session_dirty flag, set when changes to any object in the book are committed (qof_backend->commit_edit has been called) and the backend hasn't yet written out the changes.

(Note that SQL backends write commits out immediately; file backends don't, and use the flag to control an autosave timer.)

Definition at line 419 of file qofbook.cpp.

420 {
421  if (!book) return FALSE;
422  return book->session_dirty;
423 
424 }

◆ qof_book_set_data()

void qof_book_set_data ( QofBook *  book,
const gchar *  key,
gpointer  data 
)

The qof_book_set_data() allows arbitrary pointers to structs to be stored in QofBook.

This is the "preferred" method for extending QofBook to hold new data types. This is also the ideal location to store other arbitrary runtime data that the application may need.

◆ qof_book_set_data_fin()

void qof_book_set_data_fin ( QofBook *  book,
const gchar *  key,
gpointer  data,
QofBookFinalCB   
)

Same as qof_book_set_data(), except that the callback will be called when the book is destroyed.

The argument to the callback will be the book followed by the data pointer.

◆ qof_book_set_option()

void qof_book_set_option ( QofBook *  book,
KvpValue *  value,
GSList *  path 
)

Save a single option value.

Used from Scheme, the KvpValue<–>SCM translation is handled by the functions in kvp-scm.c and automated by SWIG. The starting element is set as KVP_OPTION_PATH in qofbookslots.h.

Parameters
bookThe book.
valueThe KvpValue to store.
pathA GSList of keys which form a path under KVP_OPTION_PATH.

Definition at line 1178 of file qofbook.cpp.

1179 {
1180  KvpFrame *root = qof_instance_get_slots (QOF_INSTANCE (book));
1181  qof_book_begin_edit (book);
1182  delete root->set_path(gslist_to_option_path(path), value);
1183  qof_instance_set_dirty (QOF_INSTANCE (book));
1184  qof_book_commit_edit (book);
1185 }

◆ qof_book_uses_autoreadonly()

gboolean qof_book_uses_autoreadonly ( const QofBook *  book)

Returns TRUE if the auto-read-only feature should be used, otherwise FALSE.

This is just a wrapper on qof_book_get_num_days_autoreadonly() == 0.

Definition at line 1009 of file qofbook.cpp.

1010 {
1011  g_assert(book);
1012  return (qof_book_get_num_days_autoreadonly(book) != 0);
1013 }
gint qof_book_get_num_days_autoreadonly(const QofBook *book)
Returns the number of days for auto-read-only transactions.
Definition: qofbook.cpp:1015