KEInstruction.h

Go to the documentation of this file.

#ifndef KEINSTRUCTION_H
#define KEINSTRUCTION_H

#include <Coconut/Coconut.h>
#include "KEValue.h"
#include "KERegister.h"

typedef enum {
    KENopOpcode,
    KEFunctionOpcode,
    KECompoundOpcode,
    KEMovLOpcode,
    KEMovPOpcode,
    KEMovHOpcode,
    KEMovROpcode,
    KESetBoolOpcode,
    KESetSignedIntOpcode,
    KESetUnsignedIntOpcode,
    KESetFloatOpcode,
    KESetStringOpcode,
    KELogicalNotOpcode,
    KELogicalAndOpcode,
    KELogicalOrOpcode,
    KELogicalXorOpcode,
    KEBitNotOpcode,
    KEBitAndOpcode,
    KEBitOrOpcode,
    KEBitXorOpcode,
    KEEqualBoolOpcode,
    KEEqualSignedIntOpcode,
    KEEqualUnsignedIntOpcode,
    KEEqualFloatOpcode,
    KEEqualStringOpcode,
    KENotEqualBoolOpcode,
    KENotEqualSignedIntOpcode,
    KENotEqualUnsignedIntOpcode,
    KENotEqualFloatOpcode,
    KENotEqualStringOpcode,
    KELessThanSignedIntOpcode,
    KELessThanUnsignedIntOpcode,
    KELessThanFloatOpcode,
    KELessThanStringOpcode,
    KELessEqualSignedIntOpcode,
    KELessEqualUnsignedIntOpcode,
    KELessEqualFloatOpcode,
    KELessEqualStringOpcode,
    KEGreaterThanSignedIntOpcode,
    KEGreaterThanUnsignedIntOpcode,
    KEGreaterThanFloatOpcode,
    KEGreaterThanStringOpcode,
    KEGreateEqualSignedIntOpcode,
    KEGreateEqualUnsignedIntOpcode,
    KEGreateEqualFloatOpcode,
    KEGreateEqualStringOpcode,
    KENegSignedIntOpcode,
    KENegFloatOpcode,
    KEAddSignedIntOpcode,
    KEAddUnsignedIntOpcode,
    KEAddFloatOpcode,
    KEAddStringOpcode,
    KESubSignedIntOpcode,
    KESubUnsignedIntOpcode,
    KESubFloatOpcode,
    KEMulSignedIntOpcode,
    KEMulUnsignedIntOpcode,
    KEMulFloatOpcode,
    KEDivSignedIntOpcode,
    KEDivUnsignedIntOpcode,
    KEDivFloatOpcode,
    KEModSignedIntOpcode,
    KEModUnsignedIntOpcode,
    KECastItoUOpcode,
    KECastItoFOpcode,
    KECastUtoIOpcode,
    KECastUtoFOpcode,
    KECastFtoIOpcode,
    KECastFtoUOpcode,
    KECreateFuncOpcode,
    KECallFuncOpcode,
    KECallBuiltinOpcode,
    KERootFrameOpcode,
    KECreateFrameOpcode,
    KESetFrameOpcode,
    KEGetFrameOpcode,
    KECreateArrayOpcode,
    KESetArrayOpcode,
    KEGetArrayOpcode,
    KECreateDictionaryOpcode,
    KESetDictionaryOpcode,
    KEGetDictionaryOpcode,
    KEIfThenOpcode,
    KEIfElseOpcode,
    KESwitchOpcode,
    KECaseOpcode,
    KEWhileOpcode,
    KEForeachArrayOpcode,
    KEForeachDictOpcode,
    KEReturnOpcode,
    KENextOpcode,
    KELastOpcode,
    KEExitOpcode
} KEOpcode ;

