+++ /dev/null
-/* ------------------------------------------------------------------------- */
-/* "arrays" : Parses array declarations and constructs arrays from them; */
-/* likewise global variables, which are in some ways a */
-/* simpler form of the same thing. */
-/* */
-/* Copyright (c) Graham Nelson 1993 - 2018 */
-/* */
-/* This file is part of Inform. */
-/* */
-/* Inform is free software: you can redistribute it and/or modify */
-/* it under the terms of the GNU General Public License as published by */
-/* the Free Software Foundation, either version 3 of the License, or */
-/* (at your option) any later version. */
-/* */
-/* Inform is distributed in the hope that it will be useful, */
-/* but WITHOUT ANY WARRANTY; without even the implied warranty of */
-/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
-/* GNU General Public License for more details. */
-/* */
-/* You should have received a copy of the GNU General Public License */
-/* along with Inform. If not, see https://gnu.org/licenses/ */
-/* */
-/* ------------------------------------------------------------------------- */
-
-#include "header.h"
-
-/* ------------------------------------------------------------------------- */
-/* Arrays defined below: */
-/* */
-/* int dynamic_array_area[] Initial values for the bytes of */
-/* the dynamic array area */
-/* int32 global_initial_value[n] The initialised value of the nth */
-/* global variable (counting 0 - 239) */
-/* */
-/* The "dynamic array area" is the Z-machine area holding the current */
-/* values of the global variables (in 240x2 = 480 bytes) followed by any */
-/* (dynamic) arrays which may be defined. Owing to a poor choice of name */
-/* some years ago, this is also called the "static data area", which is */
-/* why the memory setting for its maximum extent is "MAX_STATIC_DATA". */
-/* */
-/* In Glulx, that 240 is changed to MAX_GLOBAL_VAR_NUMBER, and we take */
-/* correspondingly more space for the globals. This *really* ought to be */
-/* split into two segments. */
-/* ------------------------------------------------------------------------- */
-int *dynamic_array_area; /* See above */
-int32 *global_initial_value;
-
-int no_globals; /* Number of global variables used
- by the programmer (Inform itself
- uses the top seven -- but these do
- not count) */
- /* In Glulx, Inform uses the bottom
- ten. */
-
-int dynamic_array_area_size; /* Size in bytes */
-
-int no_arrays;
-int32 *array_symbols;
-int *array_sizes, *array_types;
-
-static int array_entry_size, /* 1 for byte array, 2 for word array */
- array_base; /* Offset in dynamic array area of the
- array being constructed. During the
- same time, dynamic_array_area_size
- is the offset of the initial entry
- in the array: so for "table" and
- "string" arrays, these numbers are
- different (by 2 and 1 bytes resp) */
-
- /* In Glulx, of course, that will be
- 4 instead of 2. */
-
-extern void finish_array(int32 i)
-{
- /* Write the array size into the 0th byte/word of the array, if it's
- a "table" or "string" array */
- if (!glulx_mode) {
-
- if (array_base!=dynamic_array_area_size)
- { if (dynamic_array_area_size-array_base==2)
- { dynamic_array_area[array_base] = i/256;
- dynamic_array_area[array_base+1] = i%256;
- }
- else
- { if (i>=256)
- error("A 'string' array can have at most 256 entries");
- dynamic_array_area[array_base] = i;
- }
- }
-
- }
- else {
- if (array_base!=dynamic_array_area_size)
- { if (dynamic_array_area_size-array_base==4)
- {
- dynamic_array_area[array_base] = (i >> 24) & 0xFF;
- dynamic_array_area[array_base+1] = (i >> 16) & 0xFF;
- dynamic_array_area[array_base+2] = (i >> 8) & 0xFF;
- dynamic_array_area[array_base+3] = (i) & 0xFF;
- }
- else
- { if (i>=256)
- error("A 'string' array can have at most 256 entries");
- dynamic_array_area[array_base] = i;
- }
- }
-
- }
-
- /* Move on the dynamic array size so that it now points to the next
- available free space */
-
- dynamic_array_area_size += i*array_entry_size;
-
-}
-
-extern void array_entry(int32 i, assembly_operand VAL)
-{
- if (!glulx_mode) {
- /* Array entry i (initial entry has i=0) is set to Z-machine value j */
-
- if (dynamic_array_area_size+(i+1)*array_entry_size > MAX_STATIC_DATA)
- memoryerror("MAX_STATIC_DATA", MAX_STATIC_DATA);
-
- if (array_entry_size==1)
- { dynamic_array_area[dynamic_array_area_size+i] = (VAL.value)%256;
-
- if (VAL.marker != 0)
- error("Entries in byte arrays and strings must be known constants");
-
- /* If the entry is too large for a byte array, issue a warning
- and truncate the value */
- else
- if (VAL.value >= 256)
- warning("Entry in '->', 'string' or 'buffer' array not in range 0 to 255");
- }
- else
- { dynamic_array_area[dynamic_array_area_size + 2*i] = (VAL.value)/256;
- dynamic_array_area[dynamic_array_area_size + 2*i+1] = (VAL.value)%256;
- if (VAL.marker != 0)
- backpatch_zmachine(VAL.marker, DYNAMIC_ARRAY_ZA,
- dynamic_array_area_size + 2*i);
- }
- }
- else {
- /* Array entry i (initial entry has i=0) is set to value j */
-
- if (dynamic_array_area_size+(i+1)*array_entry_size > MAX_STATIC_DATA)
- memoryerror("MAX_STATIC_DATA", MAX_STATIC_DATA);
-
- if (array_entry_size==1)
- { dynamic_array_area[dynamic_array_area_size+i] = (VAL.value) & 0xFF;
-
- if (VAL.marker != 0)
- error("Entries in byte arrays and strings must be known constants");
-
- /* If the entry is too large for a byte array, issue a warning
- and truncate the value */
- else
- if (VAL.value >= 256)
- warning("Entry in '->', 'string' or 'buffer' array not in range 0 to 255");
- }
- else if (array_entry_size==4)
- { dynamic_array_area[dynamic_array_area_size + 4*i] = (VAL.value >> 24) & 0xFF;
- dynamic_array_area[dynamic_array_area_size + 4*i+1] = (VAL.value >> 16) & 0xFF;
- dynamic_array_area[dynamic_array_area_size + 4*i+2] = (VAL.value >> 8) & 0xFF;
- dynamic_array_area[dynamic_array_area_size + 4*i+3] = (VAL.value) & 0xFF;
- if (VAL.marker != 0)
- backpatch_zmachine(VAL.marker, ARRAY_ZA,
- dynamic_array_area_size - 4*MAX_GLOBAL_VARIABLES + 4*i);
- }
- else
- {
- error("Somehow created an array of shorts");
- }
- }
-}
-
-/* ------------------------------------------------------------------------- */
-/* Global and Array directives. */
-/* */
-/* Global <variablename> | */
-/* | = <value> */
-/* | <array specification> */
-/* */
-/* Array <arrayname> <array specification> */
-/* */
-/* where an array specification is: */
-/* */
-/* | -> | <number-of-entries> */
-/* | --> | <entry-1> ... <entry-n> */
-/* | string | [ <entry-1> [,] [;] <entry-2> ... <entry-n> ]; */
-/* | table */
-/* */
-/* ------------------------------------------------------------------------- */
-
-extern void set_variable_value(int i, int32 v)
-{ global_initial_value[i]=v;
-}
-
-/* There are four ways to initialise arrays: */
-
-#define UNSPECIFIED_AI -1
-#define NULLS_AI 0
-#define DATA_AI 1
-#define ASCII_AI 2
-#define BRACKET_AI 3
-
-extern void make_global(int array_flag, int name_only)
-{
- /* array_flag is TRUE for an Array directive, FALSE for a Global;
- name_only is only TRUE for parsing an imported variable name, so
- array_flag is always FALSE in that case. */
-
- int32 i;
- int array_type, data_type;
- assembly_operand AO;
-
- int32 global_symbol;
- const char *global_name;
- debug_location_beginning beginning_debug_location =
- get_token_location_beginning();
-
- directive_keywords.enabled = FALSE;
- get_next_token();
- i = token_value;
- global_symbol = i;
- global_name = token_text;
-
- if (!glulx_mode) {
- if ((token_type==SYMBOL_TT) && (stypes[i]==GLOBAL_VARIABLE_T)
- && (svals[i] >= LOWEST_SYSTEM_VAR_NUMBER))
- goto RedefinitionOfSystemVar;
- }
- else {
- if ((token_type==SYMBOL_TT) && (stypes[i]==GLOBAL_VARIABLE_T))
- goto RedefinitionOfSystemVar;
- }
-
- if ((token_type != SYMBOL_TT) || (!(sflags[i] & UNKNOWN_SFLAG)))
- { discard_token_location(beginning_debug_location);
- if (array_flag)
- ebf_error("new array name", token_text);
- else ebf_error("new global variable name", token_text);
- panic_mode_error_recovery(); return;
- }
-
- if ((!array_flag) && (sflags[i] & USED_SFLAG))
- error_named("Variable must be defined before use:", token_text);
-
- if (array_flag)
- {
- if (!glulx_mode)
- assign_symbol(i, dynamic_array_area_size, ARRAY_T);
- else
- assign_symbol(i,
- dynamic_array_area_size - 4*MAX_GLOBAL_VARIABLES, ARRAY_T);
- if (no_arrays == MAX_ARRAYS)
- memoryerror("MAX_ARRAYS", MAX_ARRAYS);
- array_symbols[no_arrays] = i;
- }
- else
- { if (!glulx_mode && no_globals==233)
- { discard_token_location(beginning_debug_location);
- error("All 233 global variables already declared");
- panic_mode_error_recovery();
- return;
- }
- if (glulx_mode && no_globals==MAX_GLOBAL_VARIABLES)
- { discard_token_location(beginning_debug_location);
- memoryerror("MAX_GLOBAL_VARIABLES", MAX_GLOBAL_VARIABLES);
- panic_mode_error_recovery();
- return;
- }
-
- variable_tokens[MAX_LOCAL_VARIABLES+no_globals] = i;
- assign_symbol(i, MAX_LOCAL_VARIABLES+no_globals, GLOBAL_VARIABLE_T);
- variable_tokens[svals[i]] = i;
-
- if (name_only) import_symbol(i);
- else global_initial_value[no_globals++]=0;
- }
-
- directive_keywords.enabled = TRUE;
-
- RedefinitionOfSystemVar:
-
- if (name_only)
- { discard_token_location(beginning_debug_location);
- return;
- }
-
- get_next_token();
-
- if ((token_type == SEP_TT) && (token_value == SEMICOLON_SEP))
- { if (array_flag)
- { discard_token_location(beginning_debug_location);
- ebf_error("array definition", token_text);
- }
- put_token_back();
- if (debugfile_switch && !array_flag)
- { debug_file_printf("<global-variable>");
- debug_file_printf("<identifier>%s</identifier>", global_name);
- debug_file_printf("<address>");
- write_debug_global_backpatch(svals[global_symbol]);
- debug_file_printf("</address>");
- write_debug_locations
- (get_token_location_end(beginning_debug_location));
- debug_file_printf("</global-variable>");
- }
- return;
- }
-
- if (!array_flag)
- {
- if ((token_type == SEP_TT) && (token_value == SETEQUALS_SEP))
- { AO = parse_expression(CONSTANT_CONTEXT);
- if (!glulx_mode) {
- if (AO.marker != 0)
- backpatch_zmachine(AO.marker, DYNAMIC_ARRAY_ZA,
- 2*(no_globals-1));
- }
- else {
- if (AO.marker != 0)
- backpatch_zmachine(AO.marker, GLOBALVAR_ZA,
- 4*(no_globals-1));
- }
- global_initial_value[no_globals-1] = AO.value;
- if (debugfile_switch)
- { debug_file_printf("<global-variable>");
- debug_file_printf("<identifier>%s</identifier>", global_name);
- debug_file_printf("<address>");
- write_debug_global_backpatch(svals[global_symbol]);
- debug_file_printf("</address>");
- write_debug_locations
- (get_token_location_end(beginning_debug_location));
- debug_file_printf("</global-variable>");
- }
- return;
- }
-
- obsolete_warning("more modern to use 'Array', not 'Global'");
-
- if (!glulx_mode) {
- backpatch_zmachine(ARRAY_MV, DYNAMIC_ARRAY_ZA, 2*(no_globals-1));
- global_initial_value[no_globals-1]
- = dynamic_array_area_size+variables_offset;
- }
- else {
- backpatch_zmachine(ARRAY_MV, GLOBALVAR_ZA, 4*(no_globals-1));
- global_initial_value[no_globals-1]
- = dynamic_array_area_size - 4*MAX_GLOBAL_VARIABLES;
- }
- }
-
- array_type = BYTE_ARRAY; data_type = UNSPECIFIED_AI;
-
- if ((!array_flag) &&
- ((token_type==DIR_KEYWORD_TT)&&(token_value==DATA_DK)))
- data_type=NULLS_AI;
- else if ((!array_flag) &&
- ((token_type==DIR_KEYWORD_TT)&&(token_value==INITIAL_DK)))
- data_type=DATA_AI;
- else if ((!array_flag) &&
- ((token_type==DIR_KEYWORD_TT)&&(token_value==INITSTR_DK)))
- data_type=ASCII_AI;
-
- else if ((token_type==SEP_TT)&&(token_value==ARROW_SEP))
- array_type = BYTE_ARRAY;
- else if ((token_type==SEP_TT)&&(token_value==DARROW_SEP))
- array_type = WORD_ARRAY;
- else if ((token_type==DIR_KEYWORD_TT)&&(token_value==STRING_DK))
- array_type = STRING_ARRAY;
- else if ((token_type==DIR_KEYWORD_TT)&&(token_value==TABLE_DK))
- array_type = TABLE_ARRAY;
- else if ((token_type==DIR_KEYWORD_TT)&&(token_value==BUFFER_DK))
- array_type = BUFFER_ARRAY;
- else
- { discard_token_location(beginning_debug_location);
- if (array_flag)
- ebf_error
- ("'->', '-->', 'string', 'table' or 'buffer'", token_text);
- else
- ebf_error
- ("'=', '->', '-->', 'string', 'table' or 'buffer'", token_text);
- panic_mode_error_recovery();
- return;
- }
-
- array_entry_size=1;
- if ((array_type==WORD_ARRAY) || (array_type==TABLE_ARRAY))
- array_entry_size=WORDSIZE;
-
- get_next_token();
- if ((token_type == SEP_TT) && (token_value == SEMICOLON_SEP))
- { discard_token_location(beginning_debug_location);
- error("No array size or initial values given");
- put_token_back();
- return;
- }
-
- switch(data_type)
- { case UNSPECIFIED_AI:
- if ((token_type == SEP_TT) && (token_value == OPEN_SQUARE_SEP))
- data_type = BRACKET_AI;
- else
- { data_type = NULLS_AI;
- if (token_type == DQ_TT) data_type = ASCII_AI;
- get_next_token();
- if (!((token_type == SEP_TT) && (token_value == SEMICOLON_SEP)))
- data_type = DATA_AI;
- put_token_back();
- put_token_back();
- }
- break;
- case NULLS_AI: obsolete_warning("use '->' instead of 'data'"); break;
- case DATA_AI: obsolete_warning("use '->' instead of 'initial'"); break;
- case ASCII_AI: obsolete_warning("use '->' instead of 'initstr'"); break;
- }
-
- array_base = dynamic_array_area_size;
-
- /* Leave room to write the array size in later, if string/table array */
-
- if ((array_type==STRING_ARRAY) || (array_type==TABLE_ARRAY))
- dynamic_array_area_size += array_entry_size;
- if (array_type==BUFFER_ARRAY)
- dynamic_array_area_size += WORDSIZE;
- array_types[no_arrays] = array_type;
-
- switch(data_type)
- {
- case NULLS_AI:
-
- AO = parse_expression(CONSTANT_CONTEXT);
-
- CalculatedArraySize:
-
- if (module_switch && (AO.marker != 0))
- { error("Array sizes must be known now, not externally defined");
- break;
- }
-
- if (!glulx_mode) {
- if ((AO.value <= 0) || (AO.value >= 32768))
- { error("An array must have between 1 and 32767 entries");
- AO.value = 1;
- }
- }
- else {
- if (AO.value <= 0 || (AO.value & 0x80000000))
- { error("An array may not have 0 or fewer entries");
- AO.value = 1;
- }
- }
-
- { for (i=0; i<AO.value; i++) array_entry(i, zero_operand);
- }
- break;
-
- case DATA_AI:
-
- /* In this case the array is initialised to the sequence of
- constant values supplied on the same line */
-
- i=0;
- do
- { get_next_token();
- if ((token_type == SEP_TT) && (token_value == SEMICOLON_SEP))
- break;
-
- if ((token_type == SEP_TT)
- && ((token_value == OPEN_SQUARE_SEP)
- || (token_value == CLOSE_SQUARE_SEP)))
- { discard_token_location(beginning_debug_location);
- error("Missing ';' to end the initial array values "
- "before \"[\" or \"]\"");
- return;
- }
- put_token_back();
-
- AO = parse_expression(ARRAY_CONTEXT);
-
- if (i == 0)
- { get_next_token();
- put_token_back();
- if ((token_type == SEP_TT)
- && (token_value == SEMICOLON_SEP))
- { data_type = NULLS_AI;
- goto CalculatedArraySize;
- }
- }
-
- array_entry(i, AO);
- i++;
- } while (TRUE);
- put_token_back();
- break;
-
- case ASCII_AI:
-
- /* In this case the array is initialised to the ASCII values of
- the characters of a given "quoted string" */
-
- get_next_token();
- if (token_type != DQ_TT)
- { ebf_error("literal text in double-quotes", token_text);
- token_text = "error";
- }
-
- { assembly_operand chars;
-
- int j;
- INITAO(&chars);
- for (i=0,j=0; token_text[j]!=0; i++,j+=textual_form_length)
- {
- int32 unicode; int zscii;
- unicode = text_to_unicode(token_text+j);
- if (glulx_mode)
- {
- if (array_entry_size == 1 && (unicode < 0 || unicode >= 256))
- {
- error("Unicode characters beyond Latin-1 cannot be used in a byte array");
- }
- else
- {
- chars.value = unicode;
- }
- }
- else /* Z-code */
- {
- zscii = unicode_to_zscii(unicode);
- if ((zscii != 5) && (zscii < 0x100)) chars.value = zscii;
- else
- { unicode_char_error("Character can only be used if declared in \
-advance as part of 'Zcharacter table':", unicode);
- chars.value = '?';
- }
- }
- chars.marker = 0;
- set_constant_ot(&chars);
- array_entry(i, chars);
- }
- }
- break;
-
- case BRACKET_AI:
-
- /* In this case the array is initialised to the sequence of
- constant values given over a whole range of compiler-lines,
- between square brackets [ and ] */
-
- i = 0;
- while (TRUE)
- { get_next_token();
- if ((token_type == SEP_TT) && (token_value == SEMICOLON_SEP))
- continue;
- if ((token_type == SEP_TT) && (token_value == CLOSE_SQUARE_SEP))
- break;
- if ((token_type == SEP_TT) && (token_value == OPEN_SQUARE_SEP))
- { /* Minimal error recovery: we assume that a ] has
- been missed, and the programmer is now starting
- a new routine */
-
- ebf_error("']'", token_text);
- put_token_back(); break;
- }
- put_token_back();
- array_entry(i, parse_expression(ARRAY_CONTEXT));
- i++;
- }
- }
-
- finish_array(i);
-
- if (debugfile_switch)
- { debug_file_printf("<array>");
- debug_file_printf("<identifier>%s</identifier>", global_name);
- debug_file_printf("<value>");
- write_debug_array_backpatch(svals[global_symbol]);
- debug_file_printf("</value>");
- debug_file_printf
- ("<byte-count>%d</byte-count>",
- dynamic_array_area_size - array_base);
- debug_file_printf
- ("<bytes-per-element>%d</bytes-per-element>",
- array_entry_size);
- debug_file_printf
- ("<zeroth-element-holds-length>%s</zeroth-element-holds-length>",
- (array_type == STRING_ARRAY || array_type == TABLE_ARRAY) ?
- "true" : "false");
- get_next_token();
- write_debug_locations(get_token_location_end(beginning_debug_location));
- put_token_back();
- debug_file_printf("</array>");
- }
-
- if ((array_type==BYTE_ARRAY) || (array_type==WORD_ARRAY)) i--;
- if (array_type==BUFFER_ARRAY) i+=WORDSIZE-1;
- array_sizes[no_arrays++] = i;
-}
-
-extern int32 begin_table_array(void)
-{
- /* The "box" statement needs to be able to construct (static) table
- arrays of strings like this */
-
- array_base = dynamic_array_area_size;
- array_entry_size = WORDSIZE;
-
- /* Leave room to write the array size in later */
-
- dynamic_array_area_size += array_entry_size;
-
- if (!glulx_mode)
- return array_base;
- else
- return array_base - WORDSIZE * MAX_GLOBAL_VARIABLES;
-}
-
-extern int32 begin_word_array(void)
-{
- /* The "random(a, b, ...)" function needs to be able to construct
- (static) word arrays like this */
-
- array_base = dynamic_array_area_size;
- array_entry_size = WORDSIZE;
-
- if (!glulx_mode)
- return array_base;
- else
- return array_base - WORDSIZE * MAX_GLOBAL_VARIABLES;
-}
-
-/* ========================================================================= */
-/* Data structure management routines */
-/* ------------------------------------------------------------------------- */
-
-extern void init_arrays_vars(void)
-{ dynamic_array_area = NULL;
- global_initial_value = NULL;
- array_sizes = NULL; array_symbols = NULL; array_types = NULL;
-}
-
-extern void arrays_begin_pass(void)
-{ no_arrays = 0;
- if (!glulx_mode)
- no_globals=0;
- else
- no_globals=11;
- dynamic_array_area_size = WORDSIZE * MAX_GLOBAL_VARIABLES;
-}
-
-extern void arrays_allocate_arrays(void)
-{ dynamic_array_area = my_calloc(sizeof(int), MAX_STATIC_DATA,
- "static data");
- array_sizes = my_calloc(sizeof(int), MAX_ARRAYS, "array sizes");
- array_types = my_calloc(sizeof(int), MAX_ARRAYS, "array types");
- array_symbols = my_calloc(sizeof(int32), MAX_ARRAYS, "array symbols");
- global_initial_value = my_calloc(sizeof(int32), MAX_GLOBAL_VARIABLES,
- "global values");
-}
-
-extern void arrays_free_arrays(void)
-{ my_free(&dynamic_array_area, "static data");
- my_free(&global_initial_value, "global values");
- my_free(&array_sizes, "array sizes");
- my_free(&array_types, "array sizes");
- my_free(&array_symbols, "array sizes");
-}
-
-/* ========================================================================= */
projects / inform.git / blobdiff