GnuCash  4.10-423-ga5cae6c5e
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.
 
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, const gchar *descr)
 
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:530

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 186 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 238 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 345 of file qofbook.cpp.

346 {
347  GHashTable* cols;
348 
349  if (!book) return;
350  ENTER ("book=%p", book);
351 
352  book->shutting_down = TRUE;
353  qof_event_force (&book->inst, QOF_EVENT_DESTROY, NULL);
354 
355  /* Call the list of finalizers, let them do their thing.
356  * Do this before tearing into the rest of the book.
357  */
358  g_hash_table_foreach (book->data_table_finalizers, book_final, book);
359 
360  qof_object_book_end (book);
361 
362  g_hash_table_destroy (book->data_table_finalizers);
363  book->data_table_finalizers = NULL;
364  g_hash_table_destroy (book->data_tables);
365  book->data_tables = NULL;
366 
367  /* qof_instance_release (&book->inst); */
368 
369  /* Note: we need to save this hashtable until after we remove ourself
370  * from it, otherwise we'll crash in our dispose() function when we
371  * DO remove ourself from the collection but the collection had already
372  * been destroyed.
373  */
374  cols = book->hash_of_collections;
375  g_object_unref (book);
376  g_hash_table_destroy (cols);
377  /*book->hash_of_collections = NULL;*/
378 
379  LEAVE ("book=%p", book);
380 }
#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 520 of file qofbook.cpp.

521 {
522  if (!book) return TRUE;
523  auto root_acct_col = qof_book_get_collection (book, GNC_ID_ROOT_ACCOUNT);
524  return qof_collection_get_data(root_acct_col) == nullptr;
525 }
QofCollection * qof_book_get_collection(const QofBook *book, QofIdType entity_type)
Return The table of entities of the given type.
Definition: qofbook.cpp:530
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 992 of file qofbook.cpp.

993 {
994  gint num_days;
995  GDate* result = NULL;
996 
997  g_assert(book);
998  num_days = qof_book_get_num_days_autoreadonly(book);
999  if (num_days > 0)
1000  {
1001  result = gnc_g_date_new_today();
1002  g_date_subtract_days(result, num_days);
1003  }
1004  return result;
1005 }
gint qof_book_get_num_days_autoreadonly(const QofBook *book)
Returns the number of days for auto-read-only transactions.
Definition: qofbook.cpp:972
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_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 530 of file qofbook.cpp.

531 {
532  QofCollection *col;
533 
534  if (!book || !entity_type) return NULL;
535 
536  col = static_cast<QofCollection*>(g_hash_table_lookup (book->hash_of_collections, entity_type));
537  if (!col)
538  {
539  col = qof_collection_new (entity_type);
540  g_hash_table_insert(
541  book->hash_of_collections,
542  (gpointer)qof_string_cache_insert(entity_type), col);
543  }
544  return col;
545 }
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 589 of file qofbook.cpp.

590 {
591  KvpFrame *kvp;
592  KvpValue *value;
593 
594  if (!book)
595  {
596  PWARN ("No book!!!");
597  return -1;
598  }
599 
600  if (!counter_name || *counter_name == '\0')
601  {
602  PWARN ("Invalid counter name.");
603  return -1;
604  }
605 
606  /* Use the KVP in the book */
607  kvp = qof_instance_get_slots (QOF_INSTANCE (book));
608 
609  if (!kvp)
610  {
611  PWARN ("Book has no KVP_Frame");
612  return -1;
613  }
614 
615  value = kvp->get_slot({"counters", counter_name});
616  if (value)
617  {
618  /* found it */
619  return value->get<int64_t>();
620  }
621  else
622  {
623  /* New counter */
624  return 0;
625  }
626 }
#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 690 of file qofbook.cpp.

