qofsession.h

Go to the documentation of this file.

/********************************************************************\
 * qofsession.h -- session access (connection to 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       gnu@gnu.org                   *
 *                                                                  *
\********************************************************************/

#ifndef QOF_SESSION_H
#define QOF_SESSION_H

#include "qofbackend.h"
#include "qofbook.h"
#include "qofclass.h"
#include "qofobject.h"

#ifdef __cplusplus
extern "C"
{
#endif

#define QOF_MOD_SESSION "qof.session"

/* This replaces three booleans that were passed in order: ignore_lock, create,
 * and force. It's structured so that one can use it as a bit field with the
 * values in the same order, i.e. ignore_lock = 1 << 2, create = 1 << 1, and
 * force = 1.
 */
typedef enum
{
    SESSION_NORMAL_OPEN = 0,    // All False
    SESSION_NEW_STORE = 2,      // False, True, False (create)
    SESSION_NEW_OVERWRITE = 3,  // False, True, True (create | force)
    SESSION_READ_ONLY = 4,      // True, False, False (ignore_lock)
    SESSION_BREAK_LOCK = 5     // True, False, True (ignore_lock | force)
} SessionOpenMode;

/* PROTOTYPES ******************************************************/

typedef struct QofSessionImpl QofSession;

QofSession * qof_session_new (QofBook* book);
void         qof_session_destroy (QofSession *session);

void qof_session_swap_data (QofSession *session_1, QofSession *session_2);

void qof_session_begin (QofSession *session, const char * new_uri,
                        SessionOpenMode mode);

typedef void (*QofPercentageFunc) (const char *message, double percent);
void qof_session_load (QofSession *session,
                       QofPercentageFunc percentage_func);

QofBackendError qof_session_get_error (QofSession *session);
const char * qof_session_get_error_message(const QofSession *session);

QofBackendError qof_session_pop_error (QofSession *session);
QofBook * qof_session_get_book (const QofSession *session);

const char * qof_session_get_file_path (const QofSession *session);

const char * qof_session_get_url (const QofSession *session);

/* gboolean qof_session_not_saved(const QofSession *session); <- unimplemented */
gboolean qof_session_save_in_progress(const QofSession *session);

QofBackend * qof_session_get_backend(const QofSession *session);

void     qof_session_save (QofSession *session,
                           QofPercentageFunc percentage_func);

void     qof_session_safe_save (QofSession *session,
                                QofPercentageFunc percentage_func);

void     qof_session_end  (QofSession *session);

gboolean qof_session_events_pending (const QofSession *session);

gboolean qof_session_process_events (QofSession *session);
gboolean qof_session_export (QofSession *tmp_session,
                             QofSession *real_session,
                             QofPercentageFunc percentage_func);

GList* qof_backend_get_registered_access_method_list(void);

void qof_session_ensure_all_data_loaded(QofSession* session);

#ifdef __cplusplus
}
#endif

#endif /* QOF_SESSION_H */