sat3.h

Go to the documentation of this file.

//& *** (c) 2006-2011 The HPGCC3 Team ***
//& Claudio Lapilli
//& Ingo Blank
//&
//& This file is licensed under the terms and conditions of the
//& HPGCC3 license that is included with the source distribution.
//& *** (c) 2006-2011 The HPGCC3 Team ***


// $Id: sat3.h 578 2008-08-04 23:59:44Z claudio $

#ifndef __SAT3_H
#define __SAT3_H

#ifndef DECNUMBER
#include <decNumber.h>
#endif

#ifndef _XREAL_H
#include <extreal.h>
#endif


#ifndef _LONGLONG_DEF
typedef unsigned long long ULONGLONG;
typedef long long LONGLONG;
#define _LONGLONG_DEF
#endif


#define SWAP4(x) (((x) << 4) | ((x) >> 4))

#define ALIGN(x,a) (((unsigned)(x)+(a)-1) & (~((unsigned)(a)-1)))

#ifndef BOOL
#define BOOL int
#endif

#ifndef FALSE
#define FALSE 0
#endif

#ifndef TRUE
#define TRUE !FALSE
#endif



typedef

struct _sat_cpu {
    
    unsigned int     Read[257];
    unsigned int     Write[257];
    unsigned char    unknown_data[260];
    unsigned int    A;
    unsigned int    Ah;
    unsigned int    B;
    unsigned int    Bh;
    unsigned int    C;
    unsigned int    Ch;
    unsigned int    D;
    unsigned int    Dh;
    
    unsigned int    R0;
    unsigned int    R0h;
    unsigned int    R1;
    unsigned int    R1h;
    unsigned int    R2;
    unsigned int    R2h;
    unsigned int    R3;
    unsigned int    R3h;
    unsigned int    R4;
    unsigned int    R4h;
    
    unsigned int    D0;
    unsigned int    D1;
    unsigned int    P;
    unsigned int    ST;
    unsigned int    HST;
    unsigned int    CARRY;
    unsigned int    DECIMAL_MODE;
    
} SAT_CPU, *SAT_PCPU;


typedef unsigned int SAT_OBJECT;

// **************************************************************
//                          CONSTANTS
// **************************************************************



#define ALLOC_TEMPOB 0xffffffff

#define ALLOC_HEAP   0xfffffffe

#define BLOCK_UNREF   -1

#define BLOCK_REF   1



// ALL PROLOGUE CONSTANTS RENAMED BY CLAUDIO
// TO MATCH THE SYSRPL NAMES 01/08/05

#define SAT_DOINT 0x2614

#define SAT_DOCSTR        0x2a2c

#define SAT_DOREAL        0x2933

#define SAT_DOEREL        0x2955
 
#define SAT_DOHXS        0x2a4e

#define SAT_DOBINT        0x2911

#define SAT_DOCMP        0x2977

#define SAT_DOECMP        0x299D

#define SAT_DOCHAR        0x29BF

#define SAT_DOARRY        0x29e8

#define SAT_DOLNKARRY        0x29e8

#define SAT_DOIDNT        0x2e48

#define SAT_DOLAM        0x2e6D

#define SAT_DOROMP        0x2e92

#define SAT_DORRP        0x2a96

#define SAT_DOSYMB        0x2AB8

#define SAT_DOLIST        0x2A74

#define SAT_DOCOL        0x2D9D

#define SAT_DOGROB        0x2B1E

#define SAT_SEMI        0x312b

#define SAT_DOBAK        0x2B62

#define SAT_DOCODE        0x2DCC

#define SAT_DOEXT        0x2ADA

#define SAT_DOFLASHP    0x26AC

#define SAT_DOLIB        0x2B40

#define SAT_DOMATRIX    0x2686

#define SAT_DOTAG        0x2AFC

#define SAT_DOAPLET        0x26D5

#define SAT_DOEXT0        0x2B88

