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 /*============================ lex.c ================================*/
 184 /*===================================================================*/
 185 typedef struct lex_file_t {
 186     FILE *file;        /* file handler */
 187     char *name;        /* name of file */
 188     char  peek  [5];
 189     char  lastok[8192];
 190
 191     int   last;    /* last token                   */
 192     int   current; /* current token                */
 193     int   length;  /* bytes left to parse          */
 194     int   size;    /* never changes (size of file) */
 195     int   line;    /* what line are we on?         */
 196 } lex_file;
 197
 198 /*
 199  * It's important that this table never exceed 32 keywords, the ascii
 200  * table starts at 33 (and we don't want conflicts)
 201  */
 202 enum {
 203     TOKEN_DO       ,
 204     TOKEN_ELSE     ,
 205     TOKEN_IF       ,
 206     TOKEN_WHILE    ,
 207     TOKEN_BREAK    ,
 208     TOKEN_CONTINUE ,
 209     TOKEN_RETURN   ,
 210     TOKEN_GOTO     ,
 211     TOKEN_FOR      ,   /* extension */
 212     TOKEN_TYPEDEF  ,   /* extension */
 213
 214     /* ensure the token types are out of the  */
 215     /* bounds of anyothers that may conflict. */
 216     TOKEN_FLOAT    = 110,
 217     TOKEN_VECTOR        ,
 218     TOKEN_STRING        ,
 219     TOKEN_ENTITY        ,
 220     TOKEN_VOID
 221 };
 222
 223 /*
 224  * Lexer state constants, these are numbers for where exactly in
 225  * the lexing the lexer is at. Or where it decided to stop if a lexer
 226  * error occurs.  These numbers must be > where the ascii-table ends
 227  * and > the last type token which is TOKEN_VOID
 228  */
 229 enum {
 230     LEX_COMMENT = 1128,
 231     LEX_CHRLIT        ,
 232     LEX_STRLIT        ,
 233     LEX_IDENT
 234 };
 235
 236 int       lex_token  (lex_file *);
 237 void      lex_reset  (lex_file *);
 238 void      lex_close  (lex_file *);
 239 void      lex_parse  (lex_file *);
 240 lex_file *lex_include(lex_file *, const char *);
 241 void      lex_init   (const char *, lex_file **);
 242
 243 /*===================================================================*/
 244 /*========================== error.c ================================*/
 245 /*===================================================================*/
 246 #define ERROR_LEX      (SHRT_MAX+0)
 247 #define ERROR_PARSE    (SHRT_MAX+1)
 248 #define ERROR_INTERNAL (SHRT_MAX+2)
 249 #define ERROR_COMPILER (SHRT_MAX+3)
 250 #define ERROR_PREPRO   (SHRT_MAX+4)
 251 int error(lex_file *, int, const char *, ...);
 252
 253 /*===================================================================*/
 254 /*========================== parse.c ================================*/
 255 /*===================================================================*/
 256 int parse_gen(lex_file *);
 257
 258 /*===================================================================*/
 259 /*========================== typedef.c ==============================*/
 260 /*===================================================================*/
 261 typedef struct typedef_node_t {
 262     char      *name;
 263 } typedef_node;
 264
 265 void          typedef_init();
 266 void          typedef_clear();
 267 typedef_node *typedef_find(const char *);
 268 int           typedef_add (lex_file *file, const char *, const char *);
 269
 270
 271 /*===================================================================*/
 272 /*=========================== util.c ================================*/
 273 /*===================================================================*/
 274 void *util_memory_a      (unsigned int, unsigned int, const char *);
 275 void  util_memory_d      (void       *, unsigned int, const char *);
 276 void  util_meminfo       ();
 277
 278 bool  util_strupper      (const char *);
 279 bool  util_strdigit      (const char *);
 280 bool  util_strncmpexact  (const char *, const char *, size_t);
 281 char *util_strdup        (const char *);
 282 char *util_strrq         (const char *);
 283 char *util_strrnl        (const char *);
 284 char *util_strsws        (const char *);
 285 char *util_strchp        (const char *, const char *);
 286 void  util_debug         (const char *, const char *, ...);
 287 int   util_getline       (char **, size_t *, FILE *);
 288 void  util_endianswap    (void *,  int, int);
 289
 290 size_t util_strtocmd    (const char *, char *, size_t);
 291 size_t util_strtononcmd (const char *, char *, size_t);
 292
 293 uint32_t util_crc32(const char *, int, register const short);
 294
 295 #ifdef NOTRACK
 296 #    define mem_a(x) malloc(x)
 297 #    define mem_d(x) free  (x)
 298 #else
 299 #    define mem_a(x) util_memory_a((x), __LINE__, __FILE__)
 300 #    define mem_d(x) util_memory_d((x), __LINE__, __FILE__)
 301 #endif
 302
 303 /*
 304  * TODO: make these safer to use.  Currently this only works on
 305  * x86 and x86_64, some systems will likely not like this. Such
 306  * as BE systems.
 307  */
 308 #define FLT2INT(Y) *((int32_t*)&(Y))
 309 #define INT2FLT(Y) *((float  *)&(Y))
 310
 311 /* Builds vector type (usefull for inside structures) */
 312 #define VECTOR_SNAP(X,Y) X ## Y
 313 #define VECTOR_FILL(X,Y) VECTOR_SNAP(X,Y)
 314 #define VECTOR_TYPE(T,N)                                        \
 315     T*     N##_data      = NULL;                                \
 316     long   N##_elements  = 0;                                   \
 317     long   N##_allocated = 0
 318 /* Builds vector add */
 319 #define VECTOR_CORE(T,N)                                        \
 320     int    N##_add(T element) {                                 \
 321         void *temp = NULL;                                      \
 322         if (N##_elements == N##_allocated) {                    \
 323             if (N##_allocated == 0) {                           \
 324                 N##_allocated = 12;                             \
 325             } else {                                            \
 326                 N##_allocated *= 2;                             \
 327             }                                                   \
 328             if  (!(temp = mem_a(N##_allocated * sizeof(T)))) {  \
 329                 mem_d(temp);                                    \
 330                 return -1;                                      \
 331             }                                                   \
 332             memcpy(temp, N##_data, (N##_elements * sizeof(T))); \
 333             mem_d(N##_data);                                    \
 334             N##_data = (T*)temp;                                \
 335         }                                                       \
 336         N##_data[N##_elements] = element;                       \
 337         return   N##_elements++;                                \
 338     }                                                           \
 339     int N##_put(T* elements, size_t len) {                      \
 340         len     --;                                             \
 341         elements--;                                             \
 342         while (N##_add(*++elements) != -1 && len--);            \
 343         return N##_elements;                                    \
 344     }                                                           \
 345     typedef char VECTOR_FILL(extra_semicolon_##N,__COUNTER__)
 346 #define VECTOR_PROT(T,N)                                        \
 347     extern T*     N##_data     ;                                \
 348     extern long   N##_elements ;                                \
 349     extern long   N##_allocated;                                \
 350     int           N##_add(T);                                   \
 351     int           N##_put(T *, size_t)
 352 #define VECTOR_MAKE(T,N) \
 353     VECTOR_TYPE(T,N);    \
 354     VECTOR_CORE(T,N)
 355
 356 /*===================================================================*/
 357 /*=========================== code.c ================================*/
 358 /*===================================================================*/
 359
 360 /* Note: if you change the order, fix type_sizeof in ir.c */
 361 enum {
 362     TYPE_VOID     ,
 363     TYPE_STRING   ,
 364     TYPE_FLOAT    ,
 365     TYPE_VECTOR   ,
 366     TYPE_ENTITY   ,
 367     TYPE_FIELD    ,
 368     TYPE_FUNCTION ,
 369     TYPE_POINTER  ,
 370     /* TYPE_INTEGER  , */
 371     TYPE_VARIANT  ,
 372
 373     TYPE_COUNT
 374 };
 375
 376 extern size_t type_sizeof[TYPE_COUNT];
 377 extern uint16_t type_store_instr[TYPE_COUNT];
 378 /* could use type_store_instr + INSTR_STOREP_F - INSTR_STORE_F
 379  * but this breaks when TYPE_INTEGER is added, since with the enhanced
 380  * instruction set, the old ones are left untouched, thus the _I instructions
 381  * are at a seperate place.
 382  */
 383 extern uint16_t type_storep_instr[TYPE_COUNT];
 384
 385 typedef struct {
 386     uint32_t offset;      /* Offset in file of where data begins  */
 387     uint32_t length;      /* Length of section (how many of)      */
 388 } prog_section;
 389
 390 typedef struct {
 391     uint32_t     version;      /* Program version (6)     */
 392     uint16_t     crc16;        /* What is this?           */
 393     uint16_t     skip;         /* see propsal.txt         */
 394
 395     prog_section statements;   /* prog_section_statement  */
 396     prog_section defs;         /* prog_section_def        */
 397     prog_section fields;       /* prog_section_field      */
 398     prog_section functions;    /* prog_section_function   */
 399     prog_section strings;      /* What is this?           */
 400     prog_section globals;      /* What is this?           */
 401     uint32_t     entfield;     /* Number of entity fields */
 402 } prog_header;
 403
 404 /*
 405  * Each paramater incerements by 3 since vector types hold
 406  * 3 components (x,y,z).
 407  */
 408 #define OFS_NULL      0
 409 #define OFS_RETURN    1
 410 #define OFS_PARM0     (OFS_RETURN+3)
 411 #define OFS_PARM1     (OFS_PARM0 +3)
 412 #define OFS_PARM2     (OFS_PARM1 +3)
 413 #define OFS_PARM3     (OFS_PARM2 +3)
 414 #define OFS_PARM4     (OFS_PARM3 +3)
 415 #define OFS_PARM5     (OFS_PARM4 +3)
 416 #define OFS_PARM6     (OFS_PARM5 +3)
 417 #define OFS_PARM7     (OFS_PARM6 +3)
 418
 419 typedef struct {
 420     uint16_t opcode;
 421
 422     /* operand 1 */
 423     union {
 424         int16_t  s1; /* signed   */
 425         uint16_t u1; /* unsigned */
 426     } o1;
 427     /* operand 2 */
 428     union {
 429         int16_t  s1; /* signed   */
 430         uint16_t u1; /* unsigned */
 431     } o2;
 432     /* operand 3 */
 433     union {
 434         int16_t  s1; /* signed   */
 435         uint16_t u1; /* unsigned */
 436     } o3;
 437
 438     /*
 439      * This is the same as the structure in darkplaces
 440      * {
 441      *     unsigned short op;
 442      *     short          a,b,c;
 443      * }
 444      * But this one is more sane to work with, and the
 445      * type sizes are guranteed.
 446      */
 447 } prog_section_statement;
 448
 449 typedef struct {
 450     /* The types:
 451      * 0 = ev_void
 452      * 1 = ev_string
 453      * 2 = ev_float
 454      * 3 = ev_vector
 455      * 4 = ev_entity
 456      * 5 = ev_field
 457      * 6 = ev_function
 458      * 7 = ev_pointer -- engine only
 459      * 8 = ev_bad     -- engine only
 460      */
 461     uint16_t type;
 462     uint16_t offset;
 463     uint32_t name;
 464 } prog_section_both;
 465 typedef prog_section_both prog_section_def;
 466 typedef prog_section_both prog_section_field;
 467
 468 typedef struct {
 469     int32_t   entry;      /* in statement table for instructions  */
 470     uint32_t  firstlocal; /* First local in local table           */
 471     uint32_t  locals;     /* Total ints of params + locals        */
 472     uint32_t  profile;    /* Always zero (engine uses this)       */
 473     uint32_t  name;       /* name of function in string table     */
 474     uint32_t  file;       /* file of the source file              */
 475     uint32_t  nargs;      /* number of arguments                  */
 476     uint8_t   argsize[8]; /* size of arguments (keep 8 always?)   */
 477 } prog_section_function;
 478
 479 /*
 480  * Instructions
 481  * These are the external instructions supported by the interperter
 482  * this is what things compile to (from the C code).
 483  */
 484 enum {
 485     INSTR_DONE,
 486     INSTR_MUL_F,
 487     INSTR_MUL_V,
 488     INSTR_MUL_FV,
 489     INSTR_MUL_VF,
 490     INSTR_DIV_F,
 491     INSTR_ADD_F,
 492     INSTR_ADD_V,
 493     INSTR_SUB_F,
 494     INSTR_SUB_V,
 495     INSTR_EQ_F,
 496     INSTR_EQ_V,
 497     INSTR_EQ_S,
 498     INSTR_EQ_E,
 499     INSTR_EQ_FNC,
 500     INSTR_NE_F,
 501     INSTR_NE_V,
 502     INSTR_NE_S,
 503     INSTR_NE_E,
 504     INSTR_NE_FNC,
 505     INSTR_LE,
 506     INSTR_GE,
 507     INSTR_LT,
 508     INSTR_GT,
 509     INSTR_LOAD_F,
 510     INSTR_LOAD_V,
 511     INSTR_LOAD_S,
 512     INSTR_LOAD_ENT,
 513     INSTR_LOAD_FLD,
 514     INSTR_LOAD_FNC,
 515     INSTR_ADDRESS,
 516     INSTR_STORE_F,
 517     INSTR_STORE_V,
 518     INSTR_STORE_S,
 519     INSTR_STORE_ENT,
 520     INSTR_STORE_FLD,
 521     INSTR_STORE_FNC,
 522     INSTR_STOREP_F,
 523     INSTR_STOREP_V,
 524     INSTR_STOREP_S,
 525     INSTR_STOREP_ENT,
 526     INSTR_STOREP_FLD,
 527     INSTR_STOREP_FNC,
 528     INSTR_RETURN,
 529     INSTR_NOT_F,
 530     INSTR_NOT_V,
 531     INSTR_NOT_S,
 532     INSTR_NOT_ENT,
 533     INSTR_NOT_FNC,
 534     INSTR_IF,
 535     INSTR_IFNOT,
 536     INSTR_CALL0,
 537     INSTR_CALL1,
 538     INSTR_CALL2,
 539     INSTR_CALL3,
 540     INSTR_CALL4,
 541     INSTR_CALL5,
 542     INSTR_CALL6,
 543     INSTR_CALL7,
 544     INSTR_CALL8,
 545     INSTR_STATE,
 546     INSTR_GOTO,
 547     INSTR_AND,
 548     INSTR_OR,
 549     INSTR_BITAND,
 550     INSTR_BITOR,
 551
 552     /*
 553      * Virtual instructions used by the assembler
 554      * keep at the end but before virtual instructions
 555      * for the IR below.
 556      */
 557     AINSTR_END,
 558
 559     /*
 560      * Virtual instructions used by the IR
 561      * Keep at the end!
 562      */
 563     VINSTR_PHI,
 564     VINSTR_JUMP,
 565     VINSTR_COND
 566 };
 567
 568 /*
 569  * The symbols below are created by the following
 570  * expanded macros:
 571  *
 572  * VECTOR_MAKE(prog_section_statement, code_statements);
 573  * VECTOR_MAKE(prog_section_def,       code_defs      );
 574  * VECTOR_MAKE(prog_section_field,     code_fields    );
 575  * VECTOR_MAKE(prog_section_function,  code_functions );
 576  * VECTOR_MAKE(int,                    code_globals   );
 577  * VECTOR_MAKE(char,                   code_chars     );
 578  */
 579 VECTOR_PROT(prog_section_statement, code_statements);
 580 VECTOR_PROT(prog_section_statement, code_statements);
 581 VECTOR_PROT(prog_section_def,       code_defs      );
 582 VECTOR_PROT(prog_section_field,     code_fields    );
 583 VECTOR_PROT(prog_section_function,  code_functions );
 584 VECTOR_PROT(int,                    code_globals   );
 585 VECTOR_PROT(char,                   code_chars     );
 586
 587 typedef float   qcfloat;
 588 typedef int32_t qcint;
 589
 590 /*
 591  * code_write -- writes out the compiled file
 592  * code_init  -- prepares the code file
 593  */
 594 bool     code_write       (const char *filename);
 595 void     code_init        ();
 596 uint32_t code_genstring   (const char *string);
 597 uint32_t code_cachedstring(const char *string);
 598 qcint    code_alloc_field (size_t qcsize);
 599
 600 /*===================================================================*/
 601 /*========================= assembler.c =============================*/
 602 /*===================================================================*/
 603 static const struct {
 604     const char  *m; /* menomic     */
 605     const size_t o; /* operands    */
 606     const size_t l; /* menomic len */
 607 } asm_instr[] = {
 608     { "DONE"      , 1, 4 },
 609     { "MUL_F"     , 3, 5 },
 610     { "MUL_V"     , 3, 5 },
 611     { "MUL_FV"    , 3, 6 },
 612     { "MUL_VF"    , 3, 6 },
 613     { "DIV"       , 0, 3 },
 614     { "ADD_F"     , 3, 5 },
 615     { "ADD_V"     , 3, 5 },
 616     { "SUB_F"     , 3, 5 },
 617     { "DUB_V"     , 3, 5 },
 618     { "EQ_F"      , 0, 4 },
 619     { "EQ_V"      , 0, 4 },
 620     { "EQ_S"      , 0, 4 },
 621     { "EQ_E"      , 0, 4 },
 622     { "EQ_FNC"    , 0, 6 },
 623     { "NE_F"      , 0, 4 },
 624     { "NE_V"      , 0, 4 },
 625     { "NE_S"      , 0, 4 },
 626     { "NE_E"      , 0, 4 },
 627     { "NE_FNC"    , 0, 6 },
 628     { "LE"        , 0, 2 },
 629     { "GE"        , 0, 2 },
 630     { "LT"        , 0, 2 },
 631     { "GT"        , 0, 2 },
 632     { "FIELD_F"   , 0, 7 },
 633     { "FIELD_V"   , 0, 7 },
 634     { "FIELD_S"   , 0, 7 },
 635     { "FIELD_ENT" , 0, 9 },
 636     { "FIELD_FLD" , 0, 9 },
 637     { "FIELD_FNC" , 0, 9 },
 638     { "ADDRESS"   , 0, 7 },
 639     { "STORE_F"   , 0, 7 },
 640     { "STORE_V"   , 0, 7 },
 641     { "STORE_S"   , 0, 7 },
 642     { "STORE_ENT" , 0, 9 },
 643     { "STORE_FLD" , 0, 9 },
 644     { "STORE_FNC" , 0, 9 },
 645     { "STOREP_F"  , 0, 8 },
 646     { "STOREP_V"  , 0, 8 },
 647     { "STOREP_S"  , 0, 8 },
 648     { "STOREP_ENT", 0, 10},
 649     { "STOREP_FLD", 0, 10},
 650     { "STOREP_FNC", 0, 10},
 651     { "RETURN"    , 0, 6 },
 652     { "NOT_F"     , 0, 5 },
 653     { "NOT_V"     , 0, 5 },
 654     { "NOT_S"     , 0, 5 },
 655     { "NOT_ENT"   , 0, 7 },
 656     { "NOT_FNC"   , 0, 7 },
 657     { "IF"        , 0, 2 },
 658     { "IFNOT"     , 0, 5 },
 659     { "CALL0"     , 1, 5 },
 660     { "CALL1"     , 2, 5 },
 661     { "CALL2"     , 3, 5 },
 662     { "CALL3"     , 4, 5 },
 663     { "CALL4"     , 5, 5 },
 664     { "CALL5"     , 6, 5 },
 665     { "CALL6"     , 7, 5 },
 666     { "CALL7"     , 8, 5 },
 667     { "CALL8"     , 9, 5 },
 668     { "STATE"     , 0, 5 },
 669     { "GOTO"      , 0, 4 },
 670     { "AND"       , 0, 3 },
 671     { "OR"        , 0, 2 },
 672     { "BITAND"    , 0, 6 },
 673     { "BITOR"     , 0, 5 },
 674     { "END"       , 0, 3 } /* virtual assembler instruction */
 675 };
 676
 677 void asm_init (const char *, FILE **);
 678 void asm_close(FILE *);
 679 void asm_parse(FILE *);
 680 /*===================================================================*/
 681 /*============================= ast.c ===============================*/
 682 /*===================================================================*/
 683 #define MEM_VECTOR_PROTO(Towner, Tmem, mem)                   \
 684     bool GMQCC_WARN Towner##_##mem##_add(Towner*, Tmem);      \
 685     bool GMQCC_WARN Towner##_##mem##_remove(Towner*, size_t)
 686
 687 #define MEM_VECTOR_PROTO_ALL(Towner, Tmem, mem)                    \
 688     MEM_VECTOR_PROTO(Towner, Tmem, mem);                           \
 689     bool GMQCC_WARN Towner##_##mem##_find(Towner*, Tmem, size_t*); \
 690     void Towner##_##mem##_clear(Towner*)
 691
 692 #define MEM_VECTOR_MAKE(Twhat, name) \
 693     Twhat  *name;                    \
 694     size_t name##_count;             \
 695     size_t name##_alloc
 696
 697 #define MEM_VEC_FUN_ADD(Tself, Twhat, mem)                           \
 698 bool GMQCC_WARN Tself##_##mem##_add(Tself *self, Twhat f)            \
 699 {                                                                    \
 700     Twhat *reall;                                                    \
 701     if (self->mem##_count == self->mem##_alloc) {                    \
 702         if (!self->mem##_alloc) {                                    \
 703             self->mem##_alloc = 16;                                  \
 704         } else {                                                     \
 705             self->mem##_alloc *= 2;                                  \
 706         }                                                            \
 707         reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_alloc);    \
 708         if (!reall) {                                                \
 709             return false;                                            \
 710         }                                                            \
 711         memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
 712         mem_d(self->mem);                                            \
 713         self->mem = reall;                                           \
 714     }                                                                \
 715     self->mem[self->mem##_count++] = f;                              \
 716     return true;                                                     \
 717 }
 718
 719 #define MEM_VEC_FUN_REMOVE(Tself, Twhat, mem)                        \
 720 bool GMQCC_WARN Tself##_##mem##_remove(Tself *self, size_t idx)      \
 721 {                                                                    \
 722     size_t i;                                                        \
 723     Twhat *reall;                                                    \
 724     if (idx >= self->mem##_count) {                                  \
 725         return true; /* huh... */                                    \
 726     }                                                                \
 727     for (i = idx; i < self->mem##_count-1; ++i) {                    \
 728         self->mem[i] = self->mem[i+1];                               \
 729     }                                                                \
 730     self->mem##_count--;                                             \
 731     if (self->mem##_count < self->mem##_count/2) {                   \
 732         self->mem##_alloc /= 2;                                      \
 733         reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_count);    \
 734         if (!reall) {                                                \
 735             return false;                                            \
 736         }                                                            \
 737         memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
 738         mem_d(self->mem);                                            \
 739         self->mem = reall;                                           \
 740     }                                                                \
 741     return true;                                                     \
 742 }
 743
 744 #define MEM_VEC_FUN_FIND(Tself, Twhat, mem)                     \
 745 bool GMQCC_WARN Tself##_##mem##_find(Tself *self, Twhat obj, size_t *idx) \
 746 {                                                               \
 747     size_t i;                                                   \
 748     for (i = 0; i < self->mem##_count; ++i) {                   \
 749         if (self->mem[i] == obj) {                              \
 750             if (idx) {                                          \
 751                 *idx = i;                                       \
 752             }                                                   \
 753             return true;                                        \
 754         }                                                       \
 755     }                                                           \
 756     return false;                                               \
 757 }
 758
 759 #define MEM_VEC_FUN_APPEND(Tself, Twhat, mem)                        \
 760 bool GMQCC_WARN Tself##_##mem##_append(Tself *s, Twhat *p, size_t c) \
 761 {                                                                    \
 762     Twhat *reall;                                                    \
 763     if (s->mem##_count+c >= s->mem##_alloc) {                        \
 764         if (!s->mem##_alloc) {                                       \
 765             s->mem##_alloc = c < 16 ? 16 : c;                        \
 766         } else {                                                     \
 767             s->mem##_alloc *= 2;                                     \
 768             if (s->mem##_count+c >= s->mem##_alloc) {                \
 769                 s->mem##_alloc = s->mem##_count+c;                   \
 770             }                                                        \
 771         }                                                            \
 772         reall = (Twhat*)mem_a(sizeof(Twhat) * s->mem##_alloc);       \
 773         if (!reall) {                                                \
 774             return false;                                            \
 775         }                                                            \
 776         memcpy(reall, s->mem, sizeof(Twhat) * s->mem##_count);       \
 777         mem_d(s->mem);                                               \
 778         s->mem = reall;                                              \
 779     }                                                                \
 780     memcpy(&s->mem[s->mem##_count], p, c*sizeof(*p));                \
 781     s->mem##_count += c;                                             \
 782     return true;                                                     \
 783 }
 784
 785 #define MEM_VEC_FUN_RESIZE(Tself, Twhat, mem)                    \
 786 bool GMQCC_WARN Tself##_##mem##_resize(Tself *s, size_t c)       \
 787 {                                                                \
 788     Twhat *reall;                                                \
 789     if (c > s->mem##_alloc) {                                    \
 790         reall = (Twhat*)mem_a(sizeof(Twhat) * c);                \
 791         if (!reall) { return false; }                            \
 792         memcpy(reall, s->mem, sizeof(Twhat) * s->mem##_count);   \
 793         s->mem##_alloc = c;                                      \
 794         mem_d(s->mem);                                           \
 795         s->mem = reall;                                          \
 796         return true;                                             \
 797     }                                                            \
 798     s->mem##_count = c;                                          \
 799     if (c < (s->mem##_alloc / 2)) {                              \
 800         reall = (Twhat*)mem_a(sizeof(Twhat) * c);                \
 801         if (!reall) { return false; }                            \
 802         memcpy(reall, s->mem, sizeof(Twhat) * c);                \
 803         mem_d(s->mem);                                           \
 804         s->mem = reall;                                          \
 805     }                                                            \
 806     return true;                                                 \
 807 }
 808
 809 #define MEM_VEC_FUN_CLEAR(Tself, mem)   \
 810 void Tself##_##mem##_clear(Tself *self) \
 811 {                                       \
 812     if (!self->mem)                     \
 813         return;                         \
 814     mem_d((void*) self->mem);           \
 815     self->mem = NULL;                   \
 816     self->mem##_count = 0;              \
 817     self->mem##_alloc = 0;              \
 818 }
 819
 820 #define MEM_VECTOR_CLEAR(owner, mem)  \
 821     if ((owner)->mem)                 \
 822         mem_d((void*)((owner)->mem)); \
 823     (owner)->mem = NULL;              \
 824     (owner)->mem##_count = 0;         \
 825     (owner)->mem##_alloc = 0
 826
 827 #define MEM_VECTOR_INIT(owner, mem) \
 828 {                                   \
 829     (owner)->mem = NULL;            \
 830     (owner)->mem##_count = 0;       \
 831     (owner)->mem##_alloc = 0;       \
 832 }
 833
 834 #define MEM_VEC_FUNCTIONS(Tself, Twhat, mem) \
 835 MEM_VEC_FUN_REMOVE(Tself, Twhat, mem)        \
 836 MEM_VEC_FUN_ADD(Tself, Twhat, mem)
 837
 838 #define MEM_VEC_FUNCTIONS_ALL(Tself, Twhat, mem) \
 839 MEM_VEC_FUNCTIONS(Tself, Twhat, mem)             \
 840 MEM_VEC_FUN_CLEAR(Tself, mem)                    \
 841 MEM_VEC_FUN_FIND(Tself, Twhat, mem)
 842
 843 enum store_types {
 844     store_global,
 845     store_local,  /* local, assignable for now, should get promoted later */
 846     store_param,  /* parameters, they are locals with a fixed position */
 847     store_value,  /* unassignable */
 848     store_return  /* unassignable, at OFS_RETURN */
 849 };
 850
 851 typedef struct {
 852     float x, y, z;
 853 } vector;
 854
 855 /*
 856  * A shallow copy of a lex_file to remember where which ast node
 857  * came from.
 858  */
 859 typedef struct {
 860     const char *file;
 861     size_t      line;
 862 } lex_ctx;
 863
 864 /*===================================================================*/
 865 /*============================= exec.c ==============================*/
 866 /*===================================================================*/
 867
 868 /* darkplaces has (or will have) a 64 bit prog loader
 869  * where the 32 bit qc program is autoconverted on load.
 870  * Since we may want to support that as well, let's redefine
 871  * float and int here.
 872  */
 873 typedef union {
 874     qcint   _int;
 875     qcint    string;
 876     qcint    function;
 877     qcint    edict;
 878     qcfloat _float;
 879     qcfloat vector[3];
 880     qcint   ivector[3];
 881 } qcany;
 882
 883 typedef char qcfloat_size_is_correct [sizeof(qcfloat) == 4 ?1:-1];
 884 typedef char qcint_size_is_correct   [sizeof(qcint)   == 4 ?1:-1];
 885
 886 enum {
 887     VMERR_OK,
 888     VMERR_TEMPSTRING_ALLOC,
 889
 890     VMERR_END
 891 };
 892
 893 #define VM_JUMPS_DEFAULT 1000000
 894
 895 /* execute-flags */
 896 #define VMXF_DEFAULT 0x0000     /* default flags - nothing */
 897 #define VMXF_TRACE   0x0001     /* trace: print statements before executing */
 898 #define VMXF_PROFILE 0x0002     /* profile: increment the profile counters */
 899
 900 struct qc_program_s;
 901
 902 typedef int (*prog_builtin)(struct qc_program_s *prog);
 903
 904 typedef struct {
 905     qcint                  stmt;
 906     size_t                 localsp;
 907     prog_section_function *function;
 908 } qc_exec_stack;
 909
 910 typedef struct qc_program_s {
 911     char           *filename;
 912
 913     MEM_VECTOR_MAKE(prog_section_statement, code);
 914     MEM_VECTOR_MAKE(prog_section_def,       defs);
 915     MEM_VECTOR_MAKE(prog_section_def,       fields);
 916     MEM_VECTOR_MAKE(prog_section_function,  functions);
 917     MEM_VECTOR_MAKE(char,                   strings);
 918     MEM_VECTOR_MAKE(qcint,                  globals);
 919     MEM_VECTOR_MAKE(qcint,                  entitydata);
 920
 921     size_t tempstring_start;
 922     size_t tempstring_at;
 923
 924     qcint  vmerror;
 925
 926     MEM_VECTOR_MAKE(size_t, profile);
 927
 928     MEM_VECTOR_MAKE(prog_builtin, builtins);
 929
 930     /* size_t ip; */
 931     qcint  entities;
 932     size_t entityfields;
 933     bool   allowworldwrites;
 934
 935     MEM_VECTOR_MAKE(qcint,         localstack);
 936     MEM_VECTOR_MAKE(qc_exec_stack, stack);
 937     size_t statement;
 938
 939     int    argc; /* current arg count for debugging */
 940 } qc_program;
 941
 942 qc_program* prog_load(const char *filename);
 943 void        prog_delete(qc_program *prog);
 944
 945 bool prog_exec(qc_program *prog, prog_section_function *func, size_t flags, long maxjumps);
 946
 947 char*             prog_getstring (qc_program *prog, qcint str);
 948 prog_section_def* prog_entfield  (qc_program *prog, qcint off);
 949 prog_section_def* prog_getdef    (qc_program *prog, qcint off);
 950 qcany*            prog_getedict  (qc_program *prog, qcint e);
 951 qcint             prog_tempstring(qc_program *prog, const char *_str);
 952
 953 /*===================================================================*/
 954 /*======================= main.c commandline ========================*/
 955 /*===================================================================*/
 956
 957 #if 0
 958 /* Helpers to allow for a whole lot of flags. Otherwise we'd limit
 959  * to 32 or 64 -f options...
 960  */
 961 typedef struct {
 962     size_t  idx; /* index into an array of 32 bit words */
 963     uint8_t bit; /* index _into_ the 32 bit word, thus just uint8 */
 964 } longbit;
 965 #define LONGBIT(bit) { ((bit)/32), ((bit)%32) }
 966 #else
 967 typedef uint32_t longbit;
 968 #define LONGBIT(bit) (bit)
 969 #endif
 970
 971 /* Used to store the list of flags with names */
 972 typedef struct {
 973     const char *name;
 974     longbit    bit;
 975 } opts_flag_def;
 976
 977 /*===================================================================*/
 978 /* list of -f flags, like -fdarkplaces-string-table-bug */
 979 enum {
 980 # define GMQCC_DEFINE_FLAG(X) X,
 981 #  include "flags.def"
 982 # undef GMQCC_DEFINE_FLAG
 983     COUNT_FLAGS
 984 };
 985 static const opts_flag_def opts_flag_list[] = {
 986 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(X) },
 987 #  include "flags.def"
 988 # undef GMQCC_DEFINE_FLAG
 989     { NULL, LONGBIT(0) }
 990 };
 991
 992 enum {
 993 # define GMQCC_DEFINE_FLAG(X) X,
 994 #  include "warns.def"
 995 # undef GMQCC_DEFINE_FLAG
 996     COUNT_WARNINGS
 997 };
 998 static const opts_flag_def opts_warn_list[] = {
 999 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(X) },
1000 #  include "warns.def"
1001 # undef GMQCC_DEFINE_FLAG
1002     { NULL, LONGBIT(0) }
1003 };
1004
1005 /* other options: */
1006 enum {
1007     COMPILER_QCC,     /* circa  QuakeC */
1008     COMPILER_FTEQCC,  /* fteqcc QuakeC */
1009     COMPILER_QCCX,    /* qccx   QuakeC */
1010     COMPILER_GMQCC    /* this   QuakeC */
1011 };
1012 extern uint32_t    opts_O;      /* -Ox */
1013 extern const char *opts_output; /* -o file */
1014 extern int         opts_standard;
1015 extern bool        opts_debug;
1016 extern bool        opts_memchk;
1017
1018 /*===================================================================*/
1019 #define OPTS_FLAG(i) (!! (opts_flags[(i)/32] & (1<< ((i)%32))))
1020 extern uint32_t opts_flags[1 + (COUNT_FLAGS / 32)];
1021 #define OPTS_WARN(i) (!! (opts_warn[(i)/32] & (1<< ((i)%32))))
1022 extern uint32_t opts_warn[1 + (COUNT_WARNINGS / 32)];
1023
1024 #endif