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

词法分析

开发平台:

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: XMLEntityHandler.hpp,v $
  58.   * Revision 1.6  2003/03/07 18:08:10  tng
  59.   * Return a reference instead of void for operator=
  60.   *
  61.   * Revision 1.5  2002/11/04 15:00:21  tng
  62.   * C++ Namespace Support.
  63.   *
  64.   * Revision 1.4  2002/06/06 20:41:51  tng
  65.   * Regression fix: should assign the returned InputSource from resolveEntity to srcToFill.
  66.   *
  67.   * Revision 1.3  2002/05/31 15:14:07  tng
  68.   * Fix doxygen documentation.
  69.   *
  70.   * Revision 1.2  2002/05/29 21:47:08  knoaman
  71.   * DOM L3 LS: DOMInputSource, DOMEntityResolver, DOMImplementationLS and DOMBuilder
  72.   *
  73.   * Revision 1.1.1.1  2002/02/01 22:21:51  peiyongz
  74.   * sane_include
  75.   *
  76.   * Revision 1.7  2000/03/02 19:54:25  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.6  2000/02/24 20:00:23  abagchi
  82.   * Swat for removing Log from API docs
  83.   *
  84.   * Revision 1.5  2000/02/16 21:42:58  aruna1
  85.   * API Doc++ summary changes in
  86.   *
  87.   * Revision 1.4  2000/02/15 01:21:31  roddey
  88.   * Some initial documentation improvements. More to come...
  89.   *
  90.   * Revision 1.3  2000/02/06 07:47:48  rahulj
  91.   * Year 2K copyright swat.
  92.   *
  93.   * Revision 1.2  1999/12/15 19:46:28  roddey
  94.   * Got rid of redundant 'const' on bool return value. Some compilers choke on this
  95.   * and its not useful anyway.
  96.   *
  97.   * Revision 1.1.1.1  1999/11/09 01:08:33  twl
  98.   * Initial checkin
  99.   *
  100.   * Revision 1.2  1999/11/08 20:44:38  rahul
  101.   * Swat for adding in Product name and CVS comment log variable.
  102.   *
  103.   */
  104. #if !defined(XMLENTITYHANDLER_HPP)
  105. #define XMLENTITYHANDLER_HPP
  106. #include <xercesc/util/XercesDefs.hpp>
  107. XERCES_CPP_NAMESPACE_BEGIN
  108. class InputSource;
  109. class XMLBuffer;
  110. /**
  111.  *  This abstract class is a callback mechanism for the scanner. By creating
  112.  *  a derivative of this class and plugging into the scanner, the scanner
  113.  *  will call back on the object's methods to entity events.
  114.  *
  115.  *  This class is primarily for use by those writing their own parser classes.
  116.  *  If you use the standard parser classes, DOMParser and SAXParser, you won't
  117.  *  use this API. You will instead use a similar mechanism defined by the SAX
  118.  *  API, called EntityResolver.
  119.  */
  120. class XMLPARSER_EXPORT XMLEntityHandler
  121. {
  122. public:
  123.     // -----------------------------------------------------------------------
  124.     //  Constructors are hidden, only the virtual destructor is exposed
  125.     // -----------------------------------------------------------------------
  126.     /** @name Destructor */
  127.     //@{
  128.     /**
  129.       * Default destructor
  130.       */
  131.     virtual ~XMLEntityHandler()
  132.     {
  133.     }
  134.     //@}
  135.     // -----------------------------------------------------------------------
  136.     //  The virtual entity handler interface
  137.     // -----------------------------------------------------------------------
  138.     /** @name The pure virtual methods in this interface. */
  139.     //@{
  140.     /**
  141.       * This method get called after the scanner has finished reading from
  142.       * the given input source while processing external entity references.
  143.       *
  144.       * @param inputSource The input source for the entity
  145.       */
  146.     virtual void endInputSource(const InputSource& inputSource) = 0;
  147.     /**
  148.       * This method allows the passes the scanned systemId to the entity
  149.       * handler, thereby giving it a chance to provide any customized
  150.       * handling like resolving relative path names. The scanner first
  151.       * calls this method before calling <code>resolveEntity</code>.
  152.       *
  153.       * @param systemId The system id extracted by the scanner from the
  154.       *                 input source.
  155.       * @param toFill The buffer in which the fully expanded system id needs
  156.       *               to be stored.
  157.       */
  158.     virtual bool expandSystemId
  159.     (
  160.         const   XMLCh* const    systemId
  161.         ,       XMLBuffer&      toFill
  162.     ) = 0;
  163.     /**
  164.       * This method allows the entity handler to reset itself, so that
  165.       * it can be used again. It is called prior to a new document parse
  166.       * operation.
  167.       */
  168.     virtual void resetEntities() = 0;
  169.     /**
  170.       * This method allows the entity handler to provide customized
  171.       * application specific entity resolution. This method is defined
  172.       * by SAX 1.0 API.
  173.       *
  174.       * @param publicId A const pointer to a Unicode string representing the
  175.       *                 public id of the entity just parsed.
  176.       * @param systemId A const pointer to a Unicode string representing the
  177.       *                 system id of the entity just parsed.
  178.       * @param baseURI  A const pointer to a Unicode string representing the
  179.       *                 base URI of the entity just parsed,
  180.       *                 or <code>null</code> if there is no base URI.
  181.       * @return The value returned by the SAX resolveEntity method or
  182.       *         NULL otherwise to indicate no processing was done.
  183.       *         The returned InputSource is owned by the parser which is
  184.       *         responsible to clean up the memory.
  185.       */
  186.     virtual InputSource* resolveEntity
  187.     (
  188.         const   XMLCh* const    publicId
  189.         , const XMLCh* const    systemId
  190.         , const XMLCh* const    baseURI = 0
  191.     ) = 0;
  192.     /**
  193.       * This method will be called before the scanner starts reading
  194.       * from an input source while processing external entity references.
  195.       *
  196.       * @param inputSource The external input source.
  197.       */
  198.     virtual void startInputSource(const InputSource& inputSource) = 0;
  199.     //@}
  200. protected :
  201.     // -----------------------------------------------------------------------
  202.     //  Hidden Constructors
  203.     // -----------------------------------------------------------------------
  204.     /** @name Constructor */
  205.     //@{
  206.     /**
  207.       * Protected default constructor
  208.       */
  209.     XMLEntityHandler()
  210.     {
  211.     }
  212.     //@}
  213. private:
  214.     // -----------------------------------------------------------------------
  215.     //  Unimplemented constructors and destructor
  216.     // -----------------------------------------------------------------------
  217.     XMLEntityHandler(const XMLEntityHandler&);
  218.     XMLEntityHandler& operator=(const XMLEntityHandler&);
  219. };
  220. XERCES_CPP_NAMESPACE_END
  221. #endif