#define SAT_DOACPTR        0x2BAA
#define SAT_DOEXT1      SAT_DOACPTR

#define SAT_DOEXT2        0x2BCC

#define SAT_DOFONT        0x2BCC

#define SAT_DOEXT3        0x2BEE

#define SAT_DOARMC        0x2C10
#define SAT_DOEXT4        0x2C10

#define SAT_DOLNGREAL        0x263A

#define SAT_DOLNGCOMP        0x2660


#define SAT_TAGGED        0x20000000

#define SAT_OPTIONAL_TAG  0x40000000

#define SAT_ANY        0

#define SAT_NUMERIC   0x10000000 




// PREDEFINED REALS
#define REAL_0        0x2f937

#define REAL_1        0x2f94c

#define REAL_2        0x2f961

#define REAL_3        0x2f976

#define REAL_4        0x2f98b

#define REAL_5        0x2f9a0

#define REAL_6        0x2f9b5

#define REAL_7        0x2f9ca

#define REAL_8        0x2f9df

#define REAL_9        0x2f9f4

// Saturn register save area

#define SAT_INTRPPTR 0x8076B     /* D0 */

#define SAT_DSKTOP   0x806F8    /* D1 */

#define SAT_RSKTOP   0x806F3    /* B */

#define SAT_AVMEM    0x80E9B    /* D */

#define SAT_TEMPTOP  0x806EE

#define SAT_TEMPOB  0x806E9

#define SAT_EDITLINE  0x806FD

#define SAT_ERROR 0x80EA5

#define SAT_TEMPENV 0x80702

#define SAT_TOUCHTAB 0x8070c

#define SAT_FSTVGERPTR 0x8072f

#define SAT_CONTEXT 0x8071b

#define SAT_USEROB  0x80711


// OTHER USEFUL SATURN OBJECTS

#define SAT_TRUE 0x3a81

#define SAT_FALSE 0x3ac0

#define SATERR_TOOFEWARGS 0x201

#define SATERR_BADARGTYPE 0x202

#define SATERR_BADARGVALUE 0x203

// TODO: ADD ALL CALCULATOR ERRORS HERE!
#define SATERR_INSUFFMEMORY             0x001
#define SATERR_UNDEFLOCALNAME           0x003
#define SATERR_UNDEFXLIBNAME            0x004
#define SATERR_MEMORYCLEAR                      0x005
#define SATERR_INVALIDCARDDATA          0x008
#define SATERR_OBJECTINUSE                      0x009
#define SATERR_PORTNOTAVAILABLE         0x00A
#define SATERR_NOROOMINPORT                     0x00B
#define SATERR_NOROOMTOSAVESTACK        0x101
#define SATERR_INVALIDUSERFUNCTION      0X103
#define SATERR_INVALIDSYNTAX            0X106
#define SATERR_WRONGARGUMENTCOUNT       0X128
#define SATERR_NONEMPTYDIR                      0X12B
#define SATERR_INVALIDDEFINITION        0X12C
#define SATERR_MISSINGLIBRARY           0X12D
#define SATERR_UNABLETOISOLATE          0X130
#define SATERR_OUTOFMEMORY                      0X135

#define SATERR_TOOFEWARGS                       0x201

#define SATERR_BADARGTYPE                       0x202

#define SATERR_BADARGVALUE                      0x203

#define SATERR_UNDEFINEDNAME            0X204
#define SATERR_POSITIVEUNDERFLOW        0X301
#define SATERR_NEGATIVEUNDERFLOW        0X302
#define SATERR_OVERFLOW                         0X303
#define SATERR_UNDEFINEDRESULT          0X304
#define SATERR_INFINITERESULT           0X305
#define SATERR_INVALIDDIMENSION         0X501
#define SATERR_INVALIDARRAYELEM         0X502


// **************************************************************
//               GENERAL PURPOSE LOW-LEVEL API
// **************************************************************

