GnuCash  4.12-71-gadd45021a8+
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_empty (const QofBook *book)
 Check if the book has had anything loaded into it. 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...
 
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)
 
const GncGUIDqof_book_get_guid_option (QofBook *book, GSList *path)
 
void qof_book_option_frame_delete (QofBook *book, const char *opt_name)
 
GHashTable * qof_book_get_features (QofBook *book)
 Access functions for reading and setting the used-features on this book.
 
void qof_book_unset_feature (QofBook *book, const gchar *key)
 
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:215
QofCollection * qof_book_get_collection(const QofBook *, QofIdType)
Return The table of entities of the given type.
Definition: qofbook.cpp:606

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 183 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 235 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 421 of file qofbook.cpp.

422 {
423  GHashTable* cols;
424 
425  if (!book) return;
426  ENTER ("book=%p", book);
427 
428  book->shutting_down = TRUE;
429  qof_event_force (&book->inst, QOF_EVENT_DESTROY, NULL);
430 
431  /* Call the list of finalizers, let them do their thing.
432  * Do this before tearing into the rest of the book.
433  */
434  g_hash_table_foreach (book->data_table_finalizers, book_final, book);
435 
436  qof_object_book_end (book);
437 
438  g_hash_table_destroy (book->data_table_finalizers);
439  book->data_table_finalizers = NULL;
440  g_hash_table_destroy (book->data_tables);
441  book->data_tables = NULL;
442 
443  /* qof_instance_release (&book->inst); */
444 
445  /* Note: we need to save this hashtable until after we remove ourself
446  * from it, otherwise we'll crash in our dispose() function when we
447  * DO remove ourself from the collection but the collection had already
448  * been destroyed.
449  */
450  cols = book->hash_of_collections;
451  g_object_unref (book);
452  g_hash_table_destroy (cols);
453  /*book->hash_of_collections = NULL;*/
454 
455  LEAVE ("book=%p", book);
456 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282

◆ qof_book_empty()

gboolean qof_book_empty ( const QofBook *  book)

Check if the book has had anything loaded into it.

Definition at line 596 of file qofbook.cpp.

597 {
598  if (!book) return TRUE;
599  auto root_acct_col = qof_book_get_collection (book, GNC_ID_ROOT_ACCOUNT);
600  return qof_collection_get_data(root_acct_col) == nullptr;
601 }
QofCollection * qof_book_get_collection(const QofBook *book, QofIdType entity_type)
Return The table of entities of the given type.
Definition: qofbook.cpp:606
gpointer qof_collection_get_data(const QofCollection *col)
Store and retrieve arbitrary object-defined data.
Definition: qofid.cpp:291

◆ 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 1114 of file qofbook.cpp.

1115 {
1116  gint num_days;
1117  GDate* result = NULL;
1118 
1119  g_assert(book);
1120  num_days = qof_book_get_num_days_autoreadonly(book);
1121  if (num_days > 0)
1122  {
1123  result = gnc_g_date_new_today();
1124  g_date_subtract_days(result, num_days);
1125  }
1126  return result;
1127 }
gint qof_book_get_num_days_autoreadonly(const QofBook *book)
Returns the number of days for auto-read-only transactions.
Definition: qofbook.cpp:1094
GDate * gnc_g_date_new_today()
Returns a newly allocated date of the current clock time, taken from time(2).
Definition: gnc-date.cpp:1229

◆ 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 993 of file qofbook.cpp.

994 {
995  const gchar *opt = NULL;
996  qof_instance_get (QOF_INSTANCE (book),
997  "book-currency", &opt,
998  NULL);
999  return opt;
1000 }
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 guaranteed to return a non-NULL value. (Unless the system malloc failed (out of memory) in which case what happens??).

Definition at line 606 of file qofbook.cpp.

607 {
608  QofCollection *col;
609 
610  if (!book || !entity_type) return NULL;
611 
612  col = static_cast<QofCollection*>(g_hash_table_lookup (book->hash_of_collections, entity_type));
613  if (!col)
614  {
615  col = qof_collection_new (entity_type);
616  g_hash_table_insert(
617  book->hash_of_collections,
618  (gpointer)qof_string_cache_insert(entity_type), col);
619  }
620  return col;
621 }
const 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:51

◆ 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 665 of file qofbook.cpp.

666 {
667  KvpFrame *kvp;
668  KvpValue *value;
669 
670  if (!book)
671  {
672  PWARN ("No book!!!");
673  return -1;
674  }
675 
676  if (!counter_name || *counter_name == '\0')
677  {
678  PWARN ("Invalid counter name.");
679  return -1;
680  }
681 
682  /* Use the KVP in the book */
683  kvp = qof_instance_get_slots (QOF_INSTANCE (book));
684 
685  if (!kvp)
686  {
687  PWARN ("Book has no KVP_Frame");
688  return -1;
689  }
690 
691  value = kvp->get_slot({"counters", counter_name});
692  if (value)
693  {
694  /* found it */
695  return value->get<int64_t>();
696  }
697  else
698  {
699  /* New counter */
700  return 0;
701  }
702 }
#define PWARN(format, args...)
Log a warning.
Definition: qoflog.h:250

◆ 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 766 of file qofbook.cpp.

767 {
768  KvpFrame *kvp;
769  const char *user_format = NULL;
770  gchar *norm_format = NULL;
771  KvpValue *value;
772  gchar *error = NULL;
773 
774  if (!book)
775  {
776  PWARN ("No book!!!");
777  return NULL;
778  }
779 
780  if (!counter_name || *counter_name == '\0')
781  {
782  PWARN ("Invalid counter name.");
783  return NULL;
784  }
785 
786  /* Get the KVP from the current book */
787  kvp = qof_instance_get_slots (QOF_INSTANCE (book));
788 
789  if (!kvp)
790  {
791  PWARN ("Book has no KVP_Frame");
792  return NULL;
793  }
794 
795  /* Get the format string */
796  value = kvp->get_slot({"counter_formats", counter_name});
797  if (value)
798  {
799  user_format = value->get<const char*>();
800  norm_format = qof_book_normalize_counter_format(user_format, &error);
801  if (!norm_format)
802  {
803  PWARN("Invalid counter format string. Format string: '%s' Counter: '%s' Error: '%s')", user_format, counter_name, error);
804  /* Invalid format string */
805  user_format = NULL;
806  g_free(error);
807  }
808  }
809 
810  /* If no (valid) format string was found, use the default format
811  * string */
812  if (!norm_format)
813  {
814  /* Use the default format */
815  norm_format = g_strdup ("%.6" PRIi64);
816  }
817  return norm_format;
818 }
#define PWARN(format, args...)
Log a warning.
Definition: qoflog.h:250
gchar * qof_book_normalize_counter_format(const gchar *p, gchar **err_msg)
Validate a counter format string.
Definition: qofbook.cpp:821

◆ 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()

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 1023 of file qofbook.cpp.

1024 {
1025  GncGUID *guid = NULL;
1026  qof_instance_get (QOF_INSTANCE (book),
1027  "default-gain-loss-account-guid", &guid,
1028  NULL);
1029  return guid;
1030 
1031 }
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 1008 of file qofbook.cpp.

1009 {
1010  const gchar *opt = NULL;
1011  qof_instance_get (QOF_INSTANCE (book),
1012  "default-gains-policy", &opt,
1013  NULL);
1014  return opt;
1015 }
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 1094 of file qofbook.cpp.

1095 {
1096  g_assert(book);
1097 
1098  if (!book->cached_num_days_autoreadonly_isvalid)
1099  {
1100  double tmp;
1101 
1102  // No cached value? Then do the expensive KVP lookup
1103  qof_instance_get (QOF_INSTANCE (book),
1104  PARAM_NAME_NUM_AUTOREAD_ONLY, &tmp,
1105  NULL);
1106 
1107  const_cast<QofBook*>(book)->cached_num_days_autoreadonly = tmp;
1108  const_cast<QofBook*>(book)->cached_num_days_autoreadonly_isvalid = TRUE;
1109  }
1110  // Value is cached now. Use the cheap variable returning.
1111  return (gint) book->cached_num_days_autoreadonly;
1112 }
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 1363 of file qofbook.cpp.

1364 {
1365  KvpFrame *root = qof_instance_get_slots(QOF_INSTANCE (book));
1366  return root->get_slot(gslist_to_option_path(path));
1367 }

◆ 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 506 of file qofbook.cpp.

507 {
508  return book->dirty_time;
509 }

◆ 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 705 of file qofbook.cpp.

706 {
707  KvpFrame *kvp;
708  KvpValue *value;
709  gint64 counter;
710  gchar* format;
711  gchar* result;
712 
713  if (!book)
714  {
715  PWARN ("No book!!!");
716  return NULL;
717  }
718 
719  if (!counter_name || *counter_name == '\0')
720  {
721  PWARN ("Invalid counter name.");
722  return NULL;
723  }
724 
725  /* Get the current counter value from the KVP in the book. */
726  counter = qof_book_get_counter(book, counter_name);
727 
728  /* Check if an error occurred */
729  if (counter < 0)
730  return NULL;
731 
732  /* Increment the counter */
733  counter++;
734 
735  /* Get the KVP from the current book */
736  kvp = qof_instance_get_slots (QOF_INSTANCE (book));
737 
738  if (!kvp)
739  {
740  PWARN ("Book has no KVP_Frame");
741  return NULL;
742  }
743 
744  /* Save off the new counter */
745  qof_book_begin_edit(book);
746  value = new KvpValue(counter);
747  delete kvp->set_path({"counters", counter_name}, value);
748  qof_instance_set_dirty (QOF_INSTANCE (book));
749  qof_book_commit_edit(book);
750 
751  format = qof_book_get_counter_format(book, counter_name);
752 
753  if (!format)
754  {
755  PWARN("Cannot get format for counter");
756  return NULL;
757  }
758 
759  /* Generate a string version of the counter */
760  result = g_strdup_printf(format, counter);
761  g_free (format);
762  return result;
763 }
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:766
#define PWARN(format, args...)
Log a warning.
Definition: qoflog.h:250
gint64 qof_book_get_counter(QofBook *book, const char *counter_name)
This will get the named counter for this book.
Definition: qofbook.cpp:665

◆ qof_book_is_readonly()

gboolean qof_book_is_readonly ( const QofBook *  book)

Return whether the book is read only.

Definition at line 582 of file qofbook.cpp.

583 {
584  g_return_val_if_fail( book != NULL, TRUE );
585  return book->read_only;
586 }

◆ 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 cannot be marked as open.

Definition at line 655 of file qofbook.cpp.

656 {
657  if (!book)
658  {
659  return;
660  }
661  book->book_open = 'n';
662 }

◆ qof_book_mark_readonly()

void qof_book_mark_readonly ( QofBook *  book)

Mark the book as read only.

Definition at line 589 of file qofbook.cpp.

590 {
591  g_return_if_fail( book != NULL );
592  book->read_only = TRUE;
593 }

◆ 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 483 of file qofbook.cpp.

484 {
485  if (!book) return;
486  if (!book->session_dirty)
487  {
488  /* Set the session dirty upfront, because the callback will check. */
489  book->session_dirty = TRUE;
490  book->dirty_time = gnc_time (NULL);
491  if (book->dirty_cb)
492  book->dirty_cb(book, TRUE, book->dirty_data);
493  }
494 }
time64 gnc_time(time64 *tbuf)
get the current local time
Definition: gnc-date.cpp:273

◆ 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 469 of file qofbook.cpp.

470 {
471  if (!book) return;
472 
473  book->dirty_time = 0;
474  if (book->session_dirty)
475  {
476  /* Set the session clean upfront, because the callback will check. */
477  book->session_dirty = FALSE;
478  if (book->dirty_cb)
479  book->dirty_cb(book, FALSE, book->dirty_data);
480  }
481 }

◆ 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 387 of file qofbook.cpp.

388 {
389  QofBook *book;
390 
391  ENTER (" ");
392  book = static_cast<QofBook*>(g_object_new(QOF_TYPE_BOOK, NULL));
393  qof_object_book_begin (book);
394 
395  qof_event_gen (&book->inst, QOF_EVENT_CREATE, NULL);
396  LEAVE ("book=%p", book);
397  return book;
398 }
void qof_object_book_begin(QofBook *book)
To be called from within the book.
Definition: qofobject.cpp:92
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282
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

◆ 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 821 of file qofbook.cpp.

822 {
823  const gchar *valid_formats [] = {
824  G_GINT64_FORMAT,
825  "lli",
826  "I64i",
827  PRIi64,
828  "li",
829  NULL,
830  };
831  int i = 0;
832  gchar *normalized_spec = NULL;
833 
834  while (valid_formats[i])
835  {
836 
837  if (err_msg && *err_msg)
838  {
839  g_free (*err_msg);
840  *err_msg = NULL;
841  }
842 
843  normalized_spec = qof_book_normalize_counter_format_internal(p, valid_formats[i], err_msg);
844  if (normalized_spec)
845  return normalized_spec; /* Found a valid format specifier, return */
846  i++;
847  }
848 
849  return NULL;
850 }
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:853

◆ 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 1370 of file qofbook.cpp.

1371 {
1372  KvpFrame *root = qof_instance_get_slots(QOF_INSTANCE (book));
1373  if (path != nullptr)
1374  {
1375  Path path_v {str_KVP_OPTION_PATH};
1376  Path tmp_path;
1377  for (auto item = path; item != nullptr; item = g_slist_next(item))
1378  tmp_path.push_back(static_cast<const char*>(item->data));
1379  delete root->set_path(gslist_to_option_path(path), nullptr);
1380  }
1381  else
1382  delete root->set_path({str_KVP_OPTION_PATH}, nullptr);
1383 }

◆ qof_book_register()

gboolean qof_book_register ( void  )

Register the book object with the QOF object system.

Definition at line 1386 of file qofbook.cpp.

1387 {
1388  static QofParam params[] =
1389  {
1390  { QOF_PARAM_GUID, QOF_TYPE_GUID, (QofAccessFunc)qof_entity_get_guid, NULL },
1391  { QOF_PARAM_KVP, QOF_TYPE_KVP, (QofAccessFunc)qof_instance_get_slots, NULL },
1392  { NULL },
1393  };
1394 
1395  qof_class_register (QOF_ID_BOOK, NULL, params);
1396 
1397  return TRUE;
1398 }
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:86
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 1311 of file qofbook.cpp.

1313 {
1314  /* Wrap this in begin/commit so that it commits only once instead of doing
1315  * so for every option. Qof_book_set_option will take care of dirtying the
1316  * book.
1317  */
1318  qof_book_begin_edit (book);
1319  save_cb (odb, book, clear);
1320  qof_book_commit_edit (book);
1321 }

◆ 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 461 of file qofbook.cpp.

462 {
463  if (!book) return FALSE;
464  return !qof_book_empty(book) && book->session_dirty;
465 
466 }
gboolean qof_book_empty(const QofBook *book)
Check if the book has had anything loaded into it.
Definition: qofbook.cpp:596

◆ 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 1350 of file qofbook.cpp.

1351 {
1352  KvpFrame *root = qof_instance_get_slots (QOF_INSTANCE (book));
1353  qof_book_begin_edit (book);
1354  delete root->set_path(gslist_to_option_path(path), value);
1355  qof_instance_set_dirty (QOF_INSTANCE (book));
1356  qof_book_commit_edit (book);
1357 
1358  // Also, mark any cached value as invalid
1359  book->cached_num_field_source_isvalid = FALSE;
1360 }

◆ 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 1088 of file qofbook.cpp.

1089 {
1090  g_assert(book);
1091  return (qof_book_get_num_days_autoreadonly(book) != 0);
1092 }
gint qof_book_get_num_days_autoreadonly(const QofBook *book)
Returns the number of days for auto-read-only transactions.
Definition: qofbook.cpp:1094