Preprocessorref - Revision history

Bssarkar: /* #deprecated */ Add more explanation about #deprecated arguments, and mention optionality

2026-03-29T16:36:11Z

‎#deprecated: Add more explanation about #deprecated arguments, and mention optionality

Bssarkar: /* #define */ Mention define/enddef non-nesting requirement (cf. GNA #21343)

2026-03-20T15:50:21Z

‎#define: Mention define/enddef non-nesting requirement (cf. GNA #21343)

Bssarkar: /* #define */ Convert to named link

2024-11-03T15:21:57Z

‎#define: Convert to named link

Pentarctagon: /* #arg */

2024-08-29T23:47:31Z

‎#arg

Pentarctagon: /* #arg */

2024-08-29T23:43:16Z

‎#arg

Soliton: /* Command-line preprocessor */ Correct relative path explanation

2024-08-05T07:29:19Z

‎Command-line preprocessor: Correct relative path explanation

Soliton: /* Command-line preprocessor */ Clarify what is included by default

2024-08-05T07:23:43Z

‎Command-line preprocessor: Clarify what is included by default

White haired uncle: /* Command-line preprocessor */

2024-08-05T06:10:07Z

‎Command-line preprocessor

White haired uncle: /* Command-line preprocessor */

2024-08-05T06:09:22Z

‎Command-line preprocessor

White haired uncle: Added example for input/output macros

2024-08-02T12:08:29Z

Added example for input/output macros

@@ Line 298: / Line 298: @@
 {{DevFeature1.13|11}}
-'''Syntax:''' '''#deprecated 1 ''message'''''
+'''Syntax:''' '''#deprecated 1 [''message'']'''
-'''Syntax:''' '''#deprecated 2 ''version'' ''message'''''
+'''Syntax:''' '''#deprecated 2 [''version'' ''message'']'''
-'''Syntax:''' '''#deprecated 3 ''version'' ''message'''''
+'''Syntax:''' '''#deprecated 3 [''version'' ''message'']'''
-'''Syntax:''' '''#deprecated 4 ''message'''''
+'''Syntax:''' '''#deprecated 4 [''message'']'''
 The effect of this directive depends on whether it appears within a macro definition.

@@ Line 22: / Line 22: @@
 '''Syntax: #define ''symbol'' [''parameters''] ''<newline>'' ''substitution'' #enddef'''
-All subsequent occurences of '''{''symbol'' [''arguments'']}''' (see below) will be replaced by the contents of the ''substitution'' block, with all occurrences of any parameter {''parameter''} within ''substitution'' replaced by the corresponding value in ''arguments''. For example, the ENEMY_UNIT macro for the [[#Macro inclusions|macro inclusion]] example below could be defined as follows:
+All subsequent occurences of '''{''symbol'' [''arguments'']}''' (see below) will be replaced by the contents of the ''substitution'' block, with all occurrences of any parameter {''parameter''} within ''substitution'' replaced by the corresponding value in ''arguments''. <code>#define-#enddef</code> blocks cannot be nested inside another <code>#define</code>, as of Wesnoth 1.19.
 <syntaxhighlight lang="wml">

@@ Line 45: / Line 45: @@
 (See [[SingleUnitWML]] for further information on creating units using WML.)
-'''Important note:''' Although macros may look like they're simplifying the code, they do not help with wml bloating. Macros are very good at ''disguising'' WML bloat, but they do nothing to ''alleviate'' it. So instead of using macros to generate redundant and repetitive instructions, you should be considering how to eliminate redundancy through programming techniques of abstraction. The most popular way to improve your code is using custom [[EventWML|events]] and [[InternalActionsWML#.5Bfire_event.5D|fire_event]] tags. See also: [[Wml_optimisation]].
+'''Important note:''' Although macros may look like they're simplifying the code, they do not help with wml bloating. Macros are very good at ''disguising'' WML bloat, but they do nothing to ''alleviate'' it. So instead of using macros to generate redundant and repetitive instructions, you should be considering how to eliminate redundancy through programming techniques of abstraction. The most popular way to improve your code is using custom [[EventWML|events]] and [[InternalActionsWML#.5Bfire_event.5D|fire_event]] tags. See also: [[Wml_optimisation|WML Optimisation]].
 ==== Whitespace in Macros ====

@@ Line 108: / Line 108: @@
 {MESSAGE _"Welcome!" CAPTION=_"Elóndra's shop of wonders" IMG=portraits/elves/shyde.png}
 {MESSAGE _"*smash*" SPEAKER_ID="Bridge Troll" SOUND=mace.ogg}
 </syntaxhighlight>

@@ Line 80: / Line 80: @@
 #arg SPEAKER_ID
-narrator
+narrator#endarg
 #arg CAPTION

@@ Line 336: / Line 336: @@
 The command will first preprocess '''data/core/macros''' and '''data/core/terrain-graphics''', and afterwards the specified path. You can specify a single file to be preprocessed (if you want to preprocess multiple separate files, you'll need to run a different command line for each one), or an entire directory, which will be preprocessed according to the rules used by the inclusion directive above.
-The resulted preprocessed files will be written in the target directory. There will be two types of files: .cfg files --- the normal ones, and .plain files containing line markers and textdomain changes.
+The resulting preprocessed files will be written in the target directory. There will be two types of files: .cfg files --- the normal ones, and .plain files containing line markers and textdomain changes.
 If by chance, the simple macro define doesn't suffice, you can use:
@@ Line 348: / Line 348: @@
 '''Syntax: --preprocess-output-macros [<target file>]'''
-This file could be fed to the 'input-macros' argument next time you run it. For example, a scenario  would be: parsing just the core first time, and for the intended target files, you would add SKIP_CORE but import the generated macros file - that will be faster than preprocessing the core again. If the target file is not specified, the output file will be _MACROS_.cfg in the target directory of the preprocess's command.
+This file could be fed to the 'input-macros' argument next time you run it. For example, a scenario would be: parsing just the core first time, and for the intended target files, you would add SKIP_CORE but import the generated macros file - that will be faster than preprocessing the core again. If the target file is not specified, the output file will be _MACROS_.cfg in the target directory of the preprocess's command.
-If ''file/directory'' and ''target directory'' are not absolute paths, they will be considered relative to the game's executable path.
+If ''file/directory'' and ''target directory'' are not absolute paths, they will be considered relative to the current directory.
 Some examples:

@@ Line 334: / Line 334: @@
 comma separated list of defines to be used by '--preprocess' command. If 'SKIP_CORE' is in the define list the data/core won't be preprocessed.
-The command will preprocess first the common config files in the main game ''data/'' directory, and afterwards the specified ones. You can specify a single file to be preprocessed (if you want to preprocess multiple separate files, you'll need to run a different command line for each one), or an entire directory, which will be preprocessed according to the rules used by the inclusion directive above.
+The command will first preprocess '''data/core/macros''' and '''data/core/terrain-graphics''', and afterwards the specified path. You can specify a single file to be preprocessed (if you want to preprocess multiple separate files, you'll need to run a different command line for each one), or an entire directory, which will be preprocessed according to the rules used by the inclusion directive above.
 The resulted preprocessed files will be written in the target directory. There will be two types of files: .cfg files --- the normal ones, and .plain files containing line markers and textdomain changes.

@@ Line 368: / Line 368: @@
 * File myfile.cfg depends on macros defined in data/gui/macros/_initial.cfg:
    Add {gui/macros/_initial.cfg} to the beginning of  myfile.cfg
-   p myfile.cfg ~/result
+   -p myfile.cfg ~/result
 If you want a more detailed (and potentially overwhelming) log, you can simply add the switches '''--log-debug=all''' or '''--log-info=all''' to the command line, so you can see how things are preprocessed in detail.

@@ Line 363: / Line 363: @@
   -p data/gui/macros/_initial.cfg  /tmp --preprocess-output-macros=macros
   -p myfile.cfg ~/result --preprocess-input-macros=/tmp/macros
 If you want a more detailed (and potentially overwhelming) log, you can simply add the switches '''--log-debug=all''' or '''--log-info=all''' to the command line, so you can see how things are preprocessed in detail.

@@ Line 360: / Line 360: @@
 * Add the MY_CAMPAIGN and HARD defines before preprocessing a campaign's files:
   -p ~/.wesnoth/data/add-ons/My_Campaign ~/result --preprocess-defines=MY_CAMPAIGN,HARD
 If you want a more detailed (and potentially overwhelming) log, you can simply add the switches '''--log-debug=all''' or '''--log-info=all''' to the command line, so you can see how things are preprocessed in detail.