VLC  4.0.0-dev
vlc_xml.h
Go to the documentation of this file.
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  struct vlc_object_t obj;
39 
40  /* Module properties */
42  void *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 
50 #define xml_Create( a ) xml_Create( VLC_OBJECT(a) )
52 
53 static inline void xml_CatalogLoad( xml_t *xml, const char *catalog )
54 {
55  xml->pf_catalog_load( xml, catalog );
56 }
57 
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  struct vlc_object_t obj;
68 
69  void *p_sys;
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 
81 #define xml_ReaderCreate( a, s ) xml_ReaderCreate(VLC_OBJECT(a), s)
83 
84 static inline int xml_ReaderNextNode( xml_reader_t *reader, const char **pval )
85 {
86  return reader->pf_next_node( reader, pval );
87 }
88 
89 static inline const char *xml_ReaderNextAttr( xml_reader_t *reader,
90  const char **pval )
91 {
92  return reader->pf_next_attr( reader, pval );
93 }
94 
95 static inline int xml_ReaderUseDTD( xml_reader_t *reader )
96 {
97  return reader->pf_use_dtd( reader );
98 }
99 
100 static inline int xml_ReaderIsEmptyElement( xml_reader_t *reader )
101 {
102  if(reader->pf_is_empty == NULL)
103  return -2;
104 
105  return reader->pf_is_empty( reader );
106 }
107 
108 enum {
109  XML_READER_ERROR=-1,
114 };
115 
116 # ifdef __cplusplus
117 }
118 # endif
119 
120 #endif
xml_reader_t::pf_use_dtd
int(* pf_use_dtd)(xml_reader_t *)
Definition: vlc_xml.h:77
xml_ReaderIsEmptyElement
static int xml_ReaderIsEmptyElement(xml_reader_t *reader)
Definition: vlc_xml.h:101
xml_ReaderCreate
#define xml_ReaderCreate(a, s)
Definition: vlc_xml.h:82
xml_t::obj
struct vlc_object_t obj
Definition: vlc_xml.h:39
xml_reader_t::p_stream
stream_t * p_stream
Definition: vlc_xml.h:71
xml_ReaderDelete
VLC_EXPORT void xml_ReaderDelete(xml_reader_t *)
Deletes an XML reader.
Definition: xml.c:95
VLC_API
#define VLC_API
Definition: fourcc_gen.c:31
xml_ReaderUseDTD
static int xml_ReaderUseDTD(xml_reader_t *reader)
Definition: vlc_xml.h:96
xml_t::pf_catalog_add
void(* pf_catalog_add)(xml_t *, const char *, const char *, const char *)
Definition: vlc_xml.h:46
xml_t::p_sys
void * p_sys
Definition: vlc_xml.h:43
xml_Delete
VLC_EXPORT void xml_Delete(xml_t *)
Definition: xml.c:59
xml_reader_t::pf_next_attr
const char *(* pf_next_attr)(xml_reader_t *, const char **)
Definition: vlc_xml.h:75
vlc_common.h
xml_ReaderNextAttr
static const char * xml_ReaderNextAttr(xml_reader_t *reader, const char **pval)
Definition: vlc_xml.h:90
XML_READER_ENDELEM
@ XML_READER_ENDELEM
Definition: vlc_xml.h:113
XML_READER_STARTELEM
@ XML_READER_STARTELEM
Definition: vlc_xml.h:112
xml_reader_t::pf_is_empty
int(* pf_is_empty)(xml_reader_t *)
Definition: vlc_xml.h:78
module_t
Internal module descriptor.
Definition: modules.h:78
XML_READER_ERROR
@ XML_READER_ERROR
Definition: vlc_xml.h:110
xml_t::p_module
module_t * p_module
Definition: vlc_xml.h:42
xml_t::pf_catalog_load
void(* pf_catalog_load)(xml_t *, const char *)
Definition: vlc_xml.h:45
xml_CatalogLoad
static void xml_CatalogLoad(xml_t *xml, const char *catalog)
Definition: vlc_xml.h:54
XML_READER_TEXT
@ XML_READER_TEXT
Definition: vlc_xml.h:114
stream_t
stream_t definition
Definition: vlc_stream.h:46
xml_t
Definition: vlc_xml.h:37
xml_reader_t::pf_next_node
int(* pf_next_node)(xml_reader_t *, const char **)
Definition: vlc_xml.h:74
vlc_object_t
VLC object common members.
Definition: vlc_objects.h:43
xml_reader_t::p_module
module_t * p_module
Definition: vlc_xml.h:72
VLC_USED
#define VLC_USED
Definition: fourcc_gen.c:32
XML_READER_NONE
@ XML_READER_NONE
Definition: vlc_xml.h:111
xml_reader_t::p_sys
void * p_sys
Definition: vlc_xml.h:70
xml_ReaderNextNode
static int xml_ReaderNextNode(xml_reader_t *reader, const char **pval)
Definition: vlc_xml.h:85
xml_reader_t
Definition: vlc_xml.h:66
xml_CatalogAdd
static void xml_CatalogAdd(xml_t *xml, const char *type, const char *orig, const char *value)
Definition: vlc_xml.h:59
xml_reader_t::obj
struct vlc_object_t obj
Definition: vlc_xml.h:68
xml_Create
#define xml_Create(a)
Definition: vlc_xml.h:51