You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xalan.apache.org by jd...@locus.apache.org on 2000/02/23 21:23:13 UTC
cvs commit: xml-xalan/c/src/PlatformSupport AttributeListImpl.hpp Cloneable.hpp DOMStringHelper.hpp DOMStringPrintWriter.hpp DecimalFormat.hpp DecimalFormatSymbols.hpp DirectoryEnumerator.hpp DoubleSupport.hpp ExecutionContext.hpp Factory.hpp PrintWriter.hpp StringTokenizer.hpp Writer.hpp XSLException.hpp
jdonohue 00/02/23 12:23:13
Modified: c/src/DOMSupport DOMServices.hpp DOMSupport.hpp
DOMSupportException.hpp NSInfo.hpp
NamespaceResolver.hpp TreeWalker.hpp
UnimplementedDocument.hpp
UnimplementedDocumentFragment.hpp
UnimplementedElement.hpp UnimplementedNode.hpp
c/src/PlatformSupport AttributeListImpl.hpp Cloneable.hpp
DOMStringHelper.hpp DOMStringPrintWriter.hpp
DecimalFormat.hpp DecimalFormatSymbols.hpp
DirectoryEnumerator.hpp DoubleSupport.hpp
ExecutionContext.hpp Factory.hpp PrintWriter.hpp
StringTokenizer.hpp Writer.hpp XSLException.hpp
Log:
Added javadoc comments
Revision Changes Path
1.4 +27 -0 xml-xalan/c/src/DOMSupport/DOMServices.hpp
Index: DOMServices.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/DOMSupport/DOMServices.hpp,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- DOMServices.hpp 2000/01/26 20:29:56 1.3
+++ DOMServices.hpp 2000/02/23 20:23:09 1.4
@@ -107,16 +107,33 @@
* Tell if the node is ignorable whitespace.
* This should be in the DOM. Return false if the
* parser doesn't handle this.
+ *
+ * @param node text node queried
+ * @return true if white space can be ignored
*/
+
virtual bool
isIgnorableWhitespace(const DOM_Text& node) const = 0;
};
+ /**
+ * Retrieves data for node
+ *
+ * @param node DOM node whose data is to be returned
+ * @param theResolver $$$
+ * @return a string representation of the node's data
+ */
static DOMString
getNodeData(
const DOM_Node& node,
const WhitespaceSupport& theResolver);
+ /**
+ * Retrieve local name of node
+ *
+ * @param node DOM node whose name is returned
+ * @return name of node without namespace
+ */
static DOMString
getLocalNameOfNode(const DOM_Node& n);
@@ -125,10 +142,20 @@
* because the DOM WG decided that attributes don't
* have parents. If this function is used with a DOM implementation
* that reuses attribute nodes, this will not work correctly.
+ *
+ * @param node child node
+ * @return parent node
*/
static DOM_Node
getParentOfNode(const DOM_Node& node);
+ /**
+ * Retrieve the URI corresponding to a namespace prefix
+ *
+ * @param prefix prefix for a namespace
+ * @param namespaceContext DOM element representing the context for namespace
+ * @return URI corresponding to namespace
+ */
static DOMString
getNamespaceForPrefix(
const DOMString& prefix,
1.2 +18 -0 xml-xalan/c/src/DOMSupport/DOMSupport.hpp
Index: DOMSupport.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/DOMSupport/DOMSupport.hpp,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DOMSupport.hpp 1999/12/18 19:47:47 1.1
+++ DOMSupport.hpp 2000/02/23 20:23:09 1.2
@@ -95,12 +95,30 @@
// These interfaces are new to DOMSupport...
+ /**
+ * Retrieve namespace corresponding to a DOM node
+ *
+ * @param theNode DOM node whose namespace is queried
+ * @return namespace corresponding to 'theNode'
+ */
virtual DOMString
getNamespaceOfNode(const DOM_Node& theNode) const = 0;
+ /**
+ * Retrieves expanded name of a DOM element, including namespace
+ *
+ * @param elem DOM element queried
+ * @return expanded name corresponding to 'elem'
+ */
virtual DOMString
getExpandedElementName(const DOM_Element& elem) const = 0;
+ /**
+ * Retrieves expanded name of a DOM attribute, including namespace
+ *
+ * @param attr DOM attribute queried
+ * @return expanded name corresponding to 'attr'
+ */
virtual DOMString
getExpandedAttributeName(const DOM_Attr& attr) const = 0;
};
1.2 +6 -2 xml-xalan/c/src/DOMSupport/DOMSupportException.hpp
Index: DOMSupportException.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/DOMSupport/DOMSupportException.hpp,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DOMSupportException.hpp 1999/12/18 19:47:47 1.1
+++ DOMSupportException.hpp 2000/02/23 20:23:09 1.2
@@ -77,8 +77,12 @@
{
public:
- explicit
- DOMSupportException(
+ /**
+ * Constructor for an exception arising from DOMSupport classes
+ *
+ * @param message error message
+ */
+ explicit DOMSupportException(
const DOMString& message = DOMString());
virtual
1.2 +20 -2 xml-xalan/c/src/DOMSupport/NSInfo.hpp
Index: NSInfo.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/DOMSupport/NSInfo.hpp,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- NSInfo.hpp 1999/12/18 19:47:47 1.1
+++ NSInfo.hpp 2000/02/23 20:23:09 1.2
@@ -82,8 +82,13 @@
ANCESTORNOXMLNS };
- explicit
- NSInfo(bool hasProcessedNS = false,
+ /**
+ * Constructor for NSInfo class, for storing namespace data
+ *
+ * @param hasProcessedNS $$$
+ * @param hasXMLNSAttrs $$$
+ */
+ explicit NSInfo(bool hasProcessedNS = false,
bool hasXMLNSAttrs = false) :
m_hasProcessedNS(hasProcessedNS),
m_hasXMLNSAttrs(hasXMLNSAttrs),
@@ -93,6 +98,13 @@
};
// Unused at the moment
+ /**
+ * Constructor for NSInfo class, for storing namespace data
+ *
+ * @param hasProcessedNS $$$
+ * @param hasXMLNSAttrs $$$
+ * @param eHasXMLNSAttrs $$$
+ */
NSInfo(bool hasProcessedNS,
bool hasXMLNSAttrs,
eHasXMLNSAttrs ancestorHasXMLNSAttrs) :
@@ -103,6 +115,12 @@
{
};
+ /**
+ * Constructor for NSInfo class, for storing namespace data
+ *
+ * @param theNamespace namespace
+ * @param hasXMLNSAttrs $$$
+ */
NSInfo(DOMString theNamespace,
bool hasXMLNSAttrs) :
m_hasProcessedNS(true),
1.3 +6 -0 xml-xalan/c/src/DOMSupport/NamespaceResolver.hpp
Index: NamespaceResolver.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/DOMSupport/NamespaceResolver.hpp,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- NamespaceResolver.hpp 2000/02/17 20:26:38 1.2
+++ NamespaceResolver.hpp 2000/02/23 20:23:09 1.3
@@ -98,6 +98,12 @@
// These interfaces are new to NamespaceResolver...
+ /**
+ * Retrieves the namespace corresponding to a DOM node
+ *
+ * @param theNode DOM node
+ * @return namespace of 'theNode'
+ */
virtual DOMString
getNamespaceOfNode(const DOM_Node& theNode) const;
1.2 +6 -0 xml-xalan/c/src/DOMSupport/TreeWalker.hpp
Index: TreeWalker.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/DOMSupport/TreeWalker.hpp,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- TreeWalker.hpp 1999/12/18 19:47:47 1.1
+++ TreeWalker.hpp 2000/02/23 20:23:09 1.2
@@ -82,12 +82,18 @@
/**
* Perform a pre-order traversal non-recursive style.
+ *
+ * @param pos starting node $$$
*/
+
virtual void
traverse(const DOM_Node& pos);
/**
* Perform a pre-order traversal non-recursive style.
+ *
+ * @param pos starting node $$$
+ * @param parent parent node $$$
*/
virtual void
traverse(
1.5 +0 -2 xml-xalan/c/src/DOMSupport/UnimplementedDocument.hpp
Index: UnimplementedDocument.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/DOMSupport/UnimplementedDocument.hpp,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- UnimplementedDocument.hpp 2000/02/17 20:26:38 1.4
+++ UnimplementedDocument.hpp 2000/02/23 20:23:10 1.5
@@ -338,8 +338,6 @@
return DOM_Document::operator!=(other);
}
-protected:
-
private:
// Not implemented...
1.5 +0 -2 xml-xalan/c/src/DOMSupport/UnimplementedDocumentFragment.hpp
Index: UnimplementedDocumentFragment.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/DOMSupport/UnimplementedDocumentFragment.hpp,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- UnimplementedDocumentFragment.hpp 2000/02/17 20:26:38 1.4
+++ UnimplementedDocumentFragment.hpp 2000/02/23 20:23:10 1.5
@@ -288,8 +288,6 @@
return DOM_DocumentFragment::operator!=(other);
}
-protected:
-
private:
// Not implemented...
1.5 +15 -8 xml-xalan/c/src/DOMSupport/UnimplementedElement.hpp
Index: UnimplementedElement.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/DOMSupport/UnimplementedElement.hpp,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- UnimplementedElement.hpp 2000/02/17 20:26:38 1.4
+++ UnimplementedElement.hpp 2000/02/23 20:23:10 1.5
@@ -75,10 +75,16 @@
public:
/**
- * Constructor.
+ * Constructor
*/
UnimplementedElement(DocumentImpl* ownerDoc);
+ /**
+ * Copy constructor
+ *
+ * @param theOther source to be copied
+ * @param deep copy child nodes as well if true
+ */
UnimplementedElement(
const UnimplementedElement& theOther,
bool deep = false);
@@ -256,7 +262,7 @@
* for an extended time, when the storage belonging to the underlying
* node needs to be reclaimed.
*
- * @param val. Only a value of 0, or null, is allowed.
+ * @param val Only a value of 0, or null, is allowed.
*/
DOM_UnimplementedElement&
operator=(const DOM_NullPtr* val)
@@ -284,9 +290,10 @@
}
/**
- * Compare with a pointer. Intended only to allow a convenient
- * comparison with null.
+ * Compare with a pointer. Intended only to allow a convenient comparison
+ * with null.
*
+ * @param other null value to compare with
*/
bool
operator==(const DOM_NullPtr* other) const
@@ -297,6 +304,7 @@
/**
* The inequality operator. See operator ==.
*
+ * @param other value to compare with
*/
bool
operator!=(const DOM_Node& other) const
@@ -305,17 +313,16 @@
}
/**
- * Compare with a pointer. Intended only to allow a convenient
- * comparison with null.
+ * Compare with a pointer. Intended only to allow a convenient comparison
+ * with null.
*
+ * @param other null value to compare with
*/
bool
operator!=(const DOM_NullPtr* other) const
{
return DOM_Node::operator!=(other);
}
-
-protected:
private:
1.5 +6 -0 xml-xalan/c/src/DOMSupport/UnimplementedNode.hpp
Index: UnimplementedNode.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/DOMSupport/UnimplementedNode.hpp,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- UnimplementedNode.hpp 2000/02/17 20:26:39 1.4
+++ UnimplementedNode.hpp 2000/02/23 20:23:10 1.5
@@ -80,6 +80,12 @@
*/
UnimplementedNode(DocumentImpl* ownerDoc);
+ /**
+ * Copy constructor
+ *
+ * @param theOther source to be copied
+ * @param deep copy child nodes as well if true
+ */
UnimplementedNode(
const UnimplementedNode& theOther,
bool deep = false);
1.3 +16 -0 xml-xalan/c/src/PlatformSupport/AttributeListImpl.hpp
Index: AttributeListImpl.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/PlatformSupport/AttributeListImpl.hpp,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AttributeListImpl.hpp 2000/02/17 20:27:26 1.2
+++ AttributeListImpl.hpp 2000/02/23 20:23:11 1.3
@@ -121,14 +121,30 @@
getValue(const char* const name) const;
// The mutators are new to this class.
+
+ /**
+ * Remove all attributes from the list
+ */
virtual void
clear();
+ /**
+ * Adds an attribute to the attribute list
+ *
+ * @param name attribute name
+ * @param type attribute type, "CDATA," for example
+ * @param value attribute value
+ */
virtual bool
addAttribute(const XMLCh* const name,
const XMLCh* const type,
const XMLCh* const value);
+ /**
+ * Removes an attribute from the attribute list
+ *
+ * @param name attribute name
+ */
virtual bool
removeAttribute(const XMLCh* const name);
1.2 +2 -0 xml-xalan/c/src/PlatformSupport/Cloneable.hpp
Index: Cloneable.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/PlatformSupport/Cloneable.hpp,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Cloneable.hpp 1999/12/18 19:47:49 1.1
+++ Cloneable.hpp 2000/02/23 20:23:11 1.2
@@ -75,6 +75,8 @@
/**
* Clone the instance.
+ *
+ * @param deep clone all subobjects if true
*/
virtual Cloneable*
clone(bool deep) const = 0;
1.9 +396 -62 xml-xalan/c/src/PlatformSupport/DOMStringHelper.hpp
Index: DOMStringHelper.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/PlatformSupport/DOMStringHelper.hpp,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- DOMStringHelper.hpp 2000/02/22 17:33:31 1.8
+++ DOMStringHelper.hpp 2000/02/23 20:23:11 1.9
@@ -102,8 +102,14 @@
#endif
-// Simulates the java String method indexOf(). Returns the index of theChar
-// in theString, or -1 if the character is not found.
+/**
+ * Simulates the java String method indexOf().
+ *
+ * @param theString string to search
+ * @param theChar character searched for
+ * @return the index of theChar in theString, or -1 if the character is not
+ * found.
+ */
XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(int)
indexOf(
const DOMString& theString,
@@ -111,16 +117,28 @@
-// Simulates the java String method indexOf(). Returns the index of theSubString
-// in theString, or -1 if the string is not found.
+/**
+ * Simulates the java String method indexOf().
+ *
+ * @param theString string to search
+ * @param theSubString substring searched for
+ * @return the index of theSubString in theString, or -1 if the string is not
+ * found.
+ */
XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(int)
indexOf(
const DOMString& theString,
const DOMString& theSubString);
-// Simulates the java String method lastIndexOf(). Returns the index of theChar
-// in theString, or -1 if the character is not found.
+/**
+ * Simulates the java String method lastIndexOf().
+ *
+ * @param theString string to search
+ * @param theChar character searched for
+ * @return the index of theChar in theString, or -1 if the character is not
+ * found.
+ */
XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(int)
lastIndexOf(
const DOMString& theString,
@@ -128,6 +146,13 @@
+/**
+ * Simulates the java String method startsWith().
+ *
+ * @param theDOMString target string to search
+ * @param theSubString substring searched for
+ * @return true if the target string begins with the substring
+ */
XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(bool)
startsWith(
const DOMString& theDOMString,
@@ -135,6 +160,30 @@
+/**
+ * Simulates the java String method startsWith().
+ *
+ * @param theDOMString target string to search
+ * @param theSubString substring searched for
+ * @return true if the target string begins with the substring
+ */
+inline bool
+startsWith(
+ const DOMString& theDOMString,
+ const char* theSubString)
+{
+ return startsWith(theDOMString,
+ DOMString(theSubString));
+}
+
+
+/**
+ * Simulates the java String method endsWith().
+ *
+ * @param theDOMString target string to search
+ * @param theSubString substring searched for
+ * @return true if the target string ends with the substring
+ */
XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(bool)
endsWith(
const DOMString& theDOMString,
@@ -142,6 +191,12 @@
+/**
+ * Simulates the java String method length() for a DOMString
+ *
+ * @param theDOMString target string
+ * @return the length of the target string
+ */
inline unsigned int
length(const DOMString& theString)
{
@@ -150,6 +205,13 @@
+/**
+ * Simulates the java String method length() for a null-terminated buffer of
+ * XMLCh characters
+ *
+ * @param theBuffer target string
+ * @return the length of the target string
+ */
inline unsigned int
length(const XMLCh* theBuffer)
{
@@ -167,6 +229,12 @@
+/**
+ * Determines if the target string contains any elements
+ *
+ * @param str target string
+ * @return true if the target string has a non-zero length
+ */
inline bool
isEmpty(const DOMString& str)
{
@@ -175,55 +243,122 @@
-inline bool
-startsWith(
- const DOMString& theDOMString,
- const char* theSubString)
-{
- return startsWith(theDOMString,
- DOMString(theSubString));
-}
+/**
+ * Converts a double value into a DOMString
+ *
+ * @param theDouble number to be converted
+ * @return decimal string representation of the number
+ */
+XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(DOMString)
+DoubleToDOMString(double theDouble);
-XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(void)
-OutputString(
- TextOutputStream& theStream,
- const DOMString& theString);
+/**
+ * Converts a long value into a DOMString
+ *
+ * @param theInt number to be converted
+ * @return hexadecimal string representation of the number
+ */
+XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(DOMString)
+LongToHexDOMString(long theInt);
-XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(void)
-OutputString(
-#if defined(XALAN_NO_NAMESPACES)
- ostream& theStream,
-#else
- std::ostream& theStream,
-#endif
- const DOMString& theString);
+/**
+ * Converts a long value into a DOMString
+ *
+ * @param theInt number to be converted
+ * @return decimal string representation of the number
+ */
+XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(DOMString)
+LongToDOMString(long theInt);
+
+/**
+ * Converts an unsigned long value into a DOMString
+ *
+ * @param theInt number to be converted
+ * @return decimal string representation of the number
+ */
XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(DOMString)
-DoubleToDOMString(double theDouble);
+UnsignedLongToDOMString(unsigned long theInt);
-XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(DOMString)
-LongToHexDOMString(long theInt);
+/**
+ * Converts a DOMString into an integer value
+ *
+ * @param theString target string
+ * @return integer value of target string
+ */
+XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(int)
+DOMStringToInt(const DOMString& theString);
-XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(DOMString)
-LongToDOMString(long theInt);
+/**
+ * Converts a DOMString into a long value
+ *
+ * @param theString target string
+ * @return long value of target string
+ */
+XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(long)
+DOMStringToLong(const DOMString& theString);
-XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(DOMString)
-UnsignedLongToDOMString(unsigned long theInt);
+/**
+ * Converts a DOMString into a double value
+ *
+ * @param theString target string
+ * @return double value of target string
+ */
+XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(double)
+DOMStringToDouble(const DOMString& theString);
+
+
+/**
+ * Outputs the target string to the specified stream
+ *
+ * @param theStream output stream
+ * @param theString target string
+ * @see operator<<
+ */
+XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(void)
+OutputString(
+ TextOutputStream& theStream,
+ const DOMString& theString);
+/**
+ * Outputs the target string to the specified stream
+ *
+ * @param theStream output stream
+ * @param theString target string
+ * @see operator<<
+ */
+XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(void)
+OutputString(
+#if defined(XALAN_NO_NAMESPACES)
+ ostream& theStream,
+#else
+ std::ostream& theStream,
+#endif
+ const DOMString& theString);
+
+
+
+/**
+ * Outputs the target string to the specified stream
+ *
+ * @param theStream output stream
+ * @param theString target string
+ * @see OutputString
+ */
inline TextOutputStream&
operator<<(
TextOutputStream& theStream,
@@ -237,6 +372,13 @@
+/**
+ * Outputs the target string to the specified stream
+ *
+ * @param theStream output stream
+ * @param theString target string
+ * @see OutputString
+ */
#if defined(XALAN_NO_NAMESPACES)
inline ostream&
#else
@@ -254,6 +396,12 @@
+/**
+ * Creates a copy of the target string
+ *
+ * @param theString target string
+ * @return copy of string
+ */
inline DOMString
clone(const DOMString& theString)
{
@@ -262,6 +410,12 @@
+/**
+ * Determines whether character represents white space
+ *
+ * @param theChar target character
+ * @return true if character represents white space
+ */
inline bool
isSpace(XMLCh theChar)
{
@@ -270,6 +424,13 @@
+/**
+ * Retrieves a character at a specified index in the target string
+ *
+ * @param theString target string
+ * @param theIndex index of character
+ * @return character at specified index
+ */
inline XMLCh
charAt(
const DOMString& theString,
@@ -280,6 +441,12 @@
+/**
+ * Determines whether character represents a digit
+ *
+ * @param theChar target character
+ * @return true if character represents a digit
+ */
inline bool
isDigit(XMLCh theChar)
{
@@ -288,6 +455,12 @@
+/**
+ * Determines whether character represents a letter or digit
+ *
+ * @param theChar target character
+ * @return true if character represents a letter or digit
+ */
inline bool
isLetterOrDigit(XMLCh theChar)
{
@@ -296,6 +469,17 @@
+/**
+ * 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.
+ *
+ * @param theString target string
+ * @param theStartIndex starting index, inclusive
+ * @param theEndIndex ending index, exclusive
+ * @return string containing the specified range of characters from target
+ */
inline DOMString
substring(
const DOMString& theString,
@@ -325,30 +509,30 @@
+/**
+ * Simulates the java String method toLowerCase(). Returns a new string
+ * containing only lower case characters of target string.
+ *
+ * @param theString target string
+ * @return string containing lower case characters
+ */
XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(DOMString)
toLowerCase(const DOMString& theString);
+/**
+ * Simulates the java String method toUpperCase(). Returns a new string
+ * containing only upper case characters of target string.
+ *
+ * @param theString target string
+ * @return string containing upper case characters
+ */
XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(DOMString)
toUpperCase(const DOMString& theString);
-XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(int)
-DOMStringToInt(const DOMString& theString);
-
-
-
-XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(long)
-DOMStringToLong(const DOMString& theString);
-
-
-
-XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(double)
-DOMStringToDouble(const DOMString& theString);
-
-
// These two function are specifically not defined, and
// should produce ambiguity during compilation. This
// is necessary because the Xerces DOMString class
@@ -366,9 +550,16 @@
const DOMString& theLHS,
const DOMString& theRHS);
+
+
-// Get the underlying representation of the wide string.
-// returns a null-terminated string
+/**
+ * Get the underlying representation of the target DOMString as a
+ * null-terminated string
+ *
+ * @param theString target string
+ * @return null-terminated string of XMLCh
+ */
inline const XMLCh*
c_wstr(const DOMString& theString)
{
@@ -380,7 +571,13 @@
}
-// not guaranteed to be null-terminated
+/**
+ * Get the underlying representation of the target DOMString as an array of
+ * XMLCh, not guaranteed to be null-terminated.
+ *
+ * @param theString target string
+ * @return array of XMLCh
+ */
inline const XMLCh*
toCharArray(const DOMString& theString)
{
@@ -389,6 +586,13 @@
+/**
+ * Get the underlying representation of the target DOMString as an array of
+ * XMLCh, not guaranteed to be null-terminated.
+ *
+ * @param theString target string
+ * @return array of XMLCh
+ */
inline XMLCh*
toCharArray(DOMString& theString)
{
@@ -397,12 +601,26 @@
+/**
+ * Compare the contents of two strings for equality
+ *
+ * @param theLHS first string to compare
+ * @param theRHS second string to compare
+ * @return true if the contents of both strings are identical
+ */
XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(bool)
equals(const XMLCh* theLHS,
const XMLCh* theRHS);
+/**
+ * Compare the contents of two strings for equality
+ *
+ * @param theLHS first string to compare
+ * @param theRHS second string to compare
+ * @return true if the contents of both strings are identical
+ */
inline bool
equals(const XMLCh* theLHS,
const DOMString& theRHS)
@@ -412,6 +630,13 @@
+/**
+ * Compare the contents of two strings for equality
+ *
+ * @param theLHS first string to compare
+ * @param theRHS second string to compare
+ * @return true if the contents of both strings are identical
+ */
inline bool
equals(const DOMString& theLHS,
const XMLCh* theRHS)
@@ -421,6 +646,13 @@
+/**
+ * Compare the contents of two strings for equality
+ *
+ * @param theLHS first string to compare
+ * @param theRHS second string to compare
+ * @return true if the contents of both strings are identical
+ */
inline bool
equals(const DOMString& theLHS,
const char* theRHS)
@@ -430,6 +662,13 @@
+/**
+ * Compare the contents of two strings for equality
+ *
+ * @param theLHS first string to compare
+ * @param theRHS second string to compare
+ * @return true if the contents of both strings are identical
+ */
inline bool
equals(
const DOMString& theLHS,
@@ -440,6 +679,13 @@
+/**
+ * Compare the contents of two strings for equality, without regard for case
+ *
+ * @param theLHS first string to compare
+ * @param theRHS second string to compare
+ * @return true if the case-insensitive contents of both strings are identical
+ */
XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(bool)
equalsIgnoreCase(
const DOMString& theLHS,
@@ -447,9 +693,16 @@
-// Returns 0 for equal strings, less than 0 if theLHS
-// is less than theRHS, or greater than 0 if theRHS
-// is greater than theLHS.
+/**
+ * Compare the contents of two strings for equality
+ *
+ * @param theLHS first string to compare
+ * @param theRHS second string to compare
+ * @return Returns 0 for equal strings, less than 0 if theLHS is lexically
+ * less than theRHS, or greater than 0 if theRHS is lexically greater than
+ * theLHS.
+ * @see operator<
+ */
XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(int)
compare(
const DOMString& theLHS,
@@ -457,6 +710,15 @@
+/**
+ * Compare the contents of two strings for equality
+ *
+ * @param theLHS first string to compare
+ * @param theRHS second string to compare
+ * @return Returns true if theLHS is lexically
+ * less than theRHS
+ * @see compare
+ */
inline bool
operator<(
const DOMString& theLHS,
@@ -467,6 +729,13 @@
+/**
+ * Concatenate two strings
+ *
+ * @param theString target string
+ * @param theStringToAppend string to add to target
+ * @return string with contents of 'theStringToAppend' added to target string
+ */
inline DOMString&
append(
DOMString& theString,
@@ -479,11 +748,22 @@
+/**
+ * Remove trailing whitespace
+ *
+ * @param theString target string
+ * @return string with contents of target string less trailing whitespace
+ */
XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(DOMString)
trim(const DOMString& theString);
+/**
+ * Remove all elements from target string
+ *
+ * @param theString target string
+ */
inline void
clear(DOMString& theString)
{
@@ -492,6 +772,13 @@
+/**
+ * Replaces a character at a specified index in a DOMString
+ *
+ * @param theString target string
+ * @param theIndex index of character
+ * @param theChar target character
+ */
inline void
setCharAt(
DOMString& theString,
@@ -515,22 +802,40 @@
#endif
+
+
-// Utility function to make a 0-terminated vector of XMLChs, from
-// a 0-terminated array chars, via transcoding.
+/**
+ * Utility function to make a null-terminated vector of XMLChs, from a
+ * null-terminated array of chars, via transcoding.
+ *
+ * @param data array to be converted
+ * @return null-terminated vector of XMLCh
+ */
XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(XMLCharVectorType)
MakeXMLChVector(const char* data);
-// Utility function to make a 0-terminated vector of XMLChs, from
-// a 0-terminated array of them.
+/**
+ * Utility function to make a null-terminated vector of XMLChs, from a
+ * null-terminated array of XMLCh.
+ *
+ * @param data array to be converted
+ * @return null-terminated vector of XMLCh
+ */
XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(XMLCharVectorType)
MakeXMLChVector(const XMLCh* data);
-// An inline version for DOMStrings....
+/**
+ * Utility function to make a null-terminated vector of XMLChs, from a
+ * DOMString
+ *
+ * @param data DOMString to be converted
+ * @return null-terminated vector of XMLCh
+ */
inline XMLCharVectorType
MakeXMLChVector(const DOMString& data)
{
@@ -554,7 +859,12 @@
-// Hash functor for DOMStrings
+/**
+ * Hash functor for DOMStrings
+ *
+ * @param theKey DOMString to be hashed
+ * @return hash value for DOMString
+ */
#if defined(XALAN_NO_NAMESPACES)
struct DOMStringHashFunction : public unary_function<const DOMString&, size_t>
#else
@@ -584,8 +894,13 @@
-// Equals functor for DOMStrings
-// Hash functor for DOMStrings
+/**
+ * Equals functor for DOMStrings
+ *
+ * @param theLHS first string to compare
+ * @param theRHS second string to compare
+ * @return true if the contents of both strings are identical
+ */
#if defined(XALAN_NO_NAMESPACES)
struct DOMStringEqualsFunction : public binary_function<const DOMString&, const DOMString&, bool>
#else
@@ -602,6 +917,12 @@
+/**
+ * Convert DOMString to C++ standard library string
+ *
+ * @param theString target string
+ * @return C++ standard library string representation of target
+ */
#if defined(XALAN_NO_NAMESPACES)
XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(string)
#else
@@ -611,12 +932,25 @@
-//Is the string just whitespace?
+/**
+ * Determines if the string contains only whitespace
+ *
+ * @param theString target string
+ * @return true if string contains only whitespace
+ */
XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(bool)
isWhiteSpace(const DOMString& string);
+/**
+ * Determines if a range in an array contains only whitespace
+ *
+ * @param ch target array
+ * @param start starting index to examine
+ * @param length number of characters to examine
+ * @return true if specified range contains only whitespace
+ */
XALAN_PLATFORMSUPPORT_EXPORT_FUNCTION(bool)
isWhiteSpace(
const XMLCh* ch,
1.4 +1 -0 xml-xalan/c/src/PlatformSupport/DOMStringPrintWriter.hpp
Index: DOMStringPrintWriter.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/PlatformSupport/DOMStringPrintWriter.hpp,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- DOMStringPrintWriter.hpp 2000/02/22 17:33:31 1.3
+++ DOMStringPrintWriter.hpp 2000/02/23 20:23:11 1.4
@@ -92,6 +92,7 @@
{
return m_outputString;
}
+ // Output functions inherited from PrintWriter...
// Flush the stream, then check the error status.
virtual bool
1.2 +20 -0 xml-xalan/c/src/PlatformSupport/DecimalFormat.hpp
Index: DecimalFormat.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/PlatformSupport/DecimalFormat.hpp,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DecimalFormat.hpp 1999/12/18 19:47:49 1.1
+++ DecimalFormat.hpp 2000/02/23 20:23:11 1.2
@@ -78,6 +78,13 @@
{
public:
+ /**
+ * Constructor
+ *
+ * @param thePatternString string defining how output should be formatted
+ * @param theSymbols class defining the symbols used for output, for
+ * example, symbol for currency
+ */
explicit
DecimalFormat(
const DOMString& thePatternString = DOMString(),
@@ -104,12 +111,25 @@
// New for DecimalFormat...
+
+ /**
+ * Retrieve class defining symbols used for output
+ *
+ * @return class defining the symbols used for output, for example, symbol
+ * for currency
+ */
const DecimalFormatSymbols&
getDecimalFormatSymbols() const
{
return m_decimalFormatSymbols;
}
+ /**
+ * Set class defining symbols used for output
+ *
+ * @param class defining the symbols used for output, for example, symbol
+ * for currency
+ */
void
setDecimalFormatSymbols(const DecimalFormatSymbols& theDecimalFormatSymbols)
{
1.4 +143 -6 xml-xalan/c/src/PlatformSupport/DecimalFormatSymbols.hpp
Index: DecimalFormatSymbols.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/PlatformSupport/DecimalFormatSymbols.hpp,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- DecimalFormatSymbols.hpp 2000/02/17 20:27:26 1.3
+++ DecimalFormatSymbols.hpp 2000/02/23 20:23:11 1.4
@@ -85,156 +85,293 @@
DecimalFormatSymbols&
operator=(const DecimalFormatSymbols& theRHS);
+ /**
+ * Retrieve the string denoting the local currency, "$", for example
+ *
+ * @return string used for local currency
+ */
DOMString
getCurrencySymbol() const
{
return m_currencySymbol;
}
+ /**
+ * Retrieve the character used for decimal sign, '.' for example
+ *
+ * @return character used for decimal sign
+ */
XMLCh
getDecimalSeparator() const
{
return m_decimalSeparator;
}
+ /**
+ * Retrieve character used for a digit in a pattern
+ *
+ * @return character used for a digit in a pattern
+ */
XMLCh
getDigit() const
{
return m_digit;
}
+ /**
+ * Retrieve the character used for thousands separator, "," for example
+ *
+ * @return character used for thousands separator
+ */
XMLCh
getGroupingSeparator() const
{
return m_groupingSeparator;
}
+ /**
+ * Retrieve the string used to represent infinity
+ *
+ * @return string used to represent infinity
+ */
DOMString
getInfinity() const
{
return m_infinity;
}
+ /**
+ * Retrieve the international string denoting the local currency
+ *
+ * @return international string denoting the local currency
+ */
DOMString
getInternationalCurrencySymbol() const
{
return m_internationalCurrencySymbol;
}
+ /**
+ * Retrieve the character used to represent minus sign
+ *
+ * @return character used to represent minus sign
+ */
XMLCh
getMinusSign() const
{
return m_minusSign;
}
+ /**
+ * Retrieve the monetary decimal separator
+ *
+ * @return character used to separate decimal portion of currency
+ */
XMLCh
getMonetaryDecimalSeparator() const
{
return m_monetaryDecimalSeparator;
}
+ /**
+ * Retrieve the string used for a numeric value that cannot be represented
+ * as a number
+ *
+ * @return string representing "not a number" value
+ */
DOMString
getNaN() const
{
return m_NaN;
}
+ /**
+ * Retrieve the character used to separate positive and negative
+ * subpatterns in a pattern
+ *
+ * @return character used to separate positive and negative subpatterns
+ */
XMLCh
getPatternSeparator() const
{
return m_patternSeparator;
}
+ /**
+ * Retrieve the character used for percent sign, "%," for example
+ *
+ * @return character used for percent sign
+ */
XMLCh
getPercent() const
{
return m_percent;
}
+ /**
+ * Retrieve the character used for per thousand sign
+ *
+ * @return character used for per thousand sign
+ */
XMLCh
getPerMill() const
{
return m_perMill;
}
+ /**
+ * Retrieve the character used for zero
+ *
+ * @return character used for zero
+ */
XMLCh
getZeroDigit() const
{
return m_zeroDigit;
}
+ /**
+ * Sets the string denoting the local currency, "$", for example
+ *
+ * @param theCurrencySymbol symbol used for local currency
+ */
void
setCurrencySymbol(const DOMString& theCurrencySymbol)
{
m_currencySymbol = theCurrencySymbol;
}
+ /**
+ * Sets the character used for decimal sign, '.' for example
+ *
+ * @param theDecimalSeparator character used for decimal sign
+ */
void
setDecimalSeparator(XMLCh theDecimalSeparator)
{
m_decimalSeparator = theDecimalSeparator;
}
+ /**
+ * Sets the character used for a digit in a pattern
+ *
+ * @param theDigit character used for a digit in a pattern
+ */
void
setDigit(XMLCh theDigit)
{
m_digit = theDigit;
}
+ /**
+ * Sets the character used for thousands separator, "," for example
+ *
+ * @param theGroupingSeparator character used for thousands separator
+ */
+ void
+ setGroupingSeparator(XMLCh theGroupingSeparator)
+ {
+ m_groupingSeparator = theGroupingSeparator;
+ }
+
+ /**
+ * Sets the string used to represent infinity
+ *
+ * @param theInfinity string used to represent infinity
+ */
void
- setGroupingSeparator(XMLCh theGoupingSeparator)
- {
- m_groupingSeparator = theGoupingSeparator;
- }
-
- void
setInfinity(const DOMString& theInfinity)
{
m_infinity = theInfinity;
}
+ /**
+ * Sets the international string denoting the local currency
+ *
+ * @param theInternationalCurrencySymbol international string denoting the
+ * local currency
+ */
void
setInternationalCurrencySymbol(const DOMString& theInternationalCurrencySymbol)
{
m_internationalCurrencySymbol = theInternationalCurrencySymbol;
}
+ /**
+ * Sets the character used to represent minus sign
+ *
+ * @param theMinusSign character used to represent minus sign
+ */
void
setMinusSign(XMLCh theMinusSign)
{
m_minusSign = theMinusSign;
}
+ /**
+ * Sets the monetary decimal separator
+ *
+ * @param theMonetaryDecimalSeparator character used to separate decimal
+ * portion of currency
+ */
void
setMonetaryDecimalSeparator(XMLCh theMonetaryDecimalSeparator)
{
m_monetaryDecimalSeparator = theMonetaryDecimalSeparator;
}
+ /**
+ * Sets the string used for a numeric value that cannot be represented
+ * as a number
+ *
+ * @param theNaN string representing "not a number" value
+ */
void
setNaN(const DOMString& theNaN)
{
m_NaN = theNaN;
}
+ /**
+ * Sets the character used to separate positive and negative subpatterns in
+ * a pattern
+ *
+ * @param thePatternSeparator character used to separate positive and
+ * negative subpatterns
+ */
void
setPatternSeparator(XMLCh thePatternSeparator)
{
m_patternSeparator = thePatternSeparator;
}
+ /**
+ * Sets the character used for percent sign, "%," for example
+ *
+ * @param thePercent character used for percent sign
+ */
void
setPercent(XMLCh thePercent)
{
m_percent = thePercent;
}
+ /**
+ * Sets the character used for per thousand sign
+ *
+ * @param thePerMill character used for per thousand sign
+ */
void
setPerMill(XMLCh thePerMill)
{
m_perMill = thePerMill;
}
+ /**
+ * Sets the character used for zero
+ *
+ * @param theZeroDigit character used for zero
+ */
void
setZeroDigit(XMLCh theZeroDigit)
{
1.5 +22 -115 xml-xalan/c/src/PlatformSupport/DirectoryEnumerator.hpp
Index: DirectoryEnumerator.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/PlatformSupport/DirectoryEnumerator.hpp,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- DirectoryEnumerator.hpp 2000/02/22 17:33:31 1.4
+++ DirectoryEnumerator.hpp 2000/02/23 20:23:11 1.5
@@ -92,8 +92,6 @@
class FindFileStruct : public _wfinddata_t
{
-public:
-
enum eAttributes
{
eAttributeArchive = _A_ARCH,
@@ -104,47 +102,30 @@
eSystem = _A_SYSTEM
};
+public:
+
+ /**
+ * Retrieve name of file
+ *
+ * @return file name
+ */
const XMLCh*
getName() const
{
return name;
}
-
- bool
- isArchive() const
- {
- return attrib & eAttributeArchive ? true : false;
- }
+ /**
+ * Determine whether file is a directory
+ *
+ * @return true if file is a directory
+ */
bool
isDirectory() const
{
return attrib & eAttributeDirectory ? true : false;
}
- bool
- isHidden() const
- {
- return attrib & eAttributeHidden ? true : false;
- }
-
- bool
- isNormal() const
- {
- return attrib == eAttributeNormal ? true : false;
- }
-
- bool
- isReadOnly() const
- {
- return attrib & eReadOnly ? true : false;
- }
-
- bool
- isSystem() const
- {
- return attrib & eSystem ? true : false;
- }
};
@@ -154,11 +135,21 @@
{
public:
+ /**
+ * Retrieve name of file
+ *
+ * @return file name
+ */
const char* getName() const
{
return d_name;
}
+ /**
+ * Determine whether file is a directory
+ *
+ * @return true if file is a directory
+ */
bool isDirectory() const
{
return d_type == DT_DIR;
@@ -185,78 +176,6 @@
};
-// Only defined for Windows platform thus far
-
-#if defined(_MSC_VER)
-
-
-#if defined(XALAN_NO_NAMESPACES)
-struct ArchiveFileFilterPredicate : public unary_function<FindFileStruct, bool>
-#else
-struct ArchiveFileFilterPredicate : public std::unary_function<FindFileStruct, bool>
-#endif
-{
- result_type
- operator()(const argument_type& theFindData) const
- {
- return theFindData.isArchive();
- }
-};
-
-#if defined(XALAN_NO_NAMESPACES)
-struct HiddenFileFilterPredicate : public unary_function<FindFileStruct, bool>
-#else
-struct HiddenFileFilterPredicate : public std::unary_function<FindFileStruct, bool>
-#endif
-{
- result_type
- operator()(const argument_type& theFindData) const
- {
- return theFindData.isHidden();
- }
-};
-
-#if defined(XALAN_NO_NAMESPACES)
-struct NormalFileFilterPredicate : public unary_function<FindFileStruct, bool>
-#else
-struct NormalFileFilterPredicate : public std::unary_function<FindFileStruct, bool>
-#endif
-{
- result_type
- operator()(const argument_type& theFindData) const
- {
- return theFindData.isNormal();
- }
-};
-
-#if defined(XALAN_NO_NAMESPACES)
-struct ReadOnlyFileFilterPredicate : public unary_function<FindFileStruct, bool>
-#else
-struct ReadOnlyFileFilterPredicate : public std::unary_function<FindFileStruct, bool>
-#endif
-{
- result_type
- operator()(const argument_type& theFindData) const
- {
- return theFindData.isReadOnly();
- }
-};
-
-#if defined(XALAN_NO_NAMESPACES)
-struct SystemFileFilterPredicate : public unary_function<FindFileStruct, bool>
-#else
-struct SystemFileFilterPredicate : public std::unary_function<FindFileStruct, bool>
-#endif
-{
- result_type
- operator()(const argument_type& theFindData) const
- {
- return theFindData.isSystem();
- }
-};
-
-#endif // defined(_MSC_VER)
-
#if defined(XALAN_NO_NAMESPACES)
@@ -268,21 +187,9 @@
result_type
operator()(const argument_type& theFindData) const
{
-#if defined(_MSC_VER)
DirectoryFilterPredicate theDirectoryPredicate;
- ArchiveFileFilterPredicate theArchivePredicate;
- NormalFileFilterPredicate theNormalPredicate;
- ReadOnlyFileFilterPredicate theReadOnlyPredicate;
-
- return !theDirectoryPredicate(theFindData)
- && (theArchivePredicate(theFindData) ||
- theNormalPredicate(theFindData) ||
- theReadOnlyPredicate(theFindData));
-#else
- DirectoryFilterPredicate theDirectoryPredicate;
return !theDirectoryPredicate(theFindData);
-#endif
}
};
1.2 +35 -0 xml-xalan/c/src/PlatformSupport/DoubleSupport.hpp
Index: DoubleSupport.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/PlatformSupport/DoubleSupport.hpp,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DoubleSupport.hpp 1999/12/18 19:47:49 1.1
+++ DoubleSupport.hpp 2000/02/23 20:23:11 1.2
@@ -72,6 +72,13 @@
// values. It seems that under the IA32 architecture, NaN will compare
// as equal to any number, which is a big problem. Hence these helper
// functions.
+
+ /**
+ * Determine if target is not a number
+ *
+ * @param theNumber target number
+ * @return true if target represents the "not a number" value
+ */
static bool
isNaN(double theNumber)
{
@@ -90,6 +97,12 @@
#endif
}
+ /**
+ * Determine if target is positive infinity
+ *
+ * @param theNumber target number
+ * @return true if target represents the value for positive infinity
+ */
static bool
isPositiveInfinity(double theNumber)
{
@@ -100,6 +113,12 @@
#endif
}
+ /**
+ * Determine if target is negative infinity
+ *
+ * @param theNumber target number
+ * @return true if target represents the value for negative infinity
+ */
static bool
isNegativeInfinity(double theNumber)
{
@@ -114,18 +133,34 @@
// be used to do equality comparisons, as == may fail on
// some platforms.
//
+
+ /**
+ * Double value that represents "not a number"
+ *
+ * @return "not a number" value
+ */
static double
getNaN()
{
return s_NaN;
}
+ /**
+ * Double value that represents positive infinity
+ *
+ * @return positive infinity value
+ */
static double
getPositiveInfinity()
{
return s_positiveInfinity;
}
+ /**
+ * Double value that represents negative infinity
+ *
+ * @return negative infinity value
+ */
static double
getNegativeInfinity()
{
1.2 +14 -4 xml-xalan/c/src/PlatformSupport/ExecutionContext.hpp
Index: ExecutionContext.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/PlatformSupport/ExecutionContext.hpp,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ExecutionContext.hpp 2000/01/24 20:25:22 1.1
+++ ExecutionContext.hpp 2000/02/23 20:23:11 1.2
@@ -83,8 +83,11 @@
~ExecutionContext();
/**
- * Tell the user of an error, and probably throw an
- * exception.
+ * Tell the user of an error, and probably throw an exception.
+ *
+ * @param msg text of message to output
+ * @param sourceNode node in source where error occurred
+ * @param styleNode node in stylesheet where error occurred
*/
virtual void
error(
@@ -93,8 +96,11 @@
const DOM_Node& styleNode = DOM_Node()) const = 0;
/**
- * Tell the user of an warning, and probably throw an
- * exception.
+ * Tell the user of an warning, and probably throw an exception.
+ *
+ * @param msg text of message to output
+ * @param sourceNode node in source where error occurred
+ * @param styleNode node in stylesheet where error occurred
*/
virtual void
warn(
@@ -104,6 +110,10 @@
/**
* Output a message.
+ *
+ * @param msg text of message to output
+ * @param sourceNode node in source where error occurred
+ * @param styleNode node in stylesheet where error occurred
*/
virtual void
message(
1.3 +6 -1 xml-xalan/c/src/PlatformSupport/Factory.hpp
Index: Factory.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/PlatformSupport/Factory.hpp,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Factory.hpp 2000/02/17 20:27:26 1.2
+++ Factory.hpp 2000/02/23 20:23:11 1.3
@@ -99,9 +99,14 @@
// These interfaces are new...
/*
- * Return an object to the factory.
*
*/
+ /**
+ * Return an object to the factory.
+ *
+ * @param theFactoryObject object to be returned
+ */
+
virtual bool
returnObject(const FactoryObject* theFactoryObject) = 0;
1.3 +13 -3 xml-xalan/c/src/PlatformSupport/PrintWriter.hpp
Index: PrintWriter.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/PlatformSupport/PrintWriter.hpp,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- PrintWriter.hpp 2000/02/17 20:27:26 1.2
+++ PrintWriter.hpp 2000/02/23 20:23:11 1.3
@@ -77,16 +77,26 @@
{
public:
- // If fAutoFlush is true, the output will not
- // be buffered.
+ /**
+ * Constructor
+ *
+ * @param fAutoFlush if true, the output will not be buffered
+ */
PrintWriter(bool fAutoFlush = false);
virtual
~PrintWriter();
- // Flush the stream, then check the error status.
+
+ /**
+ * Flush the stream, then check the error status.
+ *
+ * @return true if no errors
+ */
virtual bool
checkError() const = 0;
+
+ // Functions inherited from Writer...
virtual void
close() = 0;
1.2 +25 -0 xml-xalan/c/src/PlatformSupport/StringTokenizer.hpp
Index: StringTokenizer.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/PlatformSupport/StringTokenizer.hpp,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- StringTokenizer.hpp 1999/12/18 19:47:50 1.1
+++ StringTokenizer.hpp 2000/02/23 20:23:11 1.2
@@ -72,6 +72,15 @@
{
public:
+ /**
+ * Constructs a tokenizer for the target string
+ *
+ * @param theString target string to tokenize
+ * @param theTokens string of delimiters used to parse target, default
+ * is "\t\n\r\f"
+ * @param fReturnTokens if true, delimiter characters are also returned
+ * as tokens, default is false
+ */
StringTokenizer(const DOMString& theString,
const DOMString& theTokens = DOMString("\t\n\r\f"),
bool fReturnTokens = false);
@@ -79,12 +88,28 @@
virtual
~StringTokenizer();
+ /**
+ * Determine if there are tokens remaining
+ *
+ * @return true if there are more tokens
+ */
virtual bool
hasMoreTokens() const;
+ /**
+ * Retrieve the next token to be parsed; behavior is undefined if there are
+ * no more tokens
+ *
+ * @return next token string
+ */
virtual DOMString
nextToken();
+ /**
+ * Count the number of tokens yet to be parsed
+ *
+ * @return number of remaining tokens
+ */
virtual int
countTokens() const;
1.4 +38 -3 xml-xalan/c/src/PlatformSupport/Writer.hpp
Index: Writer.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/PlatformSupport/Writer.hpp,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Writer.hpp 2000/02/22 17:33:31 1.3
+++ Writer.hpp 2000/02/23 20:23:11 1.4
@@ -85,31 +85,66 @@
virtual
~Writer();
+ /**
+ * Close the stream
+ */
virtual void
close() = 0;
+ /**
+ * Flush the stream
+ */
virtual void
flush() = 0;
// Output functions
- // If the length is UINT_MAX, then the array is assumed to be null-terminated.
+ /**
+ * Writes a string
+ *
+ * @param s string to write
+ * @param theOffset starting offset in string to begin writing, default 0
+ * @param theLength number of characters to write. If the length is
+ * UINT_MAX, then the array is assumed to be
+ * null-terminated. Default is UINT_MAX.
+ */
virtual void
write(const char* s,
unsigned int theOffset = 0,
unsigned int theLength = UINT_MAX) = 0;
- // If the length is UINT_MAX, then the array is assumed to be null-terminated.
+ /**
+ * Writes a string
+ *
+ * @param s string to write
+ * @param theOffset starting offset in string to begin writing, default 0
+ * @param theLength number of characters to write. If the length is
+ * UINT_MAX, then the array is assumed to be
+ * null-terminated. Default is UINT_MAX.
+ */
virtual void
write(const XMLCh* s,
unsigned int theOffset = 0,
unsigned int theLength = UINT_MAX) = 0;
+ /**
+ * Writes a character
+ *
+ * @param c character to write
+ */
virtual void
write(XMLCh c) = 0;
- // If the length is UINT_MAX, then the entire string is printed.
+ /**
+ * Writes a string
+ *
+ * @param s string to write
+ * @param theOffset starting offset in string to begin writing, default 0
+ * @param theLength number of characters to write. If the length is
+ * UINT_MAX, then the entire string is printed. Default
+ * is UINT_MAX.
+ */
virtual void
write(const DOMString& s,
unsigned int theOffset = 0,
1.3 +16 -0 xml-xalan/c/src/PlatformSupport/XSLException.hpp
Index: XSLException.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/PlatformSupport/XSLException.hpp,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- XSLException.hpp 2000/01/28 14:59:22 1.2
+++ XSLException.hpp 2000/02/23 20:23:11 1.3
@@ -73,6 +73,12 @@
{
public:
+ /**
+ * Constructor
+ *
+ * @param theMessage message to write when exception thrown
+ * @param theType type of exception, default is "XSLException"
+ */
XSLException(
const DOMString& theMessage,
const DOMString& theType = DOMString("XSLException"));
@@ -80,11 +86,21 @@
virtual
~XSLException();
+ /**
+ * Retrieve type of exception
+ *
+ * @return type of exception
+ */
DOMString getType() const
{
return m_type;
}
+ /**
+ * Retrieve message for exception
+ *
+ * @return exception message
+ */
DOMString getMessage() const
{
return m_message;