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