Xalan-C++ API Documentation

The Xalan C++ XSL Transformer Version 1.1

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

DOMStringHelper.hpp File Reference

Include dependency graph for DOMStringHelper.hpp:

Include dependency graph

This graph shows which files directly or indirectly include this file:

Included by dependency graph

Go to the source code of this file.

Compounds

Defines

Functions


Define Documentation

#define DOMSTRINGHELPER_HEADER_GUARD_1357924680
 

#define XALAN_STATIC_UCODE_STRING( str )   TranscodeFromLocalCodePage(str)
 


Function Documentation

double DOMStringToDouble ( const XalanDOMString & theString ) []
 

Converts a XalanDOMString into a double value.

Parameters:
theString   target string
Returns:
double value of target string

int DOMStringToInt ( const XalanDOMString & theString ) []
 

Converts a XalanDOMString into an integer value.

Parameters:
theString   target string
Returns:
integer value of target string

long DOMStringToLong ( const XalanDOMString & theString ) []
 

Converts a XalanDOMString into a long value.

Parameters:
theString   target string
Returns:
long value of target string

unsigned long DOMStringToUnsignedLong ( const XalanDOMString & theString ) []
 

Converts a XalanDOMString into a long value.

Parameters:
theString   target string
Returns:
unsigned long value of target string

const XalanDOMString DoubleToDOMString ( double theValue ) []
 

Converts a double value into a XalanDOMString.

Parameters:
theValue   number to be converted
Returns:
decimal string representation of the number

const XalanDOMString LongToDOMString ( long theValue ) []
 

Converts a long value into a XalanDOMString.

Parameters:
theValue   number to be converted
Returns:
decimal string representation of the number

const XalanDOMString LongToHexDOMString ( long theValue ) []
 

Converts a long value into a XalanDOMString.

Returns an empty string for negative values.

Parameters:
theValue   number to be converted
Returns:
hexadecimal string representation of the number

XalanDOMCharVectorType MakeXalanDOMCharVector ( const XalanDOMString & data ) []
 

Utility function to make a null-terminated vector of XMLChs, from a XalanDOMString.

Parameters:
data   XalanDOMString to be converted
Returns:
null-terminated vector of XalanDOMChar

void OutputString ( std::ostream & theStream,
const XalanDOMString & theString ) []
 

Outputs the target string to the specified stream.

Parameters:
theStream   output stream
theString   target string
See also:
operator<<

const XalanDOMString & StaticStringToDOMString ( const XalanDOMString & theString ) []
 

Determines if a range in an array contains only whitespace.

Parameters:
ch   target array
start   starting index to examine
length   number of characters to examine
Returns:
true if specified range contains only whitespace

const XalanDOMString UnsignedLongToDOMString ( unsigned long theValue ) []
 

Converts an unsigned long value into a XalanDOMString.

Parameters:
theValue   number to be converted
Returns:
decimal string representation of the number

const XalanDOMString UnsignedLongToHexDOMString ( unsigned long theValue ) []
 

Converts an unsigned long value and appends the result to a XalanDOMString.

Parameters:
theValue   number to be converted
Returns:
hexadecimal string representation of the number

XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION ( XalanDOMString ) const
 

Simulates the java String method substring().

Returns a new string that is a substring of this string. The substring begins at the specified theStartIndex and extends to the character at index theEndIndex - 1. Thus the length of the substring is theEndIndex - theStartIndex.

Parameters:
theString   source string
theStartIndex   starting index, inclusive
theEndIndex   ending index, exclusive
Returns:
string containing the specified range of characters from target

XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION ( void ) const
 

Outputs the target string to the specified stream.

Parameters:
theStream   output stream
theString   target string
See also:
operator<<

XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION ( double ) const
 

Converts a wide string into a double value.

Parameters:
theString   target string
Returns:
double value of target string

XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION ( long ) const
 

Converts a wide string into a long value.

Parameters:
theString   target string
Returns:
long value of target string

XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION ( int ) const
 

Converts a wide string into an integer value.

Parameters:
theString   target string
Returns:
integer value of target string

XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION ( XalanDOMString )
 

Converts a double value into a XalanDOMString.

Parameters:
theValue   number to be converted
theResult   the string to append with the result
Returns:
a reference to the passed string result.

XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION ( bool ) const
 

Simulates the java String method startsWith().

Parameters:
theDOMString   target string to search
theSubstring   substring searched for
Returns:
true if the target string begins with the substring

XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION ( unsigned long ) const
 

