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

词法分析

开发平台:

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: DTDHandler.hpp,v $
  58.  * Revision 1.4  2003/03/07 18:10:06  tng
  59.  * Return a reference instead of void for operator=
  60.  *
  61.  * Revision 1.3  2002/11/04 14:56:25  tng
  62.  * C++ Namespace Support.
  63.  *
  64.  * Revision 1.2  2002/02/20 18:17:01  tng
  65.  * [Bug 5977] Warnings on generating apiDocs.
  66.  *
  67.  * Revision 1.1.1.1  2002/02/01 22:22:08  peiyongz
  68.  * sane_include
  69.  *
  70.  * Revision 1.5  2000/02/24 20:12:54  abagchi
  71.  * Swat for removing Log from API docs
  72.  *
  73.  * Revision 1.4  2000/02/12 03:31:55  rahulj
  74.  * Removed duplicate CVS Log entries.
  75.  *
  76.  * Revision 1.3  2000/02/12 01:27:19  aruna1
  77.  * Documentation updated
  78.  *
  79.  * Revision 1.2  2000/02/06 07:47:57  rahulj
  80.  * Year 2K copyright swat.
  81.  *
  82.  * Revision 1.1.1.1  1999/11/09 01:07:44  twl
  83.  * Initial checkin
  84.  *
  85.  * Revision 1.2  1999/11/08 20:44:54  rahul
  86.  * Swat for adding in Product name and CVS comment log variable.
  87.  *
  88.  */
  89. #ifndef DTDHANDLER_HPP
  90. #define DTDHANDLER_HPP
  91. #include <xercesc/util/XercesDefs.hpp>
  92. XERCES_CPP_NAMESPACE_BEGIN
  93. /**
  94.   * Receive notification of basic DTD-related events.
  95.   *
  96.   * <p>If a SAX application needs information about notations and
  97.   * unparsed entities, then the application implements this
  98.   * interface and registers an instance with the SAX parser using
  99.   * the parser's setDTDHandler method.  The parser uses the
  100.   * instance to report notation and unparsed entity declarations to
  101.   * the application.</p>
  102.   *
  103.   * <p>The SAX parser may report these events in any order, regardless
  104.   * of the order in which the notations and unparsed entities were
  105.   * declared; however, all DTD events must be reported after the
  106.   * document handler's startDocument event, and before the first
  107.   * startElement event.</p>
  108.   *
  109.   * <p>It is up to the application to store the information for
  110.   * future use (perhaps in a hash table or object tree).
  111.   * If the application encounters attributes of type "NOTATION",
  112.   * "ENTITY", or "ENTITIES", it can use the information that it
  113.   * obtained through this interface to find the entity and/or
  114.   * notation corresponding with the attribute value.</p>
  115.   *
  116.   * <p>The HandlerBase class provides a default implementation
  117.   * of this interface, which simply ignores the events.</p>
  118.   *
  119.   * @see Parser#setDTDHandler
  120.   * @see HandlerBase#HandlerBase
  121.   */
  122. class SAX_EXPORT DTDHandler
  123. {
  124. public:
  125.     /** @name Constructors and Destructor */
  126.     //@{
  127.     /** Default Constructor */
  128.     DTDHandler()
  129.     {
  130.     }
  131.     /** Destructor */
  132.     virtual ~DTDHandler()
  133.     {
  134.     }
  135.     //@}
  136.     /** @name The DTD handler interface */
  137.     //@{
  138.   /**
  139.     * Receive notification of a notation declaration event.
  140.     *
  141.     * <p>It is up to the application to record the notation for later
  142.     * reference, if necessary.</p>
  143.     *
  144.     * <p>If a system identifier is present, and it is a URL, the SAX
  145.     * parser must resolve it fully before passing it to the
  146.     * application.</p>
  147.     *
  148.     * @param name The notation name.
  149.     * @param publicId The notation's public identifier, or null if
  150.     *        none was given.
  151.     * @param systemId The notation's system identifier, or null if
  152.     *        none was given.
  153.     * @exception SAXException Any SAX exception, possibly
  154.     *            wrapping another exception.
  155.     * @see #unparsedEntityDecl
  156.     * @see AttributeList#AttributeList
  157.     */
  158. virtual void notationDecl
  159.     (
  160.         const   XMLCh* const    name
  161.         , const XMLCh* const    publicId
  162.         , const XMLCh* const    systemId
  163.     ) = 0;
  164.   /**
  165.     * Receive notification of an unparsed entity declaration event.
  166.     *
  167.     * <p>Note that the notation name corresponds to a notation
  168.     * reported by the notationDecl() event.  It is up to the
  169.     * application to record the entity for later reference, if
  170.     * necessary.</p>
  171.     *
  172.     * <p>If the system identifier is a URL, the parser must resolve it
  173.     * fully before passing it to the application.</p>
  174.     *
  175.     * @exception SAXException Any SAX exception, possibly
  176.     *            wrapping another exception.
  177.     * @param name The unparsed entity's name.
  178.     * @param publicId The entity's public identifier, or null if none
  179.     *        was given.
  180.     * @param systemId The entity's system identifier (it must always
  181.     *        have one).
  182.     * @param notationName The name of the associated notation.
  183.     * @see #notationDecl
  184.     * @see AttributeList#AttributeList
  185.     */
  186.     virtual void unparsedEntityDecl
  187.     (
  188.         const   XMLCh* const    name
  189.         , const XMLCh* const    publicId
  190.         , const XMLCh* const    systemId
  191.         , const XMLCh* const    notationName
  192.     ) = 0;
  193.     /**
  194.     * Reset the DocType object on its reuse
  195.     *
  196.     * <p>This method helps in reseting the DTD object implementational
  197.     * defaults each time the DTD is begun.</p>
  198.     *
  199.     */
  200.     virtual void resetDocType() = 0;
  201.     //@}
  202. private :
  203.     /* Unimplemented constructors and operators */
  204.     /* Copy constructor */
  205.     DTDHandler(const DTDHandler&);
  206.     /* Assignment operator */
  207.     DTDHandler& operator=(const DTDHandler&);
  208. };
  209. XERCES_CPP_NAMESPACE_END
  210. #endif