InputSource.hpp Source File

| API Docs for SAX and DOM |

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

# InputSource.hpp

Go to the documentation of this 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.7  2003/05/16 21:36:59  knoaman
    00060  * Memory manager implementation: Modify constructors to pass in the memory manager.
    00061  *
    00062  * Revision 1.6  2003/05/15 18:27:05  knoaman
    00063  * Partial implementation of the configurable memory manager.
    00064  *
    00065  * Revision 1.5  2003/03/07 18:10:06  tng
    00066  * Return a reference instead of void for operator=
    00067  *
    00068  * Revision 1.4  2002/11/04 14:56:26  tng
    00069  * C++ Namespace Support.
    00070  *
    00071  * Revision 1.3  2002/09/30 18:26:18  tng
    00072  * Since the derived class Wrapper4DOMInputSource has overwritten the set/getEncoding, SystemId, PublicId ... etc., these functions has to be virtual for them to work.
    00073  *
    00074  * Revision 1.2  2002/02/20 18:17:01  tng
    00075  * [Bug 5977] Warnings on generating apiDocs.
    00076  *
    00077  * Revision 1.1.1.1  2002/02/01 22:22:08  peiyongz
    00078  * sane_include
    00079  *
    00080  * Revision 1.10  2001/11/21 16:14:32  tng
    00081  * 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.
    00082  *
    00083  * Revision 1.9  2000/03/02 19:54:35  roddey
    00084  * This checkin includes many changes done while waiting for the
    00085  * 1.1.0 code to be finished. I can't list them all here, but a list is
    00086  * available elsewhere.
    00087  *
    00088  * Revision 1.8  2000/02/24 20:12:55  abagchi
    00089  * Swat for removing Log from API docs
    00090  *
    00091  * Revision 1.7  2000/02/12 03:42:21  rahulj
    00092  * Fixed DOC++ documentation formatting errors.
    00093  *
    00094  * Revision 1.6  2000/02/12 03:31:55  rahulj
    00095  * Removed duplicate CVS Log entries.
    00096  *
    00097  * Revision 1.5  2000/02/12 01:27:19  aruna1
    00098  * Documentation updated
    00099  *
    00100  * Revision 1.4  2000/02/09 02:15:28  abagchi
    00101  * Documented destructor
    00102  *
    00103  * Revision 1.3  2000/02/06 07:47:58  rahulj
    00104  * Year 2K copyright swat.
    00105  *
    00106  * Revision 1.2  2000/01/12 00:15:39  roddey
    00107  * Changes to deal with multiply nested, relative pathed, entities and to deal
    00108  * with the new URL class changes.
    00109  *
    00110  * Revision 1.1.1.1  1999/11/09 01:07:46  twl
    00111  * Initial checkin
    00112  *
    00113  * Revision 1.2  1999/11/08 20:45:01  rahul
    00114  * Swat for adding in Product name and CVS comment log variable.
    00115  *
    00116  */
    00117
    00118
    00119 #ifndef INPUTSOURCE_HPP
    00120 #define INPUTSOURCE_HPP
    00121
    00122 #include <xercesc/util/PlatformUtils.hpp>
    00123
    00124 XERCES_CPP_NAMESPACE_BEGIN
    00125
    00126 class BinInputStream;
    00127
    00128
    00159 class  InputSource : public XMemory
    00160 {
    00161 public:
    00162     // -----------------------------------------------------------------------
    00163     //  All constructors are hidden, just the destructor is available
    00164     // -----------------------------------------------------------------------
    00171     virtual ~InputSource();
    00173
    00174
    00175     // -----------------------------------------------------------------------
    00188     virtual BinInputStream* makeStream() const = 0;
    00189
    00191
    00192
    00193     // -----------------------------------------------------------------------
    00205     virtual const XMLCh* getEncoding() const;
    00206
    00207
    00214     virtual const XMLCh* getPublicId() const;
    00215
    00216
    00225     virtual const XMLCh* getSystemId() const;
    00226
    00235     virtual const bool getIssueFatalErrorIfNotFound() const;
    00236
    00237     MemoryManager* getMemoryManager() const;
    00238
    00240
    00241
    00242     // -----------------------------------------------------------------------
    00245
    00257     virtual void setEncoding(const XMLCh* const encodingStr);
    00258
    00259
    00271     virtual void setPublicId(const XMLCh* const publicId);
    00272
    00289     virtual void setSystemId(const XMLCh* const systemId);
    00290
    00300     virtual void setIssueFatalErrorIfNotFound(const bool flag);
    00301
    00303
    00304
    00305 protected :
    00306     // -----------------------------------------------------------------------
    00307     //  Hidden constructors
    00308     // -----------------------------------------------------------------------
    00312     InputSource(MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
    00313
    00317     InputSource(const XMLCh* const systemId,
    00318                 MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
    00319
    00324     InputSource
    00325     (
    00326         const   XMLCh* const   systemId
    00327         , const XMLCh* const   publicId
    00328         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
    00329     );
    00330
    00334     InputSource(const char* const systemId,
    00335                 MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
    00336
    00341     InputSource
    00342     (
    00343         const   char* const systemId
    00344         , const char* const publicId
    00345         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
    00346     );
    00347
    00349
    00350
    00351
    00352
    00353
    00354 private:
    00355     // -----------------------------------------------------------------------
    00356     //  Unimplemented constructors and operators
    00357     // -----------------------------------------------------------------------
    00358     InputSource(const InputSource&);
    00359     InputSource& operator=(const InputSource&);
    00360
    00361
    00362     // -----------------------------------------------------------------------
    00363     //  Private data members
    00364     //
    00365     //  fEncoding
    00366     //      This is the encoding to use. Usually this is null, which means
    00367     //      to use the information found in the file itself. But, if set,
    00368     //      this encoding will be used without question.
    00369     //
    00370     //  fPublicId
    00371     //      This is the optional public id for the input source. It can be
    00372     //      null if none is desired.
    00373     //
    00374     //  fSystemId
    00375     //      This is the system id for the input source. This is what is
    00376     //      actually used to open the source.
    00377     //
    00378     //  fFatalErrorIfNotFound
    00379     // -----------------------------------------------------------------------
    00380     MemoryManager* fMemoryManager;
    00381     XMLCh*         fEncoding;
    00382     XMLCh*         fPublicId;
    00383     XMLCh*         fSystemId;
    00384     bool           fFatalErrorIfNotFound;
    00385 };
    00386
    00387
    00388 // ---------------------------------------------------------------------------
    00389 //  InputSource: Getter methods
    00390 // ---------------------------------------------------------------------------
    00391 inline const XMLCh* InputSource::getEncoding() const
    00392 {
    00393     return fEncoding;
    00394 }
    00395
    00396 inline const XMLCh* InputSource::getPublicId() const
    00397 {
    00398     return fPublicId;
    00399 }
    00400
    00401 inline const XMLCh* InputSource::getSystemId() const
    00402 {
    00403     return fSystemId;
    00404 }
    00405
    00406 inline const bool InputSource::getIssueFatalErrorIfNotFound() const
    00407 {
    00408     return fFatalErrorIfNotFound;
    00409 }
    00410
    00411 inline MemoryManager* InputSource::getMemoryManager() const
    00412 {
    00413     return fMemoryManager;
    00414 }
    00415
    00416 // ---------------------------------------------------------------------------
    00417 //  InputSource: Setter methods
    00418 // ---------------------------------------------------------------------------
    00419 inline void InputSource::setIssueFatalErrorIfNotFound(const bool flag)
    00420 {
    00421     fFatalErrorIfNotFound = flag;
    00422 }
    00423
    00424 XERCES_CPP_NAMESPACE_END
    00425
    00426 #endif

Copyright © 2000 The Apache Software Foundation. All Rights Reserved.