qsf-xml.h

Go to the documentation of this file.

/***************************************************************************
 *            qsf-xml.h
 *
 *  Fri Nov 26 19:29:47 2004
 *  Copyright  2004,2005,2006  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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

#ifndef QSF_XML_H
#define QSF_XML_H

#include <stdio.h>
#include <stdlib.h>
#include <regex.h>
#include <time.h>
#include "qof.h"

#include <libintl.h>
#define _(String) dgettext (GETTEXT_PACKAGE, 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;
    gint 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 MAX_DATE_LENGTH 
#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_ITERATE_ATTR "foreach" 
#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_OBJECT_ATTR "object" 
#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;     
            gint 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;         
            xmlDocPtr output_doc;        
            xmlNodePtr child_node;       
            xmlNodePtr convert_node;     
            xmlNodePtr param_node;       
            xmlNodePtr output_node;      
            xmlNodePtr output_root;      
            xmlNodePtr book_node;        
            xmlNodePtr lister;           
            xmlNsPtr qsf_ns, map_ns;     
            const gchar *qof_type;       
            QofIdType qof_obj_type;          
            QofIdType qof_foreach;       
            gint foreach_limit;          
            QofInstance *qsf_ent;          
            QofBackend *be;              
            gboolean knowntype;          
            QofParam *qof_param;         
            QofBook *book;                   
            gint boolean_calculation_done; 
            gchar *filepath;              
            gchar *map_path;              
            gchar* full_kvp_path;         
            gint64 use_gz_level;          
            GList *map_files;             
            const gchar *encoding;        
        } qsf_param;

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

gint
qsf_compare_tag_strings(const xmlChar *node_name, gchar *tag_name);

gint
qsf_strings_equal(const xmlChar *node_name, gchar *tag_name);

gint
qsf_is_element(xmlNodePtr a, xmlNsPtr ns, gchar *c);

gint
qsf_check_tag(qsf_param *params, gchar *qof_type);

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

gboolean
qsf_is_valid(const gchar *schema_dir, const gchar* schema_filename, xmlDocPtr doc);

GList** qsf_map_prepare_list(GList **maps);

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_be(qsf_param *params);
gboolean is_qsf_object(const gchar *path);
gboolean is_our_qsf_object_be(qsf_param *params);
gboolean is_our_qsf_object(const gchar *path);
gboolean is_qsf_map_be(qsf_param *params);
gboolean is_qsf_map(const gchar *path);
gboolean is_qsf_object_with_map_be(gchar *map_path, qsf_param *params);
gboolean is_qsf_object_with_map(const gchar *path, gchar *map_file);

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

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

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);

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);

#endif /* QSF_XML_H */

---