Xerces-C++  3.1.3
List of all members
XMLFormatter Class Reference

This class provides the basic formatting capabilities that are required to turn the Unicode based XML data from the parsers into a form that can be used on non-Unicode based systems, that is, into local or generic text encodings. More...

Inheritance diagram for XMLFormatter:
XMemory

Public Types

Public Constants
enum  EscapeFlags {
  NoEscapes, StdEscapes, AttrEscapes, CharEscapes,
  EscapeFlags_Count, DefaultEscape = 999
}
 EscapeFlags - Different styles of escape flags to control various formatting. More...
 
enum  UnRepFlags { UnRep_Fail, UnRep_CharRef, UnRep_Replace, DefaultUnRep = 999 }
 UnRepFlags. More...
 

Public Member Functions

Constructor and Destructor
 XMLFormatter (const XMLCh *const outEncoding, const XMLCh *const docVersion, XMLFormatTarget *const target, const EscapeFlags escapeFlags=NoEscapes, const UnRepFlags unrepFlags=UnRep_Fail, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)
 
 XMLFormatter (const char *const outEncoding, const char *const docVersion, XMLFormatTarget *const target, const EscapeFlags escapeFlags=NoEscapes, const UnRepFlags unrepFlags=UnRep_Fail, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)
 
 XMLFormatter (const XMLCh *const outEncoding, XMLFormatTarget *const target, const EscapeFlags escapeFlags=NoEscapes, const UnRepFlags unrepFlags=UnRep_Fail, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)
 
 XMLFormatter (const char *const outEncoding, XMLFormatTarget *const target, const EscapeFlags escapeFlags=NoEscapes, const UnRepFlags unrepFlags=UnRep_Fail, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)
 
 ~XMLFormatter ()
 
Formatting methods
void formatBuf (const XMLCh *const toFormat, const XMLSize_t count, const EscapeFlags escapeFlags=DefaultEscape, const UnRepFlags unrepFlags=DefaultUnRep)
 
XMLFormatteroperator<< (const XMLCh *const toFormat)
 
XMLFormatteroperator<< (const XMLCh toFormat)
 
void writeBOM (const XMLByte *const toFormat, const XMLSize_t count)
 
Getter methods
const XMLChgetEncodingName () const
 
const XMLTranscodergetTranscoder () const
 
XMLTranscodergetTranscoder ()
 
Setter methods
void setEscapeFlags (const EscapeFlags newFlags)
 
void setUnRepFlags (const UnRepFlags newFlags)
 
XMLFormatteroperator<< (const EscapeFlags newFlags)
 
XMLFormatteroperator<< (const UnRepFlags newFlags)
 
EscapeFlags getEscapeFlags () const
 
UnRepFlags getUnRepFlags () const
 
- Public Member Functions inherited from XMemory
void * operator new (size_t size)
 This method overrides operator new. More...
 
void * operator new (size_t size, MemoryManager *memMgr)
 This method defines a custom operator new, that will use the provided memory manager to perform the allocation. More...
 
void * operator new (size_t size, void *ptr)
 This method overrides placement operator new. More...
 
void operator delete (void *p)
 This method overrides operator delete. More...
 
void operator delete (void *p, MemoryManager *memMgr)
 This method provides a matching delete for the custom operator new. More...
 
void operator delete (void *p, void *ptr)
 This method provides a matching delete for the placement new. More...
 

Additional Inherited Members

- Protected Member Functions inherited from XMemory
 XMemory ()
 Protected default constructor. More...
 

Detailed Description

This class provides the basic formatting capabilities that are required to turn the Unicode based XML data from the parsers into a form that can be used on non-Unicode based systems, that is, into local or generic text encodings.

A number of flags are provided to control whether various optional formatting operations are performed.

Member Enumeration Documentation

EscapeFlags - Different styles of escape flags to control various formatting.

NoEscapes: No character needs to be escaped. Just write them out as is.

StdEscapes: The following characters need to be escaped:

character should be escaped and written as
& &amp;
> &gt;
" &quot;
< &lt;
' &apos;

AttrEscapes: The following characters need to be escaped:

character should be escaped and written as
& &amp;
> &gt;
" &quot;

CharEscapes: The following characters need to be escaped:

character should be escaped and written as
& &amp;
> &gt;

EscapeFlags_Count: Special value, do not use directly.

DefaultEscape: Special value, do not use directly.

