Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

XalanXMLSerializerBase Class Reference

XalanXMLSerializerBase serves as a base class for XML serializers based on FormatterListener events. More...

Inheritance diagram for XalanXMLSerializerBase:

List of all members.

Public Types

typedef XalanVector< bool > BoolStackType
enum { eBufferSize = 512 }
enum {
eNone = 0u, eAttr = 1u, eBoth = 2u, eForb = 4u,
eCRFb = 5u
}

Public Member Functions

XalanXMLSerializerBase (MemoryManager &theManager, eXMLVersion theXMLVersion, const XalanDOMString &theEncoding, const XalanDOMString &theDoctypeSystem, const XalanDOMString &theDoctypePublic, bool xmlDecl, const XalanDOMString &theStandalone)
Constructor.
virtual ~XalanXMLSerializerBase ()
MemoryManagerType & getMemoryManager ()
virtual void setDocumentLocator (const Locator *const locator)
virtual void startDocument ()
virtual void startElement (const XMLCh *const name, AttributeList &attrs)=0
virtual void endElement (const XMLCh *const name)=0
virtual void characters (const XMLCh *const chars, const unsigned int length)
virtual void charactersRaw (const XMLCh *const chars, const unsigned int length)=0
virtual void entityReference (const XMLCh *const name)=0
Receive notification of a entityReference.
virtual void ignorableWhitespace (const XMLCh *const chars, const unsigned int length)
virtual void processingInstruction (const XMLCh *const target, const XMLCh *const data)
virtual void resetDocument ()
virtual void comment (const XMLCh *const data)=0
Called when a Comment is to be constructed.
virtual void cdata (const XMLCh *const ch, const unsigned int length)
virtual const XalanDOMString & getDoctypeSystem () const
virtual const XalanDOMString & getDoctypePublic () const
virtual const XalanDOMString & getEncoding () const =0
const XalanDOMString & getVersion () const
const XalanDOMString & getStandalone () const
bool getShouldWriteXMLHeader () const
void setShouldWriteXMLHeader (bool b)

Static Public Member Functions

static void initialize (MemoryManager &theManager)
Perform static initialization.
static void terminate ()
Perform static shut down.

Static Public Attributes

static const XalanDOMString & s_1_0String
static const XalanDOMString & s_1_1String

Protected Member Functions

virtual void writeXMLHeader ()=0
virtual void flushBuffer ()=0
virtual void writeDoctypeDecl (const XalanDOMChar *name)=0
virtual void writeProcessingInstruction (const XMLCh *target, const XMLCh *data)=0
virtual void writeCharacters (const XMLCh *chars, unsigned int length)=0
virtual void writeCDATA (const XMLCh *chars, unsigned int length)=0
virtual void outputNewline ()=0
bool markParentForChildren ()
Mark the parent element as having a child.
bool getNeedToOutputDoctypeDecl () const
Determine if it a DOCTYPE declaration needs to be written.
void openElementForChildren ()
Open an element for possibile children.
bool outsideDocumentElement () const
bool childNodesWereAdded ()
Determine if an element ever had any children added.
void generateDoctypeDecl (const XalanDOMChar *name)

Static Protected Member Functions

static bool isUTF16HighSurrogate (XalanDOMChar theChar)
static bool isUTF16LowSurrogate (XalanDOMChar theChar)
static unsigned int decodeUTF16SurrogatePair (XalanDOMChar theHighSurrogate, XalanDOMChar theLowSurrogate, MemoryManager &theManager)
static void throwInvalidUTF16SurrogateException (XalanDOMChar ch, MemoryManager &theManager)
Throw an exception when an invalid surrogate is encountered.
static void throwInvalidUTF16SurrogateException (XalanDOMChar ch, XalanDOMChar next, MemoryManager &theManager)
Throw an exception when an invalid surrogate is encountered.
static void throwInvalidCharacterException (unsigned int ch, MemoryManager &theManager)
Throw an exception when an invalid character is encountered.
static void throwInvalidXMLCharacterException (unsigned int ch, const XalanDOMString &theXMLversion, MemoryManager &theManager)
Throw an exception when an invalid character for the specific XML version is encountered.

Protected Attributes

bool m_nextIsRaw
Tell if the next text should be raw.
bool m_spaceBeforeClose
Add space before '/>' for XHTML.
const XalanDOMString m_doctypeSystem
The System ID for the doc type.
const XalanDOMString m_doctypePublic
The public ID for the doc type.
const XalanDOMString & m_version
Tells the XML version, for writing out to the XML decl.
const XalanDOMString m_standalone
Text for standalone part of header.
const XalanDOMString m_encoding

