include/vlc_xml.h

   1 /*****************************************************************************
   2  * xml.h: XML abstraction layer
   3  *****************************************************************************
   4  * Copyright (C) 2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Author: Gildas Bazin <gbazin@videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef VLC_XML_H
  25 #define VLC_XML_H
  26
  27 /**
  28  * \file
  29  * This file defines functions and structures to handle xml tags in vlc
  30  *
  31  */
  32
  33 # ifdef __cplusplus
  34 extern "C" {
  35 # endif
  36
  37 struct xml_t
  38 {
  39     VLC_COMMON_MEMBERS
  40
  41     /* Module properties */
  42     module_t  *p_module;
  43     xml_sys_t *p_sys;
  44
  45     xml_reader_t * (*pf_reader_create) ( xml_t *, stream_t * );
  46     void (*pf_reader_delete) ( xml_reader_t * );
  47
  48     void (*pf_catalog_load) ( xml_t *, const char * );
  49     void (*pf_catalog_add) ( xml_t *, const char *, const char *,
  50                                const char * );
  51 };
  52
  53 VLC_EXPORT( xml_t *, xml_Create, ( vlc_object_t * ) );
  54 #define xml_Create( a ) xml_Create( VLC_OBJECT(a) )
  55 VLC_EXPORT( void, xml_Delete, ( xml_t * ) );
  56
  57 #define xml_ReaderCreate( a, b ) a->pf_reader_create( a, b )
  58 #define xml_ReaderDelete( a, b ) a->pf_reader_delete( b )
  59 #define xml_CatalogLoad( a, b ) a->pf_catalog_load( a, b )
  60 #define xml_CatalogAdd( a, b, c, d ) a->pf_catalog_add( a, b, c, d )
  61
  62 struct xml_reader_t
  63 {
  64     xml_t *p_xml;
  65     xml_reader_sys_t *p_sys;
  66
  67     int (*pf_read) ( xml_reader_t * );
  68     int (*pf_node_type) ( xml_reader_t * );
  69     char * (*pf_name) ( xml_reader_t * );
  70     char * (*pf_value) ( xml_reader_t * );
  71     int (*pf_next_attr) ( xml_reader_t * );
  72
  73     int (*pf_use_dtd) ( xml_reader_t *, bool );
  74 };
  75
  76 #define xml_ReaderRead( a ) a->pf_read( a )
  77 #define xml_ReaderNodeType( a ) a->pf_node_type( a )
  78 #define xml_ReaderName( a ) a->pf_name( a )
  79 #define xml_ReaderValue( a ) a->pf_value( a )
  80 #define xml_ReaderNextAttr( a ) a->pf_next_attr( a )
  81 #define xml_ReaderUseDTD( a, b ) a->pf_use_dtd( a, b )
  82
  83 #define XML_READER_NONE 0
  84 #define XML_READER_STARTELEM 1
  85 #define XML_READER_ENDELEM 2
  86 #define XML_READER_TEXT 3
  87
  88 # ifdef __cplusplus
  89 }
  90 # endif
  91
  92 #endif