HPGCC3 Documentation 3.0 R003

General constants, macros, etc.

Data Structures

struct  _sat_cpu
 The BOOLEAN constant FALSE. More...

Defines

#define SWAP4(x)   (((x) << 4) | ((x) >> 4))
 Swap low and high nibbles in a byte.
#define ALIGN(x, a)   (((unsigned)(x)+(a)-1) & (~((unsigned)(a)-1)))
 Align an address 'x' to a 'a' bit boundary.
#define BOOL   int
 Standard definition for BOOLEAN type.
#define ALLOC_TEMPOB   0xffffffff
 Memory allocation constant used by sat3_alloc.
#define ALLOC_HEAP   0xfffffffe
 Memory allocation constant used by sat3_alloc.
#define BLOCK_UNREF   -1
 Memory allocation constant used by sat3_free.
#define BLOCK_REF   1
 Memory allocation constant used by sat3_free.
#define SAT_DOINT   0x2614
 Saturn data prologue: ZINT (Typical Exact Integer)
#define SAT_DOCSTR   0x2a2c
 Saturn data prologue: STRING.
#define SAT_DOREAL   0x2933
 Saturn data prologue: REAL.
#define SAT_DOEREL   0x2955
 Saturn data prologue: EXTENDED REAL.
#define SAT_DOHXS   0x2a4e
 Saturn data prologue: UINT (HEX STRING)
#define SAT_DOBINT   0x2911
 Saturn data prologue: BINT.
#define SAT_DOCMP   0x2977
 Saturn data prologue: COMPLEX.
#define SAT_DOECMP   0x299D
 Saturn data prologue: EXTENDED COMPLEX.
#define SAT_DOCHAR   0x29BF
 Saturn data prologue: CHAR.
#define SAT_DOARRY   0x29e8
 Saturn data prologue: ARRAY.
#define SAT_DOLNKARRY   0x29e8
 Saturn data prologue: LINKED ARRAY.
#define SAT_DOIDNT   0x2e48
 Saturn data prologue: ID (variable name)
#define SAT_DOLAM   0x2e6D
 Saturn data prologue: LAM ID (variable name)
#define SAT_DOROMP   0x2e92
 Saturn data prologue: XLIB (ROM Pointer)
#define SAT_DORRP   0x2a96
 Saturn data prologue: RRP (Directory objects)
#define SAT_DOSYMB   0x2AB8
 Saturn data prologue: SYMBOLIC.
#define SAT_DOLIST   0x2A74
 Saturn data prologue: LIST.
#define SAT_DOCOL   0x2D9D
 Saturn data prologue: SECONDARY (Programs)
#define SAT_DOGROB   0x2B1E
 Saturn data prologue: GROB.
#define SAT_SEMI   0x312b
 Saturn composite object terminator: SEMI.
#define SAT_DOBAK   0x2B62
 Saturn data prologue: BACKUP.
#define SAT_DOCODE   0x2DCC
 Saturn data prologue: CODE.
#define SAT_DOEXT   0x2ADA
 Saturn data prologue: UNIT OBJECT.
#define SAT_DOFLASHP   0x26AC
 Saturn data prologue: FLASH PTR.
#define SAT_DOLIB   0x2B40
 Saturn data prologue: LIBRARY.
#define SAT_DOMATRIX   0x2686
 Saturn data prologue: SYMBOLIC ARRAY.
#define SAT_DOTAG   0x2AFC
 Saturn data prologue: TAGGED OBJECT.
#define SAT_DOAPLET   0x26D5
 Saturn data prologue: DOAPLET.
#define SAT_DOEXT0   0x2B88
 Saturn data prologue: LIBDATA.
#define SAT_DOACPTR   0x2BAA
 Saturn data prologue: ACPTR (internal object)
#define SAT_DOEXT1   SAT_DOACPTR
#define SAT_DOEXT2   0x2BCC
 Saturn data prologue: DOEXT2.
#define SAT_DOFONT   0x2BCC
 Saturn data prologue: DOFONT.
#define SAT_DOEXT3   0x2BEE
 Saturn data prologue: DOEXT3.
#define SAT_DOARMC   0x2C10
 Saturn data prologue: ARMCODE, (ex DOEXT4)
