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