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