1 /*****************************************************************************
2 * vlc_xml.h: XML abstraction layer
3 *****************************************************************************
4 * Copyright (C) 2004-2010 VLC authors and VideoLAN
5 *
6 * Author: Gildas Bazin <gbazin@videolan.org>
7 *
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU Lesser General Public License as published by
10 * the Free Software Foundation; either version 2.1 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public License
19 * along with this program; if not, write to the Free Software Foundation,
20 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21 *****************************************************************************/
22
23 #ifndef VLC_XML_H
24 #define VLC_XML_H
25
26 /**
27 * \file
28 * This file defines functions and structures to handle xml tags in vlc
29 *
30 */
31
32 # ifdef __cplusplus
33 extern "C" {
34 # endif
35
36 struct xml_t
37 {
38 VLC_COMMON_MEMBERS
39
40 /* Module properties */
41 module_t *p_module;
42 xml_sys_t *p_sys;
43
44 void (*pf_catalog_load) ( xml_t *, const char * );
45 void (*pf_catalog_add) ( xml_t *, const char *, const char *,
46 const char * );
47 };
48
49 VLC_API xml_t * xml_Create( vlc_object_t * ) VLC_USED;
50 #define xml_Create( a ) xml_Create( VLC_OBJECT(a) )
51 VLC_API void xml_Delete( xml_t * );
52
xml_CatalogLoad(xml_t * xml,const char * catalog)53 static inline void xml_CatalogLoad( xml_t *xml, const char *catalog )
54 {
55 xml->pf_catalog_load( xml, catalog );
56 }
57
xml_CatalogAdd(xml_t * xml,const char * type,const char * orig,const char * value)58 static inline void xml_CatalogAdd( xml_t *xml, const char *type,
59 const char *orig, const char *value )
60 {
61 xml->pf_catalog_add( xml, type, orig, value );
62 }
63
64
65 struct xml_reader_t
66 {
67 VLC_COMMON_MEMBERS
68
69 xml_reader_sys_t *p_sys;
70 stream_t *p_stream;
71 module_t *p_module;
72
73 int (*pf_next_node) ( xml_reader_t *, const char ** );
74 const char *(*pf_next_attr) ( xml_reader_t *, const char ** );
75
76 int (*pf_use_dtd) ( xml_reader_t * );
77 int (*pf_is_empty) ( xml_reader_t * );
78 };
79
80 VLC_API xml_reader_t * xml_ReaderCreate(vlc_object_t *, stream_t *) VLC_USED;
81 #define xml_ReaderCreate( a, s ) xml_ReaderCreate(VLC_OBJECT(a), s)
82 VLC_API void xml_ReaderDelete(xml_reader_t *);
83 VLC_API xml_reader_t * xml_ReaderReset(xml_reader_t *, stream_t *) VLC_USED;
84
xml_ReaderNextNode(xml_reader_t * reader,const char ** pval)85 static inline int xml_ReaderNextNode( xml_reader_t *reader, const char **pval )
86 {
87 return reader->pf_next_node( reader, pval );
88 }
89
xml_ReaderNextAttr(xml_reader_t * reader,const char ** pval)90 static inline const char *xml_ReaderNextAttr( xml_reader_t *reader,
91 const char **pval )
92 {
93 return reader->pf_next_attr( reader, pval );
94 }
95
xml_ReaderUseDTD(xml_reader_t * reader)96 static inline int xml_ReaderUseDTD( xml_reader_t *reader )
97 {
98 return reader->pf_use_dtd( reader );
99 }
100
xml_ReaderIsEmptyElement(xml_reader_t * reader)101 static inline int xml_ReaderIsEmptyElement( xml_reader_t *reader )
102 {
103 if(reader->pf_is_empty == NULL)
104 return -2;
105
106 return reader->pf_is_empty( reader );
107 }
108
109 enum {
110 XML_READER_ERROR=-1,
111 XML_READER_NONE=0,
112 XML_READER_STARTELEM,
113 XML_READER_ENDELEM,
114 XML_READER_TEXT,
115 };
116
117 # ifdef __cplusplus
118 }
119 # endif
120
121 #endif
122