Max/nunuhara_xsystem4
1
0
Fork 0
mirror of https://github.com/nunuhara/xsystem4.git synced 2026-10-12 09:18:11 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
74c5b91e0c7c31bc99645bd3fc190130647d43fb
nunuhara_xsystem4/include/system4/ain.h
T
Nunuhara Cabbage 74c5b91e0c aindump: enums, iterators, interface objects 
Type 82
-------
I am assuming this is an iterator type because it always appears as a
local variable alongside "dummy" variables with "foreach" in their name,
and the naming of the variables suggests an iterator. Probably there is
a new syntax like:

    foreach (iter_var in array_var) { ... }

Type 89
-------
An instance of an interface. This is a 2-valued type (similar to ref
int, etc.) where the first value is the index of a struct page, and the
second value is an index into the struct's vtable.

Any struct that implements an interface gets an array<int> named
"<vtable>" as its first member. This array stores indices into the
global function table. CALLMETHOD now looks up methods in the vtable
rather than the global function table.

Types 92, 93
------------
These are enum types. Type 92 is the normal enum type, and type 93 is
the reference-to-enum type. The "struct type" for these types stores an
index into the enum table.

Types 86, 91
------------
Type 86 only seems to be used as the return value from EnumType::Parse
methods. In the ain file, it has an extra type descriptor, similar to an
array type. This extra type descriptor always has data type 91, and its
struct type is an index into the enum table. Type 91 is simlar to types
92 & 93: it stores an enum table index in its struct type.

Type 86 is a 2-valued type. The first value is the value of the enum (an
integer between 0 and n). The second value seems to be either 0 or -1,
depending on whether EnumType::Parse was able to produce a valid enum
value.

It is possible that type 86 is actually some kind of generic maybe-error
type that only happens to be used by the enum code. But that doesn't
explain why it is paired with type 91 and not type 92.
2020-01-15 12:59:41 -08:00

268 lines
6.3 KiB
C
Raw Blame History

