Merge pull request #75 from matthiaskrgr/master
[xonotic/gmqcc.git] / doc / gmqcc.1
1 .\" Process with groff -man -Tascii file.3
2 .TH GMQCC 1 2012-07-12 "" "gmqcc Manual"
3 .SH NAME
4 gmqcc \- A Quake C compiler built from the NIH realm of sarcastic wit
5 .SH SYNOPSIS
6 .B gmqcc
7 [\fIOPTIONS\fR] [\fIfiles...\fR]
8 .SH DESCRIPTION
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.
14 .SH OPTIONS
15 \fBgmqcc\fR mostly tries to mimic gcc's commandline handling, though
16 there are also traditional long-options available.
17 .TP
18 .B "-h, --help"
19 Show a usage message and exit.
20 .TP
21 .B "-debug"
22 Turn on some compiler debugging mechanisms.
23 .TP
24 .B "-memchk"
25 Turn on compiler mem-check. (Shows allocations and checks for leaks.)
26 .TP
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.
30 .TP
31 .BI "-O" number
32 Specify the optimization level
33 .RS
34 .IP 3
35 Highest optimization level
36 .IP 2
37 Default optimization level
38 .IP 1
39 Minimal optimization level
40 .IP 0
41 Disable optimization entirely
42 .RE
43 .TP
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
47 be overwritten.
48 .TP
49 .B -Ohelp
50 List all possible optimizations and the optimization level they're
51 activated at.
52 .TP
53 .BR -q ", " --quiet
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.
57 .TP
58 .BI -W warning "\fR, " "" -Wno- warning
59 Enable or disable a warning.
60 .TP
61 .B -Wall
62 Enable all warnings. Overrides preceding -W parameters.
63 .TP
64 .BR -Werror ", " -Wno-error
65 Controls whether or not all warnings should be treated as errors.
66 .TP
67 .BI -Werror- warning "\fR, " "" -Wno-error- warning
68 Controls whether a specific warning should be an error.
69 .TP
70 .B -Whelp
71 List all possible warn flags.
72 .TP
73 .BI -f flag "\fR, " "" -fno- flag
74 Enable or disable a specific compile flag. See the list of flags
75 below.
76 .TP
77 .B -fhelp
78 List all possible compile flags.
79 .TP
80 .B -nocolor
81 Disables colored output
82 .TP
83 .BI -config= file
84 Use an ini file to read all the -O, -W and -f flag from. See the
85 CONFIG section about the file format.
86 .TP
87 .BI "-redirout=" file
88 Redirects standard output to a \fIfile\fR
89 .TP
90 .BI "-redirerr=" file
91 Redirects standard error to a \fIfile\fR
92 .TP
93 .BI "-std=" standard
94 Use the specified standard for parsing QC code. The following standards
95 are available:
96 .IR gmqcc , qcc , fteqcc
97 Selecting a standard also implies some -f options and behaves as if
98 those options have been written right after the -std option, meaning
99 if you changed them before the -std option, you're now overwriting
100 them.
101 .sp
102 .BR -std=gmqcc " includes:"
103 .in +4
104 -fadjust-vector-fields
105 .in
106 .BR -std=qcc " includes:"
107 .in +4
108 .nf
109 -fassign-function-types
110 -f\fIno-\fRadjust-vector-fields
111 .fi
112 .in
113 .BR -std=fteqcc " includes:"
114 .in +4
115 .nf
116 -fftepp
117 -ftranslatable-strings
118 -fassign-function-types
119 -Wternary-precedence
120 -f\fIno-\fRadjust-vector-fields
121 -f\fIno-\fRcorrect-ternary
122 .fi
123 .in
124 .TP
125 .B "-dump"
126 DEBUG OPTION. Print the code's intermediate representation before the
127 optimization and finalization passes to stdout before generating the
128 binary.
129 .TP
130 .B "-dumpfin"
131 DEBUG OPTION. Print the code's intermediate representation after the
132 optimization and finalization passes to stdout before generating the
133 binary. The instructions will be enumerated, and values will contain a
134 list of liferanges.
135 .SH COMPILE WARNINGS
136 .TP
137 .B -Wunused-variable
138 Generate a warning about variables which are declared but never used.
139 This can be avoided by adding the \fInoref\fR keyword in front of the
140 variable declaration. Additionally a complete section of unreferenced
141 variables can be opened using \fI#pragma noref 1\fR, and closed via
142 \fI#pragma noref 0\fR.
143 .TP
144 .B -Wused-uninitialized
145 Generate a warning if it is possible that a variable can be used
146 without prior initialization. Note that this warning is not
147 necessarily reliable if the initialization happens only under certain
148 conditions. The other way is \fInot\fR possible: that the warning is
149 \fInot\fR generated when uninitialized use \fIis possible\fR.
150 .TP
151 .B -Wunknown-control-sequence
152 Generate an error when an unrecognized control sequence in a string is
153 used. Meaning: when there's a character after a backslash in a string
154 which has no known meaning.
155 .TP
156 .B -Wextensions
157 Warn when using special extensions which are not part of the selected
158 standard.
159 .TP
160 .B -Wfield-redeclared
161 Generally QC compilers ignore redeclaration of fields. Here you can
162 optionally enable a warning.
163 .TP
164 .B -Wmissing-return-values
165 Functions which aren't of type \fIvoid\fR will warn if it possible to
166 reach the end without returning an actual value.
167 .TP
168 .B -Wtoo-few-parameters
169 Warn about a function call with fewer parameters than the function
170 expects.
171 .TP
172 .B -Wlocal-shadows
173 Warn when a locally declared variable shadows variable.
174 .TP
175 .B -Wlocal-constants
176 Warn when the initialization of a local variable turns the variable
177 into a constant. This is default behaviour unless
178 \fI-finitialized-nonconstants\fR is used.
179 .TP
180 .B -Wvoid-variables
181 There are only 2 known global variables of type void: end_sys_globals
182 and end_sys_fields. Any other void-variable will warn.
183 .TP
184 .B -Wimplicit-function-pointer
185 A global function which is not declared with the \fIvar\fR keyword is
186 expected to have an implementing body, or be a builtin. If neither is
187 the case, it implicitly becomes a function pointer, and a warning is
188 generated.
189 .TP
190 .B -Wvariadic-function
191 Currently there's no way for an in QC implemented function to access
192 variadic parameters. If a function with variadic parameters has an
193 implementing body, a warning will be generated.
194 .TP
195 .B -Wframe-macros
196 Generate warnings about \fI$frame\fR commands, for instance about
197 duplicate frame definitions.
198 .TP
199 .B -Weffectless-statement
200 Warn about statements which have no effect. Any expression which does
201 not call a function or assigns a variable.
202 .TP
203 .B -Wend-sys-fields
204 The \fIend_sys_fields\fR variable is supposed to be a global variable
205 of type \fIvoid\fR. It is also recognized as a \fIfield\fR but this
206 will generate a warning.
207 .TP
208 .B -Wassign-function-types
209 Warn when assigning to a function pointer with an unmatching
210 signature. This usually happens in cases like assigning the null
211 function to an entity's .think function pointer.
212 .TP
213 .B -Wpreprocessor
214 Enable warnings coming from the preprocessor. Like duplicate macro
215 declarations. This warning triggers when there's a problem with the
216 way the preprocessor has been used, it will \fBnot\fR affect warnings
217 generated with the '#warning' directive. See -Wcpp.
218 .TP
219 .B -Wcpp
220 Show warnings created using the preprocessor's '#warning' directive.
221 .TP
222 .B -Wmultifile-if
223 Warn if there's a preprocessor \fI#if\fR spanning across several
224 files.
225 .TP
226 .B -Wdouble-declaration
227 Warn about multiple declarations of globals. This seems pretty common
228 in QC code so you probably do not want this unless you want to clean
229 up your code.
230 .TP
231 .B -Wconst-var
232 The combination of \fIconst\fR and \fIvar\fR is not illegal, however
233 different compilers may handle them differently. We were told, the
234 intention is to create a function-pointer which is not assignable.
235 This is exactly how we interpret it. However for this interpretation
236 the \fIvar\fR keyword is considered superfluous (and philosophically
237 wrong), so it is possible to generate a warning about this.
238 .TP
239 .B -Wmultibyte-character
240 Warn about multibyte character constants, they do not work right now.
241 .TP
242 .B -Wternary-precedence
243 Warn if a ternary expression which contains a comma operator is used
244 without enclosing parenthesis, since this is most likely not what you
245 actually want. We recommend the \fI-fcorrect-ternary\fR option.
246 .TP
247 .B -Wunknown-pragmas
248 Warn when encountering an unrecognized \fI#pragma\fR line.
249 .TP
250 .B -Wunreachable-code
251 Warn about unreachable code. That is: code after a return statement,
252 or code after a call to a function marked as 'noreturn'.
253 .TP
254 .B -Wdebug
255 Enable some warnings added in order to help debugging in the compiler.
256 You won't need this.
257 .B -Wunknown-attribute
258 Warn on an unknown attribute. The warning will inlclude only the first
259 token inside the enclosing attribute-brackets. This may change when
260 the actual attribute syntax is better defined.
261 .SH COMPILE FLAGS
262 .TP
263 .B -fdarkplaces-string-table-bug
264 Add some additional characters to the string table in order to
265 compensate for a wrong boundcheck in some specific version of the
266 darkplaces engine.
267 .TP
268 .B -fadjust-vector-fields
269 When assigning to field pointers of type \fI.vector\fR the common
270 behaviour in compilers like \fIfteqcc\fR is to only assign the
271 x-component of the pointer. This means that you can use the vector as
272 such, but you cannot use its y and z components directly. This flag
273 fixes this behaviour. Before using it make sure your code does not
274 depend on the buggy behaviour.
275 .TP
276 .B -fftepp
277 Enable a partially fteqcc-compatible preprocessor. It supports all the
278 features used in the Xonotic codebase. If you need more, write a
279 ticket.
280 .TP
281 .B -fftepp-predefs
282 Enable some predefined macros. This only works in combination with
283 \'-fftepp' and is currently not included by '-std=fteqcc'. The
284 following macros will be added:
285 .in +4
286 .nf
287 __LINE__
288 __FILE__
289 __COUNTER__
290 __COUNTER_LAST__
291 __RANDOM__
292 __RANDOM_LAST__
293 .fi
294 .in
295 Note that fteqcc also defines __FUNC__, __TIME__, __DATE__ and
296 __NULL__, which are not yet implemented.
297 .TP
298 .B -frelaxed-switch
299 Allow switch cases to use non constant variables.
300 .TP
301 .B -fshort-logic
302 Perform early out in logical AND and OR expressions. The final result
303 will be either a 0 or a 1, see the next flag for more possibilities.
304 .TP
305 .B -fperl-logic
306 In many languages, logical expressions perform early out in a special
307 way: If the left operand of an AND yeilds true, or the one of an OR
308 yields false, the complete expression evaluates to the right side.
309 Thus \fItrue && 5\fI evaluates to 5 rather than 1.
310 .TP
311 .B -ftranslatable-strings
312 Enable the underscore intrinsic: Using \fI_("A string constant")\fR
313 will cause the string immediate to get a name with a "dotranslate_"
314 prefix. The darkplaces engine recognizes these and translates them in
315 a way similar to how gettext works.
316 .TP
317 .B -finitialized-nonconstants
318 Don't implicitly convert initialized variables to constants. With this
319 flag, the \fIconst\fR keyword is required to make a constant.
320 .TP
321 .B -fassign-function-types
322 If this flag is not set, (and it is set by default in the qcc and
323 fteqcc standards), assigning function pointers of mismatching
324 signatures will result in an error rather than a warning.
325 .TP
326 .B -flno
327 Produce a linenumber file along with the output .dat file.
328 .TP
329 .B -fcorrect-ternary
330 Use C's operator precedence for ternary expressions. Unless your code
331 depends on fteqcc-compatible behaviour, you'll want to use thi
332 soption.
333 .TP
334 .B -fsingle-vector-defs
335 Normally vectors generate 4 defs, once for the vector, and once for
336 its components with _x, _y, _z suffixes. This option
337 prevents components from being listed.
338 .TP
339 .B -fcorrect-logic
340 Most QC compilers translate if(a_vector) directly as an IF on the
341 vector, which means only the x-component is checked. This causes
342 vectors to be cast to actual booleans via a NOT_V and, if necessary, a
343 NOT_F chained to it.
344 .in +4
345 .nf
346 if (a_vector) // becomes
347 if not(!a_vector)
348 // likewise
349 a = a_vector && a_float // becomes
350 a = !!a_vector && a_float
351 .fi
352 .in
353 .TP
354 .B -ftrue-empty-strings
355 An empty string is considered to be true everywhere. The NOT_S
356 instruction usually considers an empty string to be false, this option
357 effectively causes the unary not in strings to use NOT_F instead.
358 .TP
359 .B -ffalse-empty-strings
360 An empty string is considered to be false everywhere. This means loops
361 and if statements which depend on a string will perform a NOT_S
362 instruction on the string before using it.
363 .TP
364 .B -futf8
365 Enable utf8 characters. This allows utf-8 encoded character constants,
366 and escape sequence codepoints in the valid utf-8 range. Effectively
367 enabling escape sequences like '\\{x2211}'.
368 .SH OPTIMIZATIONS
369 .TP
370 .B -Opeephole
371 Some general peephole optimizations. For instance the code `a = b + c`
372 typically generates 2 instructions, an ADD and a STORE. This
373 optimization removes the STORE and lets the ADD write directly into A.
374 .TP
375 .B -Otail-recursion
376 Tail recursive function calls will be turned into loops to avoid the
377 overhead of the CALL and RETURN instructions.
378 .TP
379 .B -Ooverlap-locals
380 Make all functions which use neither local arrays nor have locals
381 which are seen as possibly uninitialized use the same local section.
382 This should be pretty safe compared to other compilers which do not
383 check for uninitialized values properly. The problem is that there's
384 QC code out there which really doesn't initialize some values. This is
385 fine as long as this kind of optimization isn't used, but also, only
386 as long as the functions cannot be called in a recursive manner. Since
387 it's hard to know whether or not an array is actually fully
388 initialized, especially when initializing it via a loop, we assume
389 functions with arrays to be too dangerous for this optimization.
390 .TP
391 .B -Olocal-temps
392 This promotes locally declared variables to "temps". Meaning when a
393 temporary result of an operation has to be stored somewhere, a local
394 variable which is not 'alive' at that point can be used to keep the
395 result. This can reduce the size of the global section.
396 This will not have declared variables overlap, even if it was
397 possible.
398 .TP
399 .B -Oglobal-temps
400 Causes temporary values which do not need to be backed up on a CALL to
401 not be stored in the function's locals-area. With this, a CALL to a
402 function may need to back up fewer values and thus execute faster.
403 .TP
404 .B -Ostrip-constant-names
405 Don't generate defs for immediate values or even declared constants.
406 Meaning variables which are implicitly constant or qualified as such
407 using the 'const' keyword.
408 .TP
409 .B -Ooverlap-strings
410 Aggressively reuse strings in the string section. When a string should
411 be added which is the trailing substring of an already existing
412 string, the existing string's tail will be returned instead of the new
413 string being added.
414
415 For example the following code will only generate 1 string:
416
417 .in +4
418 .nf
419 print("Hell you!\\n");
420 print("you!\\n"); // trailing substring of "Hello you!\\n"
421 .fi
422 .in
423 There's however one limitation. Strings are still processed in order,
424 so if the above print statements were reversed, this optimization
425 would not happen.
426 .TP
427 .B -Ocall-stores
428 By default, all parameters of a CALL are copied into the
429 parameter-globals right before the CALL instructions. This is the
430 easiest and safest way to translate calls, but also adds a lot of
431 unnecessary copying and unnecessary temporary values. This
432 optimization makes operations which are used as a parameter evaluate
433 directly into the parameter-global if that is possible, which is when
434 there's no other CALL instruction in between.
435 .TP
436 .B -Ovoid-return
437 Usually an empty RETURN instruction is added to the end of a void
438 typed function. However, additionally after every function a DONE
439 instruction is added for several reasons. (For example the qcvm's
440 disassemble switch uses it to know when the function ends.). This
441 optimization replaces that last RETURN with DONE rather than adding
442 the DONE additionally.
443 .SH CONFIG
444 The configuration file is similar to regular .ini files. Comments
445 start with hashtags or semicolons, sections are written in square
446 brackets and in each section there can be arbitrary many key-value
447 pairs.
448 .sp
449 There are 3 sections currently:
450 .IR flags ", " warnings ", and " optimizations .
451 They contain a list of boolean values of the form `VARNAME = true` or
452 `VARNAME = false`. The variable names are the same as for the
453 corresponding -W, -f or -O flag written with only capital letters and
454 dashes replaced by underscores.
455 .sp
456 Here's an example:
457 .in +4
458 .nf
459 # a GMQCC configuration file
460 [flags]
461     FTEPP = true
462     ADJUST_VECTOR_FIELDS = false
463     LNO = true
464
465 [warnings]
466     UNUSED_VARIABLE = false
467     USED_UNINITIALIZED = true
468
469 [optimizations]
470     PEEPHOLE = true
471     TAIL_RECURSION = true
472 .fi
473 .in
474 .SH BUGS
475 Currently the '-fftepp-predefs' flag is not included by '-std=fteqcc',
476 partially because it is not entirely conformant to fteqcc.
477 .sp
478
479 Please report bugs on <http://github.com/graphitemaster/gmqcc/issues>,
480 or see <http://graphitemaster.github.com/gmqcc> on how to contact us.
481 .SH FILES
482 .TP 20
483 .B gmqcc.ini.example
484 A documented example for a gmqcc.ini file.
485 .SH SEE ALSO
486 .IR qcvm (1)
487 .SH AUTHOR
488 See <http://graphitemaster.github.com/gmqcc>.