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

词法分析

开发平台:

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: URLInputSource.hpp,v $
  58.  * Revision 1.3  2003/05/16 21:36:55  knoaman
  59.  * Memory manager implementation: Modify constructors to pass in the memory manager.
  60.  *
  61.  * Revision 1.2  2002/11/04 15:00:21  tng
  62.  * C++ Namespace Support.
  63.  *
  64.  * Revision 1.1.1.1  2002/02/01 22:21:50  peiyongz
  65.  * sane_include
  66.  *
  67.  * Revision 1.8  2000/12/14 18:49:56  tng
  68.  * Fix API document generation warning: "Warning: end of member group without matching begin"
  69.  *
  70.  * Revision 1.7  2000/02/24 20:00:22  abagchi
  71.  * Swat for removing Log from API docs
  72.  *
  73.  * Revision 1.6  2000/02/15 23:59:07  roddey
  74.  * More updated documentation of Framework classes.
  75.  *
  76.  * Revision 1.5  2000/02/15 01:21:30  roddey
  77.  * Some initial documentation improvements. More to come...
  78.  *
  79.  * Revision 1.4  2000/02/06 07:47:46  rahulj
  80.  * Year 2K copyright swat.
  81.  *
  82.  * Revision 1.3  2000/01/26 18:56:02  roddey
  83.  * Needed to include XMLURL.hpp so that it compiles standalone.
  84.  *
  85.  * Revision 1.2  2000/01/15 01:26:16  rahulj
  86.  * Added support for HTTP to the parser using libWWW 5.2.8.
  87.  * Renamed URL.[ch]pp to XMLURL.[ch]pp and like wise for the class name.
  88.  * Only tested under NT 4.0 SP 5.
  89.  * Removed URL.hpp from files where it was not used.
  90.  *
  91.  * Revision 1.1  2000/01/12 00:13:26  roddey
  92.  * These were moved from internal/ to framework/, which was something that should have
  93.  * happened long ago. They are really framework type of classes.
  94.  *
  95.  * Revision 1.1.1.1  1999/11/09 01:08:18  twl
  96.  * Initial checkin
  97.  *
  98.  * Revision 1.2  1999/11/08 20:44:44  rahul
  99.  * Swat for adding in Product name and CVS comment log variable.
  100.  *
  101.  */
  102. #if !defined(URLINPUTSOURCE_HPP)
  103. #define URLINPUTSOURCE_HPP
  104. #include <xercesc/util/XMLURL.hpp>
  105. #include <xercesc/sax/InputSource.hpp>
  106. XERCES_CPP_NAMESPACE_BEGIN
  107. class BinInputStream;
  108. /**
  109.  *  This class is a derivative of the standard InputSource class. It provides
  110.  *  for the parser access to data which is referenced via a URL, as apposed to
  111.  *  a local file name. The URL can be provided via an XMLURL class, as a fully
  112.  *  qualified system id, or a base system id and a system id which may be
  113.  *  fully qualified or may be relative to the base.
  114.  *
  115.  *  As with all InputSource derivatives. The primary objective of an input
  116.  *  source is to create an input stream via which the parser can spool in
  117.  *  data from the referenced source.
  118.  *
  119.  *  Note that the parse system does not necessarily support URL based XML
  120.  *  entities out of the box. Support for socket based access is optional and
  121.  *  controlled by the per-platform support.
  122.  */
  123. class XMLPARSER_EXPORT URLInputSource : public InputSource
  124. {
  125. public :
  126.     // -----------------------------------------------------------------------
  127.     //  Constructors and Destructor
  128.     // -----------------------------------------------------------------------
  129.     /** @name Constructors */
  130.     //@{
  131.     /**
  132.       * This constructor accepts an already built URL. It is assumed that
  133.       * it is correct and it will be used as is. In this case, no public id
  134.       * accepted, but it can still be set via the parent class' setPublicId()
  135.       * method.
  136.       *
  137.       * @param  urlId   The URL which holds the system id of the entity
  138.       *                 to parse.
  139.       */
  140.     URLInputSource
  141.     (
  142.         const XMLURL& urlId
  143.         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
  144.     );
  145.     /**
  146.      *  This constructor takes a base system id URL and a possibly relative
  147.      *  system id. The relative part is parsed and, if it is indeed relative,
  148.      *  it will be made relative to the passed base id. Otherwise, it will be
  149.      *  taken as is.
  150.      *
  151.      *  @param  baseId      The base system id URL which provides the base
  152.      *                      for any relative id part.
  153.      *
  154.      *  @param  systemId    The possibly relative system id URL. If its relative
  155.      *                      its based on baseId, else its taken as is.
  156.      */
  157.     URLInputSource
  158.     (
  159.         const   XMLCh* const    baseId
  160.         , const XMLCh* const    systemId
  161.         , MemoryManager* const  manager = XMLPlatformUtils::fgMemoryManager
  162.     );
  163.     /**
  164.      *  This constructor is indentical to the previous one, except that it also
  165.      *  allows you to set a public id if you want to.
  166.      *
  167.      *  @param  baseId      The base system id URL which provides the base
  168.      *                      for any relative id part.
  169.      *
  170.      *  @param  systemId    The possibly relative system id URL. If its relative
  171.      *                      its based on baseId, else its taken as is.
  172.      *
  173.      *  @param  publicId    The optional public id to set. This is just passed
  174.      *                      on to the parent class for storage.
  175.      */
  176.     URLInputSource
  177.     (
  178.         const   XMLCh* const    baseId
  179.         , const XMLCh* const    systemId
  180.         , const XMLCh* const    publicId
  181.         , MemoryManager* const  manager = XMLPlatformUtils::fgMemoryManager
  182.     );
  183.     /**
  184.      *  This constructor is identical to the second constructor above, except that
  185.      *  it accepts the relative system id part as a local code page string and
  186.      *  just transcodes it internally, as a convenience.
  187.      *
  188.      *  @param  baseId      The base system id URL which provides the base
  189.      *                      for any relative id part.
  190.      *
  191.      *  @param  systemId    The possibly relative system id URL. If its relative
  192.      *                      its based on baseId, else its taken as is.
  193.      */
  194.     URLInputSource
  195.     (
  196.         const   XMLCh* const    baseId
  197.         , const char* const     systemId
  198.         , MemoryManager* const  manager = XMLPlatformUtils::fgMemoryManager
  199.     );
  200.     /**
  201.      *  This constructor is identical to the third constructor above, except that
  202.      *  it accepts the relative and public ids as local code page strings and just
  203.      *  transcodes them internally, as a convenience.
  204.      *
  205.      *  @param  baseId      The base system id URL which provides the base
  206.      *                      for any relative id part.
  207.      *
  208.      *  @param  systemId    The possibly relative system id URL. If its relative
  209.      *                      its based on baseId, else its taken as is.
  210.      *
  211.      *  @param  publicId    The optional public id to set. This is just passed
  212.      *                      on to the parent class for storage.
  213.      *                      on to the parent class for storage.
  214.      */
  215.     URLInputSource
  216.     (
  217.         const   XMLCh* const    baseId
  218.         , const char* const     systemId
  219.         , const char* const     publicId
  220.         , MemoryManager* const  manager = XMLPlatformUtils::fgMemoryManager
  221.     );
  222.     //@}
  223.     /** @name Destructor */
  224.     //@{
  225.     ~URLInputSource();
  226.     //@}
  227.     // -----------------------------------------------------------------------
  228.     //  Virtual input source interface
  229.     // -----------------------------------------------------------------------
  230.     /** @name Virtual methods */
  231.     //@{
  232.     /**
  233.      * This method will return a binary input stream derivative that will
  234.      * parse from the source refered to by the URL system id.
  235.      */
  236.     BinInputStream* makeStream() const;
  237.     //@}
  238.     // -----------------------------------------------------------------------
  239.     //  Getter methods
  240.     // -----------------------------------------------------------------------
  241.     /** @name Getter methods */
  242.     //@{
  243.     /**
  244.       * This method will return a const reference to the URL member which
  245.       * contains the system id in pre-parsed URL form. If you just want the
  246.       * string format, call getSystemId() on the parent class.
  247.       *
  248.       * @return A const reference to a URL object that contains the current
  249.       *         system id set for this input source.
  250.       */
  251.     const XMLURL& urlSrc() const;
  252.     //@}
  253. private :
  254.     // -----------------------------------------------------------------------
  255.     //  Private data members
  256.     //
  257.     //  fURL
  258.     //      This is the URL created from the passed ids.
  259.     // -----------------------------------------------------------------------
  260.     XMLURL fURL;
  261. };
  262. inline const XMLURL& URLInputSource::urlSrc() const
  263. {
  264.     return fURL;
  265. }
  266. XERCES_CPP_NAMESPACE_END
  267. #endif