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 <stdio.h>
  30 #include <stdarg.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 #       pragma warning(disable : 4996 ) /* This function or variable may be unsafe                 */
  41 #       pragma warning(disable : 4700 ) /* uninitialized local variable used                       */
  42 #endif
  43
  44 #define GMQCC_VERSION_MAJOR 0
  45 #define GMQCC_VERSION_MINOR 2
  46 #define GMQCC_VERSION_PATCH 0
  47 #define GMQCC_VERSION_BUILD(J,N,P) (((J)<<16)|((N)<<8)|(P))
  48 #define GMQCC_VERSION \
  49     GMQCC_VERSION_BUILD(GMQCC_VERSION_MAJOR, GMQCC_VERSION_MINOR, GMQCC_VERSION_PATCH)
  50
  51 /*
  52  * We cannoy 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 #elseif 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 /*
 138  * stdint.h and inttypes.h -less subset
 139  * for systems that don't have it, which we must
 140  * assume is all systems. (int8_t not required)
 141  */
 142 #if   CHAR_MIN  == -128
 143     typedef unsigned char  uint8_t; /* same as below */
 144 #elif SCHAR_MIN == -128
 145     typedef unsigned char  uint8_t; /* same as above */
 146 #endif
 147 #if   SHRT_MAX  == 0x7FFF
 148     typedef short          int16_t;
 149     typedef unsigned short uint16_t;
 150 #elif INT_MAX   == 0x7FFF
 151     typedef int            int16_t;
 152     typedef unsigned int   uint16_t;
 153 #endif
 154 #if   INT_MAX   == 0x7FFFFFFF
 155     typedef int            int32_t;
 156     typedef unsigned int   uint32_t;
 157 #elif LONG_MAX  == 0x7FFFFFFF
 158     typedef long           int32_t;
 159     typedef unsigned long  uint32_t;
 160 #endif
 161
 162
 163 #if defined(__GNUC__) || defined (__CLANG__)
 164         typedef int              int64_t  __attribute__((__mode__(__DI__)));
 165         typedef unsigned int     uint64_t __attribute__((__mode__(__DI__)));
 166 #elif defined(_MSC_VER)
 167         typedef __int64          int64_t;
 168         typedef unsigned __int64 uint64_t;
 169 #else
 170     /*
 171     * Incorrectly size the types so static assertions below will
 172     * fail.  There is no valid way to get a 64bit type at this point
 173     * without making assumptions of too many things.
 174     */
 175     typedef struct { char _fail : 0; } int64_t;
 176     typedef struct { char _fail : 0; } uint64_t;
 177 #endif
 178 #ifdef _LP64 /* long pointer == 64 */
 179     typedef unsigned long  uintptr_t;
 180     typedef long           intptr_t;
 181 #else
 182     typedef unsigned int   uintptr_t;
 183     typedef int            intptr_t;
 184 #endif
 185 /* Ensure type sizes are correct: */
 186 typedef char uint8_size_is_correct  [sizeof(uint8_t)  == 1?1:-1];
 187 typedef char uint16_size_is_correct [sizeof(uint16_t) == 2?1:-1];
 188 typedef char uint32_size_is_correct [sizeof(uint32_t) == 4?1:-1];
 189 typedef char uint64_size_is_correct [sizeof(uint64_t) == 8?1:-1];
 190 typedef char int16_size_if_correct  [sizeof(int16_t)  == 2?1:-1];
 191 typedef char int32_size_is_correct  [sizeof(int32_t)  == 4?1:-1];
 192 typedef char int64_size_is_correct  [sizeof(int64_t)  >= 8?1:-1];
 193 /* intptr_t / uintptr_t correct size check */
 194 typedef char uintptr_size_is_correct[sizeof(intptr_t) == sizeof(int*)?1:-1];
 195 typedef char intptr_size_is_correct [sizeof(uintptr_t)== sizeof(int*)?1:-1];
 196
 197 /*===================================================================*/
 198 /*=========================== util.c ================================*/
 199 /*===================================================================*/
 200 FILE *util_fopen(const char *filename, const char *mode);
 201
 202 void *util_memory_a      (size_t,       unsigned int, const char *);
 203 void  util_memory_d      (void       *, unsigned int, const char *);
 204 void *util_memory_r      (void       *, size_t,       unsigned int, const char *);
 205 void  util_meminfo       ();
 206
 207 bool  util_filexists     (const char *);
 208 bool  util_strupper      (const char *);
 209 bool  util_strdigit      (const char *);
 210 bool  util_strncmpexact  (const char *, const char *, size_t);
 211 char *util_strdup        (const char *);
 212 char *util_strrq         (const char *);
 213 char *util_strrnl        (const char *);
 214 char *util_strsws        (const char *);
 215 char *util_strchp        (const char *, const char *);
 216 void  util_debug         (const char *, const char *, ...);
 217 int   util_getline       (char **, size_t *, FILE *);
 218 void  util_endianswap    (void *,  int, int);
 219
 220 size_t util_strtocmd    (const char *, char *, size_t);
 221 size_t util_strtononcmd (const char *, char *, size_t);
 222
 223 uint16_t util_crc16(uint16_t crc, const char *data, size_t len);
 224 uint32_t util_crc32(uint32_t crc, const char *data, size_t len);
 225
 226 #ifdef NOTRACK
 227 #    define mem_a(x)    malloc (x)
 228 #    define mem_d(x)    free   (x)
 229 #    define mem_r(x, n) realloc(x, n)
 230 #else
 231 #    define mem_a(x)    util_memory_a((x), __LINE__, __FILE__)
 232 #    define mem_d(x)    util_memory_d((x), __LINE__, __FILE__)
 233 #    define mem_r(x, n) util_memory_r((x), (n), __LINE__, __FILE__)
 234 #endif
 235
 236 /*
 237  * TODO: make these safer to use.  Currently this only works on
 238  * x86 and x86_64, some systems will likely not like this. Such
 239  * as BE systems.
 240  */
 241 #define FLT2INT(Y) *((int32_t*)&(Y))
 242 #define INT2FLT(Y) *((float  *)&(Y))
 243
 244 /* New flexible vector implementation from Dale */
 245 #define _vec_raw(A) (((size_t*)(void*)(A)) - 2)
 246 #define _vec_beg(A) (_vec_raw(A)[0])
 247 #define _vec_end(A) (_vec_raw(A)[1])
 248 #define _vec_needsgrow(A,N) ((!(A)) || (_vec_end(A) + (N) >= _vec_beg(A)))
 249 #define _vec_mightgrow(A,N) (_vec_needsgrow((A), (N)) ? (void)_vec_forcegrow((A),(N)) : (void)0)
 250 #define _vec_forcegrow(A,N) _util_vec_grow(((void**)&(A)), (N), sizeof(*(A)))
 251 #define _vec_remove(A,S,I,N) (memmove((char*)(A)+(I)*(S),(char*)(A)+((I)+(N))*(S),(S)*(_vec_end(A)-(I)-(N))), _vec_end(A)-=(N))
 252 void _util_vec_grow(void **a, size_t i, size_t s);
 253 /* exposed interface */
 254 #define vec_free(A)          ((A) ? (mem_d((void*)_vec_raw(A)), (A) = NULL) : 0)
 255 #define vec_push(A,V)        (_vec_mightgrow((A),1), (A)[_vec_end(A)++] = (V))
 256 #define vec_size(A)          ((A) ? _vec_end(A) : 0)
 257 #define vec_add(A,N)         (_vec_mightgrow((A),(N)), _vec_end(A)+=(N), &(A)[_vec_end(A)-(N)])
 258 #define vec_last(A)          ((A)[_vec_end(A)-1])
 259 #define vec_append(A,N,S)    memcpy(vec_add((A), (N)), (S), N * sizeof(*(S)))
 260 #define vec_remove(A,I,N)    _vec_remove((A), sizeof(*(A)), (I), (N))
 261 #define vec_pop(A)           (_vec_end(A)-=1)
 262 /* these are supposed to NOT reallocate */
 263 #define vec_shrinkto(A,N)    (_vec_end(A) = (N))
 264 #define vec_shrinkby(A,N)    (_vec_end(A) -= (N))
 265
 266 typedef struct hash_table_t {
 267     size_t                size;
 268     struct hash_node_t **table;
 269 } hash_table_t, *ht;
 270
 271 /*
 272  * hashtable implementation:
 273  *
 274  * Note:
 275  *      This was designed for pointers:  you manage the life of the object yourself
 276  *      if you do use this for non-pointers please be warned that the object may not
 277  *      be valid if the duration of it exceeds (i.e on stack).  So you need to allocate
 278  *      yourself, or put those in global scope to ensure duration is for the whole
 279  *      runtime.
 280  *
 281  * util_htnew(size)                             -- to make a new hashtable
 282  * util_htset(table, key, value, sizeof(value)) -- to set something in the table
 283  * util_htget(table, key)                       -- to get something from the table
 284  * util_htdel(table)                            -- to delete the table
 285  *
 286  * example of use:
 287  *
 288  * ht    foo  = util_htnew(1024);
 289  * int   data = 100;
 290  * char *test = "hello world\n";
 291  * util_htset(foo, "foo", (void*)&data);
 292  * util_gtset(foo, "bar", (void*)test);
 293  *
 294  * printf("foo: %d, bar %s",
 295  *     *((int *)util_htget(foo, "foo")),
 296  *      ((char*)util_htget(foo, "bar"))
 297  * );
 298  *
 299  * util_htdel(foo);
 300  */
 301 hash_table_t *util_htnew (size_t size);
 302 void          util_htset (hash_table_t *ht, const char *key, void *value);
 303 void         *util_htget (hash_table_t *ht, const char *key);
 304 void          util_htdel (hash_table_t *ht);
 305 size_t        util_hthash(hash_table_t *ht, const char *key);
 306 void         *util_htgeth(hash_table_t *ht, const char *key, size_t hash);
 307 void          util_htseth(hash_table_t *ht, const char *key, size_t hash, void *value);
 308 /*===================================================================*/
 309 /*=========================== code.c ================================*/
 310 /*===================================================================*/
 311
 312 /* Note: if you change the order, fix type_sizeof in ir.c */
 313 enum {
 314     TYPE_VOID     ,
 315     TYPE_STRING   ,
 316     TYPE_FLOAT    ,
 317     TYPE_VECTOR   ,
 318     TYPE_ENTITY   ,
 319     TYPE_FIELD    ,
 320     TYPE_FUNCTION ,
 321     TYPE_POINTER  ,
 322     TYPE_INTEGER  ,
 323     TYPE_VARIANT  ,
 324     TYPE_STRUCT   ,
 325     TYPE_UNION    ,
 326     TYPE_ARRAY    ,
 327
 328     TYPE_COUNT
 329 };
 330
 331 /* const/var qualifiers */
 332 #define CV_NONE  0
 333 #define CV_CONST 1
 334 #define CV_VAR  -1
 335
 336 extern const char *type_name[TYPE_COUNT];
 337
 338 extern size_t type_sizeof[TYPE_COUNT];
 339 extern uint16_t type_store_instr[TYPE_COUNT];
 340 extern uint16_t field_store_instr[TYPE_COUNT];
 341 /* could use type_store_instr + INSTR_STOREP_F - INSTR_STORE_F
 342  * but this breaks when TYPE_INTEGER is added, since with the enhanced
 343  * instruction set, the old ones are left untouched, thus the _I instructions
 344  * are at a seperate place.
 345  */
 346 extern uint16_t type_storep_instr[TYPE_COUNT];
 347 /* other useful lists */
 348 extern uint16_t type_eq_instr[TYPE_COUNT];
 349 extern uint16_t type_ne_instr[TYPE_COUNT];
 350 extern uint16_t type_not_instr[TYPE_COUNT];
 351
 352 typedef struct {
 353     uint32_t offset;      /* Offset in file of where data begins  */
 354     uint32_t length;      /* Length of section (how many of)      */
 355 } prog_section;
 356
 357 typedef struct {
 358     uint32_t     version;      /* Program version (6)     */
 359     uint16_t     crc16;        /* What is this?           */
 360     uint16_t     skip;         /* see propsal.txt         */
 361
 362     prog_section statements;   /* prog_section_statement  */
 363     prog_section defs;         /* prog_section_def        */
 364     prog_section fields;       /* prog_section_field      */
 365     prog_section functions;    /* prog_section_function   */
 366     prog_section strings;      /* What is this?           */
 367     prog_section globals;      /* What is this?           */
 368     uint32_t     entfield;     /* Number of entity fields */
 369 } prog_header;
 370
 371 /*
 372  * Each paramater incerements by 3 since vector types hold
 373  * 3 components (x,y,z).
 374  */
 375 #define OFS_NULL      0
 376 #define OFS_RETURN    1
 377 #define OFS_PARM0     (OFS_RETURN+3)
 378 #define OFS_PARM1     (OFS_PARM0 +3)
 379 #define OFS_PARM2     (OFS_PARM1 +3)
 380 #define OFS_PARM3     (OFS_PARM2 +3)
 381 #define OFS_PARM4     (OFS_PARM3 +3)
 382 #define OFS_PARM5     (OFS_PARM4 +3)
 383 #define OFS_PARM6     (OFS_PARM5 +3)
 384 #define OFS_PARM7     (OFS_PARM6 +3)
 385
 386 typedef struct {
 387     uint16_t opcode;
 388
 389     /* operand 1 */
 390     union {
 391         int16_t  s1; /* signed   */
 392         uint16_t u1; /* unsigned */
 393     } o1;
 394     /* operand 2 */
 395     union {
 396         int16_t  s1; /* signed   */
 397         uint16_t u1; /* unsigned */
 398     } o2;
 399     /* operand 3 */
 400     union {
 401         int16_t  s1; /* signed   */
 402         uint16_t u1; /* unsigned */
 403     } o3;
 404
 405     /*
 406      * This is the same as the structure in darkplaces
 407      * {
 408      *     unsigned short op;
 409      *     short          a,b,c;
 410      * }
 411      * But this one is more sane to work with, and the
 412      * type sizes are guranteed.
 413      */
 414 } prog_section_statement;
 415
 416 typedef struct {
 417     /* The types:
 418      * 0 = ev_void
 419      * 1 = ev_string
 420      * 2 = ev_float
 421      * 3 = ev_vector
 422      * 4 = ev_entity
 423      * 5 = ev_field
 424      * 6 = ev_function
 425      * 7 = ev_pointer -- engine only
 426      * 8 = ev_bad     -- engine only
 427      */
 428     uint16_t type;
 429     uint16_t offset;
 430     uint32_t name;
 431 } prog_section_both;
 432 typedef prog_section_both prog_section_def;
 433 typedef prog_section_both prog_section_field;
 434
 435 /* this is ORed to the type */
 436 #define DEF_SAVEGLOBAL (1<<15)
 437 #define DEF_TYPEMASK   ((1<<15)-1)
 438
 439 typedef struct {
 440     int32_t   entry;      /* in statement table for instructions  */
 441     uint32_t  firstlocal; /* First local in local table           */
 442     uint32_t  locals;     /* Total ints of params + locals        */
 443     uint32_t  profile;    /* Always zero (engine uses this)       */
 444     uint32_t  name;       /* name of function in string table     */
 445     uint32_t  file;       /* file of the source file              */
 446     uint32_t  nargs;      /* number of arguments                  */
 447     uint8_t   argsize[8]; /* size of arguments (keep 8 always?)   */
 448 } prog_section_function;
 449
 450 /*
 451  * Instructions
 452  * These are the external instructions supported by the interperter
 453  * this is what things compile to (from the C code).
 454  */
 455 enum {
 456     INSTR_DONE,
 457     INSTR_MUL_F,
 458     INSTR_MUL_V,
 459     INSTR_MUL_FV, /* NOTE: the float operands must NOT be at the same locations: A != C */
 460     INSTR_MUL_VF, /* and here: B != C */
 461     INSTR_DIV_F,
 462     INSTR_ADD_F,
 463     INSTR_ADD_V,
 464     INSTR_SUB_F,
 465     INSTR_SUB_V,
 466     INSTR_EQ_F,
 467     INSTR_EQ_V,
 468     INSTR_EQ_S,
 469     INSTR_EQ_E,
 470     INSTR_EQ_FNC,
 471     INSTR_NE_F,
 472     INSTR_NE_V,
 473     INSTR_NE_S,
 474     INSTR_NE_E,
 475     INSTR_NE_FNC,
 476     INSTR_LE,
 477     INSTR_GE,
 478     INSTR_LT,
 479     INSTR_GT,
 480     INSTR_LOAD_F,
 481     INSTR_LOAD_V,
 482     INSTR_LOAD_S,
 483     INSTR_LOAD_ENT,
 484     INSTR_LOAD_FLD,
 485     INSTR_LOAD_FNC,
 486     INSTR_ADDRESS,
 487     INSTR_STORE_F,
 488     INSTR_STORE_V,
 489     INSTR_STORE_S,
 490     INSTR_STORE_ENT,
 491     INSTR_STORE_FLD,
 492     INSTR_STORE_FNC,
 493     INSTR_STOREP_F,
 494     INSTR_STOREP_V,
 495     INSTR_STOREP_S,
 496     INSTR_STOREP_ENT,
 497     INSTR_STOREP_FLD,
 498     INSTR_STOREP_FNC,
 499     INSTR_RETURN,
 500     INSTR_NOT_F,
 501     INSTR_NOT_V,
 502     INSTR_NOT_S,
 503     INSTR_NOT_ENT,
 504     INSTR_NOT_FNC,
 505     INSTR_IF,
 506     INSTR_IFNOT,
 507     INSTR_CALL0,
 508     INSTR_CALL1,
 509     INSTR_CALL2,
 510     INSTR_CALL3,
 511     INSTR_CALL4,
 512     INSTR_CALL5,
 513     INSTR_CALL6,
 514     INSTR_CALL7,
 515     INSTR_CALL8,
 516     INSTR_STATE,
 517     INSTR_GOTO,
 518     INSTR_AND,
 519     INSTR_OR,
 520     INSTR_BITAND,
 521     INSTR_BITOR,
 522
 523     /*
 524      * Virtual instructions used by the assembler
 525      * keep at the end but before virtual instructions
 526      * for the IR below.
 527      */
 528     AINSTR_END,
 529
 530     /*
 531      * Virtual instructions used by the IR
 532      * Keep at the end!
 533      */
 534     VINSTR_PHI,
 535     VINSTR_JUMP,
 536     VINSTR_COND
 537 };
 538
 539 extern prog_section_statement *code_statements;
 540 extern prog_section_def       *code_defs;
 541 extern prog_section_field     *code_fields;
 542 extern prog_section_function  *code_functions;
 543 extern int                    *code_globals;
 544 extern char                   *code_chars;
 545 extern uint16_t code_crc;
 546
 547 typedef float   qcfloat;
 548 typedef int32_t qcint;
 549
 550 /*
 551  * code_write -- writes out the compiled file
 552  * code_init  -- prepares the code file
 553  */
 554 bool     code_write       (const char *filename);
 555 void     code_init        ();
 556 uint32_t code_genstring   (const char *string);
 557 uint32_t code_cachedstring(const char *string);
 558 qcint    code_alloc_field (size_t qcsize);
 559
 560 /*
 561  * A shallow copy of a lex_file to remember where which ast node
 562  * came from.
 563  */
 564 typedef struct {
 565     const char *file;
 566     size_t      line;
 567 } lex_ctx;
 568
 569
 570 /*===================================================================*/
 571 /*============================ con.c ================================*/
 572 /*===================================================================*/
 573 enum {
 574     CON_BLACK   = 30,
 575     CON_RED,
 576     CON_GREEN,
 577     CON_BROWN,
 578     CON_BLUE,
 579     CON_MAGENTA,
 580     CON_CYAN ,
 581     CON_WHITE
 582 };
 583
 584 /* message level */
 585 enum {
 586     LVL_MSG,
 587     LVL_WARNING,
 588     LVL_ERROR
 589 };
 590
 591
 592 void con_vprintmsg (int level, const char *name, size_t line, const char *msgtype, const char *msg, va_list ap);
 593 void con_printmsg  (int level, const char *name, size_t line, const char *msgtype, const char *msg, ...);
 594 void con_cvprintmsg(void *ctx, int lvl, const char *msgtype, const char *msg, va_list ap);
 595 void con_cprintmsg (void *ctx, int lvl, const char *msgtype, const char *msg, ...);
 596
 597 void con_close();
 598 void con_color(int state);
 599 void con_init ();
 600 void con_reset();
 601 int  con_change(const char *out, const char *err);
 602 int  con_verr  (const char *fmt, va_list va);
 603 int  con_vout  (const char *fmt, va_list va);
 604 int  con_err   (const char *fmt, ...);
 605 int  con_out   (const char *fmt, ...);
 606
 607 /* error/warning interface */
 608 extern size_t compile_errors;
 609 extern size_t compile_warnings;
 610
 611 void compile_error(lex_ctx ctx, const char *msg, ...);
 612 bool GMQCC_WARN compile_warning(lex_ctx ctx, int warntype, const char *fmt, ...);
 613
 614 /*===================================================================*/
 615 /*========================= assembler.c =============================*/
 616 /*===================================================================*/
 617 static const struct {
 618     const char  *m; /* menomic     */
 619     const size_t o; /* operands    */
 620     const size_t l; /* menomic len */
 621 } asm_instr[] = {
 622     { "DONE"      , 1, 4 },
 623     { "MUL_F"     , 3, 5 },
 624     { "MUL_V"     , 3, 5 },
 625     { "MUL_FV"    , 3, 6 },
 626     { "MUL_VF"    , 3, 6 },
 627     { "DIV"       , 0, 3 },
 628     { "ADD_F"     , 3, 5 },
 629     { "ADD_V"     , 3, 5 },
 630     { "SUB_F"     , 3, 5 },
 631     { "SUB_V"     , 3, 5 },
 632     { "EQ_F"      , 0, 4 },
 633     { "EQ_V"      , 0, 4 },
 634     { "EQ_S"      , 0, 4 },
 635     { "EQ_E"      , 0, 4 },
 636     { "EQ_FNC"    , 0, 6 },
 637     { "NE_F"      , 0, 4 },
 638     { "NE_V"      , 0, 4 },
 639     { "NE_S"      , 0, 4 },
 640     { "NE_E"      , 0, 4 },
 641     { "NE_FNC"    , 0, 6 },
 642     { "LE"        , 0, 2 },
 643     { "GE"        , 0, 2 },
 644     { "LT"        , 0, 2 },
 645     { "GT"        , 0, 2 },
 646     { "FIELD_F"   , 0, 7 },
 647     { "FIELD_V"   , 0, 7 },
 648     { "FIELD_S"   , 0, 7 },
 649     { "FIELD_ENT" , 0, 9 },
 650     { "FIELD_FLD" , 0, 9 },
 651     { "FIELD_FNC" , 0, 9 },
 652     { "ADDRESS"   , 0, 7 },
 653     { "STORE_F"   , 0, 7 },
 654     { "STORE_V"   , 0, 7 },
 655     { "STORE_S"   , 0, 7 },
 656     { "STORE_ENT" , 0, 9 },
 657     { "STORE_FLD" , 0, 9 },
 658     { "STORE_FNC" , 0, 9 },
 659     { "STOREP_F"  , 0, 8 },
 660     { "STOREP_V"  , 0, 8 },
 661     { "STOREP_S"  , 0, 8 },
 662     { "STOREP_ENT", 0, 10},
 663     { "STOREP_FLD", 0, 10},
 664     { "STOREP_FNC", 0, 10},
 665     { "RETURN"    , 0, 6 },
 666     { "NOT_F"     , 0, 5 },
 667     { "NOT_V"     , 0, 5 },
 668     { "NOT_S"     , 0, 5 },
 669     { "NOT_ENT"   , 0, 7 },
 670     { "NOT_FNC"   , 0, 7 },
 671     { "IF"        , 0, 2 },
 672     { "IFNOT"     , 0, 5 },
 673     { "CALL0"     , 1, 5 },
 674     { "CALL1"     , 2, 5 },
 675     { "CALL2"     , 3, 5 },
 676     { "CALL3"     , 4, 5 },
 677     { "CALL4"     , 5, 5 },
 678     { "CALL5"     , 6, 5 },
 679     { "CALL6"     , 7, 5 },
 680     { "CALL7"     , 8, 5 },
 681     { "CALL8"     , 9, 5 },
 682     { "STATE"     , 0, 5 },
 683     { "GOTO"      , 0, 4 },
 684     { "AND"       , 0, 3 },
 685     { "OR"        , 0, 2 },
 686     { "BITAND"    , 0, 6 },
 687     { "BITOR"     , 0, 5 },
 688
 689     { "END"       , 0, 3 } /* virtual assembler instruction */
 690 };
 691 /*===================================================================*/
 692 /*============================= ir.c ================================*/
 693 /*===================================================================*/
 694
 695 enum store_types {
 696     store_global,
 697     store_local,  /* local, assignable for now, should get promoted later */
 698     store_param,  /* parameters, they are locals with a fixed position */
 699     store_value,  /* unassignable */
 700     store_return  /* unassignable, at OFS_RETURN */
 701 };
 702
 703 typedef struct {
 704     qcfloat x, y, z;
 705 } vector;
 706
 707 vector  vec3_add  (vector, vector);
 708 vector  vec3_sub  (vector, vector);
 709 qcfloat vec3_mulvv(vector, vector);
 710 vector  vec3_mulvf(vector, float);
 711
 712 /*===================================================================*/
 713 /*============================= exec.c ==============================*/
 714 /*===================================================================*/
 715
 716 /* darkplaces has (or will have) a 64 bit prog loader
 717  * where the 32 bit qc program is autoconverted on load.
 718  * Since we may want to support that as well, let's redefine
 719  * float and int here.
 720  */
 721 typedef union {
 722     qcint   _int;
 723     qcint    string;
 724     qcint    function;
 725     qcint    edict;
 726     qcfloat _float;
 727     qcfloat vector[3];
 728     qcint   ivector[3];
 729 } qcany;
 730
 731 typedef char qcfloat_size_is_correct [sizeof(qcfloat) == 4 ?1:-1];
 732 typedef char qcint_size_is_correct   [sizeof(qcint)   == 4 ?1:-1];
 733
 734 enum {
 735     VMERR_OK,
 736     VMERR_TEMPSTRING_ALLOC,
 737
 738     VMERR_END
 739 };
 740
 741 #define VM_JUMPS_DEFAULT 1000000
 742
 743 /* execute-flags */
 744 #define VMXF_DEFAULT 0x0000     /* default flags - nothing */
 745 #define VMXF_TRACE   0x0001     /* trace: print statements before executing */
 746 #define VMXF_PROFILE 0x0002     /* profile: increment the profile counters */
 747
 748 struct qc_program_s;
 749
 750 typedef int (*prog_builtin)(struct qc_program_s *prog);
 751
 752 typedef struct {
 753     qcint                  stmt;
 754     size_t                 localsp;
 755     prog_section_function *function;
 756 } qc_exec_stack;
 757
 758 typedef struct qc_program_s {
 759     char           *filename;
 760
 761     prog_section_statement *code;
 762     prog_section_def       *defs;
 763     prog_section_def       *fields;
 764     prog_section_function  *functions;
 765     char                   *strings;
 766     qcint                  *globals;
 767     qcint                  *entitydata;
 768     bool                   *entitypool;
 769
 770     const char*            *function_stack;
 771
 772     uint16_t crc16;
 773
 774     size_t tempstring_start;
 775     size_t tempstring_at;
 776
 777     qcint  vmerror;
 778
 779     size_t *profile;
 780
 781     prog_builtin *builtins;
 782     size_t        builtins_count;
 783
 784     /* size_t ip; */
 785     qcint  entities;
 786     size_t entityfields;
 787     bool   allowworldwrites;
 788
 789     qcint         *localstack;
 790     qc_exec_stack *stack;
 791     size_t statement;
 792
 793     size_t xflags;
 794
 795     int    argc; /* current arg count for debugging */
 796 } qc_program;
 797
 798 qc_program* prog_load(const char *filename);
 799 void        prog_delete(qc_program *prog);
 800
 801 bool prog_exec(qc_program *prog, prog_section_function *func, size_t flags, long maxjumps);
 802
 803 char*             prog_getstring (qc_program *prog, qcint str);
 804 prog_section_def* prog_entfield  (qc_program *prog, qcint off);
 805 prog_section_def* prog_getdef    (qc_program *prog, qcint off);
 806 qcany*            prog_getedict  (qc_program *prog, qcint e);
 807 qcint             prog_tempstring(qc_program *prog, const char *_str);
 808
 809
 810 /*===================================================================*/
 811 /*===================== parser.c commandline ========================*/
 812 /*===================================================================*/
 813
 814 bool parser_init          ();
 815 bool parser_compile_file  (const char *filename);
 816 bool parser_compile_string(const char *name, const char *str);
 817 bool parser_finish        (const char *output);
 818 void parser_cleanup       ();
 819 /* There's really no need to strlen() preprocessed files */
 820 bool parser_compile_string_len(const char *name, const char *str, size_t len);
 821
 822 /*===================================================================*/
 823 /*====================== ftepp.c commandline ========================*/
 824 /*===================================================================*/
 825 bool ftepp_init             ();
 826 bool ftepp_preprocess_file  (const char *filename);
 827 bool ftepp_preprocess_string(const char *name, const char *str);
 828 void ftepp_finish           ();
 829 const char *ftepp_get       ();
 830 void ftepp_flush            ();
 831 void ftepp_add_define       (const char *source, const char *name);
 832
 833 /*===================================================================*/
 834 /*======================= main.c commandline ========================*/
 835 /*===================================================================*/
 836
 837 #if 0
 838 /* Helpers to allow for a whole lot of flags. Otherwise we'd limit
 839  * to 32 or 64 -f options...
 840  */
 841 typedef struct {
 842     size_t  idx; /* index into an array of 32 bit words */
 843     uint8_t bit; /* index _into_ the 32 bit word, thus just uint8 */
 844 } longbit;
 845 #define LONGBIT(bit) { ((bit)/32), ((bit)%32) }
 846 #else
 847 typedef uint32_t longbit;
 848 #define LONGBIT(bit) (bit)
 849 #endif
 850
 851 /* Used to store the list of flags with names */
 852 typedef struct {
 853     const char *name;
 854     longbit    bit;
 855 } opts_flag_def;
 856
 857 /*===================================================================*/
 858 /* list of -f flags, like -fdarkplaces-string-table-bug */
 859 enum {
 860 # define GMQCC_TYPE_FLAGS
 861 # define GMQCC_DEFINE_FLAG(X) X,
 862 #  include "opts.def"
 863     COUNT_FLAGS
 864 };
 865 static const opts_flag_def opts_flag_list[] = {
 866 # define GMQCC_TYPE_FLAGS
 867 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(X) },
 868 #  include "opts.def"
 869     { NULL, LONGBIT(0) }
 870 };
 871
 872 enum {
 873 # define GMQCC_TYPE_WARNS
 874 # define GMQCC_DEFINE_FLAG(X) WARN_##X,
 875 #  include "opts.def"
 876     COUNT_WARNINGS
 877 };
 878 static const opts_flag_def opts_warn_list[] = {
 879 # define GMQCC_TYPE_WARNS
 880 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(WARN_##X) },
 881 #  include "opts.def"
 882     { NULL, LONGBIT(0) }
 883 };
 884
 885 enum {
 886 # define GMQCC_TYPE_OPTIMIZATIONS
 887 # define GMQCC_DEFINE_FLAG(NAME, MIN_O) OPTIM_##NAME,
 888 #  include "opts.def"
 889     COUNT_OPTIMIZATIONS
 890 };
 891 static const opts_flag_def opts_opt_list[] = {
 892 # define GMQCC_TYPE_OPTIMIZATIONS
 893 # define GMQCC_DEFINE_FLAG(NAME, MIN_O) { #NAME, LONGBIT(OPTIM_##NAME) },
 894 #  include "opts.def"
 895     { NULL, LONGBIT(0) }
 896 };
 897 static const unsigned int opts_opt_oflag[] = {
 898 # define GMQCC_TYPE_OPTIMIZATIONS
 899 # define GMQCC_DEFINE_FLAG(NAME, MIN_O) MIN_O,
 900 #  include "opts.def"
 901     0
 902 };
 903 extern unsigned int optimization_count[COUNT_OPTIMIZATIONS];
 904
 905 /* other options: */
 906 enum {
 907     COMPILER_QCC,     /* circa  QuakeC */
 908     COMPILER_FTEQCC,  /* fteqcc QuakeC */
 909     COMPILER_QCCX,    /* qccx   QuakeC */
 910     COMPILER_GMQCC    /* this   QuakeC */
 911 };
 912 extern uint32_t    opts_O;      /* -Ox */
 913 extern const char *opts_output; /* -o file */
 914 extern int         opts_standard;
 915 extern bool        opts_debug;
 916 extern bool        opts_memchk;
 917 extern bool        opts_dumpfin;
 918 extern bool        opts_dump;
 919 extern bool        opts_werror;
 920 extern bool        opts_forcecrc;
 921 extern uint16_t    opts_forced_crc;
 922 extern bool        opts_pp_only;
 923 extern size_t      opts_max_array_size;
 924
 925 /*===================================================================*/
 926 #define OPTS_FLAG(i) (!! (opts_flags[(i)/32] & (1<< ((i)%32))))
 927 extern uint32_t opts_flags[1 + (COUNT_FLAGS / 32)];
 928 #define OPTS_WARN(i) (!! (opts_warn[(i)/32] & (1<< ((i)%32))))
 929 extern uint32_t opts_warn[1 + (COUNT_WARNINGS / 32)];
 930 #define OPTS_OPTIMIZATION(i) (!! (opts_optimization[(i)/32] & (1<< ((i)%32))))
 931 extern uint32_t opts_optimization[1 + (COUNT_OPTIMIZATIONS / 32)];
 932
 933 #endif