PTLib  Version 2.14.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
PXML Class Reference

#include <pxml.h>

Inheritance diagram for PXML:
Inheritance graph
[legend]
Collaboration diagram for PXML:
Collaboration graph
[legend]

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  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 (Options options=NoOptions, const char *noIndentElements=NULL)
 
 PXML (const PXML &xml)
 
 ~PXML ()
 
void ReadFrom (istream &strm)
 Input the contents of the object from the stream. More...
 
void PrintOn (ostream &strm) const
 Output the contents of the object to the stream. More...
 
PString AsString () const
 
bool IsDirty () const
 
bool Load (const PString &data)
 
bool Load (const PString &data, Options options)
 
bool LoadFile (const PFilePath &fn)
 
bool LoadFile (const PFilePath &fn, Options options)
 
virtual bool OnLoadProgress (unsigned) const
 
virtual void OnLoaded ()
 
bool Save ()
 
bool Save (Options options)
 
PString AsString ()
 
PString AsString (Options options)
 
bool SaveFile (const PFilePath &fn)
 
bool SaveFile (const PFilePath &fn, Options options)
 
virtual bool OnSaveProgress (unsigned) const
 
virtual bool OutputProgress () const
 
virtual PINDEX GetObjectCount () const
 
void RemoveAll ()
 
virtual PBoolean IsNoIndentElement (const PString &elementName) const
 
virtual PXMLElement * CreateElement (const PCaselessString &name, const char *data=NULL)
 
virtual PXMLRootElement * CreateRootElement (const PCaselessString &name)
 
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 * SetRootElement (PXMLRootElement *root)
 
PXMLElement * SetRootElement (const PString &documentType)
 
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, Options options=NoOptions)
 
const PCaselessString & GetVersion () const
 
const PCaselessString & GetEncoding () const
 
StandAloneType GetStandAlone () const
 
bool IsLoaded () const
 
PXMLRootElement * GetRootElement () const
 
PCaselessString GetDocumentType () const
 
const PCaselessString & GetDocType () const
 
const PCaselessString & GetPubicIdentifier () const
 
const PCaselessString & GetDtdURI () const
 
PString GetErrorString () const
 
unsigned GetErrorColumn () const
 
unsigned GetErrorLine () const
 
- Public Member Functions inherited from PXMLBase
 P_DECLARE_BITWISE_ENUM_EX (Options, 7,(NoOptions, Indent, IndentWithTabs, NewLineAfterElement, NoIgnoreWhiteSpace, CloseExtended, WithNS, FragmentOnly), AllOptions=(1<<(6+1))-1)
 
 PXMLBase (Options opts=NoOptions)
 
void SetOptions (Options opts)
 
Options GetOptions () const
 
void SetMaxEntityLength (unsigned len)
 
unsigned GetMaxEntityLength () const
 
bool OutputIndent (ostream &strm, int indent, const PString &elementName=PString::Empty()) const
 
- Public Member Functions inherited from PObject
unsigned GetTraceContextIdentifier () const
 Get PTRACE context identifier. More...
 
void SetTraceContextIdentifier (unsigned id)
 
void GetTraceContextIdentifier (PObject &obj)
 
void GetTraceContextIdentifier (PObject *obj)
 
void SetTraceContextIdentifier (const PObject &obj)
 
void SetTraceContextIdentifier (const PObject *obj)
 
virtual ~PObject ()
 
virtual PObject * Clone () const
 Create a copy of the class on the heap. More...
 
template<class CLS >
CLS * CloneAs () const
 As for Clone() but converts to specified type. 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...
 
__inline const PObject * PTraceObjectInstance () const
 
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 EscapeSpecialChars (const PString &string)
 

Protected Attributes

PFilePath m_loadFilename
 
PCaselessString m_version
 
PCaselessString m_encoding
 
StandAloneType m_standAlone
 
PCaselessString m_docType
 
PCaselessString m_publicId
 
PCaselessString m_dtdURI
 
PXMLRootElement * m_rootElement
 
PStringStream m_errorString
 
unsigned m_errorLine
 
unsigned m_errorColumn
 
PSortedStringList m_noIndentElements
 
PCaselessString m_defaultNameSpace
 
PINDEX m_totalObjects
 
PINDEX m_savedObjects
 
unsigned m_percent
 
- Protected Attributes inherited from PXMLBase
Options m_options
 
unsigned m_maxEntityLength
 
- Protected Attributes inherited from PObject
unsigned m_traceContextIdentifier
 

Additional Inherited Members

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

Member Enumeration Documentation

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::PXML ( Options  options = NoOptions,
const char *  noIndentElements = NULL 
)
PXML::PXML ( const PXML &  xml)
PXML::~PXML ( )

Member Function Documentation

