qofbackend-p.h

Go to the documentation of this file.

/********************************************************************\
 * qofbackend-p.h -- private api for data storage backend           *
 *                                                                  *
 * 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       [email protected]                   *
 *                                                                  *
\********************************************************************/
#ifndef QOF_BACKEND_P_H
#define QOF_BACKEND_P_H

#include "qofbackend.h"
#include "qofbook.h"
#include "qofinstance-p.h"
#include "qofquery.h"
#include "qofsession.h"

struct QofBackendProvider_s
{
    /*@ observer @*/
    const char * provider_name;

    /*@ observer @*/
    const char * access_method;

    QofBackend * (*backend_new) (void);

    /*@ null @*/
    gboolean (*check_data_type) (const char*);

    void (*provider_free) (/*@ only @*/ QofBackendProvider *);
};

typedef enum
{
    LOAD_TYPE_INITIAL_LOAD,
    LOAD_TYPE_LOAD_ALL
} QofBackendLoadType;

struct QofBackend_s
{
    void (*session_begin) (QofBackend *be,
                           QofSession *session,
                           const char *book_id,
                           gboolean ignore_lock,
                           gboolean create,
                           gboolean force);
    void (*session_end) (QofBackend *);
    void (*destroy_backend) (/*@ only @*/ QofBackend *);

    void (*load) (QofBackend *, /*@ dependent @*/ QofBook *, QofBackendLoadType);

    void (*begin) (QofBackend *, QofInstance *);
    void (*commit) (QofBackend *, QofInstance *);
    void (*rollback) (QofBackend *, QofInstance *);

    gpointer (*compile_query) (QofBackend *, QofQuery *);
    void (*free_query) (QofBackend *, gpointer);
    void (*run_query) (QofBackend *, gpointer);

    void (*sync) (QofBackend *, /*@ dependent @*/ QofBook *);
    void (*safe_sync) (QofBackend *, /*@ dependent @*/ QofBook *);
    void (*load_config) (QofBackend *, KvpFrame *);
    /*@ observer @*/
    KvpFrame* (*get_config) (QofBackend *);

    gboolean (*events_pending) (QofBackend *);
    gboolean (*process_events) (QofBackend *);

    QofBePercentageFunc percentage;

    QofBackendProvider *provider;

    QofBackendError last_err;
    char * error_msg;

    KvpFrame* backend_configuration;
    gint config_count;
    char * fullpath;

    void (*price_lookup) (QofBackend *, gpointer);

    void (*export_fn) (QofBackend *, QofBook *);

};

#ifdef __cplusplus
extern "C"
{
#endif

void qof_backend_register_provider (/*@ only @*/ QofBackendProvider *);

void qof_backend_set_message(QofBackend *be, const char *format, ...);

char * qof_backend_get_message(QofBackend *be);

void qof_backend_init(QofBackend *be);
void qof_backend_destroy(QofBackend *be);

gchar qof_book_get_open_marker(const QofBook *book);

gint32 qof_book_get_version (const QofBook *book);

void qof_book_set_version (QofBook *book, gint32 version);

/* @} */
/* @} */
/* @} */
#ifdef __cplusplus
}
#endif

#endif /* QOF_BACKEND_P_H */