1 /* @(#) pf_guts.h 98/01/28 1.4 */
5 /***************************************************************
6 ** Include file for PForth, a Forth based on 'C'
9 ** Copyright 1994 3DO, Phil Burk, Larry Polansky, David Rosenboom
11 ** The pForth software code is dedicated to the public domain,
12 ** and any third party may reproduce, distribute and modify
13 ** the pForth software code or any derivative works thereof
14 ** without any compensation or license. The pForth software
15 ** code is provided on an "as is" basis without any warranty
16 ** of any kind, including, without limitation, the implied
17 ** warranties of merchantability and fitness for a particular
18 ** purpose and their equivalents under the laws of any jurisdiction.
20 ***************************************************************/
23 ** PFORTH_VERSION changes when PForth is modified and released.
24 ** See README file for version info.
26 #define PFORTH_VERSION "28"
29 ** PFORTH_FILE_VERSION changes when incompatible changes are made
30 ** in the ".dic" file format.
32 ** FV3 - 950225 - Use ABS_TO_CODEREL for CodePtr. See file "pf_save.c".
33 ** FV4 - 950309 - Added NameSize and CodeSize to pfSaveForth().
34 ** FV5 - 950316 - Added Floats and reserved words.
35 ** FV6 - 961213 - Added ID_LOCAL_PLUSSTORE, ID_COLON_P, etc.
36 ** FV7 - 971203 - Added ID_FILL, (1LOCAL@), etc., ran out of reserved, resorted.
37 ** FV8 - 980818 - Added Endian flag.
38 ** FV9 - 20100503 - Added support for 64-bit CELL.
39 ** FV10 - 20170103 - Added ID_FILE_FLUSH ID_FILE_RENAME ID_FILE_RESIZE
41 #define PF_FILE_VERSION (10) /* Bump this whenever primitives added. */
42 #define PF_EARLIEST_FILE_VERSION (9) /* earliest one still compatible */
44 /***************************************************************
45 ** Sizes and other constants
46 ***************************************************************/
48 #define TIB_SIZE (256)
61 #define FLAG_PRECEDENCE (0x80)
62 #define FLAG_IMMEDIATE (0x40)
63 #define FLAG_SMUDGE (0x20)
64 #define MASK_NAME_SIZE (0x1F)
66 /* Debug TRACE flags */
67 #define TRACE_INNER (0x0002)
68 #define TRACE_COMPILE (0x0004)
69 #define TRACE_SPECIAL (0x0008)
71 /* Numeric types returned by NUMBER? */
72 #define NUM_TYPE_BAD (0)
73 #define NUM_TYPE_SINGLE (1)
74 #define NUM_TYPE_DOUBLE (2)
75 #define NUM_TYPE_FLOAT (3)
77 #define CREATE_BODY_OFFSET (3*sizeof(cell_t))
79 /***************************************************************
80 ** Primitive Token IDS
81 ** Do NOT change the order of these IDs or dictionary files will break!
82 ***************************************************************/
83 enum cforth_primitive_ids
85 ID_EXIT = 0, /* ID_EXIT must always be zero. */
86 /* Do NOT change the order of these IDs or dictionary files will break! */
120 ID_COMP_U_GREATERTHAN,
123 ID_COMP_ZERO_GREATERTHAN,
124 ID_COMP_ZERO_LESSTHAN,
125 ID_COMP_ZERO_NOT_EQUAL,
220 ID_SOURCE_LINE_NUMBER_FETCH, /* used to be ID_RESTORE_INPUT */
230 ID_SOURCE_LINE_NUMBER_STORE, /* used to be ID_SAVE_INPUT */
258 ID_VAR_HEADERS_LIMIT,
280 /* Added to support 64 bit operation. */
285 ID_FILE_FLUSH, /* FLUSH-FILE */
286 ID_FILE_RENAME, /* (RENAME-FILE) */
287 ID_FILE_RESIZE, /* RESIZE-FILE */
288 /* If you add a word here, take away one reserved word below. */
290 /* Only reserve space if we are adding FP so that we can detect
291 ** unsupported primitives when loading dictionary.
309 ID_FP_F_ZERO_LESS_THAN,
352 /* Add new IDs by replacing reserved IDs or extending FP routines. */
353 /* Do NOT change the order of these IDs or dictionary files will break! */
354 NUM_PRIMITIVES /* This must always be LAST */
359 /***************************************************************
361 ***************************************************************/
362 /* ANSI standard definitions needed by pForth */
363 #define THROW_ABORT (-1)
364 #define THROW_ABORT_QUOTE (-2)
365 #define THROW_STACK_OVERFLOW (-3)
366 #define THROW_STACK_UNDERFLOW (-4)
367 #define THROW_UNDEFINED_WORD (-13)
368 #define THROW_EXECUTING (-14)
369 #define THROW_PAIRS (-22)
370 #define THROW_FLOAT_STACK_UNDERFLOW ( -45)
371 #define THROW_QUIT (-56)
372 #define THROW_FLUSH_FILE (-68)
373 #define THROW_RESIZE_FILE (-74)
375 /* THROW codes unique to pForth */
376 #define THROW_BYE (-256) /* Exit program. */
377 #define THROW_SEMICOLON (-257) /* Error detected at ; */
378 #define THROW_DEFERRED (-258) /* Not a deferred word. Used in system.fth */
380 /***************************************************************
382 ***************************************************************/
384 typedef struct pfTaskData_s
386 cell_t *td_StackPtr; /* Primary data stack */
387 cell_t *td_StackBase;
388 cell_t *td_StackLimit;
389 cell_t *td_ReturnPtr; /* Return stack */
390 cell_t *td_ReturnBase;
391 cell_t *td_ReturnLimit;
393 PF_FLOAT *td_FloatStackPtr;
394 PF_FLOAT *td_FloatStackBase;
395 PF_FLOAT *td_FloatStackLimit;
397 cell_t *td_InsPtr; /* Instruction pointer, "PC" */
398 FileStream *td_InputStream;
400 char td_TIB[TIB_SIZE]; /* Buffer for terminal input. */
401 cell_t td_IN; /* Index into Source */
402 cell_t td_SourceNum; /* #TIB after REFILL */
403 char *td_SourcePtr; /* Pointer to TIB or other source. */
404 cell_t td_LineNumber; /* Incremented on every refill. */
405 cell_t td_OUT; /* Current output column. */
408 typedef struct pfNode
410 struct pfNode *n_Next;
411 struct pfNode *n_Prev;
414 /* Structure of header entry in dictionary. These will be stored in dictionary specific endian format*/
415 typedef struct cfNameLinks
417 cell_t cfnl_PreviousName; /* name relative address of previous */
418 ExecToken cfnl_ExecToken; /* Execution token for word. */
419 /* Followed by variable length name field. */
422 #define PF_DICF_ALLOCATED_SEGMENTS ( 0x0001)
423 typedef struct pfDictionary_s
427 /* Headers contain pointers to names and dictionary. */
429 ucell_t dic_HeaderBaseUnaligned;
431 ucell_t dic_HeaderBase;
432 ucell_t dic_HeaderPtr;
433 ucell_t dic_HeaderLimit;
434 /* Code segment contains tokenized code and data. */
435 ucell_t dic_CodeBaseUnaligned;
436 ucell_t dic_CodeBase;
442 ucell_t dic_CodeLimit;
445 /* Save state of include when nesting files. */
446 typedef struct IncludeFrame
448 FileStream *inf_FileID;
449 cell_t inf_LineNumber;
450 cell_t inf_SourceNum;
452 char inf_SaveTIB[TIB_SIZE];
455 #define MAX_INCLUDE_DEPTH (16)
457 /***************************************************************
459 ***************************************************************/
465 ThrowCode pfCatch( ExecToken XT );
471 /***************************************************************
473 ***************************************************************/
474 extern pfTaskData_t *gCurrentTask;
475 extern pfDictionary_t *gCurrentDictionary;
476 extern char gScratch[TIB_SIZE];
477 extern cell_t gNumPrimitives;
479 extern ExecToken gLocalCompiler_XT; /* CFA of (LOCAL) compiler. */
480 extern ExecToken gNumberQ_XT; /* XT of NUMBER? */
481 extern ExecToken gQuitP_XT; /* XT of (QUIT) */
482 extern ExecToken gAcceptP_XT; /* XT of ACCEPT */
484 #define DEPTH_AT_COLON_INVALID (-100)
485 extern cell_t gDepthAtColon;
487 /* Global variables. */
488 extern cell_t gVarContext; /* Points to last name field. */
489 extern cell_t gVarState; /* 1 if compiling. */
490 extern cell_t gVarBase; /* Numeric Base. */
491 extern cell_t gVarEcho; /* Echo input from file. */
492 extern cell_t gVarEchoAccept; /* Echo input from ACCEPT. */
493 extern cell_t gVarTraceLevel;
494 extern cell_t gVarTraceStack;
495 extern cell_t gVarTraceFlags;
496 extern cell_t gVarQuiet; /* Suppress unnecessary messages, OK, etc. */
497 extern cell_t gVarReturnCode; /* Returned to caller of Forth, eg. UNIX shell. */
499 extern IncludeFrame gIncludeStack[MAX_INCLUDE_DEPTH];
500 extern cell_t gIncludeIndex;
501 /***************************************************************
503 ***************************************************************/
506 /* Endian specific macros for creating target dictionaries for machines with
508 ** different endian-ness.
512 #if defined(PF_BIG_ENDIAN_DIC)
514 #define WRITE_FLOAT_DIC WriteFloatBigEndian
515 #define WRITE_CELL_DIC(addr,data) WriteCellBigEndian((uint8_t *)(addr),(ucell_t)(data))
516 #define WRITE_SHORT_DIC(addr,data) Write16BigEndian((uint8_t *)(addr),(uint16_t)(data))
517 #define READ_FLOAT_DIC ReadFloatBigEndian
518 #define READ_CELL_DIC(addr) ReadCellBigEndian((const uint8_t *)(addr))
519 #define READ_SHORT_DIC(addr) Read16BigEndian((const uint8_t *)(addr))
521 #elif defined(PF_LITTLE_ENDIAN_DIC)
523 #define WRITE_FLOAT_DIC WriteFloatLittleEndian
524 #define WRITE_CELL_DIC(addr,data) WriteCellLittleEndian((uint8_t *)(addr),(ucell_t)(data))
525 #define WRITE_SHORT_DIC(addr,data) Write16LittleEndian((uint8_t *)(addr),(uint16_t)(data))
526 #define READ_FLOAT_DIC ReadFloatLittleEndian
527 #define READ_CELL_DIC(addr) ReadCellLittleEndian((const uint8_t *)(addr))
528 #define READ_SHORT_DIC(addr) Read16LittleEndian((const uint8_t *)(addr))
532 #define WRITE_FLOAT_DIC(addr,data) { *((PF_FLOAT *)(addr)) = (PF_FLOAT)(data); }
533 #define WRITE_CELL_DIC(addr,data) { *((cell_t *)(addr)) = (cell_t)(data); }
534 #define WRITE_SHORT_DIC(addr,data) { *((int16_t *)(addr)) = (int16_t)(data); }
535 #define READ_FLOAT_DIC(addr) ( *((PF_FLOAT *)(addr)) )
536 #define READ_CELL_DIC(addr) ( *((const ucell_t *)(addr)) )
537 #define READ_SHORT_DIC(addr) ( *((const uint16_t *)(addr)) )
542 #define HEADER_HERE (gCurrentDictionary->dic_HeaderPtr.Cell)
543 #define CODE_HERE (gCurrentDictionary->dic_CodePtr.Cell)
544 #define CODE_COMMA( N ) WRITE_CELL_DIC(CODE_HERE++,(N))
545 #define NAME_BASE (gCurrentDictionary->dic_HeaderBase)
546 #define CODE_BASE (gCurrentDictionary->dic_CodeBase)
547 #define NAME_SIZE (gCurrentDictionary->dic_HeaderLimit - gCurrentDictionary->dic_HeaderBase)
548 #define CODE_SIZE (gCurrentDictionary->dic_CodeLimit - gCurrentDictionary->dic_CodeBase)
550 #define IN_CODE_DIC(addr) ( ( ((uint8_t *)(addr)) >= gCurrentDictionary->dic_CodeBase) && ( ((uint8_t *)(addr)) < gCurrentDictionary->dic_CodeLimit) )
552 #define IN_NAME_DIC(addr) ( ( ((uint8_t *)(addr)) >= gCurrentDictionary->dic_HeaderBase) && ( ((uint8_t *)(addr)) < gCurrentDictionary->dic_HeaderLimit) )
553 #define IN_DICS(addr) (IN_CODE_DIC(addr) || IN_NAME_DIC(addr))
555 /* Address conversion */
556 #define ABS_TO_NAMEREL( a ) ((cell_t) (((ucell_t) a) - NAME_BASE ))
557 #define ABS_TO_CODEREL( a ) ((cell_t) (((ucell_t) a) - CODE_BASE ))
558 #define NAMEREL_TO_ABS( a ) ((ucell_t) (((cell_t) a) + NAME_BASE))
559 #define CODEREL_TO_ABS( a ) ((ucell_t) (((cell_t) a) + CODE_BASE))
561 /* The check for >0 is only needed for CLONE testing. !!! */
562 #define IsTokenPrimitive(xt) ((xt<gNumPrimitives) && (xt>=0))
564 #define FREE_VAR(v) { if (v) { pfFreeMem((void *)(v)); v = 0; } }
566 #define DATA_STACK_DEPTH (gCurrentTask->td_StackBase - gCurrentTask->td_StackPtr)
567 #define DROP_DATA_STACK (gCurrentTask->td_StackPtr++)
568 #define POP_DATA_STACK (*gCurrentTask->td_StackPtr++)
569 #define PUSH_DATA_STACK(x) {*(--(gCurrentTask->td_StackPtr)) = (cell_t) x; }
571 /* Force Quad alignment. */
572 #define QUADUP(x) (((x)+3)&~3)
574 #define MIN(a,b) ( ((a)<(b)) ? (a) : (b) )
575 #define MAX(a,b) ( ((a)>(b)) ? (a) : (b) )
579 #define TOUCH(argument) ((void)argument)
582 /***************************************************************
583 ** I/O related macros
584 ***************************************************************/
586 #define EMIT(c) ioEmit(c)
587 #define EMIT_CR EMIT('\n');
589 #define MSG(cs) pfMessage(cs)
590 #define ERR(x) MSG(x)
592 #define DBUG(x) /* PRT(x) */
593 #define DBUGX(x) /* DBUG(x) */
595 #define MSG_NUM_D(msg,num) { MSG(msg); ffDot((cell_t) num); EMIT_CR; }
596 #define MSG_NUM_H(msg,num) { MSG(msg); ffDotHex((cell_t) num); EMIT_CR; }
598 #define DBUG_NUM_D(msg,num) { pfDebugMessage(msg); pfDebugPrintDecimalNumber((cell_t) num); pfDebugMessage("\n"); }
600 #endif /* _pf_guts_h */