/* Copyright (C) 2019 Nunuhara Cabbage <nunuhara@haniwa.technology>
*
* This program 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 2 of the License, or
* (at your option) any later version.
*
* This program 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 this program; if not, see <http://gnu.org/licenses/>.
*/
#ifndef SYSTEM4_AIN_H
#define SYSTEM4_AIN_H
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
struct string;
enum ain_error {
AIN_SUCCESS,
AIN_FILE_ERROR,
AIN_UNRECOGNIZED_FORMAT,
AIN_INVALID,
AIN_MAX_ERROR
};
enum ain_data_type {
AIN_VOID = 0,
AIN_INT = 10,
AIN_FLOAT = 11,
AIN_STRING = 12,
AIN_STRUCT = 13,
AIN_ARRAY_INT = 14,
AIN_ARRAY_FLOAT = 15,
AIN_ARRAY_STRING = 16,
AIN_ARRAY_STRUCT = 17,
AIN_REF_INT = 18,
AIN_REF_FLOAT = 19,
AIN_REF_STRING = 20,
AIN_REF_STRUCT = 21,
AIN_REF_ARRAY_INT = 22,
AIN_REF_ARRAY_FLOAT = 23,
AIN_REF_ARRAY_STRING = 24,
AIN_REF_ARRAY_STRUCT = 25,
AIN_IMAIN_SYSTEM = 26,
AIN_FUNC_TYPE = 27,
AIN_ARRAY_FUNC_TYPE = 30,
AIN_REF_FUNC_TYPE = 31,
AIN_REF_ARRAY_FUNC_TYPE = 32,
AIN_BOOL = 47,
AIN_ARRAY_BOOL = 50,
AIN_REF_BOOL = 51,
AIN_REF_ARRAY_BOOL = 52,
AIN_LONG_INT = 55,
AIN_ARRAY_LONG_INT = 58,
AIN_REF_LONG_INT = 59,
AIN_REF_ARRAY_LONG_INT = 60,
AIN_DELEGATE = 63,
AIN_ARRAY_DELEGATE = 66,
AIN_UNKNOWN_TYPE_67 = 67, // delegate?
AIN_REF_ARRAY_DELEGATE = 69,
AIN_UNKNOWN_TYPE_74 = 74, // generic array value?
AIN_UNKNOWN_TYPE_75 = 75, // generic array value? (ref?)
AIN_ARRAY = 79,
AIN_REF_ARRAY = 80,
AIN_ITERATOR = 82, // array iterator
AIN_ENUM1 = 86, // return value of EnumType::Parse; has type 91 in array type
AIN_IFACE = 89, // 2 values: [0] = struct page, [1] = vtable offset to inteface methods
AIN_ENUM2 = 91, // used as array type of type 86; has enum type in struct type
AIN_ENUM3 = 92, // used as argument type, and array type in EnumType::GetList; has enum type in struct type
AIN_REF_ENUM = 93,
AIN_UNKNOWN_TYPE_95 = 95, // function?
};
#define AIN_ARRAY_TYPE \
AIN_ARRAY_INT: \
case AIN_ARRAY_FLOAT: \
case AIN_ARRAY_STRING: \
case AIN_ARRAY_STRUCT: \
case AIN_ARRAY_FUNC_TYPE: \
case AIN_ARRAY_BOOL: \
case AIN_ARRAY_LONG_INT: \
case AIN_ARRAY_DELEGATE
#define AIN_REF_ARRAY_TYPE \
AIN_REF_ARRAY_INT: \
case AIN_REF_ARRAY_FLOAT: \
case AIN_REF_ARRAY_STRING: \
case AIN_REF_ARRAY_STRUCT: \
case AIN_REF_ARRAY_FUNC_TYPE: \
case AIN_REF_ARRAY_BOOL: \
case AIN_REF_ARRAY_LONG_INT: \
case AIN_REF_ARRAY_DELEGATE
#define AIN_REF_TYPE \
AIN_REF_INT: \
case AIN_REF_FLOAT: \
case AIN_REF_STRING: \
case AIN_REF_STRUCT: \
case AIN_REF_ARRAY_INT: \
case AIN_REF_ARRAY_FLOAT: \
case AIN_REF_ARRAY_STRING: \
case AIN_REF_ARRAY_STRUCT: \
case AIN_REF_FUNC_TYPE: \
case AIN_REF_ARRAY_FUNC_TYPE: \
case AIN_REF_BOOL: \
case AIN_REF_ARRAY_BOOL: \
case AIN_REF_LONG_INT: \
case AIN_REF_ARRAY_LONG_INT: \
case AIN_REF_ARRAY_DELEGATE
enum ain_variable_type {
AIN_VAR_LOCAL,
AIN_VAR_MEMBER
};
struct ain_type {
enum ain_data_type data; // data type
int32_t struc; // struct type (index into ain->structures)
int32_t rank; // array rank (if array type)
struct ain_type *array_type;
};
struct ain_variable {
char *name;
char *name2;
struct ain_type type;
int32_t has_initval;
union {
char *s;
int32_t i;
float f;
} initval;
int32_t group_index;
enum ain_variable_type var_type;
};
struct ain_function {
int32_t address;
char *name;
bool is_label;
struct ain_type return_type;
int32_t nr_args;
int32_t nr_vars;
int32_t is_lambda; // XXX: if this = 1, then function is a lambda; but not all lambdas have this = 1
int32_t crc;
struct ain_variable *vars;
};
struct ain_initval {
int32_t global_index;
int32_t data_type;
union {
char *string_value;
int32_t int_value;
};
};
struct ain_interface {
int32_t struct_type;
int32_t uk;
};
struct ain_struct {
char *name;
int32_t nr_interfaces;
struct ain_interface *interfaces;
int32_t constructor;
int32_t destructor;
int32_t nr_members;
struct ain_variable *members;
};
struct ain_hll_argument {
char *name;
int32_t data_type;
};
struct ain_hll_function {
char *name;
int32_t data_type;
int32_t nr_arguments;
struct ain_hll_argument *arguments;
};
struct ain_library {
char *name;
int32_t nr_functions;
struct ain_hll_function *functions;
};
struct ain_switch_case {
int32_t value;
int32_t address;
};
struct ain_switch {
int32_t case_type;
int32_t default_address;
int32_t nr_cases;
struct ain_switch_case *cases;
};
struct ain_function_type {
char *name;
struct ain_type return_type;
int32_t nr_arguments;
int32_t nr_variables;
struct ain_variable *variables;
};
struct ain {
char *ain_path;
int32_t version;
int32_t keycode;
uint8_t *code;
size_t code_size;
int32_t nr_functions;
struct ain_function *functions;
int32_t nr_globals;
struct ain_variable *globals;
int32_t nr_initvals;
struct ain_initval *global_initvals;
int32_t nr_structures;
struct ain_struct *structures;
int32_t nr_messages;
struct string **messages;
int32_t main;
int32_t alloc;
int32_t msgf;
int32_t nr_libraries;
struct ain_library *libraries;
int32_t nr_switches;
struct ain_switch *switches;
int32_t game_version;
int32_t nr_strings;
struct string **strings;
int32_t nr_filenames;
char **filenames;
int32_t ojmp;
int nr_function_types;
struct ain_function_type *function_types;
int nr_delegates;
struct ain_function_type *delegates;
int32_t nr_global_groups;
char **global_group_names;
int32_t nr_enums;
char **enums;
};
const char *ain_strerror(int error);
const char *ain_strtype(struct ain *ain, enum ain_data_type type, int struct_type);
char *ain_strtype_d(struct ain *ain, struct ain_type *v);
const char *ain_variable_to_string(struct ain *ain, struct ain_variable *v);
uint8_t *ain_read(const char *path, long *len, int *error);
struct ain *ain_open(const char *path, int *error);
void ain_free(struct ain *ain);
#endif /* SYSTEM4_AIN_H */
Reference in New Issue View Git Blame Copy Permalink