io-gncxml-v2.h

Go to the documentation of this file.

/********************************************************************\
 * io-gncxml-v2.h -- api for gnucash xml i/o                        *
 *                                                                  *
 * Copyright (c) 2001 Gnumatic Incorporated                         *
 *                                                                  *
 * 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 IO_GNCXML_V2_H
#define IO_GNCXML_V2_H

#include <glib.h>

#include "gnc-engine.h"
#include "gnc-backend-xml.h"

#include "sixtp.h"

typedef struct
{
    int accounts_total;
    int accounts_loaded;

    int books_total;
    int books_loaded;

    int commodities_total;
    int commodities_loaded;

    int transactions_total;
    int transactions_loaded;

    int prices_total;
    int prices_loaded;

    int schedXactions_total;
    int schedXactions_loaded;

    int budgets_total;
    int budgets_loaded;
} load_counter;

typedef struct sixtp_gdv2 sixtp_gdv2;
typedef void (*countCallbackFn)(sixtp_gdv2 *gd, const char *type);
struct sixtp_gdv2
{
    QofBook *book;
    load_counter counter;
    countCallbackFn countCallback;
    QofBePercentageFunc gui_display_fn;
    gboolean exporting;
};

#define GNC_FILE_BACKEND        "gnc:file:2"
#define GNC_FILE_BACKEND_VERS   2
typedef struct
{
    int         version;        /* backend version number */
    const char *        type_name;      /* The XML tag for this type */

    sixtp *     (*create_parser) (void);
    gboolean    (*add_item)(sixtp_gdv2 *, gpointer obj);
    int       (*get_count) (QofBook *);
    gboolean    (*write) (FILE*, QofBook*);
    void                (*scrub) (QofBook *);
    gboolean    (*ns) (FILE*);
} GncXmlDataType_t;

typedef struct
{
    AccountList *accts;
    TransList   *transactions;
    QofBook *book;
} gnc_template_xaction_data;

void run_callback(sixtp_gdv2 *data, const char *type);

gboolean qof_session_load_from_xml_file_v2(FileBackend *, QofBook *, QofBookFileType);

/* write all book info to a file */
gboolean gnc_book_write_to_xml_filehandle_v2(QofBook *book, FILE *fh);
gboolean gnc_book_write_to_xml_file_v2(QofBook *book, const char *filename, gboolean compress);

gboolean gnc_book_write_accounts_to_xml_filehandle_v2(QofBackend *be, QofBook *book, FILE *fh);
gboolean gnc_book_write_accounts_to_xml_file_v2(QofBackend * be, QofBook *book,
        const char *filename);

QofBookFileType gnc_is_xml_data_file_v2(const gchar *name, gboolean *with_encoding);

gboolean gnc_xml2_write_namespace_decl (FILE *out, const char *namespace);


typedef struct
{
    GQuark encoding;
    gchar *utf8_string;
} conv_type;

gint gnc_xml2_find_ambiguous(
    const gchar *filename, GList *encodings, GHashTable **unique,
    GHashTable **ambiguous, GList **impossible);

gboolean gnc_xml2_parse_with_subst (
    FileBackend *fbe, QofBook *book, GHashTable *subst);

#endif /* __IO_GNCXML_V2_H__ */