Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

Classes | Public Types | Static Public Member Functions | Static Public Attributes | List of all members
XalanTranscodingServices Class Reference

Classes

class  UnrepresentableCharacterException

Public Types

enum  eCode { OK, UnsupportedEncoding, InternalFailure, SupportFilesNotFound }
typedef unsigned char XalanXMLByte
typedef unsigned int size_type
typedef unsigned int UnicodeCharType

Static Public Member Functions

static void initialize (MemoryManagerType &theManager)
 Perform static initialization.
static void terminate ()
 Perform static shut down.
static size_type length (const XalanXMLByte *theBytes)
static XalanOutputTranscodermakeNewTranscoder (MemoryManagerType &theManager, const XalanDOMString &theEncodingName, eCode &theResult, size_type theBlockSize)
 Create a transcoder instance for the specified encoding.
static void destroyTranscoder (XalanOutputTranscoder *theTranscoder)
 Destroy a transcoder instance.
static bool encodingIsUTF8 (const XalanDOMChar *theEncodingName)
 Determine if the encoding name supplied is equivalent to UTF-8.
static bool encodingIsUTF8 (const XalanDOMString &theEncodingName)
 Determine if the encoding name supplied is equivalent to UTF-8.
static bool encodingIsUTF16 (const XalanDOMChar *theEncodingName)
 Determine if the encoding name supplied is equivalent to UTF-16.
static bool encodingIsUTF16 (const XalanDOMString &theEncodingName)
 Determine if the encoding name supplied is equivalent to UTF-16.
static bool encodingIsUTF32 (const XalanDOMChar *theEncodingName)
 Determine if the encoding name supplied is equivalent to UTF-32.
static bool encodingIsUTF32 (const XalanDOMString &theEncodingName)
 Determine if the encoding name supplied is equivalent to UTF-32.
static const XalanXMLBytegetStreamProlog (const XalanDOMString &theEncodingName)
 Get an array that contains any leading bytes that should be written to an XML stream for the specified encoding.
static XalanDOMChar getMaximumCharacterValue (const XalanDOMString &theEncoding)
 Get the maximum character value for the encoding.
static XalanDOMChar getMaximumCharacterValue ()
 Get the maximum character value for the local code page.
static bool getBytesEqualChars (const XalanDOMString &theEncoding)
 Determine if the output stage can safely skip transcoding by truncating.
static bool canTranscodeToLocalCodePage (UnicodeCharType theChar)

Static Public Attributes

static const XalanDOMChar s_utf8String []
static const XalanDOMChar s_utf16String []
static const XalanDOMChar s_utf16LEString []
static const XalanDOMChar s_utf16BEString []
static const XalanDOMChar s_utf32String []
static const XalanDOMChar s_asciiString []
static const XalanDOMChar s_usASCIIString []
static const XalanDOMChar s_windows1250String []
static const XalanDOMChar s_iso88591String []
static const XalanDOMChar s_shiftJISString []

Member Typedef Documentation

Member Enumeration Documentation

Enumerator:
OK 
UnsupportedEncoding 
InternalFailure 
SupportFilesNotFound 

Member Function Documentation

static bool XalanTranscodingServices::canTranscodeToLocalCodePage ( UnicodeCharType  theChar)
static
static void XalanTranscodingServices::destroyTranscoder ( XalanOutputTranscoder theTranscoder)
static

Destroy a transcoder instance.

The transcoder to destroy.

static bool XalanTranscodingServices::encodingIsUTF16 ( const XalanDOMChar *  theEncodingName)
static

Determine if the encoding name supplied is equivalent to UTF-16.

Parameters
theEncodingNameThe name of the output encoding.
Returns
true or false
static bool XalanTranscodingServices::encodingIsUTF16 ( const XalanDOMString theEncodingName)
static

Determine if the encoding name supplied is equivalent to UTF-16.

Parameters
theEncodingNameThe name of the output encoding.
Returns
true or false
static bool XalanTranscodingServices::encodingIsUTF32 ( const XalanDOMChar *  theEncodingName)
static

