1 .\" Process with groff -man -Tascii file.3
2 .TH GMQCC 1 2012-07-12 "" "gmqcc Manual"
4 gmqcc \- A Quake C compiler built from the NIH realm of sarcastic wit
7 [\fIOPTIONS\fR] [\fIfiles...\fR]
9 Traditionally, a QC compiler reads the file \fIprogs.src\fR which
10 in its first line contains the output filename, and the rest is a
11 list of QC source files that are to be compiled in order.
12 \fBgmqcc\fR optionally takes options to specify the output and
13 input files on the commandline, and also accepts assembly files.
15 \fBgmqcc\fR mostly tries to mimic gcc's commandline handling, though
16 there are also traditional long-options available.
19 Show a usage message and exit.
22 Turn on some compiler debugging mechanisms.
25 Turn on compiler mem-check. (Shows allocations and checks for leaks.)
27 .BI "-o, --output=" filename
28 Specify the output filename. Defaults to progs.dat. This will overwrite
29 the output file listed in a \fIprogs.src\fR file in case such a file is used.
32 Specify the optimization level
35 Highest optimization level
37 Default optimization level
39 Minimal optimization level
41 Disable optimization entirely
44 .BI "-O" name "\fR, " "" -Ono- name
45 Enable or disable a specific optimization. Note that these options
46 must be used after setting the optimization level, otherwise they'll
50 List all possible optimizations and the optimization level they're
54 Be less verbose. In particular removes the messages about which files
55 are being processed, and which compilation mode is being used, and
56 some others. Warnings and errors will of course still be displayed.
58 .BI -W warning "\fR, " "" -Wno- warning
59 Enable or disable a warning.
62 Enable almost all warnings. Overrides preceding -W parameters.
64 The following warnings will \fBnot\fR be anbled:
67 -Wuninitialized-global
71 .BR -Werror ", " -Wno-error
72 Controls whether or not all warnings should be treated as errors.
74 .BI -Werror- warning "\fR, " "" -Wno-error- warning
75 Controls whether a specific warning should be an error.
78 List all possible warn flags.
80 .BI -f flag "\fR, " "" -fno- flag
81 Enable or disable a specific compile flag. See the list of flags
85 List all possible compile flags.
88 Disables colored output
91 Use an ini file to read all the -O, -W and -f flag from. See the
92 CONFIG section about the file format.
95 Redirects standard output to a \fIfile\fR
98 Redirects standard error to a \fIfile\fR
101 Use the specified standard for parsing QC code. The following standards
103 .IR gmqcc , qcc , fteqcc
104 Selecting a standard also implies some -f options and behaves as if
105 those options have been written right after the -std option, meaning
106 if you changed them before the -std option, you're now overwriting
109 .BR -std=gmqcc " includes:"
112 -fadjust-vector-fields
116 -finitialized-nonconstants
117 -ftranslatable-strings
118 -f\fIno-\fRfalse-empty-strings
119 -Winvalid-parameter-count
120 -Wmissing-returnvalues
121 -fcorrect-ternary (cannot be turned off)
125 .BR -std=qcc " includes:"
128 -fassign-function-types
129 -f\fIno-\fRadjust-vector-fields
133 .BR -std=fteqcc " includes:"
137 -ftranslatable-strings
138 -fassign-function-types
140 -f\fIno-\fRadjust-vector-fields
141 -f\fIno-\fRcorrect-ternary
146 DEBUG OPTION. Print the code's intermediate representation before the
147 optimization and finalization passes to stdout before generating the
151 DEBUG OPTION. Print the code's intermediate representation after the
152 optimization and finalization passes to stdout before generating the
153 binary. The instructions will be enumerated, and values will contain a
158 Generate a warning about variables which are declared but never used.
159 This can be avoided by adding the \fInoref\fR keyword in front of the
160 variable declaration. Additionally a complete section of unreferenced
161 variables can be opened using \fI#pragma noref 1\fR, and closed via
162 \fI#pragma noref 0\fR.
164 .B -Wused-uninitialized
165 Generate a warning if it is possible that a variable can be used
166 without prior initialization. Note that this warning is not
167 necessarily reliable if the initialization happens only under certain
168 conditions. The other way is \fInot\fR possible: that the warning is
169 \fInot\fR generated when uninitialized use \fIis possible\fR.
171 .B -Wunknown-control-sequence
172 Generate an error when an unrecognized control sequence in a string is
173 used. Meaning: when there's a character after a backslash in a string
174 which has no known meaning.
177 Warn when using special extensions which are not part of the selected
180 .B -Wfield-redeclared
181 Generally QC compilers ignore redeclaration of fields. Here you can
182 optionally enable a warning.
184 .B -Wmissing-return-values
185 Functions which aren't of type \fIvoid\fR will warn if it possible to
186 reach the end without returning an actual value.
188 .B -Winvalid-parameter-count
189 Warn about a function call with an invalid number of parameters.
192 Warn when a locally declared variable shadows variable.
195 Warn when the initialization of a local variable turns the variable
196 into a constant. This is default behaviour unless
197 \fI-finitialized-nonconstants\fR is used.
200 There are only 2 known global variables of type void: end_sys_globals
201 and end_sys_fields. Any other void-variable will warn.
203 .B -Wimplicit-function-pointer
204 A global function which is not declared with the \fIvar\fR keyword is
205 expected to have an implementing body, or be a builtin. If neither is
206 the case, it implicitly becomes a function pointer, and a warning is
209 .B -Wvariadic-function
210 Currently there's no way for an in QC implemented function to access
211 variadic parameters. If a function with variadic parameters has an
212 implementing body, a warning will be generated.
215 Generate warnings about \fI$frame\fR commands, for instance about
216 duplicate frame definitions.
218 .B -Weffectless-statement
219 Warn about statements which have no effect. Any expression which does
220 not call a function or assigns a variable.
223 The \fIend_sys_fields\fR variable is supposed to be a global variable
224 of type \fIvoid\fR. It is also recognized as a \fIfield\fR but this
225 will generate a warning.
227 .B -Wassign-function-types
228 Warn when assigning to a function pointer with an unmatching
229 signature. This usually happens in cases like assigning the null
230 function to an entity's .think function pointer.
233 Enable warnings coming from the preprocessor. Like duplicate macro
234 declarations. This warning triggers when there's a problem with the
235 way the preprocessor has been used, it will \fBnot\fR affect warnings
236 generated with the '#warning' directive. See -Wcpp.
239 Show warnings created using the preprocessor's '#warning' directive.
242 Warn if there's a preprocessor \fI#if\fR spanning across several
245 .B -Wdouble-declaration
246 Warn about multiple declarations of globals. This seems pretty common
247 in QC code so you probably do not want this unless you want to clean
251 The combination of \fIconst\fR and \fIvar\fR is not illegal, however
252 different compilers may handle them differently. We were told, the
253 intention is to create a function-pointer which is not assignable.
254 This is exactly how we interpret it. However for this interpretation
255 the \fIvar\fR keyword is considered superfluous (and philosophically
256 wrong), so it is possible to generate a warning about this.
258 .B -Wmultibyte-character
259 Warn about multibyte character constants, they do not work right now.
261 .B -Wternary-precedence
262 Warn if a ternary expression which contains a comma operator is used
263 without enclosing parenthesis, since this is most likely not what you
264 actually want. We recommend the \fI-fcorrect-ternary\fR option.
267 Warn when encountering an unrecognized \fI#pragma\fR line.
269 .B -Wunreachable-code
270 Warn about unreachable code. That is: code after a return statement,
271 or code after a call to a function marked as 'noreturn'.
274 Enable some warnings added in order to help debugging in the compiler.
276 .B -Wunknown-attribute
277 Warn on an unknown attribute. The warning will inlclude only the first
278 token inside the enclosing attribute-brackets. This may change when
279 the actual attribute syntax is better defined.
282 Warn when using reserved names such as 'nil'.
284 .B -Wuninitialized-constant
285 Warn about global constants (using the 'const' keyword) with no
288 .B -Wuninitialized-global
289 Warn about global variables with no initializing value. This is off by
290 default, and is added mostly to help find null-values which are
291 supposed to be replaced by the untyped 'nil' constant.
293 .B -Wdifferent-qualifiers
294 Warn when a variables is redeclared with a different qualifier. For
295 example when redeclaring a variable as \'var\' which was previously
298 .B -Wdifferent-attributes
299 Similar to the above but for attributes like "[[noreturn]]".
302 Warn when a function is marked with the attribute
303 "[[deprecated]]". This flag enables a warning on calls to functions
307 Warn about possible mistakes caused by missing or wrong parenthesis,
308 like an assignment in an 'if' condition when there's no additional set
309 of parens around the assignment.
312 .B -fdarkplaces-string-table-bug
313 Add some additional characters to the string table in order to
314 compensate for a wrong boundcheck in some specific version of the
317 .B -fadjust-vector-fields
318 When assigning to field pointers of type \fI.vector\fR the common
319 behaviour in compilers like \fIfteqcc\fR is to only assign the
320 x-component of the pointer. This means that you can use the vector as
321 such, but you cannot use its y and z components directly. This flag
322 fixes this behaviour. Before using it make sure your code does not
323 depend on the buggy behaviour.
326 Enable a partially fteqcc-compatible preprocessor. It supports all the
327 features used in the Xonotic codebase. If you need more, write a
331 Enable some predefined macros. This only works in combination with
332 \'-fftepp' and is currently not included by '-std=fteqcc'. The
333 following macros will be added:
344 Note that fteqcc also defines __FUNC__, __TIME__, __DATE__ and
345 __NULL__, which are not yet implemented.
348 Allow switch cases to use non constant variables.
351 Perform early out in logical AND and OR expressions. The final result
352 will be either a 0 or a 1, see the next flag for more possibilities.
355 In many languages, logical expressions perform early out in a special
356 way: If the left operand of an AND yeilds true, or the one of an OR
357 yields false, the complete expression evaluates to the right side.
358 Thus \fItrue && 5\fI evaluates to 5 rather than 1.
360 .B -ftranslatable-strings
361 Enable the underscore intrinsic: Using \fI_("A string constant")\fR
362 will cause the string immediate to get a name with a "dotranslate_"
363 prefix. The darkplaces engine recognizes these and translates them in
364 a way similar to how gettext works.
366 .B -finitialized-nonconstants
367 Don't implicitly convert initialized variables to constants. With this
368 flag, the \fIconst\fR keyword is required to make a constant.
370 .B -fassign-function-types
371 If this flag is not set, (and it is set by default in the qcc and
372 fteqcc standards), assigning function pointers of mismatching
373 signatures will result in an error rather than a warning.
376 Produce a linenumber file along with the output .dat file.
379 Use C's operator precedence for ternary expressions. Unless your code
380 depends on fteqcc-compatible behaviour, you'll want to use thi
383 .B -fsingle-vector-defs
384 Normally vectors generate 4 defs, once for the vector, and once for
385 its components with _x, _y, _z suffixes. This option
386 prevents components from being listed.
389 Most QC compilers translate if(a_vector) directly as an IF on the
390 vector, which means only the x-component is checked. This causes
391 vectors to be cast to actual booleans via a NOT_V and, if necessary, a
395 if (a_vector) // becomes
398 a = a_vector && a_float // becomes
399 a = !!a_vector && a_float
403 .B -ftrue-empty-strings
404 An empty string is considered to be true everywhere. The NOT_S
405 instruction usually considers an empty string to be false, this option
406 effectively causes the unary not in strings to use NOT_F instead.
408 .B -ffalse-empty-strings
409 An empty string is considered to be false everywhere. This means loops
410 and if statements which depend on a string will perform a NOT_S
411 instruction on the string before using it.
414 Enable utf8 characters. This allows utf-8 encoded character constants,
415 and escape sequence codepoints in the valid utf-8 range. Effectively
416 enabling escape sequences like '\\{x2211}'.
419 When a warning is treated as an error, and this option is set (which
420 it is by default), it is like any other error and will cause
421 compilation to stop. When disabling this flag by using
422 \-fno-bail-on-werror, compilation will continue until the end, but no
423 output is generated. Instead the first such error message's context is
427 Allow loops to be labeled, and allow 'break' and 'continue' to take an
428 optional label to decide which loop to actually jump out of or
433 for :outer (i = 0; i < n; ++i) {
444 Adds a global named 'nil' which is of no type and can be assigned to
445 anything. No typechecking will be performed on assignments. Assigning
446 to it is forbidden, using it in any other kind of expression is also
450 Various effects, usually to weaken some conditions.
452 .IP "with -funtyped-nil"
453 Allow local variables named 'nil'. (This will not allow declaring a
454 global of that name.)
458 Some general peephole optimizations. For instance the code `a = b + c`
459 typically generates 2 instructions, an ADD and a STORE. This
460 optimization removes the STORE and lets the ADD write directly into A.
463 Tail recursive function calls will be turned into loops to avoid the
464 overhead of the CALL and RETURN instructions.
467 Make all functions which use neither local arrays nor have locals
468 which are seen as possibly uninitialized use the same local section.
469 This should be pretty safe compared to other compilers which do not
470 check for uninitialized values properly. The problem is that there's
471 QC code out there which really doesn't initialize some values. This is
472 fine as long as this kind of optimization isn't used, but also, only
473 as long as the functions cannot be called in a recursive manner. Since
474 it's hard to know whether or not an array is actually fully
475 initialized, especially when initializing it via a loop, we assume
476 functions with arrays to be too dangerous for this optimization.
479 This promotes locally declared variables to "temps". Meaning when a
480 temporary result of an operation has to be stored somewhere, a local
481 variable which is not 'alive' at that point can be used to keep the
482 result. This can reduce the size of the global section.
483 This will not have declared variables overlap, even if it was
487 Causes temporary values which do not need to be backed up on a CALL to
488 not be stored in the function's locals-area. With this, a CALL to a
489 function may need to back up fewer values and thus execute faster.
491 .B -Ostrip-constant-names
492 Don't generate defs for immediate values or even declared constants.
493 Meaning variables which are implicitly constant or qualified as such
494 using the 'const' keyword.
497 Aggressively reuse strings in the string section. When a string should
498 be added which is the trailing substring of an already existing
499 string, the existing string's tail will be returned instead of the new
502 For example the following code will only generate 1 string:
506 print("Hell you!\\n");
507 print("you!\\n"); // trailing substring of "Hello you!\\n"
510 There's however one limitation. Strings are still processed in order,
511 so if the above print statements were reversed, this optimization
515 By default, all parameters of a CALL are copied into the
516 parameter-globals right before the CALL instructions. This is the
517 easiest and safest way to translate calls, but also adds a lot of
518 unnecessary copying and unnecessary temporary values. This
519 optimization makes operations which are used as a parameter evaluate
520 directly into the parameter-global if that is possible, which is when
521 there's no other CALL instruction in between.
524 Usually an empty RETURN instruction is added to the end of a void
525 typed function. However, additionally after every function a DONE
526 instruction is added for several reasons. (For example the qcvm's
527 disassemble switch uses it to know when the function ends.). This
528 optimization replaces that last RETURN with DONE rather than adding
529 the DONE additionally.
531 .B -Ovector-components
532 Because traditional QC code doesn't allow you to access individual
533 vector components of a computed vector without storing it in a local
534 first, sometimes people multiply it by a constant like '0 1 0' to get,
535 in this case, the y component of a vector. This optimization will turn
536 such a multiplication into a direct component access. If the factor is
537 anything other than 1, a float-multiplication will be added, which is
538 still faster than a vector multiplication.
540 The configuration file is similar to regular .ini files. Comments
541 start with hashtags or semicolons, sections are written in square
542 brackets and in each section there can be arbitrary many key-value
545 There are 3 sections currently:
546 .IR flags ", " warnings ", and " optimizations .
547 They contain a list of boolean values of the form `VARNAME = true` or
548 `VARNAME = false`. The variable names are the same as for the
549 corresponding -W, -f or -O flag written with only capital letters and
550 dashes replaced by underscores.
555 # a GMQCC configuration file
558 ADJUST_VECTOR_FIELDS = false
562 UNUSED_VARIABLE = false
563 USED_UNINITIALIZED = true
567 TAIL_RECURSION = true
571 Currently the '-fftepp-predefs' flag is not included by '-std=fteqcc',
572 partially because it is not entirely conformant to fteqcc.
575 Please report bugs on <http://github.com/graphitemaster/gmqcc/issues>,
576 or see <http://graphitemaster.github.com/gmqcc> on how to contact us.
580 A documented example for a gmqcc.ini file.
584 See <http://graphitemaster.github.com/gmqcc>.
projects / xonotic / gmqcc.git / blob