mirror of
https://github.com/Gnucash/gnucash.git
synced 2025-02-25 18:55:30 -06:00
fad343b4e2
time that the book transitioned from clean to dirty, and for calling back a registered function when the book transitions from clean to dirty. git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@13931 57a11ea4-9604-0410-9ed3-97b8803252fd
127 lines
4.6 KiB
C
127 lines
4.6 KiB
C
/********************************************************************\
|
|
* qof-book-p.h -- private functions for QOF books. *
|
|
* *
|
|
* This program is free software; you can redistribute it and/or *
|
|
* modify it under the terms of the GNU General Public License as *
|
|
* published by the Free Software Foundation; either version 2 of *
|
|
* the License, or (at your option) any later version. *
|
|
* *
|
|
* This program is distributed in the hope that it will be useful, *
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
|
|
* GNU General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU General Public License*
|
|
* along with this program; if not, contact: *
|
|
* *
|
|
* Free Software Foundation Voice: +1-617-542-5942 *
|
|
* 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652 *
|
|
* Boston, MA 02110-1301, USA gnu@gnu.org *
|
|
* *
|
|
\********************************************************************/
|
|
/** @addtogroup Object
|
|
@{ */
|
|
/** @addtogroup Object_Private
|
|
Private interfaces, not meant to be used by applications.
|
|
@{ */
|
|
/** @name Book_Private
|
|
@{ */
|
|
/*
|
|
* HISTORY:
|
|
* Created 2001 by Rob Browning
|
|
* Copyright (c) 2001 Rob Browning
|
|
* Copyright (c) 2001,2003 Linas Vepstas <linas@linas.org>
|
|
*/
|
|
|
|
#ifndef QOF_BOOK_P_H
|
|
#define QOF_BOOK_P_H
|
|
|
|
#include "kvp_frame.h"
|
|
#include "qofbackend.h"
|
|
#include "qofbook.h"
|
|
#include "qofid.h"
|
|
#include "qofid-p.h"
|
|
#include "qofinstance-p.h"
|
|
|
|
/* Book structure */
|
|
struct _QofBook
|
|
{
|
|
QofInstance inst; /* Unique guid for this book. */
|
|
|
|
/* The time when the book was first dirtied. This is a secondary
|
|
* indicator. It should only be used when inst.dirty is TRUE. */
|
|
time_t dirty_time;
|
|
|
|
/* This callback function is called any time the book dirty flag
|
|
* changes state. Both clean->dirty and dirty->clean transitions
|
|
* trigger a callback. */
|
|
QofBookDirtyCB dirty_cb;
|
|
|
|
/* This is the user supplied data that is returned in the dirty
|
|
* callback function.*/
|
|
gpointer dirty_data;
|
|
|
|
/* The entity table associates the GUIDs of all the objects
|
|
* belonging to this book, with their pointers to the respective
|
|
* objects. This allows a lookup of objects based on thier guid.
|
|
*/
|
|
GHashTable * hash_of_collections;
|
|
|
|
/* In order to store arbitrary data, for extensibility, add a table
|
|
* that will be used to hold arbitrary pointers.
|
|
*/
|
|
GHashTable *data_tables;
|
|
|
|
/* Hash table of destroy callbacks for the data table. */
|
|
GHashTable *data_table_finalizers;
|
|
|
|
/* state flag: 'y' means 'open for editing',
|
|
* 'n' means 'book is closed'
|
|
* xxxxx shouldn't this be replaced by the instance editlevel ???
|
|
*/
|
|
char book_open;
|
|
|
|
/* a flag denoting whether the book is closing down, used to
|
|
* help the QOF objects shut down cleanly without maintaining
|
|
* internal consistency.
|
|
* XXX shouldn't this be replaced by instance->do_free ???
|
|
*/
|
|
gboolean shutting_down;
|
|
|
|
/* version number, used for tracking multiuser updates */
|
|
gint32 version;
|
|
|
|
/* To be technically correct, backends belong to sessions and
|
|
* not books. So the pointer below "really shouldn't be here",
|
|
* except that it provides a nice convenience, avoiding a lookup
|
|
* from the session. Better solutions welcome ... */
|
|
QofBackend *backend;
|
|
|
|
/* -------------------------------------------------------------- */
|
|
/* Backend private expansion data */
|
|
guint32 idata; /* used by the sql backend for kvp management */
|
|
};
|
|
|
|
/*
|
|
* qof_book_set_backend() is used by backends to
|
|
* initialize the pointers in the book structure to
|
|
* something that contains actual data. These routines
|
|
* should not be used otherwise. (Its somewhat questionable
|
|
* if the backends should even be doing this much, but for
|
|
* backwards compatibility, we leave these here.)
|
|
*/
|
|
void qof_book_set_backend (QofBook *book, QofBackend *be);
|
|
|
|
/* Register books with the engine */
|
|
gboolean qof_book_register (void);
|
|
|
|
/** @deprecated use qof_entity_set_guid instead but only in
|
|
backends (when reading the GUID from the data source). */
|
|
#define qof_book_set_guid(book,guid) \
|
|
qof_entity_set_guid(QOF_ENTITY(book), guid)
|
|
|
|
/* @} */
|
|
/* @} */
|
|
/* @} */
|
|
#endif /* QOF_BOOK_P_H */
|