struct KEInstruction {
    struct CNObject         superClass ;
    KEOpcode            opCode ;
    union {
        struct {
            struct KEInstruction *      compoundInstruction ;
            KERegisterId            maxLocalRegisterId ;
        } functionInstruction ;
        struct {
            struct CNObjectList     instructionList ;
        } compoundInstruction ;
        struct {
            KERegisterId            destinationId ;
            KERegisterId            sourceId ;
        } moveInstruction ;
        struct {
            KERegisterId            destinationId ;
            struct KEValue          constantValue ;
        } setInstruction ;
        struct {
            KERegisterId            destinationId ;
            KERegisterId            sourceId ;
        } unaryInstruction ;
        struct {
            KERegisterId            destinationId ;
            KERegisterId            leftId ;
            KERegisterId            rightId ;
        } binaryInstruction ;
        struct {
            KERegisterId            destinationId ;
            struct KEPath *         path ;
            struct KEValue *        pathValue ;
            struct CNObjectList     hiddenRegisters ;
        } createFunctionInstruction ;
        struct {
            KERegisterId            functionId ;
            struct CNObjectList     returnRegisters ;
            struct CNObjectList     parameterRegisters ;
        } callFunctionInstruction ;
        struct {
            struct KEPath *         path ;
            struct KEValue *        pathValue ;
            struct CNObjectList     returnRegisters ;
            struct CNObjectList     parameterRegisters ;
        } callBuiltinInstruction ;
        struct {
            KERegisterId            destinationId ;
            struct KEFrame *        rootFrame ;
        } rootFrameInstruction ;
        struct {
            KERegisterId            destinationId ;
        } createFrameInstruction ;
        struct {
            KERegisterId            destinationId ;
            struct KEPath *         destinationPath ;
            KERegisterId            sourceId ;
        } setFrameInstruction ;
        struct {
            KERegisterId            destinationId ;
            KERegisterId            sourceId ;
            struct KEPath *         sourcePath ;
        } getFrameInstruction ;
        struct {
            KERegisterId            destinationId ;
        } createArrayInstruction ;
        struct {
            KERegisterId            destinationId ;
            KERegisterId            destinationIndex ;
            KERegisterId            sourceId ;
        } setArrayInstruction ;
        struct {
            KERegisterId            destinationId ;
            KERegisterId            sourceId ;
            KERegisterId            sourceIndex ;
        } getArrayInstruction ;
        struct {
            KERegisterId            destinationId ;
        } createDictionaryInstruction ;
        struct {
            KERegisterId            destinationId ;
            KERegisterId            destinationKey ;
            KERegisterId            sourceId ;
        } setDictionaryInstruction ;
        struct {
            KERegisterId            destinationId ;
            KERegisterId            sourceId ;
            KERegisterId            sourceKey ;
        } getDictionaryInstruction ;
        struct {
            KERegisterId            conditionId ;
            struct KEInstruction *      thenInstruction ;
            struct KEInstruction *      elseInstruction ;
        } ifInstruction ;
        struct {
            KERegisterId            conditionId ;
            struct CNObjectList     caseInstructionList ;
            struct KEInstruction *      defaultInstruction ;
        } switchInstruction ;
        struct {
            CNBoolean           isDefaultCondition ;
            int64_t             caseValue ;
            struct KEInstruction *      caseInstruction ;
        } caseInstruction ;
        struct {
            KERegisterId            conditionId ;
            struct KEInstruction *      bodyInstruction ;
        } whileInstruction ;
        struct {
            KERegisterId            elementId ;
            KERegisterId            arrayId ;
            struct KEInstruction *      bodyInstruction ;
        } foreachArrayInstruction ;
        struct {
            KERegisterId            elementId ;
            KERegisterId            dictionaryId ;
            struct KEInstruction *      bodyInstruction ;
        } foreachDictionaryInstruction ;
        struct {
            KERegisterId            codeId ;
        } exitInstruction ;
    } ; /* No name union */

    struct KELineInfo *     lineInfo ;
} ;

struct KEInstruction *
KEAllocateFunctionInstruction(struct KEInstruction * body,
                  struct KELineInfo * linfo,
                  struct CNResource * resource) ;

