vmstack.h

TOOL (Tiny Object Oriented Language) is an easily-embedded, object-oriented, C++-like-language inter

#ifndef STACK_H_INCLUDED
#define STACK_H_INCLUDED
/*****************************************************************************/
/*                              HEADER FILE                                  */
/*****************************************************************************/
/*
       $Archive:   $

      $Revision:   $
          $Date:   $
        $Author:   $

    Description:   Declaration of the class for a dynamic stack of VMVariant
                   elements

                      TOOL And XML FORMS License
                      ==========================

                      Except where otherwise noted, all of the documentation 
                      and software included in the TOOL package is 
                      copyrighted by Michael Swartzendruber.

                      Copyright (C) 2005 Michael John Swartzendruber. 
                      All rights reserved.

                      Access to this code, whether intentional or accidental,
                      does NOT IMPLY any transfer of rights.

                      This software is provided "as-is," without any express 
                      or implied warranty. In no event shall the author be held
                      liable for any damages arising from the use of this software.

                      Permission is granted to anyone to use this software for 
                      any purpose, including commercial applications, and to 
                      alter and redistribute it, provided that the following 
                      conditions are met:

                      1. All redistributions of source code files must retain 
                         all copyright notices that are currently in place, 
                         and this list of conditions without modification.

                      2. The origin of this software must not be misrepresented;
                         you must not claim that you wrote the original software.

                      3. If you use this software in another product, an acknowledgment
                         in the product documentation would be appreciated but is
                         not required.

                      4. Modified versions in source or binary form must be plainly 
                         marked as such, and must not be misrepresented as being 
                         the original software.
*/
/*****************************************************************************/


#include "../VMCoreGlobal.h"


// error string
//
#define ALLOCATION_ERROR   "Can Not Allocate Memory."
#define STACK_EMPTY_ERROR  "Caller Error. Stack Is Empty."

class VMDataStack
{
public:
  VMDataStack( void );
  VMDataStack( VMDataStack& roOther );
  ~VMDataStack( void );

  void operator =( VMDataStack& roOther );

  void  Push( VMVariant& roItem );
  bool  Pop( VMVariant& roOutput );
  bool  PeekTop( VMVariant& roOutput );

  void   Clear( void );
  size_t GetCount( void );

  void DeepCopy( VMDataStack& roOther ); 

protected:
  struct NODE
  {
    VMVariant  m_oData;
    NODE*      m_pxNext;

    NODE::NODE( void ){;};
    NODE::~NODE( void ){;};
  };
  #define PNODE NODE*

  PNODE  m_pxHead;
  size_t m_xCount;
};


#endif


/*****************************************************************************/
/* Check-in history */
/*
 *$Log:  $
*/
/*****************************************************************************/