Determine if the encoding name supplied is equivalent to UTF-32.

Parameters
theEncodingNameThe name of the output encoding.
Returns
true or false
static bool XalanTranscodingServices::encodingIsUTF32 ( const XalanDOMString theEncodingName)
static

Determine if the encoding name supplied is equivalent to UTF-32.

Parameters
theEncodingNameThe name of the output encoding.
Returns
true or false
static bool XalanTranscodingServices::encodingIsUTF8 ( const XalanDOMChar *  theEncodingName)
static

Determine if the encoding name supplied is equivalent to UTF-8.

Parameters
theEncodingNameThe name of the output encoding.
Returns
true or false
static bool XalanTranscodingServices::encodingIsUTF8 ( const XalanDOMString theEncodingName)
static

Determine if the encoding name supplied is equivalent to UTF-8.

Parameters
theEncodingNameThe name of the output encoding.
Returns
true or false
static bool XalanTranscodingServices::getBytesEqualChars ( const XalanDOMString theEncoding)
static

Determine if the output stage can safely skip transcoding by truncating.

Parameters
theEncodingThe encoding name.
Returns
true if truncation is possible, false if not.
static XalanDOMChar XalanTranscodingServices::getMaximumCharacterValue ( const XalanDOMString theEncoding)
static

Get the maximum character value for the encoding.

Parameters
theEncodingThe encoding name.
Returns
The maximum character value the encoding supports.
static XalanDOMChar XalanTranscodingServices::getMaximumCharacterValue ( )
static

Get the maximum character value for the local code page.

This is now deprecated, since it's impossibly broken.

Deprecated:
Returns
The maximum character value the local code page supports.
static const XalanXMLByte* XalanTranscodingServices::getStreamProlog ( const XalanDOMString theEncodingName)
static

Get an array that contains any leading bytes that should be written to an XML stream for the specified encoding.

For example, if the encoding is UTF-16, the vector will contain the appropriate byte order mark for the current platform. If there is no prolog for the encoding, or the encoding is unknown, an empty array is returned.

Parameters
theEncodingNameThe name of the desired output encoding.
Returns
An array containing the appropriate bytes.
static void XalanTranscodingServices::initialize ( MemoryManagerType theManager)
static

Perform static initialization.

See class PlatformSupportInit.

static size_type XalanTranscodingServices::length ( const XalanXMLByte theBytes)
static
static XalanOutputTranscoder* XalanTranscodingServices::makeNewTranscoder ( MemoryManagerType theManager,
const XalanDOMString theEncodingName,
eCode theResult,
size_type  theBlockSize 
)
static

Create a transcoder instance for the specified encoding.

Parameters
theEncodingNameThe name of the desired output encoding.
theResultThe error code.
theTargetThe target array for storing the transcoded data.
theBlockSizeThe block size the transcoder should use.
Returns
The new transcoder, or 0 if there was an error.
static void XalanTranscodingServices::terminate ( )
static

Perform static shut down.

See class PlatformSupportInit.

Member Data Documentation

const XalanDOMChar XalanTranscodingServices::s_asciiString[]
static
const XalanDOMChar XalanTranscodingServices::s_iso88591String[]
static
const XalanDOMChar XalanTranscodingServices::s_shiftJISString[]
static
const XalanDOMChar XalanTranscodingServices::s_usASCIIString[]
static
const XalanDOMChar XalanTranscodingServices::s_utf16BEString[]
static
const XalanDOMChar XalanTranscodingServices::s_utf16LEString[]
static
const XalanDOMChar XalanTranscodingServices::s_utf16String[]
static
const XalanDOMChar XalanTranscodingServices::s_utf32String[]
static
const XalanDOMChar XalanTranscodingServices::s_utf8String[]
static
const XalanDOMChar XalanTranscodingServices::s_windows1250String[]
static

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

Interpreting class diagrams

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

dot

Xalan-C++ XSLT Processor Version 1.10
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.

Apache Logo