XspfReader Class Reference

#include <XspfReader.h>

List of all members.

Public Member Functions
	XspfReader (XspfExtensionReaderFactory *handlerFactory=NULL)
	XspfReader (XspfReader const &source)
XspfReader &	operator= (XspfReader const &source)
	~XspfReader ()
int	parseFile (XML_Char const *filename, XspfReaderCallback *callback, XML_Char const *baseUri)
int	parseMemory (char const *memory, int numBytes, XspfReaderCallback *callback, XML_Char const *baseUri)
int	parseChunks (XspfChunkCallback *inputCallback, XspfReaderCallback *dataCallback, XML_Char const *baseUri)
void	limitLengthPerEntityValue (bool enabled)
void	limitLookupSumPerEntityValue (bool enabled)
void	limitLookupDepthPerEntityValue (bool enabled)
void	enableMaliciousXmlDetection (bool enabled)
void	setMaxLengthPerEntityValue (int maxLength)
void	setMaxLookupSumPerEntityValue (int maxLookupSum)
void	setMaxLookupDepthPerEntityValue (int maxLookupDepth)
Static Public Member Functions
static bool	isXmlBase (XML_Char const *attributeKey)
Friends
class	XspfExtensionReader

---

Detailed Description

Reads a XSPF playlist from a file.

Definition at line 209 of file XspfReader.h.

---

Constructor & Destructor Documentation

XspfReader

(

XspfExtensionReaderFactory *

handlerFactory = NULL

)

Creates a new reader.

Parameters:

handlerFactory

Factory used to create handlers

XspfReader

(

XspfReader const &

source

)

Copy constructor.

Parameters:

source

Source to copy from

~XspfReader

(

)

Frees all own memory.

---

Member Function Documentation

void enableMaliciousXmlDetection

(

bool

enabled

)

Enables/disables all means of malicious XML detection. This function is provided for convenience.

Experimental:

This feature is marked as experimental.

Parameters:

enabled

Enabled flag

See also:

limitLengthPerEntityValue, setMaxLengthPerEntityValue

limitLookupSumPerEntityValue, setMaxLookupSumPerEntityValue

limitLookupDepthPerEntityValue, setMaxLookupDepthPerEntityValue

Since:

1.0.0

static bool isXmlBase

(

XML_Char const *

attributeKey

)

[static]

Checks if attributeKey is the xml:base attribute

Parameters:

attributeKey

Attribute key to check

Returns:

Equality flag

void limitLengthPerEntityValue

(

bool

enabled

)

Enables/disables the restriction on the length of entity values.

Experimental:

This feature is marked as experimental.

Parameters:

enabled

Enabled flag

See also:

setMaxLengthPerEntityValue

Since:

1.0.0

void limitLookupDepthPerEntityValue

(

bool

enabled

)

Enables/disables the restriction on the lookup depth of entity values.

Experimental:

This feature is marked as experimental.

Parameters:

enabled

Enabled flag

See also:

setMaxLookupDepthPerEntityValue

Since:

1.0.0

void limitLookupSumPerEntityValue

(

bool

enabled

)

Enables/disables the restriction on the sum of lookups per entity value.

Experimental:

This feature is marked as experimental.

Parameters:

enabled

Enabled flag

See also:

setMaxLookupSumPerEntityValue

Since:

1.0.0

XspfReader& operator=

(

XspfReader const &

source

)

Assignment operator.

Parameters:

source

Source to copy from

int parseChunks	(	XspfChunkCallback *	inputCallback,
		XspfReaderCallback *	dataCallback,
		XML_Char const *	baseUri
	)

Reads an XSPF playlist from a chunk callback.

Parameters:

	inputCallback	Chunk callback, must not be NULL
	dataCallback	Reader callback that will receive the playlist's information Passing NULL will make the reader use a XspfStrictReaderCallback instance internally.
	baseUri	Absolute external base URI to resolve URIs against

Returns:

Error/warning code that aborted parsing or XSPF_READER_SUCCESS.

Since:

1.0.0rc1

int parseFile	(	XML_Char const *	filename,
		XspfReaderCallback *	callback,
		XML_Char const *	baseUri
	)

Reads an XSPF playlist from a file.

Parameters:

	filename	Filename of the file to read
	callback	Reader callback that will receive the playlist's information. Passing NULL will make the reader use a XspfStrictReaderCallback instance internally.
	baseUri	Absolute external base URI to resolve URIs against

Returns:

Error/warning code that aborted parsing or XSPF_READER_SUCCESS.

Since:

1.0.0rc1

int parseMemory	(	char const *	memory,
		int	numBytes,
		XspfReaderCallback *	callback,
		XML_Char const *	baseUri
	)

Reads an XSPF playlist from a block of memory.

Parameters:

	memory	Memory block to parse
	numBytes	Size of memory in bytes
	callback	Reader callback that will receive the playlist's information Passing NULL will make the reader use a XspfStrictReaderCallback instance internally.
	baseUri	Absolute external base URI to resolve URIs against

Returns:

Error/warning code that aborted parsing or XSPF_READER_SUCCESS.

Since:

1.0.0rc1

void setMaxLengthPerEntityValue

(

int

maxLength

)

Adjusts the limit on the length of entity values.

Experimental:

This feature is marked as experimental.

Parameters:

maxLength

Inclusive limit to set

See also:

limitLengthPerEntityValue

Since:

1.0.0

void setMaxLookupDepthPerEntityValue

(

int

maxLookupDepth

)

Adjusts the limit on the lookup depth of entity values.

Experimental:

This feature is marked as experimental.

Parameters:

maxLookupDepth

Inclusive limit to set

See also:

limitLookupDepthPerEntityValue

Since:

1.0.0

void setMaxLookupSumPerEntityValue

(

int

maxLookupSum

)

Adjusts the limit on the sum of lookups per entity value.

Experimental:

This feature is marked as experimental.

Parameters:

maxLookupSum

Inclusive limit to set

See also:

limitLookupSumPerEntityValue

Since:

1.0.0

---

The documentation for this class was generated from the following file:

• XspfReader.h