HandlerBase.hpp
上传用户:zhuqijet
上传日期:2013-06-25
资源大小:10074k
文件大小:17k
源码类别:

词法分析

开发平台:

Visual C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 1999-2000 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Xerces" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation, and was
  51.  * originally based on software copyright (c) 1999, International
  52.  * Business Machines, Inc., http://www.ibm.com .  For more information
  53.  * on the Apache Software Foundation, please see
  54.  * <http://www.apache.org/>.
  55.  */
  56. /*
  57.  * $Log: HandlerBase.hpp,v $
  58.  * Revision 1.5  2002/11/04 14:56:25  tng
  59.  * C++ Namespace Support.
  60.  *
  61.  * Revision 1.4  2002/07/16 18:15:00  tng
  62.  * [Bug 6070] warning unused variable in HandlerBase.hpp
  63.  *
  64.  * Revision 1.3  2002/06/06 20:39:16  tng
  65.  * Document Fix: document that the returned object from resolveEntity is owned by the parser
  66.  *
  67.  * Revision 1.2  2002/02/20 18:17:01  tng
  68.  * [Bug 5977] Warnings on generating apiDocs.
  69.  *
  70.  * Revision 1.1.1.1  2002/02/01 22:22:08  peiyongz
  71.  * sane_include
  72.  *
  73.  * Revision 1.6  2000/03/02 19:54:35  roddey
  74.  * This checkin includes many changes done while waiting for the
  75.  * 1.1.0 code to be finished. I can't list them all here, but a list is
  76.  * available elsewhere.
  77.  *
  78.  * Revision 1.5  2000/02/24 20:12:55  abagchi
  79.  * Swat for removing Log from API docs
  80.  *
  81.  * Revision 1.4  2000/02/12 03:31:55  rahulj
  82.  * Removed duplicate CVS Log entries.
  83.  *
  84.  * Revision 1.3  2000/02/12 01:27:19  aruna1
  85.  * Documentation updated
  86.  *
  87.  * Revision 1.2  2000/02/06 07:47:57  rahulj
  88.  * Year 2K copyright swat.
  89.  *
  90.  * Revision 1.1.1.1  1999/11/09 01:07:45  twl
  91.  * Initial checkin
  92.  *
  93.  * Revision 1.2  1999/11/08 20:45:00  rahul
  94.  * Swat for adding in Product name and CVS comment log variable.
  95.  *
  96.  */
  97. #ifndef HANDLERBASE_HPP
  98. #define HANDLERBASE_HPP
  99. #include <xercesc/sax/DocumentHandler.hpp>
  100. #include <xercesc/sax/DTDHandler.hpp>
  101. #include <xercesc/sax/EntityResolver.hpp>
  102. #include <xercesc/sax/ErrorHandler.hpp>
  103. #include <xercesc/sax/SAXParseException.hpp>
  104. XERCES_CPP_NAMESPACE_BEGIN
  105. class Locator;
  106. class AttributeList;
  107. /**
  108.   * Default base class for handlers.
  109.   *
  110.   * <p>This class implements the default behaviour for four SAX
  111.   * interfaces: EntityResolver, DTDHandler, DocumentHandler,
  112.   * and ErrorHandler.</p>
  113.   *
  114.   * <p>Application writers can extend this class when they need to
  115.   * implement only part of an interface; parser writers can
  116.   * instantiate this class to provide default handlers when the
  117.   * application has not supplied its own.</p>
  118.   *
  119.   * <p>Note that the use of this class is optional.</p>
  120.   *
  121.   * @see EntityResolver#EntityResolver
  122.   * @see DTDHandler#DTDHandler
  123.   * @see DocumentHandler#DocumentHandler
  124.   * @see ErrorHandler#ErrorHandler
  125.   */
  126. class SAX_EXPORT HandlerBase :
  127.     public EntityResolver, public DTDHandler, public DocumentHandler
  128.     , public ErrorHandler
  129. {
  130. public:
  131.     /** @name Default handlers for the DocumentHandler interface */
  132.     //@{
  133.   /**
  134.     * Receive notification of character data inside an element.
  135.     *
  136.     * <p>By default, do nothing.  Application writers may override this
  137.     * method to take specific actions for each chunk of character data
  138.     * (such as adding the data to a node or buffer, or printing it to
  139.     * a file).</p>
  140.     *
  141.     * @param chars The characters.
  142.     * @param length The number of characters to use from the
  143.     *               character array.
  144.     * @exception SAXException Any SAX exception, possibly
  145.     *            wrapping another exception.
  146.     * @see DocumentHandler#characters
  147.     */
  148.     virtual void characters
  149.     (
  150.         const   XMLCh* const    chars
  151.         , const unsigned int    length
  152.     );
  153.   /**
  154.     * Receive notification of the end of the document.
  155.     *
  156.     * <p>By default, do nothing.  Application writers may override this
  157.     * method in a subclass to take specific actions at the beginning
  158.     * of a document (such as finalising a tree or closing an output
  159.     * file).</p>
  160.     *
  161.     * @exception SAXException Any SAX exception, possibly
  162.     *            wrapping another exception.
  163.     * @see DocumentHandler#endDocument
  164.     */
  165.     virtual void endDocument();
  166.   /**
  167.     * Receive notification of the end of an element.
  168.     *
  169.     * <p>By default, do nothing.  Application writers may override this
  170.     * method in a subclass to take specific actions at the end of
  171.     * each element (such as finalising a tree node or writing
  172.     * output to a file).</p>
  173.     *
  174.     * @param name The element type name.
  175.     * @exception SAXException Any SAX exception, possibly
  176.     *            wrapping another exception.
  177.     * @see DocumentHandler#endElement
  178.     */
  179.     virtual void endElement(const XMLCh* const name);
  180.   /**
  181.     * Receive notification of ignorable whitespace in element content.
  182.     *
  183.     * <p>By default, do nothing.  Application writers may override this
  184.     * method to take specific actions for each chunk of ignorable
  185.     * whitespace (such as adding data to a node or buffer, or printing
  186.     * it to a file).</p>
  187.     *
  188.     * @param chars The whitespace characters.
  189.     * @param length The number of characters to use from the
  190.     *               character array.
  191.     * @exception SAXException Any SAX exception, possibly
  192.     *            wrapping another exception.
  193.     * @see DocumentHandler#ignorableWhitespace
  194.     */
  195.     virtual void ignorableWhitespace
  196.     (
  197.         const   XMLCh* const    chars
  198.         , const unsigned int    length
  199.     );
  200.   /**
  201.     * Receive notification of a processing instruction.
  202.     *
  203.     * <p>By default, do nothing.  Application writers may override this
  204.     * method in a subclass to take specific actions for each
  205.     * processing instruction, such as setting status variables or
  206.     * invoking other methods.</p>
  207.     *
  208.     * @param target The processing instruction target.
  209.     * @param data The processing instruction data, or null if
  210.     *             none is supplied.
  211.     * @exception SAXException Any SAX exception, possibly
  212.     *            wrapping another exception.
  213.     * @see DocumentHandler#processingInstruction
  214.     */
  215.     virtual void processingInstruction
  216.     (
  217.         const   XMLCh* const    target
  218.         , const XMLCh* const    data
  219.     );
  220.     /**
  221.     * Reset the Docuemnt object on its reuse
  222.     *
  223.     * @see DocumentHandler#resetDocument
  224.     */
  225.     virtual void resetDocument();
  226.     //@}
  227.     /** @name Default implementation of DocumentHandler interface */
  228.     //@{
  229.   /**
  230.     * Receive a Locator object for document events.
  231.     *
  232.     * <p>By default, do nothing.  Application writers may override this
  233.     * method in a subclass if they wish to store the locator for use
  234.     * with other document events.</p>
  235.     *
  236.     * @param locator A locator for all SAX document events.
  237.     * @see DocumentHandler#setDocumentLocator
  238.     * @see Locator
  239.     */
  240.     virtual void setDocumentLocator(const Locator* const locator);
  241.   /**
  242.     * Receive notification of the beginning of the document.
  243.     *
  244.     * <p>By default, do nothing.  Application writers may override this
  245.     * method in a subclass to take specific actions at the beginning
  246.     * of a document (such as allocating the root node of a tree or
  247.     * creating an output file).</p>
  248.     *
  249.     * @exception SAXException Any SAX exception, possibly
  250.     *            wrapping another exception.
  251.     * @see DocumentHandler#startDocument
  252.     */
  253.     virtual void startDocument();
  254.   /**
  255.     * Receive notification of the start of an element.
  256.     *
  257.     * <p>By default, do nothing.  Application writers may override this
  258.     * method in a subclass to take specific actions at the start of
  259.     * each element (such as allocating a new tree node or writing
  260.     * output to a file).</p>
  261.     *
  262.     * @param name The element type name.
  263.     * @param attributes The specified or defaulted attributes.
  264.     * @exception SAXException Any SAX exception, possibly
  265.     *            wrapping another exception.
  266.     * @see DocumentHandler#startElement
  267.     */
  268.     virtual void startElement
  269.     (
  270.         const   XMLCh* const    name
  271.         ,       AttributeList&  attributes
  272.     );
  273.     //@}
  274.     /** @name Default implementation of the EntityResolver interface. */
  275.     //@{
  276.   /**
  277.     * Resolve an external entity.
  278.     *
  279.     * <p>Always return null, so that the parser will use the system
  280.     * identifier provided in the XML document.  This method implements
  281.     * the SAX default behaviour: application writers can override it
  282.     * in a subclass to do special translations such as catalog lookups
  283.     * or URI redirection.</p>
  284.     *
  285.     * @param publicId The public identifer, or null if none is
  286.     *                 available.
  287.     * @param systemId The system identifier provided in the XML
  288.     *                 document.
  289.     * @return The new input source, or null to require the
  290.     *         default behaviour.
  291.     *         The returned InputSource is owned by the parser which is
  292.     *         responsible to clean up the memory.
  293.     * @exception SAXException Any SAX exception, possibly
  294.     *            wrapping another exception.
  295.     * @see EntityResolver#resolveEntity
  296.     */
  297.     virtual InputSource* resolveEntity
  298.     (
  299.         const   XMLCh* const    publicId
  300.         , const XMLCh* const    systemId
  301.     );
  302.     //@}
  303.     /** @name Default implementation of the ErrorHandler interface */
  304.     //@{
  305.    /**
  306.     * Receive notification of a recoverable parser error.
  307.     *
  308.     * <p>The default implementation does nothing.  Application writers
  309.     * may override this method in a subclass to take specific actions
  310.     * for each error, such as inserting the message in a log file or
  311.     * printing it to the console.</p>
  312.     *
  313.     * @param exception The warning information encoded as an exception.
  314.     * @exception SAXException Any SAX exception, possibly
  315.     *            wrapping another exception.
  316.     * @see ErrorHandler#warning
  317.     * @see SAXParseException#SAXParseException
  318.     */
  319.     virtual void error(const SAXParseException& exception);
  320.   /**
  321.     * Report a fatal XML parsing error.
  322.     *
  323.     * <p>The default implementation throws a SAXParseException.
  324.     * Application writers may override this method in a subclass if
  325.     * they need to take specific actions for each fatal error (such as
  326.     * collecting all of the errors into a single report): in any case,
  327.     * the application must stop all regular processing when this
  328.     * method is invoked, since the document is no longer reliable, and
  329.     * the parser may no longer report parsing events.</p>
  330.     *
  331.     * @param exception The error information encoded as an exception.
  332.     * @exception SAXException Any SAX exception, possibly
  333.     *            wrapping another exception.
  334.     * @see ErrorHandler#fatalError
  335.     * @see SAXParseException#SAXParseException
  336.     */
  337.     virtual void fatalError(const SAXParseException& exception);
  338.   /**
  339.     * Receive notification of a parser warning.
  340.     *
  341.     * <p>The default implementation does nothing.  Application writers
  342.     * may override this method in a subclass to take specific actions
  343.     * for each warning, such as inserting the message in a log file or
  344.     * printing it to the console.</p>
  345.     *
  346.     * @param exception The warning information encoded as an exception.
  347.     * @exception SAXException Any SAX exception, possibly
  348.     *            wrapping another exception.
  349.     * @see ErrorHandler#warning
  350.     * @see SAXParseException#SAXParseException
  351.     */
  352.     virtual void warning(const SAXParseException& exception);
  353.     /**
  354.     * Reset the Error handler object on its reuse
  355.     *
  356.     * @see ErrorHandler#resetErrors
  357.     */
  358.     virtual void resetErrors();
  359.     //@}
  360.     /** @name Default implementation of DTDHandler interface. */
  361.     //@{
  362.   /**
  363.     * Receive notification of a notation declaration.
  364.     *
  365.     * <p>By default, do nothing.  Application writers may override this
  366.     * method in a subclass if they wish to keep track of the notations
  367.     * declared in a document.</p>
  368.     *
  369.     * @param name The notation name.
  370.     * @param publicId The notation public identifier, or null if not
  371.     *                 available.
  372.     * @param systemId The notation system identifier.
  373.     * @see DTDHandler#notationDecl
  374.     */
  375.     virtual void notationDecl
  376.     (
  377.         const   XMLCh* const    name
  378.         , const XMLCh* const    publicId
  379.         , const XMLCh* const    systemId
  380.     );
  381.     /**
  382.     * Reset the DTD object on its reuse
  383.     *
  384.     * @see DTDHandler#resetDocType
  385.     */
  386.     virtual void resetDocType();
  387.   /**
  388.     * Receive notification of an unparsed entity declaration.
  389.     *
  390.     * <p>By default, do nothing.  Application writers may override this
  391.     * method in a subclass to keep track of the unparsed entities
  392.     * declared in a document.</p>
  393.     *
  394.     * @param name The entity name.
  395.     * @param publicId The entity public identifier, or null if not
  396.     *                 available.
  397.     * @param systemId The entity system identifier.
  398.     * @param notationName The name of the associated notation.
  399.     * @see DTDHandler#unparsedEntityDecl
  400.     */
  401.     virtual void unparsedEntityDecl
  402.     (
  403.         const   XMLCh* const    name
  404.         , const XMLCh* const    publicId
  405.         , const XMLCh* const    systemId
  406.         , const XMLCh* const    notationName
  407.     );
  408.     //@}
  409. };
  410. // ---------------------------------------------------------------------------
  411. //  HandlerBase: Inline default implementations
  412. // ---------------------------------------------------------------------------
  413. inline void HandlerBase::characters(const   XMLCh* const
  414.                                     , const unsigned int)
  415. {
  416. }
  417. inline void HandlerBase::endDocument()
  418. {
  419. }
  420. inline void HandlerBase::endElement(const XMLCh* const)
  421. {
  422. }
  423. inline void HandlerBase::error(const SAXParseException&)
  424. {
  425. }
  426. inline void HandlerBase::fatalError(const SAXParseException& exception)
  427. {
  428.     throw exception;
  429. }
  430. inline void
  431. HandlerBase::ignorableWhitespace(   const   XMLCh* const
  432.                                     , const unsigned int)
  433. {
  434. }
  435. inline void HandlerBase::notationDecl(  const   XMLCh* const
  436.                                         , const XMLCh* const
  437.                                         , const XMLCh* const)
  438. {
  439. }
  440. inline void
  441. HandlerBase::processingInstruction( const   XMLCh* const
  442.                                     , const XMLCh* const)
  443. {
  444. }
  445. inline void HandlerBase::resetErrors()
  446. {
  447. }
  448. inline void HandlerBase::resetDocument()
  449. {
  450. }
  451. inline void HandlerBase::resetDocType()
  452. {
  453. }
  454. inline InputSource*
  455. HandlerBase::resolveEntity( const   XMLCh* const
  456.                             , const XMLCh* const)
  457. {
  458.     return 0;
  459. }
  460. inline void
  461. HandlerBase::unparsedEntityDecl(const   XMLCh* const
  462.                                 , const XMLCh* const
  463.                                 , const XMLCh* const
  464.                                 , const XMLCh* const)
  465. {
  466. }
  467. inline void HandlerBase::setDocumentLocator(const Locator* const)
  468. {
  469. }
  470. inline void HandlerBase::startDocument()
  471. {
  472. }
  473. inline void
  474. HandlerBase::startElement(  const   XMLCh* const
  475.                             ,       AttributeList&)
  476. {
  477. }
  478. inline void HandlerBase::warning(const SAXParseException&)
  479. {
  480. }
  481. XERCES_CPP_NAMESPACE_END
  482. #endif