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