5a6339a38374de7230987cb1eb3f2558780d6724
[xonotic/gmqcc.git] / gmqcc.ini.example
1 # This is an example INI file that can be used to set compiler options
2 # without the rquirement for supplying them as arguments on the command
3 # line, this can be coupled with progs.src.  To utilize this file there
4 # are two options availble, if it's named "gmqcc.ini" or "gmqcc.cfg" and
5 # the file exists in the directory that GMQCC is invoked from, the compiler
6 # will implicitally find and execute regardless.  For more freedom you may
7 # use -config=<file> from the command line to specify a more explicit
8 # directory/name.ext for the configuration file.
9
10
11 # These are common compiler flags usually represented via the -f prefix
12 # from the command line.
13 [flags]
14     # Enabling this can potentially reduces code size by overlapping
15     # locals where possible.
16     OVERLAP_LOCALS               = false
17
18     # in some older versions of the Darkplaces engine the string table
19     # size is computed wrong causing compiled progs.dat to fail to load
20     # Enabling this works around the bug by writing a few additional
21     # null bytes to the end of the string table to compensate.
22     DARKPLACES_STRING_TABLE_BUG  = false
23
24     # Enabling this corrects the assignment of vector field pointers via
25     # subsituting STORE_FLD with STORE_V.
26     ADJUST_VECTOR_FIELDS         = true
27
28     # Enabling this allows the use of the FTEQ preprocessor, as well as
29     # additional preprocessing directives such as #error and #warning.
30     FTEPP                        = true
31
32     # Enabling this relaxes switch statement semantics
33     RELAXED_SWITCH               = false
34
35     # Enabling this allows short-circut evaluation and logic, opposed
36     # to full evaluation.
37     SHORT_LOGIC                  = false
38
39     # Enabling this allows perl-like evaluation/logic.
40     PERL_LOGIC                   = true
41
42     # Enabling this allows the use of the "translatable strings" extension
43     # assisted by .po files.
44     TRANSLATABLE_STRINGS         = false
45
46     # Enabling this prevents initializations from becoming constant unless
47     # 'const' is specified as a type qualifier.
48     INITIALIZED_NONCONSTANTS     = false
49
50     # Enabling this allows function types to be assignable even if their
51     # signatures are invariant of each other.
52     ASSIGN_FUNCTION_TYPES        = false
53
54     # Enabling this will allow the generation of .lno files for engine
55     # virtual machine backtraces (this is enabled with -g as well).
56     LNO                          = false
57
58     # Enabling this corrects ternary percedence bugs present in fteqcc.
59     CORRECT_TERNARY              = true
60
61     # Prevent the creation of _x, _y and _z progdefs for vectors
62     SINGLE_VECTOR_DEFS           = false
63
64     # Cast vectors to real booleans when used in logic expressions.
65     # This is achieved by using NOT_V.
66     CORRECT_LOGIC                = false
67
68     # Always treat empty strings as true. Usuall !"" yields true, because
69     # the string-NOT instruction considers empty strings to be false, while
70     # an empty string as condition for 'if' will be considered true, since
71     # only the numerical value of the global is looked at.
72     TRUE_EMPTY_STRINGS           = false
73
74     # Opposite of the above, empty strings are always false. Similar to
75     # CORRECT_LOGIC this will always use NOT_S to cast a string to a real
76     # boolean value.
77     FALSE_EMPTY_STRINGS          = false
78
79     # Recognize utf-8 characters in character constants, and encode
80     # codepoint escape sequences in strings as utf-8. This essentially allows
81     # \{1234} escape sequences to be higher than 255.
82     UTF8
83
84     # When a warning is printed and it is set to be treated as error via
85     # a -Werror switch, compilation will be stopped, unless this is false.
86     # When this is false, the rest of the code will be compiled, and at the end
87     # the file and line of the first warning will be shown.
88     BAIL_ON_WERROR               = true
89
90     # Allow loops and switches to be labeled and break and continue to take an
91     # optional label to target a specific loop/switch.
92     LOOP_LABELS                  = false
93
94     # Enable the 'nil' null constant, which has no type. It can be used as the
95     # right hand of any assignment regardless of the required type.
96     UNTYPED_NIL                  = false
97
98     # Be "permissive". For instance, when -funtyped-nil is used, this allows local
99     # variables with the name 'nil' to be declared.
100     PREMISSIVE                   = false
101
102     # Enable enhanced diagnostic messages. i.e provides a "did you mean"
103     # <ident> when you accidently typo. Amongst others
104     ENHANCED_DIAGNOSTICS         = true
105
106     # Allow vararg access from within QC of the form: ...(argnumber, type)
107     VARIADIC_ARGS                = true
108
109 # These are all the warnings, usually present via the -W prefix from
110 # the command line.
111 [warnings]
112     # ?? Used for debugging ??
113     DEBUG                        = false
114
115     # Enables warnings about unused variables.
116     UNUSED_VARIABLE              = true
117
118     # Enables warnings about uninitialized variables.
119     USED_UNINITIALIZED           = true
120
121     # Enables warnings about the unknown control sequences in the source
122     # stream.
123     UNKNOWN_CONTROL_SEQUENCE     = true
124
125     # Enables warnings about the use of (an) extension(s).
126     EXTENSIONS                   = true
127
128     # Enables warnings about redeclared fields.
129     FIELD_REDECLARED             = true
130
131     # Enables warnings about missing return values.
132     MISSING_RETURN_VALUES        = true
133
134     # Enables warnings about missing parameters for function calls.
135     INVALID_PARAMETER_COUNT      = true
136
137     # Enables warnings about locals shadowing parameters or other locals.
138     LOCAL_SHADOWS                = true
139
140     # Enables warnings about constants specified as locals.
141     LOCAL_CONSTANTS              = true
142
143     # Enables warnings about variables declared as type void.
144     VOID_VARIABLES               = true
145
146     # Enables warnings about implicitally declared function pointers.
147     IMPLICIT_FUNCTION_POINTER    = true
148
149     # Enables warnings for use of varadics for non-builtin functions.
150     VARIADIC_FUNCTION            = true
151
152     # Enables warnings about duplicated frame macros.
153     FRAME_MACROS                 = true
154
155     # Enables warnings about effectivless statements.
156     EFFECTLESS_STATEMENT         = true
157
158     # Enables warnings of "end_sys_fields" beiing declared a field.
159     END_SYS_FIELDS               = true
160
161     # Enables warnings for infompatible function pointer signatures used
162     # in assignment.
163     ASSIGN_FUNCTION_TYPES        = true
164
165     # Enables warnings about redefined macros in the preprocessor
166     PREPROCESSOR                 = true
167
168     # Enables warnings about multi-file if statements
169     MULTIFILE_IF                 = true
170
171     # Enables warnings about double declarations
172     DOUBLE_DECLARATION           = true
173
174     # Enables warnings about type qualifiers containing both 'var' and
175     # 'const'
176     CONST_VAR                    = true
177
178     # Enables warnings about the use of multibytes characters / constants
179     MULTIBYTE_CHARACTER          = true
180
181     # Enables warnings about ternary expressions whos precedence may be
182     # not what was initially expected.
183     TERNARY_PRECEDENCE           = true
184
185     # Enables warnings about unknown pragmas.
186     UNKNOWN_PRAGMAS              = true
187
188     # Enables warnings about unreachable code.
189     UNREACHABLE_CODE             = true
190
191     # Enables preprocessor "#warnings"
192     CPP                          = true
193
194     # With the [[attribute]] syntax enabled, warn when an unknown
195     # attribute is encountered. Its first token will be included in the
196     # message.
197     UNKNOWN_ATTRIBUTE            = true
198
199     # Warn when declaring variables or fields with a reserved name like 'nil'
200     RESERVED_NAMES               = true
201
202     # Warn about 'const'-qualified global variables with no initializing value.
203     UNINITIALIZED_CONSTANT       = true
204
205     # Warn about non-constant global variables with no initializing value.
206     UNINITIALIZED_GLOBAL         = true
207
208     # Redeclaring a 'const' as 'var' or the other way round.
209     DIFFERENT_QUALIFIERS         = true
210
211     # Redeclaring a function with different attributes such as
212     # [[noreturn]]
213     DIFFERENT_ATTRIBUTES         = true
214
215     # Warn when a function is marked with the attribute
216     # "[[deprecated]]". This flag enables a warning on calls to functions
217     # marked as such.
218     DEPRECATED                   = true
219
220     # Warn about possible problems from missing parenthesis, like an
221     # assignment used as truth value without additional parens around.
222     PARENTHESIS                  = true
223
224 # Finally these are all the optimizations, usually present via the -O
225 # prefix from the command line.
226 [optimizations]
227     # Enables peephole optimizations.
228     PEEPHOLE                     = true
229
230     # Enables localtemp omission optimizations.
231     LOCALTEMPS                   = true
232
233     # Enables tail recrusion optimizationd.
234     TAIL_RECURSION               = true
235
236     # Enables tail-call optimizations. (Not implemented)
237     TAIL_CALLS                   = true
238
239     # Every function where it is safe to do so will share its local data section
240     # with the others. The criteria are currently that the function must not have
241     # any possibly uninitialized locals, or local arrays regardless of how they
242     # are initialized.
243     OVERLAP_LOCALS               = false
244
245     # Strip out the names of constants to save some space in the progs.dat
246     STRIP_CONSTANT_NAMES         = true
247
248     # Aggressivly reuse strings in the string-section
249     OVERLAP_STRINGS              = true
250
251     # Have expressions which are used as function parameters evaluate directly
252     # into the parameter-globals if possible.
253     # This avoids a whole lot of copying.
254     CALL_STORES                  = true
255
256     # Do not create a RETURN instruction at the end functions of return-type void.
257     VOID_RETURN                  = true
258
259     # Turn extraction-multiplications such as (a_vector * '0 1 0')
260     # into direct component accesses
261     VECTOR_COMPONENTS            = true