http://xml.apache.org/http://www.apache.org/http://www.w3.org/

Home

Readme
Installation
Build

API Docs
Samples
Programming
Migration
FAQs

Releases
Feedback

PDF Document

Download
Dev Snapshots
CVS Repository
Mail Archive

API Docs for SAX and DOM
 

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

RefStackOf.hpp

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


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