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.11  2003/12/17 00:18:35  cargilld
00060  * Update to memory management so that the static memory manager (one used to call Initialize) is only for static data.
00061  *
00062  * Revision 1.10  2003/12/01 23:23:26  neilg
00063  * fix for bug 25118; thanks to Jeroen Witmond
00064  *
00065  * Revision 1.9  2003/11/17 10:52:15  amassari
00066  * Fixed documentation bug#24746
00067  *
00068  * Revision 1.8  2003/05/30 16:11:45  gareth
00069  * Fixes so we compile under VC7.1. Patch by Alberto Massari.
00070  *
00071  * Revision 1.7  2003/05/16 21:36:59  knoaman
00072  * Memory manager implementation: Modify constructors to pass in the memory manager.
00073  *
00074  * Revision 1.6  2003/05/15 18:27:05  knoaman
00075  * Partial implementation of the configurable memory manager.
00076  *
00077  * Revision 1.5  2003/03/07 18:10:06  tng
00078  * Return a reference instead of void for operator=
00079  *
00080  * Revision 1.4  2002/11/04 14:56:26  tng
00081  * C++ Namespace Support.
00082  *
00083  * Revision 1.3  2002/09/30 18:26:18  tng
00084  * Since the derived class Wrapper4DOMInputSource has overwritten the set/getEncoding, SystemId, PublicId ... etc., these functions has to be virtual for them to work.
00085  *
00086  * Revision 1.2  2002/02/20 18:17:01  tng
00087  * [Bug 5977] Warnings on generating apiDocs.
00088  *
00089  * Revision 1.1.1.1  2002/02/01 22:22:08  peiyongz
00090  * sane_include
00091  *
00092  * Revision 1.10  2001/11/21 16:14:32  tng
00093  * 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.
00094  *
00095  * Revision 1.9  2000/03/02 19:54:35  roddey
00096  * This checkin includes many changes done while waiting for the
00097  * 1.1.0 code to be finished. I can't list them all here, but a list is
00098  * available elsewhere.
00099  *
00100  * Revision 1.8  2000/02/24 20:12:55  abagchi
00101  * Swat for removing Log from API docs
00102  *
00103  * Revision 1.7  2000/02/12 03:42:21  rahulj
00104  * Fixed DOC++ documentation formatting errors.
00105  *
00106  * Revision 1.6  2000/02/12 03:31:55  rahulj
00107  * Removed duplicate CVS Log entries.
00108  *
00109  * Revision 1.5  2000/02/12 01:27:19  aruna1
00110  * Documentation updated
00111  *
00112  * Revision 1.4  2000/02/09 02:15:28  abagchi
00113  * Documented destructor
00114  *
00115  * Revision 1.3  2000/02/06 07:47:58  rahulj
00116  * Year 2K copyright swat.
00117  *
00118  * Revision 1.2  2000/01/12 00:15:39  roddey
00119  * Changes to deal with multiply nested, relative pathed, entities and to deal
00120  * with the new URL class changes.
00121  *
00122  * Revision 1.1.1.1  1999/11/09 01:07:46  twl
00123  * Initial checkin
00124  *
00125  * Revision 1.2  1999/11/08 20:45:01  rahul
00126  * Swat for adding in Product name and CVS comment log variable.
00127  *
00128  */
00129 
00130 
00131 #ifndef INPUTSOURCE_HPP
00132 #define INPUTSOURCE_HPP
00133 
00134 #include <xercesc/util/PlatformUtils.hpp>
00135 
00136 XERCES_CPP_NAMESPACE_BEGIN
00137 
00138 class BinInputStream;
00139 
00140 
00171 class  InputSource : public XMemory
00172 {
00173 public:
00174     // -----------------------------------------------------------------------
00175     //  All constructors are hidden, just the destructor is available
00176     // -----------------------------------------------------------------------
00183     virtual ~InputSource();
00185 
00186 
00187     // -----------------------------------------------------------------------
00200     virtual BinInputStream* makeStream() const = 0;
00201 
00203 
00204 
00205     // -----------------------------------------------------------------------
00217     virtual const XMLCh* getEncoding() const;
00218 
00219 
00226     virtual const XMLCh* getPublicId() const;
00227 
00228 
00237     virtual const XMLCh* getSystemId() const;
00238 
00247     virtual bool getIssueFatalErrorIfNotFound() const;
00248 
00249     MemoryManager* getMemoryManager() const;
00250 
00252 
00253 
00254     // -----------------------------------------------------------------------
00257 
00269     virtual void setEncoding(const XMLCh* const encodingStr);
00270 
00271 
00283     virtual void setPublicId(const XMLCh* const publicId);
00284 
00301     virtual void setSystemId(const XMLCh* const systemId);
00302 
00312     virtual void setIssueFatalErrorIfNotFound(const bool flag);
00313 
00315 
00316 
00317 protected :
00318     // -----------------------------------------------------------------------
00319     //  Hidden constructors
00320     // -----------------------------------------------------------------------
00324     InputSource(MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
00325 
00331     InputSource(const XMLCh* const systemId,
00332                 MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
00333 
00340     InputSource
00341     (
00342         const   XMLCh* const   systemId
00343         , const XMLCh* const   publicId
00344         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
00345     );
00346 
00352     InputSource(const char* const systemId,
00353                 MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
00354 
00361     InputSource
00362     (
00363         const   char* const systemId
00364         , const char* const publicId
00365         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
00366     );
00367 
00369 
00370 
00371 
00372 
00373 
00374 private:
00375     // -----------------------------------------------------------------------
00376     //  Unimplemented constructors and operators
00377     // -----------------------------------------------------------------------
00378     InputSource(const InputSource&);
00379     InputSource& operator=(const InputSource&);
00380 
00381 
00382     // -----------------------------------------------------------------------
00383     //  Private data members
00384     //
00385     //  fEncoding
00386     //      This is the encoding to use. Usually this is null, which means
00387     //      to use the information found in the file itself. But, if set,
00388     //      this encoding will be used without question.
00389     //
00390     //  fPublicId
00391     //      This is the optional public id for the input source. It can be
00392     //      null if none is desired.
00393     //
00394     //  fSystemId
00395     //      This is the system id for the input source. This is what is
00396     //      actually used to open the source.
00397     //
00398     //  fFatalErrorIfNotFound
00399     // -----------------------------------------------------------------------
00400     MemoryManager* const fMemoryManager;
00401     XMLCh*         fEncoding;
00402     XMLCh*         fPublicId;
00403     XMLCh*         fSystemId;
00404     bool           fFatalErrorIfNotFound;
00405 };
00406 
00407 
00408 // ---------------------------------------------------------------------------
00409 //  InputSource: Getter methods
00410 // ---------------------------------------------------------------------------
00411 inline const XMLCh* InputSource::getEncoding() const
00412 {
00413     return fEncoding;
00414 }
00415 
00416 inline const XMLCh* InputSource::getPublicId() const
00417 {
00418     return fPublicId;
00419 }
00420 
00421 inline const XMLCh* InputSource::getSystemId() const
00422 {
00423     return fSystemId;
00424 }
00425 
00426 inline bool InputSource::getIssueFatalErrorIfNotFound() const
00427 {
00428     return fFatalErrorIfNotFound;
00429 }
00430 
00431 inline MemoryManager* InputSource::getMemoryManager() const
00432 {
00433     return fMemoryManager;
00434 }
00435 
00436 // ---------------------------------------------------------------------------
00437 //  InputSource: Setter methods
00438 // ---------------------------------------------------------------------------
00439 inline void InputSource::setIssueFatalErrorIfNotFound(const bool flag)
00440 {
00441     fFatalErrorIfNotFound = flag;
00442 }
00443 
00444 XERCES_CPP_NAMESPACE_END
00445 
00446 #endif