#include <pxml.h>

Inheritance diagram for PXML:

Classes
struct	ValidationContext

struct	ValidationInfo

Public Types
enum	ValidationOp { EndOfValidationList, DocType, ElementName, RequiredAttribute, RequiredNonEmptyAttribute, RequiredAttributeWithValue, RequiredElement, Subtree, RequiredAttributeWithValueMatching, RequiredElementWithBodyMatching, OptionalElement, OptionalAttribute, OptionalNonEmptyAttribute, OptionalAttributeWithValue, OptionalAttributeWithValueMatching, OptionalElementWithBodyMatching, SetDefaultNamespace, SetNamespace, RequiredAttributeWithValueMatchingEx = RequiredAttributeWithValueMatching + 0x8000, OptionalAttributeWithValueMatchingEx = OptionalAttributeWithValueMatching + 0x8000, RequiredElementWithBodyMatchingEx = RequiredElementWithBodyMatching + 0x8000, OptionalElementWithBodyMatchingEx = OptionalElementWithBodyMatching + 0x8000 }

Public Types inherited from PXMLBase
enum	{ DEFAULT_MAX_ENTITY_LENGTH = 4096 }

enum	Options { NoOptions = 0x0000, Indent = 0x0001, NewLineAfterElement = 0x0002, NoIgnoreWhiteSpace = 0x0004, CloseExtended = 0x0008, WithNS = 0x0010, FragmentOnly = 0x0020, AllOptions = 0xffff }

enum	StandAloneType { UninitialisedStandAlone = -2, UnknownStandAlone = -1, NotStandAlone, IsStandAlone }

Public Types inherited from PObject
enum	Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
	Result of the comparison operation performed by the `Compare()` function. More...

Public Member Functions
	PXML (int options=NoOptions, const char *noIndentElements=NULL)

	PXML (const PString &data, int options=NoOptions, const char *noIndentElements=NULL)

	PXML (const PXML &xml)

	~PXML ()

bool	IsLoaded () const

bool	IsDirty () const

bool	Load (const PString &data, Options options=NoOptions)

bool	LoadFile (const PFilePath &fn, Options options=NoOptions)

virtual void	OnLoaded ()

bool	Save (Options options=NoOptions)

bool	Save (PString &data, Options options=NoOptions)

bool	SaveFile (const PFilePath &fn, Options options=NoOptions)

void	RemoveAll ()

PBoolean	IsNoIndentElement (const PString &elementName) const

PString	AsString () const

void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...

void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

PXMLElement *	GetElement (const PCaselessString &name, const PCaselessString &attr, const PString &attrval) const

PXMLElement *	GetElement (const PCaselessString &name, PINDEX idx=0) const

PXMLElement *	GetElement (PINDEX idx) const

PINDEX	GetNumElements () const

PXMLElement *	GetRootElement () const

PXMLElement *	SetRootElement (PXMLElement *p)

PXMLElement *	SetRootElement (const PString &documentType)

bool	RemoveElement (PINDEX idx)

PCaselessString	GetDocumentType () const

bool	Validate (const ValidationInfo *validator)

bool	ValidateElements (ValidationContext &context, PXMLElement baseElement, const ValidationInfo elements)

bool	ValidateElement (ValidationContext &context, PXMLElement element, const ValidationInfo elements)

bool	LoadAndValidate (const PString &body, const PXML::ValidationInfo *validator, PString &error, int options=NoOptions)

PString	GetErrorString () const

unsigned	GetErrorColumn () const

unsigned	GetErrorLine () const

PString	GetDocType () const

void	SetDocType (const PString &v)

PMutex &	GetMutex ()

Public Member Functions inherited from PXMLBase
	PXMLBase (int opts=NoOptions)

void	SetOptions (int opts)

int	GetOptions () const

void	SetMaxEntityLength (unsigned len)

unsigned	GetMaxEntityLength () const

Public Member Functions inherited from PObject
virtual	~PObject ()

virtual PObject *	Clone () const
	Create a copy of the class on the heap. More...

