Xalan-C++ API Documentation

The Xalan-C++ XSL Transformer Version 1.0

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

DOMStringHelper.hpp File Reference

Include dependency graph for DOMStringHelper.hpp:

Go to the source code of this file.

Compounds

Defines

Typedefs

Functions


Define Documentation

#define DOMSTRINGHELPER_HEADER_GUARD_1357924680

#define XALAN_STATIC_UCODE_STRING( str)   initializeAndTranscode(str)


Typedef Documentation

typedef std::vector<char> CharVectorType

typedef std::vector<XalanDOMChar> XalanDOMCharVectorType


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

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 CharVectorType TranscodeToLocalCodePage ( const XalanDOMString & sourceString)

Convert XalanDOMString to C++ standard library vector, transcoding to the default local code page.

Parameters:
theSourceString   source string
Returns:
The transcoded string.

bool TranscodeToLocalCodePage ( const XalanDOMString & sourceString,
CharVectorType & targetVector,
bool terminate = false)

Convert XalanDOMString to C++ standard library vector, transcoding to the default local code page.

Parameters:
sourceString   The source string
targetVector   The target string
Returns:
true if successful, false if not.

const CharVectorType TranscodeToLocalCodePage ( const XalanDOMChar * sourceString)

Convert XalanDOMString to C++ standard library vector, transcoding to the default local code page.

Null-terminate the sttring...

Parameters:
theSourceString   source string
Returns:
The transcoded string.

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   target 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:
theDouble   number to be converted
Returns:
decimal string representation of the number

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

XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION ( const XalanDOMString) const

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

Concatenate two strings.

Parameters:
theString   target string
theStringToAppend   string to add to target
Returns:
string with contents of 'theStringToAppend' added to 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 XalanDOMCharVectorType & theVector)

Get a pointer to the first element of the vector as a null-terminated string.

Parameters:
theSVector   target vector
Returns:
null-terminated string of XalanDOMChar

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

XalanDOMString clone ( const XalanDOMString & theString)

Creates a copy of the target string.

Parameters:
theString   target string
Returns:
copy of string

int collationCompare ( const XalanDOMCharVectorType & theLHS,
const XalanDOMCharVectorType & theRHS)

Compare the contents of two vectors using the the collation settings of the current code page.

Parameters:
theLHS   first vector to compare
theRHS   second vector to compare
Returns:
Returns 0 for equal vectors, 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)

int compare ( const XalanDOMCharVectorType & theLHS,
const XalanDOMCharVectorType & theRHS)

Compare the contents of two XalanDOMCharVectorTypes.

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

int compareIgnoreCase ( const XalanDOMCharVectorType & theLHS,
const XalanDOMCharVectorType & theRHS)

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

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

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 XalanDOMString & theLHS,
const XalanDOMCharVectorType & theRHS)

Compare the contents of a XalanDOMString and a XalanDOMCharVectorType for equality.

Parameters:
theLHS   XalanDOMString to compare
theRHS   XalanDOMCharVectorType to compare
Returns:
true if the contents of both are identical

bool equals ( const XalanDOMCharVectorType & theLHS,
const XalanDOMString & theRHS)

Compare the contents of a XalanDOMCharVectorType and a XalanDOMString for equality.

Parameters:
theLHS   XalanDOMCharVectorType to compare
theRHS   XalanDOMString to compare
Returns:
true if the contents of both are identical

bool equals ( const XalanDOMChar * theLHS,
const XalanDOMCharVectorType & theRHS)

Compare the contents of two strings for equality.

Parameters:
theLHS   string to compare
theRHS   XalanDOMCharVectorType to compare
Returns:
true if the contents are identical

bool equals ( const XalanDOMCharVectorType & theLHS,
const XalanDOMChar * theRHS)

Compare the contents of two strings for equality.

Parameters:
theLHS   XalanDOMCharVectorType to compare
theRHS   string to compare
Returns:
true if the contents of are identical

bool equals ( const XalanDOMCharVectorType & theLHS,
const XalanDOMCharVectorType & theRHS)

Compare the contents of two vectors for equality.

Parameters:
theLHS   first vector to compare
theRHS   second vector to compare
Returns:
true if the contents of both vectors 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 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 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 XalanDOMChar * theLHS,
const XalanDOMChar * theRHS)

Initial value:

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

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,
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.

bool isDigit ( XalanDOMChar theChar)

Determines whether character represents a digit.

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

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 isLetterOrDigit ( XalanDOMChar theChar)

Determines whether character represents a letter or digit.

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

bool isSpace ( 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 XalanDOMChar * theBuffer)

Simulates the java String method length() for a null-terminated buffer of XalanDOMChar characters.

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

unsigned int length ( const XalanDOMString & theString)

Simulates the java String method length() for a XalanDOMString.

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

bool operator< ( const XalanDOMCharVectorType & theLHS,
const XalanDOMCharVectorType & theRHS)

Implements operator< for XalanDOMCharVectorType.

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

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 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 & theDOMString,
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 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

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.0
Copyright © 2000 The Apache Software Foundation. All Rights Reserved.