/*----------------------------------------------------------------------------*/
/*                                                                            */
/* 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:           */
/* 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                                           RaiseInstruction.hpp */
/*                                                                            */
/* Primitive RAISE instruction Class Definitions                              */
/*                                                                            */
/******************************************************************************/
#ifndef Included_RexxInstructionRaise
#define Included_RexxInstructionRaise

#include "RexxInstruction.hpp"
#include "FlagSet.hpp"

// flags to control the execution of a RAISE instruction
typedef enum
{
    raise_return,
    raise_exit,
    raise_array,
    raise_syntax,
    raise_propagate
} RaiseInstructionFlags;

class RexxInstructionRaise : public RexxInstruction
{
 public:
    inline RexxInstructionRaise(RESTORETYPE restoreType) { ; };
    RexxInstructionRaise(RexxString *_condition, RexxInternalObject *_expression, RexxInternalObject *_description,
        RexxInternalObject *_additional, RexxInternalObject *_result, FlagSet<RaiseInstructionFlags, 32> flags);

    void live(size_t) override;
    void liveGeneral(MarkReason reason) override;
    void flatten(Envelope*) override;

    void execute(RexxActivation *, ExpressionStack *) override;

 protected:

    FlagSet<RaiseInstructionFlags, 32>  instructionFlags;   // instruction control flags
    RexxInternalObject *rcValue;         // RC value expression
    RexxString *conditionName;           // condition trap name
    RexxInternalObject *description;     // condition description
    RexxInternalObject *resultValue;     // condition result
    size_t      arrayCount;              // count of additional items
    RexxInternalObject *additional[1];   // additional specified information
};
#endif