Programmer Guide/Source code - Revision history

Jw: /* Statements */

2019-08-16T07:50:04Z

Statements

← Older revision		Revision as of 09:50, 16 August 2019
Line 72:		Line 72:
	<code>{<var>label</var>'':''}{{<var>targetstring</var> :=} <var>commandstring</var>}</code>		<code>{<var>label</var>'':''}{{<var>targetstring</var> :=} <var>commandstring</var>}</code>

	;<var>label</var>: A label defines a target which can be used to change the program flow. A label is a string without whitespace and must start with a letter or the underline character (''_''). It must be unique within the enclosing macro. If a label is used to define a local subroutine/function that can be called using the ([[Programmer_Guide/Command_Reference/~~GOTO_and_GOSUB~~\|GOSUB]] command, its definition can also define whether parameters passed by the caller are processed or not. The argument parsing is defined in brackets with the same syntax and rules as for the macro header.		;<var>label</var>: A label defines a target which can be used to change the program flow. A label is a string without whitespace and must start with a letter or the underline character (''_''). It must be unique within the enclosing macro. If a label is used to define a local subroutine/function that can be called using the ([[Programmer_Guide/Command_Reference/GOSUB\|GOSUB]] command, its definition can also define whether parameters passed by the caller are processed or not. The argument parsing is defined in brackets with the same syntax and rules as for the macro header.
	::Examples:		::Examples:
	::<code>jumpToMe:<br>callMe(read: #arg1';'#arg2):<br>callMeWithOptions(argopt: #arg1=1 #arg2 #arg3):</code>		::<code>jumpToMe:<br>callMe(read: #arg1';'#arg2):<br>callMeWithOptions(argopt: #arg1=1 #arg2 #arg3):</code>

Jw: /* Definition of Classes */

2019-08-07T06:17:35Z

Definition of Classes

← Older revision		Revision as of 08:17, 7 August 2019
Line 100:		Line 100:
	;<var>classname</var>: The name of the class.		;<var>classname</var>: The name of the class.

	;<var>parentclass</var>: The name of the parent class. If not specified, the class has no parent class. It is ~~recommened~~ that classes are directly or indirectly derived from [[Programmer_Guide/Class_Library/CObj\|CObj]]. If [[Programmer_Guide/Class_Library/CObj\|CObj]] is not used as base class, some standard functionalities (like message handling, serialisation, ..) are not available to the class.		;<var>parentclass</var>: The name of the parent class. If not specified, the class has no parent class. It is recommended that classes are directly or indirectly derived from [[Programmer_Guide/Class_Library/CObj\|CObj]]. If [[Programmer_Guide/Class_Library/CObj\|CObj]] is not used as base class, some standard functionalities (like message handling, serialisation, ..) are not available to the class.

	====Statements====		====Statements====

Jw: /* Header */

2018-08-06T08:32:03Z

Header

← Older revision		Revision as of 10:32, 6 August 2018
Line 59:		Line 59:
	[MACRO <var>macroname</var> ARG: <var>argname1</var>{=<var>defaultvalue1</var>} ...]		[MACRO <var>macroname</var> ARG: <var>argname1</var>{=<var>defaultvalue1</var>} ...]
	[MACRO <var>macroname</var> ARGS: <var>argname1</var>{=<var>defaultvalue1</var>} ...]		[MACRO <var>macroname</var> ARGS: <var>argname1</var>{=<var>defaultvalue1</var>} ...]
	:ARG-style argument parsing. This form uses the [[Programmer_Guide/Command_Reference/ARG\|ARG]] command, and stores each argument in the i-th argument variable. The parsing ~~rulses~~ are the same as for build-in commands without options.		:ARG-style argument parsing. This form uses the [[Programmer_Guide/Command_Reference/ARG\|ARG]] command, and stores each argument in the i-th argument variable. The parsing rules are the same as for build-in commands without options.

	[MACRO <var>macroname</var> ARGOPT: <var>argname1</var>{=<var>defaultvalue1</var>} ...]		[MACRO <var>macroname</var> ARGOPT: <var>argname1</var>{=<var>defaultvalue1</var>} ...]
	:ARGOPT-style argument parsing. This form uses the [[Programmer_Guide/Command_Reference/ARG\|ARG]] command, and stores each argument in the i-th argument variable. The parsing ~~rulses~~ are the same as for build-in commands with options. The [[Programmer_Guide/Command_Reference/ARG\|ARG]] command ca be used to access/check options and option values.		:ARGOPT-style argument parsing. This form uses the [[Programmer_Guide/Command_Reference/ARG\|ARG]] command, and stores each argument in the i-th argument variable. The parsing rules are the same as for build-in commands with options. The [[Programmer_Guide/Command_Reference/ARG\|ARG]] command ca be used to access/check options and option values.
	:important variables: '''#QARGV''', '''#QARGC'''		:important variables: '''#QARGV''', '''#QARGC'''

	For some examples of macros using different argument parsing styles, see the ~~scirpt~~ <code>script\examples\macro argument_parsing_example.sts</code>.		For some examples of macros using different argument parsing styles, see the script <code>script\examples\macro argument_parsing_example.sts</code>.

	===Statements===		===Statements===

Jw: /* Definition of Macros */

2018-01-18T08:42:13Z

Definition of Macros

← Older revision		Revision as of 10:42, 18 January 2018
Line 47:		Line 47:
	==Definition of Macros==		==Definition of Macros==
	===Header===		===Header===
	A macro is defined by one of the section headers listed below. The possible formats differ only in how arguments are processed or parsed before the first macro statement is executed. The optional ~~visibility~~ tag is omitted in this description, because it described in detail in the chapter [[#Section_Header\|section header]].		A macro is defined by one of the section headers listed below. The possible formats differ only in how arguments are processed or parsed before the first macro statement is executed. The optional scope tag is omitted in this description, because it described in detail in the chapter [[#Section_Header\|section header]].

	[MACRO <var>macroname</var>]		[MACRO <var>macroname</var>]

Jw: /* Definition of Macros */

2018-01-18T08:41:28Z

Definition of Macros

← Older revision		Revision as of 10:41, 18 January 2018
Line 46:		Line 46:

	==Definition of Macros==		==Definition of Macros==
	====Header====		===Header===
	A macro is defined by one of the section headers listed below. The possible formats differ only in how arguments are processed or parsed before the first macro statement is executed. The optional visibility tag is omitted in this description, because it described in detail in the chapter [[#Section_Header\|section header]].		A macro is defined by one of the section headers listed below. The possible formats differ only in how arguments are processed or parsed before the first macro statement is executed. The optional visibility tag is omitted in this description, because it described in detail in the chapter [[#Section_Header\|section header]].

Line 67:		Line 67:
	For some examples of macros using different argument parsing styles, see the scirpt <code>script\examples\macro argument_parsing_example.sts</code>.		For some examples of macros using different argument parsing styles, see the scirpt <code>script\examples\macro argument_parsing_example.sts</code>.

	====Statements====		===Statements===
	Each macro statement contains one command and/or a <var><span id="labels">label</span></var>. The command consists of the <var>commandstring</var> and the optional <var>targetstring</var>. The statements are processed line by line. Special [[#Control_statements\|control statements]] can be used to change the processing order. The syntax of a statement is as follows:		Each macro statement contains one command and/or a <var><span id="labels">label</span></var>. The command consists of the <var>commandstring</var> and the optional <var>targetstring</var>. The statements are processed line by line. Special [[#Control_statements\|control statements]] can be used to change the processing order. The syntax of a statement is as follows:

Jw: /* Header */

2018-01-18T08:40:20Z

Header

← Older revision		Revision as of 10:40, 18 January 2018
Line 57:		Line 57:
	:important variables: <var>#ARGV</var>, <var>#ARGC</var>		:important variables: <var>#ARGV</var>, <var>#ARGC</var>

	~~<code>~~[MACRO <var>macroname</var> ARG: <var>argname1</var>{=<var>defaultvalue1</var>} ...]<BR>~~[MACRO~~ macroname ARGS: <var>argname1</var>{=<var>defaultvalue1</var>} ...]~~</code>~~		[MACRO <var>macroname</var> ARG: <var>argname1</var>{=<var>defaultvalue1</var>} ...]
			[MACRO <var>macroname</var> ARGS: <var>argname1</var>{=<var>defaultvalue1</var>} ...]
	:ARG-style argument parsing. This form uses the [[Programmer_Guide/Command_Reference/ARG\|ARG]] command, and stores each argument in the i-th argument variable. The parsing rulses are the same as for build-in commands without options.		:ARG-style argument parsing. This form uses the [[Programmer_Guide/Command_Reference/ARG\|ARG]] command, and stores each argument in the i-th argument variable. The parsing rulses are the same as for build-in commands without options.

	~~<code>~~[MACRO <var>macroname</var> ARGOPT: <var>argname1</var>{=<var>defaultvalue1</var>} ...]~~</code>~~		[MACRO <var>macroname</var> ARGOPT: <var>argname1</var>{=<var>defaultvalue1</var>} ...]
	:ARGOPT-style argument parsing. This form uses the [[Programmer_Guide/Command_Reference/ARG\|ARG]] command, and stores each argument in the i-th argument variable. The parsing rulses are the same as for build-in commands with options. The [[Programmer_Guide/Command_Reference/ARG\|ARG]] command ca be used to access/check options and option values.		:ARGOPT-style argument parsing. This form uses the [[Programmer_Guide/Command_Reference/ARG\|ARG]] command, and stores each argument in the i-th argument variable. The parsing rulses are the same as for build-in commands with options. The [[Programmer_Guide/Command_Reference/ARG\|ARG]] command ca be used to access/check options and option values.
	:important variables: '''#QARGV''', '''#QARGC'''		:important variables: '''#QARGV''', '''#QARGC'''

Jw: /* Header */

2018-01-18T08:38:21Z

Header

← Older revision		Revision as of 10:38, 18 January 2018
Line 54:		Line 54:

	[MACRO <var>macroname</var> {READ:} <var>argname<sub>1</sub></var>{=<var>defaultvalue<sub>1</sub></var>} {separator<sub>1</sub>} …]		[MACRO <var>macroname</var> {READ:} <var>argname<sub>1</sub></var>{=<var>defaultvalue<sub>1</sub></var>} {separator<sub>1</sub>} …]
	:''<code>READ</code>-style'' argument parsing: The arguments are parsed as strings, internally using the [[Programmer_Guide/Command_Reference/READ\|READVAR]] command before the first macro statement is executed. The programmer can select arbitrary separators by supplying the <code>separator<sub>n</sub></code> arguments. If an argument value is specified in the call, it is assigned to the argument, otherwise the default value defined in the header is assigned to the argument. A default value must not contain whitespace characters. If more arguments are passed in a macro call than defined in the header, the last argument contains all remaining arguments. If no default value is assigned to an argument, its value is the empty string. If no separator is ~~spezified~~ between two arguments, all whitespace characters are considered separators.		:''<code>READ</code>-style'' argument parsing: The arguments are parsed as strings, internally using the [[Programmer_Guide/Command_Reference/READ\|READVAR]] command before the first macro statement is executed. The programmer can select arbitrary separators by supplying the <code>separator<sub>n</sub></code> arguments. If an argument value is specified in the call, it is assigned to the argument, otherwise the default value defined in the header is assigned to the argument. A default value must not contain whitespace characters. If more arguments are passed in a macro call than defined in the header, the last argument contains all remaining arguments. If no default value is assigned to an argument, its value is the empty string. If no separator is specified between two arguments, all whitespace characters are considered separators.
	:important variables: <var>#ARGV</var>, <var>#ARGC</var>		:important variables: <var>#ARGV</var>, <var>#ARGC</var>

Jw: /* Libraries */

2017-05-30T09:21:30Z

Libraries

← Older revision		Revision as of 11:21, 30 May 2017
Line 217:		Line 217:
	...		...
	The <code>Libraries</code> section can be used to specify other source files (libraries), to be loaded '''after''' the script file. Files listed in this section must be {{STX}} script files located in the ''current directory'' or the directoy of the main script file (variable <code>ScriptFileDirectory</code>). This section is processed when a script is loaded into the [[Programmer_Guide/BScript\|script runtime environment]].		The <code>Libraries</code> section can be used to specify other source files (libraries), to be loaded '''after''' the script file. Files listed in this section must be {{STX}} script files located in the ''current directory'' or the directoy of the main script file (variable <code>ScriptFileDirectory</code>). This section is processed when a script is loaded into the [[Programmer_Guide/BScript\|script runtime environment]].
	* Note: The <Code>Libraries</code> section can not be used to load the '''parents''' of classes defined in a script file, because parents must be ~~laoded~~ before derived classes!		* Note: The <Code>Libraries</code> section can not be used to load the '''parents''' of classes defined in a script file, because parents must be loaded before derived classes!

	===Scripts===		===Scripts===

Jw: /* Header */

2017-01-12T08:09:06Z

Header

← Older revision		Revision as of 10:09, 12 January 2017
Line 58:		Line 58:

	<code>[MACRO <var>macroname</var> ARG: <var>argname1</var>{=<var>defaultvalue1</var>} ...]<BR>[MACRO macroname ARGS: <var>argname1</var>{=<var>defaultvalue1</var>} ...]</code>		<code>[MACRO <var>macroname</var> ARG: <var>argname1</var>{=<var>defaultvalue1</var>} ...]<BR>[MACRO macroname ARGS: <var>argname1</var>{=<var>defaultvalue1</var>} ...]</code>
	:ARG-style argument parsing. This form uses the ARG command, and stores each argument in the i-th argument variable. The parsing rulses are the same as for build-in commands without options.		:ARG-style argument parsing. This form uses the [[Programmer_Guide/Command_Reference/ARG\|ARG]] command, and stores each argument in the i-th argument variable. The parsing rulses are the same as for build-in commands without options.

	<code>[MACRO <var>macroname</var> ARGOPT: <var>argname1</var>{=<var>defaultvalue1</var>} ...]</code>		<code>[MACRO <var>macroname</var> ARGOPT: <var>argname1</var>{=<var>defaultvalue1</var>} ...]</code>

Jw: /* Header */

2017-01-12T08:07:24Z

Header

← Older revision		Revision as of 10:07, 12 January 2017
Line 47:		Line 47:
	==Definition of Macros==		==Definition of Macros==
	====Header====		====Header====
	A macro is defined by one of the section headers listed below. The possible formats differ only in how arguments are processed or parsed before the first macro statement is executed. The optional visibility tag is omitted in this description, because it described in detail in the chapter [[#~~Section_header~~\|section header]].		A macro is defined by one of the section headers listed below. The possible formats differ only in how arguments are processed or parsed before the first macro statement is executed. The optional visibility tag is omitted in this description, because it described in detail in the chapter [[#Section_Header\|section header]].

	[MACRO <var>macroname</var>]		[MACRO <var>macroname</var>]