/*----------------------------------------------------------------------------*/
/*                                                                            */
/* Copyright (c) 1995, 2004 IBM Corporation. All rights reserved.             */
/* Copyright (c) 2005-2014 Rexx Language Association. All rights reserved.    */
/*                                                                            */
/* This program and the accompanying materials are made available under       */
/* the terms of the Common Public License v1.0 which accompanies this         */
/* distribution. A copy is also available at the following address:           */
/* https://www.oorexx.org/license.html                                        */
/*                                                                            */
/* 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 Rexx Language Association 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 THE COPYRIGHT   */
/* OWNER OR 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.               */
/*                                                                            */
/*----------------------------------------------------------------------------*/
/******************************************************************************/
/* REXX Kernel                                           ExpressionStack.hpp  */
/*                                                                            */
/* Primitive Expression Stack Class Definitions                               */
/*                                                                            */
/******************************************************************************/

#ifndef Included_ExpressionStack
#define Included_ExpressionStack

#include "ArrayClass.hpp"

class ProtectedObject;
class Activity;

/**
 * Evaluation stack used for storing expression results during
 * execution.
 */
class ExpressionStack
{
 public:
    ExpressionStack(RexxInternalObject **frames, size_t items) { stack = frames; size = items; top = stack; }
    ExpressionStack() { stack = OREF_NULL; size = 0; top = stack; }

    void live(size_t);
    void liveGeneral(MarkReason reason);

    void         expandArgs(size_t, size_t, size_t, const char *);
    RexxString * requiredStringArg(size_t);
    RexxString * optionalStringArg(size_t);
    RexxInteger *requiredIntegerArg(size_t, size_t, const char *);
    RexxInteger *optionalIntegerArg(size_t, size_t, const char *);
    RexxObject * requiredBigIntegerArg(size_t, size_t, const char *);
    RexxObject * optionalBigIntegerArg(size_t, size_t, const char *);
    void         migrate(Activity *);

    inline void setFrame(RexxInternalObject **frames, size_t items) { stack = frames; size = items; top = stack; *top = OREF_NULL; }

    inline void send(RexxString *message, RexxClass *scope, size_t count, ProtectedObject &result) {
                   ((RexxObject *)(*(top - count)))->messageSend(message, arguments(count), count, scope, result); };
    inline void send(RexxString *message, size_t count, ProtectedObject &result) {
                   ((RexxObject *)(*(top - count)))->messageSend(message, arguments(count), count, result); };
    inline void         push(RexxInternalObject *value) { *(++top) = value; };
    inline RexxInternalObject  *pop() { return *(top--); };
    inline ArrayClass  *argumentArray(size_t count) { return new_array(count, (RexxInternalObject **)(top - (count - 1))); };
    inline RexxObject **arguments(size_t count) { return (RexxObject **)(top - (count - 1)); };
    inline void         replace(size_t offset, RexxObject *value) { *(top - offset) = value; };
    inline size_t       getSize() {return size;};
    inline RexxInternalObject * getTop()  {return *(top);};
    inline void         operatorResult(RexxObject *value) { *(--top) = value; };
    inline void         prefixResult(RexxObject *value)   { *(top) = value; };
    inline void         popn(size_t c) {top -= c;};
    inline void         clear() {top = stack;};
    inline RexxInternalObject * peek(size_t v) {return *(top - v);};
    inline RexxInternalObject **pointer(size_t v) {return (top - v); };
    inline size_t       location() {return top - stack;};
    inline void         setTop(size_t v) {top = stack + v;};
    inline void         toss() { top--; };
    inline RexxInternalObject **getFrame() { return stack; }

protected:

    size_t size;                         // size of the expstack
    RexxInternalObject **top;            // current expstack top location
    RexxInternalObject **stack;          // actual stack values

};
#endif