oberon.h

   1 #ifndef EMBEDED_OBERON_SCRIPT_H
   2 #define EMBEDED_OBERON_SCRIPT_H
   3
   4 #include <libgccjit.h>
   5
   6 typedef struct gen_proc_s gen_proc_t;
   7 typedef struct gen_type_s gen_type_t;
   8 typedef struct gen_var_s gen_var_t;
   9 typedef struct gen_block_s gen_block_t;
  10 typedef struct gen_context_s gen_context_t;
  11
  12 struct gen_proc_s
  13 {
  14         gcc_jit_function * gcc_func;
  15 };
  16
  17 struct gen_type_s
  18 {
  19         gcc_jit_type * gcc_type;
  20         gcc_jit_struct * gcc_struct;
  21 };
  22
  23 struct gen_var_s
  24 {
  25         gcc_jit_lvalue * gcc_lvalue;
  26         gcc_jit_param * gcc_param;
  27         gcc_jit_field * gcc_field;
  28 };
  29
  30 struct gen_block_s
  31 {
  32         gcc_jit_block * gcc_block;
  33         gen_block_t * up;
  34 };
  35
  36 struct gen_context_s
  37 {
  38         gcc_jit_context * gcc_context;
  39         gcc_jit_result * gcc_result;
  40         gen_block_t * block;
  41         unsigned record_count;
  42 };
  43
  44 typedef struct oberon_type_s oberon_type_t;
  45 typedef struct oberon_object_s oberon_object_t;
  46 typedef struct oberon_module_s oberon_module_t;
  47 typedef struct oberon_context_s oberon_context_t;
  48 typedef struct oberon_scope_s oberon_scope_t;
  49
  50 typedef struct oberon_item_s oberon_item_t;
  51 typedef struct oberon_oper_s oberon_oper_t;
  52 typedef union oberon_expr_u oberon_expr_t;
  53
  54 /*
  55  * Структура oberon_scope_s (oberon_type_t) реализует стекообразную
  56  * область видимости объектов.
  57  * Поля:
  58  *   ctx  -- контекст в котором область видимости была создана;
  59  *   list -- список объявлений. Первый элемент всегда существует,
  60  *           но не используется и должен быть пропущен.
  61  *   up   -- ссылка на облась видимости уровнем выше.
  62  */
  63
  64 struct oberon_scope_s
  65 {
  66         oberon_context_t * ctx;
  67         oberon_object_t * list;
  68         oberon_scope_t * up;
  69
  70         oberon_object_t * parent;
  71         int local;
  72 };
  73
  74 /*
  75  * Формы типов данных.
  76  * Тип VOID используется как заглушка возврата типа в обычных процедурах
  77  */
  78
  79 enum
  80 {
  81         OBERON_TYPE_VOID,
  82         OBERON_TYPE_INTEGER,
  83         OBERON_TYPE_BOOLEAN,
  84         OBERON_TYPE_PROCEDURE,
  85         OBERON_TYPE_ARRAY,
  86         OBERON_TYPE_RECORD,
  87         OBERON_TYPE_POINTER
  88 };
  89
  90 /*
  91  * Структура oberon_type_s (oberon_type_t) описывает типы данных.
  92  * Поля:
  93  *   class -- Форма типа данных (OBERON_TYPE_*).
  94  *   size  -- Размер примитива в байтах или количество ячеек массива.
  95  *            Ноль для открытых массивов.
  96  *   num_decl -- Количество объявленых полей в структуре или сигнатуре процедуры.
  97  *   base  -- Базовый тип структуры или тип возврата процедуры.
  98  *   decl -- Список объявлений. Перебор начинается с первого элемента.
  99  *
 100  * Таблица использования полей:
 101  *   class size num_decl base decl
 102  *   VOID  -    -        -    -
 103  *   INT   +    -        -    -
 104  *   BOOL  +    -        -    -
 105  *   PROC  -    +        +    +
 106  */
 107
 108 struct oberon_type_s
 109 {
 110         int class;
 111         int size;
 112
 113         int num_decl;
 114         oberon_type_t * base;
 115         oberon_object_t * decl;
 116
 117         oberon_module_t * module;
 118
 119         int recursive;
 120         int initialized;
 121         gen_type_t * gen_type;
 122 };
 123
 124 /*
 125  * Классы объектов.
 126  *   VAR -- переменная.
 127  *   TYPE -- тип данных.
 128  *   PROC -- процедура.
 129  *   PARAM -- параметр процедуры.
 130  *   VAR_PARAM -- VAR-параметр процедуры.
 131  */
 132
 133 enum
 134 {
 135         OBERON_CLASS_VAR,
 136         OBERON_CLASS_TYPE,
 137         OBERON_CLASS_PROC,
 138         OBERON_CLASS_PARAM,
 139         OBERON_CLASS_VAR_PARAM,
 140         OBERON_CLASS_CONST,
 141         OBERON_CLASS_FIELD,
 142         OBERON_CLASS_MODULE
 143 };
 144
 145 /*
 146  * Структура oberon_object_s (oberon_object_t) описывает все
 147  * объявления которые могут иметь имя. От констант, до процедур.
 148  * Поля:
 149  *   name -- имя объекта.
 150  *   class -- класс объекта (OBERON_CLASS_*).
 151  *   type -- ссылка на тип переменной, дескриптор типа или сигнатуру процедуры.
 152  *   next -- ссылка на следующий объект в списке.
 153  */
 154
 155 typedef oberon_expr_t * (*GenerateFuncCallback)(oberon_context_t *, int, oberon_expr_t *);
 156 typedef void (*GenerateProcCallback)(oberon_context_t *, int, oberon_expr_t *);
 157
 158 struct oberon_object_s
 159 {
 160         char * name;
 161         int class;
 162         int export;
 163         int read_only;
 164
 165         int local;
 166         int linked;
 167         int initialized;
 168
 169         oberon_object_t * parent;
 170
 171         oberon_scope_t * scope; // for proc
 172         int has_return; // for proc
 173         int sysproc;
 174         GenerateFuncCallback genfunc;
 175         GenerateProcCallback genproc;
 176
 177         oberon_type_t * type;
 178         oberon_item_t * value;
 179         oberon_object_t * next;
 180
 181         oberon_module_t * module;
 182
 183         gen_var_t * gen_var;
 184         gen_proc_t * gen_proc;
 185 };
 186
 187 /*
 188  * Структура oberon_module_s (oberon_module_t) описывает объявление модуля.
 189  * Поля:
 190  *   name -- настоящее имя модуля.
 191  *   decl -- все глобальные объявления в модуле.
 192  *   begin -- Указатель на сгенерированный код тела модуля (секция BEGIN).
 193  */
 194
 195 struct oberon_module_s
 196 {
 197         char * name;
 198         int ready;
 199
 200         oberon_scope_t * decl;
 201
 202         oberon_module_t * next;
 203 };
 204
 205 /*
 206  * Структура oberon_context_s (oberon_context_t) учитывает текущее состояние интерпретатора.
 207  * Один экземпляр не может использоваться в нескольких потоках одновременно.
 208  * Поля:
 209  *   code    -- входной буффер для сканера.
 210  *   code_index -- Текущая позия в буффере.
 211  *   с       -- последний прочитанный символ.
 212  *   token   -- последний прочитанный токен.
 213  *   string  -- буфер с прочитанной строкой / идентификатором.
 214  *              всегда имеет уникальный адрес и может изменяться.
 215  *   integer -- прочитанное целое число.
 216  *   decl    -- текущая область видимости.
 217  *   mod     -- текущий модуль.
 218  *   int_type, bool_type, void_type -- стандартные типы.
 219  *   world_scope -- область видимости "мир" - выше модуля.
 220  */
 221
 222 typedef const char * (*ModuleImportCallback)(const char * name);
 223
 224 struct oberon_context_s
 225 {
 226         /*** SCANER DATA ***/
 227         const char * code;
 228         int code_index;
 229
 230         char c;
 231         int token;
 232         char * string;
 233         int integer;
 234         /*** END SCANER DATA ***/
 235
 236         /*** PARSER DATA ***/
 237         oberon_scope_t * decl;
 238         oberon_module_t * mod;
 239         /*** END PARSER DATA ***/
 240
 241         oberon_type_t * int_type;
 242         oberon_type_t * bool_type;
 243         oberon_type_t * void_type;
 244         oberon_type_t * void_ptr_type;
 245         oberon_scope_t * world_scope;
 246         oberon_module_t * module_list;
 247         ModuleImportCallback import_module;
 248         gen_context_t * gen_context;
 249 };
 250
 251 enum
 252 {
 253         MODE_VAR,
 254         MODE_INTEGER,
 255         MODE_BOOLEAN,
 256         MODE_CALL,
 257         MODE_INDEX,
 258         MODE_FIELD,
 259         MODE_DEREF,
 260         MODE_NIL
 261 };
 262
 263 enum
 264 {
 265         OP_UNARY_MINUS,
 266         OP_BITWISE_NOT,
 267         OP_LOGIC_NOT,
 268         OP_ABS,
 269
 270         OP_ADD,
 271         OP_SUB,
 272         OP_MUL,
 273         OP_DIV,
 274         OP_MOD,
 275         OP_BITWISE_AND,
 276         OP_BITWISE_XOR,
 277         OP_BITWISE_OP,
 278         OP_LOGIC_AND,
 279         OP_LOGIC_OR,
 280
 281         OP_EQ,
 282         OP_NEQ,
 283         OP_LSS,
 284         OP_LEQ,
 285         OP_GRT,
 286         OP_GEQ
 287 };
 288
 289 struct oberon_item_s
 290 {
 291         int is_item; // == 1
 292         oberon_type_t * result;
 293         oberon_expr_t * next;
 294         int read_only;
 295
 296         int mode;
 297         int integer;
 298         int boolean;
 299         oberon_object_t * var;
 300
 301         oberon_item_t * parent;
 302
 303         int num_args;
 304         oberon_expr_t * args;
 305 };
 306
 307 struct oberon_oper_s
 308 {
 309         int is_item; // == 0
 310         oberon_type_t * result;
 311         oberon_expr_t * next;
 312         int read_only;
 313
 314         int op;
 315         oberon_expr_t * left;
 316         oberon_expr_t * right;
 317 };
 318
 319 union oberon_expr_u
 320 {
 321         struct {
 322                 int is_item;
 323                 oberon_type_t * result;
 324                 oberon_expr_t * next;
 325                 int read_only;
 326         };
 327
 328         oberon_item_t item;
 329         oberon_oper_t oper;
 330 };
 331
 332 oberon_context_t * oberon_create_context(ModuleImportCallback import_module);
 333 void oberon_destroy_context(oberon_context_t * ctx);
 334 void oberon_register_global_type(oberon_context_t * ctx, oberon_type_t * type);
 335 oberon_module_t * oberon_compile_module(oberon_context_t * ctx, const char * code);
 336 void oberon_error(oberon_context_t * ctx, const char * fmt, ...);
 337
 338 #endif // EMBEDED_OBERON_SCRIPT_H