qsf-xml.h

Go to the documentation of this file.

/***************************************************************************
 *            qsf-xml.h
 *
 *  Fri Nov 26 19:29:47 2004
 *  Copyright  2004-2005  Neil Williams  <linux@codehelp.co.uk>
 *
 ****************************************************************************/
/*
 *  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 Library General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

 #ifndef QSF_XML_H
 #define QSF_XML_H

#include <stdio.h>
#include <stdlib.h>
#include <glib.h>
#include <regex.h>
#include <time.h>
#include <libxml/xmlmemory.h>
#include <libxml/tree.h>
#include <libxml/parser.h>
#include <libxml/xmlschemas.h>
#include "gnc-date.h"
#include "qof_book_merge.h"
#include "qofbook.h"
#include "qofclass.h"
#include "qofobject.h"
#include "kvp_frame.h"
#include "qofbackend-p.h"
#include "qofsession-p.h"
#include "qofbook-p.h"

#if defined(HAVE_GETTEXT)             /* HAVE_GETTEXT */

#include <libintl.h>
#include <locale.h>

#undef _
#undef Q_

#ifdef DISABLE_GETTEXT_UNDERSCORE
#define _(String) (String)
#define Q_(String) gnc_qualifier_prefix_noop(String)
#else                                 /* ENABLE_GETTEXT_UNDERSCORE */
#define _(String) gettext(String)
#define Q_(String) gnc_qualifier_prefix_gettext(String)
#endif                                /* End ENABLE_GETTEXT_UNDERSCORE */

#else                                 /* Not HAVE_GETTEXT */
#if !defined(__USE_GNU_GETTEXT)

#undef _
#undef Q_
#define _(String)       (String)
#define Q_(String) gnc_qualifier_prefix_noop(String)
#define gettext(String) (String)
#define ngettext(msgid, msgid_plural, n) (((n)==1) ? \
                                            (msgid) : (msgid_plural))

#endif                                /* End not__USE_GNU_GETTEXT */
#endif                                /* End Not HAVE_GETTEXT */

#undef  N_
#define N_(String) (String)


typedef enum  {
        QSF_UNDEF = 0, 
        IS_QSF_MAP,   
        IS_QSF_OBJ,   
        HAVE_QSF_MAP, 
        OUR_QSF_OBJ,  
}qsf_type;
        
typedef struct qsf_object_set
{
        GHashTable *parameters;
        QofIdType object_type;
        int object_count;
}qsf_objects;

#define QSF_QOF_VERSION QOF_OBJECT_VERSION 
#define QSF_ROOT_TAG    "qof-qsf" 
#define QSF_DEFAULT_NS  "http://qof.sourceforge.net/" 
#define QSF_DATE_LENGTH 31 
#define QSF_BOOK_TAG    "book" 
#define QSF_BOOK_GUID   "book-guid" 
#define QSF_BOOK_COUNT  "count" 
#define QSF_OBJECT_TAG  "object" 
#define QSF_OBJECT_TYPE "type" 
#define QSF_OBJECT_COUNT "count" 
#define QSF_XML_VERSION  "1.0"  
#define QSF_OBJECT_KVP  "path" 
#define QSF_OBJECT_VALUE "value" 
#define MAP_ROOT_TAG    "qsf-map" 
#define MAP_DEFINITION_TAG      "definition" 
#define MAP_DEFINE_TAG  "define" 
#define MAP_DEFAULT_TAG "default"  
#define MAP_OBJECT_TAG  "object" 
#define MAP_CALCULATE_TAG       "calculate" 
#define MAP_QOF_VERSION "qof_version" 
#define MAP_NAME_ATTR   "name" 
#define MAP_TYPE_ATTR   "type" 
#define MAP_VALUE_ATTR  "value" 
#define MAP_E_TYPE      "e_type" 
#define MAP_ENUM_TYPE "enum"

#define QSF_BOOLEAN_DEFAULT "boolean"

