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