void sat3_poke(SAT_OBJECT sat_addr,unsigned int val,int nibbles);

unsigned int sat3_peek(SAT_OBJECT sat_addr,int nibbles);

void sat3_memmove(SAT_OBJECT dest,SAT_OBJECT source,int nibbles);

void sat3_memset(SAT_OBJECT dest,int value,int nibvalue,int nibbles);

SAT_OBJECT sat3_alloc(SAT_OBJECT where,int nibbles);

int sat3_free(SAT_OBJECT block);


SAT_OBJECT sat3_copyobject(SAT_OBJECT dest,SAT_OBJECT source);

int sat3_sizeof(SAT_OBJECT obj);

int sat3_getfreetempob();
int sat3_getfreeuserob();
SAT_OBJECT sat3_createtemp(int objsize);

SAT_OBJECT sat3_skipob(SAT_OBJECT object);

SAT_OBJECT sat3_sknameup(SAT_OBJECT name);

SAT_OBJECT sat3_sknamedn(SAT_OBJECT name);

LONGLONG sat3_bcd2llong(SAT_OBJECT data,int digits);

void sat3_errorsto(int errno);

void sat3_exiterror(int errno);



void sat3_garbcol();


unsigned int sat3_s2a(SAT_OBJECT sat_addr);

int sat3_typesize(int prologtype);




// **************************************************************
//                      OBJECT CREATION API
// **************************************************************

// *******************************
//         System BINT
// *******************************


SAT_OBJECT sat3_createbint_int(SAT_OBJECT where,int value);

int sat3_convertbint_int(SAT_OBJECT bint);

unsigned int sat3_convertbint_uint(SAT_OBJECT bint);

// *******************************
//              REAL
// *******************************
SAT_OBJECT sat3_createreal_xreal(SAT_OBJECT where,XREAL *value);

BOOL sat3_convertreal_xreal(SAT_OBJECT real, XREAL *result);

SAT_OBJECT sat3_createreal_decn(SAT_OBJECT where,decNumber *value);

BOOL sat3_convertreal_decn(SAT_OBJECT real, decNumber *result);

SAT_OBJECT sat3_createreal_dbl(SAT_OBJECT where,double value);

double sat3_convertreal_dbl(SAT_OBJECT real);

SAT_OBJECT sat3_createreal_int(SAT_OBJECT where,int value);

int sat3_convertreal_int(SAT_OBJECT real);

SAT_OBJECT sat3_createreal_llong(SAT_OBJECT where,LONGLONG value);

LONGLONG sat3_convertreal_llong(SAT_OBJECT real);

// *******************************
//              COMPLEX
// *******************************

SAT_OBJECT sat3_createcplx_xreal(SAT_OBJECT where,XREAL *real,XREAL *imag);

BOOL sat3_convertcplx_xreal(SAT_OBJECT cplx, XREAL *real,XREAL *imag);

SAT_OBJECT sat3_createcplx_decn(SAT_OBJECT where,decNumber *real,decNumber *imag);

BOOL sat3_convertcplx_decn(SAT_OBJECT cplx, decNumber *real,decNumber *imag);

SAT_OBJECT sat3_createcplx_dbl(SAT_OBJECT where,double real,double imag);

BOOL sat3_convertcplx_dbl(SAT_OBJECT cplx,double *real, double *imag);

SAT_OBJECT sat3_createcplx_int(SAT_OBJECT where,int real,int imag);

BOOL sat3_convertcplx_int(SAT_OBJECT cplx,int *real,int *imag);

SAT_OBJECT sat3_createcplx_llong(SAT_OBJECT where,LONGLONG real,LONGLONG imag);

BOOL sat3_convertcplx_llong(SAT_OBJECT cplx,LONGLONG *real,LONGLONG *imag);


// *******************************
//              ZINT
// *******************************

SAT_OBJECT sat3_createzint_xreal(SAT_OBJECT where,XREAL *value); 

