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: RefStackOf.hpp,v $ 00059 * Revision 1.1 2002/05/11 21:09:29 bhavani 00060 * CR#CR062582# adding xercesc 1.7 file 00061 * 00062 * Revision 1.1.1.1 2002/02/01 22:22:12 peiyongz 00063 * sane_include 00064 * 00065 * Revision 1.4 2000/03/02 19:54:45 roddey 00066 * This checkin includes many changes done while waiting for the 00067 * 1.1.0 code to be finished. I can't list them all here, but a list is 00068 * available elsewhere. 00069 * 00070 * Revision 1.3 2000/02/24 20:05:25 abagchi 00071 * Swat for removing Log from API docs 00072 * 00073 * Revision 1.2 2000/02/06 07:48:03 rahulj 00074 * Year 2K copyright swat. 00075 * 00076 * Revision 1.1.1.1 1999/11/09 01:05:03 twl 00077 * Initial checkin 00078 * 00079 * Revision 1.2 1999/11/08 20:45:13 rahul 00080 * Swat for adding in Product name and CVS comment log variable. 00081 * 00082 */ 00083 00084 #if !defined(REFSTACKOF_HPP) 00085 #define REFSTACKOF_HPP 00086 00087 00088 #include <xercesc/util/XercesDefs.hpp> 00089 #include <xercesc/util/ArrayIndexOutOfBoundsException.hpp> 00090 #include <xercesc/util/EmptyStackException.hpp> 00091 #include <xercesc/util/RefVectorOf.hpp> 00092 #include <xercesc/util/XMLEnumerator.hpp> 00093 00094 00095 // 00096 // Forward declare the enumerator so he can be our friend. Can you say 00097 // friend? Sure... 00098 // 00099 template <class TElem> class RefStackEnumerator; 00100 00101 00102 template <class TElem> class RefStackOf 00103 { 00104 public : 00105 // ----------------------------------------------------------------------- 00106 // Constructors and Destructor 00107 // ----------------------------------------------------------------------- 00108 RefStackOf(const unsigned int initElems, const bool adoptElems = true); 00109 ~RefStackOf(); 00110 00111 00112 // ----------------------------------------------------------------------- 00113 // Element management methods 00114 // ----------------------------------------------------------------------- 00115 const TElem* elementAt(const unsigned int index) const; 00116 void push(TElem* const toPush); 00117 const TElem* peek() const; 00118 TElem* pop(); 00119 void removeAllElements(); 00120 00121 00122 // ----------------------------------------------------------------------- 00123 // Getter methods 00124 // ----------------------------------------------------------------------- 00125 bool empty(); 00126 unsigned int curCapacity(); 00127 unsigned int size(); 00128 00129 00130 private : 00131 // ----------------------------------------------------------------------- 00132 // Declare our friends 00133 // ----------------------------------------------------------------------- 00134 friend class RefStackEnumerator<TElem>; 00135 00136 00137 // ----------------------------------------------------------------------- 00138 // Data Members 00139 // 00140 // fVector 00141 // The vector that is used as the backing data structure for the 00142 // stack. 00143 // ----------------------------------------------------------------------- 00144 RefVectorOf<TElem> fVector; 00145 }; 00146 00147 00148 00149 // 00150 // An enumerator for a value stack. It derives from the basic enumerator 00151 // class, so that value stacks can be generically enumerated. 00152 // 00153 template <class TElem> class RefStackEnumerator : public XMLEnumerator<TElem> 00154 { 00155 public : 00156 // ----------------------------------------------------------------------- 00157 // Constructors and Destructor 00158 // ----------------------------------------------------------------------- 00159 RefStackEnumerator 00160 ( 00161 RefStackOf<TElem>* const toEnum 00162 , const bool adopt = false 00163 ); 00164 ~RefStackEnumerator(); 00165 00166 00167 // ----------------------------------------------------------------------- 00168 // Enum interface 00169 // ----------------------------------------------------------------------- 00170 bool hasMoreElements() const; 00171 TElem& nextElement(); 00172 void Reset(); 00173 00174 00175 private : 00176 // ----------------------------------------------------------------------- 00177 // Data Members 00178 // 00179 // fAdopted 00180 // Indicates whether we have adopted the passed stack. If so then 00181 // we delete the stack when we are destroyed. 00182 // 00183 // fCurIndex 00184 // This is the current index into the vector inside the stack being 00185 // enumerated. 00186 // 00187 // fToEnum 00188 // The stack that is being enumerated. This is just kept for 00189 // adoption purposes, since we really are enumerating the vector 00190 // inside of it. 00191 // ----------------------------------------------------------------------- 00192 bool fAdopted; 00193 unsigned int fCurIndex; 00194 RefVectorOf<TElem>* fVector; 00195 RefStackOf<TElem>* fToEnum; 00196 }; 00197 00198 00199 #if !defined(XERCES_TMPLSINC) 00200 #include <xercesc/util/RefStackOf.c> 00201 #endif 00202 00203 #endif