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

词法分析

开发平台:

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: Wrapper4InputSource.hpp,v 1.6 2003/03/07 18:08:10 tng Exp $
  58.  */
  59. #ifndef WRAPPER4INPUTSOURCE_HPP
  60. #define WRAPPER4INPUTSOURCE_HPP
  61. #include <xercesc/dom/DOMInputSource.hpp>
  62. XERCES_CPP_NAMESPACE_BEGIN
  63. class InputSource;
  64. /**
  65.   * Wrap a SAX InputSource object to a DOM InputSource.
  66.   */
  67. class XMLPARSER_EXPORT Wrapper4InputSource: public DOMInputSource
  68. {
  69. public:
  70.     /** @name Constructors and Destructor */
  71.     //@{
  72.   /**
  73.     * Constructor
  74.     *
  75.     * Wrap a SAX InputSource and pretend it to be a DOMInputSource.
  76.     * By default, the wrapper will adopt the SAX InputSource that is wrapped.
  77.     *
  78.     * @param  inputSource  The SAX InputSource to be wrapped
  79.     * @param  adoptFlag    Indicates if the wrapper should adopt the wrapped
  80.     *                      SAX InputSource. Default is true.
  81.     */
  82.     Wrapper4InputSource(InputSource* const inputSource,
  83.                         const bool adoptFlag = true);
  84.   /**
  85.     * Destructor
  86.     *
  87.     */
  88.     virtual ~Wrapper4InputSource();
  89.     //@}
  90.     // -----------------------------------------------------------------------
  91.     /** @name Virtual input source interface */
  92.     //@{
  93.   /**
  94.     * <p><b>"Experimental - subject to change"</b></p>
  95.     *
  96.     * Makes the byte stream for this input source.
  97.     *
  98.     * <p>The function will call the makeStream of the wrapped input source.
  99.     * The returned stream becomes the parser's property.</p>
  100.     *
  101.     * @see BinInputStream
  102.     */
  103.     BinInputStream* makeStream() const;
  104.     //@}
  105.     // -----------------------------------------------------------------------
  106.     /** @name Getter methods */
  107.     //@{
  108.   /**
  109.     * <p><b>"Experimental - subject to change"</b></p>
  110.     *
  111.     * An input source can be set to force the parser to assume a particular
  112.     * encoding for the data that input source reprsents, via the setEncoding()
  113.     * method. This method will delegate to the wrapped input source to return
  114.     * name of the encoding that is to be forced. If the encoding has never
  115.     * been forced, it returns a null pointer.
  116.     *
  117.     * @return The forced encoding, or null if none was supplied.
  118.     * @see #setEncoding
  119.     */
  120.     const XMLCh* getEncoding() const;
  121.   /**
  122.     * <p><b>"Experimental - subject to change"</b></p>
  123.     *
  124.     * Get the public identifier for this input source. Delegated to the
  125.     * wrapped input source object.
  126.     *
  127.     * @return The public identifier, or null if none was supplied.
  128.     * @see #setPublicId
  129.     */
  130.     const XMLCh* getPublicId() const;
  131.   /**
  132.     * <p><b>"Experimental - subject to change"</b></p>
  133.     *
  134.     * Get the system identifier for this input source. Delegated to the
  135.     * wrapped input source object.
  136.     *
  137.     * <p>If the system ID is a URL, it will be fully resolved.</p>
  138.     *
  139.     * @return The system identifier.
  140.     * @see #setSystemId
  141.     */
  142.     const XMLCh* getSystemId() const;
  143.    /**
  144.      * Get the base URI to be used for resolving relative URIs to absolute
  145.      * URIs. If the baseURI is itself a relative URI, the behavior is
  146.      * implementation dependent. Delegated to the wrapped intput source
  147.      * object.
  148.      *
  149.      * <p><b>"Experimental - subject to change"</b></p>
  150.      *
  151.      * @return The base URI.
  152.      * @see #setBaseURI
  153.      * @since DOM Level 3
  154.      */
  155.     const XMLCh* getBaseURI() const;
  156.  /**
  157.     * <p><b>"Experimental - subject to change"</b></p>
  158.     *
  159.     * Get the flag that indicates if the parser should issue fatal error if this input source
  160.     * is not found. Delegated to the wrapped input source object.
  161.     *
  162.     * @return True if the parser should issue fatal error if this input source is not found.
  163.     *         False if the parser issue warning message instead.
  164.     * @see #setIssueFatalErrorIfNotFound
  165.     */
  166.     const bool getIssueFatalErrorIfNotFound() const;
  167.     //@}
  168.     // -----------------------------------------------------------------------
  169.     /** @name Setter methods */
  170.     //@{
  171.   /**
  172.     * <p><b>"Experimental - subject to change"</b></p>
  173.     *
  174.     * Set the encoding which will be required for use with the XML text read
  175.     * via a stream opened by this input source. This will update the wrapped
  176.     * input source object.
  177.     *
  178.     * <p>This is usually not set, allowing the encoding to be sensed in the
  179.     * usual XML way. However, in some cases, the encoding in the file is known
  180.     * to be incorrect because of intermediate transcoding, for instance
  181.     * encapsulation within a MIME document.
  182.     *
  183.     * @param encodingStr The name of the encoding to force.
  184.     */
  185.     void setEncoding(const XMLCh* const encodingStr);
  186.   /**
  187.     * <p><b>"Experimental - subject to change"</b></p>
  188.     *
  189.     * Set the public identifier for this input source. This will update the
  190.     * wrapped input source object.
  191.     *
  192.     * <p>The public identifier is always optional: if the application writer
  193.     * includes one, it will be provided as part of the location information.</p>
  194.     *
  195.     * @param publicId The public identifier as a string.
  196.     * @see Locator#getPublicId
  197.     * @see SAXParseException#getPublicId
  198.     * @see #getPublicId
  199.     */
  200.     void setPublicId(const XMLCh* const publicId);
  201.   /**
  202.     * <p><b>"Experimental - subject to change"</b></p>
  203.     *
  204.     * Set the system identifier for this input source. This will update the
  205.     * wrapped input source object.
  206.     *
  207.     * <p>The system id is always required. The public id may be used to map
  208.     * to another system id, but the system id must always be present as a fall
  209.     * back.</p>
  210.     *
  211.     * <p>If the system ID is a URL, it must be fully resolved.</p>
  212.     *
  213.     * @param systemId The system identifier as a string.
  214.     * @see #getSystemId
  215.     * @see Locator#getSystemId
  216.     * @see SAXParseException#getSystemId
  217.     */
  218.     void setSystemId(const XMLCh* const systemId);
  219.    /**
  220.     * Set the base URI to be used for resolving relative URIs to absolute
  221.     * URIs. If the baseURI is itself a relative URI, the behavior is
  222.     * implementation dependent. This will update the wrapped input source
  223.     * object.
  224.     *
  225.     * <p><b>"Experimental - subject to change"</b></p>
  226.     *
  227.     * @param baseURI The base URI.
  228.     * @see #getBaseURI
  229.     * @since DOM Level 3
  230.     */
  231.     void setBaseURI(const XMLCh* const baseURI);
  232.   /**
  233.     * <p><b>"Experimental - subject to change"</b></p>
  234.     *
  235.     * Indicates if the parser should issue fatal error if this input source
  236.     * is not found.  If set to false, the parser issue warning message
  237.     * instead. This will update the wrapped input source object.
  238.     *
  239.     * @param flag  True if the parser should issue fatal error if this input
  240.     *              source is not found.
  241.     *              If set to false, the parser issue warning message instead.
  242.     *              (Default: true)
  243.     *
  244.     * @see #getIssueFatalErrorIfNotFound
  245.     */
  246.     void setIssueFatalErrorIfNotFound(const bool flag);
  247.    /**
  248.     * Called to indicate that this DOMInputSource is no longer in use
  249.     * and that the implementation may relinquish any resources associated with it.
  250.     *
  251.     * Access to a released object will lead to unexpected result.
  252.     */
  253.     void              release();
  254.     //@}
  255. private:
  256.     // -----------------------------------------------------------------------
  257.     //  Unimplemented constructors and operators
  258.     // -----------------------------------------------------------------------
  259.     Wrapper4InputSource(const Wrapper4InputSource&);
  260.     Wrapper4InputSource& operator=(const Wrapper4InputSource&);
  261.     // -----------------------------------------------------------------------
  262.     //  Private data members
  263.     // -----------------------------------------------------------------------
  264.     bool         fAdoptInputSource;
  265.     InputSource* fInputSource;
  266. };
  267. // ---------------------------------------------------------------------------
  268. //  Wrapper4InputSource: Getter methods
  269. // ---------------------------------------------------------------------------
  270. inline const XMLCh* Wrapper4InputSource::getBaseURI() const
  271. {
  272.     return 0; // REVISIT - should we return an empty string?
  273. }
  274. // ---------------------------------------------------------------------------
  275. //  Wrapper4InputSource: Setter methods
  276. // ---------------------------------------------------------------------------
  277. inline void Wrapper4InputSource::setBaseURI(const XMLCh* const)
  278. {
  279. }
  280. XERCES_CPP_NAMESPACE_END
  281. #endif