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

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