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: XMLBuffer.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:22 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:29 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(XMLBUFFER_HPP)
00083 #define XMLBUFFER_HPP
00084
00085 #include <util/XercesDefs.hpp>
00086
00097 class XMLBuffer
00098 {
00099 public :
00100 // -----------------------------------------------------------------------
00101 // Constructors and Destructor
00102 // -----------------------------------------------------------------------
00103
00105 //@{
00106 XMLBuffer() :
00107
00108 fBuffer(0)
00109 , fIndex(0)
00110 , fCapacity(1023)
00111 , fUsed(false)
00112 {
00113 // Buffer is one larger than capacity, to allow for zero term
00114 fBuffer = new XMLCh[fCapacity+1];
00115
00116 // Keep it null terminated
00117 fBuffer[0] = XMLCh(0);
00118 }
00119 //@}
00120
00122 //@{
00123 ~XMLBuffer()
00124 {
00125 delete [] fBuffer;
00126 }
00127 //@}
00128
00129 // -----------------------------------------------------------------------
00130 // Buffer Management
00131 // -----------------------------------------------------------------------
00132 void append(const XMLCh toAppend)
00133 {
00134 if (fIndex == fCapacity)
00135 expand();
00136
00137 // Put in char and bump the index
00138 fBuffer[fIndex++] = toAppend;
00139 }
00140
00141 void append
00142 (
00143 const XMLCh* const chars
00144 , const unsigned int count = 0
00145 );
00146
00147 const XMLCh* getRawBuffer() const
00148 {
00149 fBuffer[fIndex] = 0;
00150 return fBuffer;
00151 }
00152
00153 XMLCh* getRawBuffer()
00154 {
00155 fBuffer[fIndex] = 0;
00156 return fBuffer;
00157 }
00158
00159 void reset()
00160 {
00161 fIndex = 0;
00162 fBuffer[0] = 0;
00163 }
00164
00165 void set
00166 (
00167 const XMLCh* const chars
00168 , const unsigned int count = 0
00169 );
00170
00171
00172 // -----------------------------------------------------------------------
00173 // Getters
00174 // -----------------------------------------------------------------------
00175 bool getInUse()
00176 {
00177 return fUsed;
00178 }
00179
00180 unsigned int getLen() const
00181 {
00182 return fIndex;
00183 }
00184
00185 bool isEmpty()
00186 {
00187 return (fIndex == 0);
00188 }
00189
00190
00191 // -----------------------------------------------------------------------
00192 // Setters
00193 // -----------------------------------------------------------------------
00194 void setInUse(const bool newValue)
00195 {
00196 fUsed = newValue;
00197 }
00198
00199
00200 private :
00201 // -----------------------------------------------------------------------
00202 // Declare our friends
00203 // -----------------------------------------------------------------------
00204 friend class XMLBufBid;
00205
00206
00207 // -----------------------------------------------------------------------
00208 // Private helpers
00209 // -----------------------------------------------------------------------
00210 void expand();
00211 void insureCapacity(const unsigned int extraNeeded);
00212
00213
00214 // -----------------------------------------------------------------------
00215 // Private data members
00216 //
00217 // fBuffer
00218 // The pointer to the buffer data. Its grown as needed. Its always
00219 // one larger than fCapacity, to leave room for the null terminator.
00220 //
00221 // fIndex
00222 // The current index into the buffer, as characters are appended
00223 // to it. If its zero, then the buffer is empty.
00224 //
00225 // fCapacity
00226 // The current capacity of the buffer. Its actually always one
00227 // larger, to leave room for the null terminator.
00228 //
00229 // fUsed
00230 // Indicates whether this buffer is in use or not.
00231 // -----------------------------------------------------------------------
00232 XMLCh* fBuffer;
00233 unsigned int fIndex;
00234 unsigned int fCapacity;
00235 bool fUsed;
00236 };
00237
00238 #endif