qofid.h

Go to the documentation of this file.

/********************************************************************\
 * qofid.h -- QOF entity type identification system                 *
 *                                                                  *
 * 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_ID_H
#define QOF_ID_H

#include <string.h>
#include "guid.h"

typedef const gchar * QofIdType;
typedef const gchar * QofIdTypeConst;

typedef struct QofCollection_s QofCollection;

#include "qofinstance.h"

#ifdef __cplusplus
extern "C"
{
#endif

#define QOF_ID_NONE           NULL
#define QOF_ID_NULL           "null"

#define QOF_ID_BOOK           "Book"
#define QOF_ID_SESSION        "Session"

#define QSTRCMP g_strcmp0

#define QOF_CHECK_TYPE(obj,type) (((obj) != NULL) && \
  (0 == QSTRCMP((type),(((QofInstance *)(obj))->e_type))))

#define QOF_CHECK_CAST(obj,e_type,c_type) (                   \
  QOF_CHECK_TYPE((obj),(e_type)) ?                            \
  (c_type *) (obj) :                                          \
  (c_type *) ({                                               \
     g_log (G_LOG_DOMAIN, G_LOG_LEVEL_CRITICAL,               \
       "Error: Bad QofInstance at %s:%d", __FILE__, __LINE__);  \
     (obj);                                                   \
  }))


QofCollection * qof_collection_new (QofIdType type);

guint qof_collection_count (const QofCollection *col);

void qof_collection_destroy (QofCollection *col);

QofIdType qof_collection_get_type (const QofCollection *);

/*@ dependent @*/
QofInstance * qof_collection_lookup_entity (const QofCollection *, const GncGUID *);

typedef void (*QofInstanceForeachCB) (QofInstance *, gpointer user_data);

void qof_collection_foreach_sorted (const QofCollection *col, QofInstanceForeachCB cb_func,
                                    gpointer user_data, GCompareFunc sort_fn);

void qof_collection_foreach (const QofCollection *, QofInstanceForeachCB,
                             gpointer user_data);

gpointer qof_collection_get_data (const QofCollection *col);
void qof_collection_set_data (QofCollection *col, gpointer user_data);

gboolean qof_collection_is_dirty (const QofCollection *col);

gboolean
qof_collection_add_entity (QofCollection *coll, QofInstance *ent);

void qof_collection_remove_entity (QofInstance *ent);

gint
qof_collection_compare (QofCollection *target, QofCollection *merge);

QofCollection*
qof_collection_from_glist (QofIdType type, const GList *glist);

#ifdef __cplusplus
}
#endif

#endif /* QOF_ID_H */