1 #This configuration file is similar to a regular .ini file. Comments start
2 #with hashtags or semicolons, sections are written in square brackets and
3 #in each section there can be arbitrary many key-value pairs.
5 #There are 3 sections currently: ‘flags’, ‘warnings’, ‘optimizations’.
6 #They contain a list of boolean values of the form ‘VARNAME = true’ or
7 #‘VARNAME = false’. The variable names are the same as for the corre‐
8 #sponding -W, -f or -O flag written with only capital letters and dashes
9 #replaced by underscores.
12 #Add some additional characters to the string table in order to
13 #compensate for a wrong boundcheck in some specific version of the
16 DARKPLACES_STRING_TABLE_BUG = true
19 #When assigning to field pointers of type .vector the common be‐
20 #haviour in compilers like fteqcc is to only assign the x-compo‐
21 #nent of the pointer. This means that you can use the vector as
22 #such, but you cannot use its y and z components directly. This
23 #flag fixes this behaviour. Before using it make sure your code
24 #does not depend on the buggy behaviour.
26 ADJUST_VECTOR_FIELDS = true
29 #Enable a partially fteqcc-compatible preprocessor. It supports
30 #all the features used in the Xonotic codebase. If you need more,
36 #Enable some predefined macros. This only works in combination
37 #with '-fftepp' and is currently not included by '-std=fteqcc'.
38 #The following macros will be added:
50 #Note that __FUNC__ is not actually a preprocessor macro, but is
51 #recognized by the parser even with the preprocessor disabled.
53 #Note that fteqcc also defines __NULL__ which becomes the first
54 #global. Assigning it to a vector does not yield the same result
55 #as in gmqcc where __NULL__ is defined to nil (See -funtyped-nil
56 #), which will cause the vector to be zero in all components. With
57 #fteqcc only the first component will be 0, while the other two
58 #will become the first to of the global return value. This behav‐
59 #ior is odd and relying on it should be discouraged, and thus is
60 #not supported by gmqcc.
65 #Allow switch cases to use non constant variables.
70 #Perform early out in logical AND and OR expressions. The final
71 #result will be either a 0 or a 1, see the next flag for more pos‐
77 #In many languages, logical expressions perform early out in a
78 #special way: If the left operand of an AND yeilds true, or the
79 #one of an OR yields false, the complete expression evaluates to
80 #the right side. Thus ‘true && 5’ evaluates to 5 rather than 1.
85 #Enable the underscore intrinsic: Using ‘_("A string constant")’
86 #will cause the string immediate to get a name with a "dotrans‐
87 #late_" prefix. The darkplaces engine recognizes these and trans‐
88 #lates them in a way similar to how gettext works.
90 TRANSLATABLE_STRINGS = true
93 #Don't implicitly convert initialized variables to constants. With
94 #this flag, the const keyword is required to make a constant.
96 INITIALIZED_NONCONSTANTS = false
99 #If this flag is not set, (and it is set by default in the qcc and
100 #fteqcc standards), assigning function pointers of mismatching
101 #signatures will result in an error rather than a warning.
103 ASSIGN_FUNCTION_TYPES = true
106 #Produce a linenumber file along with the output .dat file.
111 #Use C's operator precedence for ternary expressions. Unless your
112 #code depends on fteqcc-compatible behaviour, you'll want to use
115 CORRECT_TERNARY = true
118 #Normally vectors generate 4 defs, once for the vector, and once
119 #for its components with _x, _y, _z suffixes. This option prevents
120 #components from being listed.
123 SINGLE_VECTOR_DEFS = true
126 #Most QC compilers translate ‘if(a_vector)’ directly as an IF on
127 #the vector, which means only the x-component is checked. This
128 #option causes vectors to be cast to actual booleans via a NOT_V
129 #and, if necessary, a NOT_F chained to it.
131 # if (a_vector) // becomes
134 # a = a_vector && a_float // becomes
135 # a = !!a_vector && a_float
140 #An empty string is considered to be true everywhere. The NOT_S
141 #instruction usually considers an empty string to be false, this
142 #option effectively causes the unary not in strings to use NOT_F
145 TRUE_EMPTY_STRINGS = false
148 #An empty string is considered to be false everywhere. This means
149 #loops and if statements which depend on a string will perform a
150 #NOT_S instruction on the string before using it.
152 FALSE_EMPTY_STRINGS = true
155 #Enable utf8 characters. This allows utf-8 encoded character con‐
156 #stants, and escape sequence codepoints in the valid utf-8 range.
157 #Effectively enabling escape sequences like '\{x2211}'.
162 #When a warning is treated as an error, and this option is set
163 #(which it is by default), it is like any other error and will
164 #cause compilation to stop. When disabling this flag by using
165 #-fno-bail-on-werror, compilation will continue until the end, but
166 #no output is generated. Instead the first such error message's
169 BAIL_ON_WERROR = false
172 #Allow loops to be labeled, and allow 'break' and 'continue' to
173 #take an optional label to decide which loop to actually jump out
176 # for :outer (i = 0; i < n; ++i) {
187 #Adds a global named 'nil' which is of no type and can be assigned
188 #to anything. No typechecking will be performed on assignments.
189 #Assigning to it is forbidden, using it in any other kind of
190 #expression is also not allowed.
192 #Note that this is different from fteqcc's __NULL__: In fteqcc,
193 #__NULL__ maps to the integer written as '0i'. It's can be
194 #assigned to function pointers and integers, but it'll error about
195 #invalid instructions when assigning it to floats without enabling
196 #the FTE instruction set. There's also a bug which allows it to be
197 #assigned to vectors, for which the source will be the global at
198 #offset 0, meaning the vector's y and z components will contain
199 #the OFS_RETURN x and y components.#
201 #In that gmqcc the nil global is an actual global filled with
202 #zeroes, and can be assigned to anything including fields, vectors
203 #or function pointers, and they end up becoming zeroed.
209 #Various effects, usually to weaken some conditions.
211 # Allow local variables named ‘nil’. (This will not
212 # allow declaring a global of that name.)
217 #Allow variadic parameters to be accessed by QC code. This can be
218 #achieved via the '...' function, which takes a parameter index
223 # void vafunc(string...count) {
225 # for (i = 0; i < count; ++i)
226 # print(...(i, string), "\n");
232 #Most Quake VMs, including the one from FTEQW or up till recently
233 #Darkplaces, do not cope well with vector instructions with over‐
234 #lapping input and output. This option will avoid producing such
237 LEGACY_VECTOR_MATHS = false
240 #Usually builtin-numbers are just immediate constants. With this
241 #flag expressions can be used, as long as they are compile-time
246 # void printA() = #1; // the usual way
247 # void printB() = #2-1; // with a constant expression
249 EXPRESSIONS_FOR_BUILTINS = true
252 #Enabiling this option will allow assigning values or expressions
253 #to the return keyword as if it were a local variable of the same
254 #type as the function's signature's return type.
258 # float bar() { return 1024; }
261 # return; // returns value of bar (this can be omitted)
264 RETURN_ASSIGNMENTS = true
267 #When passing on varargs to a different functions, this turns some
268 #static error cases into warnings. Like when the caller's varargs
269 #are restricted to a different type than the callee's parameter.
270 #Or a list of unrestricted varargs is passed into restricted
273 UNSAFE_VARARGS = false
276 #Always use STORE_F, LOAD_F, STOREP_F when accessing scalar variables.
277 #This is somewhat incorrect assembly instruction use, but in all engines
278 #they do exactly the same. This makes disassembly output harder to read,
279 #breaks decompilers, but causes the output file to be better compressible.
281 TYPELESS_STORES = false
284 #In commutative instructions, always put the lower-numbered operand first.
285 #This shaves off 1 byte of entropy from all these instructions, reducing
286 #compressed size of the output file.
288 SORT_OPERANDS = false
293 #Generate a warning about variables which are declared but never
294 #used. This can be avoided by adding the ‘noref’ keyword in front
295 #of the variable declaration. Additionally a complete section of
296 #unreferenced variables can be opened using ‘#pragma noref 1’ and
297 #closed via ‘#pragma noref 0’.
299 UNUSED_VARIABLE = false
302 #Generate a warning if it is possible that a variable can be used
303 #without prior initialization. Note that this warning is not nec‐
304 #essarily reliable if the initialization happens only under cer‐
305 #tain conditions. The other way is not possible: that the warning
306 #is not generated when uninitialized use is possible.
308 USED_UNINITIALIZED = false
311 #Generate an error when an unrecognized control sequence in a
312 #string is used. Meaning: when there's a character after a back‐
313 #slash in a string which has no known meaning.
315 UNKNOWN_CONTROL_SEQUENCE = false
318 #Warn when using special extensions which are not part of the
324 #Generally QC compilers ignore redeclaration of fields. Here you
325 #can optionally enable a warning.
327 FIELD_REDECLARED = false
330 #Functions which aren't of type void will warn if it possible to
331 #reach the end without returning an actual value.
333 MISSING_RETURN_VALUES = false
336 #Warn about a function call with an invalid number of parameters.
338 INVALID_PARAMETER_COUNT = false
341 #Warn when a locally declared variable shadows variable.
343 LOCAL_SHADOWS = false
346 #Warn when the initialization of a local variable turns the vari‐
347 #able into a constant. This is default behaviour unless
348 #-finitialized-nonconstants is used.
350 LOCAL_CONSTANTS = false
353 #There are only 2 known global variables of type void:
354 #‘end_sys_globals’ and ‘end_sys_fields’. Any other void-variable
357 VOID_VARIABLES = false
360 #A global function which is not declared with the ‘var’ keyword is
361 #expected to have an implementing body, or be a builtin. If nei‐
362 #ther is the case, it implicitly becomes a function pointer, and a
363 #warning is generated.
365 IMPLICIT_FUNCTION_POINTER = false
368 #Currently there's no way for an in QC implemented function to
369 #access variadic parameters. If a function with variadic parame‐
370 #ters has an implementing body, a warning will be generated.
372 VARIADIC_FUNCTION = false
375 #Generate warnings about ‘$frame’ commands, for instance about
376 #duplicate frame definitions.
381 #Warn about statements which have no effect. Any expression which
382 #does not call a function or assigns a variable.
384 EFFECTLESS_STATEMENT = false
387 #The ‘end_sys_fields’ variable is supposed to be a global variable
388 #of type void. It is also recognized as a field but this will
391 END_SYS_FIELDS = false
394 #Warn when assigning to a function pointer with an unmatching sig‐
395 #nature. This usually happens in cases like assigning the null
396 #function to an entity's .think function pointer.
398 ASSIGN_FUNCTION_TYPES = false
401 #Show warnings created using the preprocessor's '#warning' directive
406 #Warn if there's a preprocessor #if spanning across several files.
411 #Warn about multiple declarations of globals. This seems pretty
412 #common in QC code so you probably do not want this unless you
413 #want to clean up your code.
415 DOUBLE_DECLARATION = false
418 #The combination of const and var is not illegal, however differ‐
419 #ent compilers may handle them differently. We were told, the
420 #intention is to create a function-pointer which is not assigna‐
421 #ble. This is exactly how we interpret it. However for this
422 #interpretation the ‘var’ keyword is considered superfluous (and
423 #philosophically wrong), so it is possible to generate a warning
429 #Warn about multibyte character constants, they do not work right
432 MULTIBYTE_CHARACTER = false
435 #Warn if a ternary expression which contains a comma operator is
436 #used without enclosing parenthesis, since this is most likely not
437 #what you actually want. We recommend the -fcorrect-ternary
440 TERNARY_PRECEDENCE = false
443 #Warn when encountering an unrecognized ‘#pragma’ line.
445 UNKNOWN_PRAGMAS = true
448 #Warn about unreachable code. That is: code after a return state‐
449 #ment, or code after a call to a function marked as 'noreturn'.
451 UNREACHABLE_CODE = true
454 #Enable some warnings added in order to help debugging in the com‐
455 #piler. You won't need this.
460 #Warn on an unknown attribute. The warning will inlclude only the
461 #first token inside the enclosing attribute-brackets. This may
462 #change when the actual attribute syntax is better defined.
464 UNKNOWN_ATTRIBUTE = true
467 #Warn when using reserved names such as ‘nil’.
469 RESERVED_NAMES = true
472 #Warn about global constants (using the ‘const’ keyword) with no
475 UNINITIALIZED_CONSTANT = true
478 #Warn about global variables with no initializing value. This is
479 #off by default, and is added mostly to help find null-values
480 #which are supposed to be replaced by the untyped 'nil' constant.
482 UNINITIALIZED_GLOBAL = true
485 #Warn when a variables is redeclared with a different qualifier.
486 #For example when redeclaring a variable as 'var' which was previ‐
487 #ously marked 'const'.
489 DIFFERENT_QUALIFIERS = true
492 #Similar to the above but for attributes like ‘[[noreturn]]’.
494 DIFFERENT_ATTRIBUTES = true
497 #Warn when a function is marked with the attribute "[[depre‐
498 #cated]]". This flag enables a warning on calls to functions
504 #Warn about possible mistakes caused by missing or wrong parenthe‐
505 #sis, like an assignment in an 'if' condition when there's no
506 #additional set of parens around the assignment.
511 #When passing variadic parameters via ...(N) it can happen that
512 #incompatible types are passed to functions. This enables several
513 #warnings when static typechecking cannot guarantee consistent
519 #When compiling original id1 QC there is a definition for `break`
520 #which conflicts with the 'break' keyword in GMQCC. Enabling this
521 #print a warning when the definition occurs. The definition is
522 #ignored for both cases.
527 #When compiling original QuakeWorld QC there are instances where
528 #code overwrites constants. This is considered an error, however
529 #for QuakeWorld to compile it needs to be treated as a warning
530 #instead, as such this warning only works when -std=qcc.
532 CONST_OVERWRITE = true
535 #Warn about the use of preprocessor directives inside macros.
537 DIRECTIVE_INMACRO = true
542 #Some general peephole optimizations. For instance the code `a = b
543 #+ c` typically generates 2 instructions, an ADD and a STORE. This
544 #optimization removes the STORE and lets the ADD write directly
550 #Tail recursive function calls will be turned into loops to avoid
551 #the overhead of the CALL and RETURN instructions.
553 TAIL_RECURSION = true
556 #Make all functions which use neither local arrays nor have locals
557 #which are seen as possibly uninitialized use the same local sec‐
558 #tion. This should be pretty safe compared to other compilers
559 #which do not check for uninitialized values properly. The problem
560 #is that there's QC code out there which really doesn't initialize
561 #some values. This is fine as long as this kind of optimization
562 #isn't used, but also, only as long as the functions cannot be
563 #called in a recursive manner. Since it's hard to know whether or
564 #not an array is actually fully initialized, especially when ini‐
565 #tializing it via a loop, we assume functions with arrays to be
566 #too dangerous for this optimization.
568 OVERLAP_LOCALS = true
571 #This promotes locally declared variables to "temps". Meaning when
572 #a temporary result of an operation has to be stored somewhere, a
573 #local variable which is not 'alive' at that point can be used to
574 #keep the result. This can reduce the size of the global section.
575 #This will not have declared variables overlap, even if it was
581 #Causes temporary values which do not need to be backed up on a
582 #CALL to not be stored in the function's locals-area. With this, a
583 #CALL to a function may need to back up fewer values and thus exe‐
589 #Don't generate defs for immediate values or even declared con‐
590 #stants. Meaning variables which are implicitly constant or qual‐
591 #ified as such using the 'const' keyword.
593 STRIP_CONSTANT_NAMES = true
596 #Aggressively reuse strings in the string section. When a string
597 #should be added which is the trailing substring of an already
598 #existing string, the existing string's tail will be returned
599 #instead of the new string being added.
601 #For example the following code will only generate 1 string:
603 # print("Hello you!\n");
604 # print("you!\n"); // trailing substring of "Hello you!\n"
606 #There's however one limitation. Strings are still processed in
607 #order, so if the above print statements were reversed, this opti‐
608 #mization would not happen.
610 OVERLAP_STRINGS = true
613 #By default, all parameters of a CALL are copied into the parame‐
614 #ter-globals right before the CALL instructions. This is the easi‐
615 #est and safest way to translate calls, but also adds a lot of
616 #unnecessary copying and unnecessary temporary values. This opti‐
617 #mization makes operations which are used as a parameter evaluate
618 #directly into the parameter-global if that is possible, which is
619 #when there's no other CALL instruction in between.
624 #Usually an empty RETURN instruction is added to the end of a void
625 #typed function. However, additionally after every function a DONE
626 #instruction is added for several reasons. (For example the qcvm's
627 #disassemble switch uses it to know when the function ends.). This
628 #optimization replaces that last RETURN with DONE rather than
629 #adding the DONE additionally.
634 #Because traditional QC code doesn't allow you to access individ‐
635 #ual vector components of a computed vector without storing it in
636 #a local first, sometimes people multiply it by a constant like
637 #‘'0 1 0'’ to get, in this case, the y component of a vector. This
638 #optimization will turn such a multiplication into a direct compo‐
639 #nent access. If the factor is anything other than 1, a float-mul‐
640 #tiplication will be added, which is still faster than a vector
643 VECTOR_COMPONENTS = true
646 #For constant expressions that result in dead code (such as a
647 #branch whos condition can be evaluated at compile-time), this
648 #will eliminate the branch and else body (if present) to produce
651 CONST_FOLD_DCE = true
654 #For constant expressions we can fold them to immediate values.
655 #this option cannot be disabled or enabled, the compiler forces
656 #it to stay enabled by ignoring the value entierly. There are
657 #plans to enable some level of constant fold disabling, but right
658 #now the language can't function without it. This is merley here
659 #as an exercise to the reader.