BOOL sat3_convertzint_xreal(SAT_OBJECT zint, XREAL *value);

SAT_OBJECT sat3_createzint_decn(SAT_OBJECT where,decNumber *value);

BOOL sat3_convertzint_decn(SAT_OBJECT zint,decNumber **result);

SAT_OBJECT sat3_createzint_dbl(SAT_OBJECT where,double value);

double sat3_convertzint_dbl(SAT_OBJECT zint);


SAT_OBJECT sat3_createzint_int(SAT_OBJECT where,int value);

int sat3_convertzint_int(SAT_OBJECT zint);

SAT_OBJECT sat3_createzint_llong(SAT_OBJECT where,LONGLONG value);

LONGLONG sat3_convertzint_llong(SAT_OBJECT zint);

#define sat3_zintdigits(zint) (sat3_strsize(zint)-1)

// *******************************
//              CHAR
// *******************************

SAT_OBJECT sat3_createchar_char(SAT_OBJECT where,char value);

char sat3_convertchar_char(SAT_OBJECT ochar);

// *******************************
//              CSTR
// *******************************

SAT_OBJECT sat3_createcstr_bytes(SAT_OBJECT where,char *data,int nbytes);

BOOL sat3_convertcstr_bytes(SAT_OBJECT cstr,char *data, int maxbytes);

SAT_OBJECT sat3_createcstr_str(SAT_OBJECT where,char *string);

BOOL sat3_convertcstr_str(SAT_OBJECT cstr,char *string, int maxchars);

SAT_OBJECT sat3_createcstr_substr(SAT_OBJECT where,char *string, int startpos,int nchars);

BOOL sat3_convertcstr_substr(SAT_OBJECT cstr,char *string, int startpos,int nchars);


int sat3_strsize(SAT_OBJECT obj);

#define sat3_strlen(cstr)  (sat3_strsize(cstr)>>1)


// *******************************
//              HXS
// *******************************

SAT_OBJECT sat3_createhxs_int(SAT_OBJECT where,int value);

int sat3_converthxs_int(SAT_OBJECT hxs);

SAT_OBJECT sat3_createhxs_llong(SAT_OBJECT where,LONGLONG value);

LONGLONG sat3_converthxs_llong(SAT_OBJECT hxs);

SAT_OBJECT sat3_createhxs_bytes(SAT_OBJECT where,char *data,int nbytes);

BOOL sat3_converthxs_bytes(SAT_OBJECT hxs,char *data, int maxbytes);

#define sat3_hxssize(hxs) sat3_strsize(hxs)


// *******************************
//              IDNT
// *******************************

SAT_OBJECT sat3_createid_str(SAT_OBJECT where,char *string);


BOOL sat3_convertid_str(SAT_OBJECT cstr,char *string, int maxchars);


int sat3_idlen(SAT_OBJECT idnt);


// *******************************
//              TAG
// *******************************

SAT_OBJECT sat3_createtag_str(SAT_OBJECT where,char *tag,SAT_OBJECT obj);

BOOL sat3_converttag_str(SAT_OBJECT tagged,char *string, int maxchars);

#define sat3_taglen(tag) sat3_idlen(tag)


SAT_OBJECT sat3_striptag(SAT_OBJECT obj);

// *******************************
//           REAL ARRAYS
// *******************************

SAT_OBJECT sat3_createrarray(SAT_OBJECT where,int rows,int cols);

void sat3_rarrayput_dbl(SAT_OBJECT array,int row,int col,double value);
void sat3_rarrayput_xreal(SAT_OBJECT array,int row,int col,XREAL *value);

void sat3_rarrayput_int(SAT_OBJECT array,int row,int col,int value);
void sat3_rarrayput_llong(SAT_OBJECT array,int row,int col,LONGLONG value);
void sat3_rarrayput_decn(SAT_OBJECT array,int row,int col,decNumber *value);

