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