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                     <tr>
 280                         <td>-Whelp or -W?</td>
 281                         <td>Lists all warning options</td>
 282                     </tr>
 283                     <tr>
 284                         <td>-fhelp or -f?</td>
 285                         <td>Lists all code generation options</td>
 286                     </tr>
 287                     <tr>
 288                         <td>-redirout=&lt;file&gt;</td>
 289                         <td>Redirect stdout to any file.</td>
 290                     </tr>
 291                     <tr>
 292                         <td>-redirerr=&lt;file&gt;</td>
 293                         <td>Redirect stderr to any file.</td>
 294                     </tr>
 295                     <tr>
 296                         <td>-nocolor</td>
 297                         <td>Turn off colored stdout/stderr.</td>
 298                     </tr>
 299                 </table>
 300
 301                 <h1><a name="bdoc">Building Documentation</a></h1>
 302                 <h2>Building on BSD/NIX</h2>
 303                 <p>
 304                     To compile GMQCC on BSD/NIX the following things are
 305                     required:
 306
 307                     <ul>
 308                         <li>GIT</li>
 309                         <li>Make</li>
 310                         <li>Any C90+ C compiler</li>
 311                     </ul>
 312
 313                     Once obtained you may checkout the development repository
 314                     with the following shell commands
 315
 316 <pre>$ git clone git://github.com/graphitemaster/gmqcc.git
 317 $ cd gmqcc
 318 </pre>
 319
 320                     The Makefile contains a few rules, depending on what you
 321                     want to compile, the following rules are:
 322
 323                     <table border="0">
 324                         <tr>
 325                             <td>Rule</td>
 326                             <td>What it does</td>
 327                         </tr>
 328                         <tr>
 329                             <td>gmqcc</td>
 330                             <td>Builds the gmqcc compiler</td>
 331                         </tr>
 332                         <tr>
 333                             <td>qcvm</td>
 334                             <td>Builds a standable QuakeC VM</td>
 335                         </tr>
 336                         <tr>
 337                             <td>testsuite</td>
 338                             <td>Builds the testsuite for GMQCC</td>
 339                         </tr>
 340                         <tr>
 341                             <td>all</td>
 342                             <td>Builds gmqcc, qcvm, and testsuite</td>
 343                         </tr>
 344                         <tr>
 345                             <td>install</td>
 346                             <td>Installs gmqcc to /usr/local/</td>
 347                         </tr>
 348                         <tr>
 349                             <td>check</td>
 350                             <td>Runs the testsuite to verify correctness</td>
 351                         </tr>
 352                     </table>
 353                 </p>
 354                 <h2>Building on Windows</h2>
 355                 <p>
 356                     To compile GMQCC on windows the following things are
 357                     required:
 358
 359                     <ul>
 360                         <li><a href="http://msysgit.googlecode.com/files/Git-1.8.0-preview20121022.exe">msysGit</a></li>
 361                         <li><a href="http://www.microsoft.com/visualstudio/eng/downloads">Visual Studio</a></li>
 362                     </ul>
 363
 364                     Once obtained you may checkout the development repository
 365                     with the following msysGit commands from a msysGit shell.
 366                     <pre>$ git clone git://github.com/graphitemaster/gmqcc.git</pre>
 367                     Included is a VS project file.
 368                 </p>
 369
 370                 <h1><a name="tdoc">Testsuite Documentation</a></h1>
 371                 <h2>Running The Testsuite</h2>
 372                 <p>
 373                     To run the testsuite you can either use
 374                     <pre>$ make check</pre>
 375                     Or if you're on windows or have already compiled the
 376                     testsuite from source:
 377                     <pre>$ ./testsuite </pre>
 378
 379                     Optionally you may provide the testsuite with additional
 380                     arguments:
 381
 382                     <table border="0">
 383                         <tr>
 384                             <td>Argument</td>
 385                             <td>What it does</td>
 386                         </tr>
 387                         <tr>
 388                             <td>-redirout=&lt;file&gt;</td>
 389                             <td>Redirect stdout to any file.</td>
 390                         </tr>
 391                         <tr>
 392                             <td>-redirerr=&lt;file&gt;</td>
 393                             <td>Redirect stderr to any file.</td>
 394                         </tr>
 395                         <tr>
 396                             <td>-debug</td>
 397                             <td>Turn on testsuite debug messages.</td>
 398                         </tr>
 399                         <tr>
 400                             <td>-memchk</td>
 401                             <td>Turn on testsuite memleak checker.</td>
 402                         </tr>
 403                         <tr>
 404                             <td>-nocolor</td>
 405                             <td>Turn off colored stdout/stderr.</td>
 406                         </tr>
 407                     </table>
 408                 </p>
 409                 <h2>Writing Tests</h2>
 410                 <p>
 411                     GMQCC comes with a complete testsuite for verifying semantics
 412                     and syntatics.  The testsuite executes files from the test/
 413                     directory, by reading task template files.
 414                 </p>
 415                 <p>
 416                    templates are rules for a specific test, used to create a "task" that
 417                    is executed with those set of rules (arguments, and what not). Tests
 418                    that don't have a template with them cannot become tasks, since without
 419                    the information for that test there is no way to properly "test" them.
 420                    Rules for these templates are described in a template file, using a
 421                    task template language.
 422                 </p>
 423                 <p>
 424                    The languge is composed entierly of "tags" which describe a string of
 425                    text for a task.  Think of it much like a configuration file.  Except
 426                    it's been designed to allow flexibility and future support for prodecual
 427                    semantics.
 428                 <p>
 429                 <p>
 430                    The following "tags" are suported by the language:
 431                 </p>
 432                 <table border="0">
 433                     <tr>
 434                         <td>Tag</td>
 435                         <td>Description of what the tag does</td>
 436                     </tr>
 437                     <tr>
 438                        <td>D:</td>
 439                          <td>Used to set a description of the current test, this must be
 440                            provided, this tag is NOT optional.</td>
 441                     </tr>
 442                     <tr>
 443                         <td>F:</td>
 444                          <td>Used to set a failure message, this message will be displayed
 445                            if the test fails, this tag is optional.</td>
 446                     </tr>
 447                     <tr>
 448                         <td>S:</td>
 449                             <td>Used to set a success message, this message will be displayed
 450                            if the test succeeds, this tag is optional.
 451                            </td>
 452                     </tr>
 453                     <tr>
 454                        <td>T:</td>
 455                             <td>Used to set the procedure for the given task, there are two
 456                            options for this:
 457                            <ul>
 458                                <li>-compile&nbsp;
 459                                    This simply performs compilation only</li>
 460                                <li>-execute&nbsp;
 461                                    This will perform compilation and execution</li>
 462                             </ul>
 463
 464                            This tag must be provided, this tag is NOT optional.
 465                            </td>
 466                     </tr>
 467                     <tr>
 468                        <td>C:</td>
 469                         <td>Used to set the compilation flags for the given task, this
 470                            must be provided, this tag is NOT optional.</td>
 471                     </tr>
 472                     <tr>
 473                        <td>E:</td>
 474                         <td>Used to set the execution flags for the given task. This tag
 475                            must be provided if T == -execute, otherwise it's erroneous
 476                            as compilation only takes place.</td>
 477                     </tr>
 478                     <tr>
 479                        <td>M:</td>
 480                         <td>Used to describe a string of text that should be matched from
 481                            the output of executing the task.  If this doesn't match the
 482                            task fails.  This tag must be provided at least once if
 483                            T == -execute, otherwise it's erroneous as compilation only
 484                            takes place. Multiple M tags are required for multi-line comparision
 485                         </td>
 486                     </tr>
 487                     <tr>
 488                        <td>I:</td>
 489                        <td>Used to specify the INPUT source file to operate on, this must be
 490                        provided, this tag is NOT optional</td>
 491                     </tr>
 492                  </table>
 493                 <h3>Notes</h3>
 494                 <p>
 495                    These tags (with exception to M) have one-time use, using them more
 496                    than once will result in template compilation errors,
 497                 </p>
 498                 <p>
 499                    Lines beginning with # or // in the template file are comments and
 500                    are ignored by the template parser.
 501                    Whitespace is optional, with exception to the colon ':' between the
 502                    tag and it's assignment value.
 503                 </p>
 504                    The template compiler will detect erronrous tags (optional tags
 505                    that need not be set), as well as missing tags, and error accordingly
 506                    which will result in that task failing.
 507                 </p>
 508                 <h1><a name="vdoc">Quake C Virtual Machine Documentation</a></h1>
 509                 <p>
 510                     Included with GMQCC is a minimal implementation of the QCVM used in many game
 511                     engines.  It's primarly used for the testsuite, but you may also use it as a
 512                     standalone runtime, or even embed it with existing appliciations.
 513                 </p>
 514                 <h2>Running The Standalone VM</h2>
 515                 <p>
 516                     To run the standalone application you need to have a compiled progs.dat, with an
 517                     entry function named &nbsp;main&nbsp;  The main function can have any amount of arguments
 518                     as the standalone executor allows main to be invoked with your choice of arguments.
 519                     An example of invoking the VM:
 520                     <pre>$ ./qcvm progs.dat -float 200 #execute passing in 200 as a float to main</pre>
 521                     If &nbsp;main&nbsp; doesn't require arguments:
 522                     <pre>$ ./qcvm progs.dat #call main with no arguments</pre>
 523
 524                     The standalone executor supports the following arguments for passing arguments to &nbsp;main&nbsp
 525
 526                     <table border="0">
 527                         <tr>
 528                             <td>Argument</td>
 529                             <td>What it does</td>
 530                         </tr>
 531                         <tr>
 532                             <td>-string</td>
 533                             <td>Passes in a string to main</td>
 534                         </tr>
 535                         <tr>
 536                             <td>-float</td>
 537                             <td>Passes in a float to main</td>
 538                         </tr>
 539                         <tr>
 540                             <td>-vector</td>
 541                             <td>Passes in a vector to main</td>
 542                         </tr>
 543                     </table>
 544
 545                     The order in which the arguments are expected for main, must be preserved, for
 546                     example if &nbsp;main&nbsp;'s signature is the following:
 547                     <pre>void main(float a, vector b)</pre>
 548
 549                     Then to pass the arguments you'd use the same order:
 550                     <pre>$ ./qcvm -float 200 -vector '1 2 3'</pre>
 551
 552                     <h3>Additional Arguments</h3>
 553                     The standalone virtual machine has the following optional command line arguments:
 554                     <table border="0">
 555                         <tr>
 556                             <td>Argument</td>
 557                             <td>What it does</td>
 558                         </tr>
 559                         <tr>
 560                             <td>-trace</td>
 561                             <td>Trace the execution call hierarchy.</td>
 562                         </tr>
 563                         <tr>
 564                             <td>-profile</td>
 565                             <td>Profile the bytecode to find hotspots.</td>
 566                         </tr>
 567                         <tr>
 568                             <td>-info</td>
 569                             <td>Get info of the running bytecode.</td>
 570                         </tr>
 571                         <tr>
 572                             <td>-disasm</td>
 573                             <td>Dissasemble the bytecode into assembly.</td>
 574                         </tr>
 575                         <tr>
 576                             <td>-printdefs</td>
 577                             <td>Prints all definitions for the bytecode running.</td>
 578                         </tr>
 579                         <tr>
 580                             <td>-printfields</td>
 581                             <td>Prints all fields for the bytecode running.</td>
 582                         </tr>
 583                     </table>
 584
 585                     <h3>Builtins</h3>
 586                     The standalone virtual machine includes the following builtins.
 587                     <table border="0">
 588                         <tr>
 589                             <td>Builtin</td>
 590                             <td>Number</td>
 591                         </tr>
 592                             <tr><td>print</td><td>1</td></tr>
 593                             <tr><td>ftos</td><td>2</td></tr>
 594                             <tr><td>spawn</td><td>3</td></tr>
 595                             <tr><td>kill</td><td>4</td></tr>
 596                             <tr><td>vtos</td><td>5</td></tr>
 597                             <tr><td>error</td><td>6</td></tr>
 598                             <tr><td>vlen</td><td>7</td></tr>
 599                             <tr><td>etos</td><td>8</td></tr>
 600                     </table>
 601                 </p>
 602                 <h3>Support or Contact</h3>
 603                 <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>
 604             </section>
 605             <footer>
 606                 <script type="text/javascript" src="http://www.ohloh.net/p/602517/widgets/project_partner_badge.js"></script>
 607             </footer>
 608         </div>
 609         <!--[if !IE]><script>fixScale(document);</script><![endif]-->
 610     </body>
 611 </html>