Classes

class CharFunctor1_0
class CharFunctor1_1
class UTF16
class UTF8

Detailed Description

XalanXMLSerializerBase serves as a base class for XML serializers based on FormatterListener events.

Member Typedef Documentation

typedef XalanVector<bool> XalanXMLSerializerBase::BoolStackType

Member Enumeration Documentation

anonymous enum

Enumeration values:

eBufferSize

anonymous enum

Enumeration values:

eNone

eAttr

eBoth

eForb

eCRFb

Constructor & Destructor Documentation

XalanXMLSerializerBase::XalanXMLSerializerBase ( MemoryManager & theManager,

eXMLVersion theXMLVersion,

const XalanDOMString & theEncoding,

const XalanDOMString & theDoctypeSystem,

const XalanDOMString & theDoctypePublic,

bool xmlDecl,

const XalanDOMString & theStandalone

)

Constructor.

Parameters:

theManager The MemoryManager instance to use for any memory allocations

doctypeSystem system identifier to be used in the document type declaration

doctypePublic public identifier to be used in the document type declaration

xmlDecl true if the XSLT processor should output an XML declaration

theStandalone The string the XSLT processor should output for the standalone document declaration

virtual XalanXMLSerializerBase::~XalanXMLSerializerBase ( ) [virtual]

Member Function Documentation

virtual void XalanXMLSerializerBase::cdata ( const XMLCh *const ch,

const unsigned int length

) [virtual]

virtual void XalanXMLSerializerBase::characters ( const XMLCh *const chars,

const unsigned int length

) [virtual]

virtual void XalanXMLSerializerBase::charactersRaw ( const XMLCh *const chars,

const unsigned int length

) [pure virtual]

Implemented in FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >.

bool XalanXMLSerializerBase::childNodesWereAdded ( ) [protected]

Determine if an element ever had any children added.

Returns:
true if the children were added, false if not.

virtual void XalanXMLSerializerBase::comment ( const XMLCh *const data ) [pure virtual]

Called when a Comment is to be constructed.

Parameters:

data pointer to comment data

Exceptions:

SAXException

Implements FormatterListener.
Implemented in FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >.

static unsigned int XalanXMLSerializerBase::decodeUTF16SurrogatePair ( XalanDOMChar theHighSurrogate,

XalanDOMChar theLowSurrogate,

MemoryManager & theManager

) [static, protected]

virtual void XalanXMLSerializerBase::endElement ( const XMLCh *const name ) [pure virtual]

Implements FormatterListener.
Implemented in FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >.

virtual void XalanXMLSerializerBase::entityReference ( const XMLCh *const name ) [pure virtual]

Receive notification of a entityReference.

Parameters:

data pointer to characters from the XML document

Exceptions:

SAXException

Implements FormatterListener.
Implemented in FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >.

virtual void XalanXMLSerializerBase::flushBuffer ( ) [protected, pure virtual]

Implemented in FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >.

void XalanXMLSerializerBase::generateDoctypeDecl ( const XalanDOMChar * name ) [protected]

virtual const XalanDOMString& XalanXMLSerializerBase::getDoctypePublic ( ) const [virtual]

Reimplemented from FormatterListener.

virtual const XalanDOMString& XalanXMLSerializerBase::getDoctypeSystem ( ) const [virtual]

Reimplemented from FormatterListener.

virtual const XalanDOMString& XalanXMLSerializerBase::getEncoding ( ) const [pure virtual]

Reimplemented from FormatterListener.
Implemented in FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >.

MemoryManagerType& XalanXMLSerializerBase::getMemoryManager ( )

bool XalanXMLSerializerBase::getNeedToOutputDoctypeDecl ( ) const [protected]

Determine if it a DOCTYPE declaration needs to be written.

bool XalanXMLSerializerBase::getShouldWriteXMLHeader ( ) const

const XalanDOMString& XalanXMLSerializerBase::getStandalone ( ) const

const XalanDOMString& XalanXMLSerializerBase::getVersion ( ) const

virtual void XalanXMLSerializerBase::ignorableWhitespace ( const XMLCh *const chars,

const unsigned int length

) [virtual]

static void XalanXMLSerializerBase::initialize ( MemoryManager & theManager ) [static]

Perform static initialization.
See class XMLSupportInit.

static bool XalanXMLSerializerBase::isUTF16HighSurrogate ( XalanDOMChar theChar ) [static, protected]

