gmqcc.h

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