vlc_xml.h File Reference

This file defines functions and structures to handle xml tags in vlc. More...

Go to the source code of this file.

Data Structures
struct	xml_t
struct	xml_reader_t
Defines
#define	xml_Create(a)   xml_Create( VLC_OBJECT(a) )
#define	xml_ReaderCreate(a, s)   xml_ReaderCreate(VLC_OBJECT(a), s)
Enumerations
enum	{ XML_READER_NONE = 0, XML_READER_STARTELEM, XML_READER_ENDELEM, XML_READER_TEXT }
Functions
VLC_API xml_t *	xml_Create (vlc_object_t *) VLC_USED
VLC_API void	xml_Delete (xml_t *)
static void	xml_CatalogLoad (xml_t *xml, const char *catalog)
static void	xml_CatalogAdd (xml_t *xml, const char *type, const char *orig, const char *value)
VLC_API xml_reader_t *	xml_ReaderCreate (vlc_object_t *, stream_t *) VLC_USED
	Creates an XML reader.
VLC_API void	xml_ReaderDelete (xml_reader_t *)
	Deletes an XML reader.
VLC_API xml_reader_t *	xml_ReaderReset (xml_reader_t *, stream_t *) VLC_USED
	Resets an existing XML reader.
static int	xml_ReaderNextNode (xml_reader_t *reader, const char **pval)
static const char *	xml_ReaderNextAttr (xml_reader_t *reader, const char **pval)
static int	xml_ReaderUseDTD (xml_reader_t *reader)
static int	xml_ReaderIsEmptyElement (xml_reader_t *reader)

---

Detailed Description

This file defines functions and structures to handle xml tags in vlc.

---

Define Documentation

#define xml_Create

(

a

)

xml_Create( VLC_OBJECT(a) )

#define xml_ReaderCreate	(		a,
			s
	)			xml_ReaderCreate(VLC_OBJECT(a), s)

---

Enumeration Type Documentation

anonymous enum

Enumerator:

XML_READER_NONE
XML_READER_STARTELEM
XML_READER_ENDELEM
XML_READER_TEXT

---

Function Documentation

static void xml_CatalogAdd	(	xml_t *	xml,
		const char *	type,
		const char *	orig,
		const char *	value
	)			[inline, static]

References xml_t::pf_catalog_add.

static void xml_CatalogLoad	(	xml_t *	xml,
		const char *	catalog
	)			[inline, static]

References xml_t::pf_catalog_load.

VLC_API xml_t* xml_Create

(

vlc_object_t *

)

References module_need, msg_Err, xml_t::p_module, vlc_custom_create, and vlc_object_release.

VLC_API void xml_Delete

(

xml_t *

)

References module_unneed, xml_t::p_module, and vlc_object_release.

VLC_API xml_reader_t* xml_ReaderCreate	(	vlc_object_t *	obj,
		stream_t *	stream
	)

Creates an XML reader.

Parameters:

	obj	parent VLC object
	stream	stream to read XML from

Returns:

NULL on error.

References module_need, msg_Err, xml_reader_t::p_module, xml_reader_t::p_stream, unlikely, vlc_custom_create, and vlc_object_release.

VLC_API void xml_ReaderDelete

(

xml_reader_t *

reader

)

Deletes an XML reader.

Parameters:

reader

XML reader created with xml_ReaderCreate().

References module_stop, xml_reader_t::p_module, xml_reader_t::p_stream, and vlc_object_release.

static int xml_ReaderIsEmptyElement

(

xml_reader_t *

reader

)

[inline, static]

References xml_reader_t::pf_is_empty.

static const char* xml_ReaderNextAttr	(	xml_reader_t *	reader,
		const char **	pval
	)			[inline, static]

References xml_reader_t::pf_next_attr.

static int xml_ReaderNextNode	(	xml_reader_t *	reader,
		const char **	pval
	)			[inline, static]

VLC_API xml_reader_t* xml_ReaderReset	(	xml_reader_t *	reader,
		stream_t *	stream
	)

Resets an existing XML reader.

If you need to parse several XML files, this function is much faster than xml_ReaderCreate() and xml_ReaderDelete() combined. If the stream parameter is NULL, the XML reader will be stopped, but not restarted until the next xml_ReaderReset() call with a non-NULL stream.

Parameters:

	reader	XML reader to reinitialize
	stream	new stream to read XML data from (or NULL)

Returns:

reader on success, NULL on error (in that case, the reader is destroyed).

References module_start, module_stop, xml_reader_t::p_module, xml_reader_t::p_stream, and vlc_object_release.

static int xml_ReaderUseDTD

(

xml_reader_t *

reader

)

[inline, static]

References xml_reader_t::pf_use_dtd.