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.7  2004/01/29 11:46:29  cargilld
00060  * Code cleanup changes to get rid of various compiler diagnostic messages.
00061  *
00062  * Revision 1.6  2003/12/01 23:23:25  neilg
00063  * fix for bug 25118; thanks to Jeroen Witmond
00064  *
00065  * Revision 1.5  2003/07/30 14:48:38  peiyongz
00066  * Allow default value
00067  *
00068  * Revision 1.4  2003/05/16 21:36:55  knoaman
00069  * Memory manager implementation: Modify constructors to pass in the memory manager.
00070  *
00071  * Revision 1.3  2002/11/04 15:00:21  tng
00072  * C++ Namespace Support.
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:21:50  peiyongz
00078  * sane_include
00079  *
00080  * Revision 1.6  2000/12/14 18:49:54  tng
00081  * Fix API document generation warning: "Warning: end of member group without matching begin"
00082  *
00083  * Revision 1.5  2000/02/24 20:00:22  abagchi
00084  * Swat for removing Log from API docs
00085  *
00086  * Revision 1.4  2000/02/15 23:59:06  roddey
00087  * More updated documentation of Framework classes.
00088  *
00089  * Revision 1.3  2000/02/15 01:21:30  roddey
00090  * Some initial documentation improvements. More to come...
00091  *
00092  * Revision 1.2  2000/02/06 07:47:46  rahulj
00093  * Year 2K copyright swat.
00094  *
00095  * Revision 1.1  2000/01/12 00:13:26  roddey
00096  * These were moved from internal/ to framework/, which was something that should have
00097  * happened long ago. They are really framework type of classes.
00098  *
00099  * Revision 1.1.1.1  1999/11/09 01:08:10  twl
00100  * Initial checkin
00101  *
00102  * Revision 1.2  1999/11/08 20:44:43  rahul
00103  * Swat for adding in Product name and CVS comment log variable.
00104  *
00105  */
00106 
00107 
00108 #if !defined(MEMBUFINPUTSOURCE_HPP)
00109 #define MEMBUFINPUTSOURCE_HPP
00110 
00111 #include <xercesc/sax/InputSource.hpp>
00112 
00113 XERCES_CPP_NAMESPACE_BEGIN
00114 
00115 class BinInputStream;
00116 
00117 
00146 class  MemBufInputSource : public InputSource
00147 {
00148 public :
00149     // -----------------------------------------------------------------------
00150     //  Constructors and Destructor
00151     // -----------------------------------------------------------------------
00152 
00155 
00177     MemBufInputSource
00178     (
00179         const   XMLByte* const  srcDocBytes
00180         , const unsigned int    byteCount
00181         , const XMLCh* const    bufId
00182         , const bool            adoptBuffer = false
00183         , MemoryManager* const  manager = XMLPlatformUtils::fgMemoryManager
00184     );
00185 
00190     MemBufInputSource
00191     (
00192         const   XMLByte* const  srcDocBytes
00193         , const unsigned int    byteCount
00194         , const char* const     bufId
00195         , const bool            adoptBuffer = false
00196         , MemoryManager* const  manager = XMLPlatformUtils::fgMemoryManager
00197     );
00199 
00206     ~MemBufInputSource();
00208 
00209 
00210     // -----------------------------------------------------------------------
00211     //  Virtual input source interface
00212     // -----------------------------------------------------------------------
00213 
00216 
00227     BinInputStream* makeStream() const;
00228 
00230 
00231 
00232     // -----------------------------------------------------------------------
00233     //  Setter methods
00234     // -----------------------------------------------------------------------
00235 
00239 
00255     void setCopyBufToStream(const bool newState);
00256 
00258 
00259 
00260 private :
00261     // -----------------------------------------------------------------------
00262     //  Unimplemented constructors and operators
00263     // -----------------------------------------------------------------------
00264     MemBufInputSource(const MemBufInputSource&);
00265     MemBufInputSource& operator=(const MemBufInputSource&);
00266 
00267     // -----------------------------------------------------------------------
00268     //  Private data members
00269     //
00270     //  fAdopted
00271     //      Indicates whether the buffer is adopted or not. If so, then it
00272     //      is destroyed when the input source is destroyed.
00273     //
00274     //  fByteCount
00275     //      The size of the source document.
00276     //
00277     //  fCopyBufToStream
00278     //      This defaults to true (the safe option), which causes it to
00279     //      give a copy of the buffer to any streams it creates. If you set
00280     //      it to false, it will allow the streams to just reference the
00281     //      buffer (in which case this input source must stay alive as long
00282     //      as the buffer is in use by the stream.)
00283     //
00284     //  fSrcBytes
00285     //      The source memory buffer that is being spooled from. Whether it
00286     //      belongs to the this input source or not is controlled by the
00287     //      fAdopted flag.
00288     // -----------------------------------------------------------------------
00289     bool            fAdopted;
00290     unsigned int    fByteCount;
00291     bool            fCopyBufToStream;
00292     const XMLByte*  fSrcBytes;
00293 };
00294 
00295 
00296 inline void MemBufInputSource::setCopyBufToStream(const bool newState)
00297 {
00298     fCopyBufToStream = newState;
00299 }
00300 
00301 XERCES_CPP_NAMESPACE_END
00302 
00303 #endif


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