virtual PINDEX	HashFunction () const
	This function yields a hash value required by the `PDictionary` class. More...

virtual const char *	GetClass (unsigned ancestor=0) const
	Get the current dynamic type of the object instance. More...

PBoolean	IsClass (const char *cls) const

virtual PBoolean	InternalIsDescendant (const char *clsName) const
	Determine if the dynamic type of the current instance is a descendent of the specified class. More...

virtual Comparison	Compare (const PObject &obj) const
	Compare the two objects and return their relative rank. More...

virtual Comparison	CompareObjectMemoryDirect (const PObject &obj) const
	Determine the byte wise comparison of two objects. More...

bool	operator== (const PObject &obj) const
	Compare the two objects. More...

bool	operator!= (const PObject &obj) const
	Compare the two objects. More...

bool	operator< (const PObject &obj) const
	Compare the two objects. More...

bool	operator> (const PObject &obj) const
	Compare the two objects. More...

bool	operator<= (const PObject &obj) const
	Compare the two objects. More...

bool	operator>= (const PObject &obj) const
	Compare the two objects. More...

Static Public Member Functions
static PString	CreateStartTag (const PString &text)

static PString	CreateEndTag (const PString &text)

static PString	CreateTagNoData (const PString &text)

static PString	CreateTag (const PString &text, const PString &data)

static PString	EscapeSpecialChars (const PString &string)

Static Public Member Functions inherited from PObject
static const char *	Class ()
	Get the name of the class as a C string. More...

