X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_xml.h;h=3bb8312b7a73ede0763763f3672785f80ac576e3;hb=d24751a730c8d352e7a45ea67c739ad8397a1418;hp=1b600b73f2e15942a01195817bb6a29b07b5b50b;hpb=c0f4bfc5d85c96cf29f4bd05fa5fa42eb344d1dc;p=vlc diff --git a/include/vlc_xml.h b/include/vlc_xml.h index 1b600b73f2..3bb8312b7a 100644 --- a/include/vlc_xml.h +++ b/include/vlc_xml.h @@ -1,29 +1,34 @@ /***************************************************************************** - * xml.h: XML abstraction layer + * vlc_xml.h: XML abstraction layer ***************************************************************************** - * Copyright (C) 2004 the VideoLAN team - * $Id$ + * Copyright (C) 2004-2010 VLC authors and VideoLAN * * Author: Gildas Bazin * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation; either version 2.1 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ #ifndef VLC_XML_H #define VLC_XML_H +/** +* \file +* This file defines functions and structures to handle xml tags in vlc +* +*/ + # ifdef __cplusplus extern "C" { # endif @@ -36,48 +41,77 @@ struct xml_t module_t *p_module; xml_sys_t *p_sys; - xml_reader_t * (*pf_reader_create) ( xml_t *, stream_t * ); - void (*pf_reader_delete) ( xml_reader_t * ); - void (*pf_catalog_load) ( xml_t *, const char * ); void (*pf_catalog_add) ( xml_t *, const char *, const char *, - const char * ); + const char * ); }; -#define xml_Create( a ) __xml_Create( VLC_OBJECT(a) ) -VLC_EXPORT( xml_t *, __xml_Create, ( vlc_object_t * ) ); -VLC_EXPORT( void, xml_Delete, ( xml_t * ) ); +VLC_API xml_t * xml_Create( vlc_object_t * ) VLC_USED; +#define xml_Create( a ) xml_Create( VLC_OBJECT(a) ) +VLC_API void xml_Delete( xml_t * ); + +static inline void xml_CatalogLoad( xml_t *xml, const char *catalog ) +{ + xml->pf_catalog_load( xml, catalog ); +} + +static inline void xml_CatalogAdd( xml_t *xml, const char *type, + const char *orig, const char *value ) +{ + xml->pf_catalog_add( xml, type, orig, value ); +} -#define xml_ReaderCreate( a, b ) a->pf_reader_create( a, b ) -#define xml_ReaderDelete( a, b ) a->pf_reader_delete( b ) -#define xml_CatalogLoad( a, b ) a->pf_catalog_load( a, b ) -#define xml_CatalogAdd( a, b, c, d ) a->pf_catalog_add( a, b, c, d ) struct xml_reader_t { - xml_t *p_xml; + VLC_COMMON_MEMBERS + xml_reader_sys_t *p_sys; + stream_t *p_stream; + module_t *p_module; - int (*pf_read) ( xml_reader_t * ); - int (*pf_node_type) ( xml_reader_t * ); - char * (*pf_name) ( xml_reader_t * ); - char * (*pf_value) ( xml_reader_t * ); - int (*pf_next_attr) ( xml_reader_t * ); + int (*pf_next_node) ( xml_reader_t *, const char ** ); + const char *(*pf_next_attr) ( xml_reader_t *, const char ** ); - int (*pf_use_dtd) ( xml_reader_t *, bool ); + int (*pf_use_dtd) ( xml_reader_t * ); + int (*pf_is_empty) ( xml_reader_t * ); }; -#define xml_ReaderRead( a ) a->pf_read( a ) -#define xml_ReaderNodeType( a ) a->pf_node_type( a ) -#define xml_ReaderName( a ) a->pf_name( a ) -#define xml_ReaderValue( a ) a->pf_value( a ) -#define xml_ReaderNextAttr( a ) a->pf_next_attr( a ) -#define xml_ReaderUseDTD( a, b ) a->pf_use_dtd( a, b ) - -#define XML_READER_NONE 0 -#define XML_READER_STARTELEM 1 -#define XML_READER_ENDELEM 2 -#define XML_READER_TEXT 3 +VLC_API xml_reader_t * xml_ReaderCreate(vlc_object_t *, stream_t *) VLC_USED; +#define xml_ReaderCreate( a, s ) xml_ReaderCreate(VLC_OBJECT(a), s) +VLC_API void xml_ReaderDelete(xml_reader_t *); +VLC_API xml_reader_t * xml_ReaderReset(xml_reader_t *, stream_t *) VLC_USED; + +static inline int xml_ReaderNextNode( xml_reader_t *reader, const char **pval ) +{ + return reader->pf_next_node( reader, pval ); +} + +static inline const char *xml_ReaderNextAttr( xml_reader_t *reader, + const char **pval ) +{ + return reader->pf_next_attr( reader, pval ); +} + +static inline int xml_ReaderUseDTD( xml_reader_t *reader ) +{ + return reader->pf_use_dtd( reader ); +} + +static inline int xml_ReaderIsEmptyElement( xml_reader_t *reader ) +{ + if(reader->pf_is_empty == NULL) + return -2; + + return reader->pf_is_empty( reader ); +} + +enum { + XML_READER_NONE=0, + XML_READER_STARTELEM, + XML_READER_ENDELEM, + XML_READER_TEXT, +}; # ifdef __cplusplus }