Parser.hpp
上传用户:huihehuasu
上传日期:2007-01-10
资源大小:6948k
文件大小:12k
源码类别:

xml/soap/webservice

开发平台:

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