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 <ctype.h>
  30
  31 #define GMQCC_VERSION_MAJOR 0
  32 #define GMQCC_VERSION_MINOR 1
  33 #define GMQCC_VERSION_PATCH 0
  34 #define GMQCC_VERSION_BUILD(J,N,P) (((J)<<16)|((N)<<8)|(P))
  35 #define GMQCC_VERSION \
  36     GMQCC_VERSION_BUILD(GMQCC_VERSION_MAJOR, GMQCC_VERSION_MINOR, GMQCC_VERSION_PATCH)
  37
  38 /*
  39  * We cannoy rely on C99 at all, since compilers like MSVC
  40  * simply don't support it.  We define our own boolean type
  41  * as a result (since we cannot include <stdbool.h>). For
  42  * compilers that are in 1999 mode (C99 compliant) we can use
  43  * the language keyword _Bool which can allow for better code
  44  * on GCC and GCC-like compilers, opposed to `int`.
  45  */
  46 #ifndef __cplusplus
  47 #   ifdef  false
  48 #       undef  false
  49 #   endif /* !false */
  50 #   ifdef  true
  51 #       undef true
  52 #   endif /* !true  */
  53 #   define false (0)
  54 #   define true  (1)
  55 #   ifdef __STDC_VERSION__
  56 #       if __STDC_VERSION__ < 199901L && __GNUC__ < 3
  57             typedef int  bool;
  58 #       else
  59             typedef _Bool bool;
  60 #       endif
  61 #   else
  62         typedef int bool;
  63 #   endif /* !__STDC_VERSION__ */
  64 #endif    /* !__cplusplus      */
  65
  66 /*
  67  * Of some functions which are generated we want to make sure
  68  * that the result isn't ignored. To find such function calls,
  69  * we use this macro.
  70  */
  71 #if defined(__GNUC__) || defined(__CLANG__)
  72 #   define GMQCC_WARN __attribute__((warn_unused_result))
  73 #else
  74 #   define GMQCC_WARN
  75 #endif
  76 /*
  77  * This is a hack to silent clang regarding empty
  78  * body if statements.
  79  */
  80 #define GMQCC_SUPPRESS_EMPTY_BODY do { } while (0)
  81
  82 /*
  83  * Inline is not supported in < C90, however some compilers
  84  * like gcc and clang might have an inline attribute we can
  85  * use if present.
  86  */
  87 #ifdef __STDC_VERSION__
  88 #    if __STDC_VERSION__ < 199901L
  89 #       if defined(__GNUC__) || defined (__CLANG__)
  90 #           if __GNUC__ < 2
  91 #               define GMQCC_INLINE
  92 #           else
  93 #               define GMQCC_INLINE __attribute__ ((always_inline))
  94 #           endif
  95 #       else
  96 #           define GMQCC_INLINE
  97 #       endif
  98 #    else
  99 #       define GMQCC_INLINE inline
 100 #    endif
 101 #else
 102 #    define GMQCC_INLINE
 103 #endif /* !__STDC_VERSION__ */
 104
 105 /*
 106  * noreturn is present in GCC and clang
 107  * it's required for _ast_node_destory otherwise -Wmissing-noreturn
 108  * in clang complains about there being no return since abort() is
 109  * called.
 110  */
 111 #if (defined(__GNUC__) && __GNUC__ >= 2) || defined(__CLANG__)
 112 #    define GMQCC_NORETURN __attribute__ ((noreturn))
 113 #else
 114 #    define GMQCC_NORETURN
 115 #endif
 116
 117 /*
 118  * stdint.h and inttypes.h -less subset
 119  * for systems that don't have it, which we must
 120  * assume is all systems. (int8_t not required)
 121  */
 122 #if   CHAR_MIN  == -128
 123     typedef unsigned char  uint8_t; /* same as below */
 124 #elif SCHAR_MIN == -128
 125     typedef unsigned char  uint8_t; /* same as above */
 126 #endif
 127 #if   SHRT_MAX  == 0x7FFF
 128     typedef short          int16_t;
 129     typedef unsigned short uint16_t;
 130 #elif INT_MAX   == 0x7FFF
 131     typedef int            int16_t;
 132     typedef unsigned int   uint16_t;
 133 #endif
 134 #if   INT_MAX   == 0x7FFFFFFF
 135     typedef int            int32_t;
 136     typedef unsigned int   uint32_t;
 137     typedef long           int64_t;
 138     typedef unsigned long  uint64_t;
 139 #elif LONG_MAX  == 0x7FFFFFFF
 140     typedef long           int32_t;
 141     typedef unsigned long  uint32_t;
 142
 143     /*
 144      * It's nearly impossible to figure out a 64bit type at
 145      * this point without making assumptions about the build
 146      * enviroment.  So if clang or gcc is detected use some
 147      * compiler builtins to create a 64 signed and unsigned
 148      * type.
 149      */
 150 #   if defined(__GNUC__) || defined (__CLANG__)
 151         typedef int          int64_t  __attribute__((__mode__(__DI__)));
 152         typedef unsigned int uint64_t __attribute__((__mode__(__DI__)));
 153 #   else
 154         /*
 155          * Incoorectly size the types so static assertions below will
 156          * fail.  There is no valid way to get a 64bit type at this point
 157          * without making assumptions of too many things.
 158          */
 159         typedef struct { char _fail : 0; } int64_t;
 160         typedef struct { char _fail : 0; } uint64_t;
 161 #   endif
 162 #endif
 163 #ifdef _LP64 /* long pointer == 64 */
 164     typedef unsigned long  uintptr_t;
 165     typedef long           intptr_t;
 166 #else
 167     typedef unsigned int   uintptr_t;
 168     typedef int            intptr_t;
 169 #endif
 170 /* Ensure type sizes are correct: */
 171 typedef char uint8_size_is_correct  [sizeof(uint8_t)  == 1?1:-1];
 172 typedef char uint16_size_is_correct [sizeof(uint16_t) == 2?1:-1];
 173 typedef char uint32_size_is_correct [sizeof(uint32_t) == 4?1:-1];
 174 typedef char uint64_size_is_correct [sizeof(uint64_t) == 8?1:-1];
 175 typedef char int16_size_if_correct  [sizeof(int16_t)  == 2?1:-1];
 176 typedef char int32_size_is_correct  [sizeof(int32_t)  == 4?1:-1];
 177 typedef char int64_size_is_correct  [sizeof(int64_t)  == 8?1:-1];
 178 /* intptr_t / uintptr_t correct size check */
 179 typedef char uintptr_size_is_correct[sizeof(intptr_t) == sizeof(int*)?1:-1];
 180 typedef char intptr_size_is_correct [sizeof(uintptr_t)== sizeof(int*)?1:-1];
 181
 182 /*===================================================================*/
 183 /*=========================== util.c ================================*/
 184 /*===================================================================*/
 185 void *util_memory_a      (unsigned int, unsigned int, const char *);
 186 void  util_memory_d      (void       *, unsigned int, const char *);
 187 void  util_meminfo       ();
 188
 189 bool  util_strupper      (const char *);
 190 bool  util_strdigit      (const char *);
 191 bool  util_strncmpexact  (const char *, const char *, size_t);
 192 char *util_strdup        (const char *);
 193 char *util_strrq         (const char *);
 194 char *util_strrnl        (const char *);
 195 char *util_strsws        (const char *);
 196 char *util_strchp        (const char *, const char *);
 197 void  util_debug         (const char *, const char *, ...);
 198 int   util_getline       (char **, size_t *, FILE *);
 199 void  util_endianswap    (void *,  int, int);
 200
 201 size_t util_strtocmd    (const char *, char *, size_t);
 202 size_t util_strtononcmd (const char *, char *, size_t);
 203
 204 uint32_t util_crc32(const char *, int, register const short);
 205
 206 #ifdef NOTRACK
 207 #    define mem_a(x) malloc(x)
 208 #    define mem_d(x) free  (x)
 209 #else
 210 #    define mem_a(x) util_memory_a((x), __LINE__, __FILE__)
 211 #    define mem_d(x) util_memory_d((x), __LINE__, __FILE__)
 212 #endif
 213
 214 /*
 215  * TODO: make these safer to use.  Currently this only works on
 216  * x86 and x86_64, some systems will likely not like this. Such
 217  * as BE systems.
 218  */
 219 #define FLT2INT(Y) *((int32_t*)&(Y))
 220 #define INT2FLT(Y) *((float  *)&(Y))
 221
 222 /* Builds vector type (usefull for inside structures) */
 223 #define VECTOR_SNAP(X,Y) X ## Y
 224 #define VECTOR_FILL(X,Y) VECTOR_SNAP(X,Y)
 225 #define VECTOR_TYPE(T,N)                                        \
 226     T*     N##_data      = NULL;                                \
 227     long   N##_elements  = 0;                                   \
 228     long   N##_allocated = 0
 229 /* Builds vector add */
 230 #define VECTOR_CORE(T,N)                                        \
 231     int    N##_add(T element) {                                 \
 232         void *temp = NULL;                                      \
 233         if (N##_elements == N##_allocated) {                    \
 234             if (N##_allocated == 0) {                           \
 235                 N##_allocated = 12;                             \
 236             } else {                                            \
 237                 N##_allocated *= 2;                             \
 238             }                                                   \
 239             if  (!(temp = mem_a(N##_allocated * sizeof(T)))) {  \
 240                 mem_d(temp);                                    \
 241                 return -1;                                      \
 242             }                                                   \
 243             memcpy(temp, N##_data, (N##_elements * sizeof(T))); \
 244             mem_d(N##_data);                                    \
 245             N##_data = (T*)temp;                                \
 246         }                                                       \
 247         N##_data[N##_elements] = element;                       \
 248         return   N##_elements++;                                \
 249     }                                                           \
 250     int N##_put(T* elements, size_t len) {                      \
 251         len     --;                                             \
 252         elements--;                                             \
 253         while (N##_add(*++elements) != -1 && len--);            \
 254         return N##_elements;                                    \
 255     }                                                           \
 256     typedef char VECTOR_FILL(extra_semicolon_##N,__COUNTER__)
 257 #define VECTOR_PROT(T,N)                                        \
 258     extern T*     N##_data     ;                                \
 259     extern long   N##_elements ;                                \
 260     extern long   N##_allocated;                                \
 261     int           N##_add(T);                                   \
 262     int           N##_put(T *, size_t)
 263 #define VECTOR_MAKE(T,N) \
 264     VECTOR_TYPE(T,N);    \
 265     VECTOR_CORE(T,N)
 266
 267 /*===================================================================*/
 268 /*=========================== code.c ================================*/
 269 /*===================================================================*/
 270
 271 /* Note: if you change the order, fix type_sizeof in ir.c */
 272 enum {
 273     TYPE_VOID     ,
 274     TYPE_STRING   ,
 275     TYPE_FLOAT    ,
 276     TYPE_VECTOR   ,
 277     TYPE_ENTITY   ,
 278     TYPE_FIELD    ,
 279     TYPE_FUNCTION ,
 280     TYPE_POINTER  ,
 281     TYPE_INTEGER  ,
 282     TYPE_QUATERNION  ,
 283     TYPE_MATRIX  ,
 284     TYPE_VARIANT  ,
 285
 286     TYPE_COUNT
 287 };
 288
 289 extern const char *type_name[TYPE_COUNT];
 290
 291 extern size_t type_sizeof[TYPE_COUNT];
 292 extern uint16_t type_store_instr[TYPE_COUNT];
 293 /* could use type_store_instr + INSTR_STOREP_F - INSTR_STORE_F
 294  * but this breaks when TYPE_INTEGER is added, since with the enhanced
 295  * instruction set, the old ones are left untouched, thus the _I instructions
 296  * are at a seperate place.
 297  */
 298 extern uint16_t type_storep_instr[TYPE_COUNT];
 299
 300 typedef struct {
 301     uint32_t offset;      /* Offset in file of where data begins  */
 302     uint32_t length;      /* Length of section (how many of)      */
 303 } prog_section;
 304
 305 typedef struct {
 306     uint32_t     version;      /* Program version (6)     */
 307     uint16_t     crc16;        /* What is this?           */
 308     uint16_t     skip;         /* see propsal.txt         */
 309
 310     prog_section statements;   /* prog_section_statement  */
 311     prog_section defs;         /* prog_section_def        */
 312     prog_section fields;       /* prog_section_field      */
 313     prog_section functions;    /* prog_section_function   */
 314     prog_section strings;      /* What is this?           */
 315     prog_section globals;      /* What is this?           */
 316     uint32_t     entfield;     /* Number of entity fields */
 317 } prog_header;
 318
 319 /*
 320  * Each paramater incerements by 3 since vector types hold
 321  * 3 components (x,y,z).
 322  */
 323 #define OFS_NULL      0
 324 #define OFS_RETURN    1
 325 #define OFS_PARM0     (OFS_RETURN+3)
 326 #define OFS_PARM1     (OFS_PARM0 +3)
 327 #define OFS_PARM2     (OFS_PARM1 +3)
 328 #define OFS_PARM3     (OFS_PARM2 +3)
 329 #define OFS_PARM4     (OFS_PARM3 +3)
 330 #define OFS_PARM5     (OFS_PARM4 +3)
 331 #define OFS_PARM6     (OFS_PARM5 +3)
 332 #define OFS_PARM7     (OFS_PARM6 +3)
 333
 334 typedef struct {
 335     uint16_t opcode;
 336
 337     /* operand 1 */
 338     union {
 339         int16_t  s1; /* signed   */
 340         uint16_t u1; /* unsigned */
 341     } o1;
 342     /* operand 2 */
 343     union {
 344         int16_t  s1; /* signed   */
 345         uint16_t u1; /* unsigned */
 346     } o2;
 347     /* operand 3 */
 348     union {
 349         int16_t  s1; /* signed   */
 350         uint16_t u1; /* unsigned */
 351     } o3;
 352
 353     /*
 354      * This is the same as the structure in darkplaces
 355      * {
 356      *     unsigned short op;
 357      *     short          a,b,c;
 358      * }
 359      * But this one is more sane to work with, and the
 360      * type sizes are guranteed.
 361      */
 362 } prog_section_statement;
 363
 364 typedef struct {
 365     /* The types:
 366      * 0 = ev_void
 367      * 1 = ev_string
 368      * 2 = ev_float
 369      * 3 = ev_vector
 370      * 4 = ev_entity
 371      * 5 = ev_field
 372      * 6 = ev_function
 373      * 7 = ev_pointer -- engine only
 374      * 8 = ev_bad     -- engine only
 375      */
 376     uint16_t type;
 377     uint16_t offset;
 378     uint32_t name;
 379 } prog_section_both;
 380 typedef prog_section_both prog_section_def;
 381 typedef prog_section_both prog_section_field;
 382
 383 typedef struct {
 384     int32_t   entry;      /* in statement table for instructions  */
 385     uint32_t  firstlocal; /* First local in local table           */
 386     uint32_t  locals;     /* Total ints of params + locals        */
 387     uint32_t  profile;    /* Always zero (engine uses this)       */
 388     uint32_t  name;       /* name of function in string table     */
 389     uint32_t  file;       /* file of the source file              */
 390     uint32_t  nargs;      /* number of arguments                  */
 391     uint8_t   argsize[8]; /* size of arguments (keep 8 always?)   */
 392 } prog_section_function;
 393
 394 /*
 395  * Instructions
 396  * These are the external instructions supported by the interperter
 397  * this is what things compile to (from the C code).
 398  */
 399 enum {
 400     INSTR_DONE,
 401     INSTR_MUL_F,
 402     INSTR_MUL_V,
 403     INSTR_MUL_VF,
 404     INSTR_MUL_FV,
 405     INSTR_DIV_F,
 406     INSTR_ADD_F,
 407     INSTR_ADD_V,
 408     INSTR_SUB_F,
 409     INSTR_SUB_V,
 410     INSTR_EQ_F,
 411     INSTR_EQ_V,
 412     INSTR_EQ_S,
 413     INSTR_EQ_E,
 414     INSTR_EQ_FNC,
 415     INSTR_NE_F,
 416     INSTR_NE_V,
 417     INSTR_NE_S,
 418     INSTR_NE_E,
 419     INSTR_NE_FNC,
 420     INSTR_LE,
 421     INSTR_GE,
 422     INSTR_LT,
 423     INSTR_GT,
 424     INSTR_LOAD_F,
 425     INSTR_LOAD_V,
 426     INSTR_LOAD_S,
 427     INSTR_LOAD_ENT,
 428     INSTR_LOAD_FLD,
 429     INSTR_LOAD_FNC,
 430     INSTR_ADDRESS,
 431     INSTR_STORE_F,
 432     INSTR_STORE_V,
 433     INSTR_STORE_S,
 434     INSTR_STORE_ENT,
 435     INSTR_STORE_FLD,
 436     INSTR_STORE_FNC,
 437     INSTR_STOREP_F,
 438     INSTR_STOREP_V,
 439     INSTR_STOREP_S,
 440     INSTR_STOREP_ENT,
 441     INSTR_STOREP_FLD,
 442     INSTR_STOREP_FNC,
 443     INSTR_RETURN,
 444     INSTR_NOT_F,
 445     INSTR_NOT_V,
 446     INSTR_NOT_S,
 447     INSTR_NOT_ENT,
 448     INSTR_NOT_FNC,
 449     INSTR_IF,
 450     INSTR_IFNOT,
 451     INSTR_CALL0,
 452     INSTR_CALL1,
 453     INSTR_CALL2,
 454     INSTR_CALL3,
 455     INSTR_CALL4,
 456     INSTR_CALL5,
 457     INSTR_CALL6,
 458     INSTR_CALL7,
 459     INSTR_CALL8,
 460     INSTR_STATE,
 461     INSTR_GOTO,
 462     INSTR_AND,
 463     INSTR_OR,
 464     INSTR_BITAND,
 465     INSTR_BITOR,
 466
 467 /* warning: will be reordered */
 468     INSTR_MUL_Q,
 469     INSTR_MUL_QF,
 470     INSTR_MUL_M,
 471     INSTR_MUL_MF,
 472     INSTR_EQ_Q,
 473     INSTR_EQ_M,
 474     INSTR_NE_Q,
 475     INSTR_NE_M,
 476     INSTR_LOAD_Q,
 477     INSTR_LOAD_M,
 478     INSTR_STORE_Q,
 479     INSTR_STORE_M,
 480     INSTR_STOREP_Q,
 481     INSTR_STOREP_M,
 482     INSTR_INV_Q,
 483     INSTR_INV_M,
 484     /*
 485      * Virtual instructions used by the assembler
 486      * keep at the end but before virtual instructions
 487      * for the IR below.
 488      */
 489     AINSTR_END,
 490
 491     /*
 492      * Virtual instructions used by the IR
 493      * Keep at the end!
 494      */
 495     VINSTR_PHI,
 496     VINSTR_JUMP,
 497     VINSTR_COND
 498 };
 499
 500 /*
 501  * The symbols below are created by the following
 502  * expanded macros:
 503  *
 504  * VECTOR_MAKE(prog_section_statement, code_statements);
 505  * VECTOR_MAKE(prog_section_def,       code_defs      );
 506  * VECTOR_MAKE(prog_section_field,     code_fields    );
 507  * VECTOR_MAKE(prog_section_function,  code_functions );
 508  * VECTOR_MAKE(int,                    code_globals   );
 509  * VECTOR_MAKE(char,                   code_chars     );
 510  */
 511 VECTOR_PROT(prog_section_statement, code_statements);
 512 VECTOR_PROT(prog_section_statement, code_statements);
 513 VECTOR_PROT(prog_section_def,       code_defs      );
 514 VECTOR_PROT(prog_section_field,     code_fields    );
 515 VECTOR_PROT(prog_section_function,  code_functions );
 516 VECTOR_PROT(int,                    code_globals   );
 517 VECTOR_PROT(char,                   code_chars     );
 518
 519 typedef float   qcfloat;
 520 typedef int32_t qcint;
 521
 522 /*
 523  * code_write -- writes out the compiled file
 524  * code_init  -- prepares the code file
 525  */
 526 bool     code_write       (const char *filename);
 527 void     code_init        ();
 528 uint32_t code_genstring   (const char *string);
 529 uint32_t code_cachedstring(const char *string);
 530 qcint    code_alloc_field (size_t qcsize);
 531
 532 /*===================================================================*/
 533 /*========================= assembler.c =============================*/
 534 /*===================================================================*/
 535 static const struct {
 536     const char  *m; /* menomic     */
 537     const size_t o; /* operands    */
 538     const size_t l; /* menomic len */
 539 } asm_instr[] = {
 540     { "DONE"      , 1, 4 },
 541     { "MUL_F"     , 3, 5 },
 542     { "MUL_V"     , 3, 5 },
 543     { "MUL_VF"    , 3, 6 },
 544     { "MUL_FV"    , 3, 6 },
 545     { "DIV"       , 0, 3 },
 546     { "ADD_F"     , 3, 5 },
 547     { "ADD_V"     , 3, 5 },
 548     { "SUB_F"     , 3, 5 },
 549     { "DUB_V"     , 3, 5 },
 550     { "EQ_F"      , 0, 4 },
 551     { "EQ_V"      , 0, 4 },
 552     { "EQ_S"      , 0, 4 },
 553     { "EQ_E"      , 0, 4 },
 554     { "EQ_FNC"    , 0, 6 },
 555     { "NE_F"      , 0, 4 },
 556     { "NE_V"      , 0, 4 },
 557     { "NE_S"      , 0, 4 },
 558     { "NE_E"      , 0, 4 },
 559     { "NE_FNC"    , 0, 6 },
 560     { "LE"        , 0, 2 },
 561     { "GE"        , 0, 2 },
 562     { "LT"        , 0, 2 },
 563     { "GT"        , 0, 2 },
 564     { "FIELD_F"   , 0, 7 },
 565     { "FIELD_V"   , 0, 7 },
 566     { "FIELD_S"   , 0, 7 },
 567     { "FIELD_ENT" , 0, 9 },
 568     { "FIELD_FLD" , 0, 9 },
 569     { "FIELD_FNC" , 0, 9 },
 570     { "ADDRESS"   , 0, 7 },
 571     { "STORE_F"   , 0, 7 },
 572     { "STORE_V"   , 0, 7 },
 573     { "STORE_S"   , 0, 7 },
 574     { "STORE_ENT" , 0, 9 },
 575     { "STORE_FLD" , 0, 9 },
 576     { "STORE_FNC" , 0, 9 },
 577     { "STOREP_F"  , 0, 8 },
 578     { "STOREP_V"  , 0, 8 },
 579     { "STOREP_S"  , 0, 8 },
 580     { "STOREP_ENT", 0, 10},
 581     { "STOREP_FLD", 0, 10},
 582     { "STOREP_FNC", 0, 10},
 583     { "RETURN"    , 0, 6 },
 584     { "NOT_F"     , 0, 5 },
 585     { "NOT_V"     , 0, 5 },
 586     { "NOT_S"     , 0, 5 },
 587     { "NOT_ENT"   , 0, 7 },
 588     { "NOT_FNC"   , 0, 7 },
 589     { "IF"        , 0, 2 },
 590     { "IFNOT"     , 0, 5 },
 591     { "CALL0"     , 1, 5 },
 592     { "CALL1"     , 2, 5 },
 593     { "CALL2"     , 3, 5 },
 594     { "CALL3"     , 4, 5 },
 595     { "CALL4"     , 5, 5 },
 596     { "CALL5"     , 6, 5 },
 597     { "CALL6"     , 7, 5 },
 598     { "CALL7"     , 8, 5 },
 599     { "CALL8"     , 9, 5 },
 600     { "STATE"     , 0, 5 },
 601     { "GOTO"      , 0, 4 },
 602     { "AND"       , 0, 3 },
 603     { "OR"        , 0, 2 },
 604     { "BITAND"    , 0, 6 },
 605     { "BITOR"     , 0, 5 },
 606
 607     { "MUL_Q"     , 3, 5 },
 608     { "MUL_QF"    , 3, 6 },
 609     { "MUL_M"     , 3, 5 },
 610     { "MUL_MF"    , 3, 6 },
 611     { "EQ_Q"      , 0, 4 },
 612     { "EQ_M"      , 0, 4 },
 613     { "NE_Q"      , 0, 4 },
 614     { "NE_M"      , 0, 4 },
 615     { "FIELD_Q"   , 0, 7 },
 616     { "FIELD_M"   , 0, 7 },
 617     { "STORE_Q"   , 0, 7 },
 618     { "STORE_M"   , 0, 7 },
 619     { "STOREP_Q"  , 0, 8 },
 620     { "STOREP_M"  , 0, 8 },
 621     { "INV_Q"     , 0, 5 },
 622     { "INV_M"     , 0, 5 },
 623
 624     { "END"       , 0, 3 } /* virtual assembler instruction */
 625 };
 626
 627 void asm_init (const char *, FILE **);
 628 void asm_close(FILE *);
 629 void asm_parse(FILE *);
 630 /*===================================================================*/
 631 /*============================= ast.c ===============================*/
 632 /*===================================================================*/
 633 #define MEM_VECTOR_PROTO(Towner, Tmem, mem)                   \
 634     bool GMQCC_WARN Towner##_##mem##_add(Towner*, Tmem);      \
 635     bool GMQCC_WARN Towner##_##mem##_remove(Towner*, size_t)
 636
 637 #define MEM_VECTOR_PROTO_ALL(Towner, Tmem, mem)                    \
 638     MEM_VECTOR_PROTO(Towner, Tmem, mem);                           \
 639     bool GMQCC_WARN Towner##_##mem##_find(Towner*, Tmem, size_t*); \
 640     void Towner##_##mem##_clear(Towner*)
 641
 642 #define MEM_VECTOR_MAKE(Twhat, name) \
 643     Twhat  *name;                    \
 644     size_t name##_count;             \
 645     size_t name##_alloc
 646
 647 #define MEM_VEC_FUN_ADD(Tself, Twhat, mem)                           \
 648 bool GMQCC_WARN Tself##_##mem##_add(Tself *self, Twhat f)            \
 649 {                                                                    \
 650     Twhat *reall;                                                    \
 651     if (self->mem##_count == self->mem##_alloc) {                    \
 652         if (!self->mem##_alloc) {                                    \
 653             self->mem##_alloc = 16;                                  \
 654         } else {                                                     \
 655             self->mem##_alloc *= 2;                                  \
 656         }                                                            \
 657         reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_alloc);    \
 658         if (!reall) {                                                \
 659             return false;                                            \
 660         }                                                            \
 661         memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
 662         mem_d(self->mem);                                            \
 663         self->mem = reall;                                           \
 664     }                                                                \
 665     self->mem[self->mem##_count++] = f;                              \
 666     return true;                                                     \
 667 }
 668
 669 #define MEM_VEC_FUN_REMOVE(Tself, Twhat, mem)                        \
 670 bool GMQCC_WARN Tself##_##mem##_remove(Tself *self, size_t idx)      \
 671 {                                                                    \
 672     size_t i;                                                        \
 673     Twhat *reall;                                                    \
 674     if (idx >= self->mem##_count) {                                  \
 675         return true; /* huh... */                                    \
 676     }                                                                \
 677     for (i = idx; i < self->mem##_count-1; ++i) {                    \
 678         self->mem[i] = self->mem[i+1];                               \
 679     }                                                                \
 680     self->mem##_count--;                                             \
 681     if (self->mem##_count < self->mem##_count/2) {                   \
 682         self->mem##_alloc /= 2;                                      \
 683         reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_count);    \
 684         if (!reall) {                                                \
 685             return false;                                            \
 686         }                                                            \
 687         memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
 688         mem_d(self->mem);                                            \
 689         self->mem = reall;                                           \
 690     }                                                                \
 691     return true;                                                     \
 692 }
 693
 694 #define MEM_VEC_FUN_FIND(Tself, Twhat, mem)                     \
 695 bool GMQCC_WARN Tself##_##mem##_find(Tself *self, Twhat obj, size_t *idx) \
 696 {                                                               \
 697     size_t i;                                                   \
 698     for (i = 0; i < self->mem##_count; ++i) {                   \
 699         if (self->mem[i] == obj) {                              \
 700             if (idx) {                                          \
 701                 *idx = i;                                       \
 702             }                                                   \
 703             return true;                                        \
 704         }                                                       \
 705     }                                                           \
 706     return false;                                               \
 707 }
 708
 709 #define MEM_VEC_FUN_APPEND(Tself, Twhat, mem)                        \
 710 bool GMQCC_WARN Tself##_##mem##_append(Tself *s, Twhat *p, size_t c) \
 711 {                                                                    \
 712     Twhat *reall;                                                    \
 713     if (s->mem##_count+c >= s->mem##_alloc) {                        \
 714         if (!s->mem##_alloc) {                                       \
 715             s->mem##_alloc = c < 16 ? 16 : c;                        \
 716         } else {                                                     \
 717             s->mem##_alloc *= 2;                                     \
 718             if (s->mem##_count+c >= s->mem##_alloc) {                \
 719                 s->mem##_alloc = s->mem##_count+c;                   \
 720             }                                                        \
 721         }                                                            \
 722         reall = (Twhat*)mem_a(sizeof(Twhat) * s->mem##_alloc);       \
 723         if (!reall) {                                                \
 724             return false;                                            \
 725         }                                                            \
 726         memcpy(reall, s->mem, sizeof(Twhat) * s->mem##_count);       \
 727         mem_d(s->mem);                                               \
 728         s->mem = reall;                                              \
 729     }                                                                \
 730     memcpy(&s->mem[s->mem##_count], p, c*sizeof(*p));                \
 731     s->mem##_count += c;                                             \
 732     return true;                                                     \
 733 }
 734
 735 #define MEM_VEC_FUN_RESIZE(Tself, Twhat, mem)                    \
 736 bool GMQCC_WARN Tself##_##mem##_resize(Tself *s, size_t c)       \
 737 {                                                                \
 738     Twhat *reall;                                                \
 739     if (c > s->mem##_alloc) {                                    \
 740         reall = (Twhat*)mem_a(sizeof(Twhat) * c);                \
 741         if (!reall) { return false; }                            \
 742         memcpy(reall, s->mem, sizeof(Twhat) * s->mem##_count);   \
 743         s->mem##_alloc = c;                                      \
 744         mem_d(s->mem);                                           \
 745         s->mem = reall;                                          \
 746         return true;                                             \
 747     }                                                            \
 748     s->mem##_count = c;                                          \
 749     if (c < (s->mem##_alloc / 2)) {                              \
 750         reall = (Twhat*)mem_a(sizeof(Twhat) * c);                \
 751         if (!reall) { return false; }                            \
 752         memcpy(reall, s->mem, sizeof(Twhat) * c);                \
 753         mem_d(s->mem);                                           \
 754         s->mem = reall;                                          \
 755     }                                                            \
 756     return true;                                                 \
 757 }
 758
 759 #define MEM_VEC_FUN_CLEAR(Tself, mem)   \
 760 void Tself##_##mem##_clear(Tself *self) \
 761 {                                       \
 762     if (!self->mem)                     \
 763         return;                         \
 764     mem_d((void*) self->mem);           \
 765     self->mem = NULL;                   \
 766     self->mem##_count = 0;              \
 767     self->mem##_alloc = 0;              \
 768 }
 769
 770 #define MEM_VECTOR_CLEAR(owner, mem)  \
 771     if ((owner)->mem)                 \
 772         mem_d((void*)((owner)->mem)); \
 773     (owner)->mem = NULL;              \
 774     (owner)->mem##_count = 0;         \
 775     (owner)->mem##_alloc = 0
 776
 777 #define MEM_VECTOR_INIT(owner, mem) \
 778 {                                   \
 779     (owner)->mem = NULL;            \
 780     (owner)->mem##_count = 0;       \
 781     (owner)->mem##_alloc = 0;       \
 782 }
 783
 784 #define MEM_VECTOR_MOVE(from, mem, to, tm)   \
 785 {                                            \
 786     (to)->tm = (from)->mem;                  \
 787     (to)->tm##_count = (from)->mem##_count;  \
 788     (to)->tm##_alloc = (from)->mem##_alloc;  \
 789     (from)->mem = NULL;                      \
 790     (from)->mem##_count = 0;                 \
 791     (from)->mem##_alloc = 0;                 \
 792 }
 793
 794 #define MEM_VEC_FUNCTIONS(Tself, Twhat, mem) \
 795 MEM_VEC_FUN_REMOVE(Tself, Twhat, mem)        \
 796 MEM_VEC_FUN_ADD(Tself, Twhat, mem)
 797
 798 #define MEM_VEC_FUNCTIONS_ALL(Tself, Twhat, mem) \
 799 MEM_VEC_FUNCTIONS(Tself, Twhat, mem)             \
 800 MEM_VEC_FUN_CLEAR(Tself, mem)                    \
 801 MEM_VEC_FUN_FIND(Tself, Twhat, mem)
 802
 803 enum store_types {
 804     store_global,
 805     store_local,  /* local, assignable for now, should get promoted later */
 806     store_param,  /* parameters, they are locals with a fixed position */
 807     store_value,  /* unassignable */
 808     store_return  /* unassignable, at OFS_RETURN */
 809 };
 810
 811 typedef struct {
 812     float x, y, z;
 813 } vector;
 814
 815 typedef float matrix[4][4]; /* OpenGL layout */
 816 typedef float quaternion[4]; /* order: x, y, z, w */
 817 #define MATRIX(axis, elem) ((4*(axis)) + (elem))
 818 #define QUAT_X 0
 819 #define QUAT_Y 1
 820 #define QUAT_Z 2
 821 #define QUAT_W 3
 822
 823 /*
 824  * A shallow copy of a lex_file to remember where which ast node
 825  * came from.
 826  */
 827 typedef struct {
 828     const char *file;
 829     size_t      line;
 830 } lex_ctx;
 831
 832 /*===================================================================*/
 833 /*============================= exec.c ==============================*/
 834 /*===================================================================*/
 835
 836 /* darkplaces has (or will have) a 64 bit prog loader
 837  * where the 32 bit qc program is autoconverted on load.
 838  * Since we may want to support that as well, let's redefine
 839  * float and int here.
 840  */
 841 typedef union {
 842     qcint   _int;
 843     qcint    string;
 844     qcint    function;
 845     qcint    edict;
 846     qcfloat _float;
 847     qcfloat vector[3];
 848     qcint   ivector[3];
 849 } qcany;
 850
 851 typedef char qcfloat_size_is_correct [sizeof(qcfloat) == 4 ?1:-1];
 852 typedef char qcint_size_is_correct   [sizeof(qcint)   == 4 ?1:-1];
 853
 854 enum {
 855     VMERR_OK,
 856     VMERR_TEMPSTRING_ALLOC,
 857
 858     VMERR_END
 859 };
 860
 861 #define VM_JUMPS_DEFAULT 1000000
 862
 863 /* execute-flags */
 864 #define VMXF_DEFAULT 0x0000     /* default flags - nothing */
 865 #define VMXF_TRACE   0x0001     /* trace: print statements before executing */
 866 #define VMXF_PROFILE 0x0002     /* profile: increment the profile counters */
 867
 868 struct qc_program_s;
 869
 870 typedef int (*prog_builtin)(struct qc_program_s *prog);
 871
 872 typedef struct {
 873     qcint                  stmt;
 874     size_t                 localsp;
 875     prog_section_function *function;
 876 } qc_exec_stack;
 877
 878 typedef struct qc_program_s {
 879     char           *filename;
 880
 881     MEM_VECTOR_MAKE(prog_section_statement, code);
 882     MEM_VECTOR_MAKE(prog_section_def,       defs);
 883     MEM_VECTOR_MAKE(prog_section_def,       fields);
 884     MEM_VECTOR_MAKE(prog_section_function,  functions);
 885     MEM_VECTOR_MAKE(char,                   strings);
 886     MEM_VECTOR_MAKE(qcint,                  globals);
 887     MEM_VECTOR_MAKE(qcint,                  entitydata);
 888
 889     size_t tempstring_start;
 890     size_t tempstring_at;
 891
 892     qcint  vmerror;
 893
 894     MEM_VECTOR_MAKE(size_t, profile);
 895
 896     MEM_VECTOR_MAKE(prog_builtin, builtins);
 897
 898     /* size_t ip; */
 899     qcint  entities;
 900     size_t entityfields;
 901     bool   allowworldwrites;
 902
 903     MEM_VECTOR_MAKE(qcint,         localstack);
 904     MEM_VECTOR_MAKE(qc_exec_stack, stack);
 905     size_t statement;
 906
 907     int    argc; /* current arg count for debugging */
 908 } qc_program;
 909
 910 qc_program* prog_load(const char *filename);
 911 void        prog_delete(qc_program *prog);
 912
 913 bool prog_exec(qc_program *prog, prog_section_function *func, size_t flags, long maxjumps);
 914
 915 char*             prog_getstring (qc_program *prog, qcint str);
 916 prog_section_def* prog_entfield  (qc_program *prog, qcint off);
 917 prog_section_def* prog_getdef    (qc_program *prog, qcint off);
 918 qcany*            prog_getedict  (qc_program *prog, qcint e);
 919 qcint             prog_tempstring(qc_program *prog, const char *_str);
 920
 921 /*===================================================================*/
 922 /*======================= main.c commandline ========================*/
 923 /*===================================================================*/
 924
 925 #if 0
 926 /* Helpers to allow for a whole lot of flags. Otherwise we'd limit
 927  * to 32 or 64 -f options...
 928  */
 929 typedef struct {
 930     size_t  idx; /* index into an array of 32 bit words */
 931     uint8_t bit; /* index _into_ the 32 bit word, thus just uint8 */
 932 } longbit;
 933 #define LONGBIT(bit) { ((bit)/32), ((bit)%32) }
 934 #else
 935 typedef uint32_t longbit;
 936 #define LONGBIT(bit) (bit)
 937 #endif
 938
 939 /* Used to store the list of flags with names */
 940 typedef struct {
 941     const char *name;
 942     longbit    bit;
 943 } opts_flag_def;
 944
 945 /*===================================================================*/
 946 /* list of -f flags, like -fdarkplaces-string-table-bug */
 947 enum {
 948 # define GMQCC_DEFINE_FLAG(X) X,
 949 #  include "flags.def"
 950 # undef GMQCC_DEFINE_FLAG
 951     COUNT_FLAGS
 952 };
 953 static const opts_flag_def opts_flag_list[] = {
 954 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(X) },
 955 #  include "flags.def"
 956 # undef GMQCC_DEFINE_FLAG
 957     { NULL, LONGBIT(0) }
 958 };
 959
 960 enum {
 961 # define GMQCC_DEFINE_FLAG(X) WARN_##X,
 962 #  include "warns.def"
 963 # undef GMQCC_DEFINE_FLAG
 964     COUNT_WARNINGS
 965 };
 966 static const opts_flag_def opts_warn_list[] = {
 967 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(WARN_##X) },
 968 #  include "warns.def"
 969 # undef GMQCC_DEFINE_FLAG
 970     { NULL, LONGBIT(0) }
 971 };
 972
 973 /* other options: */
 974 enum {
 975     COMPILER_QCC,     /* circa  QuakeC */
 976     COMPILER_FTEQCC,  /* fteqcc QuakeC */
 977     COMPILER_QCCX,    /* qccx   QuakeC */
 978     COMPILER_GMQCC    /* this   QuakeC */
 979 };
 980 extern uint32_t    opts_O;      /* -Ox */
 981 extern const char *opts_output; /* -o file */
 982 extern int         opts_standard;
 983 extern bool        opts_debug;
 984 extern bool        opts_memchk;
 985
 986 /*===================================================================*/
 987 #define OPTS_FLAG(i) (!! (opts_flags[(i)/32] & (1<< ((i)%32))))
 988 extern uint32_t opts_flags[1 + (COUNT_FLAGS / 32)];
 989 #define OPTS_WARN(i) (!! (opts_warn[(i)/32] & (1<< ((i)%32))))
 990 extern uint32_t opts_warn[1 + (COUNT_WARNINGS / 32)];
 991
 992 #endif