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