PreProcessor Commands - Revision history

R3vo: replaced example __A3_DIAG__

2026-04-13T14:08:37Z

replaced example __A3_DIAG__

← Older revision		Revision as of 16:08, 13 April 2026
Line 470:		Line 470:
	'''Description:''' Gets replaced by 1 on diag, undefined otherwise.		'''Description:''' Gets replaced by 1 on diag, undefined otherwise.
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
	~~__GAME_BUILD__~~ // 1		__A3_DIAG__// 1
	</syntaxhighlight>		</syntaxhighlight>

Lou Montana: Some wiki formatting

2026-01-11T15:33:58Z

Some wiki formatting

← Older revision		Revision as of 17:33, 11 January 2026
Line 1:		Line 1:
	{{TOC\|side\|0.9}}		{{TOC\|side\|0.9}}
	The PreProcessor and the Config Parser allow to use macros in configs. The purpose of macros is to re-use the same definition in scripts and configs multiple times.		The PreProcessor and the Config Parser allow to use macros in configs.
			The purpose of macros is to re-use the same definition in scripts and configs multiple times.
	It also gives a centralised place to correct errors in this definition.		It also gives a centralised place to correct errors in this definition.
	Know that edge cases may arise - see the collection of test-cases linked at the end of this page.		Know that edge cases may arise - see the collection of test-cases linked at the end of this page.
Line 352:		Line 353:

	'''Description:''' Is replaced for current time.		'''Description:''' Is replaced for current time.
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
	__TIME__ // 15:17:42		__TIME__ // 15:17:42
	</syntaxhighlight>		</syntaxhighlight>

Lou Montana: Fix WORD → ARG

2025-10-22T16:53:04Z

Fix WORD → ARG

← Older revision		Revision as of 18:53, 22 October 2025
Line 1:		Line 1:
	{{TOC\|side\|0.9}}		{{TOC\|side\|0.9}}
	The PreProcessor and the Config Parser allow to use macros in configs. The purpose of macros is to re-use the same definition in scripts and configs multiple times.		The PreProcessor and the Config Parser allow to use macros in configs. The purpose of macros is to re-use the same definition in scripts and configs multiple times.
	It also gives a ~~centralized~~ place to correct errors in this definition.		It also gives a centralised place to correct errors in this definition.
	Know that edge cases may arise - see the collection of test-cases linked at the end of this page.		Know that edge cases may arise - see the collection of test-cases linked at the end of this page.
	{{Feature\|arma3\|In {{arma3}}, preprocessor commands are '''case-sensitive!'''}}		{{Feature\|arma3\|In {{arma3}}, preprocessor commands are '''case-sensitive!'''}}
