ExpressionStack.cpp

Go to the documentation of this file.

/*----------------------------------------------------------------------------*/
/*                                                                            */
/* Copyright (c) 1995, 2004 IBM Corporation. All rights reserved.             */
/* Copyright (c) 2005-2009 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:           */
/* http://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                                                                */
/*                                                                            */
/* Primitive Expression Stack Class                                           */
/*                                                                            */
/******************************************************************************/
#include <stdlib.h>
#include "RexxCore.h"
#include "StringClass.hpp"
#include "ExpressionStack.hpp"
#include "ActivityManager.hpp"
 
void RexxExpressionStack::live(size_t liveMark)
/******************************************************************************/
/* Function:  Normal garbage collection live marking                          */
/******************************************************************************/
{
   RexxObject **entry;                 /* marked stack entry                */
 
                                       /* loop through the stack entries    */
   for (entry = this->stack; entry <= this->top; entry++)
   {
       memory_mark(*entry);              /* marking each one                  */
   }
}
 
void RexxExpressionStack::liveGeneral(int reason)
/******************************************************************************/
/* Function:  Generalized object marking                                      */
/******************************************************************************/
{
   RexxObject **entry;                 /* marked stack entry                */
 
   for (entry = this->stack; entry <= this->top; entry++)
   {
       memory_mark_general(*entry);      /* marking each one                  */
   }
}
 
void RexxExpressionStack::flatten(RexxEnvelope * envelope)
/******************************************************************************/
/* Function:  Flatten an object                                               */
/******************************************************************************/
{
    setUpFlatten(RexxExpressionStack)
 
    size_t i;                            /* pointer for scanning stack entries*/
    size_t count;                        /* number of elements                */
 
    count = this->top - this->stack;     /* get the total count               */
                                         /* loop through the stack entries    */
    for (i = 0; i < count; i++)
    {
        flatten_reference(newThis->stack[i], envelope);
    }
 
    cleanUpFlatten
}
 
void RexxExpressionStack::migrate(RexxActivity *activity)
/******************************************************************************/
/* Function:  Migrate the expression stack to a new activity                  */
/******************************************************************************/
{
    RexxObject **oldFrame = stack;
    /* allocate a new frame */
    activity->allocateStackFrame(this, size);
    /* copy the enties over to the new stack. */
    memcpy(stack, oldFrame, sizeof(RexxObject *) * size);
}
 
void RexxExpressionStack::expandArgs(
     size_t argcount,                  /* count of arguments                */
     size_t min,                       /* minimum required arguments        */
     size_t max,                       /* maximum required arguments        */
     const char *function )            /* function being processed          */
/******************************************************************************/
/* Function:  Verify that a function has received all of its required         */
/*            arguments, and did not receive extras.                          */
/******************************************************************************/
{
    size_t       i;                      /* loop counter                      */
    size_t       j;
    RexxObject **current;                /* pointer to the current stack item */
 
    if (argcount < min)                  /* too few arguments?                */
    {
                                         /* report an error                   */
        reportException(Error_Incorrect_call_minarg, function, min);
    }
    else if (argcount > max)             /* too many arguments?               */
    {
                                         /* report an error                   */
        reportException(Error_Incorrect_call_maxarg, function, max);
    }
    else                               /* need to expand number of args     */
    {
        /* address the stack elements        */
        current = this->pointer(argcount - 1);
        for (i = min; i; i--)            /* check on required arguments       */
        {
            if (*current++ == OREF_NULL)   /* omitted argument?                 */
            {
                j = min - i + 1;               /* argument location                 */
                                               /* missing required argument         */
                reportException(Error_Incorrect_call_noarg, function, j);
            }
        }
    }
}
 
RexxString *RexxExpressionStack::requiredStringArg(
    size_t position)                   /* position of argument              */
/******************************************************************************/
/* Function:  Retrieve an object from the expression stack and potentially    */
/*            convert it into a string argument.                              */
/******************************************************************************/
{
    RexxObject *argument = this->peek(position);     /* get the argument in question      */
    if (isOfClass(String, argument))         /* string object already?            */
    {
        return(RexxString *)argument;     /* finished                          */
    }
                                          /* get the string form, raising a    */
                                          /* NOSTRING condition if necessary   */
    RexxString *newStr = argument->requestString();
    this->replace(position, newStr);     /* replace the argument              */
    return newStr;                       /* return the replacement value      */
}
 
RexxString *RexxExpressionStack::optionalStringArg(
    size_t  position)                   /* position of argument              */
