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 mimick 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 entierly
  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 .BI -W warning "\fR, " "" -Wno- warning
  54 Enable or disable a warning.
  55 .TP
  56 .B -Wall
  57 Enable all warnings. Overrides preceding -W parameters.
  58 .TP
  59 .BR -Werror ", " -Wno-error
  60 Controls whether or not all warnings should be treated as errors.
  61 .TP
  62 .BI -Werror- warning "\fR, " "" -Wno-error- warning
  63 Controls whether a specific warning should be an error.
  64 .TP
  65 .B -Whelp
  66 List all possible warn flags.
  67 .TP
  68 .BI -f flag "\fR, " "" -fno- flag
  69 Enable or disable a specific compile flag. See the list of flags
  70 below.
  71 .TP
  72 .B -fhelp
  73 List all possible compile flags.
  74 .TP
  75 .B -nocolor
  76 Disables colored output
  77 .TP
  78 .BI -config= file
  79 Use an ini file to read all the -O, -W and -f flag from. See the
  80 CONFIG section about the file format.
  81 .TP
  82 .BI "-redirout=" file
  83 Redirects standard output to a \fIfile\fR
  84 .TP
  85 .BI "-redirerr=" file
  86 Redirects standard error to a \fIfile\fR
  87 .TP
  88 .BI "-std=" standard
  89 Use the specified standard for parsing QC code. The following standards
  90 are available:
  91 .IR gmqcc , qcc , fteqcc
  92 Selecting a standard also implies some -f options and behaves as if
  93 those options have been written right after the -std option, meaning
  94 if you changed them before the -std option, you're now overwriting
  95 them.
  96 .sp
  97 .BR -std=gmqcc " includes:"
  98 .in +4
  99 -fadjust-vector-fields
 100 .in
 101 .BR -std=qcc " includes:"
 102 .in +4
 103 .nf
 104 -fassign-function-types
 105 -f\fIno-\fRadjust-vector-fields
 106 .fi
 107 .in
 108 .BR -std=fteqcc " includes:"
 109 .in +4
 110 .nf
 111 -fftepp
 112 -ftranslatable-strings
 113 -fassign-function-types
 114 -Wternary-precedence
 115 -f\fIno-\fRadjust-vector-fields
 116 -f\fIno-\fRcorrect-ternary
 117 .fi
 118 .in
 119 .SH Warnings
 120 .TP
 121 .B -Wunused-variable
 122 Generate a warning about variables which are declared but never used.
 123 This can be avoided by adding the \fInoref\fR keyword in front of the
 124 variable declaration. Additionally a complete section of unreferenced
 125 variables can be opened using \fI#pragma noref 1\fR, and closed via
 126 \fI#pragma noref 0\fR.
 127 .TP
 128 .B -Wused-uninitialized
 129 Generate a warning if it is possible that a variable can be used
 130 without prior initialization. Note that this warning is not
 131 necessarily reliable if the initialization happens only under certain
 132 conditions. The other way is \fInot\fR possible: that the warning is
 133 \fInot\fR generated when uninitialized use \fIis possible\fR.
 134 .TP
 135 .B -Wunknown-control-sequence
 136 Generate an error when an unrecognized control sequence in a string is
 137 used. Meaning: when there's a character after a backslash in a string
 138 which has no known meaning.
 139 .TP
 140 .B -Wextensions
 141 Warn when using special extensions which are not part of the selected
 142 standard.
 143 .TP
 144 .B -Wfield-redeclared
 145 Generally QC compilers ignore redeclaration of fields. Here you can
 146 optionally enable a warning.
 147 .TP
 148 .B -Wmissing-return-values
 149 Functions which aren't of type \fIvoid\fR will warn if it possible to
 150 reach the end without returning an actual value.
 151 .TP
 152 .B -Wtoo-few-parameters
 153 Warn about a function call with fewer parameters than the function
 154 expects.
 155 .TP
 156 .B -Wlocal-shadows
 157 Warn when a locally declared variable shadows variable.
 158 .TP
 159 .B -Wlocal-constants
 160 Warn when the initialization of a local variable turns the variable
 161 into a constant. This is default behaviour unless
 162 \fI-finitialized-nonconstants\fR is used.
 163 .TP
 164 .B -Wvoid-variables
 165 There are only 2 known global variables of type void: end_sys_globals
 166 and end_sys_fields. Any other void-variable will warn.
 167 .TP
 168 .B -Wimplicit-function-pointer
 169 A global function which is not declared with the \fIvar\fR keyword is
 170 expected to have an implementing body, or be a builtin. If neither is
 171 the case, it implicitly becomes a function pointer, and a warning is
 172 generated.
 173 .TP
 174 .B -Wvariadic-function
 175 Currently there's no way for an in QC implemented function to access
 176 variadic parameters. If a function with variadic parameters has an
 177 implementing body, a warning will be generated.
 178 .TP
 179 .B -Wframe-macros
 180 Generate warnings about \fI$frame\fR commands, for instance about
 181 duplicate frame definitions.
 182 .TP
 183 .B -Weffectless-statement
 184 Warn about statements which have no effect. Any expression which does
 185 not call a function or assigns a variable.
 186 .TP
 187 .B -Wend-sys-fields
 188 The \fIend_sys_fields\fR variable is supposed to be a global variable
 189 of type \fIvoid\fR. It is also recognized as a \fIfield\fR but this
 190 will generate a warning.
 191 .TP
 192 .B -Wassign-function-types
 193 Warn when assigning to a function pointer with an unmatching
 194 signature. This usually happens in cases like assigning the null
 195 function to an entity's .think function pointer.
 196 .TP
 197 .B -Wpreprocessor
 198 Enable warnings coming from the preprocessor. Like duplicate macro
 199 declarations.
 200 .TP
 201 .B -Wmultifile-if
 202 Warn if there's a preprocessor \fI#if\fR spanning across several
 203 files.
 204 .TP
 205 .B -Wdouble-declaration
 206 Warn about multiple declarations of globals. This seems pretty common
 207 in QC code so you probably do not want this unless you want to clean
 208 up your code.
 209 .TP
 210 .B -Wconst-var
 211 The combination of \fIconst\fR and \fIvar\fR is not illegal, however
 212 different compilers may handle them differently. We were told, the
 213 intention is to create a function-pointer which is not assignable.
 214 This is exactly how we interpret it. However for this interpretation
 215 the \fIvar\fR keyword is considered superfluous (and philosophically
 216 wrong), so it is possible to generate a warning about this.
 217 .TP
 218 .B -Wmultibyte-character
 219 Warn about multibyte character constants, they do not work right now.
 220 .TP
 221 .B -Wternary-precedence
 222 Warn if a ternary expression which contains a comma operator is used
 223 without enclosing parenthesis, since this is most likely not what you
 224 actually want. We recommend the \fI-fcorrect-ternary\fR option.
 225 .TP
 226 .B -Wunknown-pragmas
 227 Warn when encountering an unrecognized \fI#pragma\fR line.
 228 .TP
 229 .B -Wunreachable-code
 230 Warn about unreachable code. That is: code after a return statement,
 231 or code after a call to a function marked as 'noreturn'.
 232 .TP
 233 .B -Wdebug
 234 Enable some warnings added in order to help debugging in the compiler.
 235 You won't need this.
 236 .SH Compile Flags
 237 .TP
 238 .B -foverlap-locals
 239 Allow local variables to overlap with each other if they don't
 240 interfer with each other. (Not implemented right now)
 241 .TP
 242 .B -fdarkplaces-string-table-bug
 243 Add some additional characters to the string table in order to
 244 compensate for a wrong boundcheck in some specific version of the
 245 darkplaces engine.
 246 .TP
 247 .B -fadjust-vector-fields
 248 When assigning to field pointers of type \fI.vector\fR the common
 249 behaviour in compilers like \fIfteqcc\fR is to only assign the
 250 x-component of the pointer. This means that you can use the vector as
 251 such, but you cannot use its y and z components directly. This flag
 252 fixes this behaviour. Before using it make sure your code does not
 253 depend on the buggy behaviour.
 254 .TP
 255 .B -fftepp
 256 Enable a partially fteqcc-compatible preprocessor. It supports all the
 257 features used in the Xonotic codebase. If you need more, write a
 258 ticket.
 259 .TP
 260 .B -frelaxed-switch
 261 Allow switch cases to use non constant variables.
 262 .TP
 263 .B -fshort-logic
 264 Perform early out in logical AND and OR expressions. The final result
 265 will be either a 0 or a 1, see the next flag for more possibilities.
 266 .TP
 267 .B -fperl-logic
 268 In many languages, logical expressions perform early out in a special
 269 way: If the left operand of an AND yeilds true, or the one of an OR
 270 yields false, the complete expression evaluates to the right side.
 271 Thus \fItrue && 5\fI evaluates to 5 rather than 1.
 272 .TP
 273 .B -ftranslatable-strings
 274 Enable the underscore intrinsic: Using \fI_("A string constant")\fR
 275 will cause the string immediate to get a name with a "dotranslate_"
 276 prefix. The darkplaces engine recognizes these and translates them in
 277 a way similar to how gettext works.
 278 .TP
 279 .B -finitialized-nonconstants
 280 Don't implicitly convert initialized variables to constants. With this
 281 flag, the \fIconst\fR keyword is required to make a constant.
 282 .TP
 283 .B -fassign-function-types
 284 If this flag is not set, (and it is set by default in the qcc and
 285 fteqcc standards), assigning function pointers of mismatching
 286 signatures will result in an error rather than a warning.
 287 .TP
 288 .B -flno
 289 Produce a linenumber file along with the output .dat file.
 290 .TP
 291 .B -fcorrect-ternary
 292 Use C's operator precedence for ternary expressions. Unless your code
 293 depends on fteqcc-compatible behaviour, you'll want to use thi
 294 soption.
 295 .TP
 296 .B -fsingle-vector-defs
 297 Normally vectors generate 4 defs, once for the vector, and once for
 298 its components with _x, _y, _z suffixes. This option
 299 prevents components from being listed.
 300 .SH CONFIG
 301 The configuration file is similar to regular .ini files. Comments
 302 start with hashtags or semicolons, sections are written in square
 303 brackets and in each section there can be arbitrary many key-value
 304 pairs.
 305 .sp
 306 There are 3 sections currently:
 307 .IR flags ", " warnings ", and " optimizations .
 308 They contain a list of boolean values of the form `VARNAME = true` or
 309 `VARNAME = false`. The variable names are the same as for the
 310 corresponding -W, -f or -O flag written with only capital letters and
 311 dashes replaced by underscores.
 312 .sp
 313 Here's an example:
 314 .in +4
 315 .nf
 316 # a GMQCC configuration file
 317 [flags]
 318     FTEPP = true
 319     ADJUST_VECTOR_FIELDS = false
 320     LNO = true
 321
 322 [warnings]
 323     UNUSED_VARIABLE = false
 324     USED_UNINITIALIZED = true
 325
 326 [optimizations]
 327     PEEPHOLE = true
 328     TAIL_RECURSION = true
 329 .fi
 330 .in
 331 .SH BUGS
 332 Please report bugs on <http://github.com/graphitemaster/gmqcc/issues>,
 333 or see <http://graphitemaster.github.com/gmqcc> on how to contact us.
 334 .SH SEE ALSO
 335 .IR qcvm (1)
 336 .SH AUTHOR
 337 See <http://graphitemaster.github.com/gmqcc>.