double sat3_rarrayget_dbl(SAT_OBJECT array,int row,int col);
BOOL sat3_rarrayget_xreal(SAT_OBJECT array,int row,int col,XREAL *result);
int sat3_rarrayget_int(SAT_OBJECT array,int row,int col);
LONGLONG sat3_rarrayget_llong(SAT_OBJECT array,int row,int col);
BOOL sat3_rarrayget_decn(SAT_OBJECT array,int row,int col,decNumber *result);

BOOL sat3_rarraysize(SAT_OBJECT array,int *rowptr,int *colptr);


// *******************************
//          COMPLEX ARRAYS
// *******************************

SAT_OBJECT sat3_createcarray(SAT_OBJECT where,int rows,int cols);
void sat3_carrayput_dbl(SAT_OBJECT array,int row,int col,double rpart,double ipart);
void sat3_carrayput_xreal(SAT_OBJECT array,int row,int col,XREAL *rpart,XREAL *ipart);
void sat3_carrayput_int(SAT_OBJECT array,int row,int col,int rpart,int ipart);
void sat3_carrayput_llong(SAT_OBJECT array,int row,int col,LONGLONG rpart,LONGLONG ipart);
void sat3_carrayput_decn(SAT_OBJECT array,int row,int col,decNumber *rpart,decNumber *ipart);
BOOL sat3_carrayget_dbl(SAT_OBJECT array,int row,int col,double *rpart,double *ipart);
BOOL sat3_carrayget_xreal(SAT_OBJECT array,int row,int col,XREAL *rpart,XREAL *ipart);
BOOL sat3_carrayget_int(SAT_OBJECT array,int row,int col,int *rpart,int *ipart);
BOOL sat3_carrayget_llong(SAT_OBJECT array,int row,int col,LONGLONG *rpart,LONGLONG *ipart);
BOOL sat3_carrayget_decn(SAT_OBJECT array,int row,int col,decNumber *rpart,decNumber *ipart);

BOOL sat3_carraysize(SAT_OBJECT array,int *rowptr,int *colptr);



// *******************************
//            MATRICES
// *******************************

SAT_OBJECT sat3_creatematrix(SAT_OBJECT where,int rows,int cols,SAT_OBJECT fillobj,int allocsize );

SAT_OBJECT sat3_matrixgetrow(SAT_OBJECT matrix,int row);

SAT_OBJECT sat3_matrixget(SAT_OBJECT matrix,int row, int col);

SAT_OBJECT sat3_matrixfirst(SAT_OBJECT obj);

SAT_OBJECT sat3_matrixnext(SAT_OBJECT obj);
BOOL sat3_matrixsize(SAT_OBJECT matrix,int *rowptr,int *colptr);

BOOL sat3_matrixrowinsert(SAT_OBJECT matrix,int rowpos,SAT_OBJECT fillobj);

BOOL sat3_matrixrowremove(SAT_OBJECT matrix,int rowpos);
BOOL sat3_matrixcolinsert(SAT_OBJECT matrix,int colpos,SAT_OBJECT fillobj);

BOOL sat3_matrixcolremove(SAT_OBJECT matrix,int colpos);

BOOL sat3_matrixput(SAT_OBJECT matrix,int row,int col,SAT_OBJECT obj);


// *******************************
//            SYMBOLICS
// *******************************

// *******************************
//            GROBS
// *******************************

// *******************************
//            LISTS
// *******************************

SAT_OBJECT sat3_createlist(SAT_OBJECT where,int allocsize );

SAT_OBJECT sat3_listhead(SAT_OBJECT list);
SAT_OBJECT sat3_listnext(SAT_OBJECT obj);
SAT_OBJECT sat3_listtail(SAT_OBJECT list);

SAT_OBJECT sat3_listget(SAT_OBJECT list, int position);
int sat3_listcount(SAT_OBJECT list);
BOOL sat3_listclose(SAT_OBJECT position);
BOOL sat3_listinsert(SAT_OBJECT position,SAT_OBJECT object);
BOOL sat3_listremove(SAT_OBJECT position);

