gmqcc.h

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