plonk_SimpleStack.h

/*
 -------------------------------------------------------------------------------
 This file is part of the Plink, Plonk, Plank libraries
  by Martin Robinson
 
 http://code.google.com/p/pl-nk/
 
 Copyright University of the West of England, Bristol 2011-14
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
 * Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
 * 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.
 * Neither the name of University of the West of England, Bristol nor 
   the names of its contributors may be used to endorse or promote products
   derived from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS 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 UNIVERSITY OF THE WEST OF ENGLAND, BRISTOL 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 makes use of third party libraries. For more information see:
 doc/license.txt included in the distribution.
 -------------------------------------------------------------------------------
 */

#ifndef PLONK_SIMPLESTACK_H
#define PLONK_SIMPLESTACK_H

#include "../core/plonk_CoreForwardDeclarations.h"
#include "plonk_ContainerForwardDeclarations.h"

#include "../core/plonk_SmartPointer.h"
#include "../core/plonk_WeakPointer.h"

template<class ValueType>                                               
class SimpleStackInternal : public SmartPointer
{
public:
    typedef SimpleStack<ValueType>        StackType;

    SimpleStackInternal() throw()
    {
        pl_SimpleStack_Init (&stack);
        pl_SimpleStack_SetFreeElementDataFunction (&stack, SimpleStackInternal::freeElement);
    }
    
    ~SimpleStackInternal()
    {
        ResultCode result;
        
        result = pl_SimpleStack_Clear (&stack);
        plonk_assert (result == PlankResult_OK);

        result = pl_SimpleStack_DeInit (&stack);
        plonk_assert (result == PlankResult_OK);
        
#ifndef PLONK_DEBUG
        (void)result;
#endif
    }
    
    void push (ValueType const& value) throw()
    {
        PlankSimpleStackElementRef element = pl_SimpleStackElement_CreateAndInit();
        plonk_assert (element != 0);
        pl_SimpleStackElement_SetData (element, new ValueType (value));
        ResultCode result = pl_SimpleStack_Push (&stack, element);
        plonk_assert (result == PlankResult_OK);
#ifndef PLONK_DEBUG
        (void)result;
#endif
    }
    
    ValueType pop() throw()
    {
        ValueType returnValue;
        
        PlankSimpleStackElementRef element;
        ResultCode result = pl_SimpleStack_Pop (&stack, &element);
        plonk_assert (result == PlankResult_OK);

        if (element != 0)
        {
            ValueType* valuePtr = static_cast <ValueType*> (pl_SimpleStackElement_GetData (element));
            
            if (valuePtr != 0)
            {
                returnValue = *valuePtr;
                delete valuePtr;
            }
            
            result = pl_SimpleStackElement_Destroy (element);
            plonk_assert (result == PlankResult_OK);
        }
        
#ifndef PLONK_DEBUG
        (void)result;
#endif
        
        return returnValue;
    }
    
    inline LongLong length() throw()
    {
        return pl_SimpleStack_GetSize (&stack);
    }
    
    friend class SimpleStack<ValueType>;
    
private:
    PlankSimpleStack stack;
    
    static ResultCode freeElement (Pointer data)
    {
        delete static_cast<ValueType*> (data);
        return PlankResult_OK;
    }
};


template<class ValueType>                                               
class SimpleStackInternal<ValueType*> : public SmartPointer
{
public:
    typedef SimpleStack<ValueType*>        StackType;
    
    SimpleStackInternal() throw()
    {
        pl_SimpleStack_Init (&stack);
    }
    
    ~SimpleStackInternal()
    {
        plonk_assert (pl_SimpleStack_GetSize (&stack) == 0); // pointers were left in the stack
        pl_SimpleStack_Clear (&stack);
        pl_SimpleStack_DeInit (&stack);        
    }
        
    void push (ValueType* const value) throw()
    {
        PlankSimpleStackElementRef element = pl_SimpleStackElement_CreateAndInit();
        plonk_assert (element != 0);
        pl_SimpleStackElement_SetData (element, value);
        ResultCode result = pl_SimpleStack_Push (&stack, element);
        plonk_assert (result == PlankResult_OK);
#ifndef PLONK_DEBUG
        (void)result;
#endif
    }
    
    ValueType* pop() throw()
    {
        ValueType* returnValue;
        
        PlankSimpleStackElementRef element;
        ResultCode result = pl_SimpleStack_Pop (&stack, &element);
        plonk_assert (result == PlankResult_OK);
        
        if (element != 0)
        {
            returnValue = static_cast <ValueType*> (pl_SimpleStackElement_GetData (element));                        
            result = pl_SimpleStackElement_Destroy (element);
            plonk_assert (result == PlankResult_OK);
        }
        
#ifndef PLONK_DEBUG
        (void)result;
#endif
        
        return returnValue;
    }
    
    inline LongLong length() throw()
    {
        return pl_SimpleStack_GetSize (&stack);
    }
    
    friend class SimpleStack<ValueType*>;
    
private:
    PlankSimpleStack stack;
};



//------------------------------------------------------------------------------

template<class ValueType>                                               
class SimpleStack : public SmartPointerContainer<SimpleStackInternal<ValueType> >
{
public:
    typedef SimpleStackInternal<ValueType>    Internal;
    typedef SmartPointerContainer<Internal>   Base;
    typedef WeakPointerContainer<SimpleStack> Weak;    

    SimpleStack()
    :   Base (new Internal())
    {
    }
    
    explicit SimpleStack (Internal* internalToUse) throw() 
        :       Base (internalToUse)
        {
        } 
    
    static SimpleStack fromWeak (Weak const& weak) throw()
    {
        return weak.fromWeak();
    }    
    
    SimpleStack (SimpleStack const& copy) throw()
    :   Base (static_cast<Base const&> (copy))
    {
    }
    
    SimpleStack (Dynamic const& other) throw()
    :   Base (other.as<SimpleStack>().getInternal())
    {
    }    
    
    SimpleStack& operator= (SimpleStack const& other) throw()
        {
                if (this != &other)
            this->setInternal (other.getInternal());
        
        return *this;
        }
    
    void push (ValueType const& value) throw()
    {
        this->getInternal()->push (value);
    }
    
    ValueType pop() throw()
    {
        return this->getInternal()->pop();
    }
    
    inline LongLong length() throw()
    {
        return this->getInternal()->length();
    }
    
    PLONK_OBJECTARROWOPERATOR(SimpleStack);

};


#endif // PLONK_SIMPLESTACK_H