PString PXML::AsString ( ) const
PString PXML::AsString ( )
PString PXML::AsString ( Options  options)
virtual PXMLElement* PXML::CreateElement ( const PCaselessString &  name,
const char *  data = NULL 
)
virtual
virtual PXMLRootElement* PXML::CreateRootElement ( const PCaselessString &  name)
virtual
static PString PXML::EscapeSpecialChars ( const PString &  string)
static
const PCaselessString& PXML::GetDocType ( ) const
inline

References m_docType.

PCaselessString PXML::GetDocumentType ( ) const
const PCaselessString& PXML::GetDtdURI ( ) const
inline

References m_dtdURI.

PXMLElement* PXML::GetElement ( const PCaselessString &  name,
const PCaselessString &  attr,
const PString &  attrval 
) const
PXMLElement* PXML::GetElement ( const PCaselessString &  name,
PINDEX  idx = 0 
) const
PXMLElement* PXML::GetElement ( PINDEX  idx) const
const PCaselessString& PXML::GetEncoding ( ) const
inline

References m_encoding.

unsigned PXML::GetErrorColumn ( ) const
inline

References m_errorColumn.

unsigned PXML::GetErrorLine ( ) const
inline

References m_errorLine.

PString PXML::GetErrorString ( ) const
inline

References m_errorString.

PINDEX PXML::GetNumElements ( ) const
virtual PINDEX PXML::GetObjectCount ( ) const
virtual
const PCaselessString& PXML::GetPubicIdentifier ( ) const
inline

References m_publicId.

PXMLRootElement* PXML::GetRootElement ( ) const
inline

References m_rootElement.

StandAloneType PXML::GetStandAlone ( ) const
inline

References m_standAlone.

const PCaselessString& PXML::GetVersion ( ) const
inline

References m_version.

bool PXML::IsDirty ( ) const
bool PXML::IsLoaded ( ) const
inline

References m_rootElement.

Referenced by PVXMLSession::IsLoaded().

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

Reimplemented from PXMLBase.

bool PXML::Load ( const PString &  data)
bool PXML::Load ( const PString &  data,
Options  options 
)
bool PXML::LoadAndValidate ( const PString &  body,
const PXML::ValidationInfo *  validator,
PString &  error,
Options  options = NoOptions 
)
bool PXML::LoadFile ( const PFilePath &  fn)
bool PXML::LoadFile ( const PFilePath &  fn,
Options  options 
)
virtual void PXML::OnLoaded ( )
inlinevirtual
virtual bool PXML::OnLoadProgress ( unsigned  ) const
inlinevirtual
virtual bool PXML::OnSaveProgress ( unsigned  ) const
inlinevirtual
virtual bool PXML::OutputProgress ( ) const
virtual

Reimplemented from PXMLBase.

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.

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.

void PXML::RemoveAll ( )
bool PXML::Save ( )
bool PXML::Save ( Options  options)
bool PXML::SaveFile ( const PFilePath &  fn)
bool PXML::SaveFile ( const PFilePath &  fn,
Options  options 
)
PXMLElement* PXML::SetRootElement ( PXMLRootElement *  root)
PXMLElement* PXML::SetRootElement ( const PString &  documentType)
bool PXML::Validate ( const ValidationInfo *  validator)
bool PXML::ValidateElement ( ValidationContext &  context,
PXMLElement *  element,
const ValidationInfo *  elements 
)
bool PXML::ValidateElements ( ValidationContext &  context,
PXMLElement *  baseElement,
const ValidationInfo *  elements 
)

Member Data Documentation

PCaselessString PXML::m_defaultNameSpace
protected
PCaselessString PXML::m_docType
protected

Referenced by GetDocType().

PCaselessString PXML::m_dtdURI
protected

Referenced by GetDtdURI().

PCaselessString PXML::m_encoding
protected

Referenced by GetEncoding().

unsigned PXML::m_errorColumn
protected

Referenced by GetErrorColumn().

unsigned PXML::m_errorLine
protected

Referenced by GetErrorLine().

PStringStream PXML::m_errorString
protected

Referenced by GetErrorString().

PFilePath PXML::m_loadFilename
protected
PSortedStringList PXML::m_noIndentElements
protected
unsigned PXML::m_percent
mutableprotected
PCaselessString PXML::m_publicId
protected

Referenced by GetPubicIdentifier().

PXMLRootElement* PXML::m_rootElement
protected

Referenced by GetRootElement(), and IsLoaded().

PINDEX PXML::m_savedObjects
mutableprotected
StandAloneType PXML::m_standAlone
protected

Referenced by GetStandAlone().

PINDEX PXML::m_totalObjects
protected
PCaselessString PXML::m_version
protected

Referenced by GetVersion().

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