InputSource.hpp Source File

00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 1999-2000 The Apache Software Foundation.  All rights
00005  * reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  *
00014  * 2. Redistributions in binary form must reproduce the above copyright
00015  *    notice, this list of conditions and the following disclaimer in
00016  *    the documentation and/or other materials provided with the
00017  *    distribution.
00018  *
00019  * 3. The end-user documentation included with the redistribution,
00020  *    if any, must include the following acknowledgment:
00021  *       "This product includes software developed by the
00022  *        Apache Software Foundation (http://www.apache.org/)."
00023  *    Alternately, this acknowledgment may appear in the software itself,
00024  *    if and wherever such third-party acknowledgments normally appear.
00025  *
00026  * 4. The names "Xerces" and "Apache Software Foundation" must
00027  *    not be used to endorse or promote products derived from this
00028  *    software without prior written permission. For written
00029  *    permission, please contact apache\@apache.org.
00030  *
00031  * 5. Products derived from this software may not be called "Apache",
00032  *    nor may "Apache" appear in their name, without prior written
00033  *    permission of the Apache Software Foundation.
00034  *
00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00046  * SUCH DAMAGE.
00047  * ====================================================================
00048  *
00049  * This software consists of voluntary contributions made by many
00050  * individuals on behalf of the Apache Software Foundation, and was
00051  * originally based on software copyright (c) 1999, International
00052  * Business Machines, Inc., http://www.ibm.com .  For more information
00053  * on the Apache Software Foundation, please see
00054  * <http://www.apache.org/>.
00055  */
00056 
00057 /*
00058  * $Log: InputSource.hpp,v $
00059  * Revision 1.10  2003/12/01 23:23:26  neilg
00060  * fix for bug 25118; thanks to Jeroen Witmond
00061  *
00062  * Revision 1.9  2003/11/17 10:52:15  amassari
00063  * Fixed documentation bug#24746
00064  *
00065  * Revision 1.8  2003/05/30 16:11:45  gareth
00066  * Fixes so we compile under VC7.1. Patch by Alberto Massari.
00067  *
00068  * Revision 1.7  2003/05/16 21:36:59  knoaman
00069  * Memory manager implementation: Modify constructors to pass in the memory manager.
00070  *
00071  * Revision 1.6  2003/05/15 18:27:05  knoaman
00072  * Partial implementation of the configurable memory manager.
00073  *
00074  * Revision 1.5  2003/03/07 18:10:06  tng
00075  * Return a reference instead of void for operator=
00076  *
00077  * Revision 1.4  2002/11/04 14:56:26  tng
00078  * C++ Namespace Support.
00079  *
00080  * Revision 1.3  2002/09/30 18:26:18  tng
00081  * Since the derived class Wrapper4DOMInputSource has overwritten the set/getEncoding, SystemId, PublicId ... etc., these functions has to be virtual for them to work.
00082  *
00083  * Revision 1.2  2002/02/20 18:17:01  tng
00084  * [Bug 5977] Warnings on generating apiDocs.
00085  *
00086  * Revision 1.1.1.1  2002/02/01 22:22:08  peiyongz
00087  * sane_include
00088  *
00089  * Revision 1.10  2001/11/21 16:14:32  tng
00090  * Schema: New method InputSource::get/setIssueFatalErrorIfNotFound to tell the parser whether to issue fatal error or not if cannot find it (the InputSource).  This is required for schema processing as it shouldn't be a fatal error if the schema is not found.
00091  *
00092  * Revision 1.9  2000/03/02 19:54:35  roddey
00093  * This checkin includes many changes done while waiting for the
00094  * 1.1.0 code to be finished. I can't list them all here, but a list is
00095  * available elsewhere.
00096  *
00097  * Revision 1.8  2000/02/24 20:12:55  abagchi
00098  * Swat for removing Log from API docs
00099  *
00100  * Revision 1.7  2000/02/12 03:42:21  rahulj
00101  * Fixed DOC++ documentation formatting errors.
00102  *
00103  * Revision 1.6  2000/02/12 03:31:55  rahulj
00104  * Removed duplicate CVS Log entries.
00105  *
00106  * Revision 1.5  2000/02/12 01:27:19  aruna1
00107  * Documentation updated
00108  *
00109  * Revision 1.4  2000/02/09 02:15:28  abagchi
00110  * Documented destructor
00111  *
00112  * Revision 1.3  2000/02/06 07:47:58  rahulj
00113  * Year 2K copyright swat.
00114  *
00115  * Revision 1.2  2000/01/12 00:15:39  roddey
00116  * Changes to deal with multiply nested, relative pathed, entities and to deal
00117  * with the new URL class changes.
00118  *
00119  * Revision 1.1.1.1  1999/11/09 01:07:46  twl
00120  * Initial checkin
00121  *
00122  * Revision 1.2  1999/11/08 20:45:01  rahul
00123  * Swat for adding in Product name and CVS comment log variable.
00124  *
00125  */
00126 
00127 
00128 #ifndef INPUTSOURCE_HPP
00129 #define INPUTSOURCE_HPP
00130 
00131 #include <xercesc/util/PlatformUtils.hpp>
00132 
00133 XERCES_CPP_NAMESPACE_BEGIN
00134 
00135 class BinInputStream;
00136 
00137 
00168 class  InputSource : public XMemory
00169 {
00170 public:
00171     // -----------------------------------------------------------------------
00172     //  All constructors are hidden, just the destructor is available
00173     // -----------------------------------------------------------------------
00180     virtual ~InputSource();
00182 
00183 
00184     // -----------------------------------------------------------------------
00197     virtual BinInputStream* makeStream() const = 0;
00198 
00200 
00201 
00202     // -----------------------------------------------------------------------
00214     virtual const XMLCh* getEncoding() const;
00215 
00216 
00223     virtual const XMLCh* getPublicId() const;
00224 
00225 
00234     virtual const XMLCh* getSystemId() const;
00235 
00244     virtual bool getIssueFatalErrorIfNotFound() const;
00245 
00246     MemoryManager* getMemoryManager() const;
00247 
00249 
00250 
00251     // -----------------------------------------------------------------------
00254 
00266     virtual void setEncoding(const XMLCh* const encodingStr);
00267 
00268 
00280     virtual void setPublicId(const XMLCh* const publicId);
00281 
00298     virtual void setSystemId(const XMLCh* const systemId);
00299 
00309     virtual void setIssueFatalErrorIfNotFound(const bool flag);
00310 
00312 
00313 
00314 protected :
00315     // -----------------------------------------------------------------------
00316     //  Hidden constructors
00317     // -----------------------------------------------------------------------
00321     InputSource(MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
00322 
00328     InputSource(const XMLCh* const systemId,
00329                 MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
00330 
00337     InputSource
00338     (
00339         const   XMLCh* const   systemId
00340         , const XMLCh* const   publicId
00341         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
00342     );
00343 
00349     InputSource(const char* const systemId,
00350                 MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
00351 
00358     InputSource
00359     (
00360         const   char* const systemId
00361         , const char* const publicId
00362         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
00363     );
00364 
00366 
00367 
00368 
00369 
00370 
00371 private:
00372     // -----------------------------------------------------------------------
00373     //  Unimplemented constructors and operators
00374     // -----------------------------------------------------------------------
00375     InputSource(const InputSource&);
00376     InputSource& operator=(const InputSource&);
00377 
00378 
00379     // -----------------------------------------------------------------------
00380     //  Private data members
00381     //
00382     //  fEncoding
00383     //      This is the encoding to use. Usually this is null, which means
00384     //      to use the information found in the file itself. But, if set,
00385     //      this encoding will be used without question.
00386     //
00387     //  fPublicId
00388     //      This is the optional public id for the input source. It can be
00389     //      null if none is desired.
00390     //
00391     //  fSystemId
00392     //      This is the system id for the input source. This is what is
00393     //      actually used to open the source.
00394     //
00395     //  fFatalErrorIfNotFound
00396     // -----------------------------------------------------------------------
00397     MemoryManager* fMemoryManager;
00398     XMLCh*         fEncoding;
00399     XMLCh*         fPublicId;
00400     XMLCh*         fSystemId;
00401     bool           fFatalErrorIfNotFound;
00402 };
00403 
00404 
00405 // ---------------------------------------------------------------------------
00406 //  InputSource: Getter methods
00407 // ---------------------------------------------------------------------------
00408 inline const XMLCh* InputSource::getEncoding() const
00409 {
00410     return fEncoding;
00411 }
00412 
00413 inline const XMLCh* InputSource::getPublicId() const
00414 {
00415     return fPublicId;
00416 }
00417 
00418 inline const XMLCh* InputSource::getSystemId() const
00419 {
00420     return fSystemId;
00421 }
00422 
00423 inline bool InputSource::getIssueFatalErrorIfNotFound() const
00424 {
00425     return fFatalErrorIfNotFound;
00426 }
00427 
00428 inline MemoryManager* InputSource::getMemoryManager() const
00429 {
00430     return fMemoryManager;
00431 }
00432 
00433 // ---------------------------------------------------------------------------
00434 //  InputSource: Setter methods
00435 // ---------------------------------------------------------------------------
00436 inline void InputSource::setIssueFatalErrorIfNotFound(const bool flag)
00437 {
00438     fFatalErrorIfNotFound = flag;
00439 }
00440 
00441 XERCES_CPP_NAMESPACE_END
00442 
00443 #endif