Simulates the java String method indexOf().

Parameters:
theString   string to search
theSubstring   substring searched for
Returns:
the index of theSubstring in theString, or length(theString) if the string is not found.

XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION ( void )
 

Initialize static data.

Parameters:
theStream   output stream
theString   target string
See also:
operator<<

XalanDOMString & append ( XalanDOMString & theString,
char theCharToAppend ) []
 

Concatenate a string and a character.

Parameters:
theString   target string
theCharToAppend   the character to add to the target
Returns:
string with the character appended

XalanDOMString & append ( XalanDOMString & theString,
const XalanDOMChar theCharToAppend ) []
 

Concatenate a string and a character.

Parameters:
theString   target string
theCharToAppend   the character to add to the target
Returns:
string with the character appended

XalanDOMString & append ( XalanDOMString & theString,
const char * theStringToAppend,
unsigned int theStringToAppendLength = unsigned(-1) ) []
 

Concatenate two strings.

Parameters:
theString   target string
theStringToAppend   string to add to target
theStringToAppendLength   length of the string (-1 implies the string is null-terminated)
Returns:
string with contents of 'theStringToAppend' added to target string

XalanDOMString & append ( XalanDOMString & theString,
const XalanDOMChar * theStringToAppend,
unsigned int theStringToAppendLength = unsigned(-1) ) []
 

Concatenate two strings.

Parameters:
theString   target string
theStringToAppend   string to add to target
theStringToAppendLength   length of the string (-1 implies the string is null-terminated)
Returns:
a reference to the target string

XalanDOMString & append ( XalanDOMString & theString,
const XalanDOMString & theStringToAppend ) []
 

Concatenate two strings.

Parameters:
theString   target string
theStringToAppend   string to add to target
Returns:
a reference to the target string

XalanDOMString & assign ( XalanDOMString & theString,
const XalanDOMChar * theStringToAssign,
unsigned int theStringToAssignLength = unsigned(-1) ) []
 

Assign one string to another.

Parameters:
theString   target string
theStringToAppend   string to assign
theStringToAppendLength   length of the string (-1 implies the string is null-terminated)
Returns:
a reference to the target string

XalanDOMString & assign ( XalanDOMString & theString,
const XalanDOMString & theStringToAssign ) []
 

Assign one string to another.

Parameters:
theString   target string
theStringToAppend   string to assign
theStringToAppendLength   length of the string (-1 implies the string is null-terminated)
Returns:
a reference to the target string

const char * c_str ( const CharVectorType & theString ) []
 

Get the underlying representation of the target CharVectorType as a null-terminated string.

Parameters:
theString   target string
Returns:
null-terminated string of chars

const XalanDOMChar * c_wstr ( const XalanDOMChar * theString ) []
 

Get the underlying representation of the wide string as a UNICODE null-terminated string.

This is here simply for consistency in the code. On certain platforms, compiler- generated wide strings will not contain Unicode code points. Another macro converts those into XalanDOMStrings, which are then transcoded. In these cases, the previous defined c_sstr() function gets called.

On platforms where the compiler does generate Unicode wide strings, this function will be called instead.

Parameters:
theString   target string
Returns:
null-terminated string of XalanDOMChar

const XalanDOMChar * c_wstr ( const XalanDOMString & theString ) []
 

Get the underlying representation of the target XalanDOMString as a null-terminated string.

Parameters:
theString   target string
Returns:
null-terminated string of XalanDOMChar

XalanDOMChar charAt ( const XalanDOMString & theString,
unsigned int theIndex ) []
 

Retrieves a character at a specified index in the target string.

Parameters:
theString   target string
theIndex   index of character
Returns:
character at specified index

void clear ( XalanDOMString & theString ) []
 

Remove all elements from target string.

Parameters:
theString   target string

int collationCompare ( const XalanDOMString & theLHS,
const XalanDOMChar * theRHS ) []
 

Compare the contents of two strings.

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
Returns 0 for equal strings, less than 0 if theLHS is less than theRHS, or greater than 0 if theRHS is greater than theLHS.

int collationCompare ( const XalanDOMChar * theLHS,
const XalanDOMString & theRHS ) []
 

Compare the contents of two strings.

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
Returns 0 for equal strings, less than 0 if theLHS is less than theRHS, or greater than 0 if theRHS is greater than theLHS.

int collationCompare ( const XalanDOMString & theLHS,
const XalanDOMString & theRHS ) []
 

Compare the contents of two strings.

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
Returns 0 for equal strings, less than 0 if theLHS is less than theRHS, or greater than 0 if theRHS is greater than theLHS.
See also:
operator<() , compare()