Line 9:		Line 9:

	See {{Link\|#Config Parser}} below:		See {{Link\|#Config Parser}} below:
	* '''[[Config.cpp]]''' - parsed when PBO is ~~binarized~~.		* '''[[Config.cpp]]''' - parsed when PBO is binarised.
	** [[localize]] cannot be used in macros, as it would hardcode string of current language instead of creating reference.		** [[localize]] cannot be used in macros, as it would hardcode string of current language instead of creating reference.
	* '''[[Description.ext]]''' - parsed when mission is loaded or previewed in missions list.		* '''[[Description.ext]]''' - parsed when mission is loaded or previewed in missions list.
Line 20:		Line 20:

	In both Configs and SQF scripts, there are two ways to define strings: either using single quotes ({{hl\|'text'}}) or double quotes ({{hl\|"text"}}).		In both Configs and SQF scripts, there are two ways to define strings: either using single quotes ({{hl\|'text'}}) or double quotes ({{hl\|"text"}}).
	While they are both identical, they are '''treated differently''' by the preprocessor. The '''single quote''' string contents are '''parsed''' by the preprocessor, while the '''double quote''' ones are '''ignored'''.		While they are both identical, they are '''treated differently''' by the preprocessor.
			The '''single quote''' string contents are '''parsed''' by the preprocessor, while the '''double quote''' ones are '''ignored'''.
	<sqf>		<sqf>
	#define ~~WORD~~ world		#define ARG world

	systemChat 'hello ~~WORD~~'; // prints: hello world (i.e. ~~WORD~~ was replaced by the preprocessor with world)		systemChat 'hello ARG'; // prints: hello world (i.e. ARG was replaced by the preprocessor with world)
	systemChat "hello ~~WORD~~"; // prints: hello ~~WORD~~		systemChat "hello ARG"; // prints: hello ARG
	</sqf>		</sqf>

Lou Montana: Add warning box for unquoted strings

2025-10-22T16:44:23Z

Add warning box for unquoted strings

← Older revision		Revision as of 18:44, 22 October 2025
Line 18:		Line 18:

	=== Strings ===		=== Strings ===

	In both Configs and SQF scripts, there are two ways to define strings: either using single quotes ({{hl\|'text'}}) or double quotes ({{hl\|"text"}}).		In both Configs and SQF scripts, there are two ways to define strings: either using single quotes ({{hl\|'text'}}) or double quotes ({{hl\|"text"}}).
	While they are both identical ~~strings~~, they are '''treated differently''' by the preprocessor. The '''single quote''' string contents are '''parsed''' by the preprocessor, while the '''double quote''' ones are '''ignored'''.		While they are both identical, they are '''treated differently''' by the preprocessor. The '''single quote''' string contents are '''parsed''' by the preprocessor, while the '''double quote''' ones are '''ignored'''.
	<sqf>		<sqf>
	#define WORD world		#define WORD world
Line 26:		Line 27:
	systemChat "hello WORD"; // prints: hello WORD		systemChat "hello WORD"; // prints: hello WORD
	</sqf>		</sqf>

			{{Feature\|warning\|
			While it is possible in config to define a string without quotes (the preprocessor will act as if the value were wrapped with single quotes), this practice is heavily discouraged.
			<syntaxhighlight lang="cpp">
			title = "$STR_TranslationKey"; // good
			title = $STR_TranslationKey; // tolerated but incorrect
			</syntaxhighlight>
			}}

	=== Comments ===		=== Comments ===
Line 31:		Line 40:
	A comment is a line within code that is not actually processed by the game engine. They are used to make code more readable or to add notes for future reference.		A comment is a line within code that is not actually processed by the game engine. They are used to make code more readable or to add notes for future reference.
	The preprocessor removes all comments from the file before it is processed. Therefore, comments are never actually "seen" by the game engine.		The preprocessor removes all comments from the file before it is processed. Therefore, comments are never actually "seen" by the game engine.
	{{Feature\|warning\|Sometimes a problematic string can fail to purge these comment outs during preprocessing!		{{Feature\|warning\|
	<sqf>private _a = '"';		Sometimes a problematic string can fail to purge these comment outs during preprocessing!
	// this is just a comment, but failed to remove upon the preprocess so will return an error. Caused by that string</sqf>}}		<sqf>
			private _a = '"';
			// this is just a comment, but failed to remove upon the preprocess so will return an error. Caused by that string
			</sqf>
			}}
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
	// this is a single-line comment		// this is a single-line comment

	/*		/*
	this is a		this is a
Line 42:		Line 55:
	comment		comment
	*/		*/

	myValue = something; // only this part of the line is commented out		myValue = something; // only this part of the line is commented out

Line 61:		Line 74:
	The define-statement does swallow all spaces in between the macro-keyword and any non-space-character in the body (Note that tabs are not spaces! They don't get removed)		The define-statement does swallow all spaces in between the macro-keyword and any non-space-character in the body (Note that tabs are not spaces! They don't get removed)
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
	#define MACRO test		#define MACRO test
	MACRO // preprocesses to test (without any spaces)		MACRO // preprocesses to test (without any spaces)

Line 100:		Line 113:
	</syntaxhighlight>		</syntaxhighlight>

	Passing arrays with more than one element {{hl\|[el1,el2,...]}} as arguments into macros as well as any argument containing ~~comas~~ {{hl\|"some, sentence"}}, will need a small workaround:		Passing arrays with more than one element {{hl\|[el1,el2,...]}} as arguments into macros as well as any argument containing commas (e.g {{hl\|"some, sentence"}}) will need a small workaround:
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
	#define HINTARG(ARG) hint ("Passed argument: " + str ARG)		#define HINTARG(ARG) hint ("Passed argument: " + str ARG)
Line 112:		Line 125:
	Correct usage:		Correct usage:
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
	#define array1 [1,2,3,4,5,6,7,8,9,0]		#define array1 [1,2,3,4,5,6,7,8,9,0]
	HINTARG(array1); // SUCCESS		HINTARG(array1); // SUCCESS
	</syntaxhighlight>		</syntaxhighlight>
Line 154:		Line 167:
	</syntaxhighlight>		</syntaxhighlight>

	=== #if ===		=== #if ===

	'''Description:''' Checks condition and processes content if condition returns 1. Skips content if it returns 0		'''Description:''' Checks condition and processes content if condition returns 1. Skips content if it returns 0
Line 325:		Line 338:
	'''Description:''' Is replaced for current date in format [[String\|string]].		'''Description:''' Is replaced for current date in format [[String\|string]].
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
	__DATE_STR__ // "2020/10/28, 15:17:42"		__DATE_STR__ // "2020/10/28, 15:17:42"
	</syntaxhighlight>		</syntaxhighlight>

Line 432:		Line 445:
	{{ArgTitle\|3\|__GAME_VER_MAJ__\|{{GVI\|arma3\|2.02}}}}		{{ArgTitle\|3\|__GAME_VER_MAJ__\|{{GVI\|arma3\|2.02}}}}

	'''Description:''' Gets replaced by the ''major'' game version.		'''Description:''' Gets replaced by the ''major'' game version.
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
	__GAME_VER_MAJ__ // 02		__GAME_VER_MAJ__ // 02
Line 585:		Line 598:
	; Problem: Preprocessor failed on file X - error 7.		; Problem: Preprocessor failed on file X - error 7.

	; Known reasons: The preprocessor encountered an unknown directive. Read, as a typo most has likely found a way into the file (something like {{hl\|#~~inlcude~~}} or {{hl\|#~~defien~~}}).<!--		; Known reasons: The preprocessor encountered an unknown directive. Read, as a typo most has likely found a way into the file (something like {{hl\|#in''lc''ude}} or {{hl\|#defi''en''}}).<!--
	--> Double-check all preprocessor directives in that file.		--> Double-check all preprocessor directives in that file.

Line 591:		Line 604:
	== External links ==		== External links ==

	* {{Link\|https~~://web.archive.org/web/20170319190732/http~~://ofp-faguss.com/files/ofp_preprocessor_explained.pdf\|{{ofp}} - Preprocessor Guide (Wayback Machine)}}		* {{Link\|https://ofp-faguss.com/files/ofp_preprocessor_explained.pdf\|{{ofp}} - Preprocessor Guide (Wayback Machine)}}
	* {{Link\|https://github.com/Krzmbrzl/ArmaPreprocessorTestCases\|Collection of preprocessor test-cases}}		* {{Link\|https://github.com/Krzmbrzl/ArmaPreprocessorTestCases\|Collection of preprocessor test-cases}}


	[[Category:Scripting Topics]]		[[Category:Scripting Topics]]

Lou Montana: Reverted edits by Mikero (talk) to last revision by Leopard20

2025-10-22T16:22:30Z

Reverted edits by Mikero (talk) to last revision by Leopard20

← Older revision		Revision as of 18:22, 22 October 2025
Line 18:		Line 18:

	=== Strings ===		=== Strings ===
	~~The definition of a string is ANY line where the variable (eg var =) cannot be processed as a numeric argument.~~		In both Configs and SQF scripts, there are two ways to define strings: either using single quotes ({{hl\|'text'}}) or double quotes ({{hl\|"text"}}).
	~~thus:~~		While they are both identical strings, they are '''treated differently''' by the preprocessor. The '''single quote''' string contents are '''parsed''' by the preprocessor, while the '''double quote''' ones are '''ignored'''.
	~~var= hello 123;// is a string, quotes in this example are effectively 'hello 123`.~~

	In both Configs and SQF scripts, there are two ways to define strings: either {{hl\|'~~this is a string~~'}} or {{hl\|"~~this is a string~~"}}.
	While they are both strings, they are '''treated differently''' by the preprocessor. The '''single quote''' string contents are '''parsed''' by the preprocessor, while the '''double quote''' ones are '''ignored'''.
	~~note that neither the surrounding ' or " pairs are stored in the output file~~.
	<sqf>		<sqf>
	#define WORD world		#define WORD world

Mikero at 05:22, 2 May 2025

2025-05-02T05:22:30Z

← Older revision		Revision as of 07:22, 2 May 2025
Line 18:		Line 18:

	=== Strings ===		=== Strings ===
	In both Configs and SQF scripts, there are two ways to define strings: either ~~using single quotes (~~{{hl\|'~~text~~'}}) or ~~double quotes (~~{{hl\|"~~text~~"}}).		The definition of a string is ANY line where the variable (eg var =) cannot be processed as a numeric argument.
	While they are both ~~identical~~ strings, they are '''treated differently''' by the preprocessor. The '''single quote''' string contents are '''parsed''' by the preprocessor, while the '''double quote''' ones are '''ignored'''.		thus:
			var= hello 123;// is a string, quotes in this example are effectively 'hello 123`.

			In both Configs and SQF scripts, there are two ways to define strings: either {{hl\|'this is a string'}} or {{hl\|"this is a string"}}.
			While they are both strings, they are '''treated differently''' by the preprocessor. The '''single quote''' string contents are '''parsed''' by the preprocessor, while the '''double quote''' ones are '''ignored'''.
			note that neither the surrounding ' or " pairs are stored in the output file.
	<sqf>		<sqf>
	#define WORD world		#define WORD world

Leopard20 at 09:41, 28 April 2025

2025-04-28T09:41:37Z

← Older revision		Revision as of 11:41, 28 April 2025
Line 18:		Line 18:

	=== Strings ===		=== Strings ===
	In both Configs and SQF scripts, there are two ways to define strings: either {{hl\|'~~this is a string~~'}} or {{hl\|"~~this is a string~~"}}.		In both Configs and SQF scripts, there are two ways to define strings: either using single quotes ({{hl\|'text'}}) or double quotes ({{hl\|"text"}}).
	While they are both identical strings, they are '''treated differently''' by the preprocessor. The '''single quote''' string contents are '''parsed''' by the preprocessor, while the '''double quote''' ones are '''ignored'''.		While they are both identical strings, they are '''treated differently''' by the preprocessor. The '''single quote''' string contents are '''parsed''' by the preprocessor, while the '''double quote''' ones are '''ignored'''.
	<sqf>		<sqf>

Leopard20 at 08:51, 28 April 2025

2025-04-28T08:51:02Z

← Older revision		Revision as of 10:51, 28 April 2025
Line 19:		Line 19:
	=== Strings ===		=== Strings ===
	In both Configs and SQF scripts, there are two ways to define strings: either {{hl\|'this is a string'}} or {{hl\|"this is a string"}}.		In both Configs and SQF scripts, there are two ways to define strings: either {{hl\|'this is a string'}} or {{hl\|"this is a string"}}.
	While they are both strings, they are '''treated differently''' by the preprocessor. The '''single quote''' string contents are '''parsed''' by the preprocessor, while the '''double quote''' ones are '''ignored'''.		While they are both identical strings, they are '''treated differently''' by the preprocessor. The '''single quote''' string contents are '''parsed''' by the preprocessor, while the '''double quote''' ones are '''ignored'''.
	<sqf>		<sqf>
	#define WORD world		#define WORD world

Leopard20 at 08:49, 28 April 2025

2025-04-28T08:49:53Z

← Older revision		Revision as of 10:49, 28 April 2025
Line 16:		Line 16:

	== Macros ==		== Macros ==

			=== Strings ===
			In both Configs and SQF scripts, there are two ways to define strings: either {{hl\|'this is a string'}} or {{hl\|"this is a string"}}.
			While they are both strings, they are '''treated differently''' by the preprocessor. The '''single quote''' string contents are '''parsed''' by the preprocessor, while the '''double quote''' ones are '''ignored'''.
			<sqf>
			#define WORD world

			systemChat 'hello WORD'; // prints: hello world (i.e. WORD was replaced by the preprocessor with world)
			systemChat "hello WORD"; // prints: hello WORD
			</sqf>

	=== Comments ===		=== Comments ===

Leopard20 at 20:07, 19 December 2024

2024-12-19T20:07:35Z

← Older revision		Revision as of 22:07, 19 December 2024
Line 213:		Line 213:
	Source directory is:		Source directory is:
	* For any file without starting the include path with \ - the file's current directory		* For any file without starting the include path with \ - the file's current directory
	* When starting with \ - the internal filesystem root (see [[~~CMA~~:~~DevelopmentSetup~~#~~Addon_development~~\|Addon ~~Development~~]]) or the Game's working directory (only with [[Arma 3: Startup Parameters\|-filePatching]] enabled)		* When starting with \ - the internal filesystem root (see [[Arma_3:_Creating_an_Addon#Addon_Prefix\|Addon Prefix]]) or the Game's working directory (only with [[Arma 3: Startup Parameters\|-filePatching]] enabled)

	A path beginning can be defined as follow:		A path beginning can be defined as follow: