Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


Classes | Functions

DOMStringHelper.hpp File Reference

#include <xalanc/PlatformSupport/PlatformSupportDefinitions.hpp>
#include <algorithm>
#include <cassert>
#include <functional>
#include <iosfwd>
#include <xalanc/Include/XalanVector.hpp>
#include <xalanc/Include/XalanMap.hpp>
#include <xalanc/Include/XalanMemoryManagement.hpp>
#include <xalanc/Include/STLHelper.hpp>
#include <xalanc/XalanDOM/XalanDOMString.hpp>
#include <xalanc/PlatformSupport/FormatterListener.hpp>
#include <xalanc/PlatformSupport/XalanUnicode.hpp>
#include <xalanc/PlatformSupport/XalanXMLChar.hpp>
Include dependency graph for DOMStringHelper.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

Functions


Function Documentation

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

Concatenate two strings.

Deprecated:
This function is deprecated.
Parameters:
theString target string
theStringToAppend string to add to target
Returns:
a reference to the target string

Definition at line 2410 of file DOMStringHelper.hpp.

XalanDOMString& append ( XalanDOMString theString,
const XalanDOMChar *  theStringToAppend,
XalanDOMString::size_type  theStringToAppendLength = XalanDOMString::npos 
) [inline]

Concatenate two strings.

Deprecated:
This function is deprecated.
Parameters:
theString target string
theStringToAppend string to add to target
theStringToAppendLength length of the string (XalanDOMString::npos implies the string is null-terminated)
Returns:
a reference to the target string

Definition at line 2432 of file DOMStringHelper.hpp.

XalanDOMString& append ( XalanDOMString theString,
const char *  theStringToAppend,
XalanDOMString::size_type  theStringToAppendLength = XalanDOMString::npos 
) [inline]

Concatenate two strings.

Deprecated:
This function is deprecated.
Parameters:
theString target string
theStringToAppend string to add to target
theStringToAppendLength length of the string (XalanDOMString::npos implies the string is null-terminated)
Returns:
string with contents of 'theStringToAppend' added to target string

Definition at line 2464 of file DOMStringHelper.hpp.

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

Concatenate a string and a character.

Deprecated:
This function is deprecated.
Parameters:
theString target string
theCharToAppend the character to add to the target
Returns:
string with the character appended

Definition at line 2490 of file DOMStringHelper.hpp.

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

Concatenate a string and a character.

Deprecated:
This function is deprecated.
Parameters:
theString target string
theCharToAppend the character to add to the target
Returns:
string with the character appended

Definition at line 2511 of file DOMStringHelper.hpp.

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

Assign one string to another.

Deprecated:
This function is deprecated.
Parameters:
theString target string
theStringToAppend string to assign
theStringToAppendLength length of the string (XalanDOMString::npos implies the string is null-terminated)
Returns:
a reference to the target string

Definition at line 2359 of file DOMStringHelper.hpp.

XalanDOMString& assign ( XalanDOMString theString,
const XalanDOMChar *  theStringToAssign,
XalanDOMString::size_type  theStringToAssignLength = XalanDOMString::npos 
) [inline]

Assign one string to another.

Deprecated:
This function is deprecated.
Parameters:
theString target string
theStringToAppend string to assign
theStringToAppendLength length of the string (XalanDOMString::npos implies the string is null-terminated)
Returns:
a reference to the target string

Definition at line 2381 of file DOMStringHelper.hpp.

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

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

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

Definition at line 118 of file DOMStringHelper.hpp.

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

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

Deprecated:
This function is deprecated.
Parameters:
theString target string
Returns:
null-terminated string of XalanDOMChar

Definition at line 103 of file DOMStringHelper.hpp.

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

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.

Deprecated:
This function is deprecated.
Parameters:
theString target string
Returns:
null-terminated string of XalanDOMChar

Definition at line 154 of file DOMStringHelper.hpp.

XalanDOMChar charAt ( const XalanDOMString theString,
XalanDOMString::size_type  theIndex 
) [inline]

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

Deprecated:
This function is deprecated.
Parameters:
theString target string
theIndex index of character
Returns:
character at specified index

Definition at line 1412 of file DOMStringHelper.hpp.

void clear ( XalanDOMString theString  )  [inline]

Remove all elements from target string.

Deprecated:
This function is deprecated.
Parameters:
theString target string

Definition at line 2591 of file DOMStringHelper.hpp.

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 collationCompare ( const XalanDOMString theLHS,
const XalanDOMString theRHS 
) [inline]

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()

Definition at line 2006 of file DOMStringHelper.hpp.

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

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.

Definition at line 2024 of file DOMStringHelper.hpp.

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

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.

Definition at line 2042 of file DOMStringHelper.hpp.

collationCompare ( const XalanDOMChar *  theLHS,
XalanDOMString::size_type  theLHSLength,
const XalanDOMChar *  theRHS,
XalanDOMString::size_type  theRHSLength 
)

Compare the contents of two character arrays.

Parameters:
theLHS first array to compare
theLHSLength the length of the first array
theRHS second array to compare
theRHSLength the length of the second array
Returns:
Returns 0 for equal arrays, less than 0 if theLHS is less than theRHS, or greater than 0 if theRHS is greater than theLHS.
compare ( const CharVectorType theLHS,
const CharVectorType 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.
See also:
operator<()
compare ( const XalanDOMChar *  theLHS,
XalanDOMString::size_type  theLHSLength,
const XalanDOMChar *  theRHS,
XalanDOMString::size_type  theRHSLength 
)

Compare the contents of two character arrays.

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

Parameters:
theLHS first array to compare
theLHSLength the length of the first array
theRHS second array to compare
theRHSLength the length of the second array
Returns:
Returns 0 for equal arrays, 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 XalanDOMChar *  theRHS 
) [inline]

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.

Definition at line 1743 of file DOMStringHelper.hpp.

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

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.
See also:
operator<()
collationCompare()

Definition at line 1766 of file DOMStringHelper.hpp.

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

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.

Definition at line 1791 of file DOMStringHelper.hpp.

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

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.

Definition at line 1816 of file DOMStringHelper.hpp.

compareIgnoreCaseASCII ( const XalanDOMChar *  theLHS,
XalanDOMString::size_type  theLHSLength,
const XalanDOMChar *  theRHS,
XalanDOMString::size_type  theRHSLength 
)

Compare the contents of two arrays 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 array to compare
theLHSLength the length of the first array
theRHS second array to compare
theRHSLength the length of the second array
Returns:
Returns 0 for equal arrays, 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 XalanDOMChar *  theRHS 
) [inline]

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.

Definition at line 1867 of file DOMStringHelper.hpp.

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

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.
See also:
operator<
collationCompare

Definition at line 1892 of file DOMStringHelper.hpp.

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

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.

Definition at line 1919 of file DOMStringHelper.hpp.

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

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.

Definition at line 1946 of file DOMStringHelper.hpp.

CopyStringToVector ( const char *  theString,
CharVectorType theVector 
)
CopyWideStringToVector ( const XalanDOMChar *  theString,
CharVectorType theVector 
)
double DOMStringToDouble ( const XalanDOMString theString,
MemoryManager &  theMemoryManager 
) [inline]

Converts a XalanDOMString into a double value.

Parameters:
theString target string
theMemoryManager The MemoryManager instance to use.
Returns:
double value of target string

Definition at line 1105 of file DOMStringHelper.hpp.

int DOMStringToInt ( const XalanDOMString theString  )  [inline]

Converts a XalanDOMString into an integer value.

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

Definition at line 1062 of file DOMStringHelper.hpp.

long DOMStringToLong ( const XalanDOMString theString  )  [inline]

Converts a XalanDOMString into a long value.

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

Definition at line 1076 of file DOMStringHelper.hpp.

unsigned long DOMStringToUnsignedLong ( const XalanDOMString theString  )  [inline]

Converts a XalanDOMString into a long value.

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

Definition at line 1090 of file DOMStringHelper.hpp.

endsWith ( const XalanDOMChar *  theString,
XalanDOMString::size_type  theStringLength,
const XalanDOMChar *  theSubstring,
XalanDOMString::size_type  theSubstringLength 
)

Simulates the java String method endsWith().

Parameters:
theString target string to search
theSubstring substring searched for
Returns:
true if the target string ends with the substring
bool endsWith ( const XalanDOMChar *  theString,
const XalanDOMChar *  theSubstring 
) [inline]

Simulates the java String method endsWith().

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

Definition at line 626 of file DOMStringHelper.hpp.

bool endsWith ( const XalanDOMString theString,
const XalanDOMString theSubstring 
) [inline]

Simulates the java String method endsWith().

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

Definition at line 649 of file DOMStringHelper.hpp.

equals ( const XalanDOMChar *  theLHS,
const XalanDOMChar *  theRHS,
XalanDOMString::size_type  theLength 
)

Compare the contents of two arrays for equality.

Parameters:
theLHS first array to compare
theRHS second array to compare
theLength the length of the arrays
Returns:
true if the contents of both arrays are identical
bool equals ( const XalanDOMChar *  theLHS,
XalanDOMString::size_type  theLHSLength,
const XalanDOMChar *  theRHS,
XalanDOMString::size_type  theRHSLength 
) [inline]

Compare the contents of two arrays for equality.

Parameters:
theLHS first array to compare
theLHSLength the length of the theLHS
theRHS second array to compare
theRHSLength the length of the theRHS
Returns:
true if the contents of both arrays are identical

Definition at line 2081 of file DOMStringHelper.hpp.

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

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

Definition at line 2100 of file DOMStringHelper.hpp.

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

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

Definition at line 2119 of file DOMStringHelper.hpp.

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

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

Definition at line 2136 of file DOMStringHelper.hpp.

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

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

Definition at line 2156 of file DOMStringHelper.hpp.

bool equals ( const XalanDOMString theLHS,
const XalanDOMChar *  theRHS,
XalanDOMString::size_type  theRHSLength 
) [inline]

Compare the contents of two strings for equality.

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

Definition at line 2173 of file DOMStringHelper.hpp.

equalsIgnoreCaseASCII ( const XalanDOMChar *  theLHS,
const XalanDOMChar *  theRHS,
XalanDOMString::size_type  theLength 
)

Compare the contents of two arrays 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 XalanDOMChar *  theLHS,
const XalanDOMChar *  theRHS 
) [inline]

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

Definition at line 2232 of file DOMStringHelper.hpp.

bool equalsIgnoreCaseASCII ( const XalanDOMChar *  theLHS,
XalanDOMString::size_type  theLHSLength,
const XalanDOMChar *  theRHS,
XalanDOMString::size_type  theRHSLength 
) [inline]

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
theLHSLength the length of the theLHS
theRHS second string to compare
theRHSLength the length of the theRHS
Returns:
true if both strings are identical

Definition at line 2211 of file DOMStringHelper.hpp.

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

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

Definition at line 2253 of file DOMStringHelper.hpp.

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

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

Definition at line 2277 of file DOMStringHelper.hpp.

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

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

Definition at line 2301 of file DOMStringHelper.hpp.

void erase ( XalanDOMString theString  )  [inline]

Remove all elements from target string.

Deprecated:
This function is deprecated.
Parameters:
theString target string

Definition at line 2606 of file DOMStringHelper.hpp.

XalanDOMChar flipCaseASCII ( XalanDOMChar  theChar  )  [inline]

Flips the case to of the supplied character.

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

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

Definition at line 1582 of file DOMStringHelper.hpp.

XalanDOMString::size_type indexOf ( const XalanDOMString theString,
XalanDOMChar  theChar 
) [inline]

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.

Definition at line 371 of file DOMStringHelper.hpp.

indexOf ( const XalanDOMChar *  theString,
XalanDOMString::size_type  theStringLength,
const XalanDOMChar *  theSubstring,
XalanDOMString::size_type  theSubstringLength 
)

Simulates the java String method indexOf().

Parameters:
theString string to search
theStringLength length of the string to search
theSubstring substring searched for
theSubstringLength length of the substring searched for
Returns:
the index of theSubstring in theString, or length(theString) if the string is not found.
XalanDOMString::size_type indexOf ( const XalanDOMChar *  theString,
const XalanDOMChar *  theSubstring 
) [inline]

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.

Definition at line 410 of file DOMStringHelper.hpp.

indexOf ( const XalanDOMString theString,
const XalanDOMString theSubstring 
)

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.
XalanDOMString::size_type indexOf ( const XalanDOMChar *  theString,
XalanDOMChar  theChar 
) [inline]

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.

Definition at line 312 of file DOMStringHelper.hpp.

XalanDOMString::size_type indexOf ( const XalanDOMChar *  theString,
XalanDOMString::size_type  theStringLength,
XalanDOMChar  theChar 
) [inline]

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.

Definition at line 341 of file DOMStringHelper.hpp.

XalanDOMString& insert ( XalanDOMString theString,
XalanDOMString::size_type  thePosition,
const XalanDOMChar *  theStringToInsert 
) [inline]

Insert a string into another string.

Deprecated:
This function is deprecated.
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

Definition at line 2557 of file DOMStringHelper.hpp.

XalanDOMString& insert ( XalanDOMString theString,
XalanDOMString::size_type  thePosition,
const XalanDOMString theStringToInsert 
) [inline]

Insert a string into another string.

Deprecated:
This function is deprecated.
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

Definition at line 2534 of file DOMStringHelper.hpp.

bool isEmpty ( const XalanDOMString str  )  [inline]

Determines if the target string contains any elements.

Deprecated:
This function is deprecated.
Parameters:
str target string
Returns:
true if the target string has a non-zero length

Definition at line 295 of file DOMStringHelper.hpp.

bool isXMLDigit ( XalanDOMChar  theChar  )  [inline]

Determines whether character represents a digit.

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

Definition at line 1442 of file DOMStringHelper.hpp.

bool isXMLLetterOrDigit ( XalanDOMChar  theChar  )  [inline]

Determines whether character represents a letter or digit.

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

Definition at line 1456 of file DOMStringHelper.hpp.

isXMLWhitespace ( const XalanDOMString string  ) 

Determines if the string contains only whitespace.

Parameters:
theString target string
Returns:
true if string contains only whitespace
isXMLWhitespace ( const XalanDOMChar  ch[],
XalanDOMString::size_type  start,
XalanDOMString::size_type  length 
)

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
bool isXMLWhitespace ( const XalanDOMChar *  theString  )  [inline]

Determines if a null-terminated string contains only whitespace.

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

Definition at line 2857 of file DOMStringHelper.hpp.

bool isXMLWhitespace ( XalanDOMChar  theChar  )  [inline]

Determines whether character represents white space.

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

Definition at line 1428 of file DOMStringHelper.hpp.

