XMLBufferMgr.hpp
上传用户:huihehuasu
上传日期:2007-01-10
资源大小:6948k
文件大小:7k
源码类别:

xml/soap/webservice

开发平台:

C/C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  * 
  4.  * Copyright (c) 1999-2000 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  * 
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  * 
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer. 
  13.  * 
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  * 
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:  
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  * 
  26.  * 4. The names "Xerces" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written 
  29.  *    permission, please contact apache@apache.org.
  30.  * 
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  * 
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  * 
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation, and was
  51.  * originally based on software copyright (c) 1999, International
  52.  * Business Machines, Inc., http://www.ibm.com .  For more information
  53.  * on the Apache Software Foundation, please see
  54.  * <http://www.apache.org/>.
  55.  */
  56. /*
  57.  * $Log: XMLBufferMgr.hpp,v $
  58.  * Revision 1.5  2000/03/02 19:54:24  roddey
  59.  * This checkin includes many changes done while waiting for the
  60.  * 1.1.0 code to be finished. I can't list them all here, but a list is
  61.  * available elsewhere.
  62.  *
  63.  * Revision 1.4  2000/02/24 20:00:23  abagchi
  64.  * Swat for removing Log from API docs
  65.  *
  66.  * Revision 1.3  2000/02/15 01:21:30  roddey
  67.  * Some initial documentation improvements. More to come...
  68.  *
  69.  * Revision 1.2  2000/02/06 07:47:47  rahulj
  70.  * Year 2K copyright swat.
  71.  *
  72.  * Revision 1.1.1.1  1999/11/09 01:08:30  twl
  73.  * Initial checkin
  74.  *
  75.  * Revision 1.2  1999/11/08 20:44:36  rahul
  76.  * Swat for adding in Product name and CVS comment log variable.
  77.  *
  78.  */
  79. #if !defined(XMLBUFFERMGR_HPP)
  80. #define XMLBUFFERMGR_HPP
  81. #include <util/XercesDefs.hpp>
  82. #include <framework/XMLBuffer.hpp>
  83. class XMLBufBid;
  84. /**
  85.  *  There are many places where XMLBuffer objects are needed. In order to
  86.  *  avoid either constantly creating and destroying them or maintaining a
  87.  *  fixed set and worrying about accidental reuse, a buffer manager can
  88.  *  provide a pool of buffers which can be temporarily used and then put
  89.  *  back into the pool. This provides a good compromise between performance
  90.  *  and easier maintenance.
  91.  */
  92. class XMLPARSER_EXPORT XMLBufferMgr
  93. {
  94. public :
  95.     // -----------------------------------------------------------------------
  96.     //  Constructors and Destructor
  97.     // -----------------------------------------------------------------------
  98.     /** @name Constructor */
  99.     //@{
  100.     XMLBufferMgr();
  101.     //@}
  102.     /** @name Destructor */
  103.     //@{
  104.     ~XMLBufferMgr();
  105.     //@}
  106.     // -----------------------------------------------------------------------
  107.     //  Buffer management
  108.     // -----------------------------------------------------------------------
  109.     XMLBuffer& bidOnBuffer();
  110.     void releaseBuffer(XMLBuffer& toRelease);
  111. private :
  112.     // -----------------------------------------------------------------------
  113.     //  Private data members
  114.     //
  115.     //  fBufCount
  116.     //      The count of buffers that have been allocated so far.
  117.     //
  118.     //  fBufList;
  119.     //      The list of pointers to buffers that are loaned out. There will
  120.     //      never be a lot of them, so a flat list is good enough.
  121.     // -----------------------------------------------------------------------
  122.     unsigned int    fBufCount;
  123.     XMLBuffer**     fBufList;
  124. };
  125. /**
  126.  *  XMLBufBid is a scoped based janitor that allows the scanner code to ask
  127.  *  for a buffer on a scoped basis and then insure that it gets freed back
  128.  *  into the pool no matter how the scope is exited (exception or normal exit.)
  129.  */
  130. class XMLBufBid
  131. {
  132. public :
  133.     // -----------------------------------------------------------------------
  134.     //  Constructors and Destructor
  135.     // -----------------------------------------------------------------------
  136.     XMLBufBid(XMLBufferMgr* const srcMgr) :
  137.         fBuffer(srcMgr->bidOnBuffer())
  138.         , fMgr(srcMgr)
  139.     {
  140.     }
  141.     ~XMLBufBid()
  142.     {
  143.         fMgr->releaseBuffer(fBuffer);
  144.     }
  145.     // -----------------------------------------------------------------------
  146.     //  Buffer access
  147.     // -----------------------------------------------------------------------
  148.     void append(const XMLCh toAppend)
  149.     {
  150.         fBuffer.append(toAppend);
  151.     }
  152.     void append(const XMLCh* const toAppend, const unsigned int count = 0)
  153.     {
  154.         fBuffer.append(toAppend, count);
  155.     }
  156.     const XMLBuffer& getBuffer() const
  157.     {
  158.         return fBuffer;
  159.     }
  160.     XMLBuffer& getBuffer()
  161.     {
  162.         return fBuffer;
  163.     }
  164.     const XMLCh* getRawBuffer() const
  165.     {
  166.         fBuffer.fBuffer[fBuffer.fIndex] = 0;
  167.         return fBuffer.fBuffer;
  168.     }
  169.     XMLCh* getRawBuffer()
  170.     {
  171.         fBuffer.fBuffer[fBuffer.fIndex] = 0;
  172.         return fBuffer.fBuffer;
  173.     }
  174.     unsigned int getLen() const
  175.     {
  176.         return fBuffer.fIndex;
  177.     }
  178.     bool isEmpty()
  179.     {
  180.         return (fBuffer.fIndex == 0);
  181.     }
  182.     void reset()
  183.     {
  184.         fBuffer.reset();
  185.     }
  186.     void set(const XMLCh* const chars, const unsigned int count = 0)
  187.     {
  188.         fBuffer.set(chars, count);
  189.     }
  190. private :
  191.     // -----------------------------------------------------------------------
  192.     //  Private data members
  193.     //
  194.     //  fBuffer
  195.     //      This is the buffer we got, and which we will release.
  196.     //
  197.     //  fMgr
  198.     //      This is the buffer manager we got the buffer from. This is needed
  199.     //      to release the buffer later.
  200.     // -----------------------------------------------------------------------
  201.     XMLBuffer&          fBuffer;
  202.     XMLBufferMgr* const fMgr;
  203. };
  204. #endif