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      (size_t,       unsigned int, const char *);
 195 void  util_memory_d      (void       *, unsigned int, const char *);
 196 void *util_memory_r      (void       *, size_t,       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, n) realloc(x, n)
 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, n) util_memory_r((x), (n), __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 /* New flexible vector implementation from Dale */
 236 #define _vec_raw(A) (((size_t*)(A)) - 2)
 237 #define _vec_beg(A) (_vec_raw(A)[0])
 238 #define _vec_end(A) (_vec_raw(A)[1])
 239 #define _vec_needsgrow(A,N) ((!(A)) || (_vec_end(A) + (N) >= _vec_beg(A)))
 240 #define _vec_mightgrow(A,N) (_vec_needsgrow((A), (N)) ? _vec_forcegrow((A),(N)) : 0)
 241 #define _vec_forcegrow(A,N) _util_vec_grow((void**)&(A), (N), sizeof(*(A)))
 242 #define _vec_remove(A,S,I,N) (memmove((char*)(A)+(I)*(S),(char*)(A)+((I)+(N))*(S),(S)*(vec_size(A)-(I)-(N))), _vec_end(A)-=(N))
 243 void _util_vec_grow(void **a, size_t i, size_t s);
 244 /* exposed interface */
 245 #define vec_free(A)          ((A) ? (mem_d(_vec_raw(A)), (A) = NULL) : 0)
 246 #define vec_push(A,V)        (_vec_mightgrow((A),1), (A)[_vec_end(A)++] = (V))
 247 #define vec_size(A)          ((A) ? _vec_end(A) : 0)
 248 #define vec_add(A,N)         (_vec_mightgrow((A),(N)), _vec_end(A)+=(N), &(A)[_vec_end(A)-(N)])
 249 #define vec_last(A)          ((A)[_vec_end(A)-1])
 250 #define vec_append(A,N,S)    memcpy(vec_add((A), (N)), (S), N * sizeof(*(S)))
 251 #define vec_remove(A,I,N)    _vec_remove((A), sizeof(*(A)), (I), (N))
 252 #define vec_pop(A)           vec_remove((A), _vec_end(A)-1, 1)
 253 /* these are supposed to NOT reallocate */
 254 #define vec_shrinkto(A,N)    (_vec_end(A) = (N))
 255 #define vec_shrinkby(A,N)    (_vec_end(A) -= (N))
 256
 257 /*===================================================================*/
 258 /*=========================== code.c ================================*/
 259 /*===================================================================*/
 260
 261 /* Note: if you change the order, fix type_sizeof in ir.c */
 262 enum {
 263     TYPE_VOID     ,
 264     TYPE_STRING   ,
 265     TYPE_FLOAT    ,
 266     TYPE_VECTOR   ,
 267     TYPE_ENTITY   ,
 268     TYPE_FIELD    ,
 269     TYPE_FUNCTION ,
 270     TYPE_POINTER  ,
 271     TYPE_INTEGER  ,
 272     TYPE_VARIANT  ,
 273     TYPE_STRUCT   ,
 274     TYPE_UNION    ,
 275     TYPE_ARRAY    ,
 276
 277     TYPE_COUNT
 278 };
 279
 280 extern const char *type_name[TYPE_COUNT];
 281
 282 extern size_t type_sizeof[TYPE_COUNT];
 283 extern uint16_t type_store_instr[TYPE_COUNT];
 284 extern uint16_t field_store_instr[TYPE_COUNT];
 285 /* could use type_store_instr + INSTR_STOREP_F - INSTR_STORE_F
 286  * but this breaks when TYPE_INTEGER is added, since with the enhanced
 287  * instruction set, the old ones are left untouched, thus the _I instructions
 288  * are at a seperate place.
 289  */
 290 extern uint16_t type_storep_instr[TYPE_COUNT];
 291 /* other useful lists */
 292 extern uint16_t type_eq_instr[TYPE_COUNT];
 293 extern uint16_t type_ne_instr[TYPE_COUNT];
 294
 295 typedef struct {
 296     uint32_t offset;      /* Offset in file of where data begins  */
 297     uint32_t length;      /* Length of section (how many of)      */
 298 } prog_section;
 299
 300 typedef struct {
 301     uint32_t     version;      /* Program version (6)     */
 302     uint16_t     crc16;        /* What is this?           */
 303     uint16_t     skip;         /* see propsal.txt         */
 304
 305     prog_section statements;   /* prog_section_statement  */
 306     prog_section defs;         /* prog_section_def        */
 307     prog_section fields;       /* prog_section_field      */
 308     prog_section functions;    /* prog_section_function   */
 309     prog_section strings;      /* What is this?           */
 310     prog_section globals;      /* What is this?           */
 311     uint32_t     entfield;     /* Number of entity fields */
 312 } prog_header;
 313
 314 /*
 315  * Each paramater incerements by 3 since vector types hold
 316  * 3 components (x,y,z).
 317  */
 318 #define OFS_NULL      0
 319 #define OFS_RETURN    1
 320 #define OFS_PARM0     (OFS_RETURN+3)
 321 #define OFS_PARM1     (OFS_PARM0 +3)
 322 #define OFS_PARM2     (OFS_PARM1 +3)
 323 #define OFS_PARM3     (OFS_PARM2 +3)
 324 #define OFS_PARM4     (OFS_PARM3 +3)
 325 #define OFS_PARM5     (OFS_PARM4 +3)
 326 #define OFS_PARM6     (OFS_PARM5 +3)
 327 #define OFS_PARM7     (OFS_PARM6 +3)
 328
 329 typedef struct {
 330     uint16_t opcode;
 331
 332     /* operand 1 */
 333     union {
 334         int16_t  s1; /* signed   */
 335         uint16_t u1; /* unsigned */
 336     } o1;
 337     /* operand 2 */
 338     union {
 339         int16_t  s1; /* signed   */
 340         uint16_t u1; /* unsigned */
 341     } o2;
 342     /* operand 3 */
 343     union {
 344         int16_t  s1; /* signed   */
 345         uint16_t u1; /* unsigned */
 346     } o3;
 347
 348     /*
 349      * This is the same as the structure in darkplaces
 350      * {
 351      *     unsigned short op;
 352      *     short          a,b,c;
 353      * }
 354      * But this one is more sane to work with, and the
 355      * type sizes are guranteed.
 356      */
 357 } prog_section_statement;
 358
 359 typedef struct {
 360     /* The types:
 361      * 0 = ev_void
 362      * 1 = ev_string
 363      * 2 = ev_float
 364      * 3 = ev_vector
 365      * 4 = ev_entity
 366      * 5 = ev_field
 367      * 6 = ev_function
 368      * 7 = ev_pointer -- engine only
 369      * 8 = ev_bad     -- engine only
 370      */
 371     uint16_t type;
 372     uint16_t offset;
 373     uint32_t name;
 374 } prog_section_both;
 375 typedef prog_section_both prog_section_def;
 376 typedef prog_section_both prog_section_field;
 377
 378 /* this is ORed to the type */
 379 #define DEF_SAVEGLOBAL (1<<15)
 380 #define DEF_TYPEMASK   ((1<<15)-1)
 381
 382 typedef struct {
 383     int32_t   entry;      /* in statement table for instructions  */
 384     uint32_t  firstlocal; /* First local in local table           */
 385     uint32_t  locals;     /* Total ints of params + locals        */
 386     uint32_t  profile;    /* Always zero (engine uses this)       */
 387     uint32_t  name;       /* name of function in string table     */
 388     uint32_t  file;       /* file of the source file              */
 389     uint32_t  nargs;      /* number of arguments                  */
 390     uint8_t   argsize[8]; /* size of arguments (keep 8 always?)   */
 391 } prog_section_function;
 392
 393 /*
 394  * Instructions
 395  * These are the external instructions supported by the interperter
 396  * this is what things compile to (from the C code).
 397  */
 398 enum {
 399     INSTR_DONE,
 400     INSTR_MUL_F,
 401     INSTR_MUL_V,
 402     INSTR_MUL_FV, /* NOTE: the float operands must NOT be at the same locations: A != C */
 403     INSTR_MUL_VF, /* and here: B != C */
 404     INSTR_DIV_F,
 405     INSTR_ADD_F,
 406     INSTR_ADD_V,
 407     INSTR_SUB_F,
 408     INSTR_SUB_V,
 409     INSTR_EQ_F,
 410     INSTR_EQ_V,
 411     INSTR_EQ_S,
 412     INSTR_EQ_E,
 413     INSTR_EQ_FNC,
 414     INSTR_NE_F,
 415     INSTR_NE_V,
 416     INSTR_NE_S,
 417     INSTR_NE_E,
 418     INSTR_NE_FNC,
 419     INSTR_LE,
 420     INSTR_GE,
 421     INSTR_LT,
 422     INSTR_GT,
 423     INSTR_LOAD_F,
 424     INSTR_LOAD_V,
 425     INSTR_LOAD_S,
 426     INSTR_LOAD_ENT,
 427     INSTR_LOAD_FLD,
 428     INSTR_LOAD_FNC,
 429     INSTR_ADDRESS,
 430     INSTR_STORE_F,
 431     INSTR_STORE_V,
 432     INSTR_STORE_S,
 433     INSTR_STORE_ENT,
 434     INSTR_STORE_FLD,
 435     INSTR_STORE_FNC,
 436     INSTR_STOREP_F,
 437     INSTR_STOREP_V,
 438     INSTR_STOREP_S,
 439     INSTR_STOREP_ENT,
 440     INSTR_STOREP_FLD,
 441     INSTR_STOREP_FNC,
 442     INSTR_RETURN,
 443     INSTR_NOT_F,
 444     INSTR_NOT_V,
 445     INSTR_NOT_S,
 446     INSTR_NOT_ENT,
 447     INSTR_NOT_FNC,
 448     INSTR_IF,
 449     INSTR_IFNOT,
 450     INSTR_CALL0,
 451     INSTR_CALL1,
 452     INSTR_CALL2,
 453     INSTR_CALL3,
 454     INSTR_CALL4,
 455     INSTR_CALL5,
 456     INSTR_CALL6,
 457     INSTR_CALL7,
 458     INSTR_CALL8,
 459     INSTR_STATE,
 460     INSTR_GOTO,
 461     INSTR_AND,
 462     INSTR_OR,
 463     INSTR_BITAND,
 464     INSTR_BITOR,
 465
 466     /*
 467      * Virtual instructions used by the assembler
 468      * keep at the end but before virtual instructions
 469      * for the IR below.
 470      */
 471     AINSTR_END,
 472
 473     /*
 474      * Virtual instructions used by the IR
 475      * Keep at the end!
 476      */
 477     VINSTR_PHI,
 478     VINSTR_JUMP,
 479     VINSTR_COND
 480 };
 481
 482 extern prog_section_statement *code_statements;
 483 extern prog_section_def       *code_defs;
 484 extern prog_section_field     *code_fields;
 485 extern prog_section_function  *code_functions;
 486 extern int                    *code_globals;
 487 extern char                   *code_chars;
 488 extern uint16_t code_crc;
 489
 490 typedef float   qcfloat;
 491 typedef int32_t qcint;
 492
 493 /*
 494  * code_write -- writes out the compiled file
 495  * code_init  -- prepares the code file
 496  */
 497 bool     code_write       (const char *filename);
 498 void     code_init        ();
 499 uint32_t code_genstring   (const char *string);
 500 uint32_t code_cachedstring(const char *string);
 501 qcint    code_alloc_field (size_t qcsize);
 502
 503 /*===================================================================*/
 504 /*============================ con.c ================================*/
 505 /*===================================================================*/
 506 enum {
 507     CON_BLACK   = 30,
 508     CON_RED,
 509     CON_GREEN,
 510     CON_BROWN,
 511     CON_BLUE,
 512     CON_MAGENTA,
 513     CON_CYAN ,
 514     CON_WHITE
 515 };
 516
 517 /* message level */
 518 enum {
 519     LVL_MSG,
 520     LVL_WARNING,
 521     LVL_ERROR
 522 };
 523
 524
 525 void con_vprintmsg (int level, const char *name, size_t line, const char *msgtype, const char *msg, va_list ap);
 526 void con_printmsg  (int level, const char *name, size_t line, const char *msgtype, const char *msg, ...);
 527 void con_cvprintmsg(void *ctx, int lvl, const char *msgtype, const char *msg, va_list ap);
 528 void con_cprintmsg (void *ctx, int lvl, const char *msgtype, const char *msg, ...);
 529
 530 void con_close();
 531 void con_color(int state);
 532 void con_init ();
 533 void con_reset();
 534 int  con_change(const char *out, const char *err);
 535 int  con_verr  (const char *fmt, va_list va);
 536 int  con_vout  (const char *fmt, va_list va);
 537 int  con_err   (const char *fmt, ...);
 538 int  con_out   (const char *fmt, ...);
 539
 540 /*===================================================================*/
 541 /*========================= assembler.c =============================*/
 542 /*===================================================================*/
 543 static const struct {
 544     const char  *m; /* menomic     */
 545     const size_t o; /* operands    */
 546     const size_t l; /* menomic len */
 547 } asm_instr[] = {
 548     { "DONE"      , 1, 4 },
 549     { "MUL_F"     , 3, 5 },
 550     { "MUL_V"     , 3, 5 },
 551     { "MUL_FV"    , 3, 6 },
 552     { "MUL_VF"    , 3, 6 },
 553     { "DIV"       , 0, 3 },
 554     { "ADD_F"     , 3, 5 },
 555     { "ADD_V"     , 3, 5 },
 556     { "SUB_F"     , 3, 5 },
 557     { "SUB_V"     , 3, 5 },
 558     { "EQ_F"      , 0, 4 },
 559     { "EQ_V"      , 0, 4 },
 560     { "EQ_S"      , 0, 4 },
 561     { "EQ_E"      , 0, 4 },
 562     { "EQ_FNC"    , 0, 6 },
 563     { "NE_F"      , 0, 4 },
 564     { "NE_V"      , 0, 4 },
 565     { "NE_S"      , 0, 4 },
 566     { "NE_E"      , 0, 4 },
 567     { "NE_FNC"    , 0, 6 },
 568     { "LE"        , 0, 2 },
 569     { "GE"        , 0, 2 },
 570     { "LT"        , 0, 2 },
 571     { "GT"        , 0, 2 },
 572     { "FIELD_F"   , 0, 7 },
 573     { "FIELD_V"   , 0, 7 },
 574     { "FIELD_S"   , 0, 7 },
 575     { "FIELD_ENT" , 0, 9 },
 576     { "FIELD_FLD" , 0, 9 },
 577     { "FIELD_FNC" , 0, 9 },
 578     { "ADDRESS"   , 0, 7 },
 579     { "STORE_F"   , 0, 7 },
 580     { "STORE_V"   , 0, 7 },
 581     { "STORE_S"   , 0, 7 },
 582     { "STORE_ENT" , 0, 9 },
 583     { "STORE_FLD" , 0, 9 },
 584     { "STORE_FNC" , 0, 9 },
 585     { "STOREP_F"  , 0, 8 },
 586     { "STOREP_V"  , 0, 8 },
 587     { "STOREP_S"  , 0, 8 },
 588     { "STOREP_ENT", 0, 10},
 589     { "STOREP_FLD", 0, 10},
 590     { "STOREP_FNC", 0, 10},
 591     { "RETURN"    , 0, 6 },
 592     { "NOT_F"     , 0, 5 },
 593     { "NOT_V"     , 0, 5 },
 594     { "NOT_S"     , 0, 5 },
 595     { "NOT_ENT"   , 0, 7 },
 596     { "NOT_FNC"   , 0, 7 },
 597     { "IF"        , 0, 2 },
 598     { "IFNOT"     , 0, 5 },
 599     { "CALL0"     , 1, 5 },
 600     { "CALL1"     , 2, 5 },
 601     { "CALL2"     , 3, 5 },
 602     { "CALL3"     , 4, 5 },
 603     { "CALL4"     , 5, 5 },
 604     { "CALL5"     , 6, 5 },
 605     { "CALL6"     , 7, 5 },
 606     { "CALL7"     , 8, 5 },
 607     { "CALL8"     , 9, 5 },
 608     { "STATE"     , 0, 5 },
 609     { "GOTO"      , 0, 4 },
 610     { "AND"       , 0, 3 },
 611     { "OR"        , 0, 2 },
 612     { "BITAND"    , 0, 6 },
 613     { "BITOR"     , 0, 5 },
 614
 615     { "END"       , 0, 3 } /* virtual assembler instruction */
 616 };
 617 /*===================================================================*/
 618 /*============================= ir.c ================================*/
 619 /*===================================================================*/
 620
 621 enum store_types {
 622     store_global,
 623     store_local,  /* local, assignable for now, should get promoted later */
 624     store_param,  /* parameters, they are locals with a fixed position */
 625     store_value,  /* unassignable */
 626     store_return  /* unassignable, at OFS_RETURN */
 627 };
 628
 629 typedef struct {
 630     qcfloat x, y, z;
 631 } vector;
 632
 633 vector  vec3_add  (vector, vector);
 634 vector  vec3_sub  (vector, vector);
 635 qcfloat vec3_mulvv(vector, vector);
 636 vector  vec3_mulvf(vector, float);
 637
 638 /*
 639  * A shallow copy of a lex_file to remember where which ast node
 640  * came from.
 641  */
 642 typedef struct {
 643     const char *file;
 644     size_t      line;
 645 } lex_ctx;
 646
 647 /*===================================================================*/
 648 /*============================= exec.c ==============================*/
 649 /*===================================================================*/
 650
 651 /* darkplaces has (or will have) a 64 bit prog loader
 652  * where the 32 bit qc program is autoconverted on load.
 653  * Since we may want to support that as well, let's redefine
 654  * float and int here.
 655  */
 656 typedef union {
 657     qcint   _int;
 658     qcint    string;
 659     qcint    function;
 660     qcint    edict;
 661     qcfloat _float;
 662     qcfloat vector[3];
 663     qcint   ivector[3];
 664 } qcany;
 665
 666 typedef char qcfloat_size_is_correct [sizeof(qcfloat) == 4 ?1:-1];
 667 typedef char qcint_size_is_correct   [sizeof(qcint)   == 4 ?1:-1];
 668
 669 enum {
 670     VMERR_OK,
 671     VMERR_TEMPSTRING_ALLOC,
 672
 673     VMERR_END
 674 };
 675
 676 #define VM_JUMPS_DEFAULT 1000000
 677
 678 /* execute-flags */
 679 #define VMXF_DEFAULT 0x0000     /* default flags - nothing */
 680 #define VMXF_TRACE   0x0001     /* trace: print statements before executing */
 681 #define VMXF_PROFILE 0x0002     /* profile: increment the profile counters */
 682
 683 struct qc_program_s;
 684
 685 typedef int (*prog_builtin)(struct qc_program_s *prog);
 686
 687 typedef struct {
 688     qcint                  stmt;
 689     size_t                 localsp;
 690     prog_section_function *function;
 691 } qc_exec_stack;
 692
 693 typedef struct qc_program_s {
 694     char           *filename;
 695
 696     prog_section_statement *code;
 697     prog_section_def       *defs;
 698     prog_section_def       *fields;
 699     prog_section_function  *functions;
 700     char                   *strings;
 701     qcint                  *globals;
 702     qcint                  *entitydata;
 703     bool                   *entitypool;
 704
 705     const char*            *function_stack;
 706
 707     uint16_t crc16;
 708
 709     size_t tempstring_start;
 710     size_t tempstring_at;
 711
 712     qcint  vmerror;
 713
 714     size_t *profile;
 715
 716     prog_builtin *builtins;
 717     size_t        builtins_count;
 718
 719     /* size_t ip; */
 720     qcint  entities;
 721     size_t entityfields;
 722     bool   allowworldwrites;
 723
 724     qcint         *localstack;
 725     qc_exec_stack *stack;
 726     size_t statement;
 727
 728     size_t xflags;
 729
 730     int    argc; /* current arg count for debugging */
 731 } qc_program;
 732
 733 qc_program* prog_load(const char *filename);
 734 void        prog_delete(qc_program *prog);
 735
 736 bool prog_exec(qc_program *prog, prog_section_function *func, size_t flags, long maxjumps);
 737
 738 char*             prog_getstring (qc_program *prog, qcint str);
 739 prog_section_def* prog_entfield  (qc_program *prog, qcint off);
 740 prog_section_def* prog_getdef    (qc_program *prog, qcint off);
 741 qcany*            prog_getedict  (qc_program *prog, qcint e);
 742 qcint             prog_tempstring(qc_program *prog, const char *_str);
 743
 744
 745 /*===================================================================*/
 746 /*===================== parser.c commandline ========================*/
 747 /*===================================================================*/
 748
 749 bool parser_init          ();
 750 bool parser_compile_file  (const char *filename);
 751 bool parser_compile_string(const char *name, const char *str);
 752 bool parser_finish        (const char *output);
 753 void parser_cleanup       ();
 754
 755 /*===================================================================*/
 756 /*====================== ftepp.c commandline ========================*/
 757 /*===================================================================*/
 758 bool ftepp_preprocess_file  (const char *filename);
 759 bool ftepp_preprocess_string(const char *name, const char *str);
 760
 761 /*===================================================================*/
 762 /*======================= main.c commandline ========================*/
 763 /*===================================================================*/
 764
 765 #if 0
 766 /* Helpers to allow for a whole lot of flags. Otherwise we'd limit
 767  * to 32 or 64 -f options...
 768  */
 769 typedef struct {
 770     size_t  idx; /* index into an array of 32 bit words */
 771     uint8_t bit; /* index _into_ the 32 bit word, thus just uint8 */
 772 } longbit;
 773 #define LONGBIT(bit) { ((bit)/32), ((bit)%32) }
 774 #else
 775 typedef uint32_t longbit;
 776 #define LONGBIT(bit) (bit)
 777 #endif
 778
 779 /* Used to store the list of flags with names */
 780 typedef struct {
 781     const char *name;
 782     longbit    bit;
 783 } opts_flag_def;
 784
 785 /*===================================================================*/
 786 /* list of -f flags, like -fdarkplaces-string-table-bug */
 787 enum {
 788 # define GMQCC_TYPE_FLAGS
 789 # define GMQCC_DEFINE_FLAG(X) X,
 790 #  include "opts.def"
 791     COUNT_FLAGS
 792 };
 793 static const opts_flag_def opts_flag_list[] = {
 794 # define GMQCC_TYPE_FLAGS
 795 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(X) },
 796 #  include "opts.def"
 797     { NULL, LONGBIT(0) }
 798 };
 799
 800 enum {
 801 # define GMQCC_TYPE_WARNS
 802 # define GMQCC_DEFINE_FLAG(X) WARN_##X,
 803 #  include "opts.def"
 804     COUNT_WARNINGS
 805 };
 806 static const opts_flag_def opts_warn_list[] = {
 807 # define GMQCC_TYPE_WARNS
 808 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(WARN_##X) },
 809 #  include "opts.def"
 810     { NULL, LONGBIT(0) }
 811 };
 812
 813 /* other options: */
 814 enum {
 815     COMPILER_QCC,     /* circa  QuakeC */
 816     COMPILER_FTEQCC,  /* fteqcc QuakeC */
 817     COMPILER_QCCX,    /* qccx   QuakeC */
 818     COMPILER_GMQCC    /* this   QuakeC */
 819 };
 820 extern uint32_t    opts_O;      /* -Ox */
 821 extern const char *opts_output; /* -o file */
 822 extern int         opts_standard;
 823 extern bool        opts_debug;
 824 extern bool        opts_memchk;
 825 extern bool        opts_dump;
 826 extern bool        opts_werror;
 827 extern bool        opts_forcecrc;
 828 extern uint16_t    opts_forced_crc;
 829 extern bool        opts_pp_only;
 830 extern size_t      opts_max_array_size;
 831
 832 /*===================================================================*/
 833 #define OPTS_FLAG(i) (!! (opts_flags[(i)/32] & (1<< ((i)%32))))
 834 extern uint32_t opts_flags[1 + (COUNT_FLAGS / 32)];
 835 #define OPTS_WARN(i) (!! (opts_warn[(i)/32] & (1<< ((i)%32))))
 836 extern uint32_t opts_warn[1 + (COUNT_WARNINGS / 32)];
 837
 838 #endif