/******************************************************************************/
/* Function:  Retrieve an object from the expression stack and potentially    */
/*            convert it into a string argument.                              */
/******************************************************************************/
{
    RexxObject *argument = this->peek(position);     /* get the argument in question      */
    if (argument == OREF_NULL)           /* missing a required argument?      */
    {
        return OREF_NULL;                  /* finished already                  */
    }
    if (isOfClass(String, argument))     /* string object already?            */
    {
        return(RexxString *)argument;     /* finished                          */
    }
                                          /* get the string form, raising a    */
                                          /* NOSTRING condition if necessary   */
    RexxString *newStr = argument->requestString();
    this->replace(position, newStr);     /* replace the argument              */
    return newStr;                       /* return the replacement value      */
}
 
RexxInteger *RexxExpressionStack::requiredIntegerArg(
     size_t position,                  /* position of argument              */
     size_t argcount,                  /* count of arguments                */
     const char *function)             /* function being processed          */
/******************************************************************************/
/* Function:  Retrieve an object from the expression stack and potentially    */
/*            convert it into an integer argument.                            */
/******************************************************************************/
{
 
    RexxObject *argument = this->peek(position);     /* get the argument in question      */
    if (isOfClass(Integer, argument))    /* integer object already?           */
    {
        return(RexxInteger *)argument;    /* finished                          */
    }
    /* return the string form of argument*/
    wholenumber_t numberValue;           /* converted long value              */
    if (!argument->requestNumber(numberValue, Numerics::ARGUMENT_DIGITS))
    {
        /* report an exception               */
        reportException(Error_Incorrect_call_whole, function, argcount - position, argument);
    }
    RexxInteger *newInt = new_integer(numberValue);   /* create an integer object          */
    this->replace(position, newInt);     /* replace the argument              */
    return newInt;                       /* return the replacement value      */
}
 
 
RexxInteger *RexxExpressionStack::optionalIntegerArg(
     size_t position,                  /* position of argument              */
     size_t argcount,                  /* count of arguments                */
     const char *function)             /* function being processed          */
/******************************************************************************/
/* Function:  Retrieve an object from the expression stack and potentially    */
/*            convert it into an integer argument.                            */
/******************************************************************************/
{
    RexxObject *argument = this->peek(position);     /* get the argument in question      */
    if (argument == OREF_NULL)           /* missing an optional argument?     */
    {
        return OREF_NULL;                  /* nothing there                     */
    }
    if (isOfClass(Integer, argument))    /* integer object already?           */
    {
        return(RexxInteger *)argument;    /* finished                          */
    }
    /* return the string form of argument*/
    wholenumber_t numberValue;           /* converted long value              */
    if (!argument->requestNumber(numberValue, Numerics::ARGUMENT_DIGITS))
    {
        /* report an exception               */
        reportException(Error_Incorrect_call_whole, function, argcount - position, argument);
    }
    RexxInteger *newInt = new_integer(numberValue);   /* create an integer object          */
    this->replace(position, newInt);     /* replace the argument              */
    return newInt;                       /* return the replacement value      */
}
 
 
RexxObject *RexxExpressionStack::requiredBigIntegerArg(size_t position, size_t argcount, const char *function)
{
 
    RexxObject *argument = this->peek(position);     /* get the argument in question      */
    // get this in the form of an object that is valid as a 64-bit integer, ready to
    // be passed along as an argument to native code.
    RexxObject *newArgument = Numerics::int64Object(argument);
    // returns a null value if it doesn't convert properly
    if (newArgument == OREF_NULL)
    {
        /* report an exception               */
        reportException(Error_Incorrect_call_whole, function, argcount - position, argument);
    }
    this->replace(position, newArgument);   /* replace the argument              */
    return newArgument;
}
 
 
RexxObject *RexxExpressionStack::optionalBigIntegerArg(size_t position, size_t argcount, const char *function)
{
    RexxObject *argument = this->peek(position);     /* get the argument in question      */
    if (argument == OREF_NULL)           /* missing an optional argument?     */
    {
        return OREF_NULL;                  /* nothing there                     */
    }
    // get this in the form of an object that is valid as a 64-bit integer, ready to
    // be passed along as an argument to native code.
    RexxObject *newArgument = Numerics::int64Object(argument);
    // returns a null value if it doesn't convert properly
    if (newArgument == OREF_NULL)
    {
        /* report an exception               */
        reportException(Error_Incorrect_call_whole, function, argcount - position, argument);
    }
    this->replace(position, newArgument);   /* replace the argument              */
    return newArgument;
}