#define SAT_DOEXT4   0x2C10
#define SAT_DOLNGREAL   0x263A
 Saturn data prologue: LNGREAL.
#define SAT_DOLNGCOMP   0x2660
 Saturn data prologue: LNGCOMP.
#define SAT_TAGGED   0x20000000
 Constant to indicate a tagged object.
#define SAT_OPTIONAL_TAG   0x40000000
 Constant to indicate an optionally tagged argument.
#define SAT_ANY   0
 Constant to indicate a any object.
#define SAT_NUMERIC   0x10000000
 Constant to indicate any numeric object (bint, zint, hxs string or real)
#define REAL_0   0x2f937
 Predefined real number in ROM.
#define REAL_1   0x2f94c
 Predefined real number in ROM.
#define REAL_2   0x2f961
 Predefined real number in ROM.
#define REAL_3   0x2f976
 Predefined real number in ROM.
#define REAL_4   0x2f98b
 Predefined real number in ROM.
#define REAL_5   0x2f9a0
 Predefined real number in ROM.
#define REAL_6   0x2f9b5
 Predefined real number in ROM.
#define REAL_7   0x2f9ca
 Predefined real number in ROM.
#define REAL_8   0x2f9df
 Predefined real number in ROM.
#define REAL_9   0x2f9f4
 Predefined real number in ROM.
#define SAT_INTRPPTR   0x8076B
 Saturn CPU storage area: D0.
#define SAT_DSKTOP   0x806F8
 Saturn CPU storage area: D1.
#define SAT_RSKTOP   0x806F3
 Saturn CPU storage area: B.
#define SAT_AVMEM   0x80E9B
 Saturn CPU storage area: D.
#define SAT_TEMPTOP   0x806EE
 Saturn emu storage area: TEMPTOP.
#define SAT_TEMPOB   0x806E9
 Saturn emu storage area: TEMPOB.
#define SAT_EDITLINE   0x806FD
 Saturn emu storage area: EDITLINE.
#define SAT_ERROR   0x80EA5
 Saturn error number: ERROR.
#define SAT_TEMPENV   0x80702
 Saturn emu storage area: TEMPENV.
#define SAT_TOUCHTAB   0x8070c
 Saturn emu storage area: TOUCHTAB.
#define SAT_FSTVGERPTR   0x8072f
 Saturn emu storage area: FSTVGERPTR.
#define SAT_CONTEXT   0x8071b
 Saturn emu storage area: CONTEXT.
#define SAT_USEROB   0x80711
 Saturn emu storage area: USEROB.
#define SAT_TRUE   0x3a81
 SysRPL flags: TRUE.
#define SAT_FALSE   0x3ac0
 SysRPL flags: FALSE.
#define SATERR_TOOFEWARGS   0x201
 Calculator error: Too Few Arguments.
#define SATERR_TOOFEWARGS   0x201
 Calculator error: Too Few Arguments.
#define SATERR_BADARGTYPE   0x202
 Calculator error: Bad Argument Type.
#define SATERR_BADARGTYPE   0x202
 Calculator error: Bad Argument Type.
#define SATERR_BADARGVALUE   0x203
 Calculator error: Bad Argument Value.
#define SATERR_BADARGVALUE   0x203
 Calculator error: Bad Argument Value.
#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_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

Typedefs

typedef unsigned int SAT_OBJECT
 Saturn object type.

Detailed Description

This group includes all general purpose type definitions, constants and preprocessor macros needed by the Saturn module


Define Documentation

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

Align an address 'x' to a 'a' bit boundary.

Definition at line 284 of file sat3.h.

#define ALLOC_HEAP   0xfffffffe

Memory allocation constant used by sat3_alloc.

Definition at line 394 of file sat3.h.

#define ALLOC_TEMPOB   0xffffffff

Memory allocation constant used by sat3_alloc.

Definition at line 390 of file sat3.h.

#define BLOCK_REF   1

Memory allocation constant used by sat3_free.

Definition at line 403 of file sat3.h.

#define BLOCK_UNREF   -1

Memory allocation constant used by sat3_free.

Definition at line 399 of file sat3.h.

#define BOOL   int

