7 .Nd A Quake C compiler built from the NIH realm of sarcastic wit
13 Traditionally, a QC compiler reads the file
15 which in its first line contains the output filename, and the rest is a
16 list of QC source files that are to be compiled in order.
18 optionally takes options to specify the output and
19 input files on the commandline, and also accepts assembly files.
22 mostly tries to mimic gcc's commandline handling, though
23 there are also traditional long-options available.
26 Show a usage message and exit.
28 Turn on some compiler debugging mechanisms.
30 Turn on compiler mem-check. (Shows allocations and checks for leaks.)
31 .It Fl o , Fl -output= Ns Ar filename
32 Specify the output filename. Defaults to progs.dat. This will overwrite
33 the output file listed in a
35 file in case such a file is used.
36 .Bl -tag -width indent
38 Specify the optimization level
40 Highest optimization level
42 Default optimization level
44 Minimal optimization level
46 Disable optimization entirely
49 .It Fl O Ns Ar name Fl Ono- Ns Ar name
50 Enable or disable a specific optimization. Note that these options
51 must be used after setting the optimization level, otherwise they'll
54 List all possible optimizations and the optimization level they're
57 Be less verbose. In particular removes the messages about which files
58 are being processed, and which compilation mode is being used, and
59 some others. Warnings and errors will of course still be displayed.
61 Run only the preprocessor as if
63 was used and print the preprocessed code to stdout.
64 .It Fl W Ns Ar warning , Fl Wno- Ns Ar warning
65 Enable or disable a warning.
67 Enable almost all warnings. Overrides preceding
71 The following warnings will
74 .Bl -tag -width indent -offset indent
75 .It Fl W Ns Cm uninitialized-global
77 .It Fl W Ns Cm error , Fl Wno- Ns Cm error
78 Controls whether or not all warnings should be treated as errors.
79 .It Fl Werror- Ns Ar warning , Fl Wno-error- Ns Ar warning
80 Controls whether a specific warning should be an error.
82 List all possible warn flags.
83 .It Fl f Ns Ar flag , Fl fno- Ns Ar flag
84 Enable or disable a specific compile flag. See the list of flags
87 List all possible compile flags.
89 Disables colored output
90 .It Fl config= Ns Ar file
91 Use an ini file to read all the
97 section about the file format.
98 .It Fl redirout= Ns Ar file
99 Redirects standard output to a
101 .It Fl redirerr= Ns Ar file
102 Redirects standard error to a
104 .It Fl std= Ns Ar standard
105 Use the specified standard for parsing QC code. The following standards
107 .Ar gmqcc , Ar qcc , Ar fteqcc
108 Selecting a standard also implies some
110 options and behaves as if
111 those options have been written right after the
114 if you changed them before the
116 option, you're now overwriting them.
118 .Fl std= Ns Cm gmqcc No includes:
119 .Bl -tag -width indent -compact -offset Ds
120 .It Fl f Ns Cm adjust-vector-fields
121 .It Fl f Ns Cm correct-logic
122 .It Fl f Ns Cm true-empty-strings
123 .It Fl f Ns Cm loop-labels
124 .It Fl f Ns Cm initialized-nonconstants
125 .It Fl f Ns Cm translatable-strings
126 .It Fl fno- Ns Cm false-empty-strings
127 .It Fl W Ns Cm invalid-parameter-count
128 .It Fl W Ns Cm missing-returnvalues
129 .It Fl f Ns Cm correct-ternary Li (cannot be turned off)
132 .Fl std= Ns Cm qcc No includes:
133 .Bl -tag -width indent -compact -offset Ds
134 .It Fl f Ns Cm assign-function-types
135 .It Fl fIno- Ns Cm adjust-vector-fields
138 .Fl std= Ns Cm fteqcc No includes:
139 .Bl -tag -width indent -compact -offset Ds
141 .It Fl f Ns Cm translatable-strings
142 .It Fl f Ns Cm assign-function-types
143 .It Fl W Ns Cm ternary-precedence
144 .It Fl fno- Ns Cm adjust-vector-fields
145 .It Fl fno- Ns Cm correct-ternary
148 Adds compiler information to the generated binary file. Currently
149 this includes the following globals:
150 .Bl -tag -width indent -compact
151 .It Li reserved:version
152 String containing the compiler version as printed by the --version
155 .It Fl -correct , Fl -no-correct
156 When enabled, errors about undefined values try to suggest an existing
157 value via spell checking.
159 DEBUG OPTION. Print the code's intermediate representation before the
160 optimization and finalization passes to stdout before generating the
163 DEBUG OPTION. Print the code's intermediate representation after the
164 optimization and finalization passes to stdout before generating the
165 binary. The instructions will be enumerated, and values will contain a
170 .It Fl W Ns Cm unused-variable
171 Generate a warning about variables which are declared but never used.
172 This can be avoided by adding the
174 keyword in front of the
175 variable declaration. Additionally a complete section of unreferenced
176 variables can be opened using
179 .Ql #pragma noref 0 Ns .
180 .It Fl W Ns Cm used-uninitialized
181 Generate a warning if it is possible that a variable can be used
182 without prior initialization. Note that this warning is not
183 necessarily reliable if the initialization happens only under certain
184 conditions. The other way is
186 possible: that the warning is
188 generated when uninitialized use
191 .It Fl W Ns Cm unknown-control-sequence
192 Generate an error when an unrecognized control sequence in a string is
193 used. Meaning: when there's a character after a backslash in a string
194 which has no known meaning.
195 .It Fl W Ns Cm extensions
196 Warn when using special extensions which are not part of the selected
198 .It Fl W Ns Cm field-redeclared
199 Generally QC compilers ignore redeclaration of fields. Here you can
200 optionally enable a warning.
201 .It Fl W Ns Cm missing-return-values
202 Functions which aren't of type
204 will warn if it possible to
205 reach the end without returning an actual value.
206 .It Fl W Ns Cm invalid-parameter-count
207 Warn about a function call with an invalid number of parameters.
208 .It Fl W Ns Cm local-shadows
209 Warn when a locally declared variable shadows variable.
210 .It Fl W Ns Cm local-constants
211 Warn when the initialization of a local variable turns the variable
212 into a constant. This is default behaviour unless
213 .Fl f Ns Cm initialized-nonconstants
215 .It Fl W Ns Cm void-variables
216 There are only 2 known global variables of type void:
219 .Ql end_sys_fields Ns .
220 Any other void-variable will warn.
221 .It Fl W Ns Cm implicit-function-pointer
222 A global function which is not declared with the
225 expected to have an implementing body, or be a builtin. If neither is
226 the case, it implicitly becomes a function pointer, and a warning is
228 .It Fl W Ns Cm variadic-function
229 Currently there's no way for an in QC implemented function to access
230 variadic parameters. If a function with variadic parameters has an
231 implementing body, a warning will be generated.
232 .It Fl W Ns Cm frame-macros
233 Generate warnings about
235 commands, for instance about
236 duplicate frame definitions.
237 .It Fl W Ns Cm effectless-statement
238 Warn about statements which have no effect. Any expression which does
239 not call a function or assigns a variable.
240 .It Fl W Ns Cm end-sys-fields
243 variable is supposed to be a global variable
246 It is also recognized as a \fIfield\fR but this
247 will generate a warning.
248 .It Fl W Ns Cm assign-function-types
249 Warn when assigning to a function pointer with an unmatching
250 signature. This usually happens in cases like assigning the null
251 function to an entity's .think function pointer.
252 .It Fl W Ns Cm preprocessor
253 Enable warnings coming from the preprocessor. Like duplicate macro
254 declarations. This warning triggers when there's a problem with the
255 way the preprocessor has been used, it will \fBnot\fR affect warnings
256 generated with the '#warning' directive. See -Wcpp.
258 Show warnings created using the preprocessor's '#warning' directive.
259 .It Fl W Ns Cm multifile-if
260 Warn if there's a preprocessor \fI#if\fR spanning across several
262 .It Fl W Ns Cm double-declaration
263 Warn about multiple declarations of globals. This seems pretty common
264 in QC code so you probably do not want this unless you want to clean
266 .It Fl W Ns Cm const-var
267 The combination of \fIconst\fR and \fIvar\fR is not illegal, however
268 different compilers may handle them differently. We were told, the
269 intention is to create a function-pointer which is not assignable.
270 This is exactly how we interpret it. However for this interpretation
273 keyword is considered superfluous (and philosophically
274 wrong), so it is possible to generate a warning about this.
275 .It Fl W Ns Cm multibyte-character
276 Warn about multibyte character constants, they do not work right now.
277 .It Fl W Ns Cm ternary-precedence
278 Warn if a ternary expression which contains a comma operator is used
279 without enclosing parenthesis, since this is most likely not what you
280 actually want. We recommend the
281 .Fl f Ns Cm correct-ternary
283 .It Fl W Ns Cm unknown-pragmas
284 Warn when encountering an unrecognized
287 .It Fl W Ns Cm unreachable-code
288 Warn about unreachable code. That is: code after a return statement,
289 or code after a call to a function marked as 'noreturn'.
291 Enable some warnings added in order to help debugging in the compiler.
293 .It Fl W Ns Cm unknown-attribute
294 Warn on an unknown attribute. The warning will inlclude only the first
295 token inside the enclosing attribute-brackets. This may change when
296 the actual attribute syntax is better defined.
297 .It Fl W Ns Cm reserved-names
298 Warn when using reserved names such as
300 .It Fl W Ns Cm uninitialized-constant
301 Warn about global constants (using the
305 .It Fl W Ns Cm uninitialized-global
306 Warn about global variables with no initializing value. This is off by
307 default, and is added mostly to help find null-values which are
308 supposed to be replaced by the untyped 'nil' constant.
309 .It Fl W Ns Cm different-qualifiers
310 Warn when a variables is redeclared with a different qualifier. For
311 example when redeclaring a variable as \'var\' which was previously
313 .It Fl W Ns Cm different-attributes
314 Similar to the above but for attributes like
315 .Ql [[noreturn]] Ns .
316 .It Fl W Ns Cm deprecated
317 Warn when a function is marked with the attribute
318 "[[deprecated]]". This flag enables a warning on calls to functions
320 .It Fl W Ns Cm parenthesis
321 Warn about possible mistakes caused by missing or wrong parenthesis,
322 like an assignment in an 'if' condition when there's no additional set
323 of parens around the assignment.
327 .It Fl f Ns Cm darkplaces-string-table-bug
328 Add some additional characters to the string table in order to
329 compensate for a wrong boundcheck in some specific version of the
331 .It Fl f Ns Cm adjust-vector-fields
332 When assigning to field pointers of type \fI.vector\fR the common
333 behaviour in compilers like \fIfteqcc\fR is to only assign the
334 x-component of the pointer. This means that you can use the vector as
335 such, but you cannot use its y and z components directly. This flag
336 fixes this behaviour. Before using it make sure your code does not
337 depend on the buggy behaviour.
339 Enable a partially fteqcc-compatible preprocessor. It supports all the
340 features used in the Xonotic codebase. If you need more, write a
342 .It Fl f Ns Cm ftepp-predefs
343 Enable some predefined macros. This only works in combination with
344 \'-fftepp' and is currently not included by '-std=fteqcc'. The
345 following macros will be added:
346 .Bd -literal -offset indent
357 Note that fteqcc also defines
359 which is not implemented yet.
361 .Fl f Ns Cm untyped-nil
362 about gmqcc's alternative to
364 .It Fl f Ns Cm relaxed-switch
365 Allow switch cases to use non constant variables.
366 .It Fl f Ns Cm short-logic
367 Perform early out in logical AND and OR expressions. The final result
368 will be either a 0 or a 1, see the next flag for more possibilities.
369 .It Fl f Ns Cm perl-logic
370 In many languages, logical expressions perform early out in a special
371 way: If the left operand of an AND yeilds true, or the one of an OR
372 yields false, the complete expression evaluates to the right side.
375 evaluates to 5 rather than 1.
376 .It Fl f Ns Cm translatable-strings
377 Enable the underscore intrinsic: Using
378 .Ql _("A string constant")
379 will cause the string immediate to get a name with a "dotranslate_"
380 prefix. The darkplaces engine recognizes these and translates them in
381 a way similar to how gettext works.
382 .It Fl f Ns Cm initialized-nonconstants
383 Don't implicitly convert initialized variables to constants. With this
384 flag, the \fIconst\fR keyword is required to make a constant.
385 .It Fl f Ns Cm assign-function-types
386 If this flag is not set, (and it is set by default in the qcc and
387 fteqcc standards), assigning function pointers of mismatching
388 signatures will result in an error rather than a warning.
390 Produce a linenumber file along with the output .dat file.
391 .It Fl f Ns Cm correct-ternary
392 Use C's operator precedence for ternary expressions. Unless your code
393 depends on fteqcc-compatible behaviour, you'll want to use thi
395 .It Fl f Ns Cm single-vector-defs
396 Normally vectors generate 4 defs, once for the vector, and once for
397 its components with _x, _y, _z suffixes. This option
398 prevents components from being listed.
399 .It Fl f Ns Cm correct-logic
400 Most QC compilers translate
402 directly as an IF on the
403 vector, which means only the x-component is checked. This option causes
404 vectors to be cast to actual booleans via a NOT_V and, if necessary, a
406 .Bd -literal -offset indent
407 if (a_vector) // becomes
410 a = a_vector && a_float // becomes
411 a = !!a_vector && a_float
413 .It Fl f Ns Cm true-empty-strings
414 An empty string is considered to be true everywhere. The NOT_S
415 instruction usually considers an empty string to be false, this option
416 effectively causes the unary not in strings to use NOT_F instead.
417 .It Fl f Ns Cm false-empty-strings
418 An empty string is considered to be false everywhere. This means loops
419 and if statements which depend on a string will perform a NOT_S
420 instruction on the string before using it.
422 Enable utf8 characters. This allows utf-8 encoded character constants,
423 and escape sequence codepoints in the valid utf-8 range. Effectively
424 enabling escape sequences like '\\{x2211}'.
425 .It Fl f Ns Cm bail-on-werror
426 When a warning is treated as an error, and this option is set (which
427 it is by default), it is like any other error and will cause
428 compilation to stop. When disabling this flag by using
429 \-fno-bail-on-werror, compilation will continue until the end, but no
430 output is generated. Instead the first such error message's context is
432 .It Fl f Ns Cm loop-labels
433 Allow loops to be labeled, and allow 'break' and 'continue' to take an
434 optional label to decide which loop to actually jump out of or
436 .Bd -literal -offset indent
437 for :outer (i = 0; i < n; ++i) {
445 .It Fl f Ns Cm untyped-nil
446 Adds a global named 'nil' which is of no type and can be assigned to
447 anything. No typechecking will be performed on assignments. Assigning
448 to it is forbidden, using it in any other kind of expression is also
451 Note that this is different from fteqcc's __NULL__: In fteqcc,
452 __NULL__ maps to the integer written as '0i'. It's can be assigned to
453 function pointers and integers, but it'll error about invalid
454 instructions when assigning it to floats without enabling the FTE
455 instruction set. There's also a bug which allows it to be assigned to
456 vectors, for which the source will be the global at offset 0, meaning
457 the vector's y and z components will contain the OFS_RETURN x and y
460 In that gmqcc the nil global is an actual global filled with zeroes,
461 and can be assigned to anything including fields, vectors or function
462 pointers, and they end up becoming zeroed.
463 .It Fl f Ns Cm permissive
464 Various effects, usually to weaken some conditions.
465 .Bl -tag -width indent -offset indent
466 .It with Fl f Ns Cm untyped-nil
467 Allow local variables named
469 (This will not allow declaring a global of that name.)
471 .It Fl f Ns Cm variadic-args
472 Allow variadic parameters to be accessed by QC code. This can be
473 achieved via the '...' function, which takes a parameter index and a
477 .Bd -literal -offset indent
478 void vafunc(string...count) {
480 for (i = 0; i < count; ++i)
481 print(...(i, string), "\\n");
484 .It Fl f Ns Cm legacy-vector-maths
485 Most Quake VMs, including the one from FTEQW or up till recently
486 Darkplaces, do not cope well with vector instructions with overlapping
487 input and output. This option will avoid producing such code.
491 .It Fl O Ns Cm peephole
492 Some general peephole optimizations. For instance the code `a = b + c`
493 typically generates 2 instructions, an ADD and a STORE. This
494 optimization removes the STORE and lets the ADD write directly into A.
495 .It Fl O Ns Cm tail-recursion
496 Tail recursive function calls will be turned into loops to avoid the
497 overhead of the CALL and RETURN instructions.
498 .It Fl O Ns Cm overlap-locals
499 Make all functions which use neither local arrays nor have locals
500 which are seen as possibly uninitialized use the same local section.
501 This should be pretty safe compared to other compilers which do not
502 check for uninitialized values properly. The problem is that there's
503 QC code out there which really doesn't initialize some values. This is
504 fine as long as this kind of optimization isn't used, but also, only
505 as long as the functions cannot be called in a recursive manner. Since
506 it's hard to know whether or not an array is actually fully
507 initialized, especially when initializing it via a loop, we assume
508 functions with arrays to be too dangerous for this optimization.
509 .It Fl O Ns Cm local-temps
510 This promotes locally declared variables to "temps". Meaning when a
511 temporary result of an operation has to be stored somewhere, a local
512 variable which is not 'alive' at that point can be used to keep the
513 result. This can reduce the size of the global section.
514 This will not have declared variables overlap, even if it was
516 .It Fl O Ns Cm global-temps
517 Causes temporary values which do not need to be backed up on a CALL to
518 not be stored in the function's locals-area. With this, a CALL to a
519 function may need to back up fewer values and thus execute faster.
520 .It Fl O Ns Cm strip-constant-names
521 Don't generate defs for immediate values or even declared constants.
522 Meaning variables which are implicitly constant or qualified as such
523 using the 'const' keyword.
524 .It Fl O Ns Cm overlap-strings
525 Aggressively reuse strings in the string section. When a string should
526 be added which is the trailing substring of an already existing
527 string, the existing string's tail will be returned instead of the new
530 For example the following code will only generate 1 string:
531 .Bd -literal -offset indent
532 print("Hell you!\\n");
533 print("you!\\n"); // trailing substring of "Hello you!\\n"
536 There's however one limitation. Strings are still processed in order,
537 so if the above print statements were reversed, this optimization
539 .It Fl O Ns Cm call-stores
540 By default, all parameters of a CALL are copied into the
541 parameter-globals right before the CALL instructions. This is the
542 easiest and safest way to translate calls, but also adds a lot of
543 unnecessary copying and unnecessary temporary values. This
544 optimization makes operations which are used as a parameter evaluate
545 directly into the parameter-global if that is possible, which is when
546 there's no other CALL instruction in between.
547 .It Fl O Ns Cm void-return
548 Usually an empty RETURN instruction is added to the end of a void
549 typed function. However, additionally after every function a DONE
550 instruction is added for several reasons. (For example the qcvm's
551 disassemble switch uses it to know when the function ends.). This
552 optimization replaces that last RETURN with DONE rather than adding
553 the DONE additionally.
554 .It Fl O Ns Cm vector-components
555 Because traditional QC code doesn't allow you to access individual
556 vector components of a computed vector without storing it in a local
557 first, sometimes people multiply it by a constant like
560 in this case, the y component of a vector. This optimization will turn
561 such a multiplication into a direct component access. If the factor is
562 anything other than 1, a float-multiplication will be added, which is
563 still faster than a vector multiplication.
566 The configuration file is similar to regular .ini files. Comments
567 start with hashtags or semicolons, sections are written in square
568 brackets and in each section there can be arbitrary many key-value
571 There are 3 sections currently:
574 .Ql optimizations Ns .
575 They contain a list of boolean values of the form
578 .Ql VARNAME = false Ns .
579 The variable names are the same as for the
584 flag written with only capital letters and
585 dashes replaced by underscores.
588 .Bd -literal -offset indent
589 # a GMQCC configuration file
592 ADJUST_VECTOR_FIELDS = false
596 UNUSED_VARIABLE = false
597 USED_UNINITIALIZED = true
601 TAIL_RECURSION = true
605 .It gmqcc.ini.example
606 A documented example for a gmqcc.ini file.
611 See <http://graphitemaster.github.com/gmqcc>.
613 Currently the '-fftepp-predefs' flag is not included by '-std=fteqcc',
614 partially because it is not entirely conformant to fteqcc.
616 Please report bugs on <http://github.com/graphitemaster/gmqcc/issues>,
617 or see <http://graphitemaster.github.com/gmqcc> on how to contact us.