MemBufFormatTarget.hpp Source File

| API Docs for SAX and DOM |

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

# MemBufFormatTarget.hpp

Go to the documentation of this file.

    00001 /*
    00002  * The Apache Software License, Version 1.1
    00003  *
    00004  * Copyright (c) 1999-2002 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  * $Id: MemBufFormatTarget.hpp,v 1.7 2003/05/16 21:36:55 knoaman Exp $
    00059  * $Log: MemBufFormatTarget.hpp,v $
    00060  * Revision 1.7  2003/05/16 21:36:55  knoaman
    00061  * Memory manager implementation: Modify constructors to pass in the memory manager.
    00062  *
    00063  * Revision 1.6  2003/05/15 18:26:07  knoaman
    00064  * Partial implementation of the configurable memory manager.
    00065  *
    00066  * Revision 1.5  2002/11/04 15:00:21  tng
    00067  * C++ Namespace Support.
    00068  *
    00069  * Revision 1.4  2002/08/12 21:38:22  peiyongz
    00070  * Bug#11462: MemBufFormatTarget issue(2) .., proposed patch from
    00071  *                      Esmond Pitt (pitte@anz.com)
    00072  *
    00073  * Revision 1.3  2002/07/22 23:23:15  tng
    00074  * DOM L3: MemBufFormatTarget stores fDataBuf as XMLByte directly, consistent design as MemBufInputSource
    00075  *
    00076  * Revision 1.2  2002/06/05 15:47:13  peiyongz
    00077  * data member changed, reset() added.
    00078  *
    00079  * Revision 1.1  2002/05/28 22:40:46  peiyongz
    00080  * DOM3 Save Interface: DOMWriter/DOMWriterFilter
    00081  *
    00082  */
    00083
    00084 #ifndef MemBufFormatTarget_HEADER_GUARD_
    00085 #define MemBufFormatTarget_HEADER_GUARD_
    00086
    00087 #include <xercesc/framework/XMLFormatter.hpp>
    00088
    00089 XERCES_CPP_NAMESPACE_BEGIN
    00090
    00091 /*
    00092  * The MemBufFormatTarget is a derivative from XMLFormatTarget, which user code
    00093  * may plug into DOMWriter to retrieve the serialized XML stream (from DOM Tree)
    00094  * in a memory buffer.
    00095  *
    00096  * The MemBufFormatTarget is initalized to have a memory buffer of 1023 upon
    00097  * construction, which grows as needed. The buffer will be deleted when
    00098  * MemBufFormatTarget is destructed; or will be reset when the reset() function
    00099  * is called.
    00100  *
    00101  * The MemBufFormatTarget returns a NULL terminated XMLByte stream upon request,
    00102  * through the method getRawBuffer(), and user should make its own copy of the
    00103  * returned buffer if it intends to keep it independent on the state of the
    00104  * MemBufFormatTarget.
    00105  */
    00106
    00107 class  MemBufFormatTarget : public XMLFormatTarget {
    00108 public:
    00109
    00112     MemBufFormatTarget
    00113     (
    00114           int                  initCapacity = 1023
    00115         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
    00116     ) ;
    00117     ~MemBufFormatTarget();
    00119
    00120     // -----------------------------------------------------------------------
    00121     //  Implementations of the format target interface
    00122     // -----------------------------------------------------------------------
    00123     virtual void writeChars(const XMLByte* const toWrite
    00124                           , const unsigned int   count
    00125                           , XMLFormatter* const  formatter);
    00126
    00127     // -----------------------------------------------------------------------
    00128     //  Getter
    00129     // -----------------------------------------------------------------------
    00137     const XMLByte* getRawBuffer() const;
    00138
    00146     unsigned int getLen() const
    00147     {
    00148         return fIndex;
    00149     }
    00150
    00157     void reset();
    00159
    00160 private:
    00161     // -----------------------------------------------------------------------
    00162     //  Unimplemented methods.
    00163     // -----------------------------------------------------------------------
    00164     MemBufFormatTarget(const MemBufFormatTarget&);
    00165     MemBufFormatTarget& operator=(const MemBufFormatTarget&);
    00166
    00167     // -----------------------------------------------------------------------
    00168     //  Private helpers
    00169     // -----------------------------------------------------------------------
    00170     void insureCapacity(const unsigned int extraNeeded);
    00171
    00172     // -----------------------------------------------------------------------
    00173     //  Private data members
    00174     //
    00175     //  fDataBuf
    00176     //      The pointer to the buffer data. Its grown as needed. Its always
    00177     //      one larger than fCapacity, to leave room for the null terminator.
    00178     //
    00179     //  fIndex
    00180     //      The current index into the buffer, as characters are appended
    00181     //      to it. If its zero, then the buffer is empty.
    00182     //
    00183     //  fCapacity
    00184     //      The current capacity of the buffer. Its actually always one
    00185     //      larger, to leave room for the null terminator.
    00186     //
    00187     // -----------------------------------------------------------------------
    00188     MemoryManager*  fMemoryManager;
    00189     XMLByte*        fDataBuf;
    00190     unsigned int    fIndex;
    00191     unsigned int    fCapacity;
    00192
    00193 };
    00194
    00195 XERCES_CPP_NAMESPACE_END
    00196
    00197 #endif
    00198

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