libxspf  1.2.0
Public Member Functions | Protected Member Functions | Friends | List of all members
XspfExtensionReader Class Referenceabstract

#include <XspfExtensionReader.h>

Inheritance diagram for XspfExtensionReader:
Inheritance graph
[legend]

Public Member Functions

 XspfExtensionReader (XspfReader *reader)
 
 XspfExtensionReader (XspfExtensionReader const &source)
 
XspfExtensionReaderoperator= (XspfExtensionReader const &source)
 
virtual ~XspfExtensionReader ()
 

Protected Member Functions

bool handleError (int code, XML_Char const *text)
 
bool handleError (int code, XML_Char const *format, XML_Char const *param)
 
XspfStack< unsigned int > & getElementStack () const
 
XspfStack< std::basic_string< XML_Char > > & getBaseUriStack () const
 
bool handleXmlBaseAttribute (XML_Char const *xmlBase)
 
virtual bool handleExtensionStart (XML_Char const *fullName, XML_Char const **atts)=0
 
virtual bool handleExtensionEnd (XML_Char const *fullName)=0
 
virtual bool handleExtensionCharacters (XML_Char const *s, int len)=0
 
virtual XspfExtensionwrap ()=0
 
virtual XspfExtensionReadercreateBrother (XspfReader *reader) const =0
 

Friends

class XspfReader
 
class XspfReaderPrivate
 
class XspfExtensionReaderFactory
 
class XspfExtensionReaderFactoryPrivate
 

Detailed Description

Provides the base for specific extention readers to derive from.

Definition at line 66 of file XspfExtensionReader.h.

Constructor & Destructor Documentation

◆ XspfExtensionReader() [1/2]

Creates a new XspfExtensionReader object.

Parameters
readerXspfReader to interact with

◆ XspfExtensionReader() [2/2]

Copy constructor.

Parameters
sourceSource to copy from

◆ ~XspfExtensionReader()

virtual ~XspfExtensionReader ( )
virtual

Destroys this XspfExtensionReader object and deletes all memory associated with it.

Member Function Documentation

◆ createBrother()

virtual XspfExtensionReader* createBrother ( XspfReader reader) const
protectedpure virtual

Creates new XspfExtensionReader of the very same type as this reader.

Parameters
readerXspfReader to interact with, must not be NULL
Returns
A new extension reader of the same type.

◆ getBaseUriStack()

XspfStack<std::basic_string<XML_Char> >& getBaseUriStack ( ) const
protected

Gives access to the Base URI stack in use.

Returns
Base URI stack reference

◆ getElementStack()

XspfStack<unsigned int>& getElementStack ( ) const
protected

Gives access to the element stack in use.

Returns
Element stack reference

◆ handleError() [1/2]

bool handleError ( int  code,
XML_Char const *  text 
)
protected

Passes error handling to the parent XspfReader.

Parameters
codeError code
textError description

◆ handleError() [2/2]

bool handleError ( int  code,
XML_Char const *  format,
XML_Char const *  param 
)
protected

Passes error handling to the parent XspfReader.

Parameters
codeError code
formatError description format string containg s
paramText parameter to insert for s

◆ handleExtensionCharacters()

virtual bool handleExtensionCharacters ( XML_Char const *  s,
int  len 
)
protectedpure virtual

Handles element content.

Parameters
sText content
lenCharacters allowed to read

◆ handleExtensionEnd()

virtual bool handleExtensionEnd ( XML_Char const *  fullName)
protectedpure virtual

Handles tag closing inside an extension including the extension tag itself.

Parameters
fullNameFull tag name ("<namespace_uri> <localname>")
Returns
Continue parsing flag

◆ handleExtensionStart()

virtual bool handleExtensionStart ( XML_Char const *  fullName,
XML_Char const **  atts 
)
protectedpure virtual

Handles tag opening inside an extension including the extension tag itself.

Parameters
fullNameFull tag name ("<namespace_uri> <localname>")
attsAlternating list of attribute keys and values
Returns
Continue parsing flag

◆ handleXmlBaseAttribute()

bool handleXmlBaseAttribute ( XML_Char const *  xmlBase)
protected

Passes xml:base handling to the parent XspfReader.

Parameters
xmlBaseValue of xml:base attribute
Returns
Continue parsing flag

◆ operator=()

XspfExtensionReader& operator= ( XspfExtensionReader const &  source)

Assignment operator.

Parameters
sourceSource to copy from

◆ wrap()

virtual XspfExtension* wrap ( )
protectedpure virtual

Makes a XspfExtension of the data collected.

Returns
New built extension

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