/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999-2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache\@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation, and was
* originally based on software copyright (c) 1999, International
* Business Machines, Inc., http://www.ibm.com . For more information
* on the Apache Software Foundation, please see
* .
*/
/*
* $Log: RefStackOf.hpp,v $
* Revision 1.6 2004/01/29 11:48:46 cargilld
* Code cleanup changes to get rid of various compiler diagnostic messages.
*
* Revision 1.5 2003/05/16 06:01:52 knoaman
* Partial implementation of the configurable memory manager.
*
* Revision 1.4 2003/05/15 19:07:45 knoaman
* Partial implementation of the configurable memory manager.
*
* Revision 1.3 2002/11/04 15:22:04 tng
* C++ Namespace Support.
*
* Revision 1.2 2002/08/21 17:45:00 tng
* [Bug 7087] compiler warnings when using gcc.
*
* Revision 1.1.1.1 2002/02/01 22:22:12 peiyongz
* sane_include
*
* Revision 1.4 2000/03/02 19:54:45 roddey
* This checkin includes many changes done while waiting for the
* 1.1.0 code to be finished. I can't list them all here, but a list is
* available elsewhere.
*
* Revision 1.3 2000/02/24 20:05:25 abagchi
* Swat for removing Log from API docs
*
* Revision 1.2 2000/02/06 07:48:03 rahulj
* Year 2K copyright swat.
*
* Revision 1.1.1.1 1999/11/09 01:05:03 twl
* Initial checkin
*
* Revision 1.2 1999/11/08 20:45:13 rahul
* Swat for adding in Product name and CVS comment log variable.
*
*/
#if !defined(REFSTACKOF_HPP)
#define REFSTACKOF_HPP
#include
#include
XERCES_CPP_NAMESPACE_BEGIN
//
// Forward declare the enumerator so he can be our friend. Can you say
// friend? Sure...
//
template class RefStackEnumerator;
template class RefStackOf : public XMemory
{
public :
// -----------------------------------------------------------------------
// Constructors and Destructor
// -----------------------------------------------------------------------
RefStackOf(const unsigned int initElems,
const bool adoptElems = true,
MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
~RefStackOf();
// -----------------------------------------------------------------------
// Element management methods
// -----------------------------------------------------------------------
const TElem* elementAt(const unsigned int index) const;
void push(TElem* const toPush);
const TElem* peek() const;
TElem* pop();
void removeAllElements();
// -----------------------------------------------------------------------
// Getter methods
// -----------------------------------------------------------------------
bool empty();
unsigned int curCapacity();
unsigned int size();
private :
// -----------------------------------------------------------------------
// Declare our friends
// -----------------------------------------------------------------------
friend class RefStackEnumerator;
// -----------------------------------------------------------------------
// Unimplemented constructors and operators
// -----------------------------------------------------------------------
RefStackOf(const RefStackOf&);
RefStackOf& operator=(const RefStackOf&);
// -----------------------------------------------------------------------
// Data Members
//
// fVector
// The vector that is used as the backing data structure for the
// stack.
// -----------------------------------------------------------------------
RefVectorOf fVector;
};
//
// An enumerator for a value stack. It derives from the basic enumerator
// class, so that value stacks can be generically enumerated.
//
template class RefStackEnumerator : public XMLEnumerator, public XMemory
{
public :
// -----------------------------------------------------------------------
// Constructors and Destructor
// -----------------------------------------------------------------------
RefStackEnumerator
(
RefStackOf* const toEnum
, const bool adopt = false
);
virtual ~RefStackEnumerator();
// -----------------------------------------------------------------------
// Enum interface
// -----------------------------------------------------------------------
bool hasMoreElements() const;
TElem& nextElement();
void Reset();
private :
// -----------------------------------------------------------------------
// Unimplemented constructors and operators
// -----------------------------------------------------------------------
RefStackEnumerator(const RefStackEnumerator&);
RefStackEnumerator& operator=(const RefStackEnumerator&);
// -----------------------------------------------------------------------
// Data Members
//
// fAdopted
// Indicates whether we have adopted the passed stack. If so then
// we delete the stack when we are destroyed.
//
// fCurIndex
// This is the current index into the vector inside the stack being
// enumerated.
//
// fToEnum
// The stack that is being enumerated. This is just kept for
// adoption purposes, since we really are enumerating the vector
// inside of it.
// -----------------------------------------------------------------------
bool fAdopted;
unsigned int fCurIndex;
RefVectorOf* fVector;
RefStackOf* fToEnum;
};
XERCES_CPP_NAMESPACE_END
#if !defined(XERCES_TMPLSINC)
#include
#endif
#endif