gmqcc.h

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