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

词法分析

开发平台:

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: LexicalHandler.hpp,v $
  58.  * Revision 1.3  2003/03/07 18:10:30  tng
  59.  * Return a reference instead of void for operator=
  60.  *
  61.  * Revision 1.2  2002/11/04 14:55:45  tng
  62.  * C++ Namespace Support.
  63.  *
  64.  * Revision 1.1.1.1  2002/02/01 22:22:09  peiyongz
  65.  * sane_include
  66.  *
  67.  * Revision 1.1  2000/12/22 15:17:04  tng
  68.  * SAX2-ext's LexicalHandler support added by David Bertoni.
  69.  *
  70.  *
  71.  */
  72. #ifndef LEXICALHANDLER_HPP
  73. #define LEXICALHANDLER_HPP
  74. #include <xercesc/util/XercesDefs.hpp>
  75. XERCES_CPP_NAMESPACE_BEGIN
  76. /**
  77.   * Receive notification of lexical events.
  78.   *
  79.   * <p>This is an extension handler for that provides lexical information
  80.   * about an XML document.  It does not provide information about document
  81.   * content.  For those events, an application must register an instance of
  82.   * a ContentHandler.</p>
  83.   *
  84.   * <p>The order of events in this interface is very important, and
  85.   * mirrors the order of information in the document itself.  For
  86.   * example, startDTD() and endDTD() events will occur before the
  87.   * first element in the document.</p>
  88.   *
  89.   * @see SAX2XMLReader#setLexicalHandler
  90.   * @see SAX2XMLReader#setContentHandler
  91.   */
  92. class SAX2_EXPORT LexicalHandler
  93. {
  94. public:
  95.     /** @name Constructors and Destructor */
  96.     //@{
  97.     /** Default constructor */
  98.     LexicalHandler()
  99.     {
  100.     }
  101.     /** Destructor */
  102.     virtual ~LexicalHandler()
  103.     {
  104.     }
  105.     //@}
  106.     /** @name The virtual document handler interface */
  107.     //@{
  108.    /**
  109.     * Receive notification of comments.
  110.     *
  111.     * <p>The Parser will call this method to report each occurence of
  112.     * a comment in the XML document.</p>
  113.     *
  114.     * <p>The application must not attempt to read from the array
  115.     * outside of the specified range.</p>
  116.     *
  117.     * @param chars The characters from the XML document.
  118.     * @param length The number of characters to read from the array.
  119.     * @exception SAXException Any SAX exception, possibly
  120.     *            wrapping another exception.
  121.     */
  122.     virtual void comment
  123.     (
  124.         const   XMLCh* const    chars
  125.         , const unsigned int    length
  126.     ) = 0;
  127.   /**
  128.     * Receive notification of the end of a CDATA section.
  129.     *
  130.     * <p>The SAX parser will invoke this method at the end of
  131.     * each CDATA parsed.</p>
  132.     *
  133.     * @exception SAXException Any SAX exception, possibly
  134.     *            wrapping another exception.
  135.     */
  136.     virtual void endCDATA () = 0;
  137.   /**
  138.     * Receive notification of the end of the DTD declarations.
  139.     *
  140.     * <p>The SAX parser will invoke this method at the end of the
  141.     * DTD</p>
  142.     *
  143.     * @exception SAXException Any SAX exception, possibly
  144.     *            wrapping another exception.
  145.     */
  146.     virtual void endDTD () = 0;
  147.   /**
  148.     * Receive notification of the end of an entity.
  149.     *
  150.     * <p>The SAX parser will invoke this method at the end of an
  151.     * entity</p>
  152.     *
  153.     * @param name The name of the entity that is ending.
  154.     * @exception SAXException Any SAX exception, possibly
  155.     *            wrapping another exception.
  156.     */
  157.     virtual void endEntity (const XMLCh* const name) = 0;
  158.   /**
  159.     * Receive notification of the start of a CDATA section.
  160.     *
  161.     * <p>The SAX parser will invoke this method at the start of
  162.     * each CDATA parsed.</p>
  163.     *
  164.     * @exception SAXException Any SAX exception, possibly
  165.     *            wrapping another exception.
  166.     */
  167.     virtual void startCDATA () = 0;
  168.   /**
  169.     * Receive notification of the start of the DTD declarations.
  170.     *
  171.     * <p>The SAX parser will invoke this method at the start of the
  172.     * DTD</p>
  173.     *
  174.     * @param name The document type name.
  175.     * @param publicId The declared public identifier for the external DTD subset, or null if none was declared.
  176.     * @param systemId The declared system identifier for the external DTD subset, or null if none was declared.
  177.     * @exception SAXException Any SAX exception, possibly
  178.     *            wrapping another exception.
  179.     */
  180.     virtual void startDTD
  181.     (
  182.         const   XMLCh* const    name
  183.         , const   XMLCh* const    publicId
  184.         , const   XMLCh* const    systemId
  185.     ) = 0;
  186.   /**
  187.     * Receive notification of the start of an entity.
  188.     *
  189.     * <p>The SAX parser will invoke this method at the start of an
  190.     * entity</p>
  191.     *
  192.     * @param name The name of the entity that is starting.
  193.     * @exception SAXException Any SAX exception, possibly
  194.     *            wrapping another exception.
  195.     */
  196.     virtual void startEntity (const XMLCh* const name) = 0;
  197.     //@}
  198. private :
  199.     /* Unimplemented Constructors and operators */
  200.     /* Copy constructor */
  201.     LexicalHandler(const LexicalHandler&);
  202.     /** Assignment operator */
  203.     LexicalHandler& operator=(const LexicalHandler&);
  204. };
  205. XERCES_CPP_NAMESPACE_END
  206. #endif