691 {
692  KvpFrame *kvp;
693  const char *user_format = NULL;
694  gchar *norm_format = NULL;
695  KvpValue *value;
696  gchar *error = NULL;
697 
698  if (!book)
699  {
700  PWARN ("No book!!!");
701  return NULL;
702  }
703 
704  if (!counter_name || *counter_name == '\0')
705  {
706  PWARN ("Invalid counter name.");
707  return NULL;
708  }
709 
710  /* Get the KVP from the current book */
711  kvp = qof_instance_get_slots (QOF_INSTANCE (book));
712 
713  if (!kvp)
714  {
715  PWARN ("Book has no KVP_Frame");
716  return NULL;
717  }
718 
719  /* Get the format string */
720  value = kvp->get_slot({"counter_formats", counter_name});
721  if (value)
722  {
723  user_format = value->get<const char*>();
724  norm_format = qof_book_normalize_counter_format(user_format, &error);
725  if (!norm_format)
726  {
727  PWARN("Invalid counter format string. Format string: '%s' Counter: '%s' Error: '%s')", user_format, counter_name, error);
728  /* Invalid format string */
729  user_format = NULL;
730  g_free(error);
731  }
732  }
733 
734  /* If no (valid) format string was found, use the default format
735  * string */
736  if (!norm_format)
737  {
738  /* Use the default format */
739  norm_format = g_strdup ("%.6" PRIi64);
740  }
741  return norm_format;
742 }
#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:745

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

973 {
974  g_assert(book);
975 
976  if (!book->cached_num_days_autoreadonly_isvalid)
977  {
978  double tmp;
979 
980  // No cached value? Then do the expensive KVP lookup
981  qof_instance_get (QOF_INSTANCE (book),
982  PARAM_NAME_NUM_AUTOREAD_ONLY, &tmp,
983  NULL);
984 
985  const_cast<QofBook*>(book)->cached_num_days_autoreadonly = tmp;
986  const_cast<QofBook*>(book)->cached_num_days_autoreadonly_isvalid = TRUE;
987  }
988  // Value is cached now. Use the cheap variable returning.
989  return (gint) book->cached_num_days_autoreadonly;
990 }
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 1218 of file qofbook.cpp.

1219 {
1220  KvpFrame *root = qof_instance_get_slots(QOF_INSTANCE (book));
1221  return root->get_slot(gslist_to_option_path(path));
1222 }

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

431 {
432  return book->dirty_time;
433 }

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

630 {
631  KvpFrame *kvp;
632  KvpValue *value;
633  gint64 counter;
634  gchar* format;
635  gchar* result;
636 
637  if (!book)
638  {
639  PWARN ("No book!!!");
640  return NULL;
641  }
642 
643  if (!counter_name || *counter_name == '\0')
644  {
645  PWARN ("Invalid counter name.");
646  return NULL;
647  }
648 
649  /* Get the current counter value from the KVP in the book. */
650  counter = qof_book_get_counter(book, counter_name);
651 
652  /* Check if an error occurred */
653  if (counter < 0)
654  return NULL;
655 
656  /* Increment the counter */
657  counter++;
658 
659  /* Get the KVP from the current book */
660  kvp = qof_instance_get_slots (QOF_INSTANCE (book));
661 
662  if (!kvp)
663  {
664  PWARN ("Book has no KVP_Frame");
665  return NULL;
666  }
667 
668  /* Save off the new counter */
669  qof_book_begin_edit(book);
670  value = new KvpValue(counter);
671  delete kvp->set_path({"counters", counter_name}, value);
672  qof_instance_set_dirty (QOF_INSTANCE (book));
673  qof_book_commit_edit(book);
674 
675  format = qof_book_get_counter_format(book, counter_name);
676 
677  if (!format)
678  {
679  PWARN("Cannot get format for counter");
680  return NULL;
681  }
682 
683  /* Generate a string version of the counter */
684  result = g_strdup_printf(format, counter);
685  g_free (format);
686  return result;
687 }
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:690
#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:589

◆ qof_book_is_readonly()

gboolean qof_book_is_readonly ( const QofBook *  book)

Return whether the book is read only.

Definition at line 506 of file qofbook.cpp.

507 {
508  g_return_val_if_fail( book != NULL, TRUE );
509  return book->read_only;
510 }

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

580 {
581  if (!book)
582  {
583  return;
584  }
585  book->book_open = 'n';
586 }

◆ qof_book_mark_readonly()

void qof_book_mark_readonly ( QofBook *  book)

Mark the book as read only.

Definition at line 513 of file qofbook.cpp.

514 {
515  g_return_if_fail( book != NULL );
516  book->read_only = TRUE;
517 }

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

408 {
409  if (!book) return;
410  if (!book->session_dirty)
411  {
412  /* Set the session dirty upfront, because the callback will check. */
413  book->session_dirty = TRUE;
414  book->dirty_time = gnc_time (NULL);
415  if (book->dirty_cb)
416  book->dirty_cb(book, TRUE, book->dirty_data);
417  }
418 }
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 393 of file qofbook.cpp.