struct KEInstruction *
KEAllocateNopInstruction(struct KELineInfo * linfo, struct CNResource * resource) ;

struct KEInstruction *
KEAllocateCompoundInstruction(struct KELineInfo * linfo, struct CNResource * resource) ;

struct KEInstruction *
KEAllocateMovInstruction(KEOpcode opcode,
             KERegisterId dstid,
             KERegisterId srcid,
             struct KELineInfo * linfo,
             struct CNResource * resource) ;

struct KEInstruction *
KEAllocateSetBoolInstruction(KERegisterId dstid,
                 CNBoolean val,
                 struct KELineInfo * linfo,
                 struct CNResource * resource) ;

struct KEInstruction *
KEAllocateSetSignedIntInstruction(KERegisterId dstid,
                  int64_t val,
                  struct KELineInfo * linfo,
                  struct CNResource * resource) ;

struct KEInstruction *
KEAllocateSetUnsignedIntInstruction(KERegisterId dstid,
                    uint64_t val,
                    struct KELineInfo * linfo,
                    struct CNResource * resource) ;

struct KEInstruction *
KEAllocateSetFloatInstruction(KERegisterId dstid,
                  double val,
                  struct KELineInfo * linfo,
                  struct CNResource * resource) ;

struct KEInstruction *
KEAllocateSetStringInstruction(KERegisterId dstid,
                   struct CNString * val,
                   struct KELineInfo * linfo,
                   struct CNResource * resource) ;

struct KEInstruction *
KEAllocateUnaryInstruction(KEOpcode opcode,
               KERegisterId dstid,
               KERegisterId srcid,
               struct KELineInfo * linfo,
               struct CNResource * resource) ;

struct KEInstruction *
KEAllocateBinaryInstruction(KEOpcode opcode,
                KERegisterId dstid,
                KERegisterId leftid,
                KERegisterId rightid,
                struct KELineInfo * linfo,
                struct CNResource * resource) ;

struct KEInstruction *
KEAllocateCreateFunctionInstruction(KERegisterId dstid,
                    struct KEPath * funcpath,
                    struct CNObjectList * hiddenregs,
                    struct KELineInfo * linfo,
                    struct CNResource * resource) ;

struct KEInstruction *
KEAllocateCallFunctionInstruction(KERegisterId funcid,
                  struct CNObjectList * retregs,
                  struct CNObjectList * paramregs,
                  struct KELineInfo * linfo,
                  struct CNResource * resource) ;

struct KEInstruction *
KEAllocateCallBuiltinInstruction(struct KEPath * path,
                 struct CNObjectList * retregs,
                 struct CNObjectList * paramregs,
                 struct KELineInfo * linfo,
                 struct CNResource * resource) ;

struct KEInstruction *
KEAllocateRootFrameInstruction(KERegisterId dstid,
                   struct KELineInfo * linfo,
                   struct CNResource * resource) ;

struct KEInstruction *
KEAllocateCreateFrameInstruction(KERegisterId dstid,
                 struct KELineInfo * linfo,
                 struct CNResource * resource) ;

struct KEInstruction *
KEAllocateSetFrameInstruction(KERegisterId dstid,
                  struct KEPath * dstpath,
                  KERegisterId srcid,
                  struct KELineInfo * linfo,
                  struct CNResource * resource) ;

struct KEInstruction *
KEAllocateGetFrameInstruction(KERegisterId dstid,
                  KERegisterId srcid,
                  struct KEPath * srcpath,
                  struct KELineInfo * linfo,
                  struct CNResource * resource) ;

struct KEInstruction *
KEAllocateCreateArrayInstruction(KERegisterId dstid,
                 struct KELineInfo * linfo,
                 struct CNResource * resource) ;

struct KEInstruction *
KEAllocateSetArrayInstruction(KERegisterId dstid,
                  KERegisterId dstindex,
                  KERegisterId srcid,
                  struct KELineInfo * linfo,
                  struct CNResource * resource) ;

