/*----------------------------------------------------------------------------*/
/*                                                                            */
/* 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                                                    Clause.hpp  */
/*                                                                            */
/* Primitive Translator Clause Class Definitions                              */
/*                                                                            */
/******************************************************************************/
#ifndef Included_RexxClause
#define Included_RexxClause

#include "SourceLocation.hpp"

#include "ArrayClass.hpp"
#include "Token.hpp"

class RexxClause : public RexxInternalObject
{
 public:
    void        *operator new(size_t);
    inline void  operator delete(void *) { ; }

    RexxClause();
    inline RexxClause(RESTORETYPE restoreType) { ; };

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

    void        setStart(size_t, size_t);
    void        setEnd(size_t, size_t);
    void        trim();
    void        newClause();
    RexxToken  *newToken(TokenClass, TokenSubclass, RexxString *, SourceLocation &);
    inline RexxToken  *newToken(TokenClass c, TokenSubclass sc, SourceLocation &l) { return newToken(c, sc, OREF_NULL, l); }
    inline RexxToken  *newToken(TokenClass c, SourceLocation &l) { return newToken(c, SUBTYPE_NONE, OREF_NULL, l); }
    RexxToken  *nextRealToken();
    inline void        firstToken() {current = first;};
    inline const SourceLocation &getLocation() { return clauseLocation; }
    inline void  setLocation(const SourceLocation &l) { clauseLocation = l; }
    inline void        previous() { current--; }
    inline RexxToken  *next() { return (RexxToken *)tokens->get(current++); }
    inline size_t      mark() { return current; }
    inline void        reset(size_t position) { current = position; }

 protected:

    static const size_t INITIAL_SIZE = 100;   // initial allocation size
    static const size_t EXTEND_SIZE = 25;     // how much we extend the clause by when we run out of tokens.

    SourceLocation clauseLocation;       // position of the clause
    size_t current;                      // index of current token of clause
    size_t first;                        // first token of clause
    ArrayClass  *tokens;                 // array of tokens in the clause
    size_t size;                         // size of token array
    size_t free;                         // location of first free token
};
#endif