Standard definition for BOOLEAN type.

Definition at line 291 of file sat3.h.

#define REAL_0   0x2f937

Predefined real number in ROM.

Definition at line 589 of file sat3.h.

#define REAL_1   0x2f94c

Predefined real number in ROM.

Definition at line 593 of file sat3.h.

#define REAL_2   0x2f961

Predefined real number in ROM.

Definition at line 597 of file sat3.h.

#define REAL_3   0x2f976

Predefined real number in ROM.

Definition at line 601 of file sat3.h.

#define REAL_4   0x2f98b

Predefined real number in ROM.

Definition at line 605 of file sat3.h.

#define REAL_5   0x2f9a0

Predefined real number in ROM.

Definition at line 609 of file sat3.h.

#define REAL_6   0x2f9b5

Predefined real number in ROM.

Definition at line 613 of file sat3.h.

#define REAL_7   0x2f9ca

Predefined real number in ROM.

Definition at line 617 of file sat3.h.

#define REAL_8   0x2f9df

Predefined real number in ROM.

Definition at line 621 of file sat3.h.

#define REAL_9   0x2f9f4

Predefined real number in ROM.

Definition at line 625 of file sat3.h.

#define SAT_ANY   0

Constant to indicate a any object.

Definition at line 575 of file sat3.h.

#define SAT_AVMEM   0x80E9B

Saturn CPU storage area: D.

Definition at line 651 of file sat3.h.

#define SAT_CONTEXT   0x8071b

Saturn emu storage area: CONTEXT.

Definition at line 699 of file sat3.h.

#define SAT_DOACPTR   0x2BAA

Saturn data prologue: ACPTR (internal object)

Definition at line 531 of file sat3.h.

#define SAT_DOAPLET   0x26D5

Saturn data prologue: DOAPLET.

Definition at line 523 of file sat3.h.

#define SAT_DOARMC   0x2C10

Saturn data prologue: ARMCODE, (ex DOEXT4)

Definition at line 549 of file sat3.h.

#define SAT_DOARRY   0x29e8

Saturn data prologue: ARRAY.

Definition at line 451 of file sat3.h.

#define SAT_DOBAK   0x2B62

Saturn data prologue: BACKUP.

Definition at line 495 of file sat3.h.

#define SAT_DOBINT   0x2911

Saturn data prologue: BINT.

Definition at line 435 of file sat3.h.

#define SAT_DOCHAR   0x29BF

Saturn data prologue: CHAR.

Definition at line 447 of file sat3.h.

#define SAT_DOCMP   0x2977

Saturn data prologue: COMPLEX.

Definition at line 439 of file sat3.h.

#define SAT_DOCODE   0x2DCC

Saturn data prologue: CODE.

Definition at line 499 of file sat3.h.

#define SAT_DOCOL   0x2D9D

Saturn data prologue: SECONDARY (Programs)

Definition at line 483 of file sat3.h.

#define SAT_DOCSTR   0x2a2c

Saturn data prologue: STRING.

Definition at line 417 of file sat3.h.

#define SAT_DOECMP   0x299D

Saturn data prologue: EXTENDED COMPLEX.

Definition at line 443 of file sat3.h.

#define SAT_DOEREL   0x2955

Saturn data prologue: EXTENDED REAL.

Definition at line 426 of file sat3.h.

#define SAT_DOEXT   0x2ADA

Saturn data prologue: UNIT OBJECT.

Definition at line 503 of file sat3.h.

#define SAT_DOEXT0   0x2B88

Saturn data prologue: LIBDATA.

Definition at line 527 of file sat3.h.

#define SAT_DOEXT1   SAT_DOACPTR

Definition at line 532 of file sat3.h.

#define SAT_DOEXT2   0x2BCC

Saturn data prologue: DOEXT2.

Definition at line 536 of file sat3.h.

#define SAT_DOEXT3   0x2BEE

Saturn data prologue: DOEXT3.

Definition at line 545 of file sat3.h.

#define SAT_DOEXT4   0x2C10

Definition at line 550 of file sat3.h.

#define SAT_DOFLASHP   0x26AC

Saturn data prologue: FLASH PTR.

