xmlIO.h

Go to the documentation of this file.

/*
 * Summary: interface for the I/O interfaces used by the parser
 * Description: interface for the I/O interfaces used by the parser
 *
 * Copy: See Copyright for the status of this software.
 *
 * Author: Daniel Veillard
 */
 
#ifndef __XML_IO_H__
#define __XML_IO_H__
 
#include <stdio.h>
#include <libxml/xmlversion.h>
#include <libxml/encoding.h>
#define XML_TREE_INTERNALS
#include <libxml/tree.h>
#undef XML_TREE_INTERNALS
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * Those are the functions and datatypes for the parser input
 * I/O structures.
 */
 
typedef int (*xmlInputMatchCallback) (char const *filename);
typedef void * (*xmlInputOpenCallback) (char const *filename);
typedef int (*xmlInputReadCallback) (void * context, char * buffer, int len);
typedef int (*xmlInputCloseCallback) (void * context);
 
#ifdef LIBXML_OUTPUT_ENABLED
/*
 * Those are the functions and datatypes for the library output
 * I/O structures.
 */
 
typedef int (*xmlOutputMatchCallback) (char const *filename);
typedef void * (*xmlOutputOpenCallback) (char const *filename);
typedef int (*xmlOutputWriteCallback) (void * context, const char * buffer,
                                       int len);
typedef int (*xmlOutputCloseCallback) (void * context);
#endif /* LIBXML_OUTPUT_ENABLED */
 
typedef xmlParserInputBufferPtr
(*xmlParserInputBufferCreateFilenameFunc)(const char *URI, xmlCharEncoding enc);
 
typedef xmlOutputBufferPtr
(*xmlOutputBufferCreateFilenameFunc)(const char *URI,
        xmlCharEncodingHandlerPtr encoder, int compression);
 
struct _xmlParserInputBuffer {
    void*                  context;
    xmlInputReadCallback   readcallback;
    xmlInputCloseCallback  closecallback;
 
    xmlCharEncodingHandlerPtr encoder; /* I18N conversions to UTF-8 */
 
    xmlBufPtr buffer;    /* Local buffer encoded in UTF-8 */
    xmlBufPtr raw;       /* if encoder != NULL buffer for raw input */
    int compressed;     /* -1=unknown, 0=not compressed, 1=compressed */
    int error;
    unsigned long rawconsumed;/* amount consumed from raw */
};
 
 
#ifdef LIBXML_OUTPUT_ENABLED
struct _xmlOutputBuffer {
    void*                   context;
    xmlOutputWriteCallback  writecallback;
    xmlOutputCloseCallback  closecallback;
 
    xmlCharEncodingHandlerPtr encoder; /* I18N conversions to UTF-8 */
 
    xmlBufPtr buffer;    /* Local buffer encoded in UTF-8 or ISOLatin */
    xmlBufPtr conv;      /* if encoder != NULL buffer for output */
    int written;            /* total number of byte written */
    int error;
};
#endif /* LIBXML_OUTPUT_ENABLED */
 
#define XML_GLOBALS_IO \
  XML_OP(xmlParserInputBufferCreateFilenameValue, \
           xmlParserInputBufferCreateFilenameFunc, XML_DEPRECATED) \
  XML_OP(xmlOutputBufferCreateFilenameValue, \
           xmlOutputBufferCreateFilenameFunc, XML_DEPRECATED)
 
#define XML_OP XML_DECLARE_GLOBAL
XML_GLOBALS_IO
#undef XML_OP
 
#if defined(LIBXML_THREAD_ENABLED) && !defined(XML_GLOBALS_NO_REDEFINITION)
  #define xmlParserInputBufferCreateFilenameValue \
    XML_GLOBAL_MACRO(xmlParserInputBufferCreateFilenameValue)
  #define xmlOutputBufferCreateFilenameValue \
    XML_GLOBAL_MACRO(xmlOutputBufferCreateFilenameValue)
#endif
/*
 * Interfaces for input
 */
XMLPUBFUN void
    xmlCleanupInputCallbacks        (void);
 
XMLPUBFUN int
    xmlPopInputCallbacks            (void);
 
XMLPUBFUN void
    xmlRegisterDefaultInputCallbacks    (void);
XMLPUBFUN xmlParserInputBufferPtr
    xmlAllocParserInputBuffer       (xmlCharEncoding enc);
 
