MemBufInputSource.hpp Source File

| API Docs for SAX and DOM |

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

# MemBufInputSource.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: MemBufInputSource.hpp,v $
    00059  * Revision 1.4  2003/05/16 21:36:55  knoaman
    00060  * Memory manager implementation: Modify constructors to pass in the memory manager.
    00061  *
    00062  * Revision 1.3  2002/11/04 15:00:21  tng
    00063  * C++ Namespace Support.
    00064  *
    00065  * Revision 1.2  2002/02/20 18:17:01  tng
    00066  * [Bug 5977] Warnings on generating apiDocs.
    00067  *
    00068  * Revision 1.1.1.1  2002/02/01 22:21:50  peiyongz
    00069  * sane_include
    00070  *
    00071  * Revision 1.6  2000/12/14 18:49:54  tng
    00072  * Fix API document generation warning: "Warning: end of member group without matching begin"
    00073  *
    00074  * Revision 1.5  2000/02/24 20:00:22  abagchi
    00075  * Swat for removing Log from API docs
    00076  *
    00077  * Revision 1.4  2000/02/15 23:59:06  roddey
    00078  * More updated documentation of Framework classes.
    00079  *
    00080  * Revision 1.3  2000/02/15 01:21:30  roddey
    00081  * Some initial documentation improvements. More to come...
    00082  *
    00083  * Revision 1.2  2000/02/06 07:47:46  rahulj
    00084  * Year 2K copyright swat.
    00085  *
    00086  * Revision 1.1  2000/01/12 00:13:26  roddey
    00087  * These were moved from internal/ to framework/, which was something that should have
    00088  * happened long ago. They are really framework type of classes.
    00089  *
    00090  * Revision 1.1.1.1  1999/11/09 01:08:10  twl
    00091  * Initial checkin
    00092  *
    00093  * Revision 1.2  1999/11/08 20:44:43  rahul
    00094  * Swat for adding in Product name and CVS comment log variable.
    00095  *
    00096  */
    00097
    00098
    00099 #if !defined(MEMBUFINPUTSOURCE_HPP)
    00100 #define MEMBUFINPUTSOURCE_HPP
    00101
    00102 #include <xercesc/sax/InputSource.hpp>
    00103
    00104 XERCES_CPP_NAMESPACE_BEGIN
    00105
    00106 class BinInputStream;
    00107
    00108
    00137 class  MemBufInputSource : public InputSource
    00138 {
    00139 public :
    00140     // -----------------------------------------------------------------------
    00141     //  Constructors and Destructor
    00142     // -----------------------------------------------------------------------
    00143
    00146
    00166     MemBufInputSource
    00167     (
    00168         const   XMLByte* const  srcDocBytes
    00169         , const unsigned int    byteCount
    00170         , const XMLCh* const    bufId
    00171         , const bool            adoptBuffer// = false
    00172         , MemoryManager* const  manager = XMLPlatformUtils::fgMemoryManager
    00173     );
    00174
    00179     MemBufInputSource
    00180     (
    00181         const   XMLByte* const  srcDocBytes
    00182         , const unsigned int    byteCount
    00183         , const char* const     bufId
    00184         , const bool            adoptBuffer = false
    00185         , MemoryManager* const  manager = XMLPlatformUtils::fgMemoryManager
    00186     );
    00188
    00195     ~MemBufInputSource();
    00197
    00198
    00199     // -----------------------------------------------------------------------
    00200     //  Virtual input source interface
    00201     // -----------------------------------------------------------------------
    00202
    00205
    00216     BinInputStream* makeStream() const;
    00217
    00219
    00220
    00221     // -----------------------------------------------------------------------
    00222     //  Setter methods
    00223     // -----------------------------------------------------------------------
    00224
    00228
    00244     void setCopyBufToStream(const bool newState);
    00245
    00247
    00248
    00249 private :
    00250     // -----------------------------------------------------------------------
    00251     //  Private data members
    00252     //
    00253     //  fAdopted
    00254     //      Indicates whether the buffer is adopted or not. If so, then it
    00255     //      is destroyed when the input source is destroyed.
    00256     //
    00257     //  fByteCount
    00258     //      The size of the source document.
    00259     //
    00260     //  fCopyBufToStream
    00261     //      This defaults to true (the safe option), which causes it to
    00262     //      give a copy of the buffer to any streams it creates. If you set
    00263     //      it to false, it will allow the streams to just reference the
    00264     //      buffer (in which case this input source must stay alive as long
    00265     //      as the buffer is in use by the stream.)
    00266     //
    00267     //  fSrcBytes
    00268     //      The source memory buffer that is being spooled from. Whether it
    00269     //      belongs to the this input source or not is controlled by the
    00270     //      fAdopted flag.
    00271     // -----------------------------------------------------------------------
    00272     bool            fAdopted;
    00273     unsigned int    fByteCount;
    00274     bool            fCopyBufToStream;
    00275     const XMLByte*  fSrcBytes;
    00276 };
    00277
    00278
    00279 inline void MemBufInputSource::setCopyBufToStream(const bool newState)
    00280 {
    00281     fCopyBufToStream = newState;
    00282 }
    00283
    00284 XERCES_CPP_NAMESPACE_END
    00285
    00286 #endif

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