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

词法分析

开发平台:

Visual C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 2002 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.  * $Id: Wrapper4DOMInputSource.hpp,v 1.5 2003/05/16 21:36:55 knoaman Exp $
  58.  */
  59. #ifndef WRAPPER4DOMINPUTSOURCE_HPP
  60. #define WRAPPER4DOMINPUTSOURCE_HPP
  61. #include <xercesc/sax/InputSource.hpp>
  62. XERCES_CPP_NAMESPACE_BEGIN
  63. class DOMInputSource;
  64. /**
  65.   * Wrap a DOMInputSource object to a SAX InputSource.
  66.   */
  67. class XMLPARSER_EXPORT Wrapper4DOMInputSource: public InputSource
  68. {
  69. public:
  70.     /** @name Constructors and Destructor */
  71.     //@{
  72.   /**
  73.     * Constructor
  74.     *
  75.     * Wrap a DOMInputSource and pretend it to be a SAX InputSource.
  76.     * By default, the wrapper will adopt the DOMInputSource that is wrapped.
  77.     *
  78.     * @param  inputSource  The DOMInputSource to be wrapped
  79.     * @param  adoptFlag    Indicates if the wrapper should adopt the wrapped
  80.     *                      DOMInputSource. Default is true.
  81.     */
  82.     Wrapper4DOMInputSource
  83.     (
  84.         DOMInputSource* const inputSource
  85.         , const bool adoptFlag = true
  86.         , MemoryManager* const  manager = XMLPlatformUtils::fgMemoryManager
  87.     );
  88.   /**
  89.     * Destructor
  90.     *
  91.     */
  92.     virtual ~Wrapper4DOMInputSource();
  93.     //@}
  94.     // -----------------------------------------------------------------------
  95.     /** @name Virtual input source interface */
  96.     //@{
  97.   /**
  98.     * <p><b>"Experimental - subject to change"</b></p>
  99.     *
  100.     * Makes the byte stream for this input source.
  101.     *
  102.     * <p>The function will call the makeStream of the wrapped input source.
  103.     * The returned stream becomes the parser's property.</p>
  104.     *
  105.     * @see BinInputStream
  106.     */
  107.     BinInputStream* makeStream() const;
  108.     //@}
  109.     // -----------------------------------------------------------------------
  110.     /** @name Getter methods */
  111.     //@{
  112.   /**
  113.     * <p><b>"Experimental - subject to change"</b></p>
  114.     *
  115.     * An input source can be set to force the parser to assume a particular
  116.     * encoding for the data that input source reprsents, via the setEncoding()
  117.     * method. This method will delegate to the wrapped input source to return
  118.     * name of the encoding that is to be forced. If the encoding has never
  119.     * been forced, it returns a null pointer.
  120.     *
  121.     * @return The forced encoding, or null if none was supplied.
  122.     * @see #setEncoding
  123.     */
  124.     const XMLCh* getEncoding() const;
  125.   /**
  126.     * <p><b>"Experimental - subject to change"</b></p>
  127.     *
  128.     * Get the public identifier for this input source. Delegated to the
  129.     * wrapped input source object.
  130.     *
  131.     * @return The public identifier, or null if none was supplied.
  132.     * @see #setPublicId
  133.     */
  134.     const XMLCh* getPublicId() const;
  135.   /**
  136.     * <p><b>"Experimental - subject to change"</b></p>
  137.     *
  138.     * Get the system identifier for this input source. Delegated to the
  139.     * wrapped input source object.
  140.     *
  141.     * <p>If the system ID is a URL, it will be fully resolved.</p>
  142.     *
  143.     * @return The system identifier.
  144.     * @see #setSystemId
  145.     */
  146.     const XMLCh* getSystemId() const;
  147.  /**
  148.     * <p><b>"Experimental - subject to change"</b></p>
  149.     *
  150.     * Get the flag that indicates if the parser should issue fatal error if
  151.     * this input source is not found. Delegated to the wrapped input source
  152.     * object.
  153.     *
  154.     * @return True  if the parser should issue fatal error if this input source
  155.     *               is not found.
  156.     *         False if the parser issue warning message instead.
  157.     * @see #setIssueFatalErrorIfNotFound
  158.     */
  159.     const bool getIssueFatalErrorIfNotFound() const;
  160.     //@}
  161.     // -----------------------------------------------------------------------
  162.     /** @name Setter methods */
  163.     //@{
  164.   /**
  165.     * <p><b>"Experimental - subject to change"</b></p>
  166.     *
  167.     * Set the encoding which will be required for use with the XML text read
  168.     * via a stream opened by this input source. This will update the wrapped
  169.     * input source object.
  170.     *
  171.     * <p>This is usually not set, allowing the encoding to be sensed in the
  172.     * usual XML way. However, in some cases, the encoding in the file is known
  173.     * to be incorrect because of intermediate transcoding, for instance
  174.     * encapsulation within a MIME document.
  175.     *
  176.     * @param encodingStr The name of the encoding to force.
  177.     */
  178.     void setEncoding(const XMLCh* const encodingStr);
  179.   /**
  180.     * <p><b>"Experimental - subject to change"</b></p>
  181.     *
  182.     * Set the public identifier for this input source. This will update the
  183.     * wrapped input source object.
  184.     *
  185.     * <p>The public identifier is always optional: if the application writer
  186.     * includes one, it will be provided as part of the location information.</p>
  187.     *
  188.     * @param publicId The public identifier as a string.
  189.     * @see Locator#getPublicId
  190.     * @see SAXParseException#getPublicId
  191.     * @see #getPublicId
  192.     */
  193.     void setPublicId(const XMLCh* const publicId);
  194.   /**
  195.     * <p><b>"Experimental - subject to change"</b></p>
  196.     *
  197.     * Set the system identifier for this input source. This will update the
  198.     * wrapped input source object.
  199.     *
  200.     * <p>The system id is always required. The public id may be used to map
  201.     * to another system id, but the system id must always be present as a fall
  202.     * back.</p>
  203.     *
  204.     * <p>If the system ID is a URL, it must be fully resolved.</p>
  205.     *
  206.     * @param systemId The system identifier as a string.
  207.     * @see #getSystemId
  208.     * @see Locator#getSystemId
  209.     * @see SAXParseException#getSystemId
  210.     */
  211.     void setSystemId(const XMLCh* const systemId);
  212.   /**
  213.     * <p><b>"Experimental - subject to change"</b></p>
  214.     *
  215.     * Indicates if the parser should issue fatal error if this input source
  216.     * is not found.  If set to false, the parser issue warning message instead.
  217.     * This will update the wrapped input source object.
  218.     *
  219.     * @param  flag True if the parser should issue fatal error if this input source is not found.
  220.     *               If set to false, the parser issue warning message instead.  (Default: true)
  221.     *
  222.     * @see #getIssueFatalErrorIfNotFound
  223.     */
  224.     void setIssueFatalErrorIfNotFound(const bool flag);
  225.     //@}
  226. private:
  227.     // -----------------------------------------------------------------------
  228.     //  Unimplemented constructors and operators
  229.     // -----------------------------------------------------------------------
  230.     Wrapper4DOMInputSource(const Wrapper4DOMInputSource&);
  231.     Wrapper4DOMInputSource& operator=(const Wrapper4DOMInputSource&);
  232.     // -----------------------------------------------------------------------
  233.     //  Private data members
  234.     // -----------------------------------------------------------------------
  235.     bool            fAdoptInputSource;
  236.     DOMInputSource* fInputSource;
  237. };
  238. XERCES_CPP_NAMESPACE_END
  239. #endif