http://xml.apache.org/http://www.apache.org/http://www.w3.org/

Home

Readme
Release Info

Installation
Download
Build

FAQs
Samples
API Docs

DOM C++ Binding
Programming
Migration Guide

Feedback
Bug-Reporting
PDF Document

CVS Repository
Mail Archive

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


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