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.5 2000/02/24 20:00:22 abagchi
00060 * Swat for removing Log from API docs
00061 *
00062 * Revision 1.4 2000/02/15 23:59:06 roddey
00063 * More updated documentation of Framework classes.
00064 *
00065 * Revision 1.3 2000/02/15 01:21:30 roddey
00066 * Some initial documentation improvements. More to come...
00067 *
00068 * Revision 1.2 2000/02/06 07:47:46 rahulj
00069 * Year 2K copyright swat.
00070 *
00071 * Revision 1.1 2000/01/12 00:13:26 roddey
00072 * These were moved from internal/ to framework/, which was something that should have
00073 * happened long ago. They are really framework type of classes.
00074 *
00075 * Revision 1.1.1.1 1999/11/09 01:08:10 twl
00076 * Initial checkin
00077 *
00078 * Revision 1.2 1999/11/08 20:44:43 rahul
00079 * Swat for adding in Product name and CVS comment log variable.
00080 *
00081 */
00082
00083
00084 #if !defined(MEMBUFINPUTSOURCE_HPP)
00085 #define MEMBUFINPUTSOURCE_HPP
00086
00087 #include <sax/InputSource.hpp>
00088
00089 class BinInputStream;
00090
00091
00120 class MemBufInputSource : public InputSource
00121 {
00122 public :
00123 // -----------------------------------------------------------------------
00124 // Constructors and Destructor
00125 // -----------------------------------------------------------------------
00126
00128 //@{
00129
00149 MemBufInputSource
00150 (
00151 const XMLByte* const srcDocBytes
00152 , const unsigned int byteCount
00153 , const XMLCh* const bufId
00154 , const bool adoptBuffer = false
00155 );
00156
00161 MemBufInputSource
00162 (
00163 const XMLByte* const srcDocBytes
00164 , const unsigned int byteCount
00165 , const char* const bufId
00166 , const bool adoptBuffer = false
00167 );
00168 //@}
00169
00171 //@{
00176 ~MemBufInputSource();
00177 //@}
00178
00179
00180 // -----------------------------------------------------------------------
00181 // Virtual input source interface
00182 // -----------------------------------------------------------------------
00183
00185 //{@
00186
00197 BinInputStream* makeStream() const;
00198
00199 //@}
00200
00201
00202 // -----------------------------------------------------------------------
00203 // Setter methods
00204 // -----------------------------------------------------------------------
00205
00207
00208 //{@
00209
00225 void setCopyBufToStream(const bool newState);
00226
00227 //@}
00228
00229
00230 private :
00231 // -----------------------------------------------------------------------
00232 // Private data members
00233 //
00234 // fAdopted
00235 // Indicates whether the buffer is adopted or not. If so, then it
00236 // is destroyed when the input source is destroyed.
00237 //
00238 // fByteCount
00239 // The size of the source document.
00240 //
00241 // fCopyBufToStream
00242 // This defaults to true (the safe option), which causes it to
00243 // give a copy of the buffer to any streams it creates. If you set
00244 // it to false, it will allow the streams to just reference the
00245 // buffer (in which case this input source must stay alive as long
00246 // as the buffer is in use by the stream.)
00247 //
00248 // fSrcBytes
00249 // The source memory buffer that is being spooled from. Whether it
00250 // belongs to the this input source or not is controlled by the
00251 // fAdopted flag.
00252 // -----------------------------------------------------------------------
00253 bool fAdopted;
00254 unsigned int fByteCount;
00255 bool fCopyBufToStream;
00256 const XMLByte* fSrcBytes;
00257 };
00258
00259
00260 inline void MemBufInputSource::setCopyBufToStream(const bool newState)
00261 {
00262 fCopyBufToStream = newState;
00263 }
00264
00265 #endif