int collationCompare ( const XalanDOMChar * theLHS,
const XalanDOMChar * theRHS ) []
 

Compare the contents of two strings.

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
Returns 0 for equal strings, less than 0 if theLHS is less than theRHS, or greater than 0 if theRHS is greater than theLHS.
See also:
operator<() , compare()

int compare ( const XalanDOMString & theLHS,
const XalanDOMChar * theRHS ) []
 

Compare the contents of two strings.

THIS FUNCTION DOES NOT COMPARE STRINGS LIKE strcmp() OR ANY OTHER "COLLATION" ALGORITHM.

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
Returns 0 for equal strings, less than 0 if theLHS is less than theRHS, or greater than 0 if theRHS is greater than theLHS.

int compare ( const XalanDOMChar * theLHS,
const XalanDOMString & theRHS ) []
 

Compare the contents of two strings.

THIS FUNCTION DOES NOT COMPARE STRINGS LIKE strcmp() OR ANY OTHER "COLLATION" ALGORITHM.

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
Returns 0 for equal strings, less than 0 if theLHS is less than theRHS, or greater than 0 if theRHS is greater than theLHS.

int compare ( const XalanDOMString & theLHS,
const XalanDOMString & theRHS ) []
 

Compare the contents of two strings.

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
Returns 0 for equal strings, less than 0 if theLHS is less than theRHS, or greater than 0 if theRHS is greater than theLHS.
See also:
operator<() , collationCompare()

int compare ( const XalanDOMChar * theLHS,
const XalanDOMChar * theRHS ) []
 

Compare the contents of two null-terminated strings.

THIS FUNCTION DOES NOT COMPARE STRINGS LIKE strcmp() OR ANY OTHER "COLLATION" ALGORITHM.

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
Returns 0 for equal strings, less than 0 if theLHS is less than theRHS, or greater than 0 if theRHS is greater than theLHS.

int compareIgnoreCaseASCII ( const XalanDOMChar * theLHS,
const XalanDOMString & theRHS ) []
 

Compare the contents of two strings, in a case insensitive manner.

Only the characters a-z and A-Z are considered for the comparison.

THIS FUNCTION DOES NOT COMPARE STRINGS LIKE strcmp() OR ANY OTHER "COLLATION" ALGORITHM.

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
Returns 0 for equal strings, less than 0 if theLHS is less than theRHS, or greater than 0 if theRHS is greater than theLHS.

int compareIgnoreCaseASCII ( const XalanDOMString & theLHS,
const XalanDOMChar * theRHS ) []
 

Compare the contents of two strings, in a case insensitive manner.

Only the characters a-z and A-Z are considered as characters with "case".

THIS FUNCTION DOES NOT COMPARE STRINGS LIKE strcmp() OR ANY OTHER "COLLATION" ALGORITHM.

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
Returns 0 for equal strings, less than 0 if theLHS is less than theRHS, or greater than 0 if theRHS is greater than theLHS.

int compareIgnoreCaseASCII ( const XalanDOMString & theLHS,
const XalanDOMString & theRHS ) []
 

Compare the contents of two strings, in a case insensitive manner.

Only the characters a-z and A-Z are considered as characters with "case".

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
Returns 0 for equal strings, less than 0 if theLHS is less than theRHS, or greater than 0 if theRHS is greater than theLHS.
See also:
operator< , collationCompare

int compareIgnoreCaseASCII ( const XalanDOMChar * theLHS,
const XalanDOMChar * theRHS ) []
 

Compare the contents of two strings, in a case insensitive manner.

Only the characters a-z and A-Z are considered as characters with "case".

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
Returns 0 for equal strings, less than 0 if theLHS is less than theRHS, or greater than 0 if theRHS is greater than theLHS.

bool endsWith ( const XalanDOMString & theDOMString,
const XalanDOMString & theSubstring ) []
 

Simulates the java String method endsWith().

Parameters:
theDOMString   target string to search
theSubstring   substring searched for
Returns:
true if the target string ends with the substring

bool equals ( const char * theLHS,
const XalanDOMChar * theRHS ) []
 

Compare the contents of two strings for equality.

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
true if the contents of both strings are identical

bool equals ( const XalanDOMChar * theLHS,
const char * theRHS ) []
 

Compare the contents of two strings for equality.

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
true if the contents of both strings are identical

bool equals ( const char * theLHS,
const XalanDOMString & theRHS ) []
 

