Difference between revisions of "Precompiler definitions"
(beginning of work on #define/#undef) |
|||
| Line 2: | Line 2: | ||
===#define=== | ===#define=== | ||
<b>Syntax</b>: #define <defname>[(<macroparams>)] [<defvalue>]<br /> | <b>Syntax</b>: #define <defname>[(<macroparams>)] [<defvalue>]<br /> | ||
| + | |||
| + | Defines a precompiler define or macro.<br /> | ||
| + | * <defname> contains the define name | ||
| + | * <macroparams> contains the list of parameters to use with a macro (optional) | ||
| + | * <defvalue> contains the define value (optional) | ||
| + | |||
| + | After statement parsing, <defname> is considered defined. Then, FTEQCC encounters <defname> or #<defname> during parsing, it will be replaced with <defvalue>, or <defname> will be erased if <defvalue> is not defined. If <macroparams> are defined, FTEQCC will then replace parameters found within <defvalue> as appropriate. | ||
| + | |||
| + | Examples: | ||
| + | // Simple defines for use in precompiler control logic later on | ||
| + | #define MONSTERS | ||
| + | #define NEWWEAPONS | ||
| + | |||
| + | // Use of defines as constants | ||
| + | #define NEWWEAPONNAME "chainsaw with lasersight" | ||
| + | string s; | ||
| + | s = NEWWEAPONNAME; // This sets the string s to "chainsaw with lasersight" | ||
| + | s = #NEWWEAPONNAME; // This also sets the string s to "chainsaw with lasersight" | ||
| + | |||
| + | // Simple use of macros | ||
| + | #define ISEQUAL(a,b) (a == b) | ||
| + | float float1, float2; | ||
| + | if (float1 == float2) | ||
| + | dosomething(); | ||
| + | if (ISEQUAL(float1, float2)) // Does the same thing as the previous if | ||
| + | dosomething(); | ||
===#undef=== | ===#undef=== | ||
| − | <b>Syntax</b>: # | + | <b>Syntax</b>: #undef <defname><br /> |
| + | |||
| + | After statement parsing, <defname> is considered undefined. FTEQCC will no longer parse <defname> or #<defname> when it is encountered. | ||
== Control Logic == | == Control Logic == | ||
| Line 54: | Line 82: | ||
===#pack=== | ===#pack=== | ||
| + | |||
| + | ===#packid=== | ||
== Pragma (#pragma) == | == Pragma (#pragma) == | ||
| Line 64: | Line 94: | ||
===#pragma COPYRIGHT=== | ===#pragma COPYRIGHT=== | ||
<b>Syntax</b>: #pragma COPYRIGHT <message><br /> | <b>Syntax</b>: #pragma COPYRIGHT <message><br /> | ||
| + | |||
| + | Changes the string to be embedded at the end of a compiled progs. <message> is the message to embed.<br /> | ||
===#pragma TARGET=== | ===#pragma TARGET=== | ||
Revision as of 22:33, 30 October 2005
Contents
Definitions
#define
Syntax: #define <defname>[(<macroparams>)] [<defvalue>]
Defines a precompiler define or macro.
- <defname> contains the define name
- <macroparams> contains the list of parameters to use with a macro (optional)
- <defvalue> contains the define value (optional)
After statement parsing, <defname> is considered defined. Then, FTEQCC encounters <defname> or #<defname> during parsing, it will be replaced with <defvalue>, or <defname> will be erased if <defvalue> is not defined. If <macroparams> are defined, FTEQCC will then replace parameters found within <defvalue> as appropriate.
Examples:
// Simple defines for use in precompiler control logic later on #define MONSTERS #define NEWWEAPONS // Use of defines as constants #define NEWWEAPONNAME "chainsaw with lasersight" string s; s = NEWWEAPONNAME; // This sets the string s to "chainsaw with lasersight" s = #NEWWEAPONNAME; // This also sets the string s to "chainsaw with lasersight" // Simple use of macros #define ISEQUAL(a,b) (a == b) float float1, float2; if (float1 == float2) dosomething(); if (ISEQUAL(float1, float2)) // Does the same thing as the previous if dosomething();
#undef
Syntax: #undef <defname>
After statement parsing, <defname> is considered undefined. FTEQCC will no longer parse <defname> or #<defname> when it is encountered.
Control Logic
#ifdef
#ifndef
#if
#else
#endif
Something
#message
Syntax: #message <message>
#warning
Syntax: #warning <message>
#error
Syntax: #error <message>
File things
#include
Syntax: #include <file>
#includelist
Syntax: #includelist
#endlist
Syntax: #endlist
#output
Depreciated, use #pragma PROGS_DAT instead.
Second file things
#eof
Syntax: #eof
#forcecrc
Syntax: #forcecrc <crc>
#copyright
Depreciated, use #pragma COPYRIGHT instead.
#datafile
Syntax: #datafile <file>
#pack
#packid
Pragma (#pragma)
#pragma is an extensive precompiler statement which controls many aspects of the compiler.
Note that all unknown #pragma statements encountered by FTEQCC are ignored (with a warning.)
#pragma DONT_COMPILE_THIS_FILE
This pragma is parsed but ignored by FTEQCC so PREQCC-using code can compile cleanly.
#pragma COPYRIGHT
Syntax: #pragma COPYRIGHT <message>
Changes the string to be embedded at the end of a compiled progs. <message> is the message to embed.
#pragma TARGET
Syntax: #pragma TARGET <target>
Switches compiled progs to a specific target type.
<target> can be the following:
- ID, STANDARD: standard Quake progs
- KK7: kkqwsv progs
- H2, HEXEN2: Hexen 2 progs
- FTE: FTE progs
- DEBUG, FTEDEBUG: FTE progs with debug information
It is not recommended to switch target types during compilation.
#pragma PROGS_SRC
This pragma is parsed but ignored by FTEQCC so PREQCC-using code can compile cleanly.
#pragma PROGS_DAT
Syntax: #pragma PROGS_DAT <progsfile>
Changes the destination file you wish to compile to. <progsfile> contains the new file name.
Example:
#ifdef MONSTERS #pragma PROGS_DAT monsters.dat #message FTEQCC will now compile to monsters.dat #else #pragma PROGS_DAT nomonsters.dat #message FTEQCC will now compile to nomonsters.dat #endif
#pragma keyword and #pragma flag
Syntax:
- #pragma keyword <onoroff> <keywordid>
- #pragma flag <onoroff> <keywordid>
#pragma warning
Syntax: #pragma warning <onoroff> <warningid>