XMLPUBFUN xmlParserInputBufferPtr
    xmlParserInputBufferCreateFilename  (const char *URI,
                                                 xmlCharEncoding enc);
XMLPUBFUN xmlParserInputBufferPtr
    xmlParserInputBufferCreateFile      (FILE *file,
                                                 xmlCharEncoding enc);
XMLPUBFUN xmlParserInputBufferPtr
    xmlParserInputBufferCreateFd        (int fd,
                                             xmlCharEncoding enc);
XMLPUBFUN xmlParserInputBufferPtr
    xmlParserInputBufferCreateMem       (const char *mem, int size,
                                             xmlCharEncoding enc);
XMLPUBFUN xmlParserInputBufferPtr
    xmlParserInputBufferCreateStatic    (const char *mem, int size,
                                             xmlCharEncoding enc);
XMLPUBFUN xmlParserInputBufferPtr
    xmlParserInputBufferCreateIO        (xmlInputReadCallback   ioread,
                         xmlInputCloseCallback  ioclose,
                         void *ioctx,
                                             xmlCharEncoding enc);
XMLPUBFUN int
    xmlParserInputBufferRead        (xmlParserInputBufferPtr in,
                         int len);
XMLPUBFUN int
    xmlParserInputBufferGrow        (xmlParserInputBufferPtr in,
                         int len);
XMLPUBFUN int
    xmlParserInputBufferPush        (xmlParserInputBufferPtr in,
                         int len,
                         const char *buf);
XMLPUBFUN void
    xmlFreeParserInputBuffer        (xmlParserInputBufferPtr in);
XMLPUBFUN char *
    xmlParserGetDirectory           (const char *filename);
 
XMLPUBFUN int
    xmlRegisterInputCallbacks       (xmlInputMatchCallback matchFunc,
                         xmlInputOpenCallback openFunc,
                         xmlInputReadCallback readFunc,
                         xmlInputCloseCallback closeFunc);
 
xmlParserInputBufferPtr
    __xmlParserInputBufferCreateFilename(const char *URI,
                        xmlCharEncoding enc);
 
#ifdef LIBXML_OUTPUT_ENABLED
/*
 * Interfaces for output
 */
XMLPUBFUN void
    xmlCleanupOutputCallbacks       (void);
XMLPUBFUN int
    xmlPopOutputCallbacks           (void);
XMLPUBFUN void
    xmlRegisterDefaultOutputCallbacks(void);
XMLPUBFUN xmlOutputBufferPtr
    xmlAllocOutputBuffer        (xmlCharEncodingHandlerPtr encoder);
 
XMLPUBFUN xmlOutputBufferPtr
    xmlOutputBufferCreateFilename   (const char *URI,
                     xmlCharEncodingHandlerPtr encoder,
                     int compression);
 
XMLPUBFUN xmlOutputBufferPtr
    xmlOutputBufferCreateFile   (FILE *file,
                     xmlCharEncodingHandlerPtr encoder);
 
XMLPUBFUN xmlOutputBufferPtr
    xmlOutputBufferCreateBuffer (xmlBufferPtr buffer,
                     xmlCharEncodingHandlerPtr encoder);
 
XMLPUBFUN xmlOutputBufferPtr
    xmlOutputBufferCreateFd     (int fd,
                     xmlCharEncodingHandlerPtr encoder);
 
XMLPUBFUN xmlOutputBufferPtr
    xmlOutputBufferCreateIO     (xmlOutputWriteCallback   iowrite,
                     xmlOutputCloseCallback  ioclose,
                     void *ioctx,
                     xmlCharEncodingHandlerPtr encoder);
 
/* Couple of APIs to get the output without digging into the buffers */
XMLPUBFUN const xmlChar *
        xmlOutputBufferGetContent       (xmlOutputBufferPtr out);
XMLPUBFUN size_t
        xmlOutputBufferGetSize          (xmlOutputBufferPtr out);
 
XMLPUBFUN int
    xmlOutputBufferWrite        (xmlOutputBufferPtr out,
                     int len,
                     const char *buf);
XMLPUBFUN int
    xmlOutputBufferWriteString  (xmlOutputBufferPtr out,
                     const char *str);