#define QSF_CONDITIONAL "if"  
#define QSF_CONDITIONAL_SET "set" 
#define QSF_CONDITIONAL_ELSE "else" 
#define QSF_OPTION "option" 
#define QSF_FORMATTING_OPTION "format" 
#define QSF_XSD_TIME  QOF_UTC_DATE_FORMAT 
#define QSF_XML_BOOLEAN_TEST "true" 
#define QSF_OBJECT_SCHEMA "qsf-object.xsd.xml" 
#define QSF_MAP_SCHEMA "qsf-map.xsd.xml" 
typedef struct qsf_metadata
{
        qsf_type file_type;          
        qsf_objects *object_set;     
        int count;                   
        GList *qsf_object_list;      
        GSList *qsf_sequence;        
        GList *referenceList;        
        GHashTable *qsf_parameter_hash; 
        GHashTable *qsf_calculate_hash, *qsf_default_hash, *qsf_define_hash;
        GSList *supported_types;     
        xmlDocPtr input_doc, output_doc; 
        xmlNodePtr child_node, cur_node, param_node, output_node, output_root, book_node, lister;
        xmlNsPtr qsf_ns, map_ns;     
        const char *qof_type;        
        QofIdType qof_obj_type;      
        QofEntity *qsf_ent;          
        QofBackend *be;              
        gboolean knowntype;          
        QofParam *qof_param;         
        QofBook *book;               
        int boolean_calculation_done; 
        char *filepath; 
}qsf_param;

void qsf_free_params(qsf_param *params);

typedef struct qsf_validates
{
        QofBackendError error_state;
        const char *object_path;
        const char *map_path;
        GHashTable *validation_table;
        int valid_object_count;
        int map_calculated_count;
        int qof_registered_count;
}qsf_validator;


int
qsf_compare_tag_strings(const xmlChar *node_name, char *tag_name);

int
qsf_strings_equal(const xmlChar *node_name, char *tag_name);

int
qsf_is_element(xmlNodePtr a, xmlNsPtr ns, char *c);

int
qsf_check_tag(qsf_param *params, char *qof_type);

void
qsf_object_validation_handler(xmlNodePtr child, xmlNsPtr ns, qsf_validator *valid);

void
qsf_map_validation_handler(xmlNodePtr child, xmlNsPtr ns, qsf_validator *valid);

void
qsf_map_top_node_handler(xmlNodePtr child, xmlNsPtr ns, qsf_param *params);

void
qsf_map_object_handler(xmlNodePtr child, xmlNsPtr ns, qsf_param *params);
gboolean
qsf_is_valid(const char *schema_dir, const char* schema_filename, xmlDocPtr doc);

gboolean is_qsf_object_be(qsf_param *params);

gboolean is_our_qsf_object_be(qsf_param *params);

gboolean is_qsf_map_be(qsf_param *params);

gboolean is_qsf_object_with_map_be(char *map_path, qsf_param *params);

gboolean is_qsf_object_with_map(const char *path, char *map_file);

gboolean
load_qsf_object(QofBook *book, const char *fullpath, qsf_param *params);

gboolean
load_our_qsf_object(QofBook *book, const char *fullpath, qsf_param *params);

void qsf_book_node_handler(xmlNodePtr child, xmlNsPtr qsf_ns, qsf_param *params);

void qsf_object_commitCB(gpointer key, gpointer value, gpointer data);

KvpValue*
string_to_kvp_value(const char *content, KvpValueType type);

void qsf_param_init(qsf_param *params);


typedef void (* qsf_nodeCB)(xmlNodePtr, xmlNsPtr, qsf_param*);

typedef void (* qsf_validCB)(xmlNodePtr, xmlNsPtr, qsf_validator*);


struct qsf_node_iterate {
        qsf_nodeCB *fcn;
        qsf_validCB *v_fcn;
        xmlNsPtr ns;
};

gboolean is_qsf_object(const char *path);

gboolean is_our_qsf_object(const char *path);

gboolean is_qsf_map(const char *path);

void
qsf_file_type (QofBackend *be, QofBook *book);

void
qsf_valid_foreach(xmlNodePtr parent, qsf_validCB cb,
        struct qsf_node_iterate *iter, qsf_validator *valid);

void
qsf_node_foreach(xmlNodePtr parent, qsf_nodeCB cb,
        struct qsf_node_iterate *iter, qsf_param *params);

QofBackendError 
qof_session_load_our_qsf_object(QofSession *first_session, const char *path);

QofBackendError 
qof_session_load_qsf_object(QofSession *first_session, const char *path);

xmlDocPtr
qsf_object_convert(xmlDocPtr mapDoc, xmlNodePtr qsf_root, qsf_param *params);

void
qsf_object_node_handler(xmlNodePtr child, xmlNsPtr qsf_ns, qsf_param *params);

void qsf_write_file(QofBackend *be, QofBook *book);

QofBackend* qsf_backend_new(void);
        
#endif /* QSF_XML_H */

---