gmqcc.h

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