Definition at line 507 of file sat3.h.

#define SAT_DOFONT   0x2BCC

Saturn data prologue: DOFONT.

Definition at line 540 of file sat3.h.

#define SAT_DOGROB   0x2B1E

Saturn data prologue: GROB.

Definition at line 487 of file sat3.h.

#define SAT_DOHXS   0x2a4e

Saturn data prologue: UINT (HEX STRING)

Definition at line 431 of file sat3.h.

#define SAT_DOIDNT   0x2e48

Saturn data prologue: ID (variable name)

Definition at line 459 of file sat3.h.

#define SAT_DOINT   0x2614

Saturn data prologue: ZINT (Typical Exact Integer)

Definition at line 413 of file sat3.h.

#define SAT_DOLAM   0x2e6D

Saturn data prologue: LAM ID (variable name)

Definition at line 463 of file sat3.h.

#define SAT_DOLIB   0x2B40

Saturn data prologue: LIBRARY.

Definition at line 511 of file sat3.h.

#define SAT_DOLIST   0x2A74

Saturn data prologue: LIST.

Definition at line 479 of file sat3.h.

#define SAT_DOLNGCOMP   0x2660

Saturn data prologue: LNGCOMP.

Definition at line 559 of file sat3.h.

#define SAT_DOLNGREAL   0x263A

Saturn data prologue: LNGREAL.

Definition at line 555 of file sat3.h.

#define SAT_DOLNKARRY   0x29e8

Saturn data prologue: LINKED ARRAY.

Definition at line 455 of file sat3.h.

#define SAT_DOMATRIX   0x2686

Saturn data prologue: SYMBOLIC ARRAY.

Definition at line 515 of file sat3.h.

#define SAT_DOREAL   0x2933

Saturn data prologue: REAL.

Definition at line 421 of file sat3.h.

#define SAT_DOROMP   0x2e92

Saturn data prologue: XLIB (ROM Pointer)

Definition at line 467 of file sat3.h.

#define SAT_DORRP   0x2a96

Saturn data prologue: RRP (Directory objects)

Definition at line 471 of file sat3.h.

#define SAT_DOSYMB   0x2AB8

Saturn data prologue: SYMBOLIC.

Definition at line 475 of file sat3.h.

#define SAT_DOTAG   0x2AFC

Saturn data prologue: TAGGED OBJECT.

Definition at line 519 of file sat3.h.

#define SAT_DSKTOP   0x806F8

Saturn CPU storage area: D1.

Definition at line 639 of file sat3.h.

#define SAT_EDITLINE   0x806FD

Saturn emu storage area: EDITLINE.

Definition at line 669 of file sat3.h.

#define SAT_ERROR   0x80EA5

Saturn error number: ERROR.

Definition at line 675 of file sat3.h.

#define SAT_FALSE   0x3ac0

SysRPL flags: FALSE.

Definition at line 717 of file sat3.h.

#define SAT_FSTVGERPTR   0x8072f

Saturn emu storage area: FSTVGERPTR.

Definition at line 693 of file sat3.h.

#define SAT_INTRPPTR   0x8076B

Saturn CPU storage area: D0.

Definition at line 633 of file sat3.h.

#define SAT_NUMERIC   0x10000000

Constant to indicate any numeric object (bint, zint, hxs string or real)

Definition at line 580 of file sat3.h.

#define SAT_OPTIONAL_TAG   0x40000000

Constant to indicate an optionally tagged argument.

Definition at line 570 of file sat3.h.

#define SAT_RSKTOP   0x806F3

Saturn CPU storage area: B.

Definition at line 645 of file sat3.h.

#define SAT_SEMI   0x312b

Saturn composite object terminator: SEMI.

Definition at line 491 of file sat3.h.

#define SAT_TAGGED   0x20000000

Constant to indicate a tagged object.

Definition at line 565 of file sat3.h.

#define SAT_TEMPENV   0x80702

Saturn emu storage area: TEMPENV.

Definition at line 681 of file sat3.h.

#define SAT_TEMPOB   0x806E9

Saturn emu storage area: TEMPOB.

Definition at line 663 of file sat3.h.

#define SAT_TEMPTOP   0x806EE

