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  

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


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