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

词法分析

开发平台:

Visual C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 1999-2001 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: Parser.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:26  tng
  62.  * C++ Namespace Support.
  63.  *
  64.  * Revision 1.2  2002/07/11 18:29:09  knoaman
  65.  * Grammar caching/preparsing - initial implementation.
  66.  *
  67.  * Revision 1.1.1.1  2002/02/01 22:22:08  peiyongz
  68.  * sane_include
  69.  *
  70.  * Revision 1.8  2001/05/11 13:26:24  tng
  71.  * Copyright update.
  72.  *
  73.  * Revision 1.7  2001/03/21 21:56:10  tng
  74.  * Schema: Add Schema Grammar, Schema Validator, and split the DTDValidator into DTDValidator, DTDScanner, and DTDGrammar.
  75.  *
  76.  * Revision 1.6  2000/03/02 19:54:35  roddey
  77.  * This checkin includes many changes done while waiting for the
  78.  * 1.1.0 code to be finished. I can't list them all here, but a list is
  79.  * available elsewhere.
  80.  *
  81.  * Revision 1.5  2000/02/24 20:12:55  abagchi
  82.  * Swat for removing Log from API docs
  83.  *
  84.  * Revision 1.4  2000/02/12 03:31:55  rahulj
  85.  * Removed duplicate CVS Log entries.
  86.  *
  87.  * Revision 1.3  2000/02/09 01:59:12  abagchi
  88.  * Removed private function docs, added parse docs
  89.  *
  90.  * Revision 1.2  2000/02/06 07:47:58  rahulj
  91.  * Year 2K copyright swat.
  92.  *
  93.  * Revision 1.1.1.1  1999/11/09 01:07:46  twl
  94.  * Initial checkin
  95.  *
  96.  * Revision 1.3  1999/11/08 20:45:02  rahul
  97.  * Swat for adding in Product name and CVS comment log variable.
  98.  *
  99.  */
  100. #ifndef PARSER_HPP
  101. #define PARSER_HPP
  102. #include <xercesc/util/XercesDefs.hpp>
  103. XERCES_CPP_NAMESPACE_BEGIN
  104. class DTDHandler;
  105. class EntityResolver;
  106. class DocumentHandler;
  107. class ErrorHandler;
  108. class InputSource;
  109. /**
  110.   * Basic interface for SAX (Simple API for XML) parsers.
  111.   *
  112.   * All SAX parsers must implement this basic interface: it allows
  113.   * applications to register handlers for different types of events
  114.   * and to initiate a parse from a URI, or a character stream.
  115.   *
  116.   * All SAX parsers must also implement a zero-argument constructor
  117.   * (though other constructors are also allowed).
  118.   *
  119.   * SAX parsers are reusable but not re-entrant: the application
  120.   * may reuse a parser object (possibly with a different input source)
  121.   * once the first parse has completed successfully, but it may not
  122.   * invoke the parse() methods recursively within a parse.
  123.   *
  124.   * @see EntityResolver#EntityResolver
  125.   * @see DTDHandler#DTDHandler
  126.   * @see DocumentHandler#DocumentHandler
  127.   * @see ErrorHandler#ErrorHandler
  128.   * @see HandlerBase#HandlerBase
  129.   * @see InputSource#InputSource
  130.   */
  131. #include <xercesc/util/XercesDefs.hpp>
  132. class SAX_EXPORT Parser
  133. {
  134. public:
  135.     /** @name Constructors and Destructor */
  136.     // -----------------------------------------------------------------------
  137.     //  Constructors and Destructor
  138.     // -----------------------------------------------------------------------
  139.     //@{
  140.     /** The default constructor */
  141.     Parser()
  142.     {
  143.     }
  144.     /** The destructor */
  145.     virtual ~Parser()
  146.     {
  147.     }
  148.     //@}
  149.     //-----------------------------------------------------------------------
  150.     // The parser interface
  151.     //-----------------------------------------------------------------------
  152.     /** @name The parser interfaces */
  153.     //@{
  154.   /**
  155.     * Allow an application to register a custom entity resolver.
  156.     *
  157.     * If the application does not register an entity resolver, the
  158.     * SAX parser will resolve system identifiers and open connections
  159.     * to entities itself (this is the default behaviour implemented in
  160.     * HandlerBase).
  161.     *
  162.     * Applications may register a new or different entity resolver
  163.     * in the middle of a parse, and the SAX parser must begin using
  164.     * the new resolver immediately.
  165.     *
  166.     * @param resolver The object for resolving entities.
  167.     * @see EntityResolver#EntityResolver
  168.     * @see HandlerBase#HandlerBase
  169.     */
  170.     virtual void setEntityResolver(EntityResolver* const resolver) = 0;
  171.   /**
  172.     * Allow an application to register a DTD event handler.
  173.     *
  174.     * If the application does not register a DTD handler, all DTD
  175.     * events reported by the SAX parser will be silently ignored (this
  176.     * is the default behaviour implemented by HandlerBase).
  177.     *
  178.     * Applications may register a new or different handler in the middle
  179.     * of a parse, and the SAX parser must begin using the new handler
  180.     * immediately.
  181.     *
  182.     * @param handler The DTD handler.
  183.     * @see DTDHandler#DTDHandler
  184.     * @see HandlerBase#HandlerBase
  185.     */
  186.     virtual void setDTDHandler(DTDHandler* const handler) = 0;
  187.   /**
  188.     * Allow an application to register a document event handler.
  189.     *
  190.     * If the application does not register a document handler, all
  191.     * document events reported by the SAX parser will be silently
  192.     * ignored (this is the default behaviour implemented by
  193.     * HandlerBase).
  194.     *
  195.     * Applications may register a new or different handler in the
  196.     * middle of a parse, and the SAX parser must begin using the new
  197.     * handler immediately.
  198.     *
  199.     * @param handler The document handler.
  200.     * @see DocumentHandler#DocumentHandler
  201.     * @see HandlerBase#HandlerBase
  202.     */
  203.     virtual void setDocumentHandler(DocumentHandler* const handler) = 0;
  204.   /**
  205.     * Allow an application to register an error event handler.
  206.     *
  207.     * If the application does not register an error event handler,
  208.     * all error events reported by the SAX parser will be silently
  209.     * ignored, except for fatalError, which will throw a SAXException
  210.     * (this is the default behaviour implemented by HandlerBase).
  211.     *
  212.     * Applications may register a new or different handler in the
  213.     * middle of a parse, and the SAX parser must begin using the new
  214.     * handler immediately.
  215.     *
  216.     * @param handler The error handler.
  217.     * @see ErrorHandler#ErrorHandler
  218.     * @see SAXException#SAXException
  219.     * @see HandlerBase#HandlerBase
  220.     */
  221.     virtual void setErrorHandler(ErrorHandler* const handler) = 0;
  222.   /**
  223.     * Parse an XML document.
  224.     *
  225.     * The application can use this method to instruct the SAX parser
  226.     * to begin parsing an XML document from any valid input
  227.     * source (a character stream, a byte stream, or a URI).
  228.     *
  229.     * Applications may not invoke this method while a parse is in
  230.     * progress (they should create a new Parser instead for each
  231.     * additional XML document).  Once a parse is complete, an
  232.     * application may reuse the same Parser object, possibly with a
  233.     * different input source.
  234.     *
  235.     * @param source The input source for the top-level of the
  236.     *               XML document.
  237.     * @exception SAXException Any SAX exception, possibly
  238.     *            wrapping another exception.
  239.     * @exception XMLException An exception from the parser or client
  240.     *            handler code.
  241.     * @see InputSource#InputSource
  242.     * @see #setEntityResolver
  243.     * @see #setDTDHandler
  244.     * @see #setDocumentHandler
  245.     * @see #setErrorHandler
  246.     */
  247.     virtual void parse
  248.     (
  249.         const   InputSource&    source
  250.     ) = 0;
  251.   /**
  252.     * Parse an XML document from a system identifier (URI).
  253.     *
  254.     * This method is a shortcut for the common case of reading a
  255.     * document from a system identifier.  It is the exact equivalent
  256.     * of the following:
  257.     *
  258.     * parse(new URLInputSource(systemId));
  259.     *
  260.     * If the system identifier is a URL, it must be fully resolved
  261.     * by the application before it is passed to the parser.
  262.     *
  263.     * @param systemId The system identifier (URI).
  264.     * @exception SAXException Any SAX exception, possibly
  265.     *            wrapping another exception.
  266.     * @exception XMLException An exception from the parser or client
  267.     *            handler code.
  268.     * @see #parse(InputSource)
  269.     */
  270.     virtual void parse
  271.     (
  272.         const   XMLCh* const    systemId
  273.     ) = 0;
  274.   /**
  275.     * Parse an XML document from a system identifier (URI).
  276.     *
  277.     * This method is a shortcut for the common case of reading a
  278.     * document from a system identifier.  It is the exact equivalent
  279.     * of the following:
  280.     *
  281.     * parse(new URLInputSource(systemId));
  282.     *
  283.     * If the system identifier is a URL, it must be fully resolved
  284.     * by the application before it is passed to the parser.
  285.     *
  286.     * @param systemId The system identifier (URI).
  287.     * @exception SAXException Any SAX exception, possibly
  288.     *            wrapping another exception.
  289.     * @exception XMLException An exception from the parser or client
  290.     *            handler code.
  291.     * @see #parse(InputSource)
  292.     */
  293.     virtual void parse
  294.     (
  295.         const   char* const     systemId
  296.     ) = 0;
  297.     //@}
  298. private :
  299.     /* The copy constructor, you cannot call this directly */
  300.     Parser(const Parser&);
  301.     /* The assignment operator, you cannot call this directly */
  302.     Parser& operator=(const Parser&);
  303. };
  304. XERCES_CPP_NAMESPACE_END
  305. #endif