You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xerces.apache.org by tn...@apache.org on 2002/06/27 20:47:32 UTC
cvs commit: xml-xerces/c/src/xercesc/parsers AbstractDOMParser.hpp SAX2XMLReaderImpl.hpp
tng 2002/06/27 11:47:32
Modified: c/src/xercesc/parsers AbstractDOMParser.hpp
SAX2XMLReaderImpl.hpp
Log:
API Documentation Update.
Revision Changes Path
1.8 +86 -70 xml-xerces/c/src/xercesc/parsers/AbstractDOMParser.hpp
Index: AbstractDOMParser.hpp
===================================================================
RCS file: /home/cvs/xml-xerces/c/src/xercesc/parsers/AbstractDOMParser.hpp,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- AbstractDOMParser.hpp 25 Jun 2002 15:58:30 -0000 1.7
+++ AbstractDOMParser.hpp 27 Jun 2002 18:47:32 -0000 1.8
@@ -95,18 +95,28 @@
// -----------------------------------------------------------------------
// Class types
// -----------------------------------------------------------------------
+ /** @name Public constants */
+ //@{
+
+ /** ValScheme enum used in setValidationScheme
+ * Val_Never: Do not report validation errors.
+ * Val_Always: The parser will always report validation errors.
+ * Val_Auto: The parser will report validation errors only if a grammar is specified.
+ *
+ * @see #setValidationScheme
+ */
enum ValSchemes
{
Val_Never
, Val_Always
, Val_Auto
};
+ //@}
// -----------------------------------------------------------------------
// Constructors and Detructor
// -----------------------------------------------------------------------
-
/** @name Destructor */
//@{
@@ -261,21 +271,6 @@
*/
bool getValidationConstraintFatal() const;
- /** Get the 'expand entity references' flag.
- * DEPRECATED Use getCreateEntityReferenceNodes() instead.
- *
- * This method returns the state of the parser's expand entity
- * references flag.
- *
- * @return 'true' if the expand entity reference flag is set on
- * the parser, 'false' otherwise.
- *
- * @see #setExpandEntityReferences
- * @see #setCreateEntityReferenceNodes
- * @see #getCreateEntityReferenceNodes
- */
- bool getExpandEntityReferences() const;
-
/** Get the 'include entity references' flag
*
* This method returns the flag that specifies whether the parser is
@@ -429,24 +424,6 @@
*/
void setValidationConstraintFatal(const bool newState);
- /** Set the 'expand entity references' flag
- *
- * DEPRECATED. USE setCreateEntityReferenceNodes instead.
- * This method allows the user to specify whether the parser should
- * expand all entity reference nodes. When the 'do expansion' flag is
- * true, the DOM tree does not have any entity reference nodes. It is
- * replaced by the sub-tree representing the replacement text of the
- * entity. When the 'do expansion' flag is false, the DOM tree
- * contains an extra entity reference node, whose children is the
- * sub tree of the replacement text.
- * <p>The default value is 'false'.
- *
- * @param expand The new state of the expand entity reference
- * flag.
- * @see #setCreateEntityReferenceNodes
- */
- void setExpandEntityReferences(const bool expand);
-
/** Set the 'include entity references' flag
*
* This method allows the user to specify whether the parser should
@@ -1085,39 +1062,6 @@
// -----------------------------------------------------------------------
- // Deprecated Methods
- // -----------------------------------------------------------------------
- /** @name Deprecated Methods */
- //@{
- /**
- * This method returns the state of the parser's validation
- * handling flag which controls whether validation checks
- * are enforced or not.
- *
- * @return true, if the parser is currently configured to
- * do validation, false otherwise.
- *
- * @see #setDoValidation
- */
- bool getDoValidation() const;
-
- /**
- * This method allows users to enable or disable the parser's validation
- * checks.
- *
- * <p>By default, the parser does not to any validation. The default
- * value is false.</p>
- *
- * @param newState The value specifying whether the parser should
- * do validity checks or not against the DTD in the
- * input XML document.
- *
- * @see #getDoValidation
- */
- void setDoValidation(const bool newState);
- //@}
-
- // -----------------------------------------------------------------------
// Implementation of the deprecated DocTypeHandler interface.
// -----------------------------------------------------------------------
/** @name Deprecated DocTypeHandler Interfaces */
@@ -1203,11 +1147,77 @@
//@}
-protected :
// -----------------------------------------------------------------------
- // Protected getter methods
+ // Deprecated Methods
// -----------------------------------------------------------------------
+ /** @name Deprecated Methods */
+ //@{
+ /**
+ * This method returns the state of the parser's validation
+ * handling flag which controls whether validation checks
+ * are enforced or not.
+ *
+ * @return true, if the parser is currently configured to
+ * do validation, false otherwise.
+ *
+ * @see #setDoValidation
+ */
+ bool getDoValidation() const;
+ /**
+ * This method allows users to enable or disable the parser's validation
+ * checks.
+ *
+ * <p>By default, the parser does not to any validation. The default
+ * value is false.</p>
+ *
+ * @param newState The value specifying whether the parser should
+ * do validity checks or not against the DTD in the
+ * input XML document.
+ *
+ * @see #getDoValidation
+ */
+ void setDoValidation(const bool newState);
+
+ /** Get the 'expand entity references' flag.
+ * DEPRECATED Use getCreateEntityReferenceNodes() instead.
+ *
+ * This method returns the state of the parser's expand entity
+ * references flag.
+ *
+ * @return 'true' if the expand entity reference flag is set on
+ * the parser, 'false' otherwise.
+ *
+ * @see #setExpandEntityReferences
+ * @see #setCreateEntityReferenceNodes
+ * @see #getCreateEntityReferenceNodes
+ */
+ bool getExpandEntityReferences() const;
+
+ /** Set the 'expand entity references' flag
+ *
+ * DEPRECATED. USE setCreateEntityReferenceNodes instead.
+ * This method allows the user to specify whether the parser should
+ * expand all entity reference nodes. When the 'do expansion' flag is
+ * true, the DOM tree does not have any entity reference nodes. It is
+ * replaced by the sub-tree representing the replacement text of the
+ * entity. When the 'do expansion' flag is false, the DOM tree
+ * contains an extra entity reference node, whose children is the
+ * sub tree of the replacement text.
+ * <p>The default value is 'false'.
+ *
+ * @param expand The new state of the expand entity reference
+ * flag.
+ * @see #setCreateEntityReferenceNodes
+ */
+ void setExpandEntityReferences(const bool expand);
+
+ //@}
+
+protected :
+ // -----------------------------------------------------------------------
+ // Protected Constructor Methods
+ // -----------------------------------------------------------------------
/** @name Constructors */
//@{
/** Construct a AbstractDOMParser, with an optional validator
@@ -1223,6 +1233,9 @@
//@}
+ // -----------------------------------------------------------------------
+ // Protected getter methods
+ // -----------------------------------------------------------------------
/** @name Protected getter methods */
//@{
/** Get the current DOM node
@@ -1276,10 +1289,13 @@
// -----------------------------------------------------------------------
// Protected Helper methods
// -----------------------------------------------------------------------
+ /** @name Protected helper methods */
+ //@{
virtual DOMElement* createElementNSNode(const XMLCh *fNamespaceURI,
const XMLCh *qualifiedName);
void resetPool();
+ //@}
private :
1.11 +797 -707 xml-xerces/c/src/xercesc/parsers/SAX2XMLReaderImpl.hpp
Index: SAX2XMLReaderImpl.hpp
===================================================================
RCS file: /home/cvs/xml-xerces/c/src/xercesc/parsers/SAX2XMLReaderImpl.hpp,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- SAX2XMLReaderImpl.hpp 17 Jun 2002 15:41:15 -0000 1.10
+++ SAX2XMLReaderImpl.hpp 27 Jun 2002 18:47:32 -0000 1.11
@@ -56,6 +56,9 @@
/*
* $Log$
+ * Revision 1.11 2002/06/27 18:47:32 tng
+ * API Documentation Update.
+ *
* Revision 1.10 2002/06/17 15:41:15 tng
* To be consistent, SAX2 is updated with:
* 1. the progressive parse methods should use the fReuseGrammar flag set from setFeature instead of using parameter
@@ -202,407 +205,125 @@
class PARSERS_EXPORT SAX2XMLReaderImpl :
public SAX2XMLReader
-// , public Parser
, public XMLDocumentHandler
, public XMLErrorReporter
, public XMLEntityHandler
, public DocTypeHandler
{
public :
-
+ // -----------------------------------------------------------------------
+ // Constructors and Destructor
+ // -----------------------------------------------------------------------
+ /** @name Constructors and Destructor */
+ //@{
+ /** The default constructor */
SAX2XMLReaderImpl() ;
- ~SAX2XMLReaderImpl() ;
- // -----------------------------------------------------------------------
- // Implementation of the XMLDocumentHandler interface
- // -----------------------------------------------------------------------
+ /** The destructor */
+ ~SAX2XMLReaderImpl() ;
+ //@}
- /** @name Implementation of the XMLDocumentHandler Interface. */
+ //-----------------------------------------------------------------------
+ // Implementation of SAX2XMLReader Interface
+ //-----------------------------------------------------------------------
+ //-----------------------------------------------------------------------
+ // The XMLReader interface
+ //-----------------------------------------------------------------------
+ /** @name Implementation of SAX 2.0 XMLReader interface's. */
//@{
- /**
- * This method is used to report all the characters scanned
- * by the parser. The driver will invoke the 'characters'
- * method of the user installed SAX Document Handler.
- *
- * <p>If any advanced callback handlers are installed, the
- * corresponding 'docCharacters' method will also be invoked.</p>
- *
- * @param chars A const pointer to a Unicode string representing the
- * character data.
- * @param length The length of the Unicode string returned in 'chars'.
- * @param cdataSection A flag indicating if the characters represent
- * content from the CDATA section.
- * @see DocumentHandler#characters
- */
- virtual void docCharacters
- (
- const XMLCh* const chars
- , const unsigned int length
- , const bool cdataSection
- );
/**
- * This method is used to report any comments scanned by the parser.
- * This method is a no-op unless, unless an advanced callback handler
- * is installed, in which case the corresponding 'docComment' method
- * is invoked.
- *
- * @param comment A const pointer to a null terminated Unicode
- * string representing the comment text.
- */
- virtual void docComment
- (
- const XMLCh* const comment
- );
-
- /**
- * This method is used to report any PI scanned by the parser.
- *
- * <p>Any PI's occurring before any 'content' are not reported
- * to any SAX handler as per the specification. However, all
- * PI's within content are reported via the SAX Document Handler's
- * 'processingInstruction' method.
- *
- * <p>If any advanced callback handlers are installed, the
- * corresponding 'docPI' method will be invoked.</p>
- *
- * @param target A const pointer to a Unicode string representing the
- * target of the PI declaration.
- * @param data A const pointer to a Unicode string representing the
- * data of the PI declaration. See the PI production rule
- * in the XML specification for details.
+ * This method returns the installed content handler.
*
- * @see DocumentHandler#processingInstruction
+ * @return A pointer to the installed content handler object.
*/
- virtual void docPI
- (
- const XMLCh* const target
- , const XMLCh* const data
- );
+ virtual ContentHandler* getContentHandler() const ;
/**
- * This method is used to indicate the end of root element
- * was just scanned by the parser. Corresponding 'endDocument'
- * method of the user installed SAX Document Handler will also
- * be invoked.
- *
- * <p>In addition, if any advanced callback handlers are installed,
- * the corresponding 'endDocument' method is invoked.</p>
+ * This method returns the installed DTD handler.
*
- * @see DocumentHandler#endDocument
+ * @return A pointer to the installed DTD handler object.
*/
- virtual void endDocument();
+ virtual DTDHandler* getDTDHandler() const ;
/**
- * This method is used to indicate the end tag of an element.
- * The driver will invoke the corresponding 'endElement' method of
- * the SAX Document Handler interface.
- *
- * <p>If any advanced callback handlers are installed, the
- * corresponding 'endElement' method is also invoked.</p>
+ * This method returns the installed entity resolver.
*
- * @param elemDecl A const reference to the object containing element
- * declaration information.
- * @param urlId An id referring to the namespace prefix, if
- * namespaces setting is switched on.
- * @param isRoot A flag indicating whether this element was the
- * root element.
- * @param elemPrefix A const pointer to a Unicode string containing
- * the namespace prefix for this element. Applicable
- * only when namespace processing is enabled.
- * @see DocumentHandler#endElement
+ * @return A pointer to the installed entity resolver object.
*/
- virtual void endElement
- (
- const XMLElementDecl& elemDecl
- , const unsigned int urlId
- , const bool isRoot
- , const XMLCh* const elemPrefix=0
- );
+ virtual EntityResolver* getEntityResolver() const ;
/**
- * This method is used to indicate that an end of an entity reference
- * was just scanned.
- *
- * <p>If any advanced callback handlers are installed, the
- * corresponding 'endEnityReference' method is invoked.</p>
+ * This method returns the installed error handler.
*
- * @param entDecl A const reference to the object containing the
- * entity declaration information.
+ * @return A pointer to the installed error handler object.
*/
- virtual void endEntityReference
- (
- const XMLEntityDecl& entDecl
- );
+ virtual ErrorHandler* getErrorHandler() const ;
- /**
- * This method is used to report all the whitespace characters,
- * which are determined to be 'ignorable'. This distinction
- * between characters is only made, if validation is enabled.
- * Corresponding 'ignorableWhitespace' method of the user installed
- * SAX Document Handler interface is called.
- *
- * <p>Any whitespace before content is not reported to the SAX
- * Document Handler method, as per the SAX specification.
- * However, if any advanced callback handlers are installed, the
- * corresponding 'ignorableWhitespace' method is invoked.</p>
- *
- * @param chars A const pointer to a Unicode string representing the
- * ignorable whitespace character data.
- * @param length The length of the Unicode string 'chars'.
- * @param cdataSection A flag indicating if the characters represent
- * content from the CDATA section.
- * @see DocumentHandler#ignorableWhitespace
- */
- virtual void ignorableWhitespace
- (
- const XMLCh* const chars
- , const unsigned int length
- , const bool cdataSection
- );
+ /**
+ * Query the current state of any feature in a SAX2 XMLReader.
+ *
+ * @param name The unique identifier (URI) of the feature being set.
+ * @return The current state of the feature.
+ * @exception SAXNotRecognizedException If the requested feature is not known.
+ */
+ virtual bool getFeature(const XMLCh* const name) const ;
- /**
- * This method allows the user installed Document Handler and
- * any advanced callback handlers to 'reset' themselves.
- */
- virtual void resetDocument();
+ /**
+ * Query the current value of a property in a SAX2 XMLReader.
+ *
+ * The parser owns the returned pointer. The memory allocated for
+ * the returned pointer will be destroyed when the parser is deleted.
+ *
+ * To ensure assessiblity of the returned information after the parser
+ * is deleted, callers need to copy and store the returned information
+ * somewhere else; otherwise you may get unexpected result. Since the returned
+ * pointer is a generic void pointer, see
+ * http://xml.apache.org/xerces-c/program-sax2.html#SAX2Properties to learn
+ * exactly what type of property value each property returns for replication.
+ *
+ * @param name The unique identifier (URI) of the property being set.
+ * @return The current value of the property. The pointer spans the same
+ * life-time as the parser. A null pointer is returned if nothing
+ * was specified externally.
+ * @exception SAXNotRecognizedException If the requested property is not known.
+ */
+ virtual void* getProperty(const XMLCh* const name) const ;
- /**
- * This method is used to report the start of the parsing process.
- * The corresponding user installed SAX Document Handler's method
- * 'startDocument' is invoked.
- *
- * <p>If any advanced callback handlers are installed, then the
- * corresponding 'startDocument' method is also called.</p>
- *
- * @see DocumentHandler#startDocument
- */
- virtual void startDocument();
+ /**
+ * Allow an application to register a document event handler.
+ *
+ * If the application does not register a document handler, all
+ * document events reported by the SAX parser will be silently
+ * ignored (this is the default behaviour implemented by
+ * HandlerBase).
+ *
+ * Applications may register a new or different handler in the
+ * middle of a parse, and the SAX parser must begin using the new
+ * handler immediately.
+ *
+ * @param handler The document handler.
+ * @see DocumentHandler#DocumentHandler
+ * @see HandlerBase#HandlerBase
+ */
+ virtual void setContentHandler(ContentHandler* const handler) ;
- /**
- * This method is used to report the start of an element. It is
- * called at the end of the element, by which time all attributes
- * specified are also parsed. The corresponding user installed
- * SAX Document Handler's method 'startElement' is invoked.
- *
- * <p>If any advanced callback handlers are installed, then the
- * corresponding 'startElement' method is also called.</p>
- *
- * @param elemDecl A const reference to the object containing element
- * declaration information.
- * @param urlId An id referring to the namespace prefix, if
- * namespaces setting is switched on.
- * @param elemPrefix A const pointer to a Unicode string containing
- * the namespace prefix for this element. Applicable
- * only when namespace processing is enabled.
- * @param attrList A const reference to the object containing the
- * list of attributes just scanned for this element.
- * @param attrCount A count of number of attributes in the list
- * specified by the parameter 'attrList'.
- * @param isEmpty A flag indicating whether this is an empty element
- * or not.
- * @param isRoot A flag indicating whether this element was the
- * root element.
- * @see DocumentHandler#startElement
- */
- virtual void startElement
- (
- const XMLElementDecl& elemDecl
- , const unsigned int urlId
- , const XMLCh* const elemPrefix
- , const RefVectorOf<XMLAttr>& attrList
- , const unsigned int attrCount
- , const bool isEmpty
- , const bool isRoot
- );
-
- /**
- * This method is used to indicate the start of an entity reference.
- *
- * <p>If any advanced callback handlers are installed, the
- * corresponding 'endEnityReference' method is invoked.</p>
- *
- * @param entDecl A const reference to the object containing the
- * entity declaration information.
- */
- virtual void startEntityReference
- (
- const XMLEntityDecl& entDecl
- );
-
- /**
- * This method is used to report the XML decl scanned by the parser.
- * Refer to the XML specification to see the meaning of parameters.
- *
- * <b><font color="#FF0000">This method is a no-op for this SAX driver
- * implementation.</font></b>
- *
- * @param versionStr A const pointer to a Unicode string representing
- * version string value.
- * @param encodingStr A const pointer to a Unicode string representing
- * the encoding string value.
- * @param standaloneStr A const pointer to a Unicode string
- * representing the standalone string value.
- * @param actualEncodingStr A const pointer to a Unicode string
- * representing the actual encoding string
- * value.
- */
- virtual void XMLDecl
- (
- const XMLCh* const versionStr
- , const XMLCh* const encodingStr
- , const XMLCh* const standaloneStr
- , const XMLCh* const actualEncodingStr
- );
- //@}
-
- // -----------------------------------------------------------------------
- // Implementation of the XMLReader interface
- // -----------------------------------------------------------------------
-
- /** @name Getter methods */
- //@{
-
- /** Get error count from the last parse operation.
- *
- * This method returns the error count from the last parse
- * operation. Note that this count is actually stored in the
- * scanner, so this method simply returns what the
- * scanner reports.
- *
- * @return number of errors encountered during the latest
- * parse operation.
- */
- virtual int getErrorCount() const;
-
- /**
- * This method returns the installed content handler.
- *
- * @return A pointer to the installed content handler object.
- */
- virtual ContentHandler* getContentHandler() const;
-
- /**
- * This method returns the installed DTD handler.
- *
- * @return A pointer to the installed DTD handler object.
- */
- virtual DTDHandler* getDTDHandler() const ;
-
- /**
- * This method returns the installed entity resolver.
- *
- * @return A pointer to the installed entity resolver object.
- */
- virtual EntityResolver* getEntityResolver() const ;
-
- /**
- * This method returns the installed error handler.
- *
- * @return A pointer to the installed error handler object.
- */
- virtual ErrorHandler* getErrorHandler() const ;
-
- /**
- * This method returns the installed lexical handler.
- *
- * @return A pointer to the installed lexical handler object.
- */
- virtual LexicalHandler* getLexicalHandler() const ;
-
- /**
- * This method returns the installed declaration handler.
- *
- * @return A pointer to the installed declaration handler object.
- */
- virtual DeclHandler* getDeclarationHandler() const ;
-
- /**
- * This method returns the state of the parser's
- * exit-on-First-Fatal-Error flag.
- *
- * <p>Or you can query the feature "http://apache.org/xml/features/continue-after-fatal-error"
- * which indicates the opposite state.</p>
- *
- * @return true, if the parser is currently configured to
- * exit on the first fatal error, false otherwise.
- *
- * @see #setExitOnFirstFatalError
- * @see #getFeature
- */
- virtual bool getExitOnFirstFatalError() const;
-
- /**
- * This method returns the state of the parser's
- * validation-constraint-fatal flag.
- *
- * <p>Or you can query the feature "http://apache.org/xml/features/validation-error-as-fatal"
- * which means the same thing.
- *
- * @return true, if the parser is currently configured to
- * set validation constraint errors as fatal, false
- * otherwise.
- *
- * @see #setValidationContraintFatal
- * @see #getFeature
- */
- virtual bool getValidationConstraintFatal() const;
-
- /** @name Implementation of SAX 2.0 interface's. */
- //@{
- /**
- * This method invokes the parsing process on the XML file specified
- * by the InputSource parameter.
- *
- * @param source A const reference to the InputSource object which
- * points to the XML file to be parsed.
- */
- virtual void parse(const InputSource& source);
-
- /**
- * This method invokes the parsing process on the XML file specified by
- * the Unicode string parameter 'systemId'.
- *
- * @param systemId A const XMLCh pointer to the Unicode string which
- * contains the path to the XML file to be parsed.
- */
- virtual void parse(const XMLCh* const systemId);
-
- /**
- * This method invokes the parsing process on the XML file specified by
- * the native char* string parameter 'systemId'.
- *
- * @param systemId A const char pointer to a native string which
- * contains the path to the XML file to be parsed.
- */
- virtual void parse(const char* const systemId);
-
- /**
- * This method installs the user specified SAX Document Handler
- * callback function on parser.
- *
- * @param handler A pointer to the document handler to be called
- * when the parser comes across 'document' events
- * as per the SAX specification.
- */
- virtual void setContentHandler(ContentHandler* const handler);
-
- /**
- * Allow an application to register a DTD event handler.
- *
- * If the application does not register a DTD handler, all DTD
- * events reported by the SAX parser will be silently ignored (this
- * is the default behaviour implemented by HandlerBase).
- *
- * Applications may register a new or different handler in the middle
- * of a parse, and the SAX parser must begin using the new handler
- * immediately.
- *
- * @param handler The DTD handler.
- * @see DTDHandler#DTDHandler
- * @see HandlerBase#HandlerBase
- */
- virtual void setDTDHandler(DTDHandler* const handler) ;
+ /**
+ * Allow an application to register a DTD event handler.
+ *
+ * If the application does not register a DTD handler, all DTD
+ * events reported by the SAX parser will be silently ignored (this
+ * is the default behaviour implemented by HandlerBase).
+ *
+ * Applications may register a new or different handler in the middle
+ * of a parse, and the SAX parser must begin using the new handler
+ * immediately.
+ *
+ * @param handler The DTD handler.
+ * @see DTDHandler#DTDHandler
+ * @see HandlerBase#HandlerBase
+ */
+ virtual void setDTDHandler(DTDHandler* const handler) ;
/**
* Allow an application to register a custom entity resolver.
@@ -641,92 +362,6 @@
*/
virtual void setErrorHandler(ErrorHandler* const handler) ;
- /**
- * Allow an application to register a lexical event handler.
- *
- * If the application does not register a lexical handler,
- * all events reported by the SAX parser will be silently
- * ignored. (this is the default behaviour implemented by HandlerBase).
- *
- * Applications may register a new or different handler in the
- * middle of a parse, and the SAX parser must begin using the new
- * handler immediately.
- *
- * @param handler The error handler.
- * @see LexicalHandler#LexicalHandler
- * @see SAXException#SAXException
- * @see HandlerBase#HandlerBase
- */
- virtual void setLexicalHandler(LexicalHandler* const handler) ;
-
- /**
- * Allow an application to register a declaration event handler.
- *
- * If the application does not register a declaration handler,
- * all events reported by the SAX parser will be silently
- * ignored. (this is the default behaviour implemented by DefaultHandler).
- *
- * Applications may register a new or different handler in the
- * middle of a parse, and the SAX parser must begin using the new
- * handler immediately.
- *
- * @param handler The DTD declaration handler.
- * @see DeclHandler#DeclHandler
- * @see SAXException#SAXException
- * @see DefaultHandler#DefaultHandler
- */
- virtual void setDeclarationHandler(DeclHandler* const handler);
-
- /**
- * This method allows users to set the parser's behaviour when it
- * encounters the first fatal error. If set to true, the parser
- * will exit at the first fatal error. If false, then it will
- * report the error and continue processing.
- *
- * <p>The default value is 'true' and the parser exits on the
- * first fatal error.</p>
- *
- * <p>Or you can set the feature "http://apache.org/xml/features/continue-after-fatal-error"
- * which has the opposite behaviour.</p>
- *
- * <p>If both the feature above and this function are used, the latter takes effect.</p>
- *
- * @param newState The value specifying whether the parser should
- * continue or exit when it encounters the first
- * fatal error.
- *
- * @see #getExitOnFirstFatalError
- * @see #setFeature
- */
- virtual void setExitOnFirstFatalError(const bool newState);
-
- /**
- * This method allows users to set the parser's behaviour when it
- * encounters a validtion constraint error. If set to true, and the
- * the parser will treat validation error as fatal and will exit depends on the
- * state of "getExitOnFirstFatalError". If false, then it will
- * report the error and continue processing.
- *
- * Note: setting this true does not mean the validation error will be printed with
- * the word "Fatal Error". It is still printed as "Error", but the parser
- * will exit if "setExitOnFirstFatalError" is set to true.
- *
- * <p>The default value is 'false'.</p>
- *
- * <p>Or you can set the feature "http://apache.org/xml/features/validation-error-as-fatal"
- * which means the same thing.</p>
- *
- * <p>If both the feature above and this function are used, the latter takes effect.</p>
- *
- * @param newState If true, the parser will exit if "setExitOnFirstFatalError"
- * is set to true.
- *
- * @see #getValidationConstraintFatal
- * @see #setExitOnFirstFatalError
- * @see #setFeature
- */
- virtual void setValidationConstraintFatal(const bool newState);
-
/**
* Set the state of any feature in a SAX2 XMLReader.
* Supported features in SAX2 for xerces-c are:
@@ -750,16 +385,7 @@
* @exception SAXNotSupportedException Feature modification is not supported during parse
*
*/
- virtual void setFeature(const XMLCh* const name, const bool value);
-
- /**
- * Query the current state of any feature in a SAX2 XMLReader.
- *
- * @param name The unique identifier (URI) of the feature being set.
- * @return The current state of the feature.
- * @exception SAXNotRecognizedException If the requested feature is not known.
- */
- virtual bool getFeature(const XMLCh* const name) const;
+ virtual void setFeature(const XMLCh* const name, const bool value) ;
/**
* Set the value of any property in a SAX2 XMLReader.
@@ -784,29 +410,708 @@
* @exception SAXNotRecognizedException If the requested property is not known.
* @exception SAXNotSupportedException Property modification is not supported during parse
*/
- virtual void setProperty(const XMLCh* const name, void* value);
+ virtual void setProperty(const XMLCh* const name, void* value) ;
+
+ /**
+ * Parse an XML document.
+ *
+ * The application can use this method to instruct the SAX parser
+ * to begin parsing an XML document from any valid input
+ * source (a character stream, a byte stream, or a URI).
+ *
+ * Applications may not invoke this method while a parse is in
+ * progress (they should create a new Parser instead for each
+ * additional XML document). Once a parse is complete, an
+ * application may reuse the same Parser object, possibly with a
+ * different input source.
+ *
+ * @param source The input source for the top-level of the
+ * XML document.
+ * @exception SAXException Any SAX exception, possibly
+ * wrapping another exception.
+ * @exception XMLException An exception from the parser or client
+ * handler code.
+ * @see InputSource#InputSource
+ * @see #setEntityResolver
+ * @see #setDTDHandler
+ * @see #setDocumentHandler
+ * @see #setErrorHandler
+ */
+ virtual void parse
+ (
+ const InputSource& source
+ ) ;
+
+ /**
+ * Parse an XML document from a system identifier (URI).
+ *
+ * This method is a shortcut for the common case of reading a
+ * document from a system identifier. It is the exact equivalent
+ * of the following:
+ *
+ * parse(new URLInputSource(systemId));
+ *
+ * If the system identifier is a URL, it must be fully resolved
+ * by the application before it is passed to the parser.
+ *
+ * @param systemId The system identifier (URI).
+ * @exception SAXException Any SAX exception, possibly
+ * wrapping another exception.
+ * @exception XMLException An exception from the parser or client
+ * handler code.
+ * @see #parse(InputSource)
+ */
+ virtual void parse
+ (
+ const XMLCh* const systemId
+ ) ;
+
+ /**
+ * Parse an XML document from a system identifier (URI).
+ *
+ * This method is a shortcut for the common case of reading a
+ * document from a system identifier. It is the exact equivalent
+ * of the following:
+ *
+ * parse(new URLInputSource(systemId));
+ *
+ * If the system identifier is a URL, it must be fully resolved
+ * by the application before it is passed to the parser.
+ *
+ * @param systemId The system identifier (URI).
+ * @exception SAXException Any SAX exception, possibly
+ * wrapping another exception.
+ * @exception XMLException An exception from the parser or client
+ * handler code.
+ * @see #parse(InputSource)
+ */
+ virtual void parse
+ (
+ const char* const systemId
+ ) ;
+
+ //@}
+
+ // -----------------------------------------------------------------------
+ // SAX 2.0-ext
+ // -----------------------------------------------------------------------
+ /** @name SAX 2.0-ext */
+ //@{
+ /**
+ * This method returns the installed declaration handler.
+ *
+ * @return A pointer to the installed declaration handler object.
+ */
+ virtual DeclHandler* getDeclarationHandler() const ;
+
+ /**
+ * This method returns the installed lexical handler.
+ *
+ * @return A pointer to the installed lexical handler object.
+ */
+ virtual LexicalHandler* getLexicalHandler() const ;
+
+ /**
+ * Allow an application to register a declaration event handler.
+ *
+ * If the application does not register a declaration handler,
+ * all events reported by the SAX parser will be silently
+ * ignored. (this is the default behaviour implemented by DefaultHandler).
+ *
+ * Applications may register a new or different handler in the
+ * middle of a parse, and the SAX parser must begin using the new
+ * handler immediately.
+ *
+ * @param handler The DTD declaration handler.
+ * @see DeclHandler#DeclHandler
+ * @see SAXException#SAXException
+ * @see DefaultHandler#DefaultHandler
+ */
+ virtual void setDeclarationHandler(DeclHandler* const handler) ;
+
+ /**
+ * Allow an application to register a lexical event handler.
+ *
+ * If the application does not register a lexical handler,
+ * all events reported by the SAX parser will be silently
+ * ignored. (this is the default behaviour implemented by HandlerBase).
+ *
+ * Applications may register a new or different handler in the
+ * middle of a parse, and the SAX parser must begin using the new
+ * handler immediately.
+ *
+ * @param handler The error handler.
+ * @see LexicalHandler#LexicalHandler
+ * @see SAXException#SAXException
+ * @see HandlerBase#HandlerBase
+ */
+ virtual void setLexicalHandler(LexicalHandler* const handler) ;
+
+ //@}
+
+ // -----------------------------------------------------------------------
+ // Getter Methods
+ // -----------------------------------------------------------------------
+ /** @name Getter Methods (Xerces-C specific) */
+ //@{
+ /**
+ * This method is used to get the current validator.
+ *
+ * <b>SAX2XMLReader assumes responsibility for the validator. It will be
+ * deleted when the XMLReader is destroyed.</b>
+ *
+ * @return A pointer to the validator. An application should not deleted
+ * the object returned.
+ *
+ */
+ virtual XMLValidator* getValidator() const ;
+ //@}
+
+ /** Get error count from the last parse operation.
+ *
+ * This method returns the error count from the last parse
+ * operation. Note that this count is actually stored in the
+ * scanner, so this method simply returns what the
+ * scanner reports.
+ *
+ * @return number of errors encountered during the latest
+ * parse operation.
+ */
+ virtual int getErrorCount() const ;
+
+ /**
+ * This method returns the state of the parser's
+ * exit-on-First-Fatal-Error flag.
+ *
+ * <p>Or you can query the feature "http://apache.org/xml/features/continue-after-fatal-error"
+ * which indicates the opposite state.</p>
+ *
+ * @return true, if the parser is currently configured to
+ * exit on the first fatal error, false otherwise.
+ *
+ * @see #setExitOnFirstFatalError
+ * @see #getFeature
+ */
+ virtual bool getExitOnFirstFatalError() const ;
+
+ /**
+ * This method returns the state of the parser's
+ * validation-constraint-fatal flag.
+ *
+ * <p>Or you can query the feature "http://apache.org/xml/features/validation-error-as-fatal"
+ * which means the same thing.
+ *
+ * @return true, if the parser is currently configured to
+ * set validation constraint errors as fatal, false
+ * otherwise.
+ *
+ * @see #setValidationContraintFatal
+ * @see #getFeature
+ */
+ virtual bool getValidationConstraintFatal() const ;
+ //@}
+
+ // -----------------------------------------------------------------------
+ // Setter Methods
+ // -----------------------------------------------------------------------
+ /** @name Setter Methods (Xerces-C specific) */
+ //@{
+ /**
+ * This method is used to set a validator.
+ *
+ * <b>SAX2XMLReader assumes responsibility for the validator. It will be
+ * deleted when the XMLReader is destroyed.</b>
+ *
+ * @param valueToAdopt A pointer to the validator that the reader should use.
+ *
+ */
+ virtual void setValidator(XMLValidator* valueToAdopt) ;
+
+ /**
+ * This method allows users to set the parser's behaviour when it
+ * encounters the first fatal error. If set to true, the parser
+ * will exit at the first fatal error. If false, then it will
+ * report the error and continue processing.
+ *
+ * <p>The default value is 'true' and the parser exits on the
+ * first fatal error.</p>
+ *
+ * <p>Or you can set the feature "http://apache.org/xml/features/continue-after-fatal-error"
+ * which has the opposite behaviour.</p>
+ *
+ * <p>If both the feature above and this function are used, the latter takes effect.</p>
+ *
+ * @param newState The value specifying whether the parser should
+ * continue or exit when it encounters the first
+ * fatal error.
+ *
+ * @see #getExitOnFirstFatalError
+ * @see #setFeature
+ */
+ virtual void setExitOnFirstFatalError(const bool newState) ;
+
+ /**
+ * This method allows users to set the parser's behaviour when it
+ * encounters a validtion constraint error. If set to true, and the
+ * the parser will treat validation error as fatal and will exit depends on the
+ * state of "getExitOnFirstFatalError". If false, then it will
+ * report the error and continue processing.
+ *
+ * Note: setting this true does not mean the validation error will be printed with
+ * the word "Fatal Error". It is still printed as "Error", but the parser
+ * will exit if "setExitOnFirstFatalError" is set to true.
+ *
+ * <p>The default value is 'false'.</p>
+ *
+ * <p>Or you can set the feature "http://apache.org/xml/features/validation-error-as-fatal"
+ * which means the same thing.</p>
+ *
+ * <p>If both the feature above and this function are used, the latter takes effect.</p>
+ *
+ * @param newState If true, the parser will exit if "setExitOnFirstFatalError"
+ * is set to true.
+ *
+ * @see #getValidationConstraintFatal
+ * @see #setExitOnFirstFatalError
+ * @see #setFeature
+ */
+ virtual void setValidationConstraintFatal(const bool newState) ;
+ //@}
+
+
+ // -----------------------------------------------------------------------
+ // Progressive scan methods
+ // -----------------------------------------------------------------------
+
+ /** @name Progressive scan methods */
+ //@{
+
+ /** Begin a progressive parse operation
+ *
+ * This method is used to start a progressive parse on a XML file.
+ * To continue parsing, subsequent calls must be to the parseNext
+ * method.
+ *
+ * It scans through the prolog and returns a token to be used on
+ * subsequent scanNext() calls. If the return value is true, then the
+ * token is legal and ready for further use. If it returns false, then
+ * the scan of the prolog failed and the token is not going to work on
+ * subsequent scanNext() calls.
+ *
+ * @param systemId A pointer to a Unicode string represting the path
+ * to the XML file to be parsed.
+ * @param toFill A token maintaing state information to maintain
+ * internal consistency between invocation of 'parseNext'
+ * calls.
+ *
+ * @return 'true', if successful in parsing the prolog. It indicates the
+ * user can go ahead with parsing the rest of the file. It
+ * returns 'false' to indicate that the parser could parse the
+ * prolog (which means the token will not be valid.)
+ *
+ * @see #parseNext
+ * @see #parseFirst(char*,...)
+ * @see #parseFirst(InputSource&,...)
+ */
+ virtual bool parseFirst
+ (
+ const XMLCh* const systemId
+ , XMLPScanToken& toFill
+ ) ;
+
+ /** Begin a progressive parse operation
+ *
+ * This method is used to start a progressive parse on a XML file.
+ * To continue parsing, subsequent calls must be to the parseNext
+ * method.
+ *
+ * It scans through the prolog and returns a token to be used on
+ * subsequent scanNext() calls. If the return value is true, then the
+ * token is legal and ready for further use. If it returns false, then
+ * the scan of the prolog failed and the token is not going to work on
+ * subsequent scanNext() calls.
+ *
+ * @param systemId A pointer to a regular native string represting
+ * the path to the XML file to be parsed.
+ * @param toFill A token maintaing state information to maintain
+ * internal consIstency between invocation of 'parseNext'
+ * calls.
+ *
+ * @return 'true', if successful in parsing the prolog. It indicates the
+ * user can go ahead with parsing the rest of the file. It
+ * returns 'false' to indicate that the parser could not parse
+ * the prolog.
+ *
+ * @see #parseNext
+ * @see #parseFirst(XMLCh*,...)
+ * @see #parseFirst(InputSource&,...)
+ */
+ virtual bool parseFirst
+ (
+ const char* const systemId
+ , XMLPScanToken& toFill
+ ) ;
+
+ /** Begin a progressive parse operation
+ *
+ * This method is used to start a progressive parse on a XML file.
+ * To continue parsing, subsequent calls must be to the parseNext
+ * method.
+ *
+ * It scans through the prolog and returns a token to be used on
+ * subsequent scanNext() calls. If the return value is true, then the
+ * token is legal and ready for further use. If it returns false, then
+ * the scan of the prolog failed and the token is not going to work on
+ * subsequent scanNext() calls.
+ *
+ * @param source A const reference to the InputSource object which
+ * points to the XML file to be parsed.
+ * @param toFill A token maintaing state information to maintain
+ * internal consistency between invocation of 'parseNext'
+ * calls.
+ *
+ * @return 'true', if successful in parsing the prolog. It indicates the
+ * user can go ahead with parsing the rest of the file. It
+ * returns 'false' to indicate that the parser could not parse
+ * the prolog.
+ *
+ * @see #parseNext
+ * @see #parseFirst(XMLCh*,...)
+ * @see #parseFirst(char*,...)
+ */
+ virtual bool parseFirst
+ (
+ const InputSource& source
+ , XMLPScanToken& toFill
+ ) ;
+
+ /** Continue a progressive parse operation
+ *
+ * This method is used to continue with progressive parsing of
+ * XML files started by a call to 'parseFirst' method.
+ *
+ * It parses the XML file and stops as soon as it comes across
+ * a XML token (as defined in the XML specification). Relevant
+ * callback handlers are invoked as required by the SAX
+ * specification.
+ *
+ * @param token A token maintaing state information to maintain
+ * internal consistency between invocation of 'parseNext'
+ * calls.
+ *
+ * @return 'true', if successful in parsing the next XML token.
+ * It indicates the user can go ahead with parsing the rest
+ * of the file. It returns 'false' to indicate that the parser
+ * could not find next token as per the XML specification
+ * production rule.
+ *
+ * @see #parseFirst(XMLCh*,...)
+ * @see #parseFirst(char*,...)
+ * @see #parseFirst(InputSource&,...)
+ */
+ virtual bool parseNext(XMLPScanToken& token) ;
+
+ /** Reset the parser after a progressive parse
+ *
+ * If a progressive parse loop exits before the end of the document
+ * is reached, the parser has no way of knowing this. So it will leave
+ * open any files or sockets or memory buffers that were in use at
+ * the time that the parse loop exited.
+ *
+ * The next parse operation will cause these open files and such to
+ * be closed, but the next parse operation might occur at some unknown
+ * future point. To avoid this problem, you should reset the parser if
+ * you exit the loop early.
+ *
+ * If you exited because of an error, then this cleanup will be done
+ * for you. Its only when you exit the file prematurely of your own
+ * accord, because you've found what you wanted in the file most
+ * likely.
+ *
+ * @param token A token maintaing state information to maintain
+ * internal consistency between invocation of 'parseNext'
+ * calls.
+ */
+ virtual void parseReset(XMLPScanToken& token) ;
+
+ //@}
+
+
+ // -----------------------------------------------------------------------
+ // Advanced document handler list maintenance methods
+ // -----------------------------------------------------------------------
+
+ /** @name Advanced document handler list maintenance methods */
+ //@{
+ /**
+ * This method installs the specified 'advanced' document callback
+ * handler, thereby allowing the user to customize the processing,
+ * if they choose to do so. Any number of advanced callback handlers
+ * maybe installed.
+ *
+ * <p>The methods in the advanced callback interface represent
+ * Xerces-C extensions. There is no specification for this interface.</p>
+ *
+ * @param toInstall A pointer to the users advanced callback handler.
+ *
+ * @see #removeAdvDocHandler
+ */
+ virtual void installAdvDocHandler(XMLDocumentHandler* const toInstall) ;
+
+ /**
+ * This method removes the 'advanced' document handler callback from
+ * the underlying parser scanner. If no handler is installed, advanced
+ * callbacks are not invoked by the scanner.
+ * @param toRemove A pointer to the advanced callback handler which
+ * should be removed.
+ *
+ * @see #installAdvDocHandler
+ */
+ virtual bool removeAdvDocHandler(XMLDocumentHandler* const toRemove) ;
+ //@}
+
+ // -----------------------------------------------------------------------
+ // Implementation of the XMLDocumentHandler interface
+ // -----------------------------------------------------------------------
+ /** @name Implementation of the XMLDocumentHandler Interface. */
+ //@{
+ /**
+ * This method is used to report all the characters scanned
+ * by the parser. The driver will invoke the 'characters'
+ * method of the user installed SAX Document Handler.
+ *
+ * <p>If any advanced callback handlers are installed, the
+ * corresponding 'docCharacters' method will also be invoked.</p>
+ *
+ * @param chars A const pointer to a Unicode string representing the
+ * character data.
+ * @param length The length of the Unicode string returned in 'chars'.
+ * @param cdataSection A flag indicating if the characters represent
+ * content from the CDATA section.
+ * @see DocumentHandler#characters
+ */
+ virtual void docCharacters
+ (
+ const XMLCh* const chars
+ , const unsigned int length
+ , const bool cdataSection
+ );
+
+ /**
+ * This method is used to report any comments scanned by the parser.
+ * This method is a no-op unless, unless an advanced callback handler
+ * is installed, in which case the corresponding 'docComment' method
+ * is invoked.
+ *
+ * @param comment A const pointer to a null terminated Unicode
+ * string representing the comment text.
+ */
+ virtual void docComment
+ (
+ const XMLCh* const comment
+ );
+
+ /**
+ * This method is used to report any PI scanned by the parser.
+ *
+ * <p>Any PI's occurring before any 'content' are not reported
+ * to any SAX handler as per the specification. However, all
+ * PI's within content are reported via the SAX Document Handler's
+ * 'processingInstruction' method.
+ *
+ * <p>If any advanced callback handlers are installed, the
+ * corresponding 'docPI' method will be invoked.</p>
+ *
+ * @param target A const pointer to a Unicode string representing the
+ * target of the PI declaration.
+ * @param data A const pointer to a Unicode string representing the
+ * data of the PI declaration. See the PI production rule
+ * in the XML specification for details.
+ *
+ * @see DocumentHandler#processingInstruction
+ */
+ virtual void docPI
+ (
+ const XMLCh* const target
+ , const XMLCh* const data
+ );
+
+ /**
+ * This method is used to indicate the end of root element
+ * was just scanned by the parser. Corresponding 'endDocument'
+ * method of the user installed SAX Document Handler will also
+ * be invoked.
+ *
+ * <p>In addition, if any advanced callback handlers are installed,
+ * the corresponding 'endDocument' method is invoked.</p>
+ *
+ * @see DocumentHandler#endDocument
+ */
+ virtual void endDocument();
+
+ /**
+ * This method is used to indicate the end tag of an element.
+ * The driver will invoke the corresponding 'endElement' method of
+ * the SAX Document Handler interface.
+ *
+ * <p>If any advanced callback handlers are installed, the
+ * corresponding 'endElement' method is also invoked.</p>
+ *
+ * @param elemDecl A const reference to the object containing element
+ * declaration information.
+ * @param urlId An id referring to the namespace prefix, if
+ * namespaces setting is switched on.
+ * @param isRoot A flag indicating whether this element was the
+ * root element.
+ * @param elemPrefix A const pointer to a Unicode string containing
+ * the namespace prefix for this element. Applicable
+ * only when namespace processing is enabled.
+ * @see DocumentHandler#endElement
+ */
+ virtual void endElement
+ (
+ const XMLElementDecl& elemDecl
+ , const unsigned int urlId
+ , const bool isRoot
+ , const XMLCh* const elemPrefix=0
+ );
+
+ /**
+ * This method is used to indicate that an end of an entity reference
+ * was just scanned.
+ *
+ * <p>If any advanced callback handlers are installed, the
+ * corresponding 'endEnityReference' method is invoked.</p>
+ *
+ * @param entDecl A const reference to the object containing the
+ * entity declaration information.
+ */
+ virtual void endEntityReference
+ (
+ const XMLEntityDecl& entDecl
+ );
+
+ /**
+ * This method is used to report all the whitespace characters,
+ * which are determined to be 'ignorable'. This distinction
+ * between characters is only made, if validation is enabled.
+ * Corresponding 'ignorableWhitespace' method of the user installed
+ * SAX Document Handler interface is called.
+ *
+ * <p>Any whitespace before content is not reported to the SAX
+ * Document Handler method, as per the SAX specification.
+ * However, if any advanced callback handlers are installed, the
+ * corresponding 'ignorableWhitespace' method is invoked.</p>
+ *
+ * @param chars A const pointer to a Unicode string representing the
+ * ignorable whitespace character data.
+ * @param length The length of the Unicode string 'chars'.
+ * @param cdataSection A flag indicating if the characters represent
+ * content from the CDATA section.
+ * @see DocumentHandler#ignorableWhitespace
+ */
+ virtual void ignorableWhitespace
+ (
+ const XMLCh* const chars
+ , const unsigned int length
+ , const bool cdataSection
+ );
+
+ /**
+ * This method allows the user installed Document Handler and
+ * any advanced callback handlers to 'reset' themselves.
+ */
+ virtual void resetDocument();
+
+ /**
+ * This method is used to report the start of the parsing process.
+ * The corresponding user installed SAX Document Handler's method
+ * 'startDocument' is invoked.
+ *
+ * <p>If any advanced callback handlers are installed, then the
+ * corresponding 'startDocument' method is also called.</p>
+ *
+ * @see DocumentHandler#startDocument
+ */
+ virtual void startDocument();
+
+ /**
+ * This method is used to report the start of an element. It is
+ * called at the end of the element, by which time all attributes
+ * specified are also parsed. The corresponding user installed
+ * SAX Document Handler's method 'startElement' is invoked.
+ *
+ * <p>If any advanced callback handlers are installed, then the
+ * corresponding 'startElement' method is also called.</p>
+ *
+ * @param elemDecl A const reference to the object containing element
+ * declaration information.
+ * @param urlId An id referring to the namespace prefix, if
+ * namespaces setting is switched on.
+ * @param elemPrefix A const pointer to a Unicode string containing
+ * the namespace prefix for this element. Applicable
+ * only when namespace processing is enabled.
+ * @param attrList A const reference to the object containing the
+ * list of attributes just scanned for this element.
+ * @param attrCount A count of number of attributes in the list
+ * specified by the parameter 'attrList'.
+ * @param isEmpty A flag indicating whether this is an empty element
+ * or not.
+ * @param isRoot A flag indicating whether this element was the
+ * root element.
+ * @see DocumentHandler#startElement
+ */
+ virtual void startElement
+ (
+ const XMLElementDecl& elemDecl
+ , const unsigned int urlId
+ , const XMLCh* const elemPrefix
+ , const RefVectorOf<XMLAttr>& attrList
+ , const unsigned int attrCount
+ , const bool isEmpty
+ , const bool isRoot
+ );
+
+ /**
+ * This method is used to indicate the start of an entity reference.
+ *
+ * <p>If any advanced callback handlers are installed, the
+ * corresponding 'endEnityReference' method is invoked.</p>
+ *
+ * @param entDecl A const reference to the object containing the
+ * entity declaration information.
+ */
+ virtual void startEntityReference
+ (
+ const XMLEntityDecl& entDecl
+ );
+
+ /**
+ * This method is used to report the XML decl scanned by the parser.
+ * Refer to the XML specification to see the meaning of parameters.
+ *
+ * <b><font color="#FF0000">This method is a no-op for this SAX driver
+ * implementation.</font></b>
+ *
+ * @param versionStr A const pointer to a Unicode string representing
+ * version string value.
+ * @param encodingStr A const pointer to a Unicode string representing
+ * the encoding string value.
+ * @param standaloneStr A const pointer to a Unicode string
+ * representing the standalone string value.
+ * @param actualEncodingStr A const pointer to a Unicode string
+ * representing the actual encoding string
+ * value.
+ */
+ virtual void XMLDecl
+ (
+ const XMLCh* const versionStr
+ , const XMLCh* const encodingStr
+ , const XMLCh* const standaloneStr
+ , const XMLCh* const actualEncodingStr
+ );
+ //@}
- /**
- * Query the current value of a property in a SAX2 XMLReader.
- *
- * The parser owns the returned pointer. The memory allocated for
- * the returned pointer will be destroyed when the parser is deleted.
- *
- * To ensure assessiblity of the returned information after the parser
- * is deleted, callers need to copy and store the returned information
- * somewhere else; otherwise you may get unexpected result. Since the returned
- * pointer is a generic void pointer, see
- * http://xml.apache.org/xerces-c/program-sax2.html#SAX2Properties to learn
- * exactly what type of property value each property returns for replication.
- *
- * @param name The unique identifier (URI) of the property being set.
- * @return The current value of the property. The pointer spans the same
- * life-time as the parser. A null pointer is returned if nothing
- * was specified externally.
- * @exception SAXNotRecognizedException If the requested property is not known.
- */
- virtual void* getProperty(const XMLCh* const name) const;
- //@}
// -----------------------------------------------------------------------
// Implementation of the XMLErrorReporter interface
@@ -951,10 +1256,10 @@
//@}
// -----------------------------------------------------------------------
- // Implementation of the DocTypeHandler Interface
+ // Implementation of the Deprecated DocTypeHandler Interface
// -----------------------------------------------------------------------
- /** @name Implementation of the DocTypeHandler Interface */
+ /** @name Implementation of the deprecated DocTypeHandler Interface */
//@{
/**
* This method is used to report an attribute definition.
@@ -1195,224 +1500,6 @@
);
//@}
- // -----------------------------------------------------------------------
- // Validator: setters and getters
- // -----------------------------------------------------------------------
- /** @name Validator: setters and getters (Xerces-C specific) */
- //@{
- /**
- * This method is used to set a validator.
- *
- * <b>SAX2XMLReader assumes responsibility for the validator. It will be
- * deleted when the XMLReader is destroyed.</b>
- *
- * @param valueToAdopt A pointer to the validator that the reader should use.
- *
- */
- virtual void setValidator(XMLValidator* valueToAdopt);
-
- /**
- * This method is used to get the current validator.
- *
- * <b>SAX2XMLReader assumes responsibility for the validator. It will be
- * deleted when the XMLReader is destroyed.</b>
- *
- * @return A pointer to the validator. An application should not delete
- * the object returned.
- *
- */
- virtual XMLValidator* getValidator() const;
- //@}
-
- // -----------------------------------------------------------------------
- // Advanced document handler list maintenance methods
- // -----------------------------------------------------------------------
-
- /** @name Advanced document handler list maintenance methods */
- //@{
- /**
- * This method installs the specified 'advanced' document callback
- * handler, thereby allowing the user to customize the processing,
- * if they choose to do so. Any number of advanced callback handlers
- * maybe installed.
- *
- * <p>The methods in the advanced callback interface represent
- * Xerces-C extensions. There is no specification for this interface.</p>
- *
- * @param toInstall A pointer to the users advanced callback handler.
- *
- * @see #removeAdvDocHandler
- */
- virtual void installAdvDocHandler(XMLDocumentHandler* const toInstall);
-
- /**
- * This method removes the 'advanced' document handler callback from
- * the underlying parser scanner. If no handler is installed, advanced
- * callbacks are not invoked by the scanner.
- * @param toRemove A pointer to the advanced callback handler which
- * should be removed.
- *
- * @see #installAdvDocHandler
- */
- virtual bool removeAdvDocHandler(XMLDocumentHandler* const toRemove);
- //@}
-
- // -----------------------------------------------------------------------
- // Progressive scan methods
- // -----------------------------------------------------------------------
-
- /** @name Progressive scan methods */
- //@{
-
- /** Begin a progressive parse operation
- *
- * This method is used to start a progressive parse on a XML file.
- * To continue parsing, subsequent calls must be to the parseNext
- * method.
- *
- * It scans through the prolog and returns a token to be used on
- * subsequent scanNext() calls. If the return value is true, then the
- * token is legal and ready for further use. If it returns false, then
- * the scan of the prolog failed and the token is not going to work on
- * subsequent scanNext() calls.
- *
- * @param systemId A pointer to a Unicode string represting the path
- * to the XML file to be parsed.
- * @param toFill A token maintaing state information to maintain
- * internal consistency between invocation of 'parseNext'
- * calls.
- *
- * @return 'true', if successful in parsing the prolog. It indicates the
- * user can go ahead with parsing the rest of the file. It
- * returns 'false' to indicate that the parser could parse the
- * prolog (which means the token will not be valid.)
- *
- * @see #parseNext
- * @see #parseFirst(char*,...)
- * @see #parseFirst(InputSource&,...)
- */
- virtual bool parseFirst
- (
- const XMLCh* const systemId
- , XMLPScanToken& toFill
- );
-
- /** Begin a progressive parse operation
- *
- * This method is used to start a progressive parse on a XML file.
- * To continue parsing, subsequent calls must be to the parseNext
- * method.
- *
- * It scans through the prolog and returns a token to be used on
- * subsequent scanNext() calls. If the return value is true, then the
- * token is legal and ready for further use. If it returns false, then
- * the scan of the prolog failed and the token is not going to work on
- * subsequent scanNext() calls.
- *
- * @param systemId A pointer to a regular native string represting
- * the path to the XML file to be parsed.
- * @param toFill A token maintaing state information to maintain
- * internal consIstency between invocation of 'parseNext'
- * calls.
- *
- * @return 'true', if successful in parsing the prolog. It indicates the
- * user can go ahead with parsing the rest of the file. It
- * returns 'false' to indicate that the parser could not parse
- * the prolog.
- *
- * @see #parseNext
- * @see #parseFirst(XMLCh*,...)
- * @see #parseFirst(InputSource&,...)
- */
- virtual bool parseFirst
- (
- const char* const systemId
- , XMLPScanToken& toFill
- );
-
- /** Begin a progressive parse operation
- *
- * This method is used to start a progressive parse on a XML file.
- * To continue parsing, subsequent calls must be to the parseNext
- * method.
- *
- * It scans through the prolog and returns a token to be used on
- * subsequent scanNext() calls. If the return value is true, then the
- * token is legal and ready for further use. If it returns false, then
- * the scan of the prolog failed and the token is not going to work on
- * subsequent scanNext() calls.
- *
- * @param source A const reference to the InputSource object which
- * points to the XML file to be parsed.
- * @param toFill A token maintaing state information to maintain
- * internal consistency between invocation of 'parseNext'
- * calls.
- *
- * @return 'true', if successful in parsing the prolog. It indicates the
- * user can go ahead with parsing the rest of the file. It
- * returns 'false' to indicate that the parser could not parse
- * the prolog.
- *
- * @see #parseNext
- * @see #parseFirst(XMLCh*,...)
- * @see #parseFirst(char*,...)
- */
- virtual bool parseFirst
- (
- const InputSource& source
- , XMLPScanToken& toFill
- );
-
- /** Continue a progressive parse operation
- *
- * This method is used to continue with progressive parsing of
- * XML files started by a call to 'parseFirst' method.
- *
- * It parses the XML file and stops as soon as it comes across
- * a XML token (as defined in the XML specification). Relevant
- * callback handlers are invoked as required by the SAX
- * specification.
- *
- * @param token A token maintaing state information to maintain
- * internal consistency between invocation of 'parseNext'
- * calls.
- *
- * @return 'true', if successful in parsing the next XML token.
- * It indicates the user can go ahead with parsing the rest
- * of the file. It returns 'false' to indicate that the parser
- * could not find next token as per the XML specification
- * production rule.
- *
- * @see #parseFirst(XMLCh*,...)
- * @see #parseFirst(char*,...)
- * @see #parseFirst(InputSource&,...)
- */
- virtual bool parseNext(XMLPScanToken& token);
-
- /** Reset the parser after a progressive parse
- *
- * If a progressive parse loop exits before the end of the document
- * is reached, the parser has no way of knowing this. So it will leave
- * open any files or sockets or memory buffers that were in use at
- * the time that the parse loop exited.
- *
- * The next parse operation will cause these open files and such to
- * be closed, but the next parse operation might occur at some unknown
- * future point. To avoid this problem, you should reset the parser if
- * you exit the loop early.
- *
- * If you exited because of an error, then this cleanup will be done
- * for you. Its only when you exit the file prematurely of your own
- * accord, because you've found what you wanted in the file most
- * likely.
- *
- * @param token A token maintaing state information to maintain
- * internal consistency between invocation of 'parseNext'
- * calls.
- */
- virtual void parseReset(XMLPScanToken& token);
-
- //@}
private :
// -----------------------------------------------------------------------
---------------------------------------------------------------------
To unsubscribe, e-mail: xerces-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: xerces-cvs-help@xml.apache.org