vlc_xml.h File Reference

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

Include dependency graph for vlc_xml.h:

Go to the source code of this file.

Data Structures
struct	xml_t
struct	xml_reader_t

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

Enumerations
enum	{   XML_READER_ERROR =-1 , XML_READER_NONE =0 , XML_READER_STARTELEM , XML_READER_ENDELEM ,   XML_READER_TEXT }

Functions
xml_t *	xml_Create (vlc_object_t *)
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)
xml_reader_t *	xml_ReaderCreate (vlc_object_t *, stream_t *)
	Creates an XML reader. More...
void	xml_ReaderDelete (xml_reader_t *)
	Deletes an XML reader. More...
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.

Macro Definition Documentation

xml_Create

#define xml_Create

(

a

)

xml_Create( VLC_OBJECT(a) )

xml_ReaderCreate

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

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
XML_READER_ERROR
XML_READER_NONE
XML_READER_STARTELEM
XML_READER_ENDELEM
XML_READER_TEXT

Function Documentation

xml_CatalogAdd()

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

inlinestatic

References xml_t::pf_catalog_add.

xml_CatalogLoad()

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

inlinestatic

References xml_t::pf_catalog_load.

xml_Create()

xml_t * xml_Create

(

vlc_object_t *

p_this

)

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

xml_Delete()

void xml_Delete

(

xml_t *

p_xml

)

References module_unneed, xml_t::p_module, and vlc_object_delete.

xml_ReaderCreate()

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_delete.

xml_ReaderDelete()

void xml_ReaderDelete

(

xml_reader_t *

reader

)

Deletes an XML reader.

Parameters

reader

XML reader created with xml_ReaderCreate().

References module_unneed, xml_reader_t::p_module, and vlc_object_delete.

xml_ReaderIsEmptyElement()

static int xml_ReaderIsEmptyElement ( xml_reader_t *  reader )

inlinestatic

References xml_reader_t::pf_is_empty.

xml_ReaderNextAttr()

static const char * xml_ReaderNextAttr ( xml_reader_t *  reader, const char **  pval  )

inlinestatic

References xml_reader_t::pf_next_attr.

xml_ReaderNextNode()

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

inlinestatic

References xml_reader_t::pf_next_node.

xml_ReaderUseDTD()

static int xml_ReaderUseDTD ( xml_reader_t *  reader )

inlinestatic

References xml_reader_t::pf_use_dtd.