/*#io
docCopyright("Steve Dekorte", 2002)
docLicense("BSD revised")
*/

#ifndef IOMESSAGE_DEFINED
#define IOMESSAGE_DEFINED 1

#include "IoVMApi.h"
#include "Common.h"
#include "List.h"
#include "ByteArray.h"
#include "IoTag.h"
#include "IoObject_struct.h"

#ifdef __cplusplus
extern "C" {
#endif

#define MESSAGE_STOP_STATUS_NORMAL   0
#define MESSAGE_STOP_STATUS_BREAK    1
#define MESSAGE_STOP_STATUS_CONTINUE 2
#define MESSAGE_STOP_STATUS_RETURN   4
#define MESSAGE_STOP_STATUS_EOL      8

#define ISMESSAGE(self) IoObject_hasCloneFunc_(self, (TagCloneFunc *)IoMessage_rawClone)

#if !defined(IoSymbol_DEFINED) 
  #define IoSymbol_DEFINED
  typedef IoObject IoSymbol;
#endif

typedef IoObject IoMessage;

typedef struct
{
    IoSymbol *name; 
    List *args;
    IoMessage *previous; // unused for now
    IoMessage *next;
    IoObject *cachedResult;
    
    // debugging info 
    //int charNumber;
    int lineNumber;
    IoSymbol *label; 
} IoMessageData;

#define IOMESSAGEDATA(self) ((IoMessageData *)IoObject_dataPointer(self))

// basics 

IOVM_API IoMessage *IoMessage_proto(void *state);
IOVM_API IoMessage *IoMessage_rawClone(IoMessage *m);
IOVM_API IoMessage *IoMessage_new(void *state);
IOVM_API void IoMessage_copy_(IoMessage *self, IoMessage *other);
IOVM_API IoMessage *IoMessage_deepCopyOf_(IoMessage *m);
IOVM_API IoMessage *IoMessage_newWithName_(void *state, IoSymbol *symbol);
IOVM_API IoMessage *IoMessage_newWithName_label_(void *state, IoSymbol *symbol, IoSymbol *label);
IOVM_API IoMessage *IoMessage_newWithName_returnsValue_(void *state, IoSymbol *symbol, IoObject *v);
IOVM_API IoMessage *IoMessage_newWithName_andCachedArg_(void *state, IoSymbol *symbol, IoObject *v);

IOVM_API void IoMessage_mark(IoMessage *self);
IOVM_API void IoMessage_free(IoMessage *self);

IOVM_API void IoMessage_label_(IoMessage *self, IoSymbol *ioSymbol); /* sets label for children too */
IOVM_API int IoMessage_rawLineNumber(IoMessage *self);
IOVM_API int IoMessage_rawCharNumber(IoMessage *self);
IOVM_API void IoMessage_rawSetLineNumber_(IoMessage *self, int n);
IOVM_API void IoMessage_rawSetCharNumber_(IoMessage *self, int n);
IOVM_API List *IoMessage_rawArgList(IoMessage *self);
IOVM_API unsigned char IoMessage_needsEvaluation(IoMessage *self);
IOVM_API unsigned char IoMessage_isEOL(IoMessage *self);

IOVM_API void IoMessage_addCachedArg_(IoMessage *self, IoObject *v);
IOVM_API void IoMessage_setCachedArg_to_(IoMessage *self, int n, IoObject *v);
IOVM_API void IoMessage_setCachedArg_toInt_(IoMessage *self, int n, int anInt);
IOVM_API void IoMessage_cachedResult_(IoMessage *self, IoObject *v);

IOVM_API IoObject *IoMessage_lineNumber(IoMessage *self, IoObject *locals, IoMessage *m);
IOVM_API IoObject *IoMessage_characterNumber(IoMessage *self, IoObject *locals, IoMessage *m);
IOVM_API IoObject *IoMessage_label(IoMessage *self, IoObject *locals, IoMessage *m);

// perform

IOVM_API IoObject *IoMessage_doInContext(IoMessage *self, IoObject *locals, IoMessage *m);
IOVM_API IoObject *IoMessage_locals_performOn_(IoMessage *self, IoObject *locals, IoObject *target);

// args

IOVM_API IoObject *IoMessage_locals_valueArgAt_(IoMessage *self, IoObject *locals, int n);
IOVM_API IoObject *IoMessage_locals_valueOrEvalArgAt_(IoMessage *self, IoObject *locals, int n);
IOVM_API void IoMessage_assertArgCount_receiver_(IoMessage *self, int n, IoObject *receiver);
IOVM_API int IoMessage_argCount(IoMessage *self);

IOVM_API void IoMessage_locals_numberArgAt_errorForType_(
  IoMessage *self, 
  IoObject *locals, 
  int n, 
  const char *typeName);
  
IOVM_API IoObject *IoMessage_locals_numberArgAt_(IoMessage *self, IoObject *locals, int n);
IOVM_API int IoMessage_locals_intArgAt_(IoMessage *self, IoObject *locals, int n);
IOVM_API long IoMessage_locals_longArgAt_(IoMessage *self, IoObject *locals, int n);
IOVM_API double IoMessage_locals_doubleArgAt_(IoMessage *self, IoObject *locals, int n);
IOVM_API float IoMessage_locals_floatArgAt_(IoMessage *self, IoObject *locals, int n);

IOVM_API IoObject *IoMessage_locals_symbolArgAt_(IoMessage *self, IoObject *locals, int n);
IOVM_API IoObject *IoMessage_locals_seqArgAt_(IoMessage *self, IoObject *locals, int n);
IOVM_API IoObject *IoMessage_locals_mutableSeqArgAt_(IoMessage *self, IoObject *locals, int n);
IOVM_API char *IoMessage_locals_cStringArgAt_(IoMessage *self, IoObject *locals, int n);

IOVM_API IoObject *IoMessage_locals_blockArgAt_(IoMessage *self, IoObject *locals, int n);
IOVM_API IoObject *IoMessage_locals_dateArgAt_(IoMessage *self, IoObject *locals, int n);
IOVM_API IoObject *IoMessage_locals_mapArgAt_(IoMessage *self, IoObject *locals, int n);
IOVM_API IoObject *IoMessage_locals_messageArgAt_(IoMessage *self, IoObject *locals, int n);
IOVM_API IoObject *IoMessage_locals_listArgAt_(IoMessage *self, IoObject *locals, int n);

// printing 

IOVM_API void IoMessage_print(IoMessage *self);
IOVM_API void IoMessage_printWithReturn(IoMessage *self);
IOVM_API ByteArray *IoMessage_description(IoMessage *self);
IOVM_API ByteArray *IoMessage_descriptionJustSelfAndArgs(IoMessage *self); /* caller must free returned */
IOVM_API void IoMessage_appendDescriptionTo_follow_(IoMessage *self, ByteArray *ba, int follow);
IOVM_API IoObject *IoMessage_asString(IoMessage *self, IoObject *locals, IoMessage *m);

// primitive methods
IOVM_API IoObject *IoMessage_clone(IoMessage *self, IoObject *locals, IoMessage *m);
IOVM_API IoObject *IoMessage_protoName(IoMessage *self, IoObject *locals, IoMessage *m);
IOVM_API IoObject *IoMessage_protoSetName(IoMessage *self, IoObject *locals, IoMessage *m);
IOVM_API IoObject *IoMessage_descriptionString(IoMessage *self, IoObject *locals, IoMessage *m);


// next

IOVM_API IoObject *IoMessage_next(IoMessage *self, IoObject *locals, IoMessage *m);
IOVM_API IoMessage *IoMessage_rawNext(IoMessage *self);

IOVM_API IoObject *IoMessage_setNext(IoMessage *self, IoObject *locals, IoMessage *m);
IOVM_API void IoMessage_rawSetNext(IoMessage *self, IoMessage *m);

// previous

IOVM_API IoObject *IoMessage_previous(IoMessage *self, IoObject *locals, IoMessage *m);
IOVM_API IoMessage *IoMessage_rawPrevious(IoMessage *self);

IOVM_API IoObject *IoMessage_setPrevious(IoMessage *self, IoObject *locals, IoMessage *m);
IOVM_API void IoMessage_rawSetPrevious(IoMessage *self, IoMessage *m);

IOVM_API IoObject *IoMessage_argAt(IoMessage *self, IoObject *locals, IoMessage *m);
IOVM_API IoObject *IoMessage_arguments(IoMessage *self, IoObject *locals, IoMessage *m);
IOVM_API IoObject *IoMessage_setArguments(IoMessage *self, IoObject *locals, IoMessage *m);
IOVM_API IoObject *IoMessage_appendArg(IoMessage *self, IoObject *locals, IoMessage *m);
IOVM_API IoObject *IoMessage_argCount_(IoMessage *self, IoObject *locals, IoMessage *m);
IOVM_API IoObject *IoMessage_cachedResult(IoMessage *self, IoObject *locals, IoMessage *m);
IOVM_API IoObject *IoMessage_setCachedResult(IoMessage *self, IoObject *locals, IoMessage *m);
IOVM_API IoObject *IoMessage_removeCachedResult(IoMessage *self, IoObject *locals, IoMessage *m);

IOVM_API IoObject *IoMessage_setLineNumber(IoMessage *self, IoObject *locals, IoMessage *m);
IOVM_API IoObject *IoMessage_setCharacterNumber(IoMessage *self, IoObject *locals, IoMessage *m);
IOVM_API IoObject *IoMessage_setLabel(IoMessage *self, IoObject *locals, IoMessage *m);

IOVM_API IoObject *IoMessage_fromString(IoMessage *self, IoObject *locals, IoMessage *m);
IOVM_API IoObject *IoMessage_argsEvaluatedIn(IoMessage *self, IoObject *locals, IoMessage *m);
IOVM_API IoObject *IoMessage_evaluatedArgs(IoMessage *self, IoObject *locals, IoMessage *m);

IOVM_API void IoMessage_foreachArgs(IoMessage *self, 
    IoObject *object, 
    IoSymbol **indexSlotName, 
    IoSymbol **valueSlotName, 
    IoMessage **doMessage);

IOVM_API IoMessage *IoMessage_asMessageWithEvaluatedArgs(IoMessage *self, IoObject *locals, IoMessage *m);

//  ------------------------------ 

#include "IoMessage_inline.h"
#include "IoMessage_parser.h"

//IoSymbol *IoMessage_name(IoMessage *self);

#define IoMessage_name(self)  (((IoMessageData *)IoObject_dataPointer(self))->name)
#define IoMessage_rawCachedResult(self) (((IoMessageData *)IoObject_dataPointer(self))->cachedResult)

IOVM_API void IoMessage_addArg_(IoMessage *self, IoMessage *m);
IOVM_API IoMessage *IoMessage_rawArgAt_(IoMessage *self, int n);
IOVM_API IoSymbol *IoMessage_rawLabel(IoMessage *self);
IOVM_API List *IoMessage_rawArgs(IoMessage *self);

IOVM_API ByteArray *IoMessage_asMinimalStackEntryDescription(IoMessage *self);

#ifdef __cplusplus
}
#endif
#endif