XMLPUBFUN int
    xmlOutputBufferWriteEscape  (xmlOutputBufferPtr out,
                     const xmlChar *str,
                     xmlCharEncodingOutputFunc escaping);
 
XMLPUBFUN int
    xmlOutputBufferFlush        (xmlOutputBufferPtr out);
XMLPUBFUN int
    xmlOutputBufferClose        (xmlOutputBufferPtr out);
 
XMLPUBFUN int
    xmlRegisterOutputCallbacks  (xmlOutputMatchCallback matchFunc,
                     xmlOutputOpenCallback openFunc,
                     xmlOutputWriteCallback writeFunc,
                     xmlOutputCloseCallback closeFunc);
 
xmlOutputBufferPtr
    __xmlOutputBufferCreateFilename(const char *URI,
                              xmlCharEncodingHandlerPtr encoder,
                              int compression);
 
#ifdef LIBXML_HTTP_ENABLED
/*  This function only exists if HTTP support built into the library  */
XMLPUBFUN void
    xmlRegisterHTTPPostCallbacks    (void );
#endif /* LIBXML_HTTP_ENABLED */
 
#endif /* LIBXML_OUTPUT_ENABLED */
 
XMLPUBFUN xmlParserInputPtr
    xmlCheckHTTPInput       (xmlParserCtxtPtr ctxt,
                     xmlParserInputPtr ret);
 
/*
 * A predefined entity loader disabling network accesses
 */
XMLPUBFUN xmlParserInputPtr
    xmlNoNetExternalEntityLoader    (const char *URL,
                     const char *ID,
                     xmlParserCtxtPtr ctxt);
 
/*
 * xmlNormalizeWindowsPath is obsolete, don't use it.
 * Check xmlCanonicPath in uri.h for a better alternative.
 */
XMLPUBFUN xmlChar *
    xmlNormalizeWindowsPath     (const xmlChar *path);
 
XMLPUBFUN int
    xmlCheckFilename        (const char *path);
XMLPUBFUN int
    xmlFileMatch            (const char *filename);
XMLPUBFUN void *
    xmlFileOpen         (const char *filename);
XMLPUBFUN int
    xmlFileRead         (void * context,
                     char * buffer,
                     int len);
XMLPUBFUN int
    xmlFileClose            (void * context);
 
#ifdef LIBXML_HTTP_ENABLED
XMLPUBFUN int
    xmlIOHTTPMatch          (const char *filename);
XMLPUBFUN void *
    xmlIOHTTPOpen           (const char *filename);
#ifdef LIBXML_OUTPUT_ENABLED
XMLPUBFUN void *
    xmlIOHTTPOpenW          (const char * post_uri,
                     int   compression );
#endif /* LIBXML_OUTPUT_ENABLED */
XMLPUBFUN int
    xmlIOHTTPRead           (void * context,
                     char * buffer,
                     int len);
XMLPUBFUN int
    xmlIOHTTPClose          (void * context);
#endif /* LIBXML_HTTP_ENABLED */
 
#if defined(LIBXML_FTP_ENABLED)
XMLPUBFUN int
    xmlIOFTPMatch           (const char *filename);
XMLPUBFUN void *
    xmlIOFTPOpen            (const char *filename);
XMLPUBFUN int
    xmlIOFTPRead            (void * context,
                     char * buffer,
                     int len);
XMLPUBFUN int
    xmlIOFTPClose           (void * context);
#endif /* defined(LIBXML_FTP_ENABLED) */
 
XMLPUBFUN xmlParserInputBufferCreateFilenameFunc
    xmlParserInputBufferCreateFilenameDefault(
        xmlParserInputBufferCreateFilenameFunc func);
XMLPUBFUN xmlOutputBufferCreateFilenameFunc
    xmlOutputBufferCreateFilenameDefault(
        xmlOutputBufferCreateFilenameFunc func);
XMLPUBFUN xmlOutputBufferCreateFilenameFunc
    xmlThrDefOutputBufferCreateFilenameDefault(
        xmlOutputBufferCreateFilenameFunc func);
XMLPUBFUN xmlParserInputBufferCreateFilenameFunc
    xmlThrDefParserInputBufferCreateFilenameDefault(
        xmlParserInputBufferCreateFilenameFunc func);
 
#ifdef __cplusplus
}
#endif
 
#endif /* __XML_IO_H__ */