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       *
 * 59 Temple Place - Suite 330        Fax:    +1-617-542-2652       *
 * Boston, MA  02111-1307,  USA       gnu@gnu.org                   *
 *                                                                  *
\********************************************************************/
#ifndef QOF_BACKEND_P_H
#define QOF_BACKEND_P_H

#include "config.h"
#include "qof-be-utils.h"
#include "qofbackend.h"
#include "qofbook.h"
#include "qofinstance-p.h"
#include "qofquery.h"
#include "qofsession.h"

struct QofBackendProvider_s
{
  const char * provider_name;

  const char * access_method;

  gboolean partial_book_supported;
        
  QofBackend * (*backend_new) (void);

  gboolean (*check_data_type) (const char*);
  
  void (*provider_free) (QofBackendProvider *);
};

struct QofBackend_s
{
  void (*session_begin) (QofBackend *be,
                         QofSession *session,
                         const char *book_id, 
                         gboolean ignore_lock,
                         gboolean create_if_nonexistent);
  void (*session_end) (QofBackend *);
  void (*destroy_backend) (QofBackend *);

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

  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 *, QofBook *);
  void (*load_config) (QofBackend *, KvpFrame *);
  KvpFrame* (*get_config) (QofBackend *);
  gint64 (*counter) (QofBackend *, const char *counter_name);

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

  QofBePercentageFunc percentage;
  
  QofBackendProvider *provider;

  gboolean (*save_may_clobber_data) (QofBackend *);

  QofBackendError last_err;
  char * error_msg;

  KvpFrame* backend_configuration;
  gint config_count;
  char * fullpath;

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

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

};

void qof_backend_register_provider (QofBackendProvider *);

void qof_backend_set_error (QofBackend *be, QofBackendError err);

QofBackendError qof_backend_get_error (QofBackend *be);

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

char * qof_backend_get_message(QofBackend *be);

void qof_backend_init(QofBackend *be);

gchar qof_book_get_open_marker(QofBook *book);

gint32 qof_book_get_version (QofBook *book);

guint32 qof_book_get_idata (QofBook *book);

void qof_book_set_version (QofBook *book, gint32 version);

void qof_book_set_idata(QofBook *book, guint32 idata);

/* @} */
/* @} */
/* @} */
#endif /* QOF_BACKEND_P_H */

---