gmqcc.h

   1 /*
   2  * Copyright (C) 2012
   3  *     Dale Weiler
   4  *     Wolfgang Bumiller
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   7  * this software and associated documentation files (the "Software"), to deal in
   8  * the Software without restriction, including without limitation the rights to
   9  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
  10  * of the Software, and to permit persons to whom the Software is furnished to do
  11  * so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in all
  14  * copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  */
  24 #ifndef GMQCC_HDR
  25 #define GMQCC_HDR
  26 #include <limits.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29 #include <stdio.h>
  30 #include <stdarg.h>
  31 #include <ctype.h>
  32
  33 /*
  34  * Disable some over protective warnings in visual studio because fixing them is a waste
  35  * of my time.
  36  */
  37 #ifdef _MSC_VER
  38 #       pragma warning(disable : 4244 ) /* conversion from 'int' to 'float', possible loss of data */
  39 #       pragma warning(disable : 4018 ) /* signed/unsigned mismatch                                */
  40 #       pragma warning(disable : 4996 ) /* This function or variable may be unsafe                 */
  41 #       pragma warning(disable : 4700 ) /* uninitialized local variable used                       */
  42 #endif
  43
  44 #if !defined(GMQCC_VERSION_MAJOR) \
  45  || !defined(GMQCC_VERSION_MINOR) \
  46  || !defined(GMQCC_VERSION_PATCH)
  47 #   error GMQCC_VERSION_ macros missing
  48 #endif
  49
  50 #define GMQCC_VERSION_BUILD(J,N,P) (((J)<<16)|((N)<<8)|(P))
  51 #define GMQCC_VERSION \
  52     GMQCC_VERSION_BUILD(GMQCC_VERSION_MAJOR, GMQCC_VERSION_MINOR, GMQCC_VERSION_PATCH)
  53
  54 /*
  55  * We cannoy rely on C99 at all, since compilers like MSVC
  56  * simply don't support it.  We define our own boolean type
  57  * as a result (since we cannot include <stdbool.h>). For
  58  * compilers that are in 1999 mode (C99 compliant) we can use
  59  * the language keyword _Bool which can allow for better code
  60  * on GCC and GCC-like compilers, opposed to `int`.
  61  */
  62 #ifndef __cplusplus
  63 #   ifdef  false
  64 #       undef  false
  65 #   endif /* !false */
  66 #   ifdef  true
  67 #       undef true
  68 #   endif /* !true  */
  69 #   define false (0)
  70 #   define true  (1)
  71 #   ifdef __STDC_VERSION__
  72 #       if __STDC_VERSION__ < 199901L && __GNUC__ < 3
  73             typedef int  bool;
  74 #       else
  75             typedef _Bool bool;
  76 #       endif
  77 #   else
  78         typedef int bool;
  79 #   endif /* !__STDC_VERSION__ */
  80 #endif    /* !__cplusplus      */
  81
  82 /*
  83  * Of some functions which are generated we want to make sure
  84  * that the result isn't ignored. To find such function calls,
  85  * we use this macro.
  86  */
  87 #if defined(__GNUC__) || defined(__CLANG__)
  88 #   define GMQCC_WARN __attribute__((warn_unused_result))
  89 #else
  90 #   define GMQCC_WARN
  91 #endif
  92 /*
  93  * This is a hack to silent clang regarding empty
  94  * body if statements.
  95  */
  96 #define GMQCC_SUPPRESS_EMPTY_BODY do { } while (0)
  97
  98 /*
  99  * Inline is not supported in < C90, however some compilers
 100  * like gcc and clang might have an inline attribute we can
 101  * use if present.
 102  */
 103 #ifdef __STDC_VERSION__
 104 #    if __STDC_VERSION__ < 199901L
 105 #       if defined(__GNUC__) || defined (__CLANG__)
 106 #           if __GNUC__ < 2
 107 #               define GMQCC_INLINE
 108 #           else
 109 #               define GMQCC_INLINE __attribute__ ((always_inline))
 110 #           endif
 111 #       else
 112 #           define GMQCC_INLINE
 113 #       endif
 114 #    else
 115 #       define GMQCC_INLINE inline
 116 #    endif
 117 /*
 118  * Visual studio has __forcinline we can use.  So lets use that
 119  * I suspect it also has just __inline of some sort, but our use
 120  * of inline is correct (not guessed), WE WANT IT TO BE INLINE
 121  */
 122 #elseif defined(_MSC_VER)
 123 #    define GMQCC_INLINE __forceinline
 124 #else
 125 #    define GMQCC_INLINE
 126 #endif /* !__STDC_VERSION__ */
 127
 128 /*
 129  * noreturn is present in GCC and clang
 130  * it's required for _ast_node_destory otherwise -Wmissing-noreturn
 131  * in clang complains about there being no return since abort() is
 132  * called.
 133  */
 134 #if (defined(__GNUC__) && __GNUC__ >= 2) || defined(__CLANG__)
 135 #    define GMQCC_NORETURN __attribute__ ((noreturn))
 136 #else
 137 #    define GMQCC_NORETURN
 138 #endif
 139
 140 /*
 141  * stdint.h and inttypes.h -less subset
 142  * for systems that don't have it, which we must
 143  * assume is all systems. (int8_t not required)
 144  */
 145 #if   CHAR_MIN  == -128
 146     typedef unsigned char  uint8_t; /* same as below */
 147 #elif SCHAR_MIN == -128
 148     typedef unsigned char  uint8_t; /* same as above */
 149 #endif
 150 #if   SHRT_MAX  == 0x7FFF
 151     typedef short          int16_t;
 152     typedef unsigned short uint16_t;
 153 #elif INT_MAX   == 0x7FFF
 154     typedef int            int16_t;
 155     typedef unsigned int   uint16_t;
 156 #endif
 157 #if   INT_MAX   == 0x7FFFFFFF
 158     typedef int            int32_t;
 159     typedef unsigned int   uint32_t;
 160 #elif LONG_MAX  == 0x7FFFFFFF
 161     typedef long           int32_t;
 162     typedef unsigned long  uint32_t;
 163 #endif
 164
 165
 166 #if defined(__GNUC__) || defined (__CLANG__)
 167         typedef int              int64_t  __attribute__((__mode__(__DI__)));
 168         typedef unsigned int     uint64_t __attribute__((__mode__(__DI__)));
 169 #elif defined(_MSC_VER)
 170         typedef __int64          int64_t;
 171         typedef unsigned __int64 uint64_t;
 172 #else
 173     /*
 174     * Incorrectly size the types so static assertions below will
 175     * fail.  There is no valid way to get a 64bit type at this point
 176     * without making assumptions of too many things.
 177     */
 178     typedef struct { char _fail : 0; } int64_t;
 179     typedef struct { char _fail : 0; } uint64_t;
 180 #endif
 181 #ifdef _LP64 /* long pointer == 64 */
 182     typedef unsigned long  uintptr_t;
 183     typedef long           intptr_t;
 184 #else
 185     typedef unsigned int   uintptr_t;
 186     typedef int            intptr_t;
 187 #endif
 188 /* Ensure type sizes are correct: */
 189 typedef char uint8_size_is_correct  [sizeof(uint8_t)  == 1?1:-1];
 190 typedef char uint16_size_is_correct [sizeof(uint16_t) == 2?1:-1];
 191 typedef char uint32_size_is_correct [sizeof(uint32_t) == 4?1:-1];
 192 typedef char uint64_size_is_correct [sizeof(uint64_t) == 8?1:-1];
 193 typedef char int16_size_if_correct  [sizeof(int16_t)  == 2?1:-1];
 194 typedef char int32_size_is_correct  [sizeof(int32_t)  == 4?1:-1];
 195 typedef char int64_size_is_correct  [sizeof(int64_t)  >= 8?1:-1];
 196 /* intptr_t / uintptr_t correct size check */
 197 typedef char uintptr_size_is_correct[sizeof(intptr_t) == sizeof(int*)?1:-1];
 198 typedef char intptr_size_is_correct [sizeof(uintptr_t)== sizeof(int*)?1:-1];
 199
 200 /*===================================================================*/
 201 /*=========================== util.c ================================*/
 202 /*===================================================================*/
 203 FILE *util_fopen(const char *filename, const char *mode);
 204
 205 void *util_memory_a      (size_t,       unsigned int, const char *);
 206 void  util_memory_d      (void       *, unsigned int, const char *);
 207 void *util_memory_r      (void       *, size_t,       unsigned int, const char *);
 208 void  util_meminfo       ();
 209
 210 bool  util_filexists     (const char *);
 211 bool  util_strupper      (const char *);
 212 bool  util_strdigit      (const char *);
 213 bool  util_strncmpexact  (const char *, const char *, size_t);
 214 char *util_strdup        (const char *);
 215 char *util_strrq         (const char *);
 216 char *util_strrnl        (const char *);
 217 char *util_strsws        (const char *);
 218 char *util_strchp        (const char *, const char *);
 219 void  util_debug         (const char *, const char *, ...);
 220 int   util_getline       (char **, size_t *, FILE *);
 221 void  util_endianswap    (void *,  int, int);
 222
 223 size_t util_strtocmd    (const char *, char *, size_t);
 224 size_t util_strtononcmd (const char *, char *, size_t);
 225
 226 uint16_t util_crc16(uint16_t crc, const char *data, size_t len);
 227 uint32_t util_crc32(uint32_t crc, const char *data, size_t len);
 228
 229 #ifdef NOTRACK
 230 #    define mem_a(x)    malloc (x)
 231 #    define mem_d(x)    free   (x)
 232 #    define mem_r(x, n) realloc(x, n)
 233 #else
 234 #    define mem_a(x)    util_memory_a((x), __LINE__, __FILE__)
 235 #    define mem_d(x)    util_memory_d((x), __LINE__, __FILE__)
 236 #    define mem_r(x, n) util_memory_r((x), (n), __LINE__, __FILE__)
 237 #endif
 238
 239 /*
 240  * TODO: make these safer to use.  Currently this only works on
 241  * x86 and x86_64, some systems will likely not like this. Such
 242  * as BE systems.
 243  */
 244 #define FLT2INT(Y) *((int32_t*)&(Y))
 245 #define INT2FLT(Y) *((float  *)&(Y))
 246
 247 /* New flexible vector implementation from Dale */
 248 #define _vec_raw(A) (((size_t*)(void*)(A)) - 2)
 249 #define _vec_beg(A) (_vec_raw(A)[0])
 250 #define _vec_end(A) (_vec_raw(A)[1])
 251 #define _vec_needsgrow(A,N) ((!(A)) || (_vec_end(A) + (N) >= _vec_beg(A)))
 252 #define _vec_mightgrow(A,N) (_vec_needsgrow((A), (N)) ? (void)_vec_forcegrow((A),(N)) : (void)0)
 253 #define _vec_forcegrow(A,N) _util_vec_grow(((void**)&(A)), (N), sizeof(*(A)))
 254 #define _vec_remove(A,S,I,N) (memmove((char*)(A)+(I)*(S),(char*)(A)+((I)+(N))*(S),(S)*(_vec_end(A)-(I)-(N))), _vec_end(A)-=(N))
 255 void _util_vec_grow(void **a, size_t i, size_t s);
 256 /* exposed interface */
 257 #define vec_free(A)          ((A) ? (mem_d((void*)_vec_raw(A)), (A) = NULL) : 0)
 258 #define vec_push(A,V)        (_vec_mightgrow((A),1), (A)[_vec_end(A)++] = (V))
 259 #define vec_size(A)          ((A) ? _vec_end(A) : 0)
 260 #define vec_add(A,N)         (_vec_mightgrow((A),(N)), _vec_end(A)+=(N), &(A)[_vec_end(A)-(N)])
 261 #define vec_last(A)          ((A)[_vec_end(A)-1])
 262 #define vec_append(A,N,S)    memcpy(vec_add((A), (N)), (S), N * sizeof(*(S)))
 263 #define vec_remove(A,I,N)    _vec_remove((A), sizeof(*(A)), (I), (N))
 264 #define vec_pop(A)           (_vec_end(A)-=1)
 265 /* these are supposed to NOT reallocate */
 266 #define vec_shrinkto(A,N)    (_vec_end(A) = (N))
 267 #define vec_shrinkby(A,N)    (_vec_end(A) -= (N))
 268
 269 #define vec_upload(X,Y,S)      \
 270     do {                       \
 271         size_t E = 0;          \
 272         while (E < S) {        \
 273             vec_push(X, Y[E]); \
 274             E ++;              \
 275         }                      \
 276     } while(0)
 277
 278 typedef struct hash_table_t {
 279     size_t                size;
 280     struct hash_node_t **table;
 281 } hash_table_t, *ht;
 282
 283 /*
 284  * hashtable implementation:
 285  *
 286  * Note:
 287  *      This was designed for pointers:  you manage the life of the object yourself
 288  *      if you do use this for non-pointers please be warned that the object may not
 289  *      be valid if the duration of it exceeds (i.e on stack).  So you need to allocate
 290  *      yourself, or put those in global scope to ensure duration is for the whole
 291  *      runtime.
 292  *
 293  * util_htnew(size)                             -- to make a new hashtable
 294  * util_htset(table, key, value, sizeof(value)) -- to set something in the table
 295  * util_htget(table, key)                       -- to get something from the table
 296  * util_htdel(table)                            -- to delete the table
 297  *
 298  * example of use:
 299  *
 300  * ht    foo  = util_htnew(1024);
 301  * int   data = 100;
 302  * char *test = "hello world\n";
 303  * util_htset(foo, "foo", (void*)&data);
 304  * util_gtset(foo, "bar", (void*)test);
 305  *
 306  * printf("foo: %d, bar %s",
 307  *     *((int *)util_htget(foo, "foo")),
 308  *      ((char*)util_htget(foo, "bar"))
 309  * );
 310  *
 311  * util_htdel(foo);
 312  */
 313 hash_table_t *util_htnew (size_t size);
 314 void          util_htset (hash_table_t *ht, const char *key, void *value);
 315 void         *util_htget (hash_table_t *ht, const char *key);
 316 void          util_htdel (hash_table_t *ht);
 317 size_t        util_hthash(hash_table_t *ht, const char *key);
 318 void         *util_htgeth(hash_table_t *ht, const char *key, size_t hash);
 319 void          util_htseth(hash_table_t *ht, const char *key, size_t hash, void *value);
 320 /*===================================================================*/
 321 /*=========================== code.c ================================*/
 322 /*===================================================================*/
 323
 324 /* Note: if you change the order, fix type_sizeof in ir.c */
 325 enum {
 326     TYPE_VOID     ,
 327     TYPE_STRING   ,
 328     TYPE_FLOAT    ,
 329     TYPE_VECTOR   ,
 330     TYPE_ENTITY   ,
 331     TYPE_FIELD    ,
 332     TYPE_FUNCTION ,
 333     TYPE_POINTER  ,
 334     TYPE_INTEGER  ,
 335     TYPE_VARIANT  ,
 336     TYPE_STRUCT   ,
 337     TYPE_UNION    ,
 338     TYPE_ARRAY    ,
 339
 340     TYPE_COUNT
 341 };
 342
 343 /* const/var qualifiers */
 344 #define CV_NONE  0
 345 #define CV_CONST 1
 346 #define CV_VAR  -1
 347 /* magic number to help parsing */
 348 #define CV_WRONG  0x8000
 349
 350 extern const char *type_name        [TYPE_COUNT];
 351 extern size_t      type_sizeof      [TYPE_COUNT];
 352 extern uint16_t    type_store_instr [TYPE_COUNT];
 353 extern uint16_t    field_store_instr[TYPE_COUNT];
 354
 355 /*
 356  * could use type_store_instr + INSTR_STOREP_F - INSTR_STORE_F
 357  * but this breaks when TYPE_INTEGER is added, since with the enhanced
 358  * instruction set, the old ones are left untouched, thus the _I instructions
 359  * are at a seperate place.
 360  */
 361 extern uint16_t type_storep_instr[TYPE_COUNT];
 362 extern uint16_t type_eq_instr    [TYPE_COUNT];
 363 extern uint16_t type_ne_instr    [TYPE_COUNT];
 364 extern uint16_t type_not_instr   [TYPE_COUNT];
 365
 366 typedef struct {
 367     uint32_t offset;      /* Offset in file of where data begins  */
 368     uint32_t length;      /* Length of section (how many of)      */
 369 } prog_section;
 370
 371 typedef struct {
 372     uint32_t     version;      /* Program version (6)     */
 373     uint16_t     crc16;
 374     uint16_t     skip;
 375
 376     prog_section statements;   /* prog_section_statement  */
 377     prog_section defs;         /* prog_section_def        */
 378     prog_section fields;       /* prog_section_field      */
 379     prog_section functions;    /* prog_section_function   */
 380     prog_section strings;
 381     prog_section globals;
 382     uint32_t     entfield;     /* Number of entity fields */
 383 } prog_header;
 384
 385 /*
 386  * Each paramater incerements by 3 since vector types hold
 387  * 3 components (x,y,z).
 388  */
 389 #define OFS_NULL      0
 390 #define OFS_RETURN    1
 391 #define OFS_PARM0     (OFS_RETURN+3)
 392 #define OFS_PARM1     (OFS_PARM0 +3)
 393 #define OFS_PARM2     (OFS_PARM1 +3)
 394 #define OFS_PARM3     (OFS_PARM2 +3)
 395 #define OFS_PARM4     (OFS_PARM3 +3)
 396 #define OFS_PARM5     (OFS_PARM4 +3)
 397 #define OFS_PARM6     (OFS_PARM5 +3)
 398 #define OFS_PARM7     (OFS_PARM6 +3)
 399
 400 typedef struct {
 401     uint16_t opcode;
 402
 403     /* operand 1 */
 404     union {
 405         int16_t  s1; /* signed   */
 406         uint16_t u1; /* unsigned */
 407     } o1;
 408     /* operand 2 */
 409     union {
 410         int16_t  s1; /* signed   */
 411         uint16_t u1; /* unsigned */
 412     } o2;
 413     /* operand 3 */
 414     union {
 415         int16_t  s1; /* signed   */
 416         uint16_t u1; /* unsigned */
 417     } o3;
 418
 419     /*
 420      * This is the same as the structure in darkplaces
 421      * {
 422      *     unsigned short op;
 423      *     short          a,b,c;
 424      * }
 425      * But this one is more sane to work with, and the
 426      * type sizes are guranteed.
 427      */
 428 } prog_section_statement;
 429
 430 typedef struct {
 431     /*
 432      * The types:
 433      * 0 = ev_void
 434      * 1 = ev_string
 435      * 2 = ev_float
 436      * 3 = ev_vector
 437      * 4 = ev_entity
 438      * 5 = ev_field
 439      * 6 = ev_function
 440      * 7 = ev_pointer -- engine only
 441      * 8 = ev_bad     -- engine only
 442      */
 443     uint16_t type;
 444     uint16_t offset;
 445     uint32_t name;
 446 } prog_section_both;
 447
 448 typedef prog_section_both prog_section_def;
 449 typedef prog_section_both prog_section_field;
 450
 451 /* this is ORed to the type */
 452 #define DEF_SAVEGLOBAL (1<<15)
 453 #define DEF_TYPEMASK   ((1<<15)-1)
 454
 455 typedef struct {
 456     int32_t   entry;      /* in statement table for instructions  */
 457     uint32_t  firstlocal; /* First local in local table           */
 458     uint32_t  locals;     /* Total ints of params + locals        */
 459     uint32_t  profile;    /* Always zero (engine uses this)       */
 460     uint32_t  name;       /* name of function in string table     */
 461     uint32_t  file;       /* file of the source file              */
 462     int32_t   nargs;      /* number of arguments                  */
 463     uint8_t   argsize[8]; /* size of arguments (keep 8 always?)   */
 464 } prog_section_function;
 465
 466 /*
 467  * Instructions
 468  * These are the external instructions supported by the interperter
 469  * this is what things compile to (from the C code).
 470  */
 471 enum {
 472     INSTR_DONE,
 473     INSTR_MUL_F,
 474     INSTR_MUL_V,
 475     INSTR_MUL_FV, /* NOTE: the float operands must NOT be at the same locations: A != C */
 476     INSTR_MUL_VF, /* and here: B != C */
 477     INSTR_DIV_F,
 478     INSTR_ADD_F,
 479     INSTR_ADD_V,
 480     INSTR_SUB_F,
 481     INSTR_SUB_V,
 482     INSTR_EQ_F,
 483     INSTR_EQ_V,
 484     INSTR_EQ_S,
 485     INSTR_EQ_E,
 486     INSTR_EQ_FNC,
 487     INSTR_NE_F,
 488     INSTR_NE_V,
 489     INSTR_NE_S,
 490     INSTR_NE_E,
 491     INSTR_NE_FNC,
 492     INSTR_LE,
 493     INSTR_GE,
 494     INSTR_LT,
 495     INSTR_GT,
 496     INSTR_LOAD_F,
 497     INSTR_LOAD_V,
 498     INSTR_LOAD_S,
 499     INSTR_LOAD_ENT,
 500     INSTR_LOAD_FLD,
 501     INSTR_LOAD_FNC,
 502     INSTR_ADDRESS,
 503     INSTR_STORE_F,
 504     INSTR_STORE_V,
 505     INSTR_STORE_S,
 506     INSTR_STORE_ENT,
 507     INSTR_STORE_FLD,
 508     INSTR_STORE_FNC,
 509     INSTR_STOREP_F,
 510     INSTR_STOREP_V,
 511     INSTR_STOREP_S,
 512     INSTR_STOREP_ENT,
 513     INSTR_STOREP_FLD,
 514     INSTR_STOREP_FNC,
 515     INSTR_RETURN,
 516     INSTR_NOT_F,
 517     INSTR_NOT_V,
 518     INSTR_NOT_S,
 519     INSTR_NOT_ENT,
 520     INSTR_NOT_FNC,
 521     INSTR_IF,
 522     INSTR_IFNOT,
 523     INSTR_CALL0,
 524     INSTR_CALL1,
 525     INSTR_CALL2,
 526     INSTR_CALL3,
 527     INSTR_CALL4,
 528     INSTR_CALL5,
 529     INSTR_CALL6,
 530     INSTR_CALL7,
 531     INSTR_CALL8,
 532     INSTR_STATE,
 533     INSTR_GOTO,
 534     INSTR_AND,
 535     INSTR_OR,
 536     INSTR_BITAND,
 537     INSTR_BITOR,
 538
 539     /*
 540      * Virtual instructions used by the assembler
 541      * keep at the end but before virtual instructions
 542      * for the IR below.
 543      */
 544     AINSTR_END,
 545
 546     /*
 547      * Virtual instructions used by the IR
 548      * Keep at the end!
 549      */
 550     VINSTR_PHI,
 551     VINSTR_JUMP,
 552     VINSTR_COND
 553 };
 554
 555 extern prog_section_statement *code_statements;
 556 extern int                    *code_linenums;
 557 extern prog_section_def       *code_defs;
 558 extern prog_section_field     *code_fields;
 559 extern prog_section_function  *code_functions;
 560 extern int                    *code_globals;
 561 extern char                   *code_chars;
 562 extern uint16_t code_crc;
 563
 564 typedef float   qcfloat;
 565 typedef int32_t qcint;
 566
 567 /*
 568  * code_write -- writes out the compiled file
 569  * code_init  -- prepares the code file
 570  */
 571 bool     code_write       (const char *filename, const char *lno);
 572 void     code_init        ();
 573 uint32_t code_genstring   (const char *string);
 574 uint32_t code_cachedstring(const char *string);
 575 qcint    code_alloc_field (size_t qcsize);
 576
 577 /* this function is used to keep statements and linenumbers together */
 578 void     code_push_statement(prog_section_statement *stmt, int linenum);
 579
 580 /*
 581  * A shallow copy of a lex_file to remember where which ast node
 582  * came from.
 583  */
 584 typedef struct {
 585     const char *file;
 586     size_t      line;
 587 } lex_ctx;
 588
 589 /*===================================================================*/
 590 /*============================ con.c ================================*/
 591 /*===================================================================*/
 592 enum {
 593     CON_BLACK   = 30,
 594     CON_RED,
 595     CON_GREEN,
 596     CON_BROWN,
 597     CON_BLUE,
 598     CON_MAGENTA,
 599     CON_CYAN ,
 600     CON_WHITE
 601 };
 602
 603 /* message level */
 604 enum {
 605     LVL_MSG,
 606     LVL_WARNING,
 607     LVL_ERROR
 608 };
 609
 610 void con_vprintmsg (int level, const char *name, size_t line, const char *msgtype, const char *msg, va_list ap);
 611 void con_printmsg  (int level, const char *name, size_t line, const char *msgtype, const char *msg, ...);
 612 void con_cvprintmsg(void *ctx, int lvl, const char *msgtype, const char *msg, va_list ap);
 613 void con_cprintmsg (void *ctx, int lvl, const char *msgtype, const char *msg, ...);
 614
 615 void con_close ();
 616 void con_init  ();
 617 void con_reset ();
 618 void con_color (int);
 619 int  con_change(const char *, const char *);
 620 int  con_verr  (const char *, va_list);
 621 int  con_vout  (const char *, va_list);
 622 int  con_err   (const char *, ...);
 623 int  con_out   (const char *, ...);
 624
 625 /* error/warning interface */
 626 extern size_t compile_errors;
 627 extern size_t compile_warnings;
 628
 629 void /********/ compile_error  (lex_ctx ctx, /*LVL_ERROR*/ const char *msg, ...);
 630 bool GMQCC_WARN compile_warning(lex_ctx ctx, int warntype, const char *fmt, ...);
 631
 632 /*===================================================================*/
 633 /*========================= assembler.c =============================*/
 634 /*===================================================================*/
 635 static const struct {
 636     const char  *m; /* menomic     */
 637     const size_t o; /* operands    */
 638     const size_t l; /* menomic len */
 639 } asm_instr[] = {
 640     { "DONE"      , 1, 4 },
 641     { "MUL_F"     , 3, 5 },
 642     { "MUL_V"     , 3, 5 },
 643     { "MUL_FV"    , 3, 6 },
 644     { "MUL_VF"    , 3, 6 },
 645     { "DIV"       , 0, 3 },
 646     { "ADD_F"     , 3, 5 },
 647     { "ADD_V"     , 3, 5 },
 648     { "SUB_F"     , 3, 5 },
 649     { "SUB_V"     , 3, 5 },
 650     { "EQ_F"      , 0, 4 },
 651     { "EQ_V"      , 0, 4 },
 652     { "EQ_S"      , 0, 4 },
 653     { "EQ_E"      , 0, 4 },
 654     { "EQ_FNC"    , 0, 6 },
 655     { "NE_F"      , 0, 4 },
 656     { "NE_V"      , 0, 4 },
 657     { "NE_S"      , 0, 4 },
 658     { "NE_E"      , 0, 4 },
 659     { "NE_FNC"    , 0, 6 },
 660     { "LE"        , 0, 2 },
 661     { "GE"        , 0, 2 },
 662     { "LT"        , 0, 2 },
 663     { "GT"        , 0, 2 },
 664     { "FIELD_F"   , 0, 7 },
 665     { "FIELD_V"   , 0, 7 },
 666     { "FIELD_S"   , 0, 7 },
 667     { "FIELD_ENT" , 0, 9 },
 668     { "FIELD_FLD" , 0, 9 },
 669     { "FIELD_FNC" , 0, 9 },
 670     { "ADDRESS"   , 0, 7 },
 671     { "STORE_F"   , 0, 7 },
 672     { "STORE_V"   , 0, 7 },
 673     { "STORE_S"   , 0, 7 },
 674     { "STORE_ENT" , 0, 9 },
 675     { "STORE_FLD" , 0, 9 },
 676     { "STORE_FNC" , 0, 9 },
 677     { "STOREP_F"  , 0, 8 },
 678     { "STOREP_V"  , 0, 8 },
 679     { "STOREP_S"  , 0, 8 },
 680     { "STOREP_ENT", 0, 10},
 681     { "STOREP_FLD", 0, 10},
 682     { "STOREP_FNC", 0, 10},
 683     { "RETURN"    , 0, 6 },
 684     { "NOT_F"     , 0, 5 },
 685     { "NOT_V"     , 0, 5 },
 686     { "NOT_S"     , 0, 5 },
 687     { "NOT_ENT"   , 0, 7 },
 688     { "NOT_FNC"   , 0, 7 },
 689     { "IF"        , 0, 2 },
 690     { "IFNOT"     , 0, 5 },
 691     { "CALL0"     , 1, 5 },
 692     { "CALL1"     , 2, 5 },
 693     { "CALL2"     , 3, 5 },
 694     { "CALL3"     , 4, 5 },
 695     { "CALL4"     , 5, 5 },
 696     { "CALL5"     , 6, 5 },
 697     { "CALL6"     , 7, 5 },
 698     { "CALL7"     , 8, 5 },
 699     { "CALL8"     , 9, 5 },
 700     { "STATE"     , 0, 5 },
 701     { "GOTO"      , 0, 4 },
 702     { "AND"       , 0, 3 },
 703     { "OR"        , 0, 2 },
 704     { "BITAND"    , 0, 6 },
 705     { "BITOR"     , 0, 5 },
 706
 707     { "END"       , 0, 3 } /* virtual assembler instruction */
 708 };
 709 /*===================================================================*/
 710 /*============================= ir.c ================================*/
 711 /*===================================================================*/
 712
 713 enum store_types {
 714     store_global,
 715     store_local,  /* local, assignable for now, should get promoted later */
 716     store_param,  /* parameters, they are locals with a fixed position */
 717     store_value,  /* unassignable */
 718     store_return  /* unassignable, at OFS_RETURN */
 719 };
 720
 721 typedef struct {
 722     qcfloat x, y, z;
 723 } vector;
 724
 725 vector  vec3_add  (vector, vector);
 726 vector  vec3_sub  (vector, vector);
 727 qcfloat vec3_mulvv(vector, vector);
 728 vector  vec3_mulvf(vector, float);
 729
 730 /*===================================================================*/
 731 /*============================= exec.c ==============================*/
 732 /*===================================================================*/
 733
 734 /*
 735  * Darkplaces has (or will have) a 64 bit prog loader
 736  * where the 32 bit qc program is autoconverted on load.
 737  * Since we may want to support that as well, let's redefine
 738  * float and int here.
 739  */
 740 typedef union {
 741     qcint   _int;
 742     qcint    string;
 743     qcint    function;
 744     qcint    edict;
 745     qcfloat _float;
 746     qcfloat vector[3];
 747     qcint   ivector[3];
 748 } qcany;
 749
 750 typedef char qcfloat_size_is_correct [sizeof(qcfloat) == 4 ?1:-1];
 751 typedef char qcint_size_is_correct   [sizeof(qcint)   == 4 ?1:-1];
 752
 753 enum {
 754     VMERR_OK,
 755     VMERR_TEMPSTRING_ALLOC,
 756
 757     VMERR_END
 758 };
 759
 760 #define VM_JUMPS_DEFAULT 1000000
 761
 762 /* execute-flags */
 763 #define VMXF_DEFAULT 0x0000     /* default flags - nothing */
 764 #define VMXF_TRACE   0x0001     /* trace: print statements before executing */
 765 #define VMXF_PROFILE 0x0002     /* profile: increment the profile counters */
 766
 767 struct qc_program_s;
 768
 769 typedef int (*prog_builtin)(struct qc_program_s *prog);
 770
 771 typedef struct {
 772     qcint                  stmt;
 773     size_t                 localsp;
 774     prog_section_function *function;
 775 } qc_exec_stack;
 776
 777 typedef struct qc_program_s {
 778     char           *filename;
 779
 780     prog_section_statement *code;
 781     prog_section_def       *defs;
 782     prog_section_def       *fields;
 783     prog_section_function  *functions;
 784     char                   *strings;
 785     qcint                  *globals;
 786     qcint                  *entitydata;
 787     bool                   *entitypool;
 788
 789     const char*            *function_stack;
 790
 791     uint16_t crc16;
 792
 793     size_t tempstring_start;
 794     size_t tempstring_at;
 795
 796     qcint  vmerror;
 797
 798     size_t *profile;
 799
 800     prog_builtin *builtins;
 801     size_t        builtins_count;
 802
 803     /* size_t ip; */
 804     qcint  entities;
 805     size_t entityfields;
 806     bool   allowworldwrites;
 807
 808     qcint         *localstack;
 809     qc_exec_stack *stack;
 810     size_t statement;
 811
 812     size_t xflags;
 813
 814     int    argc; /* current arg count for debugging */
 815 } qc_program;
 816
 817 qc_program* prog_load(const char *filename);
 818 void        prog_delete(qc_program *prog);
 819
 820 bool prog_exec(qc_program *prog, prog_section_function *func, size_t flags, long maxjumps);
 821
 822 char*             prog_getstring (qc_program *prog, qcint str);
 823 prog_section_def* prog_entfield  (qc_program *prog, qcint off);
 824 prog_section_def* prog_getdef    (qc_program *prog, qcint off);
 825 qcany*            prog_getedict  (qc_program *prog, qcint e);
 826 qcint             prog_tempstring(qc_program *prog, const char *_str);
 827
 828
 829 /*===================================================================*/
 830 /*===================== parser.c commandline ========================*/
 831 /*===================================================================*/
 832
 833 bool parser_init          ();
 834 bool parser_compile_file  (const char *filename);
 835 bool parser_compile_string(const char *name, const char *str);
 836 bool parser_finish        (const char *output);
 837 void parser_cleanup       ();
 838 /* There's really no need to strlen() preprocessed files */
 839 bool parser_compile_string_len(const char *name, const char *str, size_t len);
 840
 841 /*===================================================================*/
 842 /*====================== ftepp.c commandline ========================*/
 843 /*===================================================================*/
 844 bool ftepp_init             ();
 845 bool ftepp_preprocess_file  (const char *filename);
 846 bool ftepp_preprocess_string(const char *name, const char *str);
 847 void ftepp_finish           ();
 848 const char *ftepp_get       ();
 849 void ftepp_flush            ();
 850 void ftepp_add_define       (const char *source, const char *name);
 851 void ftepp_add_macro        (const char *name,   const char *value);
 852
 853 /*===================================================================*/
 854 /*======================= main.c commandline ========================*/
 855 /*===================================================================*/
 856
 857 #if 0
 858 /* Helpers to allow for a whole lot of flags. Otherwise we'd limit
 859  * to 32 or 64 -f options...
 860  */
 861 typedef struct {
 862     size_t  idx; /* index into an array of 32 bit words */
 863     uint8_t bit; /* index _into_ the 32 bit word, thus just uint8 */
 864 } longbit;
 865 #define LONGBIT(bit) { ((bit)/32), ((bit)%32) }
 866 #else
 867 typedef uint32_t longbit;
 868 #define LONGBIT(bit) (bit)
 869 #endif
 870
 871 /* Used to store the list of flags with names */
 872 typedef struct {
 873     const char *name;
 874     longbit     bit;
 875 } opts_flag_def;
 876
 877 /*===================================================================*/
 878 /* list of -f flags, like -fdarkplaces-string-table-bug */
 879 enum {
 880 # define GMQCC_TYPE_FLAGS
 881 # define GMQCC_DEFINE_FLAG(X) X,
 882 #  include "opts.def"
 883     COUNT_FLAGS
 884 };
 885 static const opts_flag_def opts_flag_list[] = {
 886 # define GMQCC_TYPE_FLAGS
 887 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(X) },
 888 #  include "opts.def"
 889     { NULL, LONGBIT(0) }
 890 };
 891
 892 enum {
 893 # define GMQCC_TYPE_WARNS
 894 # define GMQCC_DEFINE_FLAG(X) WARN_##X,
 895 #  include "opts.def"
 896     COUNT_WARNINGS
 897 };
 898 static const opts_flag_def opts_warn_list[] = {
 899 # define GMQCC_TYPE_WARNS
 900 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(WARN_##X) },
 901 #  include "opts.def"
 902     { NULL, LONGBIT(0) }
 903 };
 904
 905 enum {
 906 # define GMQCC_TYPE_OPTIMIZATIONS
 907 # define GMQCC_DEFINE_FLAG(NAME, MIN_O) OPTIM_##NAME,
 908 #  include "opts.def"
 909     COUNT_OPTIMIZATIONS
 910 };
 911 static const opts_flag_def opts_opt_list[] = {
 912 # define GMQCC_TYPE_OPTIMIZATIONS
 913 # define GMQCC_DEFINE_FLAG(NAME, MIN_O) { #NAME, LONGBIT(OPTIM_##NAME) },
 914 #  include "opts.def"
 915     { NULL, LONGBIT(0) }
 916 };
 917 static const unsigned int opts_opt_oflag[] = {
 918 # define GMQCC_TYPE_OPTIMIZATIONS
 919 # define GMQCC_DEFINE_FLAG(NAME, MIN_O) MIN_O,
 920 #  include "opts.def"
 921     0
 922 };
 923 extern unsigned int optimization_count[COUNT_OPTIMIZATIONS];
 924
 925 /* other options: */
 926 enum {
 927     COMPILER_QCC,     /* circa  QuakeC */
 928     COMPILER_FTEQCC,  /* fteqcc QuakeC */
 929     COMPILER_QCCX,    /* qccx   QuakeC */
 930     COMPILER_GMQCC    /* this   QuakeC */
 931 };
 932
 933 typedef struct {
 934     uint32_t    O;              /* -Ox           */
 935     const char *output;         /* -o file       */
 936     bool        g;              /* -g            */
 937     int         standard;       /* -std=         */
 938     bool        debug;          /* -debug        */
 939     bool        memchk;         /* -memchk       */
 940     bool        dumpfin;        /* -dumpfin      */
 941     bool        dump;           /* -dump         */
 942     bool        werror;         /* -Werror       */
 943     bool        forcecrc;       /* --force-crc=  */
 944     uint16_t    forced_crc;     /* --force-crc=  */
 945     bool        pp_only;        /* -E            */
 946     size_t      max_array_size; /* --max-array=  */
 947
 948     uint32_t flags       [1 + (COUNT_FLAGS         / 32)];
 949     uint32_t warn        [1 + (COUNT_WARNINGS      / 32)];
 950     uint32_t optimization[1 + (COUNT_OPTIMIZATIONS / 32)];
 951 } cmd_options;
 952
 953 extern cmd_options opts;
 954
 955 /*===================================================================*/
 956 #define OPTS_FLAG(i)         (!! (opts.flags       [(i)/32] & (1<< ((i)%32))))
 957 #define OPTS_WARN(i)         (!! (opts.warn        [(i)/32] & (1<< ((i)%32))))
 958 #define OPTS_OPTIMIZATION(i) (!! (opts.optimization[(i)/32] & (1<< ((i)%32))))
 959
 960 void options_set(uint32_t *flags, size_t idx, bool on);
 961
 962 #endif