qofobject.h

Go to the documentation of this file.

/********************************************************************\
 * qofobject.h -- the Core Object Registration/Lookup Interface     *
 *                                                                  *
 * 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                   *
 *                                                                  *
\********************************************************************/
#ifndef QOF_OBJECT_H_
#define QOF_OBJECT_H_

#include "qofbook.h"
#include "qofid.h"
#include "qofchoice.h"

#define QOF_OBJECT_VERSION 3

#define QOF_MOD_OBJECT "qof.object"

typedef struct _QofObject QofObject;
typedef void (*QofForeachCB) (gpointer obj, gpointer user_data);
typedef void (*QofForeachTypeCB) (QofObject *type, gpointer user_data);
typedef void (*QofForeachBackendTypeCB) (QofIdTypeConst type,
        gpointer backend_data,
        gpointer user_data);

struct _QofObject
{
    gint                interface_version; /* of this object interface */
    QofIdType           e_type;            /* the Object's QOF_ID */
    const char *        type_label;        /* "Printable" type-label string */

    gpointer            (*create)(QofBook *);

    void                (*book_begin)(QofBook *);

    void                (*book_end)(QofBook *);

    gboolean            (*is_dirty)(const QofCollection *);

    void                (*mark_clean)(QofCollection *);

    void                (*foreach)(const QofCollection *, QofInstanceForeachCB, gpointer);

    const char *        (*printable)(gpointer instance);

    int                 (*version_cmp)(gpointer instance_left, gpointer instance_right);
};

/* -------------------------------------------------------------- */

void qof_object_initialize (void);
void qof_object_shutdown (void);
gboolean qof_object_register (const QofObject *object);

const QofObject * qof_object_lookup (QofIdTypeConst type_name);

gpointer qof_object_new_instance (QofIdTypeConst type_name, QofBook *book);

const char * qof_object_get_type_label (QofIdTypeConst type_name);

const char * qof_object_printable (QofIdTypeConst type_name, gpointer instance);

void qof_object_foreach_type (QofForeachTypeCB cb, gpointer user_data);

void qof_object_foreach (QofIdTypeConst type_name, QofBook *book,
                         QofInstanceForeachCB cb, gpointer user_data);

void qof_object_foreach_sorted (QofIdTypeConst type_name, QofBook *book,
                                QofInstanceForeachCB cb, gpointer user_data);

gboolean qof_object_register_backend (QofIdTypeConst type_name,
                                      const char *backend_name,
                                      gpointer be_data);

/*@ dependent @*/
gpointer qof_object_lookup_backend (QofIdTypeConst type_name,
                                    const char *backend_name);

void qof_object_foreach_backend (const char *backend_name,
                                 QofForeachBackendTypeCB cb,
                                 gpointer user_data);

#endif /* QOF_OBJECT_H_ */