Update the ini example, holy hell we have more options than I imagined.
[xonotic/gmqcc.git] / gmqcc.ini.example
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.
4
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.
10
11 [flags]
12     #Add some additional characters to the string table in order to
13     #compensate for a wrong boundcheck in some specific version of the
14     #darkplaces engine.
15
16     DARKPLACES_STRING_TABLE_BUG = true
17
18
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.
25
26     ADJUST_VECTOR_FIELDS = true
27
28
29     #Enable a partially fteqcc-compatible preprocessor. It supports
30     #all the features used in the Xonotic codebase. If you need more,
31     #write a ticket.
32
33     FTEPP = true
34     
35
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:
39     #
40     #   __LINE__
41     #   __FILE__
42     #   __COUNTER__
43     #   __COUNTER_LAST__
44     #   __RANDOM__
45     #   __RANDOM_LAST__
46     #   __DATE__
47     #   __TIME__
48     #   __FUNC__
49     #
50     #Note that __FUNC__ is not actually a preprocessor macro, but is
51     #recognized by the parser even with the preprocessor disabled.
52     #
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.
61
62     FTEPP_PREDEFS = false
63
64
65     #Allow switch cases to use non constant variables.
66
67     RELAXED_SWITCH = true
68
69
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‐
72     #sibilities.
73
74     SHORT_LOGIC = true
75
76
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.
81
82     PERL_LOGIC = false
83
84
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.
89
90     TRANSLATABLE_STRINGS = true
91
92
93     #Don't implicitly convert initialized variables to constants. With
94     #this flag, the const keyword is required to make a constant.
95
96     INITIALIZED_NONCONSTANTS = false
97
98
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.
102
103     ASSIGN_FUNCTION_TYPES = true
104
105
106     #Produce a linenumber file along with the output .dat file.
107
108     LNO = false
109
110
111     #Use C's operator precedence for ternary expressions. Unless your
112     #code depends on fteqcc-compatible behaviour, you'll want to use
113     #this option.
114
115     CORRECT_TERNARY = true
116
117
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.
121
122
123     SINGLE_VECTOR_DEFS = true
124
125
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.
130     #
131     #   if (a_vector) // becomes
132     #   if not(!a_vector)
133     #   // likewise
134     #   a = a_vector && a_float // becomes
135     #   a = !!a_vector && a_float
136
137     CORRECT_LOGIC = true
138
139
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
143     #instead.
144
145     TRUE_EMPTY_STRINGS = false
146
147
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.
151
152     FALSE_EMPTY_STRINGS = true
153
154
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}'.
158
159     UTF8 = true
160
161
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
167     #context is shown.
168
169     BAIL_ON_WERROR = false
170
171
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
174     #of or continue.
175     #
176     #   for :outer (i = 0; i < n; ++i) {
177     #       while (inner) {
178     #           ...;
179     #           if (something)
180     #               continue outer;
181     #       }
182     #   }
183
184     LOOP_LABELS = true
185
186
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.
191     #
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.#
200     #
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.
204
205
206     UNTYPED_NIL = true
207
208
209     #Various effects, usually to weaken some conditions.
210     #   with -funtyped-nil
211     #       Allow local variables named ‘nil’.  (This will not
212     #       allow declaring a global of that name.)
213
214     PERMISSIVE = false
215
216
217     #Allow variadic parameters to be accessed by QC code. This can be
218     #achieved via the '...' function, which takes a parameter index
219     #and a typename.
220     #
221     #Example:
222     #
223     #   void vafunc(string...count) {
224     #       float i;
225     #       for (i = 0; i < count; ++i)
226     #           print(...(i, string), "\n");
227     #   }
228
229     VARIADIC_ARGS = true
230
231
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
235     #code.
236
237     LEGACY_VECTOR_MATHS = false
238
239
240     #Usually builtin-numbers are just immediate constants. With this
241     #flag expressions can be used, as long as they are compile-time
242     #constant.
243     #
244     #Example:
245     #
246     #   void printA() = #1;   // the usual way
247     #   void printB() = #2-1; // with a constant expression
248
249     EXPRESSIONS_FOR_BUILTINS = true
250
251
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.
255     #
256     #Example:
257     #
258     #   float bar() { return 1024; }
259     #   float fun() {
260     #       return = bar();
261     #       return; // returns value of bar (this can be omitted)
262     #   }
263
264     RETURN_ASSIGNMENTS = true
265
266
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
271     #varargs.
272
273     UNSAFE_VARARGS = false
274
275
276
277 [warnings]
278     #Generate a warning about variables which are declared but never
279     #used.  This can be avoided by adding the ‘noref’ keyword in front
280     #of the variable declaration. Additionally a complete section of
281     #unreferenced variables can be opened using ‘#pragma noref 1’ and
282     #closed via ‘#pragma noref 0’.
283
284     UNUSED_VARIABLE = false
285
286
287     #Generate a warning if it is possible that a variable can be used
288     #without prior initialization. Note that this warning is not nec‐
289     #essarily reliable if the initialization happens only under cer‐
290     #tain conditions. The other way is not possible: that the warning
291     #is not generated when uninitialized use is possible.
292
293     USED_UNINITIALIZED = false
294
295
296     #Generate an error when an unrecognized control sequence in a
297     #string is used. Meaning: when there's a character after a back‐
298     #slash in a string which has no known meaning.
299
300     UNKNOWN_CONTROL_SEQUENCE = false
301
302
303     #Warn when using special extensions which are not part of the
304     #selected standard.
305
306     EXTENSIONS = false
307
308
309     #Generally QC compilers ignore redeclaration of fields. Here you
310     #can optionally enable a warning.
311
312     FIELD_REDECLARED = false
313
314
315     #Functions which aren't of type void will warn if it possible to
316     #reach the end without returning an actual value.
317
318     MISSING_RETURN_VALUES = false
319
320
321     #Warn about a function call with an invalid number of parameters.
322
323     INVALID_PARAMETER_COUNT = false
324
325
326     #Warn when a locally declared variable shadows variable.
327
328     LOCAL_SHADOWS = false
329
330
331     #Warn when the initialization of a local variable turns the vari‐
332     #able into a constant. This is default behaviour unless
333     #-finitialized-nonconstants is used.
334
335     LOCAL_CONSTANTS = false
336
337
338     #There are only 2 known global variables of type void:
339     #‘end_sys_globals’ and ‘end_sys_fields’.  Any other void-variable
340     #will warn.
341
342     VOID_VARIABLES = false
343
344
345     #A global function which is not declared with the ‘var’ keyword is
346     #expected to have an implementing body, or be a builtin. If nei‐
347     #ther is the case, it implicitly becomes a function pointer, and a
348     #warning is generated.
349
350     IMPLICIT_FUNCTION_POINTER = false
351
352
353     #Currently there's no way for an in QC implemented function to
354     #access variadic parameters. If a function with variadic parame‐
355     #ters has an implementing body, a warning will be generated.
356
357     VARIADIC_FUNCTION = false
358
359
360     #Generate warnings about ‘$frame’ commands, for instance about
361     #duplicate frame definitions.
362
363     FRAME_MACROS = false
364
365
366     #Warn about statements which have no effect. Any expression which
367     #does not call a function or assigns a variable.
368
369     EFFECTLESS_STATEMENT = false
370
371
372     #The ‘end_sys_fields’ variable is supposed to be a global variable
373     #of type void.  It is also recognized as a field but this will
374     #generate a warning.
375
376     END_SYS_FIELDS = false
377
378
379     #Warn when assigning to a function pointer with an unmatching sig‐
380     #nature. This usually happens in cases like assigning the null
381     #function to an entity's .think function pointer.
382
383     ASSIGN_FUNCTION_TYPES = false
384
385
386     #Show warnings created using the preprocessor's '#warning' directive
387
388     CPP = true
389
390
391     #Warn if there's a preprocessor #if spanning across several files.
392
393     MULTIFILE_IF = true
394
395
396     #Warn about multiple declarations of globals. This seems pretty
397     #common in QC code so you probably do not want this unless you
398     #want to clean up your code.
399
400     DOUBLE_DECLARATION = false
401
402
403     #The combination of const and var is not illegal, however differ‐
404     #ent compilers may handle them differently. We were told, the
405     #intention is to create a function-pointer which is not assigna‐
406     #ble.  This is exactly how we interpret it. However for this
407     #interpretation the ‘var’ keyword is considered superfluous (and
408     #philosophically wrong), so it is possible to generate a warning
409     #about this.
410
411     CONST_VAR = true
412
413
414     #Warn about multibyte character constants, they do not work right
415     #now.
416
417     MULTIBYTE_CHARACTER = false
418
419
420     #Warn if a ternary expression which contains a comma operator is
421     #used without enclosing parenthesis, since this is most likely not
422     #what you actually want. We recommend the -fcorrect-ternary
423     #option.
424
425     TERNARY_PRECEDENCE = false
426
427
428     #Warn when encountering an unrecognized ‘#pragma’ line.
429
430     UNKNOWN_PRAGMAS = true
431
432
433     #Warn about unreachable code. That is: code after a return state‐
434     #ment, or code after a call to a function marked as 'noreturn'.
435
436     UNREACHABLE_CODE = true
437
438
439     #Enable some warnings added in order to help debugging in the com‐
440     #piler.  You won't need this.
441
442     DEBUG = false
443
444
445     #Warn on an unknown attribute. The warning will inlclude only the
446     #first token inside the enclosing attribute-brackets. This may
447     #change when the actual attribute syntax is better defined.
448
449     UNKNOWN_ATTRIBUTE = true
450
451
452     #Warn when using reserved names such as ‘nil’.
453
454     RESERVED_NAMES = true
455
456
457     #Warn about global constants (using the ‘const’ keyword) with no
458     #assigned value.
459
460     UNINITIALIZED_CONSTANT = true
461
462
463     #Warn about global variables with no initializing value. This is
464     #off by default, and is added mostly to help find null-values
465     #which are supposed to be replaced by the untyped 'nil' constant.
466
467     UNINITIALIZED_GLOBAL = true
468
469
470     #Warn when a variables is redeclared with a different qualifier.
471     #For example when redeclaring a variable as 'var' which was previ‐
472     #ously marked 'const'.
473
474     DIFFERENT_QUALIFIERS = true
475
476
477     #Similar to the above but for attributes like ‘[[noreturn]]’.
478
479     DIFFERENT_ATTRIBUTES = true
480
481
482     #Warn when a function is marked with the attribute "[[depre‐
483     #cated]]". This flag enables a warning on calls to functions
484     #marked as such.
485
486     DEPRECATED = true
487
488
489     #Warn about possible mistakes caused by missing or wrong parenthe‐
490     #sis, like an assignment in an 'if' condition when there's no
491     #additional set of parens around the assignment.
492
493     PARENTHESIS = true
494
495
496     #When passing variadic parameters via ...(N) it can happen that
497     #incompatible types are passed to functions. This enables several
498     #warnings when static typechecking cannot guarantee consistent
499     #behavior.
500
501     UNSAFE_TYPES = true
502
503
504     #When compiling original id1 QC, there is a definition for `break`
505     #which conflicts with the 'break' keyword in GMQCC. Enabling this
506     #warning will print a warning when the definition occurs. The
507     #definition is ignored for both cases.
508
509     BREAKDEF = true
510
511 [optimizations]
512     #Some general peephole optimizations. For instance the code `a = b
513     #+ c` typically generates 2 instructions, an ADD and a STORE. This
514     #optimization removes the STORE and lets the ADD write directly
515     #into A.
516
517     PEEPHOLE = true
518
519
520     #Tail recursive function calls will be turned into loops to avoid
521     #the overhead of the CALL and RETURN instructions.
522
523     TAIL_RECURSION = true
524
525
526     #Make all functions which use neither local arrays nor have locals
527     #which are seen as possibly uninitialized use the same local sec‐
528     #tion.  This should be pretty safe compared to other compilers
529     #which do not check for uninitialized values properly. The problem
530     #is that there's QC code out there which really doesn't initialize
531     #some values. This is fine as long as this kind of optimization
532     #isn't used, but also, only as long as the functions cannot be
533     #called in a recursive manner. Since it's hard to know whether or
534     #not an array is actually fully initialized, especially when ini‐
535     #tializing it via a loop, we assume functions with arrays to be
536     #too dangerous for this optimization.
537
538     OVERLAP_LOCALS = true
539
540
541
542     #This promotes locally declared variables to "temps". Meaning when
543     #a temporary result of an operation has to be stored somewhere, a
544     #local variable which is not 'alive' at that point can be used to
545     #keep the result. This can reduce the size of the global section.
546     #This will not have declared variables overlap, even if it was
547     #possible.
548
549     LOCAL_TEMPS = true
550
551  
552     #Causes temporary values which do not need to be backed up on a
553     #CALL to not be stored in the function's locals-area. With this, a
554     #CALL to a function may need to back up fewer values and thus exe‐
555     #cute faster.
556
557     GLOBAL_TEMPS = true
558
559
560     #Don't generate defs for immediate values or even declared con‐
561     #stants.  Meaning variables which are implicitly constant or qual‐
562     #ified as such using the 'const' keyword.
563
564     STRIP_CONSTANT_NAMES = true
565
566
567     #Aggressively reuse strings in the string section. When a string
568     #should be added which is the trailing substring of an already
569     #existing string, the existing string's tail will be returned
570     #instead of the new string being added.
571     #
572     #For example the following code will only generate 1 string:
573     #
574     #   print("Hello you!\n");
575     #   print("you!\n"); // trailing substring of "Hello you!\n"
576     #
577     #There's however one limitation. Strings are still processed in
578     #order, so if the above print statements were reversed, this opti‐
579     #mization would not happen.
580
581     OVERLAP_STRINGS = true
582
583
584     #By default, all parameters of a CALL are copied into the parame‐
585     #ter-globals right before the CALL instructions. This is the easi‐
586     #est and safest way to translate calls, but also adds a lot of
587     #unnecessary copying and unnecessary temporary values. This opti‐
588     #mization makes operations which are used as a parameter evaluate
589     #directly into the parameter-global if that is possible, which is
590     #when there's no other CALL instruction in between.
591
592     CALL_STORES = true
593
594
595     #Usually an empty RETURN instruction is added to the end of a void
596     #typed function. However, additionally after every function a DONE
597     #instruction is added for several reasons. (For example the qcvm's
598     #disassemble switch uses it to know when the function ends.). This
599     #optimization replaces that last RETURN with DONE rather than
600     #adding the DONE additionally.
601
602     VOID_RETURN = true
603
604
605     #Because traditional QC code doesn't allow you to access individ‐
606     #ual vector components of a computed vector without storing it in
607     #a local first, sometimes people multiply it by a constant like
608     #‘'0 1 0'’ to get, in this case, the y component of a vector. This
609     #optimization will turn such a multiplication into a direct compo‐
610     #nent access. If the factor is anything other than 1, a float-mul‐
611     #tiplication will be added, which is still faster than a vector
612     #multiplication.
613
614     VECTOR_COMPONENTS = true
615
616
617     #For constant expressions that result in dead code (such as a
618     #branch whos condition can be evaluated at compile-time), this
619     #will eliminate the branch and else body (if present) to produce
620     #more optimal code.
621
622     CONST_FOLD_DCE = true
623
624     #For constant expressions we can fold them to immediate values.
625     #this option cannot be disabled or enabled, the compiler forces
626     #it to stay enabled by ignoring the value entierly. There are
627     #plans to enable some level of constant fold disabling, but right
628     #now the language can't function without it. This is merley here
629     #as an exercise to the reader.
630
631     CONST_FOLD = true