MemBufFormatTarget.hpp
上传用户:zhuqijet
上传日期:2013-06-25
资源大小:10074k
文件大小:7k
源码类别:

词法分析

开发平台:

Visual C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 1999-2002 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.  * $Id: MemBufFormatTarget.hpp,v 1.7 2003/05/16 21:36:55 knoaman Exp $
  58.  * $Log: MemBufFormatTarget.hpp,v $
  59.  * Revision 1.7  2003/05/16 21:36:55  knoaman
  60.  * Memory manager implementation: Modify constructors to pass in the memory manager.
  61.  *
  62.  * Revision 1.6  2003/05/15 18:26:07  knoaman
  63.  * Partial implementation of the configurable memory manager.
  64.  *
  65.  * Revision 1.5  2002/11/04 15:00:21  tng
  66.  * C++ Namespace Support.
  67.  *
  68.  * Revision 1.4  2002/08/12 21:38:22  peiyongz
  69.  * Bug#11462: MemBufFormatTarget issue(2) .., proposed patch from
  70.  *                      Esmond Pitt (pitte@anz.com)
  71.  *
  72.  * Revision 1.3  2002/07/22 23:23:15  tng
  73.  * DOM L3: MemBufFormatTarget stores fDataBuf as XMLByte directly, consistent design as MemBufInputSource
  74.  *
  75.  * Revision 1.2  2002/06/05 15:47:13  peiyongz
  76.  * data member changed, reset() added.
  77.  *
  78.  * Revision 1.1  2002/05/28 22:40:46  peiyongz
  79.  * DOM3 Save Interface: DOMWriter/DOMWriterFilter
  80.  *
  81.  */
  82. #ifndef MemBufFormatTarget_HEADER_GUARD_
  83. #define MemBufFormatTarget_HEADER_GUARD_
  84. #include <xercesc/framework/XMLFormatter.hpp>
  85. XERCES_CPP_NAMESPACE_BEGIN
  86. /*
  87.  * The MemBufFormatTarget is a derivative from XMLFormatTarget, which user code
  88.  * may plug into DOMWriter to retrieve the serialized XML stream (from DOM Tree)
  89.  * in a memory buffer.
  90.  *
  91.  * The MemBufFormatTarget is initalized to have a memory buffer of 1023 upon
  92.  * construction, which grows as needed. The buffer will be deleted when
  93.  * MemBufFormatTarget is destructed; or will be reset when the reset() function
  94.  * is called.
  95.  *
  96.  * The MemBufFormatTarget returns a NULL terminated XMLByte stream upon request,
  97.  * through the method getRawBuffer(), and user should make its own copy of the
  98.  * returned buffer if it intends to keep it independent on the state of the
  99.  * MemBufFormatTarget.
  100.  */
  101. class XMLPARSER_EXPORT MemBufFormatTarget : public XMLFormatTarget {
  102. public:
  103.     /** @name constructors and destructor */
  104.     //@{
  105.     MemBufFormatTarget
  106.     (
  107.           int                  initCapacity = 1023
  108.         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
  109.     ) ;
  110.     ~MemBufFormatTarget();
  111.     //@}
  112.     // -----------------------------------------------------------------------
  113.     //  Implementations of the format target interface
  114.     // -----------------------------------------------------------------------
  115.     virtual void writeChars(const XMLByte* const toWrite
  116.                           , const unsigned int   count
  117.                           , XMLFormatter* const  formatter);
  118.     // -----------------------------------------------------------------------
  119.     //  Getter
  120.     // -----------------------------------------------------------------------
  121.     /** @name getRawBuffer */
  122.     //@{
  123.     /**
  124.      * Returned the internal raw buffer.
  125.      *
  126.      */
  127.     //@}
  128.     const XMLByte* getRawBuffer() const;
  129.     /** @name getLen */
  130.     //@{
  131.     /**
  132.      * Returned the length of the raw buffer.
  133.      *
  134.      */
  135.     //@}
  136.     unsigned int getLen() const
  137.     {
  138.         return fIndex;
  139.     }
  140.     /** @name reset */
  141.     //@{
  142.     /**
  143.      * Reset the internal string buffer.
  144.      *
  145.      */
  146.     void reset();
  147.     //@}
  148. private:
  149.     // -----------------------------------------------------------------------
  150.     //  Unimplemented methods.
  151.     // -----------------------------------------------------------------------
  152.     MemBufFormatTarget(const MemBufFormatTarget&);
  153.     MemBufFormatTarget& operator=(const MemBufFormatTarget&);
  154.     // -----------------------------------------------------------------------
  155.     //  Private helpers
  156.     // -----------------------------------------------------------------------
  157.     void insureCapacity(const unsigned int extraNeeded);
  158.     // -----------------------------------------------------------------------
  159.     //  Private data members
  160.     //
  161.     //  fDataBuf
  162.     //      The pointer to the buffer data. Its grown as needed. Its always
  163.     //      one larger than fCapacity, to leave room for the null terminator.
  164.     //
  165.     //  fIndex
  166.     //      The current index into the buffer, as characters are appended
  167.     //      to it. If its zero, then the buffer is empty.
  168.     //
  169.     //  fCapacity
  170.     //      The current capacity of the buffer. Its actually always one
  171.     //      larger, to leave room for the null terminator.
  172.     //
  173.     // -----------------------------------------------------------------------
  174.     MemoryManager*  fMemoryManager;
  175.     XMLByte*        fDataBuf;
  176.     unsigned int    fIndex;
  177.     unsigned int    fCapacity;
  178. };
  179. XERCES_CPP_NAMESPACE_END
  180. #endif