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