struct KEInstruction *
KEAllocateGetArrayInstruction(KERegisterId dstid,
                  KERegisterId srcid,
                  KERegisterId srcindex,
                  struct KELineInfo * linfo,
                  struct CNResource * resource) ;

struct KEInstruction *
KEAllocateCreateDictionaryInstruction(KERegisterId dstid,
                      struct KELineInfo * linfo,
                      struct CNResource * resource) ;

struct KEInstruction *
KEAllocateSetDictionaryInstruction(KERegisterId dstid,
                   KERegisterId dstkey,
                   KERegisterId srcid,
                   struct KELineInfo * linfo,
                   struct CNResource * resource) ;

struct KEInstruction *
KEAllocateGetDictionaryInstruction(KERegisterId dstid,
                   KERegisterId srcid,
                   KERegisterId srckey,
                   struct KELineInfo * linfo,
                   struct CNResource * resource) ;

struct KEInstruction *
KEAllocateIfInstruction(KERegisterId condid,
            struct KEInstruction * theninst,
            struct KEInstruction * elseinst,
            struct KELineInfo * linfo,
            struct CNResource * resource) ;

struct KEInstruction *
KEAllocateSwitchInstruction(KERegisterId condid,
                struct CNObjectList * caseinsts,
                struct KELineInfo * linfo,
                struct CNResource * resource) ;

struct KEInstruction *
KEAllocateCaseInstruction(CNBoolean isdef,
              uint64_t caseval,
              struct KEInstruction * bodyinst,
              struct KELineInfo * linfo,
              struct CNResource * resource) ;

struct KEInstruction *
KEAllocateWhileInstruction(KERegisterId condid,
               struct KEInstruction * bodyinst,
               struct KELineInfo * linfo,
               struct CNResource * resource) ;

struct KEInstruction *
KEAllocateForeachArrayInstruction(KERegisterId elmid,
                  KERegisterId arrayid,
                  struct KEInstruction * bodyinst,
                  struct KELineInfo * linfo,
                  struct CNResource * resource) ;

struct KEInstruction *
KEAllocateForeachDictionaryInstruction(KERegisterId elmid,
                       KERegisterId dictid,
                       struct KEInstruction * bodyinst,
                       struct KELineInfo * linfo,
                       struct CNResource * resource) ;

struct KEInstruction *
KEAllocateReturnInstruction(struct KELineInfo * linfo, struct CNResource * resource) ;

struct KEInstruction *
KEAllocateNextInstruction(struct KELineInfo * linfo, struct CNResource * resource) ;

struct KEInstruction *
KEAllocateLastInstruction(struct KELineInfo * linfo, struct CNResource * resource) ;

struct KEInstruction *
KEAllocateExitInstruction(KERegisterId codeid, struct KELineInfo * linfo, struct CNResource * resource) ;

static inline struct CNResource *
KEResourceOfInstruction(struct KEInstruction * src)
{
    return CNResourceOfObject(&(src->superClass)) ;
}

static inline void
KERetainInstruction(struct KEInstruction * dst)
{
    CNRetainObject(&(dst->superClass)) ;
}

static inline void
KEReleaseInstruction(struct KEInstruction * dst)
{
    CNReleaseObject(&(dst->superClass)) ;
}

static inline KEOpcode
KEOpcodeOfInstruction(const struct KEInstruction * src)
{
    return src->opCode ;
}

static inline struct KELineInfo *
KELineInfoOfInstruction(const struct KEInstruction * src)
{
    return src->lineInfo ;
}

const char *
KEOpcodeString(KEOpcode src) ;

static inline void
KEAddInstructionToCompoundInstruction(struct KEInstruction * dst, struct KEInstruction * src)
{
    CNAppendObjectToList(&((dst->compoundInstruction).instructionList), &(src->superClass)) ;
}

#endif  /* KEINSTRUCTION_H */