Enumerator
NoEscapes 
StdEscapes 
AttrEscapes 
CharEscapes 
EscapeFlags_Count 
DefaultEscape 

UnRepFlags.

The unrepresentable flags that indicate how to react when a character cannot be represented in the target encoding.

UnRep_Fail: Fail the operation.

UnRep_CharRef: Display the unrepresented character as reference.

UnRep_Replace: Replace the unrepresented character with the replacement character.

DefaultUnRep: Special value, do not use directly.

Enumerator
UnRep_Fail 
UnRep_CharRef 
UnRep_Replace 
DefaultUnRep 

Constructor & Destructor Documentation

XMLFormatter::XMLFormatter ( const XMLCh *const  outEncoding,
const XMLCh *const  docVersion,
XMLFormatTarget *const  target,
const EscapeFlags  escapeFlags = NoEscapes,
const UnRepFlags  unrepFlags = UnRep_Fail,
MemoryManager *const  manager = XMLPlatformUtils::fgMemoryManager 
)
Parameters
outEncodingthe encoding for the formatted content.
docVersionthe document version.
targetthe formatTarget where the formatted content is written to.
escapeFlagsthe escape style for certain character.
unrepFlagsthe reaction to unrepresentable character.
managerPointer to the memory manager to be used to allocate objects.
XMLFormatter::XMLFormatter ( const char *const  outEncoding,
const char *const  docVersion,
XMLFormatTarget *const  target,
const EscapeFlags  escapeFlags = NoEscapes,
const UnRepFlags  unrepFlags = UnRep_Fail,
MemoryManager *const  manager = XMLPlatformUtils::fgMemoryManager 
)
XMLFormatter::XMLFormatter ( const XMLCh *const  outEncoding,
XMLFormatTarget *const  target,
const EscapeFlags  escapeFlags = NoEscapes,
const UnRepFlags  unrepFlags = UnRep_Fail,
MemoryManager *const  manager = XMLPlatformUtils::fgMemoryManager 
)
XMLFormatter::XMLFormatter ( const char *const  outEncoding,
XMLFormatTarget *const  target,
const EscapeFlags  escapeFlags = NoEscapes,
const UnRepFlags  unrepFlags = UnRep_Fail,
MemoryManager *const  manager = XMLPlatformUtils::fgMemoryManager 
)
XMLFormatter::~XMLFormatter ( )

Member Function Documentation

void XMLFormatter::formatBuf ( const XMLCh *const  toFormat,
const XMLSize_t  count,
const EscapeFlags  escapeFlags = DefaultEscape,
const UnRepFlags  unrepFlags = DefaultUnRep 
)
Parameters
toFormatthe string to be formatted
countlength of the string
escapeFlagsthe escape style for formatting toFormat
unrepFlagsthe reaction for any unrepresentable character in toFormat
const XMLCh * XMLFormatter::getEncodingName ( ) const
Returns
return the encoding set for the formatted content
XMLFormatter::EscapeFlags XMLFormatter::getEscapeFlags ( ) const
Returns
return the escape style for the formatted content
const XMLTranscoder * XMLFormatter::getTranscoder ( ) const
Returns
return constant transcoder used internally for transcoding the formatter conent
XMLTranscoder * XMLFormatter::getTranscoder ( )
Returns
return the transcoder used internally for transcoding the formatter content
XMLFormatter::UnRepFlags XMLFormatter::getUnRepFlags ( ) const
Returns
return the reaction for unrepresentable character
XMLFormatter& XMLFormatter::operator<< ( const XMLCh *const  toFormat)
See also
formatBuf
XMLFormatter& XMLFormatter::operator<< ( const XMLCh  toFormat)
XMLFormatter & XMLFormatter::operator<< ( const EscapeFlags  newFlags)
Parameters
newFlagsset the escape style for the follow-on formatted content
See also
setEscapeFlags
XMLFormatter & XMLFormatter::operator<< ( const UnRepFlags  newFlags)
Parameters
newFlagsset the reaction for unrepresentable character
See also
setUnRepFlags
void XMLFormatter::setEscapeFlags ( const EscapeFlags  newFlags)
Parameters
newFlagsset the escape style for the follow-on formatted content
void XMLFormatter::setUnRepFlags ( const UnRepFlags  newFlags)
Parameters
newFlagsset the reaction for unrepresentable character
void XMLFormatter::writeBOM ( const XMLByte *const  toFormat,
const XMLSize_t  count 
)

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