gg_xml.h

Go to the documentation of this file.

/*
 gg_xml.h -- Gaia common support for XML documents
  
 version 4.1, 2013 May 8

 Author: Sandro Furieri a.furieri@lqt.it

 ------------------------------------------------------------------------------
 
 Version: MPL 1.1/GPL 2.0/LGPL 2.1
 
 The contents of this file are subject to the Mozilla Public License Version
 1.1 (the "License"); you may not use this file except in compliance with
 the License. You may obtain a copy of the License at
 http://www.mozilla.org/MPL/
 
Software distributed under the License is distributed on an "AS IS" basis,
WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
for the specific language governing rights and limitations under the
License.

The Original Code is the SpatiaLite library

The Initial Developer of the Original Code is Alessandro Furieri
 
Portions created by the Initial Developer are Copyright (C) 2008-2013
the Initial Developer. All Rights Reserved.

Contributor(s):

Alternatively, the contents of this file may be used under the terms of
either the GNU General Public License Version 2 or later (the "GPL"), or
the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
in which case the provisions of the GPL or the LGPL are applicable instead
of those above. If you wish to allow use of your version of this file only
under the terms of either the GPL or the LGPL, and not to allow others to
use your version of this file under the terms of the MPL, indicate your
decision by deleting the provisions above and replace them with the notice
and other provisions required by the GPL or the LGPL. If you do not delete
the provisions above, a recipient may use your version of this file under
the terms of any one of the MPL, the GPL or the LGPL.
 
*/


#ifndef _GG_XML_H
#ifndef DOXYGEN_SHOULD_SKIP_THIS
#define _GG_XML_H
#endif

