gmqcc.h

   1 /*
   2  * Copyright (C) 2012
   3  *     Dale Weiler, Wolfgang Bumiller
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   6  * this software and associated documentation files (the "Software"), to deal in
   7  * the Software without restriction, including without limitation the rights to
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
   9  * of the Software, and to permit persons to whom the Software is furnished to do
  10  * so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in all
  13  * copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21  * SOFTWARE.
  22  */
  23 #ifndef GMQCC_HDR
  24 #define GMQCC_HDR
  25 #include <limits.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include <stdio.h>
  29 #include <ctype.h>
  30
  31 #define GMQCC_VERSION_MAJOR 0
  32 #define GMQCC_VERSION_MINOR 1
  33 #define GMQCC_VERSION_PATCH 0
  34 #define GMQCC_VERSION_BUILD(J,N,P) (((J)<<16)|((N)<<8)|(P))
  35 #define GMQCC_VERSION \
  36     GMQCC_VERSION_BUILD(GMQCC_VERSION_MAJOR, GMQCC_VERSION_MINOR, GMQCC_VERSION_PATCH)
  37
  38 /*
  39  * We cannoy rely on C99 at all, since compilers like MSVC
  40  * simply don't support it.  We define our own boolean type
  41  * as a result (since we cannot include <stdbool.h>). For
  42  * compilers that are in 1999 mode (C99 compliant) we can use
  43  * the language keyword _Bool which can allow for better code
  44  * on GCC and GCC-like compilers, opposed to `int`.
  45  */
  46 #ifndef __cplusplus
  47 #   ifdef  false
  48 #       undef  false
  49 #   endif /* !false */
  50 #   ifdef  true
  51 #       undef true
  52 #   endif /* !true  */
  53 #   define false (0)
  54 #   define true  (1)
  55 #   ifdef __STDC_VERSION__
  56 #       if __STDC_VERSION__ < 199901L && __GNUC__ < 3
  57             typedef int  bool;
  58 #       else
  59             typedef _Bool bool;
  60 #       endif
  61 #   else
  62         typedef int bool;
  63 #   endif /* !__STDC_VERSION__ */
  64 #endif    /* !__cplusplus      */
  65
  66 /*
  67  * Of some functions which are generated we want to make sure
  68  * that the result isn't ignored. To find such function calls,
  69  * we use this macro.
  70  */
  71 #if defined(__GNUC__) || defined(__CLANG__)
  72 #   define GMQCC_WARN __attribute__((warn_unused_result))
  73 #else
  74 #   define GMQCC_WARN
  75 #endif
  76 /*
  77  * This is a hack to silent clang regarding empty
  78  * body if statements.
  79  */
  80 #define GMQCC_SUPPRESS_EMPTY_BODY do { } while (0)
  81
  82 /*
  83  * Inline is not supported in < C90, however some compilers
  84  * like gcc and clang might have an inline attribute we can
  85  * use if present.
  86  */
  87 #ifdef __STDC_VERSION__
  88 #    if __STDC_VERSION__ < 199901L
  89 #       if defined(__GNUC__) || defined (__CLANG__)
  90 #           if __GNUC__ < 2
  91 #               define GMQCC_INLINE
  92 #           else
  93 #               define GMQCC_INLINE __attribute__ ((always_inline))
  94 #           endif
  95 #       else
  96 #           define GMQCC_INLINE
  97 #       endif
  98 #    else
  99 #       define GMQCC_INLINE inline
 100 #    endif
 101 #else
 102 #    define GMQCC_INLINE
 103 #endif /* !__STDC_VERSION__ */
 104
 105 /*
 106  * noreturn is present in GCC and clang
 107  * it's required for _ast_node_destory otherwise -Wmissing-noreturn
 108  * in clang complains about there being no return since abort() is
 109  * called.
 110  */
 111 #if (defined(__GNUC__) && __GNUC__ >= 2) || defined(__CLANG__)
 112 #    define GMQCC_NORETURN __attribute__ ((noreturn))
 113 #else
 114 #    define GMQCC_NORETURN
 115 #endif
 116
 117 /*
 118  * stdint.h and inttypes.h -less subset
 119  * for systems that don't have it, which we must
 120  * assume is all systems. (int8_t not required)
 121  */
 122 #if   CHAR_MIN  == -128
 123     typedef unsigned char  uint8_t; /* same as below */
 124 #elif SCHAR_MIN == -128
 125     typedef unsigned char  uint8_t; /* same as above */
 126 #endif
 127 #if   SHRT_MAX  == 0x7FFF
 128     typedef short          int16_t;
 129     typedef unsigned short uint16_t;
 130 #elif INT_MAX   == 0x7FFF
 131     typedef int            int16_t;
 132     typedef unsigned int   uint16_t;
 133 #endif
 134 #if   INT_MAX   == 0x7FFFFFFF
 135     typedef int            int32_t;
 136     typedef unsigned int   uint32_t;
 137     typedef long           int64_t;
 138     typedef unsigned long  uint64_t;
 139 #elif LONG_MAX  == 0x7FFFFFFF
 140     typedef long           int32_t;
 141     typedef unsigned long  uint32_t;
 142
 143     /*
 144      * It's nearly impossible to figure out a 64bit type at
 145      * this point without making assumptions about the build
 146      * enviroment.  So if clang or gcc is detected use some
 147      * compiler builtins to create a 64 signed and unsigned
 148      * type.
 149      */
 150 #   if defined(__GNUC__) || defined (__CLANG__)
 151         typedef int          int64_t  __attribute__((__mode__(__DI__)));
 152         typedef unsigned int uint64_t __attribute__((__mode__(__DI__)));
 153 #   else
 154         /*
 155          * Incoorectly size the types so static assertions below will
 156          * fail.  There is no valid way to get a 64bit type at this point
 157          * without making assumptions of too many things.
 158          */
 159         typedef struct { char _fail : 0; } int64_t;
 160         typedef struct { char _fail : 0; } uint64_t;
 161 #   endif
 162 #endif
 163 #ifdef _LP64 /* long pointer == 64 */
 164     typedef unsigned long  uintptr_t;
 165     typedef long           intptr_t;
 166 #else
 167     typedef unsigned int   uintptr_t;
 168     typedef int            intptr_t;
 169 #endif
 170 /* Ensure type sizes are correct: */
 171 typedef char uint8_size_is_correct  [sizeof(uint8_t)  == 1?1:-1];
 172 typedef char uint16_size_is_correct [sizeof(uint16_t) == 2?1:-1];
 173 typedef char uint32_size_is_correct [sizeof(uint32_t) == 4?1:-1];
 174 typedef char uint64_size_is_correct [sizeof(uint64_t) == 8?1:-1];
 175 typedef char int16_size_if_correct  [sizeof(int16_t)  == 2?1:-1];
 176 typedef char int32_size_is_correct  [sizeof(int32_t)  == 4?1:-1];
 177 typedef char int64_size_is_correct  [sizeof(int64_t)  == 8?1:-1];
 178 /* intptr_t / uintptr_t correct size check */
 179 typedef char uintptr_size_is_correct[sizeof(intptr_t) == sizeof(int*)?1:-1];
 180 typedef char intptr_size_is_correct [sizeof(uintptr_t)== sizeof(int*)?1:-1];
 181
 182 /*===================================================================*/
 183 /*============================ lex.c ================================*/
 184 /*===================================================================*/
 185 typedef struct lex_file_t {
 186     FILE *file;        /* file handler */
 187     char *name;        /* name of file */
 188     char  peek  [5];
 189     char  lastok[8192];
 190
 191     int   last;    /* last token                   */
 192     int   current; /* current token                */
 193     int   length;  /* bytes left to parse          */
 194     int   size;    /* never changes (size of file) */
 195     int   line;    /* what line are we on?         */
 196 } lex_file;
 197
 198 /*
 199  * It's important that this table never exceed 32 keywords, the ascii
 200  * table starts at 33 (and we don't want conflicts)
 201  */
 202 enum {
 203     TOKEN_DO       ,
 204     TOKEN_ELSE     ,
 205     TOKEN_IF       ,
 206     TOKEN_WHILE    ,
 207     TOKEN_BREAK    ,
 208     TOKEN_CONTINUE ,
 209     TOKEN_RETURN   ,
 210     TOKEN_GOTO     ,
 211     TOKEN_FOR      ,   /* extension */
 212     TOKEN_TYPEDEF  ,   /* extension */
 213
 214     /* ensure the token types are out of the  */
 215     /* bounds of anyothers that may conflict. */
 216     TOKEN_FLOAT    = 110,
 217     TOKEN_VECTOR        ,
 218     TOKEN_STRING        ,
 219     TOKEN_ENTITY        ,
 220     TOKEN_VOID
 221 };
 222
 223 /*
 224  * Lexer state constants, these are numbers for where exactly in
 225  * the lexing the lexer is at. Or where it decided to stop if a lexer
 226  * error occurs.  These numbers must be > where the ascii-table ends
 227  * and > the last type token which is TOKEN_VOID
 228  */
 229 enum {
 230     LEX_COMMENT = 1128,
 231     LEX_CHRLIT        ,
 232     LEX_STRLIT        ,
 233     LEX_IDENT
 234 };
 235
 236 int       lex_token  (lex_file *);
 237 void      lex_reset  (lex_file *);
 238 void      lex_close  (lex_file *);
 239 void      lex_parse  (lex_file *);
 240 lex_file *lex_include(lex_file *, const char *);
 241 void      lex_init   (const char *, lex_file **);
 242
 243 /*===================================================================*/
 244 /*========================== error.c ================================*/
 245 /*===================================================================*/
 246 #define ERROR_LEX      (SHRT_MAX+0)
 247 #define ERROR_PARSE    (SHRT_MAX+1)
 248 #define ERROR_INTERNAL (SHRT_MAX+2)
 249 #define ERROR_COMPILER (SHRT_MAX+3)
 250 #define ERROR_PREPRO   (SHRT_MAX+4)
 251 int error(lex_file *, int, const char *, ...);
 252
 253 /*===================================================================*/
 254 /*========================== parse.c ================================*/
 255 /*===================================================================*/
 256 int parse_gen(lex_file *);
 257
 258 /*===================================================================*/
 259 /*========================== typedef.c ==============================*/
 260 /*===================================================================*/
 261 typedef struct typedef_node_t {
 262     char      *name;
 263 } typedef_node;
 264
 265 void          typedef_init();
 266 void          typedef_clear();
 267 typedef_node *typedef_find(const char *);
 268 int           typedef_add (lex_file *file, const char *, const char *);
 269
 270
 271 /*===================================================================*/
 272 /*=========================== util.c ================================*/
 273 /*===================================================================*/
 274 void *util_memory_a      (unsigned int, unsigned int, const char *);
 275 void  util_memory_d      (void       *, unsigned int, const char *);
 276 void  util_meminfo       ();
 277
 278 bool  util_strupper      (const char *);
 279 bool  util_strdigit      (const char *);
 280 bool  util_strncmpexact  (const char *, const char *, size_t);
 281 char *util_strdup        (const char *);
 282 char *util_strrq         (const char *);
 283 char *util_strrnl        (const char *);
 284 char *util_strsws        (const char *);
 285 char *util_strchp        (const char *, const char *);
 286 void  util_debug         (const char *, const char *, ...);
 287 int   util_getline       (char **, size_t *, FILE *);
 288 void  util_endianswap    (void *,  int, int);
 289
 290 uint32_t util_crc32(const char *, int, register const short);
 291
 292 #ifdef NOTRACK
 293 #    define mem_a(x) malloc(x)
 294 #    define mem_d(x) free  (x)
 295 #else
 296 #    define mem_a(x) util_memory_a((x), __LINE__, __FILE__)
 297 #    define mem_d(x) util_memory_d((x), __LINE__, __FILE__)
 298 #endif
 299
 300 /*
 301  * TODO: make these safer to use.  Currently this only works on
 302  * x86 and x86_64, some systems will likely not like this. Such
 303  * as BE systems.
 304  */
 305 #define FLT2INT(Y) *((int32_t*)&(Y))
 306 #define INT2FLT(Y) *((float  *)&(Y))
 307
 308 /* Builds vector type (usefull for inside structures) */
 309 #define VECTOR_SNAP(X,Y) X ## Y
 310 #define VECTOR_FILL(X,Y) VECTOR_SNAP(X,Y)
 311 #define VECTOR_TYPE(T,N)                                        \
 312     T*     N##_data      = NULL;                                \
 313     long   N##_elements  = 0;                                   \
 314     long   N##_allocated = 0
 315 /* Builds vector add */
 316 #define VECTOR_CORE(T,N)                                        \
 317     int    N##_add(T element) {                                 \
 318         void *temp = NULL;                                      \
 319         if (N##_elements == N##_allocated) {                    \
 320             if (N##_allocated == 0) {                           \
 321                 N##_allocated = 12;                             \
 322             } else {                                            \
 323                 N##_allocated *= 2;                             \
 324             }                                                   \
 325             if  (!(temp = mem_a(N##_allocated * sizeof(T)))) {  \
 326                 mem_d(temp);                                    \
 327                 return -1;                                      \
 328             }                                                   \
 329             memcpy(temp, N##_data, (N##_elements * sizeof(T))); \
 330             mem_d(N##_data);                                    \
 331             N##_data = (T*)temp;                                \
 332         }                                                       \
 333         N##_data[N##_elements] = element;                       \
 334         return   N##_elements++;                                \
 335     }                                                           \
 336     int N##_put(T* elements, size_t len) {                      \
 337         len     --;                                             \
 338         elements--;                                             \
 339         while (N##_add(*++elements) != -1 && len--);            \
 340         return N##_elements;                                    \
 341     }                                                           \
 342     typedef char VECTOR_FILL(extra_semicolon_,__COUNTER__)
 343 #define VECTOR_PROT(T,N)                                        \
 344     extern T*     N##_data     ;                                \
 345     extern long   N##_elements ;                                \
 346     extern long   N##_allocated;                                \
 347     int           N##_add(T);                                   \
 348     int           N##_put(T *, size_t)
 349 #define VECTOR_MAKE(T,N) \
 350     VECTOR_TYPE(T,N);    \
 351     VECTOR_CORE(T,N)
 352
 353 /*===================================================================*/
 354 /*=========================== code.c ================================*/
 355 /*===================================================================*/
 356
 357 /* Note: if you change the order, fix type_sizeof in ir.c */
 358 enum {
 359     TYPE_VOID     ,
 360     TYPE_STRING   ,
 361     TYPE_FLOAT    ,
 362     TYPE_VECTOR   ,
 363     TYPE_ENTITY   ,
 364     TYPE_FIELD    ,
 365     TYPE_FUNCTION ,
 366     TYPE_POINTER  ,
 367     /* TYPE_INTEGER  , */
 368     TYPE_VARIANT  ,
 369
 370     TYPE_COUNT
 371 };
 372
 373 extern size_t type_sizeof[TYPE_COUNT];
 374 extern uint16_t type_store_instr[TYPE_COUNT];
 375 /* could use type_store_instr + INSTR_STOREP_F - INSTR_STORE_F
 376  * but this breaks when TYPE_INTEGER is added, since with the enhanced
 377  * instruction set, the old ones are left untouched, thus the _I instructions
 378  * are at a seperate place.
 379  */
 380 extern uint16_t type_storep_instr[TYPE_COUNT];
 381
 382 typedef struct {
 383     uint32_t offset;      /* Offset in file of where data begins  */
 384     uint32_t length;      /* Length of section (how many of)      */
 385 } prog_section;
 386
 387 typedef struct {
 388     uint32_t     version;      /* Program version (6)     */
 389     uint16_t     crc16;        /* What is this?           */
 390     uint16_t     skip;         /* see propsal.txt         */
 391
 392     prog_section statements;   /* prog_section_statement  */
 393     prog_section defs;         /* prog_section_def        */
 394     prog_section fields;       /* prog_section_field      */
 395     prog_section functions;    /* prog_section_function   */
 396     prog_section strings;      /* What is this?           */
 397     prog_section globals;      /* What is this?           */
 398     uint32_t     entfield;     /* Number of entity fields */
 399 } prog_header;
 400
 401 /*
 402  * Each paramater incerements by 3 since vector types hold
 403  * 3 components (x,y,z).
 404  */
 405 #define OFS_NULL      0
 406 #define OFS_RETURN    1
 407 #define OFS_PARM0     (OFS_RETURN+3)
 408 #define OFS_PARM1     (OFS_PARM0 +3)
 409 #define OFS_PARM2     (OFS_PARM1 +3)
 410 #define OFS_PARM3     (OFS_PARM2 +3)
 411 #define OFS_PARM4     (OFS_PARM3 +3)
 412 #define OFS_PARM5     (OFS_PARM4 +3)
 413 #define OFS_PARM6     (OFS_PARM5 +3)
 414 #define OFS_PARM7     (OFS_PARM6 +3)
 415
 416 typedef struct {
 417     uint16_t opcode;
 418
 419     /* operand 1 */
 420     union {
 421         int16_t  s1; /* signed   */
 422         uint16_t u1; /* unsigned */
 423     } o1;
 424     /* operand 2 */
 425     union {
 426         int16_t  s1; /* signed   */
 427         uint16_t u1; /* unsigned */
 428     } o2;
 429     /* operand 3 */
 430     union {
 431         int16_t  s1; /* signed   */
 432         uint16_t u1; /* unsigned */
 433     } o3;
 434
 435     /*
 436      * This is the same as the structure in darkplaces
 437      * {
 438      *     unsigned short op;
 439      *     short          a,b,c;
 440      * }
 441      * But this one is more sane to work with, and the
 442      * type sizes are guranteed.
 443      */
 444 } prog_section_statement;
 445
 446 typedef struct {
 447     /* The types:
 448      * 0 = ev_void
 449      * 1 = ev_string
 450      * 2 = ev_float
 451      * 3 = ev_vector
 452      * 4 = ev_entity
 453      * 5 = ev_field
 454      * 6 = ev_function
 455      * 7 = ev_pointer -- engine only
 456      * 8 = ev_bad     -- engine only
 457      */
 458     uint16_t type;
 459     uint16_t offset;
 460     uint32_t name;
 461 } prog_section_both;
 462 typedef prog_section_both prog_section_def;
 463 typedef prog_section_both prog_section_field;
 464
 465 typedef struct {
 466     int32_t   entry;      /* in statement table for instructions  */
 467     uint32_t  firstlocal; /* First local in local table           */
 468     uint32_t  locals;     /* Total ints of params + locals        */
 469     uint32_t  profile;    /* Always zero (engine uses this)       */
 470     uint32_t  name;       /* name of function in string table     */
 471     uint32_t  file;       /* file of the source file              */
 472     uint32_t  nargs;      /* number of arguments                  */
 473     uint8_t   argsize[8]; /* size of arguments (keep 8 always?)   */
 474 } prog_section_function;
 475
 476 /*
 477  * Instructions
 478  * These are the external instructions supported by the interperter
 479  * this is what things compile to (from the C code).
 480  */
 481 enum {
 482     INSTR_DONE,
 483     INSTR_MUL_F,
 484     INSTR_MUL_V,
 485     INSTR_MUL_FV,
 486     INSTR_MUL_VF,
 487     INSTR_DIV_F,
 488     INSTR_ADD_F,
 489     INSTR_ADD_V,
 490     INSTR_SUB_F,
 491     INSTR_SUB_V,
 492     INSTR_EQ_F,
 493     INSTR_EQ_V,
 494     INSTR_EQ_S,
 495     INSTR_EQ_E,
 496     INSTR_EQ_FNC,
 497     INSTR_NE_F,
 498     INSTR_NE_V,
 499     INSTR_NE_S,
 500     INSTR_NE_E,
 501     INSTR_NE_FNC,
 502     INSTR_LE,
 503     INSTR_GE,
 504     INSTR_LT,
 505     INSTR_GT,
 506     INSTR_LOAD_F,
 507     INSTR_LOAD_V,
 508     INSTR_LOAD_S,
 509     INSTR_LOAD_ENT,
 510     INSTR_LOAD_FLD,
 511     INSTR_LOAD_FNC,
 512     INSTR_ADDRESS,
 513     INSTR_STORE_F,
 514     INSTR_STORE_V,
 515     INSTR_STORE_S,
 516     INSTR_STORE_ENT,
 517     INSTR_STORE_FLD,
 518     INSTR_STORE_FNC,
 519     INSTR_STOREP_F,
 520     INSTR_STOREP_V,
 521     INSTR_STOREP_S,
 522     INSTR_STOREP_ENT,
 523     INSTR_STOREP_FLD,
 524     INSTR_STOREP_FNC,
 525     INSTR_RETURN,
 526     INSTR_NOT_F,
 527     INSTR_NOT_V,
 528     INSTR_NOT_S,
 529     INSTR_NOT_ENT,
 530     INSTR_NOT_FNC,
 531     INSTR_IF,
 532     INSTR_IFNOT,
 533     INSTR_CALL0,
 534     INSTR_CALL1,
 535     INSTR_CALL2,
 536     INSTR_CALL3,
 537     INSTR_CALL4,
 538     INSTR_CALL5,
 539     INSTR_CALL6,
 540     INSTR_CALL7,
 541     INSTR_CALL8,
 542     INSTR_STATE,
 543     INSTR_GOTO,
 544     INSTR_AND,
 545     INSTR_OR,
 546     INSTR_BITAND,
 547     INSTR_BITOR,
 548
 549     /*
 550      * Virtual instructions used by the assembler
 551      * keep at the end but before virtual instructions
 552      * for the IR below.
 553      */
 554     AINSTR_END,
 555
 556     /*
 557      * Virtual instructions used by the IR
 558      * Keep at the end!
 559      */
 560     VINSTR_PHI,
 561     VINSTR_JUMP,
 562     VINSTR_COND
 563 };
 564
 565 /*
 566  * The symbols below are created by the following
 567  * expanded macros:
 568  *
 569  * VECTOR_MAKE(prog_section_statement, code_statements);
 570  * VECTOR_MAKE(prog_section_def,       code_defs      );
 571  * VECTOR_MAKE(prog_section_field,     code_fields    );
 572  * VECTOR_MAKE(prog_section_function,  code_functions );
 573  * VECTOR_MAKE(int,                    code_globals   );
 574  * VECTOR_MAKE(char,                   code_chars     );
 575  */
 576 VECTOR_PROT(prog_section_statement, code_statements);
 577 VECTOR_PROT(prog_section_statement, code_statements);
 578 VECTOR_PROT(prog_section_def,       code_defs      );
 579 VECTOR_PROT(prog_section_field,     code_fields    );
 580 VECTOR_PROT(prog_section_function,  code_functions );
 581 VECTOR_PROT(int,                    code_globals   );
 582 VECTOR_PROT(char,                   code_chars     );
 583
 584 /*
 585  * code_write -- writes out the compiled file
 586  * code_init  -- prepares the code file
 587  */
 588 bool     code_write       (const char *filename);
 589 void     code_init        ();
 590 uint32_t code_genstring   (const char *string);
 591 uint32_t code_cachedstring(const char *string);
 592
 593 /*===================================================================*/
 594 /*========================= assembler.c =============================*/
 595 /*===================================================================*/
 596 static const struct {
 597     const char  *m; /* menomic     */
 598     const size_t o; /* operands    */
 599     const size_t l; /* menomic len */
 600 } asm_instr[] = {
 601     { "DONE"      , 1, 4 },
 602     { "MUL_F"     , 3, 5 },
 603     { "MUL_V"     , 3, 5 },
 604     { "MUL_FV"    , 3, 6 },
 605     { "MUL_VF"    , 3, 6 },
 606     { "DIV"       , 0, 3 },
 607     { "ADD_F"     , 3, 5 },
 608     { "ADD_V"     , 3, 5 },
 609     { "SUB_F"     , 3, 5 },
 610     { "DUB_V"     , 3, 5 },
 611     { "EQ_F"      , 0, 4 },
 612     { "EQ_V"      , 0, 4 },
 613     { "EQ_S"      , 0, 4 },
 614     { "EQ_E"      , 0, 4 },
 615     { "EQ_FNC"    , 0, 6 },
 616     { "NE_F"      , 0, 4 },
 617     { "NE_V"      , 0, 4 },
 618     { "NE_S"      , 0, 4 },
 619     { "NE_E"      , 0, 4 },
 620     { "NE_FNC"    , 0, 6 },
 621     { "LE"        , 0, 2 },
 622     { "GE"        , 0, 2 },
 623     { "LT"        , 0, 2 },
 624     { "GT"        , 0, 2 },
 625     { "FIELD_F"   , 0, 7 },
 626     { "FIELD_V"   , 0, 7 },
 627     { "FIELD_S"   , 0, 7 },
 628     { "FIELD_ENT" , 0, 9 },
 629     { "FIELD_FLD" , 0, 9 },
 630     { "FIELD_FNC" , 0, 9 },
 631     { "ADDRESS"   , 0, 7 },
 632     { "STORE_F"   , 0, 7 },
 633     { "STORE_V"   , 0, 7 },
 634     { "STORE_S"   , 0, 7 },
 635     { "STORE_ENT" , 0, 9 },
 636     { "STORE_FLD" , 0, 9 },
 637     { "STORE_FNC" , 0, 9 },
 638     { "STOREP_F"  , 0, 8 },
 639     { "STOREP_V"  , 0, 8 },
 640     { "STOREP_S"  , 0, 8 },
 641     { "STOREP_ENT", 0, 10},
 642     { "STOREP_FLD", 0, 10},
 643     { "STOREP_FNC", 0, 10},
 644     { "RETURN"    , 0, 6 },
 645     { "NOT_F"     , 0, 5 },
 646     { "NOT_V"     , 0, 5 },
 647     { "NOT_S"     , 0, 5 },
 648     { "NOT_ENT"   , 0, 7 },
 649     { "NOT_FNC"   , 0, 7 },
 650     { "IF"        , 0, 2 },
 651     { "IFNOT"     , 0, 5 },
 652     { "CALL0"     , 1, 5 },
 653     { "CALL1"     , 2, 5 },
 654     { "CALL2"     , 3, 5 },
 655     { "CALL3"     , 4, 5 },
 656     { "CALL4"     , 5, 5 },
 657     { "CALL5"     , 6, 5 },
 658     { "CALL6"     , 7, 5 },
 659     { "CALL7"     , 8, 5 },
 660     { "CALL8"     , 9, 5 },
 661     { "STATE"     , 0, 5 },
 662     { "GOTO"      , 0, 4 },
 663     { "AND"       , 0, 3 },
 664     { "OR"        , 0, 2 },
 665     { "BITAND"    , 0, 6 },
 666     { "BITOR"     , 0, 5 },
 667     { "END"       , 0, 3 } /* virtual assembler instruction */
 668 };
 669
 670 void asm_init (const char *, FILE **);
 671 void asm_close(FILE *);
 672 void asm_parse(FILE *);
 673 /*===================================================================*/
 674 /*============================= main.c ==============================*/
 675 /*===================================================================*/
 676 enum {
 677     COMPILER_QCC,     /* circa  QuakeC */
 678     COMPILER_FTEQCC,  /* fteqcc QuakeC */
 679     COMPILER_QCCX,    /* qccx   QuakeC */
 680     COMPILER_GMQCC    /* this   QuakeC */
 681 };
 682 extern bool opts_debug;
 683 extern bool opts_memchk;
 684 extern bool opts_darkplaces_stringtablebug;
 685 extern bool opts_omit_nullcode;
 686 extern int  opts_compiler;
 687 /*===================================================================*/
 688 /*============================= ast.c ===============================*/
 689 /*===================================================================*/
 690 #define MEM_VECTOR_PROTO(Towner, Tmem, mem)                   \
 691     bool GMQCC_WARN Towner##_##mem##_add(Towner*, Tmem);      \
 692     bool GMQCC_WARN Towner##_##mem##_remove(Towner*, size_t)
 693
 694 #define MEM_VECTOR_PROTO_ALL(Towner, Tmem, mem)                    \
 695     MEM_VECTOR_PROTO(Towner, Tmem, mem);                           \
 696     bool GMQCC_WARN Towner##_##mem##_find(Towner*, Tmem, size_t*); \
 697     void Towner##_##mem##_clear(Towner*)
 698
 699 #define MEM_VECTOR_MAKE(Twhat, name) \
 700     Twhat  *name;                    \
 701     size_t name##_count;             \
 702     size_t name##_alloc
 703
 704 #define MEM_VEC_FUN_ADD(Tself, Twhat, mem)                           \
 705 bool GMQCC_WARN Tself##_##mem##_add(Tself *self, Twhat f)            \
 706 {                                                                    \
 707     Twhat *reall;                                                    \
 708     if (self->mem##_count == self->mem##_alloc) {                    \
 709         if (!self->mem##_alloc) {                                    \
 710             self->mem##_alloc = 16;                                  \
 711         } else {                                                     \
 712             self->mem##_alloc *= 2;                                  \
 713         }                                                            \
 714         reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_alloc);    \
 715         if (!reall) {                                                \
 716             return false;                                            \
 717         }                                                            \
 718         memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
 719         mem_d(self->mem);                                            \
 720         self->mem = reall;                                           \
 721     }                                                                \
 722     self->mem[self->mem##_count++] = f;                              \
 723     return true;                                                     \
 724 }
 725
 726 #define MEM_VEC_FUN_REMOVE(Tself, Twhat, mem)                        \
 727 bool GMQCC_WARN Tself##_##mem##_remove(Tself *self, size_t idx)      \
 728 {                                                                    \
 729     size_t i;                                                        \
 730     Twhat *reall;                                                    \
 731     if (idx >= self->mem##_count) {                                  \
 732         return true; /* huh... */                                    \
 733     }                                                                \
 734     for (i = idx; i < self->mem##_count-1; ++i) {                    \
 735         self->mem[i] = self->mem[i+1];                               \
 736     }                                                                \
 737     self->mem##_count--;                                             \
 738     if (self->mem##_count < self->mem##_count/2) {                   \
 739         self->mem##_alloc /= 2;                                      \
 740         reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_count);    \
 741         if (!reall) {                                                \
 742             return false;                                            \
 743         }                                                            \
 744         memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
 745         mem_d(self->mem);                                            \
 746         self->mem = reall;                                           \
 747     }                                                                \
 748     return true;                                                     \
 749 }
 750
 751 #define MEM_VEC_FUN_FIND(Tself, Twhat, mem)                     \
 752 bool GMQCC_WARN Tself##_##mem##_find(Tself *self, Twhat obj, size_t *idx) \
 753 {                                                               \
 754     size_t i;                                                   \
 755     for (i = 0; i < self->mem##_count; ++i) {                   \
 756         if (self->mem[i] == obj) {                              \
 757             if (idx) {                                          \
 758                 *idx = i;                                       \
 759             }                                                   \
 760             return true;                                        \
 761         }                                                       \
 762     }                                                           \
 763     return false;                                               \
 764 }
 765
 766 #define MEM_VEC_FUN_APPEND(Tself, Twhat, mem)                        \
 767 bool GMQCC_WARN Tself##_##mem##_append(Tself *s, Twhat *p, size_t c) \
 768 {                                                                    \
 769     Twhat *reall;                                                    \
 770     if (s->mem##_count+c >= s->mem##_alloc) {                        \
 771         if (!s->mem##_alloc) {                                       \
 772             s->mem##_alloc = c < 16 ? 16 : c;                        \
 773         } else {                                                     \
 774             s->mem##_alloc *= 2;                                     \
 775             if (s->mem##_count+c >= s->mem##_alloc) {                \
 776                 s->mem##_alloc = s->mem##_count+c;                   \
 777             }                                                        \
 778         }                                                            \
 779         reall = (Twhat*)mem_a(sizeof(Twhat) * s->mem##_alloc);       \
 780         if (!reall) {                                                \
 781             return false;                                            \
 782         }                                                            \
 783         memcpy(reall, s->mem, sizeof(Twhat) * s->mem##_count);       \
 784         mem_d(s->mem);                                               \
 785         s->mem = reall;                                              \
 786     }                                                                \
 787     memcpy(&s->mem[s->mem##_count], p, c*sizeof(*p));                \
 788     s->mem##_count += c;                                             \
 789     return true;                                                     \
 790 }
 791
 792 #define MEM_VEC_FUN_RESIZE(Tself, Twhat, mem)                    \
 793 bool GMQCC_WARN Tself##_##mem##_resize(Tself *s, size_t c)       \
 794 {                                                                \
 795     Twhat *reall;                                                \
 796     if (c > s->mem##_alloc) {                                    \
 797         reall = (Twhat*)mem_a(sizeof(Twhat) * c);                \
 798         if (!reall) { return false; }                            \
 799         memcpy(reall, s->mem, sizeof(Twhat) * s->mem##_count);   \
 800         s->mem##_alloc = c;                                      \
 801         mem_d(s->mem);                                           \
 802         s->mem = reall;                                          \
 803         return true;                                             \
 804     }                                                            \
 805     s->mem##_count = c;                                          \
 806     if (c < (s->mem##_alloc / 2)) {                              \
 807         reall = (Twhat*)mem_a(sizeof(Twhat) * c);                \
 808         if (!reall) { return false; }                            \
 809         memcpy(reall, s->mem, sizeof(Twhat) * c);                \
 810         mem_d(s->mem);                                           \
 811         s->mem = reall;                                          \
 812     }                                                            \
 813     return true;                                                 \
 814 }
 815
 816 #define MEM_VEC_FUN_CLEAR(Tself, mem)   \
 817 void Tself##_##mem##_clear(Tself *self) \
 818 {                                       \
 819     if (!self->mem)                     \
 820         return;                         \
 821     mem_d((void*) self->mem);           \
 822     self->mem = NULL;                   \
 823     self->mem##_count = 0;              \
 824     self->mem##_alloc = 0;              \
 825 }
 826
 827 #define MEM_VECTOR_CLEAR(owner, mem)  \
 828     if ((owner)->mem)                 \
 829         mem_d((void*)((owner)->mem)); \
 830     (owner)->mem = NULL;              \
 831     (owner)->mem##_count = 0;         \
 832     (owner)->mem##_alloc = 0
 833
 834 #define MEM_VECTOR_INIT(owner, mem) \
 835 {                                   \
 836     (owner)->mem = NULL;            \
 837     (owner)->mem##_count = 0;       \
 838     (owner)->mem##_alloc = 0;       \
 839 }
 840
 841 #define MEM_VEC_FUNCTIONS(Tself, Twhat, mem) \
 842 MEM_VEC_FUN_REMOVE(Tself, Twhat, mem)        \
 843 MEM_VEC_FUN_ADD(Tself, Twhat, mem)
 844
 845 #define MEM_VEC_FUNCTIONS_ALL(Tself, Twhat, mem) \
 846 MEM_VEC_FUNCTIONS(Tself, Twhat, mem)             \
 847 MEM_VEC_FUN_CLEAR(Tself, mem)                    \
 848 MEM_VEC_FUN_FIND(Tself, Twhat, mem)
 849
 850 enum store_types {
 851     store_global,
 852     store_local,  /* local, assignable for now, should get promoted later */
 853     store_param,  /* parameters, they are locals with a fixed position */
 854     store_value,  /* unassignable */
 855     store_return  /* unassignable, at OFS_RETURN */
 856 };
 857
 858 typedef struct {
 859     float x, y, z;
 860 } vector;
 861
 862 /*
 863  * A shallow copy of a lex_file to remember where which ast node
 864  * came from.
 865  */
 866 typedef struct {
 867     const char *file;
 868     size_t      line;
 869 } lex_ctx;
 870
 871 /*===================================================================*/
 872 /*============================= exec.c ==============================*/
 873 /*===================================================================*/
 874
 875 /* darkplaces has (or will have) a 64 bit prog loader
 876  * where the 32 bit qc program is autoconverted on load.
 877  * Since we may want to support that as well, let's redefine
 878  * float and int here.
 879  */
 880 typedef float   qcfloat;
 881 typedef int32_t qcint;
 882
 883 typedef union {
 884     qcint   _int;
 885     qcint    string;
 886     qcint    function;
 887     qcint    edict;
 888     qcfloat _float;
 889     qcfloat vector[3];
 890     qcint   ivector[3];
 891 } qcany;
 892
 893 typedef char qcfloat_size_is_correct [sizeof(qcfloat) == 4 ?1:-1];
 894 typedef char qcint_size_is_correct   [sizeof(qcint)   == 4 ?1:-1];
 895
 896 enum {
 897     VMERR_OK,
 898     VMERR_TEMPSTRING_ALLOC,
 899
 900     VMERR_END
 901 };
 902
 903 #define VM_JUMPS_DEFAULT 1000000
 904
 905 /* execute-flags */
 906 #define VMXF_DEFAULT 0x0000     /* default flags - nothing */
 907 #define VMXF_TRACE   0x0001     /* trace: print statements before executing */
 908 #define VMXF_PROFILE 0x0002     /* profile: increment the profile counters */
 909
 910 struct qc_program_s;
 911
 912 typedef int (*prog_builtin)(struct qc_program_s *prog);
 913
 914 typedef struct {
 915     qcint                  stmt;
 916     size_t                 localsp;
 917     prog_section_function *function;
 918 } qc_exec_stack;
 919
 920 typedef struct qc_program_s {
 921     char           *filename;
 922
 923     MEM_VECTOR_MAKE(prog_section_statement, code);
 924     MEM_VECTOR_MAKE(prog_section_def,       defs);
 925     MEM_VECTOR_MAKE(prog_section_def,       fields);
 926     MEM_VECTOR_MAKE(prog_section_function,  functions);
 927     MEM_VECTOR_MAKE(char,                   strings);
 928     MEM_VECTOR_MAKE(qcint,                  globals);
 929     MEM_VECTOR_MAKE(qcint,                  entitydata);
 930
 931     size_t tempstring_start;
 932     size_t tempstring_at;
 933
 934     qcint  vmerror;
 935
 936     MEM_VECTOR_MAKE(size_t, profile);
 937
 938     MEM_VECTOR_MAKE(prog_builtin, builtins);
 939
 940     /* size_t ip; */
 941     qcint  entities;
 942     size_t entityfields;
 943     bool   allowworldwrites;
 944
 945     MEM_VECTOR_MAKE(qcint,         localstack);
 946     MEM_VECTOR_MAKE(qc_exec_stack, stack);
 947     size_t statement;
 948
 949     int    argc; /* current arg count for debugging */
 950 } qc_program;
 951
 952 qc_program* prog_load(const char *filename);
 953 void        prog_delete(qc_program *prog);
 954
 955 bool prog_exec(qc_program *prog, prog_section_function *func, size_t flags, long maxjumps);
 956
 957 char*             prog_getstring (qc_program *prog, qcint str);
 958 prog_section_def* prog_entfield  (qc_program *prog, qcint off);
 959 prog_section_def* prog_getdef    (qc_program *prog, qcint off);
 960 qcany*            prog_getedict  (qc_program *prog, qcint e);
 961 qcint             prog_tempstring(qc_program *prog, const char *_str);
 962
 963 /*===================================================================*/
 964 /*======================= main.c commandline ========================*/
 965 /*===================================================================*/
 966
 967 #if 0
 968 /* Helpers to allow for a whole lot of flags. Otherwise we'd limit
 969  * to 32 or 64 -f options...
 970  */
 971 typedef struct {
 972     size_t  idx; /* index into an array of 32 bit words */
 973     uint8_t bit; /* index _into_ the 32 bit word, thus just uint8 */
 974 } longbit;
 975 #define LONGBIT(bit) { ((bit)/32), ((bit)%32) }
 976 #else
 977 typedef uint32_t longbit;
 978 #define LONGBIT(bit) (bit)
 979 #endif
 980
 981 /* Used to store the list of flags with names */
 982 typedef struct {
 983     const char *name;
 984     longbit    bit;
 985 } opt_flag_def;
 986
 987 /*===================================================================*/
 988 /* list of -f flags, like -fdarkplaces-string-table-bug */
 989 enum {
 990     DP_STRING_TABLE_BUG,
 991     OMIT_NULLBYTES,
 992
 993     NUM_F_FLAGS
 994 };
 995 static const opt_flag_def opt_flag_list[] = {
 996     { "darkplaces-string-table-bug", LONGBIT(DP_STRING_TABLE_BUG) },
 997     { "omit-nullbytes",              LONGBIT(OMIT_NULLBYTES)      },
 998 };
 999 static const size_t opt_flag_list_count = sizeof(opt_flag_list) / sizeof(opt_flag_list[0]);
1000
1001 /* other options: */
1002 extern uint32_t    opt_O;      /* -Ox */
1003 extern const char *opt_output; /* -o file */
1004
1005 /*===================================================================*/
1006 #define OPT_FLAG(i) (!! (opt_flags[(i)/32] & (1<< ((i)%32))))
1007 extern uint32_t opt_flags[1 + (NUM_F_FLAGS / 32)];
1008
1009 #endif