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

Home

Readme
Installation
Build

API Docs
Samples
Programming
Migration
FAQs

Releases
Feedback

PDF Document

Download
Dev Snapshots
CVS Repository
Mail Archive

API Docs for SAX and DOM
 

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

XMLBufferMgr.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: XMLBufferMgr.hpp,v $
00059  * Revision 1.5  2000/03/02 19:54:24  roddey
00060  * This checkin includes many changes done while waiting for the
00061  * 1.1.0 code to be finished. I can't list them all here, but a list is
00062  * available elsewhere.
00063  *
00064  * Revision 1.4  2000/02/24 20:00:23  abagchi
00065  * Swat for removing Log from API docs
00066  *
00067  * Revision 1.3  2000/02/15 01:21:30  roddey
00068  * Some initial documentation improvements. More to come...
00069  *
00070  * Revision 1.2  2000/02/06 07:47:47  rahulj
00071  * Year 2K copyright swat.
00072  *
00073  * Revision 1.1.1.1  1999/11/09 01:08:30  twl
00074  * Initial checkin
00075  *
00076  * Revision 1.2  1999/11/08 20:44:36  rahul
00077  * Swat for adding in Product name and CVS comment log variable.
00078  *
00079  */
00080 
00081 
00082 #if !defined(XMLBUFFERMGR_HPP)
00083 #define XMLBUFFERMGR_HPP
00084 
00085 #include <util/XercesDefs.hpp>
00086 #include <framework/XMLBuffer.hpp>
00087 
00088 class XMLBufBid;
00089 
00098 class  XMLBufferMgr
00099 {
00100 public :
00101     // -----------------------------------------------------------------------
00102     //  Constructors and Destructor
00103     // -----------------------------------------------------------------------
00104 
00106     //@{
00107     XMLBufferMgr();
00108     //@}
00109 
00111     //@{
00112     ~XMLBufferMgr();
00113     //@}
00114 
00115 
00116     // -----------------------------------------------------------------------
00117     //  Buffer management
00118     // -----------------------------------------------------------------------
00119     XMLBuffer& bidOnBuffer();
00120     void releaseBuffer(XMLBuffer& toRelease);
00121 
00122 
00123 private :
00124     // -----------------------------------------------------------------------
00125     //  Private data members
00126     //
00127     //  fBufCount
00128     //      The count of buffers that have been allocated so far.
00129     //
00130     //  fBufList;
00131     //      The list of pointers to buffers that are loaned out. There will
00132     //      never be a lot of them, so a flat list is good enough.
00133     // -----------------------------------------------------------------------
00134     unsigned int    fBufCount;
00135     XMLBuffer**     fBufList;
00136 };
00137 
00138 
00144 class XMLBufBid
00145 {
00146 public :
00147     // -----------------------------------------------------------------------
00148     //  Constructors and Destructor
00149     // -----------------------------------------------------------------------
00150     XMLBufBid(XMLBufferMgr* const srcMgr) :
00151 
00152         fBuffer(srcMgr->bidOnBuffer())
00153         , fMgr(srcMgr)
00154     {
00155     }
00156 
00157     ~XMLBufBid()
00158     {
00159         fMgr->releaseBuffer(fBuffer);
00160     }
00161 
00162 
00163 
00164     // -----------------------------------------------------------------------
00165     //  Buffer access
00166     // -----------------------------------------------------------------------
00167     void append(const XMLCh toAppend)
00168     {
00169         fBuffer.append(toAppend);
00170     }
00171 
00172     void append(const XMLCh* const toAppend, const unsigned int count = 0)
00173     {
00174         fBuffer.append(toAppend, count);
00175     }
00176 
00177     const XMLBuffer& getBuffer() const
00178     {
00179         return fBuffer;
00180     }
00181 
00182     XMLBuffer& getBuffer()
00183     {
00184         return fBuffer;
00185     }
00186 
00187     const XMLCh* getRawBuffer() const
00188     {
00189         fBuffer.fBuffer[fBuffer.fIndex] = 0;
00190         return fBuffer.fBuffer;
00191     }
00192 
00193     XMLCh* getRawBuffer()
00194     {
00195         fBuffer.fBuffer[fBuffer.fIndex] = 0;
00196         return fBuffer.fBuffer;
00197     }
00198 
00199     unsigned int getLen() const
00200     {
00201         return fBuffer.fIndex;
00202     }
00203 
00204     bool isEmpty()
00205     {
00206         return (fBuffer.fIndex == 0);
00207     }
00208 
00209     void reset()
00210     {
00211         fBuffer.reset();
00212     }
00213 
00214     void set(const XMLCh* const chars, const unsigned int count = 0)
00215     {
00216         fBuffer.set(chars, count);
00217     }
00218 
00219 
00220 private :
00221     // -----------------------------------------------------------------------
00222     //  Private data members
00223     //
00224     //  fBuffer
00225     //      This is the buffer we got, and which we will release.
00226     //
00227     //  fMgr
00228     //      This is the buffer manager we got the buffer from. This is needed
00229     //      to release the buffer later.
00230     // -----------------------------------------------------------------------
00231     XMLBuffer&          fBuffer;
00232     XMLBufferMgr* const fMgr;
00233 };
00234 
00235 #endif


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