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