#ifdef __cplusplus
extern "C"
{
#endif

/* constant values for XmlBLOB */

#define GAIA_XML_START          0x00

#define GAIA_XML_END            0xDD

#define GAIA_XML_HEADER         0xAB

#define GAIA_XML_SCHEMA         0xBA

#define GAIA_XML_FILEID         0xCA

#define GAIA_XML_PARENTID       0xDA

#define GAIA_XML_TITLE          0xDB

#define GAIA_XML_ABSTRACT       0xDC

#define GAIA_XML_GEOMETRY       0xDD

#define GAIA_XML_CRC32          0xBC

#define GAIA_XML_PAYLOAD        0xCB

/* bitmasks for XmlBLOB-FLAG */

#define GAIA_XML_LITTLE_ENDIAN          0x01

#define GAIA_XML_COMPRESSED             0x02

#define GAIA_XML_VALIDATED              0x04

#define GAIA_XML_ISO_METADATA           0x80

#define GAIA_XML_SLD_SE_RASTER_STYLE    0x10

#define GAIA_XML_SLD_SE_VECTOR_STYLE    0x40

#define GAIA_XML_SVG                    0x20


/* function prototypes */

#ifndef DOXYGEN_SHOULD_IGNORE_THIS
#ifdef ENABLE_LIBXML2           /* LIBXML2 enabled: supporting XML documents */
#endif

    GAIAGEO_DECLARE char *gaia_libxml2_version (void);

    GAIAGEO_DECLARE void gaiaXmlToBlob (void *p_cache, const unsigned char *xml,
                                        int xml_len, int compressed,
                                        const char *schemaURI,
                                        unsigned char **result, int *size,
                                        char **parsing_errors,
                                        char **schema_validation_errors);

    GAIAGEO_DECLARE char *gaiaXmlTextFromBlob (const unsigned char *blob,
                                               int size, int indent);

    GAIAGEO_DECLARE void gaiaXmlFromBlob (const unsigned char *blob,
                                          int size, int indent,
                                          unsigned char **result,
                                          int *res_size);

    GAIAGEO_DECLARE int gaiaIsValidXmlBlob (const unsigned char *blob,
                                            int size);

    GAIAGEO_DECLARE int gaiaIsCompressedXmlBlob (const unsigned char *blob,
                                                 int size);

    GAIAGEO_DECLARE int gaiaIsIsoMetadataXmlBlob (const unsigned char *blob,
                                                  int size);

    GAIAGEO_DECLARE int gaiaIsSldSeVectorStyleXmlBlob (const unsigned char
                                                       *blob, int size);

    GAIAGEO_DECLARE int gaiaIsSldSeRasterStyleXmlBlob (const unsigned char
                                                       *blob, int size);

    GAIAGEO_DECLARE int gaiaIsSvgXmlBlob (const unsigned char *blob, int size);

    GAIAGEO_DECLARE void gaiaXmlBlobCompression (const unsigned char *blob,
                                                 int in_size, int compressed,
                                                 unsigned char **result,
                                                 int *out_size);

    GAIAGEO_DECLARE int gaiaIsSchemaValidatedXmlBlob (const unsigned char *blob,
                                                      int size);

    GAIAGEO_DECLARE int gaiaXmlBlobGetDocumentSize (const unsigned char *blob,
                                                    int size);

    GAIAGEO_DECLARE char *gaiaXmlBlobGetSchemaURI (const unsigned char
                                                   *blob, int size);

    GAIAGEO_DECLARE char *gaiaXmlGetInternalSchemaURI (void *p_cache,
                                                       const unsigned char *xml,
                                                       int xml_len);

    GAIAGEO_DECLARE char *gaiaXmlBlobGetFileId (const unsigned char
                                                *blob, int size);

    GAIAGEO_DECLARE char *gaiaXmlBlobGetParentId (const unsigned char
                                                  *blob, int size);

    GAIAGEO_DECLARE int gaiaXmlBlobSetFileId (void *p_cache, const unsigned char
                                              *blob, int size,
                                              const char *identifier,
                                              unsigned char **new_blob,
                                              int *new_size);

    GAIAGEO_DECLARE int gaiaXmlBlobSetParentId (void *p_cache,
                                                const unsigned char *blob,
                                                int size,
                                                const char *identifier,
                                                unsigned char **new_blob,
                                                int *new_size);

    GAIAGEO_DECLARE int gaiaXmlBlobAddFileId (void *p_cache, const unsigned char
                                              *blob, int size,
                                              const char *identifier,
                                              const char *ns_id,
                                              const char *uri_id,
                                              const char *ns_charstr,
                                              const char *uri_charstr,
                                              unsigned char **new_blob,
                                              int *new_size);

    GAIAGEO_DECLARE int gaiaXmlBlobAddParentId (void *p_cache,
                                                const unsigned char *blob,
                                                int size,
                                                const char *identifier,
                                                const char *ns_id,
                                                const char *uri_id,
                                                const char *ns_charstr,
                                                const char *uri_charstr,
                                                unsigned char **new_blob,
                                                int *new_size);

    GAIAGEO_DECLARE char *gaiaXmlBlobGetTitle (const unsigned char
                                               *blob, int size);

    GAIAGEO_DECLARE char *gaiaXmlBlobGetAbstract (const unsigned char
                                                  *blob, int size);

    GAIAGEO_DECLARE void gaiaXmlBlobGetGeometry (const unsigned char
                                                 *blob, int size,
                                                 unsigned char **blob_geom,
                                                 int *blob_size);

    GAIAGEO_DECLARE char *gaiaXmlBlobGetEncoding (const unsigned char
                                                  *blob, int size);

    GAIAGEO_DECLARE char *gaiaXmlBlobGetLastParseError (void *p_cache);

    GAIAGEO_DECLARE char *gaiaXmlBlobGetLastValidateError (void *p_cache);

    GAIAGEO_DECLARE int gaiaIsValidXPathExpression (void *p_cache,
                                                    const char *xpath_expr);

    GAIAGEO_DECLARE char *gaiaXmlBlobGetLastXPathError (void *p_cache);

    GAIAGEO_DECLARE int gaiaXmlLoad (void *p_cache, const char *path_or_url,
                                     unsigned char **result, int *size,
                                     char **parsing_errors);

    GAIAGEO_DECLARE int gaiaXmlStore (const unsigned char *blob, int size,
                                      const char *path, int indent);

#endif                          /* end LIBXML2: supporting XML documents */

#ifdef __cplusplus
}
#endif

#endif                          /* _GG_XML_H */