1 /* ------------------------------------------------------------------------- */
2 /* Header file for Inform: Z-machine ("Infocom" format) compiler */
4 /* Copyright (c) Graham Nelson 1993 - 2020 */
6 /* This file is part of Inform. */
8 /* Inform is free software: you can redistribute it and/or modify */
9 /* it under the terms of the GNU General Public License as published by */
10 /* the Free Software Foundation, either version 3 of the License, or */
11 /* (at your option) any later version. */
13 /* Inform is distributed in the hope that it will be useful, */
14 /* but WITHOUT ANY WARRANTY; without even the implied warranty of */
15 /* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
16 /* GNU General Public License for more details. */
18 /* You should have received a copy of the GNU General Public License */
19 /* along with Inform. If not, see https://gnu.org/licenses/ */
21 /* *** To compile this program in one of the existing ports, you must */
22 /* at least change the machine definition (on the next page). */
23 /* In most cases no other work will be needed. *** */
27 /* Machine/host OS definitions (in alphabetical order) */
28 /* Default definitions */
29 /* Standard ANSI inclusions, macro definitions, structures */
30 /* Definitions of internal code numbers */
31 /* Extern declarations for linkage (in alphabetical order of file) */
33 /* ------------------------------------------------------------------------- */
35 #define RELEASE_NUMBER 1634
36 #define GLULX_RELEASE_NUMBER 38
37 #define MODULE_VERSION_NUMBER 1
38 #define VNUMBER RELEASE_NUMBER
40 /* N indicates an intermediate release for Inform 7 */
41 /*#define RELEASE_SUFFIX "N"*/
43 /* ------------------------------------------------------------------------- */
44 /* Our host machine or OS for today is... */
46 /* [ Inform should compile (possibly with warnings) and work safely */
49 /* #define AMIGA - for the Commodore Amiga under SAS/C */
50 /* #define ARCHIMEDES - for Acorn RISC OS machines under Norcroft C */
51 /* #define ATARIST - for the Atari ST */
52 /* #define BEOS - for the BeBox */
53 /* #define LINUX - for Linux under gcc (essentially as Unix) */
54 /* #define MACOS - for the Apple Mac with OS X (another Unix) */
55 /* #define MAC_CLASSIC - for the Apple Mac under Think C or Codewarrior */
56 /* #define MAC_MPW - for MPW under Codewarrior (and maybe Think C) */
57 /* #define OS2 - for OS/2 32-bit mode under IBM's C Set++ */
58 /* #define PC - for 386+ IBM PCs, eg. Microsoft Visual C/C++ */
59 /* #define PC_QUICKC - for small IBM PCs under QuickC */
60 /* #define PC_WIN32 - for Borland C++ or Microsoft Visual C++ */
61 /* #define UNIX - for Unix under gcc (or big IBM PC under djgpp) */
62 /* #define VMS - for VAX or ALPHA under DEC C, but not VAX C */
64 /* In most cases executables are already available at */
65 /* http://www.ifarchive.org/, and these are sometimes enhanced with */
66 /* e.g. windowed interfaces whose source is not archived with the */
67 /* main Inform source.] */
69 /* (If no machine is defined, then cautious #defines will be made. In */
70 /* most cases, porting to a new machine is a matter of carefully filling */
71 /* out a block of definitions like those below.) */
72 /* ------------------------------------------------------------------------- */
76 /* ------------------------------------------------------------------------- */
77 /* The first task is to include the ANSI header files, and typedef */
78 /* suitable 32-bit integer types. */
79 /* ------------------------------------------------------------------------- */
91 #if SCHAR_MAX >= 0x7FFFFFFFL && SCHAR_MIN <= -0x7FFFFFFFL
92 typedef signed char int32;
93 typedef unsigned char uint32;
94 #elif SHRT_MAX >= 0x7FFFFFFFL && SHRT_MIN <= -0x7FFFFFFFL
95 typedef signed short int int32;
96 typedef unsigned short int uint32;
97 #elif INT_MAX >= 0x7FFFFFFFL && INT_MIN <= -0x7FFFFFFFL
98 typedef signed int int32;
99 typedef unsigned int uint32;
100 #elif LONG_MAX >= 0x7FFFFFFFL && LONG_MIN <= -0x7FFFFFFFL
101 typedef signed long int int32;
102 typedef unsigned long int uint32;
104 #error No type large enough to support 32-bit integers.
107 /* VAX C does not provide these limit constants, contrary to ANSI */
109 typedef unsigned int uint32;
112 /* ------------------------------------------------------------------------- */
113 /* The next part of this file contains blocks of definitions, one for */
114 /* each port, of machine or OS-dependent constants needed by Inform. */
116 /* 1. MACHINE_STRING should be set to the name of the machine or OS. */
118 /* 2. Some miscellaneous #define options (set if the constant is */
119 /* defined, otherwise not set): */
121 /* USE_TEMPORARY_FILES - use scratch files for workspace, not memory, */
123 /* PROMPT_INPUT - prompt input (don't use Unix-style command line) */
124 /* TIME_UNAVAILABLE - don't use ANSI time routines to work out today's */
126 /* CHAR_IS_UNSIGNED - if on your compiler the type "char" is unsigned */
127 /* by default, you should define this */
128 /* HAS_REALPATH - the POSIX realpath() function is available to */
129 /* find the absolute path to a file */
131 /* 3. An estimate of the typical amount of memory likely to be free */
132 /* should be given in DEFAULT_MEMORY_SIZE. */
133 /* For most modern machines, HUGE_SIZE is the appropriate setting, but */
134 /* some older micros may benefit from SMALL_SIZE. */
135 /* ------------------------------------------------------------------------- */
141 /* ------------------------------------------------------------------------- */
142 /* 4. Filenaming definitions: */
144 /* It's assumed that the host OS has the concept of subdirectories and */
145 /* has "pathnames", that is, filenames giving a chain of subdirectories */
146 /* divided by the FN_SEP (filename separator) character: e.g. for Unix */
147 /* FN_SEP is defined below as '/' and a typical name is */
148 /* "users/graham/jigsaw.z5". */
149 /* White space is not allowed in filenames, and nor is the special */
150 /* character FN_ALT, which unless defined here will be a comma and will */
151 /* be used to separate alternative locations in a path variable. */
153 /* If NO_FILE_EXTENSIONS is undefined then the OS allows "file extensions" */
154 /* of 1 to 3 alphanumeric characters like ".txt" (for text files), ".z5" */
155 /* (for game files), etc., to indicate the file's type (and, crucially, */
156 /* regards the same filename but with different extensions -- e.g., */
157 /* "frog.amp" and "frog.lil" -- as being different names). */
158 /* (The file extensions defined below are widely accepted, so please use */
159 /* them unless there's a good reason why not.) */
161 /* You should then define STANDARD_DIRECTORIES (you can define it anyway) */
162 /* in which case Inform will expect by default that files are sorted out */
163 /* by being put into suitable directories (e.g., a "games" directory for */
166 /* If it's convenient for your port you can alter the detailed definitions */
167 /* which these broad settings make. Be careful if NO_FILE_EXTENSIONS */
168 /* is set without STANDARD_DIRECTORIES, as then Inform may */
169 /* overwrite its source with object code. */
171 /* 5. Filenames (or code related to filenames) for the three temporary */
172 /* files. These only exist during compilation (and only if -F1 is set). */
173 /* Temporary_Name is the body of a filename to use */
174 /* (if you don't set this, it becomes "Inftemp") and Temporary_Directory */
175 /* is the directory path for the files to go in (which can be altered on */
176 /* the command line). On some multi-tasking OSs these filenames ought to */
177 /* include a number uniquely identifying the process: to indicate this, */
178 /* define INCLUDE_TASK_ID and provide some code... */
180 /* #define INCLUDE_TASK_ID */
181 /* #ifdef INFORM_FILE */
182 /* static int32 unique_task_id(void) */
183 /* { ...some code returning your task ID... */
187 /* 6. Any other definitions specific to the OS or machine. */
188 /* (In particular DEFAULT_ERROR_FORMAT is 0 on most machines and 1 on PCs; */
189 /* it controls the style of error messages, which is important for some */
190 /* error-throwback debugging tools.) */
191 /* ------------------------------------------------------------------------- */
193 /* ========================================================================= */
194 /* The blocks now follow in alphabetical order. */
195 /* ------------------------------------------------------------------------- */
197 /* ------------------------------------------------------------------------- */
200 #define MACHINE_STRING "Amiga"
202 #define DEFAULT_MEMORY_SIZE LARGE_SIZE
206 #define __USE_SYSBASE
207 #include <proto/exec.h>
208 #define INCLUDE_TASK_ID
209 #define Temporary_Directory "T:"
210 #ifdef MAIN_INFORM_FILE
211 static int32 unique_task_id(void)
212 { return (int32)FindTask(NULL);
216 /* ------------------------------------------------------------------------- */
217 /* ARCHIMEDES block: Acorn/RISC OS settings */
218 /* ------------------------------------------------------------------------- */
221 #define MACHINE_STRING "RISC OS"
223 #define CHAR_IS_UNSIGNED
225 #define DEFAULT_MEMORY_SIZE LARGE_SIZE
228 #define STANDARD_DIRECTORIES
229 #define NO_FILE_EXTENSIONS
230 #define Source_Directory "inform"
231 #define ICL_Directory "ICL"
233 #define ENABLE_TEMPORARY_PATH
234 #define Temporary_Directory "ram:"
236 #define ARC_THROWBACK
238 /* ------------------------------------------------------------------------- */
240 /* ------------------------------------------------------------------------- */
243 #define MACHINE_STRING "Atari ST"
245 #define DEFAULT_MEMORY_SIZE LARGE_SIZE
250 #define Temporary_Directory "/tmp"
251 #define INCLUDE_TASK_ID
252 #ifdef MAIN_INFORM_FILE
253 static int32 unique_task_id(void)
254 { return (int32)getpid();
259 /* ------------------------------------------------------------------------- */
261 /* ------------------------------------------------------------------------- */
264 #define MACHINE_STRING "BeOS"
266 #define DEFAULT_MEMORY_SIZE LARGE_SIZE
269 #define FILE_EXTENSIONS
271 #define Temporary_Directory "/tmp"
273 /* ------------------------------------------------------------------------- */
275 /* ------------------------------------------------------------------------- */
278 #define MACHINE_STRING "Linux"
282 #define DEFAULT_MEMORY_SIZE HUGE_SIZE
286 #define Temporary_Directory "/tmp"
290 /* ------------------------------------------------------------------------- */
291 /* Macintosh block */
292 /* ------------------------------------------------------------------------- */
300 #define MACHINE_STRING "Macintosh Programmer's Workshop"
302 #define MACHINE_STRING "Macintosh"
306 #define EXTERNAL_SHELL
314 #define DEFAULT_MEMORY_SIZE LARGE_SIZE
318 #define Include_Extension ".h"
322 #include "TB Inform.h"
325 #include <CursorCtl.h>
326 #define DEFAULT_ERROR_FORMAT 2
329 /* ------------------------------------------------------------------------- */
331 /* ------------------------------------------------------------------------- */
334 #define MACHINE_STRING "OS/2"
336 #define CHAR_IS_UNSIGNED
338 #define DEFAULT_MEMORY_SIZE LARGE_SIZE
342 /* ------------------------------------------------------------------------- */
344 /* ------------------------------------------------------------------------- */
347 #define MACHINE_STRING "MacOS"
351 #define DEFAULT_MEMORY_SIZE HUGE_SIZE
355 #define Temporary_Directory "/tmp"
356 #define INCLUDE_TASK_ID
357 #define _POSIX_C_SOURCE 199506L
358 #define _XOPEN_SOURCE 500
359 #ifdef MAIN_INFORM_FILE
360 #include <sys/types.h>
362 static int32 unique_task_id(void)
363 { return (int32)getpid();
369 /* ------------------------------------------------------------------------- */
370 /* PC and PC_QUICKC block */
371 /* ------------------------------------------------------------------------- */
378 #define MACHINE_STRING "PC"
380 #define USE_TEMPORARY_FILES
383 #define DEFAULT_MEMORY_SIZE SMALL_SIZE
385 #define DEFAULT_MEMORY_SIZE LARGE_SIZE
390 #define DEFAULT_ERROR_FORMAT 1
392 /* ------------------------------------------------------------------------- */
394 /* ------------------------------------------------------------------------- */
397 #define MACHINE_STRING "Win32"
401 #define DEFAULT_MEMORY_SIZE HUGE_SIZE
405 #define DEFAULT_ERROR_FORMAT 1
407 #ifdef _MSC_VER /* Microsoft Visual C++ */
408 #define snprintf _snprintf
410 #define isinf(x) (!_isnan(x) && !_finite(x))
413 /* ------------------------------------------------------------------------- */
415 /* ------------------------------------------------------------------------- */
418 #ifndef MACHINE_STRING
419 #define MACHINE_STRING "Unix"
424 #define DEFAULT_MEMORY_SIZE HUGE_SIZE
429 #define Temporary_Directory "/tmp"
430 #define INCLUDE_TASK_ID
431 #ifdef MAIN_INFORM_FILE
433 static int32 unique_task_id(void)
434 { return (int32)getpid();
438 /* ------------------------------------------------------------------------- */
439 /* VMS (Dec VAX and Alpha) block */
440 /* ------------------------------------------------------------------------- */
448 #define MACHINE_STRING "Alpha/VMS"
450 #define MACHINE_STRING "VAX/VMS"
453 #define CHAR_IS_UNSIGNED
455 #define DEFAULT_MEMORY_SIZE LARGE_SIZE
458 #define Code_Extension ".zip"
459 #define V4Code_Extension ".zip"
460 #define V5Code_Extension ".zip"
461 #define V6Code_Extension ".zip"
462 #define V7Code_Extension ".zip"
463 #define V8Code_Extension ".zip"
465 /* ========================================================================= */
466 /* Default settings: */
467 /* ------------------------------------------------------------------------- */
469 #ifndef NO_FILE_EXTENSIONS
470 #define FILE_EXTENSIONS
473 #ifndef Transcript_File
474 #ifdef FILE_EXTENSIONS
475 #define Transcript_File "gametext.txt"
477 #define Transcript_File "gametext"
480 #ifndef Debugging_File
481 #ifdef FILE_EXTENSIONS
482 #define Debugging_File "gameinfo.dbg"
484 #define Debugging_File "gamedebug"
488 #ifdef FILE_EXTENSIONS
489 #ifndef Source_Extension
490 #define Source_Extension ".inf"
492 #ifndef Include_Extension
493 #define Include_Extension ".h"
495 #ifndef Code_Extension
496 #define Code_Extension ".z3"
498 #ifndef V4Code_Extension
499 #define V4Code_Extension ".z4"
501 #ifndef V5Code_Extension
502 #define V5Code_Extension ".z5"
504 #ifndef V6Code_Extension
505 #define V6Code_Extension ".z6"
507 #ifndef V7Code_Extension
508 #define V7Code_Extension ".z7"
510 #ifndef V8Code_Extension
511 #define V8Code_Extension ".z8"
513 #ifndef GlulxCode_Extension
514 #define GlulxCode_Extension ".ulx"
516 #ifndef Module_Extension
517 #define Module_Extension ".m5"
519 #ifndef ICL_Extension
520 #define ICL_Extension ".icl"
525 #define Source_Extension ""
526 #define Include_Extension ""
527 #define Code_Extension ""
528 #define V4Code_Extension ""
529 #define V5Code_Extension ""
530 #define V6Code_Extension ""
531 #define V7Code_Extension ""
532 #define V8Code_Extension ""
533 #define GlulxCode_Extension ""
534 #define Module_Extension ""
535 #define ICL_Extension ""
538 #ifdef STANDARD_DIRECTORIES
539 #ifndef Source_Directory
540 #define Source_Directory "source"
542 #ifndef Include_Directory
543 #define Include_Directory "library"
545 #ifndef Code_Directory
546 #define Code_Directory "games"
548 #ifndef Module_Directory
549 #define Module_Directory "modules"
551 #ifndef Temporary_Directory
552 #define Temporary_Directory ""
554 #ifndef ICL_Directory
555 #define ICL_Directory ""
560 #ifndef Source_Directory
561 #define Source_Directory ""
563 #ifndef Include_Directory
564 #define Include_Directory ""
566 #ifndef Code_Directory
567 #define Code_Directory ""
569 #ifndef Module_Directory
570 #define Module_Directory ""
572 #ifndef Temporary_Directory
573 #define Temporary_Directory ""
575 #ifndef ICL_Directory
576 #define ICL_Directory ""
592 #ifndef Temporary_File
593 #define Temporary_File "Inftemp"
596 #ifndef DEFAULT_ERROR_FORMAT
597 #define DEFAULT_ERROR_FORMAT 0
600 #ifndef DEFAULT_MEMORY_SIZE
601 #define DEFAULT_MEMORY_SIZE LARGE_SIZE
604 #ifndef CHAR_IS_UNSIGNED
605 typedef unsigned char uchar;
610 #if defined(__GNUC__) || defined(__clang__)
611 #define NORETURN __attribute__((__noreturn__))
612 #endif /* defined(__GNUC__) || defined(__clang__) */
618 /* ------------------------------------------------------------------------- */
619 /* A macro (rather than constant) definition: */
620 /* ------------------------------------------------------------------------- */
623 void _huge * halloc(long, size_t);
625 #define subtract_pointers(p1,p2) (long)((char _huge *)p1-(char _huge *)p2)
627 #define subtract_pointers(p1,p2) (((char *) p1)-((char *) p2))
630 /* ------------------------------------------------------------------------- */
631 /* SEEK_SET is a constant which should be defined in the ANSI header files */
632 /* but which is not present in some implementations: it's used as a */
633 /* parameter for "fseek", defined in "stdio". In pre-ANSI C, the value */
634 /* 0 was used as a parameter instead, hence the definition below. */
635 /* ------------------------------------------------------------------------- */
641 /* ------------------------------------------------------------------------- */
642 /* A large block of #define'd constant values follows. */
643 /* ------------------------------------------------------------------------- */
648 /* These checked the glulx_mode global during development, but are no
650 #define ASSERT_ZCODE() (0)
651 #define ASSERT_GLULX() (0)
654 #define ReadInt32(ptr) \
655 ( (((int32)(((uchar *)(ptr))[0])) << 24) \
656 | (((int32)(((uchar *)(ptr))[1])) << 16) \
657 | (((int32)(((uchar *)(ptr))[2])) << 8) \
658 | (((int32)(((uchar *)(ptr))[3])) ) )
660 #define ReadInt16(ptr) \
661 ( (((int32)(((uchar *)(ptr))[0])) << 8) \
662 | (((int32)(((uchar *)(ptr))[1])) ) )
664 #define WriteInt32(ptr, val) \
665 ((ptr)[0] = (uchar)(((int32)(val)) >> 24), \
666 (ptr)[1] = (uchar)(((int32)(val)) >> 16), \
667 (ptr)[2] = (uchar)(((int32)(val)) >> 8), \
668 (ptr)[3] = (uchar)(((int32)(val)) ) )
670 #define WriteInt16(ptr, val) \
671 ((ptr)[0] = (uchar)(((int32)(val)) >> 8), \
672 (ptr)[1] = (uchar)(((int32)(val)) ) )
674 /* ------------------------------------------------------------------------- */
675 /* If your compiler doesn't recognise \t, and you use ASCII, you could */
676 /* define T_C as (char) 9; failing that, it _must_ be defined as ' ' */
677 /* (space) and is _not_ allowed to be 0 or any recognisable character. */
678 /* ------------------------------------------------------------------------- */
680 #define TAB_CHARACTER '\t'
682 /* ------------------------------------------------------------------------- */
684 /* ------------------------------------------------------------------------- */
686 #define MAX_ERRORS 100
687 #define MAX_IDENTIFIER_LENGTH 32
688 #define MAX_ABBREV_LENGTH 64
689 #define MAX_DICT_WORD_SIZE 40
690 #define MAX_DICT_WORD_BYTES (40*4)
691 #define MAX_NUM_ATTR_BYTES 39
692 #define MAX_VERB_WORD_SIZE 120
694 #define VENEER_CONSTRAINT_ON_CLASSES_Z 256
695 #define VENEER_CONSTRAINT_ON_IP_TABLE_SIZE_Z 128
696 #define VENEER_CONSTRAINT_ON_CLASSES_G 32768
697 #define VENEER_CONSTRAINT_ON_IP_TABLE_SIZE_G 32768
698 #define VENEER_CONSTRAINT_ON_CLASSES \
699 (glulx_mode ? VENEER_CONSTRAINT_ON_CLASSES_G \
700 : VENEER_CONSTRAINT_ON_CLASSES_Z)
701 #define VENEER_CONSTRAINT_ON_IP_TABLE_SIZE \
702 (glulx_mode ? VENEER_CONSTRAINT_ON_IP_TABLE_SIZE_G \
703 : VENEER_CONSTRAINT_ON_IP_TABLE_SIZE_Z)
705 #define GLULX_HEADER_SIZE 36
706 /* Number of bytes in the header. */
707 #define GLULX_STATIC_ROM_SIZE 24
708 /* Number of bytes in the Inform-specific block right after the header. */
709 #define GPAGESIZE 256
710 /* All Glulx memory boundaries must be multiples of GPAGESIZE. */
712 /* ------------------------------------------------------------------------- */
713 /* Structure definitions (there are a few others local to files) */
714 /* ------------------------------------------------------------------------- */
716 typedef struct assembly_operand_t
719 int symtype; /* 6.30 */
720 int symflags; /* 6.30 */
724 #define INITAOTV(aop, typ, val) ((aop)->type=(typ), (aop)->value=(val), (aop)->marker=0, (aop)->symtype=0, (aop)->symflags=0)
725 #define INITAOT(aop, typ) INITAOTV(aop, typ, 0)
726 #define INITAO(aop) INITAOTV(aop, 0, 0)
728 #define MAX_LINES_PER_VERB 32
729 typedef struct verbt {
731 int l[MAX_LINES_PER_VERB];
734 typedef struct prop {
736 assembly_operand ao[32];
739 /* Only one of this object. */
740 typedef struct fpropt {
746 typedef struct objecttz {
748 int parent, next, child;
752 typedef struct propg {
760 /* Only one of this object. */
761 typedef struct fproptg {
762 uchar atts[MAX_NUM_ATTR_BYTES];
766 assembly_operand *propdata;
770 typedef struct objecttg {
771 /* attributes are stored in a separate array */
773 int32 parent, next, child;
778 typedef struct maybe_file_position_S
781 } maybe_file_position;
783 typedef struct debug_location_s
785 int32 beginning_byte_index;
786 int32 end_byte_index;
787 int32 beginning_line_number;
788 int32 end_line_number;
789 int32 beginning_character_number;
790 int32 end_character_number;
791 int32 orig_file_index;
792 int32 orig_beg_line_number;
793 int32 orig_beg_char_number;
794 /* We only track the beginning #origsource location, not the end. */
797 typedef struct debug_locations_s
798 { debug_location location;
799 struct debug_locations_s *next;
803 typedef struct brief_location_s
806 int32 orig_file_index;
807 int32 orig_line_number;
810 typedef struct debug_location_beginning_s
811 { debug_locations *head;
812 int32 beginning_byte_index;
813 int32 beginning_line_number;
814 int32 beginning_character_number;
815 int32 orig_file_index;
816 int32 orig_beg_line_number;
817 int32 orig_beg_char_number;
818 } debug_location_beginning;
820 typedef struct keyword_group_s
821 { char *keywords[120];
822 int change_token_type;
827 typedef struct token_data_s
829 int32 value; /* ###-long */
831 int symtype; /* 6.30 */
832 int symflags; /* 6.30 */
834 debug_location location;
837 typedef struct FileId_s /* Source code file identifier: */
838 { char *filename; /* The filename (after translation) */
839 FILE *handle; /* Handle of file (when open), or
841 int is_input; /* Is this a source file that we are
842 parsing? If not, this is an
843 origsource filename (and handle
847 typedef struct ErrorPosition_s
858 /* A memory block can hold at most ALLOC_CHUNK_SIZE * 72: */
860 extern int ALLOC_CHUNK_SIZE;
862 typedef struct memory_block_s
869 /* This serves for both Z-code and Glulx instructions. Glulx doesn't use
870 the text, store_variable_number, branch_label_number, or branch_flag
872 typedef struct assembly_instruction_t
873 { int internal_number;
874 int store_variable_number;
875 int32 branch_label_number;
879 assembly_operand operand[8];
880 } assembly_instruction;
882 typedef struct expression_tree_node_s
884 /* Data used in tree construction */
887 int operator_number; /* Only meaningful for non-leaves */
888 assembly_operand value; /* Only meaningful for leaves */
890 /* Attributes synthesised during code generation */
892 int must_produce_value; /* e.g. FALSE in a void context */
894 int label_after; /* -1, or "put this label after code" */
895 int to_expression; /* TRUE if a condition used as numeric val */
896 int true_label; /* On condition "true", jump to this (or keep
898 int false_label; /* Likewise if the condition is "false". */
900 } expression_tree_node;
902 typedef struct operator_s
903 { int precedence; /* Level 0 to 13 (13 is highest) */
904 int token_type; /* Lexical token type */
905 int token_value; /* Lexical token value */
906 int usage; /* Infix (IN_U), prefix or postfix */
907 int associativity; /* Left (L_A), right (R_A)
908 or 0 for "it is an error to
909 implicitly associate this" */
910 int requires_lvalue; /* TRUE if the first operand must
911 be an "lvalue" (the name of some
912 storage object, such as a variable
913 or an array entry) */
914 int opcode_number_z; /* Translation number (see below) */
915 int opcode_number_g; /* Translation number (see below) */
916 int side_effect; /* TRUE if evaluating the operator
917 has potential side-effects in
918 terms of changing the Z-machine */
919 int negation; /* 0 for an unconditional operator,
920 otherwise the negation operator */
921 char *description; /* Text describing the operator
922 for error messages and tracing */
925 /* The translation number of an operator is as follows:
928 an internal opcode number if the operator can be translated
929 directly to a single Z-machine opcode;
930 400+n if it can be translated to branch opcode n;
931 800+n if to the negated form of branch opcode n;
932 (using n = 200, 201 for two conditions requiring special
936 an internal opcode number if the operator can be translated
937 directly to a single Glulx opcode;
938 FIRST_CC to LAST_CC if it is a condition;
941 /* ------------------------------------------------------------------------- */
942 /* Assembly operand types. */
943 /* ------------------------------------------------------------------------- */
945 /* For Z-machine... */
947 #define LONG_CONSTANT_OT 0 /* General constant */
948 #define SHORT_CONSTANT_OT 1 /* Constant in range 0 to 255 */
949 #define VARIABLE_OT 2 /* Variable (global, local or sp) */
950 #define OMITTED_OT 3 /* Value used in type field to indicate
951 that no operand is supplied */
952 #define EXPRESSION_OT 4 /* Meaning: to determine this value, run code
953 equivalent to the expression tree whose
954 root node-number is the value given */
958 /* #define OMITTED_OT 3 */ /* Same as above */
959 /* #define EXPRESSION_OT 4 */ /* Same as above */
960 #define CONSTANT_OT 5 /* Four-byte constant */
961 #define HALFCONSTANT_OT 6 /* Two-byte constant */
962 #define BYTECONSTANT_OT 7 /* One-byte constant */
963 #define ZEROCONSTANT_OT 8 /* Constant zero (no bytes of data) */
964 #define SYSFUN_OT 9 /* System function value */
965 #define DEREFERENCE_OT 10 /* Value at this address */
966 #define GLOBALVAR_OT 11 /* Global variable */
967 #define LOCALVAR_OT 12 /* Local variable or sp */
969 /* ------------------------------------------------------------------------- */
970 /* Internal numbers representing assemble-able Z-opcodes */
971 /* ------------------------------------------------------------------------- */
982 #define test_attr_zc 9
983 #define set_attr_zc 10
984 #define clear_attr_zc 11
986 #define insert_obj_zc 13
989 #define get_prop_zc 16
990 #define get_prop_addr_zc 17
991 #define get_next_prop_zc 18
1000 #define put_prop_zc 27
1002 #define print_char_zc 29
1003 #define print_num_zc 30
1004 #define random_zc 31
1007 #define split_window_zc 34
1008 #define set_window_zc 35
1009 #define output_stream_zc 36
1010 #define input_stream_zc 37
1011 #define sound_effect_zc 38
1013 #define get_sibling_zc 40
1014 #define get_child_zc 41
1015 #define get_parent_zc 42
1016 #define get_prop_len_zc 43
1019 #define print_addr_zc 46
1020 #define remove_obj_zc 47
1021 #define print_obj_zc 48
1024 #define print_paddr_zc 51
1028 #define rfalse_zc 55
1030 #define print_ret_zc 57
1033 #define restore_zc 60
1034 #define restart_zc 61
1035 #define ret_popped_zc 62
1038 #define new_line_zc 65
1039 #define show_status_zc 66
1040 #define verify_zc 67
1041 #define call_2s_zc 68
1042 #define call_vs_zc 69
1044 #define call_vs2_zc 71
1045 #define erase_window_zc 72
1046 #define erase_line_zc 73
1047 #define set_cursor_zc 74
1048 #define get_cursor_zc 75
1049 #define set_text_style_zc 76
1050 #define buffer_mode_zc 77
1051 #define read_char_zc 78
1052 #define scan_table_zc 79
1053 #define call_1s_zc 80
1054 #define call_2n_zc 81
1055 #define set_colour_zc 82
1057 #define call_vn_zc 84
1058 #define call_vn2_zc 85
1059 #define tokenise_zc 86
1060 #define encode_text_zc 87
1061 #define copy_table_zc 88
1062 #define print_table_zc 89
1063 #define check_arg_count_zc 90
1064 #define call_1n_zc 91
1066 #define piracy_zc 93
1067 #define log_shift_zc 94
1068 #define art_shift_zc 95
1069 #define set_font_zc 96
1070 #define save_undo_zc 97
1071 #define restore_undo_zc 98
1072 #define draw_picture_zc 99
1073 #define picture_data_zc 100
1074 #define erase_picture_zc 101
1075 #define set_margins_zc 102
1076 #define move_window_zc 103
1077 #define window_size_zc 104
1078 #define window_style_zc 105
1079 #define get_wind_prop_zc 106
1080 #define scroll_window_zc 107
1081 #define pop_stack_zc 108
1082 #define read_mouse_zc 109
1083 #define mouse_window_zc 110
1084 #define push_stack_zc 111
1085 #define put_wind_prop_zc 112
1086 #define print_form_zc 113
1087 #define make_menu_zc 114
1088 #define picture_table_zc 115
1089 #define print_unicode_zc 116
1090 #define check_unicode_zc 117
1093 /* ------------------------------------------------------------------------- */
1094 /* Internal numbers representing assemble-able Glulx opcodes */
1095 /* ------------------------------------------------------------------------- */
1107 #define bitnot_gc 10
1108 #define shiftl_gc 11
1109 #define sshiftr_gc 12
1110 #define ushiftr_gc 13
1125 #define return_gc 28
1128 #define tailcall_gc 31
1135 #define aloads_gc 38
1136 #define aloadb_gc 39
1137 #define aloadbit_gc 40
1138 #define astore_gc 41
1139 #define astores_gc 42
1140 #define astoreb_gc 43
1141 #define astorebit_gc 44
1142 #define stkcount_gc 45
1143 #define stkpeek_gc 46
1144 #define stkswap_gc 47
1145 #define stkroll_gc 48
1146 #define stkcopy_gc 49
1147 #define streamchar_gc 50
1148 #define streamnum_gc 51
1149 #define streamstr_gc 52
1150 #define gestalt_gc 53
1151 #define debugtrap_gc 54
1152 #define getmemsize_gc 55
1153 #define setmemsize_gc 56
1154 #define jumpabs_gc 57
1155 #define random_gc 58
1156 #define setrandom_gc 59
1158 #define verify_gc 61
1159 #define restart_gc 62
1161 #define restore_gc 64
1162 #define saveundo_gc 65
1163 #define restoreundo_gc 66
1164 #define protect_gc 67
1166 #define getstringtbl_gc 69
1167 #define setstringtbl_gc 70
1168 #define getiosys_gc 71
1169 #define setiosys_gc 72
1170 #define linearsearch_gc 73
1171 #define binarysearch_gc 74
1172 #define linkedsearch_gc 75
1174 #define callfi_gc 77
1175 #define callfii_gc 78
1176 #define callfiii_gc 79
1177 #define streamunichar_gc 80
1180 #define malloc_gc 83
1182 #define accelfunc_gc 85
1183 #define accelparam_gc 86
1184 #define numtof_gc 87
1185 #define ftonumz_gc 88
1186 #define ftonumn_gc 89
1204 #define atan2_gc 107
1211 #define jisnan_gc 114
1212 #define jisinf_gc 115
1214 /* ------------------------------------------------------------------------- */
1215 /* Index numbers into the keyword group "opcode_macros_g" (see "lexer.c") */
1216 /* ------------------------------------------------------------------------- */
1222 #define SYMBOL_TT 0 /* value = index in symbol table */
1223 #define NUMBER_TT 1 /* value = the number */
1224 #define DQ_TT 2 /* no value */
1225 #define SQ_TT 3 /* no value */
1226 #define SEP_TT 4 /* value = the _SEP code */
1227 #define EOF_TT 5 /* no value */
1229 #define STATEMENT_TT 100 /* a statement keyword */
1230 #define SEGMENT_MARKER_TT 101 /* with/has/class etc. */
1231 #define DIRECTIVE_TT 102 /* a directive keyword */
1232 #define CND_TT 103 /* in/has/etc. */
1233 #define SYSFUN_TT 105 /* built-in function */
1234 #define LOCAL_VARIABLE_TT 106 /* local variable */
1235 #define OPCODE_NAME_TT 107 /* opcode name */
1236 #define MISC_KEYWORD_TT 108 /* keyword like "char" used in
1237 syntax for a statement */
1238 #define DIR_KEYWORD_TT 109 /* keyword like "meta" used in
1239 syntax for a directive */
1240 #define TRACE_KEYWORD_TT 110 /* keyword used in debugging */
1241 #define SYSTEM_CONSTANT_TT 111 /* such as "code_offset" */
1242 #define OPCODE_MACRO_TT 112 /* fake opcode for compatibility */
1244 #define OP_TT 200 /* value = operator no */
1245 #define ENDEXP_TT 201 /* no value */
1246 #define SUBOPEN_TT 202 /* ( used for subexpr */
1247 #define SUBCLOSE_TT 203 /* ) used to close subexp */
1248 #define LARGE_NUMBER_TT 204 /* constant not in range 0-255 */
1249 #define SMALL_NUMBER_TT 205 /* constant in range 0-255 */
1250 /* In Glulx, that's the range -0x8000 to 0x7fff instead. */
1251 #define VARIABLE_TT 206 /* variable name */
1252 #define DICTWORD_TT 207 /* literal 'word' */
1253 #define ACTION_TT 208 /* action name */
1255 #define VOID_CONTEXT 1
1256 #define CONDITION_CONTEXT 2
1257 #define CONSTANT_CONTEXT 3
1258 #define QUANTITY_CONTEXT 4
1259 #define ACTION_Q_CONTEXT 5
1260 #define ASSEMBLY_CONTEXT 6
1261 #define ARRAY_CONTEXT 7
1262 #define FORINIT_CONTEXT 8
1263 #define RETURN_Q_CONTEXT 9
1265 #define LOWEST_SYSTEM_VAR_NUMBER 249 /* globals 249 to 255 are used
1266 in compiled code (Z-code
1267 only; in Glulx, the range can
1270 /* ------------------------------------------------------------------------- */
1271 /* Symbol flag definitions (in no significant order) */
1272 /* ------------------------------------------------------------------------- */
1274 #define UNKNOWN_SFLAG 1
1275 #define REPLACE_SFLAG 2
1276 #define USED_SFLAG 4
1277 #define DEFCON_SFLAG 8
1278 #define STUB_SFLAG 16
1279 #define IMPORT_SFLAG 32
1280 #define EXPORT_SFLAG 64
1281 #define ALIASED_SFLAG 128
1283 #define CHANGE_SFLAG 256
1284 #define SYSTEM_SFLAG 512
1285 #define INSF_SFLAG 1024
1286 #define UERROR_SFLAG 2048
1287 #define ACTION_SFLAG 4096
1288 #define REDEFINABLE_SFLAG 8192
1289 #define STAR_SFLAG 16384
1291 /* ------------------------------------------------------------------------- */
1292 /* Symbol type definitions */
1293 /* ------------------------------------------------------------------------- */
1297 #define GLOBAL_VARIABLE_T 3
1299 #define CONSTANT_T 5
1300 #define ATTRIBUTE_T 6
1301 #define PROPERTY_T 7
1302 #define INDIVIDUAL_PROPERTY_T 8
1305 #define FAKE_ACTION_T 11
1306 #define STATIC_ARRAY_T 12
1308 /* ------------------------------------------------------------------------- */
1309 /* Statusline_flag values */
1310 /* ------------------------------------------------------------------------- */
1312 #define SCORE_STYLE 0
1313 #define TIME_STYLE 1
1315 /* ------------------------------------------------------------------------- */
1316 /* Inform keyword definitions */
1317 /* ------------------------------------------------------------------------- */
1319 /* Index numbers into the keyword group "directives" (see "lexer.c") */
1321 #define ABBREVIATE_CODE 0
1322 #define ARRAY_CODE 1
1323 #define ATTRIBUTE_CODE 2
1324 #define CLASS_CODE 3
1325 #define CONSTANT_CODE 4
1326 #define DEFAULT_CODE 5
1327 #define DICTIONARY_CODE 6
1329 #define ENDIF_CODE 8
1330 #define EXTEND_CODE 9
1331 #define FAKE_ACTION_CODE 10
1332 #define GLOBAL_CODE 11
1333 #define IFDEF_CODE 12
1334 #define IFNDEF_CODE 13
1335 #define IFNOT_CODE 14
1336 #define IFV3_CODE 15
1337 #define IFV5_CODE 16
1338 #define IFTRUE_CODE 17
1339 #define IFFALSE_CODE 18
1340 #define IMPORT_CODE 19
1341 #define INCLUDE_CODE 20
1342 #define LINK_CODE 21
1343 #define LOWSTRING_CODE 22
1344 #define MESSAGE_CODE 23
1345 #define NEARBY_CODE 24
1346 #define OBJECT_CODE 25
1347 #define ORIGSOURCE_CODE 26
1348 #define PROPERTY_CODE 27
1349 #define RELEASE_CODE 28
1350 #define REPLACE_CODE 29
1351 #define SERIAL_CODE 30
1352 #define SWITCHES_CODE 31
1353 #define STATUSLINE_CODE 32
1354 #define STUB_CODE 33
1355 #define SYSTEM_CODE 34
1356 #define TRACE_CODE 35
1357 #define UNDEF_CODE 36
1358 #define VERB_CODE 37
1359 #define VERSION_CODE 38
1360 #define ZCHARACTER_CODE 39
1362 #define OPENBLOCK_CODE 100
1363 #define CLOSEBLOCK_CODE 101
1365 /* Index numbers into the keyword group "statements" (see "lexer.c") */
1368 #define BREAK_CODE 1
1369 #define CONTINUE_CODE 2
1370 #define SDEFAULT_CODE 3
1377 #define INVERSION_CODE 10
1378 #define JUMP_CODE 11
1379 #define MOVE_CODE 12
1380 #define NEW_LINE_CODE 13
1381 #define OBJECTLOOP_CODE 14
1382 #define PRINT_CODE 15
1383 #define PRINT_RET_CODE 16
1384 #define QUIT_CODE 17
1385 #define READ_CODE 18
1386 #define REMOVE_CODE 19
1387 #define RESTORE_CODE 20
1388 #define RETURN_CODE 21
1389 #define RFALSE_CODE 22
1390 #define RTRUE_CODE 23
1391 #define SAVE_CODE 24
1392 #define SPACES_CODE 25
1393 #define STRING_CODE 26
1394 #define STYLE_CODE 27
1395 #define SWITCH_CODE 28
1396 #define UNTIL_CODE 29
1397 #define WHILE_CODE 30
1399 #define ASSIGNMENT_CODE 100
1400 #define FUNCTION_CODE 101
1402 /* Index numbers into the keyword group "conditions" (see "lexer.c") */
1405 #define HASNT_COND 1
1407 #define NOTIN_COND 3
1408 #define OFCLASS_COND 4
1410 #define PROVIDES_COND 6
1412 /* Index numbers into the keyword group "segment_markers" (see "lexer.c") */
1414 #define CLASS_SEGMENT 0
1415 #define HAS_SEGMENT 1
1416 #define PRIVATE_SEGMENT 2
1417 #define WITH_SEGMENT 3
1419 /* Index numbers into the keyword group "misc_keywords" (see "lexer.c") */
1426 #define CAP_THE_MK 5
1429 #define REVERSE_MK 8
1431 #define UNDERLINE_MK 10
1436 #define ADDRESS_MK 15
1437 #define STRING_MK 16
1438 #define OBJECT_MK 17
1441 #define PROPERTY_MK 20
1444 /* Index numbers into the keyword group "directive_keywords" (see "lexer.c") */
1448 #define ADDITIVE_DK 2
1454 #define MULTIHELD_DK 8
1455 #define MULTIEXCEPT_DK 9
1456 #define MULTIINSIDE_DK 10
1457 #define CREATURE_DK 11
1458 #define SPECIAL_DK 12
1459 #define NUMBER_DK 13
1462 #define REVERSE_DK 16
1465 #define REPLACE_DK 19
1468 #define STRING_DK 22
1470 #define BUFFER_DK 24
1472 #define INITIAL_DK 26
1473 #define INITSTR_DK 27
1475 #define PRIVATE_DK 29
1479 #define FATALERROR_DK 33
1480 #define WARNING_DK 34
1481 #define TERMINATING_DK 35
1482 #define STATIC_DK 36
1484 /* Index numbers into the keyword group "trace_keywords" (see "lexer.c") */
1486 #define DICTIONARY_TK 0
1487 #define SYMBOLS_TK 1
1488 #define OBJECTS_TK 2
1490 #define ASSEMBLY_TK 4
1491 #define EXPRESSIONS_TK 5
1498 /* Index numbers into the keyword group "system_constants" (see "lexer.c") */
1500 #define NO_SYSTEM_CONSTANTS 62
1502 #define adjectives_table_SC 0
1503 #define actions_table_SC 1
1504 #define classes_table_SC 2
1505 #define identifiers_table_SC 3
1506 #define preactions_table_SC 4
1507 #define version_number_SC 5
1508 #define largest_object_SC 6
1509 #define strings_offset_SC 7
1510 #define code_offset_SC 8
1511 #define dict_par1_SC 9
1512 #define dict_par2_SC 10
1513 #define dict_par3_SC 11
1514 #define actual_largest_object_SC 12
1515 #define static_memory_offset_SC 13
1516 #define array_names_offset_SC 14
1517 #define readable_memory_offset_SC 15
1518 #define cpv__start_SC 16
1519 #define cpv__end_SC 17
1520 #define ipv__start_SC 18
1521 #define ipv__end_SC 19
1522 #define array__start_SC 20
1523 #define array__end_SC 21
1525 #define lowest_attribute_number_SC 22
1526 #define highest_attribute_number_SC 23
1527 #define attribute_names_array_SC 24
1529 #define lowest_property_number_SC 25
1530 #define highest_property_number_SC 26
1531 #define property_names_array_SC 27
1533 #define lowest_action_number_SC 28
1534 #define highest_action_number_SC 29
1535 #define action_names_array_SC 30
1537 #define lowest_fake_action_number_SC 31
1538 #define highest_fake_action_number_SC 32
1539 #define fake_action_names_array_SC 33
1541 #define lowest_routine_number_SC 34
1542 #define highest_routine_number_SC 35
1543 #define routines_array_SC 36
1544 #define routine_names_array_SC 37
1545 #define routine_flags_array_SC 38
1547 #define lowest_global_number_SC 39
1548 #define highest_global_number_SC 40
1549 #define globals_array_SC 41
1550 #define global_names_array_SC 42
1551 #define global_flags_array_SC 43
1553 #define lowest_array_number_SC 44
1554 #define highest_array_number_SC 45
1555 #define arrays_array_SC 46
1556 #define array_names_array_SC 47
1557 #define array_flags_array_SC 48
1559 #define lowest_constant_number_SC 49
1560 #define highest_constant_number_SC 50
1561 #define constants_array_SC 51
1562 #define constant_names_array_SC 52
1564 #define lowest_class_number_SC 53
1565 #define highest_class_number_SC 54
1566 #define class_objects_array_SC 55
1568 #define lowest_object_number_SC 56
1569 #define highest_object_number_SC 57
1571 #define oddeven_packing_SC 58
1573 #define grammar_table_SC 59 /* Glulx-only */
1574 #define dictionary_table_SC 60 /* Glulx-only */
1575 #define dynam_string_table_SC 61 /* Glulx-only */
1578 /* Index numbers into the keyword group "system_functions" (see "lexer.c") */
1580 #define NUMBER_SYSTEM_FUNCTIONS 12
1582 #define CHILD_SYSF 0
1583 #define CHILDREN_SYSF 1
1584 #define ELDER_SYSF 2
1585 #define ELDEST_SYSF 3
1586 #define INDIRECT_SYSF 4
1587 #define PARENT_SYSF 5
1588 #define RANDOM_SYSF 6
1589 #define SIBLING_SYSF 7
1590 #define YOUNGER_SYSF 8
1591 #define YOUNGEST_SYSF 9
1592 #define METACLASS_SYSF 10
1593 #define GLK_SYSF 11 /* Glulx-only */
1595 /* Index numbers into the operators group "separators" (see "lexer.c") */
1597 #define NUMBER_SEPARATORS 49
1600 #define DARROW_SEP 1
1606 #define DIVIDE_SEP 7
1607 #define REMAINDER_SEP 8
1609 #define ARTOR_SEP 10
1610 #define LOGAND_SEP 11
1611 #define ARTAND_SEP 12
1612 #define LOGNOT_SEP 13
1613 #define NOTEQUAL_SEP 14
1614 #define ARTNOT_SEP 15
1615 #define CONDEQUALS_SEP 16
1616 #define SETEQUALS_SEP 17
1618 #define GREATER_SEP 19
1621 #define OPENB_SEP 22
1622 #define CLOSEB_SEP 23
1623 #define COMMA_SEP 24
1624 #define PROPADD_SEP 25
1625 #define PROPNUM_SEP 26
1626 #define MPROPADD_SEP 27
1627 #define MPROPNUM_SEP 28
1628 #define MESSAGE_SEP 29
1629 #define PROPERTY_SEP 30
1630 #define SUPERCLASS_SEP 31
1631 #define COLON_SEP 32
1633 #define SEMICOLON_SEP 34
1634 #define OPEN_SQUARE_SEP 35
1635 #define CLOSE_SQUARE_SEP 36
1636 #define OPEN_BRACE_SEP 37
1637 #define CLOSE_BRACE_SEP 38
1638 #define DOLLAR_SEP 39
1639 #define NBRANCH_SEP 40
1640 #define BRANCH_SEP 41
1641 #define HASHADOLLAR_SEP 42
1642 #define HASHGDOLLAR_SEP 43
1643 #define HASHNDOLLAR_SEP 44
1644 #define HASHRDOLLAR_SEP 45
1645 #define HASHWDOLLAR_SEP 46
1646 #define HASHHASH_SEP 47
1649 #define UNARY_MINUS_SEP 100
1650 #define POST_INC_SEP 101
1651 #define POST_DEC_SEP 102
1653 /* ------------------------------------------------------------------------- */
1654 /* Internal numbers used to refer to operators (in expressions) */
1655 /* (must correspond to entries in the operators table in "express.c") */
1656 /* ------------------------------------------------------------------------- */
1658 #define NUM_OPERATORS 68
1668 #define SETEQUALS_OP 1
1674 #define NONZERO_OP 6
1675 #define CONDEQUALS_OP 7
1676 #define NOTEQUAL_OP 8
1678 #define GREATER_OP 10
1685 #define OFCLASS_OP 17
1686 #define PROVIDES_OP 18
1687 #define NOTOFCLASS_OP 19
1688 #define NOTPROVIDES_OP 20
1694 #define DIVIDE_OP 25
1695 #define REMAINDER_OP 26
1696 #define ARTAND_OP 27
1698 #define ARTNOT_OP 29
1700 #define DARROW_OP 31
1701 #define UNARY_MINUS_OP 32
1703 #define POST_INC_OP 34
1705 #define POST_DEC_OP 36
1706 #define PROP_ADD_OP 37
1707 #define PROP_NUM_OP 38
1708 #define MPROP_ADD_OP 39
1709 #define MPROP_NUM_OP 40
1711 #define MESSAGE_OP 42
1712 #define PROPERTY_OP 43
1713 #define SUPERCLASS_OP 44
1715 #define ARROW_SETEQUALS_OP 45
1716 #define DARROW_SETEQUALS_OP 46
1717 #define MESSAGE_SETEQUALS_OP 47
1718 #define PROPERTY_SETEQUALS_OP 48
1720 #define ARROW_INC_OP 49
1721 #define DARROW_INC_OP 50
1722 #define MESSAGE_INC_OP 51
1723 #define PROPERTY_INC_OP 52
1725 #define ARROW_DEC_OP 53
1726 #define DARROW_DEC_OP 54
1727 #define MESSAGE_DEC_OP 55
1728 #define PROPERTY_DEC_OP 56
1730 #define ARROW_POST_INC_OP 57
1731 #define DARROW_POST_INC_OP 58
1732 #define MESSAGE_POST_INC_OP 59
1733 #define PROPERTY_POST_INC_OP 60
1735 #define ARROW_POST_DEC_OP 61
1736 #define DARROW_POST_DEC_OP 62
1737 #define MESSAGE_POST_DEC_OP 63
1738 #define PROPERTY_POST_DEC_OP 64
1740 #define PROP_CALL_OP 65
1741 #define MESSAGE_CALL_OP 66
1743 #define PUSH_OP 67 /* Glulx only */
1745 /* ------------------------------------------------------------------------- */
1746 /* The five types of compiled array */
1747 /* ------------------------------------------------------------------------- */
1749 #define BYTE_ARRAY 0
1750 #define WORD_ARRAY 1
1751 #define STRING_ARRAY 2
1752 #define TABLE_ARRAY 3
1753 #define BUFFER_ARRAY 4
1755 /* ------------------------------------------------------------------------- */
1756 /* Internal numbers used to refer to veneer routines */
1757 /* (must correspond to entries in the table in "veneer.c") */
1758 /* ------------------------------------------------------------------------- */
1760 #define VENEER_ROUTINES 48
1762 #define Box__Routine_VR 0
1764 #define R_Process_VR 1
1766 #define InDefArt_VR 3
1767 #define CDefArt_VR 4
1768 #define CInDefArt_VR 5
1769 #define PrintShortName_VR 6
1770 #define EnglishNumber_VR 7
1771 #define Print__Pname_VR 8
1774 #define RV__Pr_VR 10
1775 #define CA__Pr_VR 11
1776 #define IB__Pr_VR 12
1777 #define IA__Pr_VR 13
1778 #define DB__Pr_VR 14
1779 #define DA__Pr_VR 15
1780 #define RA__Pr_VR 16
1781 #define RL__Pr_VR 17
1782 #define RA__Sc_VR 18
1783 #define OP__Pr_VR 19
1784 #define OC__Cl_VR 20
1786 #define Copy__Primitive_VR 21
1787 #define RT__Err_VR 22
1788 #define Z__Region_VR 23
1789 #define Unsigned__Compare_VR 24
1790 #define Metaclass_VR 25
1791 #define CP__Tab_VR 26
1792 #define Cl__Ms_VR 27
1793 #define RT__ChT_VR 28
1794 #define RT__ChR_VR 29
1795 #define RT__ChG_VR 30
1796 #define RT__ChGt_VR 31
1797 #define RT__ChPS_VR 32
1798 #define RT__ChPR_VR 33
1799 #define RT__TrPS_VR 34
1800 #define RT__ChLDB_VR 35
1801 #define RT__ChLDW_VR 36
1802 #define RT__ChSTB_VR 37
1803 #define RT__ChSTW_VR 38
1804 #define RT__ChPrintC_VR 39
1805 #define RT__ChPrintA_VR 40
1806 #define RT__ChPrintS_VR 41
1807 #define RT__ChPrintO_VR 42
1809 /* Glulx-only veneer routines */
1810 #define OB__Move_VR 43
1811 #define OB__Remove_VR 44
1812 #define Print__Addr_VR 45
1813 #define Glk__Wrap_VR 46
1814 #define Dynam__String_VR 47
1816 /* ------------------------------------------------------------------------- */
1817 /* Run-time-error numbers (must correspond with RT__Err code in veneer) */
1818 /* ------------------------------------------------------------------------- */
1822 #define PARENT_RTE 4
1823 #define ELDEST_RTE 5
1825 #define YOUNGER_RTE 7
1826 #define SIBLING_RTE 8
1827 #define CHILDREN_RTE 9
1828 #define YOUNGEST_RTE 10
1829 #define ELDER_RTE 11
1830 #define OBJECTLOOP_RTE 12
1831 #define OBJECTLOOP2_RTE 13
1833 #define REMOVE_RTE 15
1834 #define MOVE1_RTE 16
1835 #define MOVE2_RTE 17
1836 /* 18 = creating a loop in object tree */
1837 /* 19 = giving a non-existent attribute */
1838 #define DBYZERO_RTE 20
1839 #define PROP_ADD_RTE 21
1840 #define PROP_NUM_RTE 22
1841 #define PROPERTY_RTE 23
1842 /* 24 = reading with -> out of range */
1843 /* 25 = reading with --> out of range */
1844 /* 26 = writing with -> out of range */
1845 /* 27 = writing with --> out of range */
1846 #define ABOUNDS_RTE 28
1847 /* similarly 29, 30, 31 */
1848 #define OBJECTLOOP_BROKEN_RTE 32
1849 /* 33 = print (char) out of range */
1850 /* 34 = print (address) out of range */
1851 /* 35 = print (string) out of range */
1852 /* 36 = print (object) out of range */
1854 /* ------------------------------------------------------------------------- */
1855 /* Z-region areas (used to refer to module positions in markers) */
1856 /* ------------------------------------------------------------------------- */
1858 #define LOW_STRINGS_ZA 1
1859 #define PROP_DEFAULTS_ZA 2
1860 #define OBJECT_TREE_ZA 3
1862 #define CLASS_NUMBERS_ZA 5
1863 #define INDIVIDUAL_PROP_ZA 6
1864 #define DYNAMIC_ARRAY_ZA 7
1865 #define GRAMMAR_ZA 8
1866 #define ACTIONS_ZA 9
1867 #define PREACTIONS_ZA 10
1868 #define ADJECTIVES_ZA 11
1869 #define DICTIONARY_ZA 12
1871 #define STATIC_STRINGS_ZA 14
1872 #define LINK_DATA_ZA 15
1874 #define SYMBOLS_ZA 16
1875 #define STATIC_ARRAY_ZA 17 /* Z-code only */
1876 #define GLOBALVAR_ZA 18 /* Glulx only */
1878 /* ------------------------------------------------------------------------- */
1879 /* "Marker values", used for backpatching and linkage */
1880 /* ------------------------------------------------------------------------- */
1882 #define NULL_MV 0 /* Null */
1884 /* Marker values used in backpatch areas: */
1886 #define DWORD_MV 1 /* Dictionary word address */
1887 #define STRING_MV 2 /* Static string */
1888 #define INCON_MV 3 /* "Hardware" constant (table address) */
1889 #define IROUTINE_MV 4 /* Call to internal routine */
1890 #define VROUTINE_MV 5 /* Call to veneer routine */
1891 #define ARRAY_MV 6 /* Ref to internal dynam array address */
1892 #define NO_OBJS_MV 7 /* Ref to number of game objects */
1893 #define INHERIT_MV 8 /* Inherited property value */
1894 #define INHERIT_INDIV_MV 9 /* Inherited indiv property value */
1895 #define MAIN_MV 10 /* "Main" routine */
1896 #define SYMBOL_MV 11 /* Forward ref to unassigned symbol */
1898 /* Additional marker values used in module backpatch areas: */
1899 /* (In Glulx, OBJECT_MV and VARIABLE_MV are used in backpatching, even
1900 without modules.) */
1902 #define VARIABLE_MV 12 /* Global variable */
1903 #define IDENT_MV 13 /* Property identifier number */
1904 #define INDIVPT_MV 14 /* Individual prop table address */
1905 #define ACTION_MV 15 /* Action number */
1906 #define OBJECT_MV 16 /* Ref to internal object number */
1907 #define STATIC_ARRAY_MV 17 /* Ref to internal static array address */
1909 #define LARGEST_BPATCH_MV 17 /* Larger marker values are never written
1910 to backpatch tables */
1912 /* Value indicating an imported symbol record: */
1914 #define IMPORT_MV 32
1916 /* Values indicating an exported symbol record: */
1918 #define EXPORT_MV 33 /* Defined ordinarily */
1919 #define EXPORTSF_MV 34 /* Defined in a system file */
1920 #define EXPORTAC_MV 35 /* Action name */
1922 /* Values used only in branch backpatching: */
1923 /* ###-I've rearranged these, so that BRANCH_MV can be last; Glulx uses the
1924 whole range from BRANCH_MV to BRANCHMAX_MV. */
1926 #define LABEL_MV 36 /* Ditto: marks "jump" operands */
1927 #define DELETED_MV 37 /* Ditto: marks bytes deleted from code */
1928 #define BRANCH_MV 38 /* Used in "asm.c" for routine coding */
1929 #define BRANCHMAX_MV 58 /* In fact, the range BRANCH_MV to
1930 BRANCHMAX_MV all means the same thing.
1931 The position within the range means
1932 how far back from the label to go
1933 to find the opmode byte to modify. */
1935 /* ========================================================================= */
1936 /* Initialisation extern definitions */
1938 /* Note that each subsystem in Inform provides four routines to keep */
1939 /* track of variables and data structures: */
1941 /* init_*_vars should set variables to initial values (they must */
1942 /* not be initialised directly in their declarations */
1943 /* as Inform may need to compile several times in a */
1946 /* *_begin_pass any variable/array initialisation that needs to */
1947 /* happen at the start of the pass through the source */
1949 /* *_allocate_arrays should use my_malloc/my_calloc (see memory.c) */
1950 /* to allocate any arrays or workspace needed */
1952 /* *_free_arrays should use my_free to free all memory allocated */
1953 /* (with one exception in "text.c") */
1955 /* ========================================================================= */
1957 /* > READ INFORM SOURCE */
1959 /* My Source Book */
1961 extern void init_arrays_vars(void); /* arrays: construct tableaux */
1962 extern void init_asm_vars(void); /* asm: assemble even rare or v6 codes */
1963 extern void init_bpatch_vars(void); /* bpatch: backpatches code */
1964 extern void init_chars_vars(void); /* chars: translate character sets */
1965 extern void init_directs_vars(void); /* directs: ponder directives */
1966 extern void init_errors_vars(void); /* errors: issue diagnostics */
1967 extern void init_expressc_vars(void); /* expressc: compile expressions */
1968 extern void init_expressp_vars(void); /* expressp: parse expressions */
1969 extern void init_files_vars(void); /* files: handle files */
1970 /* void init_vars(void); inform: decide what to do */
1971 extern void init_lexer_vars(void); /* lexer: lexically analyse source */
1972 extern void init_linker_vars(void); /* linker: link in pre-compiled module */
1973 extern void init_memory_vars(void); /* memory: manage memory settings */
1974 extern void init_objects_vars(void); /* objects: cultivate object tree */
1975 extern void init_states_vars(void); /* states: translate statements to code*/
1976 extern void init_symbols_vars(void); /* symbols: construct symbols table */
1977 extern void init_syntax_vars(void); /* syntax: parse the program */
1978 extern void init_tables_vars(void); /* tables: glue tables into the output */
1979 extern void init_text_vars(void); /* text: encode text and dictionary */
1980 extern void init_veneer_vars(void); /* veneer: compile a layer of code */
1981 extern void init_verbs_vars(void); /* verbs: lay out grammar */
1983 extern void files_begin_prepass(void); /* These routines initialise just */
1984 extern void lexer_begin_prepass(void); /* enough to begin loading source */
1986 extern void arrays_begin_pass(void);
1987 extern void asm_begin_pass(void);
1988 extern void bpatch_begin_pass(void);
1989 extern void chars_begin_pass(void);
1990 extern void directs_begin_pass(void);
1991 extern void errors_begin_pass(void);
1992 extern void expressc_begin_pass(void);
1993 extern void expressp_begin_pass(void);
1994 extern void files_begin_pass(void);
1995 /* void begin_pass(void); */
1996 extern void lexer_begin_pass(void);
1997 extern void linker_begin_pass(void);
1998 extern void memory_begin_pass(void);
1999 extern void objects_begin_pass(void);
2000 extern void states_begin_pass(void);
2001 extern void symbols_begin_pass(void);
2002 extern void syntax_begin_pass(void);
2003 extern void tables_begin_pass(void);
2004 extern void text_begin_pass(void);
2005 extern void veneer_begin_pass(void);
2006 extern void verbs_begin_pass(void);
2008 extern void lexer_endpass(void);
2009 extern void linker_endpass(void);
2011 extern void arrays_allocate_arrays(void);
2012 extern void asm_allocate_arrays(void);
2013 extern void bpatch_allocate_arrays(void);
2014 extern void chars_allocate_arrays(void);
2015 extern void directs_allocate_arrays(void);
2016 extern void errors_allocate_arrays(void);
2017 extern void expressc_allocate_arrays(void);
2018 extern void expressp_allocate_arrays(void);
2019 extern void files_allocate_arrays(void);
2020 /* void allocate_arrays(void); */
2021 extern void lexer_allocate_arrays(void);
2022 extern void linker_allocate_arrays(void);
2023 extern void memory_allocate_arrays(void);
2024 extern void objects_allocate_arrays(void);
2025 extern void states_allocate_arrays(void);
2026 extern void symbols_allocate_arrays(void);
2027 extern void syntax_allocate_arrays(void);
2028 extern void tables_allocate_arrays(void);
2029 extern void text_allocate_arrays(void);
2030 extern void veneer_allocate_arrays(void);
2031 extern void verbs_allocate_arrays(void);
2033 extern void arrays_free_arrays(void);
2034 extern void asm_free_arrays(void);
2035 extern void bpatch_free_arrays(void);
2036 extern void chars_free_arrays(void);
2037 extern void directs_free_arrays(void);
2038 extern void errors_free_arrays(void);
2039 extern void expressc_free_arrays(void);
2040 extern void expressp_free_arrays(void);
2041 extern void files_free_arrays(void);
2042 /* void free_arrays(void); */
2043 extern void lexer_free_arrays(void);
2044 extern void linker_free_arrays(void);
2045 extern void memory_free_arrays(void);
2046 extern void objects_free_arrays(void);
2047 extern void states_free_arrays(void);
2048 extern void symbols_free_arrays(void);
2049 extern void syntax_free_arrays(void);
2050 extern void tables_free_arrays(void);
2051 extern void text_free_arrays(void);
2052 extern void veneer_free_arrays(void);
2053 extern void verbs_free_arrays(void);
2055 /* ========================================================================= */
2056 /* Remaining extern definitions are given by file in alphabetical order */
2057 /* ------------------------------------------------------------------------- */
2058 /* Extern definitions for "arrays" */
2059 /* ------------------------------------------------------------------------- */
2061 extern int no_globals, no_arrays;
2062 extern int dynamic_array_area_size;
2063 extern int *dynamic_array_area;
2064 extern int static_array_area_size;
2065 extern int *static_array_area;
2066 extern int32 *global_initial_value;
2067 extern int32 *array_symbols;
2068 extern int *array_sizes, *array_types, *array_locs;
2070 extern void make_global(int array_flag, int name_only);
2071 extern void set_variable_value(int i, int32 v);
2072 extern void check_globals(void);
2073 extern int32 begin_table_array(void);
2074 extern int32 begin_word_array(void);
2075 extern void array_entry(int32 i, int is_static, assembly_operand VAL);
2076 extern void finish_array(int32 i, int is_static);
2078 /* ------------------------------------------------------------------------- */
2079 /* Extern definitions for "asm" */
2080 /* ------------------------------------------------------------------------- */
2082 extern memory_block zcode_area;
2083 extern int32 zmachine_pc;
2085 extern int32 no_instructions;
2086 extern int sequence_point_follows;
2087 extern int uses_unicode_features, uses_memheap_features,
2088 uses_acceleration_features, uses_float_features;
2089 extern debug_location statement_debug_location;
2090 extern int execution_never_reaches_here;
2091 extern int *variable_usage;
2092 extern int next_label, no_sequence_points;
2093 extern int32 *variable_tokens;
2094 extern assembly_instruction AI;
2095 extern int32 *named_routine_symbols;
2097 extern void print_operand(assembly_operand o);
2098 extern char *variable_name(int32 i);
2099 extern void set_constant_ot(assembly_operand *AO);
2100 extern int is_constant_ot(int otval);
2101 extern int is_variable_ot(int otval);
2102 extern void assemblez_instruction(assembly_instruction *a);
2103 extern void assembleg_instruction(assembly_instruction *a);
2104 extern void assemble_label_no(int n);
2105 extern void assemble_jump(int n);
2106 extern void define_symbol_label(int symbol);
2107 extern int32 assemble_routine_header(int no_locals, int debug_flag,
2108 char *name, int embedded_flag, int the_symbol);
2109 extern void assemble_routine_end(int embedded_flag, debug_locations locations);
2111 extern void assemblez_0(int internal_number);
2112 extern void assemblez_0_to(int internal_number, assembly_operand o1);
2113 extern void assemblez_0_branch(int internal_number, int label, int flag);
2114 extern void assemblez_1(int internal_number, assembly_operand o1);
2115 extern void assemblez_1_to(int internal_number,
2116 assembly_operand o1, assembly_operand st);
2117 extern void assemblez_1_branch(int internal_number,
2118 assembly_operand o1, int label, int flag);
2119 extern void assemblez_objcode(int internal_number,
2120 assembly_operand o1, assembly_operand st,
2121 int label, int flag);
2122 extern void assemblez_2(int internal_number,
2123 assembly_operand o1, assembly_operand o2);
2124 extern void assemblez_2_to(int internal_number,
2125 assembly_operand o1, assembly_operand o2,
2126 assembly_operand st);
2127 extern void assemblez_2_branch(int internal_number,
2128 assembly_operand o1, assembly_operand o2,
2129 int label, int flag);
2130 extern void assemblez_3(int internal_number,
2131 assembly_operand o1, assembly_operand o2,
2132 assembly_operand o3);
2133 extern void assemblez_3_branch(int internal_number,
2134 assembly_operand o1, assembly_operand o2,
2135 assembly_operand o3, int label, int flag);
2136 extern void assemblez_3_to(int internal_number,
2137 assembly_operand o1, assembly_operand o2,
2138 assembly_operand o3, assembly_operand st);
2139 extern void assemblez_4(int internal_number,
2140 assembly_operand o1, assembly_operand o2,
2141 assembly_operand o3, assembly_operand o4);
2142 extern void assemblez_5(int internal_number,
2143 assembly_operand o1, assembly_operand o2,
2144 assembly_operand o3, assembly_operand o4,
2145 assembly_operand o5);
2146 extern void assemblez_6(int internal_number,
2147 assembly_operand o1, assembly_operand o2,
2148 assembly_operand o3, assembly_operand o4,
2149 assembly_operand o5, assembly_operand o6);
2150 extern void assemblez_4_branch(int internal_number,
2151 assembly_operand o1, assembly_operand o2,
2152 assembly_operand o3, assembly_operand o4,
2153 int label, int flag);
2154 extern void assemblez_4_to(int internal_number,
2155 assembly_operand o1, assembly_operand o2,
2156 assembly_operand o3, assembly_operand o4,
2157 assembly_operand st);
2158 extern void assemblez_5_to(int internal_number,
2159 assembly_operand o1, assembly_operand o2,
2160 assembly_operand o3, assembly_operand o4,
2161 assembly_operand o5, assembly_operand st);
2163 extern void assemblez_inc(assembly_operand o1);
2164 extern void assemblez_dec(assembly_operand o1);
2165 extern void assemblez_store(assembly_operand o1, assembly_operand o2);
2166 extern void assemblez_jump(int n);
2168 extern void assembleg_0(int internal_number);
2169 extern void assembleg_1(int internal_number, assembly_operand o1);
2170 extern void assembleg_2(int internal_number, assembly_operand o1,
2171 assembly_operand o2);
2172 extern void assembleg_3(int internal_number, assembly_operand o1,
2173 assembly_operand o2, assembly_operand o3);
2174 extern void assembleg_4(int internal_number, assembly_operand o1,
2175 assembly_operand o2, assembly_operand o3, assembly_operand o4);
2176 extern void assembleg_5(int internal_number, assembly_operand o1,
2177 assembly_operand o2, assembly_operand o3, assembly_operand o4,
2178 assembly_operand o5);
2179 extern void assembleg_0_branch(int internal_number,
2181 extern void assembleg_1_branch(int internal_number,
2182 assembly_operand o1, int label);
2183 extern void assembleg_2_branch(int internal_number,
2184 assembly_operand o1, assembly_operand o2, int label);
2185 extern void assembleg_call_1(assembly_operand oaddr, assembly_operand o1,
2186 assembly_operand odest);
2187 extern void assembleg_call_2(assembly_operand oaddr, assembly_operand o1,
2188 assembly_operand o2, assembly_operand odest);
2189 extern void assembleg_call_3(assembly_operand oaddr, assembly_operand o1,
2190 assembly_operand o2, assembly_operand o3, assembly_operand odest);
2191 extern void assembleg_inc(assembly_operand o1);
2192 extern void assembleg_dec(assembly_operand o1);
2193 extern void assembleg_store(assembly_operand o1, assembly_operand o2);
2194 extern void assembleg_jump(int n);
2196 extern void parse_assembly(void);
2198 /* ------------------------------------------------------------------------- */
2199 /* Extern definitions for "bpatch" */
2200 /* ------------------------------------------------------------------------- */
2202 extern memory_block zcode_backpatch_table, staticarray_backpatch_table,
2203 zmachine_backpatch_table;
2204 extern int32 zcode_backpatch_size, staticarray_backpatch_size,
2205 zmachine_backpatch_size;
2206 extern int backpatch_marker, backpatch_error_flag;
2208 extern int32 backpatch_value(int32 value);
2209 extern void backpatch_zmachine_image_z(void);
2210 extern void backpatch_zmachine_image_g(void);
2211 extern void backpatch_zmachine(int mv, int zmachine_area, int32 offset);
2213 /* ------------------------------------------------------------------------- */
2214 /* Extern definitions for "chars" */
2215 /* ------------------------------------------------------------------------- */
2217 extern uchar source_to_iso_grid[];
2218 extern int32 iso_to_unicode_grid[];
2219 extern int character_digit_value[];
2220 extern uchar alphabet[3][27];
2221 extern int alphabet_modified;
2222 extern int zscii_defn_modified;
2223 extern int zscii_high_water_mark;
2224 extern char alphabet_used[];
2225 extern int iso_to_alphabet_grid[];
2226 extern int zscii_to_alphabet_grid[];
2227 extern int textual_form_length;
2229 extern int iso_to_unicode(int iso);
2230 extern int unicode_to_zscii(int32 u);
2231 extern int32 zscii_to_unicode(int z);
2232 extern int32 text_to_unicode(char *text);
2233 extern void zscii_to_text(char *text, int zscii);
2234 extern char *name_of_iso_set(int s);
2235 extern void change_character_set(void);
2236 extern void new_alphabet(char *text, int alphabet);
2237 extern void new_zscii_character(int32 unicode, int plus_flag);
2238 extern void new_zscii_finished(void);
2239 extern void map_new_zchar(int32 unicode);
2240 extern void make_lower_case(char *str);
2241 extern void make_upper_case(char *str);
2243 /* ------------------------------------------------------------------------- */
2244 /* Extern definitions for "directs" */
2245 /* ------------------------------------------------------------------------- */
2247 extern brief_location routine_starts_line;
2249 extern int no_routines, no_named_routines, no_locals, no_termcs;
2250 extern int terminating_characters[];
2252 extern int parse_given_directive(int internal_flag);
2254 /* ------------------------------------------------------------------------- */
2255 /* Extern definitions for "errors" */
2256 /* ------------------------------------------------------------------------- */
2258 extern char *forerrors_buff;
2259 extern int forerrors_pointer;
2260 extern int no_errors, no_warnings, no_suppressed_warnings,
2261 no_link_errors, no_compiler_errors;
2263 extern ErrorPosition ErrorReport;
2265 extern void fatalerror(char *s) NORETURN;
2266 extern void fatalerror_named(char *s1, char *s2) NORETURN;
2267 extern void memory_out_error(int32 size, int32 howmany, char *name) NORETURN;
2268 extern void memoryerror(char *s, int32 size) NORETURN;
2269 extern void error(char *s);
2270 extern void error_named(char *s1, char *s2);
2271 extern void error_numbered(char *s1, int val);
2272 extern void error_named_at(char *s1, char *s2, brief_location report_line);
2273 extern void ebf_error(char *s1, char *s2);
2274 extern void char_error(char *s, int ch);
2275 extern void unicode_char_error(char *s, int32 uni);
2276 extern void no_such_label(char *lname);
2277 extern void warning(char *s);
2278 extern void warning_numbered(char *s1, int val);
2279 extern void warning_named(char *s1, char *s2);
2280 extern void dbnu_warning(char *type, char *name, brief_location report_line);
2281 extern void uncalled_routine_warning(char *type, char *name, brief_location report_line);
2282 extern void obsolete_warning(char *s1);
2283 extern void link_error(char *s);
2284 extern void link_error_named(char *s1, char *s2);
2285 extern int compiler_error(char *s);
2286 extern int compiler_error_named(char *s1, char *s2);
2287 extern void print_sorry_message(void);
2289 #ifdef ARC_THROWBACK
2290 extern int throwback_switch;
2292 extern void throwback(int severity, char * error);
2293 extern void throwback_start(void);
2294 extern void throwback_end(void);
2297 /* ------------------------------------------------------------------------- */
2298 /* Extern definitions for "expressc" */
2299 /* ------------------------------------------------------------------------- */
2301 extern int vivc_flag;
2302 extern operator operators[];
2304 extern assembly_operand stack_pointer, temp_var1, temp_var2, temp_var3,
2305 temp_var4, zero_operand, one_operand, two_operand, three_operand,
2306 four_operand, valueless_operand;
2308 assembly_operand code_generate(assembly_operand AO, int context, int label);
2309 assembly_operand check_nonzero_at_runtime(assembly_operand AO1, int label,
2312 /* ------------------------------------------------------------------------- */
2313 /* Extern definitions for "expressp" */
2314 /* ------------------------------------------------------------------------- */
2316 extern int system_function_usage[];
2317 extern expression_tree_node *ET;
2319 extern int z_system_constant_list[];
2320 extern int glulx_system_constant_list[];
2322 extern int32 value_of_system_constant(int t);
2323 extern void clear_expression_space(void);
2324 extern void show_tree(assembly_operand AO, int annotate);
2325 extern assembly_operand parse_expression(int context);
2326 extern int test_for_incdec(assembly_operand AO);
2328 /* ------------------------------------------------------------------------- */
2329 /* Extern definitions for "files" */
2330 /* ------------------------------------------------------------------------- */
2332 extern int total_files;
2333 extern int current_input_file;
2334 extern int total_input_files;
2335 extern FileId *InputFiles;
2337 extern FILE *Temp1_fp, *Temp2_fp, *Temp3_fp;
2338 extern char Temp1_Name[], Temp2_Name[], Temp3_Name[];
2339 extern int32 total_chars_read;
2341 extern void open_temporary_files(void);
2342 extern void check_temp_files(void);
2343 extern void remove_temp_files(void);
2345 extern void open_transcript_file(char *what_of);
2346 extern void write_to_transcript_file(char *text);
2347 extern void close_transcript_file(void);
2348 extern void abort_transcript_file(void);
2350 extern void nullify_debug_file_position(maybe_file_position *position);
2352 extern void begin_debug_file(void);
2354 extern void debug_file_printf(const char*format, ...);
2355 extern void debug_file_print_with_entities(const char*string);
2356 extern void debug_file_print_base_64_triple
2357 (uchar first, uchar second, uchar third);
2358 extern void debug_file_print_base_64_pair(uchar first, uchar second);
2359 extern void debug_file_print_base_64_single(uchar first);
2361 extern void write_debug_location(debug_location location);
2362 extern void write_debug_locations(debug_locations locations);
2363 extern void write_debug_optional_identifier(int32 symbol_index);
2364 extern void write_debug_symbol_backpatch(int32 symbol_index);
2365 extern void write_debug_symbol_optional_backpatch(int32 symbol_index);
2366 extern void write_debug_object_backpatch(int32 object_number);
2367 extern void write_debug_packed_code_backpatch(int32 offset);
2368 extern void write_debug_code_backpatch(int32 offset);
2369 extern void write_debug_global_backpatch(int32 offset);
2370 extern void write_debug_array_backpatch(int32 offset);
2371 extern void write_debug_grammar_backpatch(int32 offset);
2373 extern void begin_writing_debug_sections(void);
2374 extern void write_debug_section(const char*name, int32 beginning_address);
2375 extern void end_writing_debug_sections(int32 end_address);
2377 extern void write_debug_undef(int32 symbol_index);
2379 extern void end_debug_file(void);
2381 extern void add_to_checksum(void *address);
2383 extern void load_sourcefile(char *story_name, int style);
2384 extern int file_load_chars(int file_number, char *buffer, int length);
2385 extern void close_all_source(void);
2386 extern int register_orig_sourcefile(char *filename);
2388 extern void output_file(void);
2390 /* ------------------------------------------------------------------------- */
2391 /* Extern definitions for "inform" */
2392 /* ------------------------------------------------------------------------- */
2394 extern char Code_Name[];
2395 extern int endofpass_flag;
2397 extern int version_number, instruction_set_number, extend_memory_map;
2398 extern int32 scale_factor, length_scale_factor;
2400 extern int WORDSIZE, INDIV_PROP_START,
2401 OBJECT_BYTE_LENGTH, DICT_ENTRY_BYTE_LENGTH, DICT_ENTRY_FLAG_POS;
2402 extern int32 MAXINTWORD;
2404 extern int asm_trace_level, line_trace_level, expr_trace_level,
2405 linker_trace_level, tokens_trace_level;
2408 bothpasses_switch, concise_switch,
2409 economy_switch, frequencies_switch,
2410 ignore_switches_switch, listobjects_switch, debugfile_switch,
2411 listing_switch, memout_switch, printprops_switch,
2412 offsets_switch, percentages_switch, obsolete_switch,
2413 transcript_switch, statistics_switch, optimise_switch,
2414 version_set_switch, nowarnings_switch, hash_switch,
2415 memory_map_switch, module_switch, temporary_files_switch,
2416 define_DEBUG_switch, define_USE_MODULES_switch, define_INFIX_switch,
2417 runtime_error_checking_switch;
2419 extern int oddeven_packing_switch;
2421 extern int glulx_mode, compression_switch;
2422 extern int32 requested_glulx_version;
2424 extern int error_format, store_the_text, asm_trace_setting,
2425 double_space_setting, trace_fns_setting, character_set_setting,
2426 character_set_unicode;
2428 extern char Debugging_Name[];
2429 extern char Transcript_Name[];
2430 extern char Language_Name[];
2431 extern char Charset_Map[];
2433 extern char banner_line[];
2435 extern void select_version(int vn);
2436 extern void switches(char *, int);
2437 extern int translate_in_filename(int last_value, char *new_name, char *old_name,
2438 int same_directory_flag, int command_line_flag);
2439 extern void translate_out_filename(char *new_name, char *old_name);
2440 extern int translate_link_filename(int last_value,
2441 char *new_name, char *old_name);
2442 extern void translate_temp_filename(int i);
2445 extern char *riscos_file_type(void);
2448 /* For the benefit of the MAC_FACE port these are declared extern, though
2449 unused outside "inform" in the compiler itself */
2451 extern void allocate_arrays(void);
2452 extern void free_arrays(void);
2454 /* ------------------------------------------------------------------------- */
2455 /* Extern definitions for "lexer" */
2456 /* ------------------------------------------------------------------------- */
2458 extern int hash_printed_since_newline;
2459 extern int total_source_line_count;
2460 extern int dont_enter_into_symbol_table;
2461 extern int return_sp_as_variable;
2462 extern int next_token_begins_syntax_line;
2463 extern char **local_variable_texts;
2465 extern int32 token_value;
2466 extern int token_type;
2467 extern char *token_text;
2469 extern debug_location get_token_location(void);
2470 extern debug_locations get_token_locations(void);
2471 extern debug_location_beginning get_token_location_beginning(void);
2472 extern void discard_token_location(debug_location_beginning beginning);
2473 extern debug_locations get_token_location_end(debug_location_beginning beginning);
2475 extern void describe_token(token_data t);
2477 extern void construct_local_variable_tables(void);
2478 extern void declare_systemfile(void);
2479 extern int is_systemfile(void);
2480 extern void report_errors_at_current_line(void);
2481 extern debug_location get_current_debug_location(void);
2482 extern debug_location get_error_report_debug_location(void);
2483 extern int32 get_current_line_start(void);
2484 extern void set_origsource_location(char *source, int32 line, int32 charnum);
2485 extern brief_location get_brief_location(ErrorPosition *errpos);
2486 extern void export_brief_location(brief_location loc, ErrorPosition *errpos);
2487 extern brief_location blank_brief_location;
2489 extern void put_token_back(void);
2490 extern void get_next_token(void);
2491 extern void restart_lexer(char *lexical_source, char *name);
2493 extern keyword_group directives, statements, segment_markers,
2494 conditions, system_functions, local_variables, opcode_names,
2495 misc_keywords, directive_keywords, trace_keywords, system_constants,
2498 /* ------------------------------------------------------------------------- */
2499 /* Extern definitions for "linker" */
2500 /* ------------------------------------------------------------------------- */
2502 extern memory_block link_data_area;
2503 extern int32 link_data_size;
2504 extern char current_module_filename[];
2506 extern char *describe_mv(int mval);
2507 extern void write_link_marker(int zmachine_area, int32 offset,
2508 assembly_operand op);
2509 extern void flush_link_data(void);
2510 extern void import_symbol(int32 symbol_number);
2511 extern void export_symbol(int32 symbol_number);
2512 extern void export_symbol_name(int32 i);
2513 extern void link_module(char *filename);
2515 /* ------------------------------------------------------------------------- */
2516 /* Extern definitions for "memory" */
2517 /* ------------------------------------------------------------------------- */
2519 extern int32 malloced_bytes;
2521 extern int MAX_QTEXT_SIZE, MAX_SYMBOLS, HASH_TAB_SIZE, MAX_DICT_ENTRIES,
2522 MAX_OBJECTS, MAX_ACTIONS, MAX_ADJECTIVES, MAX_ABBREVS,
2523 MAX_STATIC_DATA, MAX_PROP_TABLE_SIZE, SYMBOLS_CHUNK_SIZE,
2524 MAX_EXPRESSION_NODES, MAX_LABELS, MAX_LINESPACE,
2525 MAX_LOW_STRINGS, MAX_CLASSES, MAX_VERBS,
2526 MAX_VERBSPACE, MAX_ARRAYS, MAX_INCLUSION_DEPTH,
2529 extern int32 MAX_STATIC_STRINGS, MAX_ZCODE_SIZE, MAX_LINK_DATA_SIZE,
2530 MAX_TRANSCRIPT_SIZE, MAX_INDIV_PROP_TABLE_SIZE,
2531 MAX_NUM_STATIC_STRINGS, MAX_UNICODE_CHARS,
2532 MAX_STACK_SIZE, MEMORY_MAP_EXTENSION;
2534 extern int32 MAX_OBJ_PROP_COUNT, MAX_OBJ_PROP_TABLE_SIZE;
2535 extern int MAX_LOCAL_VARIABLES, MAX_GLOBAL_VARIABLES;
2536 extern int DICT_WORD_SIZE, DICT_CHAR_SIZE, DICT_WORD_BYTES;
2537 extern int ZCODE_HEADER_EXT_WORDS, ZCODE_HEADER_FLAGS_3;
2538 extern int NUM_ATTR_BYTES, GLULX_OBJECT_EXT_BYTES;
2539 extern int WARN_UNUSED_ROUTINES, OMIT_UNUSED_ROUTINES;
2541 /* These macros define offsets that depend on the value of NUM_ATTR_BYTES.
2542 (Meaningful only for Glulx.) */
2543 /* GOBJFIELD: word offsets of various elements in the object structure. */
2544 #define GOBJFIELD_CHAIN() (1+((NUM_ATTR_BYTES)/4))
2545 #define GOBJFIELD_NAME() (2+((NUM_ATTR_BYTES)/4))
2546 #define GOBJFIELD_PROPTAB() (3+((NUM_ATTR_BYTES)/4))
2547 #define GOBJFIELD_PARENT() (4+((NUM_ATTR_BYTES)/4))
2548 #define GOBJFIELD_SIBLING() (5+((NUM_ATTR_BYTES)/4))
2549 #define GOBJFIELD_CHILD() (6+((NUM_ATTR_BYTES)/4))
2551 extern void *my_malloc(int32 size, char *whatfor);
2552 extern void my_realloc(void *pointer, int32 oldsize, int32 size,
2554 extern void *my_calloc(int32 size, int32 howmany, char *whatfor);
2555 extern void my_recalloc(void *pointer, int32 size, int32 oldhowmany,
2556 int32 howmany, char *whatfor);
2557 extern void my_free(void *pointer, char *whatitwas);
2559 extern void set_memory_sizes(int size_flag);
2560 extern void adjust_memory_sizes(void);
2561 extern void memory_command(char *command);
2562 extern void print_memory_usage(void);
2564 extern void initialise_memory_block(memory_block *MB);
2565 extern void deallocate_memory_block(memory_block *MB);
2566 extern int read_byte_from_memory_block(memory_block *MB, int32 index);
2567 extern void write_byte_to_memory_block(memory_block *MB,
2568 int32 index, int value);
2570 /* ------------------------------------------------------------------------- */
2571 /* Extern definitions for "objects" */
2572 /* ------------------------------------------------------------------------- */
2574 extern int no_attributes, no_properties;
2575 extern int no_individual_properties;
2576 extern int individuals_length;
2577 extern uchar *individuals_table;
2578 extern int no_classes, no_objects;
2579 extern objecttz *objectsz;
2580 extern objecttg *objectsg;
2581 extern uchar *objectatts;
2582 extern int *class_object_numbers;
2583 extern int32 *class_begins_at;
2585 extern int32 *prop_default_value;
2586 extern int *prop_is_long;
2587 extern int *prop_is_additive;
2588 extern char *properties_table;
2589 extern int properties_table_size;
2591 extern void make_attribute(void);
2592 extern void make_property(void);
2593 extern void make_object(int nearby_flag,
2594 char *textual_name, int specified_parent, int specified_class,
2596 extern void make_class(char *metaclass_name);
2597 extern int object_provides(int obj, int id);
2598 extern void list_object_tree(void);
2599 extern void write_the_identifier_names(void);
2601 /* ------------------------------------------------------------------------- */
2602 /* Extern definitions for "symbols" */
2603 /* ------------------------------------------------------------------------- */
2605 extern int no_named_constants;
2606 extern int no_symbols;
2607 extern int32 **symbs;
2608 extern int32 *svals;
2610 extern brief_location *slines;
2613 extern char *stypes;
2615 extern signed char *stypes;
2617 extern maybe_file_position *symbol_debug_backpatch_positions;
2618 extern maybe_file_position *replacement_debug_backpatch_positions;
2619 extern int32 *individual_name_strings;
2620 extern int32 *attribute_name_strings;
2621 extern int32 *action_name_strings;
2622 extern int32 *array_name_strings;
2623 extern int track_unused_routines;
2624 extern int df_dont_note_global_symbols;
2625 extern uint32 df_total_size_before_stripping;
2626 extern uint32 df_total_size_after_stripping;
2628 extern char *typename(int type);
2629 extern int hash_code_from_string(char *p);
2630 extern int strcmpcis(char *p, char *q);
2631 extern int symbol_index(char *lexeme_text, int hashcode);
2632 extern void end_symbol_scope(int k);
2633 extern void describe_symbol(int k);
2634 extern void list_symbols(int level);
2635 extern void assign_marked_symbol(int index, int marker, int32 value, int type);
2636 extern void assign_symbol(int index, int32 value, int type);
2637 extern void issue_unused_warnings(void);
2638 extern void add_symbol_replacement_mapping(int original, int renamed);
2639 extern int find_symbol_replacement(int *value);
2640 extern void df_note_function_start(char *name, uint32 address,
2641 int embedded_flag, brief_location source_line);
2642 extern void df_note_function_end(uint32 endaddress);
2643 extern void df_note_function_symbol(int symbol);
2644 extern void locate_dead_functions(void);
2645 extern uint32 df_stripped_address_for_address(uint32);
2646 extern uint32 df_stripped_offset_for_code_offset(uint32, int *);
2647 extern void df_prepare_function_iterate(void);
2648 extern uint32 df_next_function_iterate(int *);
2650 /* ------------------------------------------------------------------------- */
2651 /* Extern definitions for "syntax" */
2652 /* ------------------------------------------------------------------------- */
2654 extern int no_syntax_lines;
2656 extern void panic_mode_error_recovery(void);
2657 extern void get_next_token_with_directives(void);
2658 extern int parse_directive(int internal_flag);
2659 extern void parse_program(char *source);
2660 extern int32 parse_routine(char *source, int embedded_flag, char *name,
2661 int veneer_flag, int r_symbol);
2662 extern void parse_code_block(int break_label, int continue_label,
2665 /* ------------------------------------------------------------------------- */
2666 /* Extern definitions for "states" */
2667 /* ------------------------------------------------------------------------- */
2669 extern void match_close_bracket(void);
2670 extern void parse_statement(int break_label, int continue_label);
2671 extern int parse_label(void);
2673 /* ------------------------------------------------------------------------- */
2674 /* Extern definitions for "tables" */
2675 /* ------------------------------------------------------------------------- */
2677 extern uchar *zmachine_paged_memory;
2679 code_offset, actions_offset, preactions_offset,
2680 dictionary_offset, strings_offset, adjectives_offset,
2681 variables_offset, class_numbers_offset, individuals_offset,
2682 identifier_names_offset, prop_defaults_offset, prop_values_offset,
2683 static_memory_offset, array_names_offset, attribute_names_offset,
2684 action_names_offset, fake_action_names_offset,
2685 routine_names_offset, routines_array_offset, routine_flags_array_offset,
2686 global_names_offset, global_flags_array_offset,
2687 array_flags_array_offset, constant_names_offset, constants_array_offset,
2688 static_arrays_offset;
2690 arrays_offset, object_tree_offset, grammar_table_offset,
2691 abbreviations_offset; /* For Glulx */
2693 extern int32 Out_Size, Write_Code_At, Write_Strings_At;
2694 extern int32 RAM_Size, Write_RAM_At; /* For Glulx */
2696 extern int release_number, statusline_flag;
2697 extern int flags2_requirements[];
2698 extern int serial_code_given_in_program;
2699 extern char serial_code_buffer[];
2701 extern void construct_storyfile(void);
2702 extern void write_serial_number(char *buffer);
2704 /* ------------------------------------------------------------------------- */
2705 /* Extern definitions for "text" */
2706 /* ------------------------------------------------------------------------- */
2708 extern uchar *low_strings, *low_strings_top;
2709 extern char *all_text, *all_text_top;
2711 extern int no_abbreviations;
2712 extern int abbrevs_lookup_table_made, is_abbreviation;
2713 extern uchar *abbreviations_at;
2714 extern int *abbrev_values;
2715 extern int *abbrev_quality;
2716 extern int *abbrev_freqs;
2718 extern int32 total_chars_trans, total_bytes_trans,
2719 zchars_trans_in_last_string;
2720 extern int put_strings_in_low_memory;
2721 extern int dict_entries;
2722 extern uchar *dictionary, *dictionary_top;
2723 extern int *final_dict_order;
2725 extern memory_block static_strings_area;
2726 extern int32 static_strings_extent;
2728 /* And now, a great many declarations for dealing with Glulx string
2731 extern int32 no_strings, no_dynamic_strings;
2732 extern int no_unicode_chars;
2734 #define MAX_DYNAMIC_STRINGS (64)
2736 typedef struct unicode_usage_s unicode_usage_t;
2737 struct unicode_usage_s {
2739 unicode_usage_t *next;
2742 extern unicode_usage_t *unicode_usage_entries;
2744 /* This is the maximum number of (8-bit) bytes that can encode a single
2745 Huffman entity. Four should be plenty, unless someone starts encoding
2746 an ideographic language. */
2747 #define MAXHUFFBYTES (4)
2749 typedef struct huffbitlist_struct {
2750 uchar b[MAXHUFFBYTES];
2752 typedef struct huffentity_struct {
2765 extern huffentity_t *huff_entities;
2767 extern int32 compression_table_size, compression_string_size;
2768 extern int32 *compressed_offsets;
2769 extern int no_huff_entities;
2770 extern int huff_abbrev_start, huff_dynam_start, huff_unicode_start;
2771 extern int huff_entity_root;
2773 extern void compress_game_text(void);
2775 /* end of the Glulx string compression stuff */
2777 extern void ao_free_arrays(void);
2778 extern int32 compile_string(char *b, int in_low_memory, int is_abbrev);
2779 extern uchar *translate_text(uchar *p, uchar *p_limit, char *s_text);
2780 extern void optimise_abbreviations(void);
2781 extern void make_abbreviation(char *text);
2782 extern void show_dictionary(void);
2783 extern void word_to_ascii(uchar *p, char *result);
2784 extern void write_dictionary_to_transcript(void);
2785 extern void sort_dictionary(void);
2786 extern void dictionary_prepare(char *dword, uchar *optresult);
2787 extern int dictionary_add(char *dword, int x, int y, int z);
2788 extern void dictionary_set_verb_number(char *dword, int to);
2789 extern int compare_sorts(uchar *d1, uchar *d2);
2790 extern void copy_sorts(uchar *d1, uchar *d2);
2792 /* ------------------------------------------------------------------------- */
2793 /* Extern definitions for "veneer" */
2794 /* ------------------------------------------------------------------------- */
2796 extern int veneer_mode;
2797 extern int32 veneer_routine_address[];
2799 extern void compile_initial_routine(void);
2800 extern assembly_operand veneer_routine(int code);
2801 extern void compile_veneer(void);
2803 /* ------------------------------------------------------------------------- */
2804 /* Extern definitions for "verbs" */
2805 /* ------------------------------------------------------------------------- */
2807 extern int no_adjectives, no_Inform_verbs, no_grammar_token_routines,
2808 no_fake_actions, no_actions, no_grammar_lines, no_grammar_tokens,
2809 grammar_version_number;
2810 extern int32 grammar_version_symbol;
2811 extern verbt *Inform_verbs;
2812 extern uchar *grammar_lines;
2813 extern int32 grammar_lines_top;
2814 extern int32 *action_byte_offset,
2815 *grammar_token_routine,
2818 extern void find_the_actions(void);
2819 extern void make_fake_action(void);
2820 extern assembly_operand action_of_name(char *name);
2821 extern void make_verb(void);
2822 extern void extend_verb(void);
2823 extern void list_verb_table(void);
2825 /* ========================================================================= */