doc.html

   1 <!doctype html>
   2 <html>
   3     <head>
   4         <meta charset="utf-8">
   5         <meta http-equiv="X-UA-Compatible" content="chrome=1">
   6         <title>GMQCC</title>
   7
   8         <link rel="stylesheet" href="stylesheets/styles.css">
   9         <link rel="stylesheet" href="stylesheets/pygment_trac.css">
  10         <script src="javascripts/scale.fix.js"></script>
  11         <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
  12         <!--[if lt IE 9]>
  13         <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  14         <![endif]-->
  15     </head>
  16     <body>
  17         <a href="https://github.com/graphitemaster/gmqcc"><div class="fork"></div></a>
  18         <div class="wrapper">
  19             <header>
  20                 <h1 class="header">GMQCC</h1>
  21                 <p class="header">An Improved Quake C Compiler</p>
  22                 <ul>
  23                     <li class="buttons"><a href=index.html>Index</a></li>
  24                     <li class="download"><a href="https://github.com/graphitemaster/gmqcc/archive/0.1.zip">Download v0.1</a></li>
  25                     <li class="buttons"><a href="https://github.com/graphitemaster/gmqcc/issues">Issues</a></li>
  26                     <li class="buttons"><a href="doc.html">Documentation</a></li>
  27                     <li class="buttons"><a href="https://github.com/graphitemaster/gmqcc">View On GitHub</a></li>
  28                 </ul>
  29             </header>
  30             <section>
  31                 <ul class="wiki">
  32                     <li class="wiki"><a class="wiki" href="#cdoc">Compiler Documentation</a></li>
  33                     <li class="wiki"><a class="wiki" href="#bdoc">Building Documentation</a></li>
  34                     <li class="wiki"><a class="wiki" href="#tdoc">Testsuite Documentation</a></li>
  35                     <li class="wiki"><a class="wiki" href="#vdoc">Virtual Machine Documentation</a></li>
  36                 </ul>
  37                 <h1><a name="cdoc">Compiler Documentation</a></h1>
  38                 <h3>Defaults Flag</h3>
  39                 <p>
  40                     The <i>-show-defaults</i> flag instructs the compiler to print out the defaults used related to
  41                     the standard, optimization, and code generation.  When this flag is specified, the compiler
  42                     will just print the defaults and quit.  No compilation is performed.
  43                 </p>
  44                 <pre>$ gmqcc -show-defaults</pre>
  45                 <h3>Compiling for an alternitive standard</h3>
  46                 To compile with a different dialect of the QuakeC programming language the <i>-std</i>
  47                 flag can be instructed to select one of the following options:
  48                 <table border="0">
  49                     <tr>
  50                         <td>gmqcc</td>
  51                         <td>default standard</td>
  52                     </tr>
  53                     <tr>
  54                         <td>fteqcc</td>
  55                         <td>fteqcc standard</td>
  56                     </tr>
  57                     <tr>
  58                         <td>qcc</td>
  59                         <td>vanila QuakeC standard</td>
  60                     </tr>
  61                 </table>
  62                 <h2>Common compiler options</h2>
  63                 <table border="0">
  64                     <tr>
  65                         <td>Options</td>
  66                         <td>What it does</td>
  67                     </tr>
  68                     <tr>
  69                         <td>-l&lt;path&gt;</td>
  70                         <td>Adds &lt;path&gt; to the directories searched by the preprocessor for include file resolution.</td>
  71                     </tr>
  72                     <tr>
  73                         <td>-o &lt;file&gt;</td>
  74                         <td>Generates the named executable (progs.src) file (when not specified default is progs.src).</td>
  75                     </tr>
  76
  77                     <tr>
  78                         <td>-O&lt;level&gt;</td>
  79                         <td>Specfies the optimization level: highest being 3, lowest being 0 (no optimization).</td>
  80                     </tr>
  81                     <tr>
  82                         <td>-E</td>
  83                         <td>Instructs the compiler to only preprocess the input, writing the preprocessed output to stdout</td>
  84                     </tr>
  85                     <tr>
  86                         <td>-Wall</td>
  87                         <td>Enables all compiled warnings for the selcted standard</td>
  88                     </tr>
  89                     <tr>
  90                         <td>-Werror</td>
  91                         <td>Instruct the compiler to treat all warnings as errors</td>
  92                     </tr>
  93                     <tr>
  94                         <td>-std=&lt;standard&gt;</td>
  95                         <td>Selects the standard dialect</td>
  96                     </tr>
  97                 </table>
  98                 <h3>Predefined Macros</h3>
  99                 <table border="0">
 100                     <tr>
 101                         <td>Macro</td>
 102                         <td>What it represents</td>
 103                     </tr>
 104                     <tr>
 105                         <td>GMQCC</td>
 106                         <td>Specifies the current selected standard is gmqcc.</td>
 107                     </tr>
 108                     <tr>
 109                         <td>FTEQCC</td>
 110                         <td>Specifies the current selected standard is fteqcc.</td>
 111                     </tr>
 112                     <tr>
 113                         <td>QCC</td>
 114                         <td>Specifies the current selected standard is qcc.</td>
 115                     </tr>
 116
 117                     <tr>
 118                         <td>__STD_VERSION_MINOR__</td>
 119                         <td>Specifies the current selected stanadards minor version number.</td>
 120                     </tr>
 121                     <tr>
 122                         <td>__STD_VERSION_MAJOR__</td>
 123                         <td>Specifies the current selected stanadards major version number.</td>
 124                     </tr>
 125                 </table>
 126                 <h3>Unsupported compatability options</h3>
 127                 <p>
 128                     GMQCC strives hard for compatability with standard dialects, but not all
 129                     features of those standards might be implemented. The unsupported features
 130                     are presented below:
 131                     <table border="0">
 132                         <tr>
 133                             <td>Feature</td>
 134                             <td>Standard</td>
 135                         </tr>
 136                         <tr>
 137                             <td>Inline Assembly</td>
 138                             <td>FTEQCC</td>
 139                         </tr>
 140                         <tr>
 141                             <td>Macro expansion in strings</td>
 142                             <td>FTEQCC</td>
 143                         </tr>
 144                     </table>
 145                 </p>
 146                 <h2>Less common compiler options</h2>
 147                 <h3>Code generation options</h3>
 148                 <table border="0">
 149                     <tr>
 150                         <td>Option</td>
 151                         <td>What it does</td>
 152                     </tr>
 153                     <tr>
 154                         <td>-foverlap-locals</td>
 155                         <td>Reduces codesize by overlapping locals where possible</td>
 156                     </tr>
 157                     <tr>
 158                         <td>-fdarkplaces-string-table-bug</td>
 159                         <td>Works around a bug in older Darkplaces engine builds where the stringtable size is computed wrong</td>
 160                     </tr>
 161                     <tr>
 162                         <td>-fadjust-vector-fields</td>
 163                         <td>corrects assignment of vector field pointers (STORE_V instead of STORE_FLD)</td>
 164                     </tr>
 165                     <tr>
 166                         <td>-fftepp</td>
 167                         <td>Enables FTEQ preprocessor</td>
 168                     </tr>
 169                     <tr>
 170                         <td>-frelaxted-switch</td>
 171                         <td>Relaxes switch statement semantics</td>
 172                     </tr>
 173                     <tr>
 174                         <td>-fshort-logic</td>
 175                         <td>Enables short circut evaluation/logic</td>
 176                     </tr>
 177                     <tr>
 178                         <td>-fperl-logic</td>
 179                         <td>Enables perl evalutaion/logic</td>
 180                     </tr>
 181                 </table>
 182                 <h3>Warning options</h3>
 183                 <table border="0">
 184                     <tr>
 185                         <td>Option</td>
 186                         <td>What it does</td>
 187                     </tr>
 188                     <tr>
 189                         <td>-Wunused-uninitialized</td>
 190                         <td>Enables warnings about unused or uninitialized variables</td>
 191                     </tr>
 192                     <tr>
 193                         <td>-Wunknwon-control-sequence</td>
 194                         <td>Enables warnings about unknown control sequences</td>
 195                     </tr>
 196                     <tr>
 197                         <td>-Wextension</td>
 198                         <td>Enables warnings about the use of (an) extension(s)</td>
 199                     </tr>
 200                     <tr>
 201                         <td>-Wfield-redeclared</td>
 202                         <td>Enables warnings about redeclared fields</td>
 203                     </tr>
 204                     <tr>
 205                         <td>-Wmissing-return-values</td>
 206                         <td>Enables warnings about missing return values</td>
 207                     </tr>
 208                     <tr>
 209                         <td>-Wtoo-few-paramaters</td>
 210                         <td>Enables warnings about missing paramaters for function calls</td>
 211                     </tr>
 212                     <tr>
 213                         <td>-Wlocal-shadows</td>
 214                         <td>Enables warnings about locals shadowing paramaters or other locals</td>
 215                     </tr>
 216                     <tr>
 217                         <td>-Wlocal-constants</td>
 218                         <td>Enables warnings about constants specified as locals</td>
 219                     </tr>
 220                     <tr>
 221                         <td>-Wvoid-variables</td>
 222                         <td>Enables warnings about variables declared as type void</td>
 223                     </tr>
 224                     <tr>
 225                         <td>-Wimplicit-function-pointer</td>
 226                         <td>Enables warnings about implicitly declared function pointers</td>
 227                     </tr>
 228                     <tr>
 229                         <td>-Wvariadic-function</td>
 230                         <td>Enables warnings for use of varadics for non-builtin functions</td>
 231                     </tr>
 232                     <tr>
 233                         <td>-Wframe-macros</td>
 234                         <td>Enables warnings about duplicated frame macros</td>
 235                     </tr>
 236                     <tr>
 237                         <td>-Weffectless-statement</td>
 238                         <td>Enables warnings about effectiveless statements</td>
 239                     </tr>
 240                     <tr>
 241                         <td>-Wend-sys-field</td>
 242                         <td>Enables warnings of end_sys_fields being declared a field</td>
 243                     </tr>
 244                     <tr>
 245                         <td>-Wassign-function-types</td>
 246                         <td>Enables warnings for incompatible function pointer signatures used in assignment</td>
 247                     </tr>
 248                     <tr>
 249                         <td>-Wpreprocessor</td>
 250                         <td>Enables warnings about redefined macros</td>
 251                     </tr>
 252                     <tr>
 253                         <td>-Wmultifile-if</td>
 254                         <td>Enables warnings about multifile if statements</td>
 255                     </tr>
 256                 </table>
 257                 <p>
 258                     Individual warnings may be disabled with &nbsp;-Wno&lt;warning&gt;
 259                     <pre>$ gmqcc -Wno-frame-macros # disables frame duplication warning</pre>
 260                 </p>
 261                 <h3>Miscellaneous options</h3>
 262                 <table border="0">
 263                     <tr>
 264                         <td>Option</td>
 265                         <td>What it does</td>
 266                     </tr>
 267                     <tr>
 268                         <td>-force-crc=&lt;num&gt;</td>
 269                         <td>Forces a specific checsum into the header</td>
 270                     </tr>
 271                     <tr>
 272                         <td>-debug</td>
 273                         <td>Turns on compiler debug messages</td>
 274                     </tr>
 275                     <tr>
 276                         <td>-memchk</td>
 277                         <td>Turns on compiler memory leak checker</td>
 278                     </tr>
 279
 280                     <tr>
 281                         <td>-Whelp or -W?</td>
 282                         <td>Lists all warning options</td>
 283                     </tr>
 284
 285                     <tr>
 286                         <td>-fhelp or -f?</td>
 287                         <td>Lists all code generation options</td>
 288                     </tr>
 289                 </table>
 290
 291                 <h1><a name="bdoc">Building Documentation</a></h1>
 292                 <h2>Building on BSD/NIX</h2>
 293                 <p>
 294                     To compile GMQCC on BSD/NIX the following things are
 295                     required:
 296
 297                     <ul>
 298                         <li>GIT</li>
 299                         <li>Make</li>
 300                         <li>Any C90+ C compiler</li>
 301                     </ul>
 302
 303                     Once obtained you may checkout the development repository
 304                     with the following shell commands
 305
 306 <pre>$ git clone git://github.com/graphitemaster/gmqcc.git
 307 $ cd gmqcc
 308 </pre>
 309
 310                     The Makefile contains a few rules, depending on what you
 311                     want to compile, the following rules are:
 312
 313                     <table border="0">
 314                         <tr>
 315                             <td>Rule</td>
 316                             <td>What it does</td>
 317                         </tr>
 318                         <tr>
 319                             <td>gmqcc</td>
 320                             <td>Builds the gmqcc compiler</td>
 321                         </tr>
 322                         <tr>
 323                             <td>qcvm</td>
 324                             <td>Builds a standable QuakeC VM</td>
 325                         </tr>
 326                         <tr>
 327                             <td>testsuite</td>
 328                             <td>Builds the testsuite for GMQCC</td>
 329                         </tr>
 330                         <tr>
 331                             <td>all</td>
 332                             <td>Builds gmqcc, qcvm, and testsuite</td>
 333                         </tr>
 334                         <tr>
 335                             <td>install</td>
 336                             <td>Installs gmqcc to /usr/local/</td>
 337                         </tr>
 338                         <tr>
 339                             <td>check</td>
 340                             <td>Runs the testsuite to verify correctness</td>
 341                         </tr>
 342                     </table>
 343                 </p>
 344                 <h2>Building on Windows</h2>
 345                 <p>
 346                     To compile GMQCC on windows the following things are
 347                     required:
 348
 349                     <ul>
 350                         <li><a href="http://msysgit.googlecode.com/files/Git-1.8.0-preview20121022.exe">msysGit</a></li>
 351                         <li><a href="http://www.microsoft.com/visualstudio/eng/downloads">Visual Studio</a></li>
 352                     </ul>
 353
 354                     Once obtained you may checkout the development repository
 355                     with the following msysGit commands from a msysGit shell.
 356                     <pre>$ git clone git://github.com/graphitemaster/gmqcc.git</pre>
 357                     Included is a VS project file.
 358                 </p>
 359
 360                 <h1><a name="tdoc">Testsuite Documentation</a></h1>
 361                 <h2>Running The Testsuite</h2>
 362                 <p>
 363                     To run the testsuite you can either use
 364                     <pre>$ make check</pre>
 365                     Or if you're on windows or have already compiled the
 366                     testsuite from source:
 367                     <pre>$ ./testsuite </pre>
 368
 369                     Optionally you may provide the testsuite with additional
 370                     arguments:
 371
 372                     <table border="0">
 373                         <tr>
 374                             <td>Argument</td>
 375                             <td>What it does</td>
 376                         </tr>
 377                         <tr>
 378                             <td>-redirout=&lt;file&gt;</td>
 379                             <td>Redirect stdout to any file.</td>
 380                         </tr>
 381                         <tr>
 382                             <td>-redirerr=&lt;file&gt;</td>
 383                             <td>Redirect stderr to any file.</td>
 384                         </tr>
 385                         <tr>
 386                             <td>-debug</td>
 387                             <td>Turn on testsuite debug messages.</td>
 388                         </tr>
 389                         <tr>
 390                             <td>-memchk</td>
 391                             <td>Turn on testsuite memleak checker.</td>
 392                         </tr>
 393                         <tr>
 394                             <td>-nocolor</td>
 395                             <td>Turn off colored stdout/stderr.</td>
 396                         </tr>
 397                     </table>
 398                 </p>
 399                 <h2>Writing Tests</h2>
 400                 <p>
 401                     GMQCC comes with a complete testsuite for verifying semantics
 402                     and syntatics.  The testsuite executes files from the test/
 403                     directory, by reading task template files.
 404                 </p>
 405                 <p>
 406                    templates are rules for a specific test, used to create a "task" that
 407                    is executed with those set of rules (arguments, and what not). Tests
 408                    that don't have a template with them cannot become tasks, since without
 409                    the information for that test there is no way to properly "test" them.
 410                    Rules for these templates are described in a template file, using a
 411                    task template language.
 412                 </p>
 413                 <p>
 414                    The languge is composed entierly of "tags" which describe a string of
 415                    text for a task.  Think of it much like a configuration file.  Except
 416                    it's been designed to allow flexibility and future support for prodecual
 417                    semantics.
 418                 <p>
 419                 <p>
 420                    The following "tags" are suported by the language:
 421                 </p>
 422                 <table border="0">
 423                     <tr>
 424                         <td>Tag</td>
 425                         <td>Description of what the tag does</td>
 426                     </tr>
 427                     <tr>
 428                        <td>D:</td>
 429                          <td>Used to set a description of the current test, this must be
 430                            provided, this tag is NOT optional.</td>
 431                     </tr>
 432                     <tr>
 433                         <td>F:</td>
 434                          <td>Used to set a failure message, this message will be displayed
 435                            if the test fails, this tag is optional.</td>
 436                     </tr>
 437                     <tr>
 438                         <td>S:</td>
 439                             <td>Used to set a success message, this message will be displayed
 440                            if the test succeeds, this tag is optional.
 441                            </td>
 442                     </tr>
 443                     <tr>
 444                        <td>T:</td>
 445                             <td>Used to set the procedure for the given task, there are two
 446                            options for this:
 447                            <ul>
 448                                <li>-compile&nbsp;
 449                                    This simply performs compilation only</li>
 450                                <li>-execute&nbsp;
 451                                    This will perform compilation and execution</li>
 452                             </ul>
 453
 454                            This tag must be provided, this tag is NOT optional.
 455                            </td>
 456                     </tr>
 457                     <tr>
 458                        <td>C:</td>
 459                         <td>Used to set the compilation flags for the given task, this
 460                            must be provided, this tag is NOT optional.</td>
 461                     </tr>
 462                     <tr>
 463                        <td>E:</td>
 464                         <td>Used to set the execution flags for the given task. This tag
 465                            must be provided if T == -execute, otherwise it's erroneous
 466                            as compilation only takes place.</td>
 467                     </tr>
 468                     <tr>
 469                        <td>M:</td>
 470                         <td>Used to describe a string of text that should be matched from
 471                            the output of executing the task.  If this doesn't match the
 472                            task fails.  This tag must be provided at least once if
 473                            T == -execute, otherwise it's erroneous as compilation only
 474                            takes place. Multiple M tags are required for multi-line comparision
 475                         </td>
 476                     </tr>
 477                     <tr>
 478                        <td>I:</td>
 479                        <td>Used to specify the INPUT source file to operate on, this must be
 480                        provided, this tag is NOT optional</td>
 481                     </tr>
 482                  </table>
 483                 <h3>Notes</h3>
 484                 <p>
 485                    These tags (with exception to M) have one-time use, using them more
 486                    than once will result in template compilation errors,
 487                 </p>
 488                 <p>
 489                    Lines beginning with # or // in the template file are comments and
 490                    are ignored by the template parser.
 491                    Whitespace is optional, with exception to the colon ':' between the
 492                    tag and it's assignment value.
 493                 </p>
 494                    The template compiler will detect erronrous tags (optional tags
 495                    that need not be set), as well as missing tags, and error accordingly
 496                    which will result in that task failing.
 497                 </p>
 498                 <h1><a name="vdoc">Quake C Virtual Machine Documentation</a></h1>
 499                 <p>
 500                     Included with GMQCC is a minimal implementation of the QCVM used in many game
 501                     engines.  It's primarly used for the testsuite, but you may also use it as a
 502                     standalone runtime, or even embed it with existing appliciations.
 503                 </p>
 504                 <h2>Running The Standalone VM</h2>
 505                 <p>
 506                     To run the standalone application you need to have a compiled progs.dat, with an
 507                     entry function named &nbsp;main&nbsp;  The main function can have any amount of arguments
 508                     as the standalone executor allows main to be invoked with your choice of arguments.
 509                     An example of invoking the VM:
 510                     <pre>$ ./qcvm progs.dat -float 200 #execute passing in 200 as a float to main</pre>
 511                     If &nbsp;main&nbsp; doesn't require arguments:
 512                     <pre>$ ./qcvm progs.dat #call main with no arguments</pre>
 513
 514                     The standalone executor supports the following arguments for passing arguments to &nbsp;main&nbsp
 515
 516                     <table border="0">
 517                         <tr>
 518                             <td>Argument</td>
 519                             <td>What it does</td>
 520                         </tr>
 521                         <tr>
 522                             <td>-string</td>
 523                             <td>Passes in a string to main</td>
 524                         </tr>
 525                         <tr>
 526                             <td>-float</td>
 527                             <td>Passes in a float to main</td>
 528                         </tr>
 529                         <tr>
 530                             <td>-vector</td>
 531                             <td>Passes in a vector to main</td>
 532                         </tr>
 533                     </table>
 534
 535                     The order in which the arguments are expected for main, must be preserved, for
 536                     example if &nbsp;main&nbsp;'s signature is the following:
 537                     <pre>void main(float a, vector b)</pre>
 538
 539                     Then to pass the arguments you'd use the same order:
 540                     <pre>$ ./qcvm -float 200 -vector '1 2 3'</pre>
 541
 542                     <h3>Additional Arguments</h3>
 543                     The standalone virtual machine has the following optional command line arguments:
 544                     <table border="0">
 545                         <tr>
 546                             <td>Argument</td>
 547                             <td>What it does</td>
 548                         </tr>
 549                         <tr>
 550                             <td>-trace</td>
 551                             <td>Trace the execution call hierarchy.</td>
 552                         </tr>
 553                         <tr>
 554                             <td>-profile</td>
 555                             <td>Profile the bytecode to find hotspots.</td>
 556                         </tr>
 557                         <tr>
 558                             <td>-info</td>
 559                             <td>Get info of the running bytecode.</td>
 560                         </tr>
 561                         <tr>
 562                             <td>-disasm</td>
 563                             <td>Dissasemble the bytecode into assembly.</td>
 564                         </tr>
 565                         <tr>
 566                             <td>-printdefs</td>
 567                             <td>Prints all definitions for the bytecode running.</td>
 568                         </tr>
 569                         <tr>
 570                             <td>-printfields</td>
 571                             <td>Prints all fields for the bytecode running.</td>
 572                         </tr>
 573                     </table>
 574
 575                     <h3>Builtins</h3>
 576                     The standalone virtual machine includes the following builtins.
 577                     <table border="0">
 578                         <tr>
 579                             <td>Builtin</td>
 580                             <td>Number</td>
 581                         </tr>
 582                             <tr><td>print</td><td>1</td></tr>
 583                             <tr><td>ftos</td><td>2</td></tr>
 584                             <tr><td>spawn</td><td>3</td></tr>
 585                             <tr><td>kill</td><td>4</td></tr>
 586                             <tr><td>vtos</td><td>5</td></tr>
 587                             <tr><td>error</td><td>6</td></tr>
 588                             <tr><td>vlen</td><td>7</td></tr>
 589                             <tr><td>etos</td><td>8</td></tr>
 590                     </table>
 591                 </p>
 592                 <h3>Support or Contact</h3>
 593                 <p>Having trouble with GMQCC? Join our IRC channel at #kf-engine on irc.freenode.net or contact <a href="mailto:cube2killfild@gmail.com">Us</a>
 594             </section>
 595             <footer>
 596                 <script type="text/javascript" src="http://www.ohloh.net/p/602517/widgets/project_partner_badge.js"></script>
 597             </footer>
 598         </div>
 599         <!--[if !IE]><script>fixScale(document);</script><![endif]-->
 600     </body>
 601 </html>