Saturn emu storage area: TEMPTOP.

Definition at line 657 of file sat3.h.

#define SAT_TOUCHTAB   0x8070c

Saturn emu storage area: TOUCHTAB.

Definition at line 687 of file sat3.h.

#define SAT_TRUE   0x3a81

SysRPL flags: TRUE.

Definition at line 712 of file sat3.h.

#define SAT_USEROB   0x80711

Saturn emu storage area: USEROB.

Definition at line 704 of file sat3.h.

#define SATERR_BADARGTYPE   0x202

Calculator error: Bad Argument Type.

Definition at line 760 of file sat3.h.

#define SATERR_BADARGTYPE   0x202

Calculator error: Bad Argument Type.

Definition at line 760 of file sat3.h.

#define SATERR_BADARGVALUE   0x203

Calculator error: Bad Argument Value.

Definition at line 765 of file sat3.h.

#define SATERR_BADARGVALUE   0x203

Calculator error: Bad Argument Value.

Definition at line 765 of file sat3.h.

#define SATERR_INFINITERESULT   0X305

Definition at line 772 of file sat3.h.

#define SATERR_INSUFFMEMORY   0x001

Definition at line 735 of file sat3.h.

#define SATERR_INVALIDARRAYELEM   0X502

Definition at line 774 of file sat3.h.

#define SATERR_INVALIDCARDDATA   0x008

Definition at line 739 of file sat3.h.

#define SATERR_INVALIDDEFINITION   0X12C

Definition at line 748 of file sat3.h.

#define SATERR_INVALIDDIMENSION   0X501

Definition at line 773 of file sat3.h.

#define SATERR_INVALIDSYNTAX   0X106

Definition at line 745 of file sat3.h.

#define SATERR_INVALIDUSERFUNCTION   0X103

Definition at line 744 of file sat3.h.

#define SATERR_MEMORYCLEAR   0x005

Definition at line 738 of file sat3.h.

#define SATERR_MISSINGLIBRARY   0X12D

Definition at line 749 of file sat3.h.

#define SATERR_NEGATIVEUNDERFLOW   0X302

Definition at line 769 of file sat3.h.

#define SATERR_NONEMPTYDIR   0X12B

Definition at line 747 of file sat3.h.

#define SATERR_NOROOMINPORT   0x00B

Definition at line 742 of file sat3.h.

#define SATERR_NOROOMTOSAVESTACK   0x101

Definition at line 743 of file sat3.h.

#define SATERR_OBJECTINUSE   0x009

Definition at line 740 of file sat3.h.

#define SATERR_OUTOFMEMORY   0X135

Definition at line 751 of file sat3.h.

#define SATERR_OVERFLOW   0X303

Definition at line 770 of file sat3.h.

#define SATERR_PORTNOTAVAILABLE   0x00A

Definition at line 741 of file sat3.h.

#define SATERR_POSITIVEUNDERFLOW   0X301

Definition at line 768 of file sat3.h.

#define SATERR_TOOFEWARGS   0x201

Calculator error: Too Few Arguments.

Definition at line 755 of file sat3.h.

#define SATERR_TOOFEWARGS   0x201

Calculator error: Too Few Arguments.

Definition at line 755 of file sat3.h.

#define SATERR_UNABLETOISOLATE   0X130

Definition at line 750 of file sat3.h.

#define SATERR_UNDEFINEDNAME   0X204

Definition at line 767 of file sat3.h.

#define SATERR_UNDEFINEDRESULT   0X304

Definition at line 771 of file sat3.h.

#define SATERR_UNDEFLOCALNAME   0x003

Definition at line 736 of file sat3.h.

#define SATERR_UNDEFXLIBNAME   0x004

Definition at line 737 of file sat3.h.

#define SATERR_WRONGARGUMENTCOUNT   0X128

Definition at line 746 of file sat3.h.

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

Swap low and high nibbles in a byte.

Definition at line 278 of file sat3.h.


Typedef Documentation

typedef unsigned int SAT_OBJECT

Saturn object type.

This type defines a unique type that can accomodate all different Saturn objects. All saturn objects are created and manipulated through their SAT_OBJECT descriptor.

Definition at line 379 of file sat3.h.