Compare the contents of two strings for equality.

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
true if the contents of both strings are identical

bool equals ( const XalanDOMString & theLHS,
const char * theRHS ) []
 

Compare the contents of two strings for equality.

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
true if the contents of both strings are identical

bool equals ( const XalanDOMString & theLHS,
const XalanDOMChar * theRHS ) []
 

Compare the contents of two strings for equality.

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
true if the contents of both strings are identical

bool equals ( const XalanDOMChar * theLHS,
const XalanDOMString & theRHS ) []
 

Compare the contents of two strings for equality.

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
true if the contents of both strings are identical

bool equals ( const XalanDOMString & theLHS,
const XalanDOMString & theRHS ) []
 

Compare the contents of two strings for equality.

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
true if the contents of both strings are identical

bool equals ( const XalanDOMChar * theLHS,
const XalanDOMChar * theRHS ) []
 

Compare the contents of two strings for equality.

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
true if the contents of both strings are identical

bool equalsIgnoreCaseASCII ( const XalanDOMString & theLHS,
const XalanDOMChar * theRHS ) []
 

Compare the contents of two strings for equality, without regard for case.

Only the characters A-Z and a-z are considered.

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
true if the case-insensitive contents of both strings are identical

bool equalsIgnoreCaseASCII ( const XalanDOMChar * theLHS,
const XalanDOMString & theRHS ) []
 

Compare the contents of two strings for equality, without regard for case.

Only the characters a-z and A-Z are considered characters with "case".

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
true if the case-insensitive contents of both strings are identical

bool equalsIgnoreCaseASCII ( const XalanDOMString & theLHS,
const XalanDOMString & theRHS ) []
 

Compare the contents of two strings for equality, without regard for case Only the characters A-Z and a-z are considered.

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
true if the case-insensitive contents of both strings are identical

bool equalsIgnoreCaseASCII ( const XalanDOMChar * theLHS,
const XalanDOMChar * theRHS ) []
 

Compare the contents of two strings for equality, without regard for case.

Only the characters a-z and A-Z are considered characters with "case".

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
true if both strings are identical

void erase ( XalanDOMString & theString ) []
 

Remove all elements from target string.

Parameters:
theString   target string

unsigned int indexOf ( const XalanDOMString & theString,
XalanDOMChar theChar ) []
 

Simulates the java String method indexOf().

Parameters:
theString   string to search
theChar   character searched for
Returns:
the index of theChar in theString, or length(theString) if the character is not found.

unsigned int indexOf ( const XalanDOMChar * theString,
unsigned int theStringLength,
XalanDOMChar theChar ) []
 

Simulates the java String method indexOf().

Parameters:
theString   string to search
theStringLength   the length of theString
theChar   character searched for
Returns:
the index of theChar in theString, or length(theString) if the character is not found.

unsigned int indexOf ( const XalanDOMChar * theString,
XalanDOMChar theChar ) []
 

Simulates the java String method indexOf().

Parameters:
theString   string to search
theChar   character searched for
Returns:
the index of theChar in theString, or length(theString) if the character is not found.

XalanDOMString & insert ( XalanDOMString & theString,
unsigned int thePosition,
const XalanDOMChar * theStringToInsert ) []
 

Insert a string into another string.

Parameters:
theString   target string
thePosition   The position in the target string to insert
theStringToInsert   The string to insert
Returns:
A reference to the target string

XalanDOMString & insert ( XalanDOMString & theString,
unsigned int thePosition,
const XalanDOMString & theStringToInsert ) []
 

Insert a string into another string.

Parameters:
theString   target string
thePosition   The position in the target string to insert
theStringToInsert   The string to insert
Returns:
A reference to the target string

bool isEmpty ( const XalanDOMString & str ) []
 

Determines if the target string contains any elements.

Parameters:
str   target string
Returns:
true if the target string has a non-zero length

bool isXMLDigit ( XalanDOMChar theChar ) []
 

Determines whether character represents a digit.

Parameters:
theChar   target character
Returns:
true if character represents a digit

bool isXMLLetterOrDigit ( XalanDOMChar theChar ) []
 

Determines whether character represents a letter or digit.

Parameters:
theChar   target character
Returns:
true if character represents a letter or digit

bool isXMLWhitespace ( const XalanDOMChar * theString ) []
 

Determines if a null-terminated string contains only whitespace.

Parameters:
theString   target string
Returns:
true if the string contains only whitespace

bool isXMLWhitespace ( XalanDOMChar theChar ) []
 

Determines whether character represents white space.