static bool XalanXMLSerializerBase::isUTF16LowSurrogate ( XalanDOMChar theChar ) [static, protected]

bool XalanXMLSerializerBase::markParentForChildren ( ) [protected]

Mark the parent element as having a child.
If this is the first child, return true, otherwise, return false. This allows the child element to determine if the parent tag has already been closed.

Returns:
true if the parent element has not been previously marked for children.

void XalanXMLSerializerBase::openElementForChildren ( ) [protected]

Open an element for possibile children.

virtual void XalanXMLSerializerBase::outputNewline ( ) [protected, pure virtual]

Implemented in FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >.

bool XalanXMLSerializerBase::outsideDocumentElement ( ) const [protected]

virtual void XalanXMLSerializerBase::processingInstruction ( const XMLCh *const target,

const XMLCh *const data

) [virtual]

Implements FormatterListener.

virtual void XalanXMLSerializerBase::resetDocument ( ) [virtual]

Implements FormatterListener.

virtual void XalanXMLSerializerBase::setDocumentLocator ( const Locator *const locator ) [virtual]

Implements FormatterListener.

void XalanXMLSerializerBase::setShouldWriteXMLHeader ( bool b )

virtual void XalanXMLSerializerBase::startDocument ( ) [virtual]

Implements FormatterListener.

virtual void XalanXMLSerializerBase::startElement ( const XMLCh *const name,

AttributeList & attrs

) [pure virtual]

Implements FormatterListener.
Implemented in FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >.

static void XalanXMLSerializerBase::terminate ( ) [static]

Perform static shut down.
See class XMLSupportInit.

static void XalanXMLSerializerBase::throwInvalidCharacterException ( unsigned int ch,

MemoryManager & theManager

) [static, protected]

Throw an exception when an invalid character is encountered.

Parameters:

ch The first character in the surrogate

next The next character in the surrogate

static void XalanXMLSerializerBase::throwInvalidUTF16SurrogateException ( XalanDOMChar ch,

XalanDOMChar next,

MemoryManager & theManager

) [static, protected]

Throw an exception when an invalid surrogate is encountered.

Parameters:

ch The first character in the surrogate

next The next character in the surrogate

static void XalanXMLSerializerBase::throwInvalidUTF16SurrogateException ( XalanDOMChar ch,

MemoryManager & theManager

) [static, protected]

Throw an exception when an invalid surrogate is encountered.

Parameters:

ch The first character in the surrogate

static void XalanXMLSerializerBase::throwInvalidXMLCharacterException ( unsigned int ch,

const XalanDOMString & theXMLversion,

MemoryManager & theManager

) [static, protected]

Throw an exception when an invalid character for the specific XML version is encountered.

Parameters:

ch The first character in the surrogate

next The next character in the surrogate

virtual void XalanXMLSerializerBase::writeCDATA ( const XMLCh * chars,

unsigned int length

) [protected, pure virtual]

Implemented in FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >.

virtual void XalanXMLSerializerBase::writeCharacters ( const XMLCh * chars,

unsigned int length

) [protected, pure virtual]

Implemented in FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >.

virtual void XalanXMLSerializerBase::writeDoctypeDecl ( const XalanDOMChar * name ) [protected, pure virtual]

Implemented in FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >.

virtual void XalanXMLSerializerBase::writeProcessingInstruction ( const XMLCh * target,

const XMLCh * data

) [protected, pure virtual]

Implemented in FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >.

virtual void XalanXMLSerializerBase::writeXMLHeader ( ) [protected, pure virtual]

Implemented in FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >.

Member Data Documentation

const XalanDOMString XalanXMLSerializerBase::m_doctypePublic [protected]

The public ID for the doc type.

const XalanDOMString XalanXMLSerializerBase::m_doctypeSystem [protected]

The System ID for the doc type.

const XalanDOMString XalanXMLSerializerBase::m_encoding [protected]

bool XalanXMLSerializerBase::m_nextIsRaw [protected]

Tell if the next text should be raw.

bool XalanXMLSerializerBase::m_spaceBeforeClose [protected]

Add space before '/>' for XHTML.

const XalanDOMString XalanXMLSerializerBase::m_standalone [protected]

Text for standalone part of header.

const XalanDOMString& XalanXMLSerializerBase::m_version [protected]

Tells the XML version, for writing out to the XML decl.

const XalanDOMString& XalanXMLSerializerBase::s_1_0String [static]

const XalanDOMString& XalanXMLSerializerBase::s_1_1String [static]

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

XalanXMLSerializerBase.hpp

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Apache Logo