BOOL sat3_listappend(SAT_OBJECT list,SAT_OBJECT object);

// *******************************
//            DIRS
// *******************************

SAT_OBJECT sat3_home();

SAT_OBJECT sat3_hiddendir();
SAT_OBJECT sat3_getcwd();
BOOL sat3_setcwd(SAT_OBJECT dir);
SAT_OBJECT sat3_findfirst(SAT_OBJECT dir);
SAT_OBJECT sat3_findnext(SAT_OBJECT dir, SAT_OBJECT diritem);
BOOL sat3_getvarname(SAT_OBJECT obj,char *namebuffer, int max_chars);
int sat3_getvarnamelen(SAT_OBJECT obj);

SAT_OBJECT sat3_updir(SAT_OBJECT dir);
SAT_OBJECT sat3_rclindir(SAT_OBJECT dir,char *name);

SAT_OBJECT sat3_rclhere(char *name);

SAT_OBJECT sat3_rcl(char *name);

BOOL sat3_getpath(SAT_OBJECT obj,char *pathbuffer,int maxchars);

BOOL sat3_purgeobj(SAT_OBJECT varobject);
BOOL sat3_purge(char *varpath);
BOOL sat3_purgeindir(SAT_OBJECT dir,char *varname);
BOOL sat3_stoindir(SAT_OBJECT dir,SAT_OBJECT obj,char *name);
BOOL sat3_sto(SAT_OBJECT obj,char *varname);

BOOL sat3_crdir(char *name);
BOOL sat3_pgdir(char *name);
BOOL sat3_chdir(char *dir);



// **************************************************************
//                    STACK MANIPULATION API
// **************************************************************
int sat3_depth();

void sat3_drop();

void sat3_dropn(int n);

void sat3_swap();

BOOL sat3_push(SAT_OBJECT object);

SAT_OBJECT sat3_pop();

SAT_OBJECT sat3_pick(int level);

void sat3_errorsto(int errno);

BOOL sat3_pushtruefalse(BOOL arg);

// **************************************************************
//                    ARGUMENT AND TYPE CHECKING API
// **************************************************************
BOOL sat3_checktype(SAT_OBJECT obj,unsigned int prolog);

BOOL sat3_checkargs(int n,... );

void sat3_checkargserror(int n,... );

BOOL sat3_ckn(int n);

void sat3_cknerror(int n);



#define sat3_isreal(obj) sat3_checktype(obj,SAT_DOREAL)

#define sat3_iscplx(obj) sat3_checktype(obj,SAT_DOCMP)

#define sat3_isbint(obj) sat3_checktype(obj,SAT_DOBINT)

#define sat3_iszint(obj) sat3_checktype(obj,SAT_DOINT)

#define sat3_ischar(obj) sat3_checktype(obj,SAT_DOCHAR)

#define sat3_iscstr(obj) sat3_checktype(obj,SAT_DOCSTR)

#define sat3_ishxs(obj) sat3_checktype(obj,SAT_DOHXS)

#define sat3_islist(obj) sat3_checktype(obj,SAT_DOLIST)

#define sat3_ismatrix(obj) sat3_checktype(obj,SAT_DOMATRIX)

#define sat3_isid(obj) sat3_checktype(obj,SAT_DOIDNT)

#define sat3_istag(obj) sat3_checktype(obj,SAT_DOTAG)

#define sat3_issymb(obj) sat3_checktype(obj,SAT_DOSYMB)

#define sat3_isdir(obj) sat3_checktype(obj,SAT_DORRP)


BOOL sat3_israrray(SAT_OBJECT obj);


BOOL sat3_iscarray(SAT_OBJECT obj);

BOOL sat3_isptr(SAT_OBJECT obj);

#include <sat3_common_idioms.h>

#endif // __SAT3_H