lastIndexOf ( const XalanDOMChar *  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.
XalanDOMString::size_type lastIndexOf ( const XalanDOMString theString,
XalanDOMChar  theChar 
) [inline]

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.

Definition at line 464 of file DOMStringHelper.hpp.

XalanDOMString::size_type length ( const char *  theString  )  [inline]

Get the length of a null-terminated string.

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

Definition at line 277 of file DOMStringHelper.hpp.

XalanDOMString::size_type length ( const XalanDOMString theString  )  [inline]

Get the length of a XalanDOMString.

Deprecated:
This function is deprecated.
Parameters:
theString target string
Returns:
the length of the target string

Definition at line 239 of file DOMStringHelper.hpp.

XalanDOMString::size_type length ( const XalanDOMChar *  theString  )  [inline]

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

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

Definition at line 254 of file DOMStringHelper.hpp.

MakeXalanDOMCharVector ( const XalanDOMChar *  data,
XalanDOMCharVectorType result 
)

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

Parameters:
data array to be converted
Returns:
null-terminated vector of XalanDOMChar
MakeXalanDOMCharVector ( const char *  data,
XalanDOMCharVectorType result,
bool  fTranscode = true 
)

Utility function to make a null-terminated vector of XMLChs, from a null-terminated array of chars, via transcoding, if requested.

Parameters:
data array to be converted
whether or not to transcode
Returns:
null-terminated vector of XalanDOMChar
XalanDOMCharVectorType& MakeXalanDOMCharVector ( const XalanDOMString data,
XalanDOMCharVectorType result 
) [inline]

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

Definition at line 2678 of file DOMStringHelper.hpp.

XalanDOMString& NumberToDOMString ( unsigned long  theValue,
XalanDOMString theResult 
) [inline]

Converts an unsigned long 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.

Definition at line 760 of file DOMStringHelper.hpp.

NumberToDOMString ( XALAN_INT64  theValue,
XalanDOMString theResult 
)

Converts an 64-bit signed 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.
XalanDOMString& NumberToDOMString ( long  theValue,
XalanDOMString theResult 
) [inline]

Converts a XalanSSize_t 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.

Definition at line 779 of file DOMStringHelper.hpp.

XalanDOMString& NumberToDOMString ( unsigned int  theValue,
XalanDOMString theResult 
) [inline]

Converts an unsigned int 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.

Definition at line 798 of file DOMStringHelper.hpp.

XalanDOMString& NumberToDOMString ( int  theValue,
XalanDOMString theResult 
) [inline]

Converts an int 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.

Definition at line 817 of file DOMStringHelper.hpp.

XalanDOMString& NumberToDOMString ( unsigned short  theValue,
XalanDOMString theResult 
) [inline]

Converts an unsigned short 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.

Definition at line 836 of file DOMStringHelper.hpp.

XalanDOMString& NumberToDOMString ( short  theValue,
XalanDOMString theResult 
) [inline]

Converts a short 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.

Definition at line 855 of file DOMStringHelper.hpp.

NumberToDOMString ( XALAN_UINT64  theValue,
XalanDOMString theResult 
)

Converts an 64-bit unsigned 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.
NumberToDOMString ( double  theValue,
XalanDOMString theResult 
)

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.
NumberToHexDOMString ( XALAN_UINT64  theValue,
XalanDOMString theResult 
)

Converts an 64-bit unsigned 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.
NumberToHexDOMString ( XALAN_INT64  theValue,
XalanDOMString theResult 
)

Converts an 64-bit signed 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.
XalanDOMString& NumberToHexDOMString ( unsigned long  theValue,
XalanDOMString theResult 
) [inline]

Converts a XalanSSize_t 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.

Definition at line 902 of file DOMStringHelper.hpp.

XalanDOMString& NumberToHexDOMString ( long  theValue,
XalanDOMString theResult 
) [inline]

Converts a XalanSSize_t 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.

Definition at line 921 of file DOMStringHelper.hpp.

XalanDOMString& NumberToHexDOMString ( unsigned int  theValue,
XalanDOMString theResult 
) [inline]

Converts an unsigned int 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.

Definition at line 940 of file DOMStringHelper.hpp.

XalanDOMString& NumberToHexDOMString ( int  theValue,
XalanDOMString theResult 
) [inline]

Converts an int 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.

Definition at line 959 of file DOMStringHelper.hpp.

XalanDOMString& NumberToHexDOMString ( unsigned short  theValue,
XalanDOMString theResult 
) [inline]

Converts an unsigned short 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.

Definition at line 978 of file DOMStringHelper.hpp.

XalanDOMString& NumberToHexDOMString ( short  theValue,
XalanDOMString theResult 
) [inline]

Converts a short 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.

Definition at line 997 of file DOMStringHelper.hpp.

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

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

Definition at line 2320 of file DOMStringHelper.hpp.

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

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

Definition at line 2339 of file DOMStringHelper.hpp.

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

Outputs the string to the specified stream.

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

Definition at line 1263 of file DOMStringHelper.hpp.

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

Outputs the target string to the specified stream.

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

Definition at line 1285 of file DOMStringHelper.hpp.

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

Outputs the target string to the specified stream.

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

Definition at line 1387 of file DOMStringHelper.hpp.

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

Outputs the string to the specified stream.

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

Definition at line 1237 of file DOMStringHelper.hpp.

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

Outputs the target string to the specified stream.

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

Definition at line 1311 of file DOMStringHelper.hpp.

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

Outputs the target string to the specified stream.

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

Definition at line 1359 of file DOMStringHelper.hpp.

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

Outputs the target string to the specified stream.

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

Definition at line 1334 of file DOMStringHelper.hpp.

OutputString ( XalanOutputStream theStream,
const CharVectorType theString 
)

Outputs the target string to the specified stream.

Parameters:
theStream output stream
theString target string
See also:
operator<<
OutputString ( XalanOutputStream theStream,
const XalanDOMChar *  theString 
)

Outputs the target string to the specified stream.

Parameters:
theStream output stream
theString target string
See also:
operator<<
void OutputString ( XalanOutputStream theStream,
const XalanDOMString theString 
) [inline]

Outputs the target string to the specified stream.

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

Definition at line 1189 of file DOMStringHelper.hpp.

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

Outputs the target string to the specified stream.

Parameters:
theStream output stream
theString target string
theMemoryManager The MemoryManager instance to use.
See also:
operator<<

Definition at line 1212 of file DOMStringHelper.hpp.

OutputString ( std::ostream &  theStream,
const XalanDOMChar *  theString,
MemoryManager &  theMemoryManager 
)

Outputs the target string to the specified stream.

Parameters:
theStream output stream
theString target string
See also:
operator<<
OutputString ( std::ostream &  theStream,
const CharVectorType theString 
)

Outputs the target string to the specified stream.

Parameters:
theStream output stream
theString target string
See also:
operator<<
PointerToDOMString ( const void *  theValue,
XalanDOMString theResult 
)

Converts a pointer into a XalanDOMString.

Parameters:
theValue pointer to be converted
theResult the string to append with the result
Returns:
a reference to the passed string result.
void releaseMemory ( XalanDOMString theString,
MemoryManager &  theManager 
) [inline]

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

Parameters:
theString target string

Definition at line 2620 of file DOMStringHelper.hpp.

void reserve ( XalanDOMString theString,
XalanDOMString::size_type  theCount 
) [inline]

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

Deprecated:
This function is deprecated.
Parameters:
theString target string
theCount The amount of space to reserve

Definition at line 221 of file DOMStringHelper.hpp.

bool startsWith ( const XalanDOMChar *  theString,
const XalanDOMString theSubstring 
) [inline]

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

Definition at line 518 of file DOMStringHelper.hpp.

startsWith ( const XalanDOMChar *  theString,
XalanDOMString::size_type  theStringLength,
const XalanDOMChar *  theSubstring,
XalanDOMString::size_type  theSubstringLength 
)

Simulates the java String method startsWith().

Parameters:
theString target string to search
theStringLength the length of theString
theSubstring substring searched for
theSubstringLength the length of theSubstring
Returns:
true if the target string begins with the substring
bool startsWith ( const XalanDOMString theString,
const XalanDOMString theSubstring 
) [inline]

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

Definition at line 589 of file DOMStringHelper.hpp.

bool startsWith ( const XalanDOMString theString,
const XalanDOMChar *  theSubstring 
) [inline]

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

Definition at line 541 of file DOMStringHelper.hpp.

bool startsWith ( const XalanDOMString theString,
const XalanDOMChar *  theSubstring,
XalanDOMString::size_type  theSubstringLength 
) [inline]

Simulates the java String method startsWith().

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

Definition at line 565 of file DOMStringHelper.hpp.

bool startsWith ( const XalanDOMChar *  theString,
const XalanDOMChar *  theSubstring 
) [inline]

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

Definition at line 499 of file DOMStringHelper.hpp.

substring ( const XalanDOMChar *  theString,
XalanDOMString theSubstring,
XalanDOMString::size_type  theStartIndex,
XalanDOMString::size_type  theEndIndex = XalanDOMString::npos 
)

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
theSubstring target string
theStartIndex starting index, inclusive
theEndIndex ending index, exclusive
Returns:
A reference to theSubstring
substring ( const XalanDOMString theString,
XalanDOMString::size_type  theStartIndex,
XalanDOMString theResult,
XalanDOMString::size_type  theEndIndex = XalanDOMString::npos 
)

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
substring ( const XalanDOMString theString,
XalanDOMString theSubstring,
XalanDOMString::size_type  theStartIndex,
XalanDOMString::size_type  theEndIndex = XalanDOMString::npos 
)

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
theSubstring target string
theStartIndex starting index, inclusive
theEndIndex ending index, exclusive
const char* toCharArray ( const CharVectorType theString  )  [inline]

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

Deprecated:
This function is deprecated.
Parameters:
theString target string
Returns:
the pointer

Definition at line 204 of file DOMStringHelper.hpp.

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

Get the underlying representation of a XalanDOMChar.

Deprecated:
This function is deprecated.
Parameters:
theString target string
Returns:
array of XalanDOMChar

Definition at line 187 of file DOMStringHelper.hpp.

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

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

Deprecated:
This function is deprecated.
Parameters:
theString target string
Returns:
array of XalanDOMChar

Definition at line 171 of file DOMStringHelper.hpp.

XalanDOMChar toLowerASCII ( XalanDOMChar  theChar  )  [inline]

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

Definition at line 1537 of file DOMStringHelper.hpp.

toLowerCaseASCII ( XalanDOMString theString  ) 

Converts ASCII alphabetic characters from upper case to lower case.

This function works only with the characters a-z and A-Z.

Parameters:
theString The string to convert
Returns:
A reference to theString
toLowerCaseASCII ( const XalanDOMString theString,
XalanDOMString theResult 
)

Converts ASCII alphabetic characters from upper case to lower case.

This function works only with the characters a-z and A-Z.

Parameters:
theString The source string
theResult The target string
Returns:
A reference to theResult
toLowerCaseASCII ( const XalanDOMChar *  theString,
XalanDOMString theResult 
)

Converts ASCII alphabetic characters from upper case to lower case.

This function works only with the characters a-z and A-Z.

Parameters:
theString The source string
theResult The target string
Returns:
A reference to theResult
XalanDOMChar toUpperASCII ( XalanDOMChar  theChar  )  [inline]

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

Definition at line 1560 of file DOMStringHelper.hpp.

toUpperCaseASCII ( XalanDOMString theString  ) 

Converts ASCII alphabetic characters from lower case to upper case.

This function works only with the characters a-z and A-Z.

Parameters:
theString The string to convert
Returns:
A reference to theString
toUpperCaseASCII ( const XalanDOMString theString,
XalanDOMString theResult 
)

Converts ASCII alphabetic characters from lower case to upper case.

This function works only with the characters a-z and A-Z.

Parameters:
theString The source string
theResult The target string
Returns:
A reference to theResult
toUpperCaseASCII ( const XalanDOMChar *  theString,
XalanDOMString theResult 
)

Converts ASCII alphabetic characters from lower case to upper case.

This function works only with the characters a-z and A-Z.

Parameters:
theString The source string
theResult The target string
Returns:
A reference to theResult
trim ( const XalanDOMString theString,
XalanDOMString theResult 
)

Remove leading and trailing whitespace.

Parameters:
theString The string to trim.
theResult The result string.
Returns:
A reference to theResult.
WideStringToDouble ( const XalanDOMChar *  theString,
MemoryManager &  theMemoryManager 
)

Converts a wide string into a double value.

Parameters:
theString target string
theMemoryManager The MemoryManager instance to use.
Returns:
double value of target string
WideStringToInt ( const XalanDOMChar *  theString  ) 

Converts a wide string into an integer value.

Parameters:
theString target string
Returns:
integer value of target string
WideStringToLong ( const XalanDOMChar *  theString  ) 

Converts a wide string into a long value.

Parameters:
theString target string
Returns:
long value of target string
WideStringToUnsignedLong ( const XalanDOMChar *  theString  ) 

Converts a wide string into an unsigned long value.

Parameters:
theString target string
Returns:
unsigned long value of target string
template<class InputIteratorType , class OutputIteratorType >
OutputIteratorType XalanCopy ( InputIteratorType  begin,
InputIteratorType  end,
OutputIteratorType  iterator 
) [inline]

Definition at line 70 of file DOMStringHelper.hpp.

template<class InputIteratorType , class OutputIteratorType , class UnaryFunction >
OutputIteratorType XalanTransform ( InputIteratorType  begin,
InputIteratorType  end,
OutputIteratorType  iterator,
UnaryFunction  function 
) [inline]

Definition at line 82 of file DOMStringHelper.hpp.

Interpreting class diagrams

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

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

Apache Logo