static Comparison	InternalCompareObjectMemoryDirect (const PObject obj1, const PObject obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...

Protected Member Functions
void	Construct (int options, const char *noIndentElements)

Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Protected Attributes
PXMLElement *	rootElement

PMutex	rootMutex

bool	loadFromFile

PFilePath	loadFilename

PString	version

PString	encoding

StandAloneType	m_standAlone

PStringStream	m_errorString

unsigned	m_errorLine

unsigned	m_errorColumn

PSortedStringList	noIndentElements

PString	docType

PString	m_defaultNameSpace

Protected Attributes inherited from PXMLBase
int	m_options

unsigned	m_maxEntityLength

Member Enumeration Documentation

§ ValidationOp

enum PXML::ValidationOp

Enumerator
EndOfValidationList
DocType
ElementName
RequiredAttribute
RequiredNonEmptyAttribute
RequiredAttributeWithValue
RequiredElement
Subtree
RequiredAttributeWithValueMatching
RequiredElementWithBodyMatching
OptionalElement
OptionalAttribute
OptionalNonEmptyAttribute
OptionalAttributeWithValue
OptionalAttributeWithValueMatching
OptionalElementWithBodyMatching
SetDefaultNamespace
SetNamespace
RequiredAttributeWithValueMatchingEx
OptionalAttributeWithValueMatchingEx
RequiredElementWithBodyMatchingEx
OptionalElementWithBodyMatchingEx

Constructor & Destructor Documentation

§ PXML() [1/3]

PXML::PXML	(	int	options = `NoOptions`,
		const char *	noIndentElements = `NULL`
	)

§ PXML() [2/3]

PXML::PXML	(	const PString &	data,
		int	options = `NoOptions`,
		const char *	noIndentElements = `NULL`
	)

§ PXML() [3/3]

PXML::PXML ( const PXML & xml )

§ ~PXML()

PXML::~PXML ( )

Member Function Documentation

§ AsString()

PString PXML::AsString ( ) const

Referenced by OnLoaded(), and PXMLObject::SetParent().

§ Construct()

void PXML::Construct	(	int	options,
		const char *	noIndentElements
	)

protected

Referenced by GetMutex().

§ CreateEndTag()

static PString PXML::CreateEndTag ( const PString & text )

static

Referenced by GetMutex().

§ CreateStartTag()

static PString PXML::CreateStartTag ( const PString & text )

static

Referenced by GetMutex().

§ CreateTag()

static PString PXML::CreateTag	(	const PString &	text,
		const PString &	data
	)

static

Referenced by GetMutex().

§ CreateTagNoData()

static PString PXML::CreateTagNoData ( const PString & text )

static

Referenced by GetMutex().

§ EscapeSpecialChars()

static PString PXML::EscapeSpecialChars ( const PString & string )

static

Referenced by GetMutex().

§ GetDocType()

PString PXML::GetDocType ( ) const

inline

References docType.

§ GetDocumentType()

PCaselessString PXML::GetDocumentType ( ) const

Referenced by GetRootElement().

§ GetElement() [1/3]

PXMLElement* PXML::GetElement	(	const PCaselessString &	name,
		const PCaselessString &	attr,
		const PString &	attrval
	)		const

Referenced by PXMLElement::GetNumAttributes(), PXMLElement::GetSubObject(), and OnLoaded().

§ GetElement() [2/3]

PXMLElement* PXML::GetElement	(	const PCaselessString &	name,
		PINDEX	idx = `0`
	)		const

§ GetElement() [3/3]

PXMLElement* PXML::GetElement ( PINDEX idx ) const

§ GetErrorColumn()

unsigned PXML::GetErrorColumn ( ) const

inline

References m_errorColumn.

§ GetErrorLine()

unsigned PXML::GetErrorLine ( ) const

inline

References m_errorLine.

§ GetErrorString()

PString PXML::GetErrorString ( ) const

inline

References m_errorString.

§ GetMutex()

PMutex& PXML::GetMutex ( )

inline

References Construct(), CreateEndTag(), CreateStartTag(), CreateTag(), CreateTagNoData(), EscapeSpecialChars(), noIndentElements, and rootMutex.

§ GetNumElements()

PINDEX PXML::GetNumElements ( ) const

Referenced by OnLoaded().

§ GetRootElement()

PXMLElement* PXML::GetRootElement ( ) const

inline

References GetDocumentType(), RemoveElement(), rootElement, and SetRootElement().

§ IsDirty()

bool PXML::IsDirty ( ) const

Referenced by IsLoaded().

§ IsLoaded()

bool PXML::IsLoaded ( ) const

inline

References IsDirty(), Load(), LoadFile(), PXMLBase::NoOptions, and rootElement.

§ IsNoIndentElement()

PBoolean PXML::IsNoIndentElement ( const PString & elementName ) const

virtual

Reimplemented from PXMLBase.

Referenced by OnLoaded().

§ Load()

bool PXML::Load	(	const PString &	data,
		Options	options = `NoOptions`
	)

Referenced by IsLoaded().

§ LoadAndValidate()

bool PXML::LoadAndValidate	(	const PString &	body,
		const PXML::ValidationInfo *	validator,
		PString &	error,
		int	options = `NoOptions`
	)

§ LoadFile()

bool PXML::LoadFile	(	const PFilePath &	fn,
		Options	options = `NoOptions`
	)

Referenced by IsLoaded().

§ OnLoaded()

virtual void PXML::OnLoaded ( )

inlinevirtual

References AsString(), GetElement(), GetNumElements(), IsNoIndentElement(), PXMLBase::NoOptions, PrintOn(), ReadFrom(), RemoveAll(), Save(), and SaveFile().

§ PrintOn()

void PXML::PrintOn ( ostream & strm ) const

virtual

Output the contents of the object to the stream.

The exact output is dependent on the exact semantics of the descendent class. This is primarily used by the standard operator<< function.

The default behaviour is to print the class name.

Reimplemented from PObject.

Referenced by PXMLElement::IsElement(), and OnLoaded().

§ ReadFrom()

void PXML::ReadFrom ( istream & strm )

virtual

Input the contents of the object from the stream.

The exact input is dependent on the exact semantics of the descendent class. This is primarily used by the standard operator>> function.

The default behaviour is to do nothing.

Reimplemented from PObject.

Referenced by OnLoaded().

§ RemoveAll()

void PXML::RemoveAll ( )

Referenced by OnLoaded().

§ RemoveElement()

bool PXML::RemoveElement ( PINDEX idx )

Referenced by PXMLElement::GetNumAttributes(), and GetRootElement().

§ Save() [1/2]

bool PXML::Save ( Options options = NoOptions )

Referenced by OnLoaded().

§ Save() [2/2]

bool PXML::Save	(	PString &	data,
		Options	options = `NoOptions`
	)

§ SaveFile()

bool PXML::SaveFile	(	const PFilePath &	fn,
		Options	options = `NoOptions`
	)

Referenced by OnLoaded().

§ SetDocType()

void PXML::SetDocType ( const PString & v )

inline

References docType.

§ SetRootElement() [1/2]

PXMLElement* PXML::SetRootElement ( PXMLElement * p )

Referenced by GetRootElement().

§ SetRootElement() [2/2]

PXMLElement* PXML::SetRootElement ( const PString & documentType )

§ Validate()

bool PXML::Validate ( const ValidationInfo * validator )

§ ValidateElement()

bool PXML::ValidateElement	(	ValidationContext &	context,
		PXMLElement *	element,
		const ValidationInfo *	elements
	)

§ ValidateElements()

bool PXML::ValidateElements	(	ValidationContext &	context,
		PXMLElement *	baseElement,
		const ValidationInfo *	elements
	)

Member Data Documentation

§ docType

PString PXML::docType

protected

Referenced by GetDocType(), and SetDocType().

§ encoding

PString PXML::encoding

protected

Referenced by PXMLParser::GetEncoding().

§ loadFilename

PFilePath PXML::loadFilename

protected

§ loadFromFile

bool PXML::loadFromFile

protected

§ m_defaultNameSpace

PString PXML::m_defaultNameSpace

protected

§ m_errorColumn

unsigned PXML::m_errorColumn

protected

Referenced by GetErrorColumn().

§ m_errorLine

unsigned PXML::m_errorLine

protected

Referenced by GetErrorLine().

§ m_errorString

PStringStream PXML::m_errorString

protected

Referenced by GetErrorString().

§ m_standAlone

StandAloneType PXML::m_standAlone

protected

Referenced by PXMLParser::GetStandAlone().

§ noIndentElements

PSortedStringList PXML::noIndentElements

protected

Referenced by GetMutex().

§ rootElement

PXMLElement* PXML::rootElement

protected

Referenced by GetRootElement(), and IsLoaded().

§ rootMutex

PMutex PXML::rootMutex

protected

Referenced by GetMutex().

§ version

PString PXML::version

protected

Referenced by PXMLParser::GetVersion().

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

pxml.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Enumeration Documentation

§ ValidationOp

Constructor & Destructor Documentation

§ PXML() [1/3]

§ PXML() [2/3]

§ PXML() [3/3]

§ ~PXML()

Member Function Documentation

§ AsString()

§ Construct()

§ CreateEndTag()

§ CreateStartTag()

§ CreateTag()

§ CreateTagNoData()

§ EscapeSpecialChars()

§ GetDocType()

§ GetDocumentType()

§ GetElement() [1/3]

§ GetElement() [2/3]

§ GetElement() [3/3]

§ GetErrorColumn()

§ GetErrorLine()

§ GetErrorString()

§ GetMutex()

§ GetNumElements()

§ GetRootElement()

§ IsDirty()

§ IsLoaded()

§ IsNoIndentElement()

§ Load()

§ LoadAndValidate()

§ LoadFile()

§ OnLoaded()

§ PrintOn()

§ ReadFrom()

§ RemoveAll()

§ RemoveElement()

§ Save() [1/2]

§ Save() [2/2]

§ SaveFile()

§ SetDocType()

§ SetRootElement() [1/2]

§ SetRootElement() [2/2]

§ Validate()

§ ValidateElement()

§ ValidateElements()

Member Data Documentation

§ docType

§ encoding

§ loadFilename

§ loadFromFile

§ m_defaultNameSpace

§ m_errorColumn

§ m_errorLine

§ m_errorString

§ m_standAlone

§ noIndentElements

§ rootElement

§ rootMutex

§ version