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/03/06 18:17:55 UTC
cvs commit: xml-xalan/c/src/XercesParserLiaison XercesParserLiaison.hpp
jdonohue 00/03/06 09:17:55
Modified: c/src/DOMSupport DOMServices.hpp
c/src/XPath XPathSupport.hpp XPathSupportDefault.hpp
XPointer.hpp XResultTreeFrag.hpp XSpan.hpp
XString.hpp XUnknown.hpp
c/src/XSLT StylesheetExecutionContext.hpp XSLTEngineImpl.hpp
c/src/XercesInit XercesInit.cpp
c/src/XercesParserLiaison XercesParserLiaison.hpp
Log:
Added javadoc comments
Revision Changes Path
1.6 +2 -3 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.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- DOMServices.hpp 2000/03/03 19:00:12 1.5
+++ DOMServices.hpp 2000/03/06 17:17:51 1.6
@@ -104,9 +104,8 @@
~WhitespaceSupport();
/**
- * Tell if the node is ignorable whitespace.
- * This should be in the DOM. Return false if the
- * parser doesn't handle this.
+ * 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
1.5 +4 -0 xml-xalan/c/src/XPath/XPathSupport.hpp
Index: XPathSupport.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/XPath/XPathSupport.hpp,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- XPathSupport.hpp 2000/03/03 19:00:21 1.4
+++ XPathSupport.hpp 2000/03/06 17:17:51 1.5
@@ -190,6 +190,10 @@
* @param theDocument document containing entity
* @return URI for the entity
*/
+ // Since it states in the DOM draft: "An XML processor may choose to
+ // completely expand entities before the structure model is passed to the
+ // DOM; in this case, there will be no EntityReferences in the DOM tree."
+ // So I'm not sure how well this is going to work.
virtual DOMString
getUnparsedEntityURI(
const DOMString& theName,
1.4 +8 -52 xml-xalan/c/src/XPath/XPathSupportDefault.hpp
Index: XPathSupportDefault.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/XPath/XPathSupportDefault.hpp,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- XPathSupportDefault.hpp 2000/02/17 20:29:53 1.3
+++ XPathSupportDefault.hpp 2000/03/06 17:17:51 1.4
@@ -82,97 +82,53 @@
virtual
~XPathSupportDefault();
- // These interfaces are inherited from Resettable...
-
- /**
- * Reset the instance.
- */
- virtual void
- reset();
-
+
// These interfaces are inherited from DOMServices::WhitespaceSupport...
- /**
- * Tell if the node is ignorable whitespace.
- * This should be in the DOM. Return false if the
- * parser doesn't handle this.
- */
virtual bool
isIgnorableWhitespace(const DOM_Text& node) const;
+
// These intefaces are inherited from XPathSupport...
- /**
- * Given a namespace, get the corresponding prefix.
- */
virtual DOMString
getNamespaceForPrefix(
const DOMString& prefix,
const DOM_Element& namespaceContext) const;
- /**
- * Returns the namespace of the given node.
- */
virtual DOMString
getNamespaceOfNode(const DOM_Node& n) const;
- /**
- * Returns the local name of the given node.
- */
virtual DOMString
getLocalNameOfNode(const DOM_Node& n) const;
- /**
- * Get node data recursively.
- * (Note whitespace issues.)
- */
virtual DOMString
getNodeData(const DOM_Node& n) const;
- /**
- * This function has to be implemented,
- * because the DOM WG decided that attributes don't
- * have parents.
- */
virtual DOM_Node
getParentOfNode(const DOM_Node& node) const;
- /**
- * Get an element from an ID.
- */
virtual DOM_Element
getElementByID(
const DOMString& id,
const DOM_Document& doc) const;
- /**
- * Set whether or not the liaison attempts to expand namespaces. Used
- * for optimization.
- */
virtual void
setProcessNamespaces(bool processNamespaces);
- /**
- * Tells if namespaces should be supported. For optimization purposes.
- */
virtual bool
getProcessNamespaces() const;
- /**
- * The getUnparsedEntityURI function returns the URI of the unparsed
- * entity with the specified name in the same document as the context
- * node (see [3.3 Unparsed Entities]). It returns the empty string if
- * there is no such entity.
- *
- * Since it states in the DOM draft: "An XML processor may choose to
- * completely expand entities before the structure model is passed
- * to the DOM; in this case, there will be no EntityReferences in the DOM tree."
- * So I'm not sure how well this is going to work.
- */
virtual DOMString
getUnparsedEntityURI(
const DOMString& theName,
const DOM_Document& theDocument) const;
+
+
+ // These interfaces are inherited from Resettable...
+
+ virtual void
+ reset();
private:
1.2 +4 -0 xml-xalan/c/src/XPath/XPointer.hpp
Index: XPointer.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/XPath/XPointer.hpp,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XPointer.hpp 1999/12/18 19:47:55 1.1
+++ XPointer.hpp 2000/03/06 17:17:51 1.2
@@ -76,12 +76,16 @@
/**
* Gets a span from an XPointer string.
+ *
+ * @param xpointer XPointer string
*/
static XSpan*
getNode(const DOMString& xpointer);
/**
* Get a span from an XPath (compiled XPointer) object.
+ *
+ * @param xpath XPath object
*/
static XSpan*
getNode(XPath& xpath);
1.2 +17 -32 xml-xalan/c/src/XPath/XResultTreeFrag.hpp
Index: XResultTreeFrag.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/XPath/XResultTreeFrag.hpp,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XResultTreeFrag.hpp 1999/12/18 19:47:55 1.1
+++ XResultTreeFrag.hpp 2000/03/06 17:17:52 1.2
@@ -85,86 +85,71 @@
{
public:
+ /**
+ * Construct an XResultTreeFrag object from a result tree fragment
+ *
+ * @param envSupport XPath environment support class instance
+ * @param support XPath support class instance
+ * @param val source result tree fragment
+ * @param deepClone true to copy all subobjects, default true
+ */
XResultTreeFrag(
XPathEnvSupport& envSupport,
XPathSupport& support,
const ResultTreeFragBase& val,
bool deepClone = true);
+ /**
+ * Construct an XResultTreeFrag object from another
+ *
+ * @param source source XResultTreeFrag
+ * @param deepClone true to copy all subobjects, default true
+ */
XResultTreeFrag(const XResultTreeFrag& source,
bool deepClone = true);
virtual
~XResultTreeFrag();
- /**
- * Tell what kind of class this is.
- */
+
+ // These methods are inherited from XObject ...
+
virtual eObjectType
getType() const;
- /**
- * Given a request type, return the equivalent string.
- * For diagnostic purposes.
- */
virtual DOMString
getTypeString() const;
- /**
- * Cast result object to a number.
- */
virtual double
num() const;
- /**
- * Cast result object to a boolean.
- */
virtual bool
boolean() const;
- /**
- * Cast result object to a string.
- */
virtual DOMString
str() const;
- /**
- * Cast result object to a result tree fragment.
- */
virtual const ResultTreeFragBase&
rtree() const;
virtual ResultTreeFragBase&
rtree();
- /**
- * Cast result object to a nodelist.
- */
virtual const NodeRefListBase&
nodeset() const;
- /**
- * Cast result object to a nodelist.
- */
virtual const MutableNodeRefList&
mutableNodeset() const;
virtual MutableNodeRefList&
mutableNodeset();
- /**
- * Process a callback request for preferred type information
- *
- */
virtual void
ProcessXObjectTypeCallback(XObjectTypeCallback& theCallbackObject);
virtual void
ProcessXObjectTypeCallback(XObjectTypeCallback& theCallbackObject) const;
- /**
- * Tell if two objects are functionally equal.
- */
virtual bool
equals(const XObject& theRHS) const;
1.2 +42 -10 xml-xalan/c/src/XPath/XSpan.hpp
Index: XSpan.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/XPath/XSpan.hpp,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XSpan.hpp 1999/12/18 19:47:55 1.1
+++ XSpan.hpp 2000/03/06 17:17:52 1.2
@@ -73,16 +73,37 @@
{
public:
+ /**
+ * Construct an XSpan object from a node list.
+ *
+ * @param envSupport XPath environment support class instance
+ * @param support XPath support class instance
+ * @param value source node list
+ */
XSpan(
XPathEnvSupport& envSupport,
XPathSupport& support,
const NodeRefListBase& value = MutableNodeRefList());
+ /**
+ * Construct an XSpan object from a node list.
+ *
+ * @param envSupport XPath environment support class instance
+ * @param support XPath support class instance
+ * @param value source node list
+ */
XSpan(
XPathEnvSupport& envSupport,
XPathSupport& support,
const MutableNodeRefList& value = MutableNodeRefList());
+ /**
+ * Construct an XSpan object from a DOM node.
+ *
+ * @param envSupport XPath environment support class instance
+ * @param support XPath support class instance
+ * @param value source node
+ */
XSpan(
XPathEnvSupport& envSupport,
XPathSupport& support,
@@ -94,36 +115,47 @@
~XSpan();
/**
- * Get the start span offset from the first node,
- * or -1 if offset isn't set.
+ * Get the start span offset from the first node, or -1 if offset isn't
+ * set.
+ *
+ * @return starting offset
*/
virtual int
getStart() const;
/**
- * Set the start span offset from the first node,
- * or pass -1 if offset isn't set.
+ * Set the start span offset from the first node, or pass -1 if offset
+ * isn't set.
+ *
+ * @param start starting offset
*/
virtual void
setStart(int start);
/**
- * Get the end span offset from start of the last node,
- * or -1 if offset isn't set.
+ * Get the end span offset from start of the last node, or -1 if offset
+ * isn't set.
+ *
+ * @return ending offset
*/
virtual int
getEnd() const;
/**
- * Set the end span offset from start of the last node,
- * or -1 if offset isn't set.
+ * Set the end span offset from start of the last node, or -1 if offset
+ * isn't set.
+ *
+ * @param end ending offset
*/
virtual void
setEnd(int end);
/**
- * Set the range of the span, based on offsets from the
- * first node and offsets from the last node.
+ * Set the range of the span, based on offsets from the first node and
+ * offsets from the last node.
+ *
+ * @param firstNodeOffset offset of first node
+ * @param lastNodeOffset offset of last node
*/
virtual void
setSpan(
1.2 +10 -32 xml-xalan/c/src/XPath/XString.hpp
Index: XString.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/XPath/XString.hpp,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XString.hpp 1999/12/18 19:47:55 1.1
+++ XString.hpp 2000/03/06 17:17:53 1.2
@@ -87,6 +87,13 @@
{
public:
+ /**
+ * Construct an XString object from a string.
+ *
+ * @param envSupport XPath environment support class instance
+ * @param support XPath support class instance
+ * @param value source string
+ */
XString(
XPathEnvSupport& envSupport,
XPathSupport& support,
@@ -97,74 +104,45 @@
virtual
~XString();
- /**
- * Tell what kind of class this is.
- */
+
+ // These methods are inherited from XObject ...
+
virtual eObjectType
getType() const;
- /**
- * Given a request type, return the equivalent string.
- * For diagnostic purposes.
- */
virtual DOMString
getTypeString() const;
- /**
- * Cast result object to a number.
- */
virtual double
num() const;
- /**
- * Cast result object to a boolean.
- */
virtual bool
boolean() const;
- /**
- * Cast result object to a string.
- */
virtual DOMString
str() const;
- /**
- * Cast result object to a result tree fragment.
- */
virtual const ResultTreeFragBase&
rtree() const;
virtual ResultTreeFragBase&
rtree();
- /**
- * Cast result object to a nodelist.
- */
virtual const NodeRefListBase&
nodeset() const;
- /**
- * Cast result object to a nodelist.
- */
virtual const MutableNodeRefList&
mutableNodeset() const;
virtual MutableNodeRefList&
mutableNodeset();
- /**
- * Process a callback request for preferred type information
- *
- */
virtual void
ProcessXObjectTypeCallback(XObjectTypeCallback& theCallbackObject);
virtual void
ProcessXObjectTypeCallback(XObjectTypeCallback& theCallbackObject) const;
- /**
- * Tell if two objects are functionally equal.
- */
virtual bool
equals(const XObject& theRHS) const;
1.2 +8 -32 xml-xalan/c/src/XPath/XUnknown.hpp
Index: XUnknown.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/XPath/XUnknown.hpp,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XUnknown.hpp 1999/12/18 19:47:56 1.1
+++ XUnknown.hpp 2000/03/06 17:17:53 1.2
@@ -77,6 +77,12 @@
{
public:
+ /**
+ * Construct an XUnknown object from a string.
+ *
+ * @param envSupport XPath environment support class instance
+ * @param name source string
+ */
XUnknown(
XPathEnvSupport& envSupport,
const DOMString& name);
@@ -86,74 +92,44 @@
virtual
~XUnknown();
- /**
- * Tell what kind of class this is.
- */
+ // These methods are inherited from XObject ...
+
virtual eObjectType
getType() const;
- /**
- * Given a request type, return the equivalent string.
- * For diagnostic purposes.
- */
virtual DOMString
getTypeString() const;
- /**
- * Cast result object to a number.
- */
virtual double
num() const;
- /**
- * Cast result object to a boolean.
- */
virtual bool
boolean() const;
- /**
- * Cast result object to a string.
- */
virtual DOMString
str() const;
- /**
- * Cast result object to a result tree fragment.
- */
virtual const ResultTreeFragBase&
rtree() const;
virtual ResultTreeFragBase&
rtree();
- /**
- * Cast result object to a nodelist.
- */
virtual const NodeRefListBase&
nodeset() const;
- /**
- * Cast result object to a nodelist.
- */
virtual const MutableNodeRefList&
mutableNodeset() const;
virtual MutableNodeRefList&
mutableNodeset();
- /**
- * Process a callback request for preferred type information
- *
- */
virtual void
ProcessXObjectTypeCallback(XObjectTypeCallback& theCallbackObject);
virtual void
ProcessXObjectTypeCallback(XObjectTypeCallback& theCallbackObject) const;
- /**
- * Tell if two objects are functionally equal.
- */
virtual bool
equals(const XObject& theRHS) const;
1.4 +13 -14 xml-xalan/c/src/XSLT/StylesheetExecutionContext.hpp
Index: StylesheetExecutionContext.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/XSLT/StylesheetExecutionContext.hpp,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- StylesheetExecutionContext.hpp 2000/03/01 20:43:43 1.3
+++ StylesheetExecutionContext.hpp 2000/03/06 17:17:54 1.4
@@ -358,9 +358,9 @@
* Execute an XPath and return the resulting XObject. The lifetime of this
* XObject is not necessarily that of the Stylesheet.
*
- * @param str string expression for XPath evaluation
- * @param contextNode the current node in the source tree
- * @param resolver resolver for namespace resolution
+ * @param str string expression for XPath evaluation
+ * @param contextNode current node in the source tree
+ * @param resolver resolver for namespace resolution
* @return pointer to resulting XObject
*/
virtual XObject*
@@ -373,9 +373,9 @@
* Execute an XPath and return the resulting XObject. The lifetime of this
* XObject is not necessarily that of the Stylesheet.
*
- * @param str string expression for XPath evaluation
- * @param contextNode the current node in the source tree
- * @param resolver resolver for namespace resolution
+ * @param str string expression for XPath evaluation
+ * @param contextNode current node in the source tree
+ * @param resolver resolver for namespace resolution
* @return pointer to resulting XObject
*/
virtual XObject*
@@ -388,7 +388,7 @@
* Create and initialize an xpath and return it. This is to be used to
* create an XPath that is only used during execution.
*
- * @param str string expression for XPath evaluation
+ * @param str string expression for XPath evaluation
* @param resolver resolver for namespace resolution
* @return pointer to resulting XPath
*/
@@ -563,8 +563,8 @@
* ignorableWhitespace() method rather than this one (validating
* parsers must do so).</p>
*
- * @param ch pointer to characters from the XML document
- * @param start start position in the array
+ * @param ch pointer to characters from the XML document
+ * @param start start position in the array
* @param length number of characters to read from the array
* @exception SAXException
*/
@@ -579,8 +579,8 @@
* disable-output-escaping attribute is used, output raw text without
* escaping.
*
- * @param ch pointer to characters from the XML document
- * @param start start position in the array
+ * @param ch pointer to characters from the XML document
+ * @param start start position in the array
* @param length number of characters to read from the array
* @exception SAXException
*/
@@ -611,9 +611,8 @@
* section 2.8) or a text declaration (XML 1.0, section 4.3.1)
* using this method.</p>
*
- * @param target The processing instruction target.
- * @param data The processing instruction data, or null if
- * none was supplied.
+ * @param target processing instruction target
+ * @param data processing instruction data, or null if none was supplied
* @exception SAXException
*/
virtual void
1.12 +3 -4 xml-xalan/c/src/XSLT/XSLTEngineImpl.hpp
Index: XSLTEngineImpl.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/XSLT/XSLTEngineImpl.hpp,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- XSLTEngineImpl.hpp 2000/03/03 19:00:33 1.11
+++ XSLTEngineImpl.hpp 2000/03/06 17:17:54 1.12
@@ -59,7 +59,7 @@
/**
*
- * $Id: XSLTEngineImpl.hpp,v 1.11 2000/03/03 19:00:33 jdonohue Exp $
+ * $Id: XSLTEngineImpl.hpp,v 1.12 2000/03/06 17:17:54 jdonohue Exp $
*
* $State: Exp $
*
@@ -671,7 +671,6 @@
* @param start start position in the array
* @param length number of characters to read from the array
* @exception SAXException
- * @see #ignorableWhitespace
*/
virtual void
cdata(
@@ -1550,9 +1549,9 @@
}
/**
- * Retrieve the XPath envronment support object
+ * Retrieve the XPath environment support object
*
- * @return XPath envronment support object
+ * @return XPath environment support object
*/
XPathEnvSupport& getXPathEnvSupport()
{
1.3 +3 -4 xml-xalan/c/src/XercesInit/XercesInit.cpp
Index: XercesInit.cpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/XercesInit/XercesInit.cpp,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- XercesInit.cpp 2000/02/03 20:13:25 1.2
+++ XercesInit.cpp 2000/03/06 17:17:55 1.3
@@ -91,11 +91,10 @@
return TRUE;
}
+#elif defined(LINUX)
+
#else
-# if defined(LINUX)
-# else
-# error Unsupported platform!!!
-# endif
+#error Unsupported platform!!!
#endif
1.5 +6 -55 xml-xalan/c/src/XercesParserLiaison/XercesParserLiaison.hpp
Index: XercesParserLiaison.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/XercesParserLiaison/XercesParserLiaison.hpp,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- XercesParserLiaison.hpp 2000/02/17 20:27:55 1.4
+++ XercesParserLiaison.hpp 2000/03/06 17:17:55 1.5
@@ -95,6 +95,12 @@
{
public:
+ /**
+ * Construct a XercesParserLiaison instance.
+ *
+ * @param theSupport instance of DOMSupport object
+ * @param fUseValidatingParser true if a validating parser is to be used
+ */
XercesParserLiaison(
DOMSupport& theSupport,
bool fUseValidatingParser = false);
@@ -104,79 +110,31 @@
// These interfaces are inherited from XMLParserLiaison...
- /**
- * Returns true if the liaison supports the SAX DocumentHandler
- * interface.
- */
virtual bool
supportsSAX() const;
- /**
- * Parse the text pointed at by the reader as XML, and return
- * a DOM Document interface. May return null if not
- * supported. It is recommended that you pass in some sort
- * of recognizable name, such as the filename or URI, with
- * which the reader can be recognized if the parse fails.
- * @param reader A stream that should hold valid XML.
- * @param identifier Used for diagnostic purposes only,
- * some sort of identification for error reporting, may be
- * an empty string.
- */
virtual DOM_Document
parseXMLStream(
InputSource& reader,
const DOMString& identifier = DOMString());
- /**
- * Parse the text pointed at by the reader as XML, and return
- * a DOM Document interface. May return null if not
- * supported. It is recommended that you pass in some sort
- * of recognizable name, such as the filename or URI, with
- * which the reader can be recognized if the parse fails.
- * @param reader A URL input source that should hold valid XML.
- * @param identifier Used for diagnostic purposes only,
- * some sort of identification for error reporting, may be
- * an empty string.
- */
virtual DOM_Document
parseXMLStream(
URLInputSource& reader,
const DOMString& identifier = DOMString());
- /**
- * Parse the text pointed at by the reader as XML.
- *
- * @param reader A URL input source that should hold valid XML.
- * @param handler An instance of a DocumentHandler.
- * @param identifier Used for diagnostic purposes only,
- * some sort of identification for error reporting, may be
- * an empty string.
- */
virtual void
parseXMLStream(
InputSource& urlInputSource,
DocumentHandler& handler,
const DOMString& identifier = DOMString());
- /**
- * Parse the text pointed at by the reader as XML.
- *
- * @param reader A URL input source that should hold valid XML.
- * @param handler An instance of a DocumentHandler.
- * @param identifier Used for diagnostic purposes only,
- * some sort of identification for error reporting, may be
- * an empty string.
- */
virtual void
parseXMLStream(
URLInputSource& urlInputSource,
DocumentHandler& handler,
const DOMString& identifier = DOMString());
- /**
- * Create an empty DOM Document. Mainly used for creating an
- * output document.
- */
virtual DOM_Document
createDocument();
@@ -191,13 +149,6 @@
virtual void
fatalError(const SAXParseException& exception);
- /**
- * Reset the Error handler object on its reuse
- *
- * <p>This method helps in reseting the Error handler object
- * implementational defaults each time the Error handler is begun.</p>
- *
- */
virtual void
resetErrors();