394 {
395  if (!book) return;
396 
397  book->dirty_time = 0;
398  if (book->session_dirty)
399  {
400  /* Set the session clean upfront, because the callback will check. */
401  book->session_dirty = FALSE;
402  if (book->dirty_cb)
403  book->dirty_cb(book, FALSE, book->dirty_data);
404  }
405 }

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

312 {
313  QofBook *book;
314 
315  ENTER (" ");
316  book = static_cast<QofBook*>(g_object_new(QOF_TYPE_BOOK, NULL));
317  qof_object_book_begin (book);
318 
319  qof_event_gen (&book->inst, QOF_EVENT_CREATE, NULL);
320  LEAVE ("book=%p", book);
321  return book;
322 }
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 745 of file qofbook.cpp.

746 {
747  const gchar *valid_formats [] = {
748  G_GINT64_FORMAT,
749  "lli",
750  "I64i",
751  PRIi64,
752  "li",
753  NULL,
754  };
755  int i = 0;
756  gchar *normalized_spec = NULL;
757 
758  while (valid_formats[i])
759  {
760 
761  if (err_msg && *err_msg)
762  {
763  g_free (*err_msg);
764  *err_msg = NULL;
765  }
766 
767  normalized_spec = qof_book_normalize_counter_format_internal(p, valid_formats[i], err_msg);
768  if (normalized_spec)
769  return normalized_spec; /* Found a valid format specifier, return */
770  i++;
771  }
772 
773  return NULL;
774 }
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:777

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

1226 {
1227  KvpFrame *root = qof_instance_get_slots(QOF_INSTANCE (book));
1228  if (path != nullptr)
1229  {
1230  Path path_v {str_KVP_OPTION_PATH};
1231  Path tmp_path;
1232  for (auto item = path; item != nullptr; item = g_slist_next(item))
1233  tmp_path.push_back(static_cast<const char*>(item->data));
1234  delete root->set_path(gslist_to_option_path(path), nullptr);
1235  }
1236  else
1237  delete root->set_path({str_KVP_OPTION_PATH}, nullptr);
1238 }

◆ qof_book_register()

gboolean qof_book_register ( void  )

Register the book object with the QOF object system.

Definition at line 1241 of file qofbook.cpp.

1242 {
1243  static QofParam params[] =
1244  {
1245  { QOF_PARAM_GUID, QOF_TYPE_GUID, (QofAccessFunc)qof_entity_get_guid, NULL },
1246  { QOF_PARAM_KVP, QOF_TYPE_KVP, (QofAccessFunc)qof_instance_get_slots, NULL },
1247  { NULL },
1248  };
1249 
1250  qof_class_register (QOF_ID_BOOK, NULL, params);
1251 
1252  return TRUE;
1253 }
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 1166 of file qofbook.cpp.

1168 {
1169  /* Wrap this in begin/commit so that it commits only once instead of doing
1170  * so for every option. Qof_book_set_option will take care of dirtying the
1171  * book.
1172  */
1173  qof_book_begin_edit (book);
1174  save_cb (odb, book, clear);
1175  qof_book_commit_edit (book);
1176 }

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

386 {
387  if (!book) return FALSE;
388  return !qof_book_empty(book) && book->session_dirty;
389 
390 }
gboolean qof_book_empty(const QofBook *book)
Check if the book has had anything loaded into it.
Definition: qofbook.cpp:520

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

1206 {
1207  KvpFrame *root = qof_instance_get_slots (QOF_INSTANCE (book));
1208  qof_book_begin_edit (book);
1209  delete root->set_path(gslist_to_option_path(path), value);
1210  qof_instance_set_dirty (QOF_INSTANCE (book));
1211  qof_book_commit_edit (book);
1212 
1213  // Also, mark any cached value as invalid
1214  book->cached_num_field_source_isvalid = FALSE;
1215 }

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

967 {
968  g_assert(book);
969  return (qof_book_get_num_days_autoreadonly(book) != 0);
970 }
gint qof_book_get_num_days_autoreadonly(const QofBook *book)
Returns the number of days for auto-read-only transactions.
Definition: qofbook.cpp:972