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