Parameters:
theChar   target character
Returns:
true if character represents white space

unsigned int lastIndexOf ( const XalanDOMString & theString,
XalanDOMChar theChar ) []
 

Simulates the java String method lastIndexOf().

Parameters:
theString   string to search
theChar   character searched for
Returns:
the index of theChar in theString, or length(theString) if the character is not found.

unsigned int length ( const char * theString ) []
 

Get the length of a null-terminated string.

Parameters:
theString   target string
Returns:
the length of the target string

unsigned int length ( const XalanDOMChar * theString ) []
 

Get the length of a null-terminated string of XalanDOMChar characters.

Parameters:
theString   target string
Returns:
the length of the target string

unsigned int length ( const XalanDOMString & theString ) []
 

Get the length of a XalanDOMString.

Parameters:
theString   target string
Returns:
the length of the target string

bool operator< ( const XalanDOMString & theLHS,
const XalanDOMString & theRHS ) []
 

Implements operator< for DOMStrings.

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
Returns true if theLHS is lexically less than theRHS
See also:
compare

bool operator< ( const CharVectorType & theLHS,
const CharVectorType & theRHS ) []
 

Implements operator< for CharVectorType.

Parameters:
theLHS   first string to compare
theRHS   second string to compare
Returns:
Returns true if theLHS is lexically less than theRHS
See also:
compare

std::ostream & operator<< ( std::ostream & theStream,
const XalanDOMString & theString ) []
 

Outputs the target string to the specified stream.

Parameters:
theStream   output stream
theString   target string
See also:
OutputString()

XalanOutputStream & operator<< ( XalanOutputStream & theStream,
const XalanDOMString & theString ) []
 

Outputs the target string to the specified stream.

Parameters:
theStream   output stream
theString   target string
See also:
OutputString()

std::ostream & operator<< ( std::ostream & theStream,
const XalanDOMChar * theString ) []
 

Outputs the target string to the specified stream.

Parameters:
theStream   output stream
theString   target string
See also:
OutputString()

XalanOutputStream & operator<< ( XalanOutputStream & theStream,
const XalanDOMChar * theString ) []
 

Outputs the target string to the specified stream.

Parameters:
theStream   output stream
theString   target string
See also:
OutputString()

std::ostream & operator<< ( std::ostream & theStream,
const CharVectorType & theString ) []
 

Outputs the string to the specified stream.

Parameters:
theStream   output stream
theString   the string to output
See also:
OutputString()

XalanOutputStream & operator<< ( XalanOutputStream & theStream,
const CharVectorType & theString ) []
 

Outputs the string to the specified stream.

Parameters:
theStream   output stream
theString   the string to output
See also:
OutputString()

void releaseMemory ( XalanDOMString & theString ) []
 

Remove all elements from target string and frees all allocated memory.

Parameters:
theString   target string

void reserve ( XalanDOMString & theString,
unsigned int theCount ) []
 

Reserve some space in the string for more efficient concatenation...

Parameters:
theString   target string
theCount   The amount of space to reserve

bool startsWith ( const XalanDOMString & theString,
const char * theSubstring ) []
 

Simulates the java String method startsWith().

Parameters:
theDOMString   target string to search
theSubstring   substring searched for
Returns:
true if the target string begins with the substring

const char * toCharArray ( const CharVectorType & theString ) []
 

Get the underlying representation of the target CharVectorType as a pointer to an array of characters.

Parameters:
theString   target string
Returns:
the pointer

const XalanDOMChar * toCharArray ( const XalanDOMChar * theString ) []
 

Get the underlying representation of a XalanDOMChar.

Parameters:
theString   target string
Returns:
array of XalanDOMChar

const XalanDOMChar * toCharArray ( const XalanDOMString & theString ) []
 

Get the underlying representation of the target XalanDOMString as an array of XalanDOMChar, not guaranteed to be null-terminated.

Parameters:
theString   target string
Returns:
array of XalanDOMChar

XalanDOMChar toLowerASCII ( XalanDOMChar theChar ) []
 

Converts ASCII alphabetic characters from upper case to lower case.

This function works only with the Unicode characters A-Z.

Parameters:
theString   target string
Returns:
string containing lower case characters

XalanDOMChar toUpperASCII ( XalanDOMChar theChar ) []
 

Converts ASCII alphabetic characters from lower case to upper case.

This function works only with the Unicode characters a-z.

Parameters:
theString   target string
Returns:
string containing upper case characters

Interpreting class diagrams

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

Xalan-C++ XSL Transformer Version 1.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.