Programmer Guide/Command Reference/DISPATCH - Revision history

Christian at 16:12, 23 March 2011

2011-03-23T16:12:38Z

← Older revision		Revision as of 18:12, 23 March 2011
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	The <code>DISPATCH</code> command, well, dispatches a call to a class, i.e. a call where a class is being called like a macro. In this case, the <code>DISPATCH</code> command regards the first argument supplied to the class call as a function to invoke (see below), and the remaining arguments as arguments to these functions.		The <code>DISPATCH</code> command, well, dispatches a call to a class, i.e. a call where a class is being called like a macro. In this case, the <code>DISPATCH</code> command regards the first argument supplied to the class call as a function to invoke (see below), and the remaining arguments as arguments to these functions.
	DISPATCH <var>function argList</var> [/Call] [/Silent] [/Prefix=<var>X</var>] [/To=<var>Y</var>] [/Fail=<var>Z</var>]		DISPATCH <var>function argList</var> [ /Call ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ] [ /Prefix=<var>X</var> ] [ /To=<var>Y</var> ] [ /Fail=<var>Z</var> ]

	DISPATCH <var>function argList</var> [/Call] [/Silent] [/Prefix=<var>X</var>] [/To=<var>Y</var>] [/Fail=<var>Z</var>]		DISPATCH <var>function argList</var> [ /Call ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ] [ /Prefix=<var>X</var> ] [ /To=<var>Y</var> ] [ /Fail=<var>Z</var> ]
	'''/Read''' [ /Var=<var>A</var> /Delim=<var>C</var> /Args=<var>D</var> ]		'''/Read''' [ /Var=<var>A</var> /Delim=<var>C</var> /Args=<var>D</var> ]

Line 16:		Line 16:
	== Options ==		== Options ==

	;<var>/Silent</var>		;<var>[[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]]</var>
	:If the command fails, it reports a warning instead of an error.		:If the command fails, it reports a warning instead of an error.

Christian at 15:16, 23 March 2011

2011-03-23T15:16:33Z

← Older revision		Revision as of 17:16, 23 March 2011
Line 13:		Line 13:

	You may influence all these parameters by either supplying arguments or options to the <code>DISPATCH</code> commands. There are the following options:		You may influence all these parameters by either supplying arguments or options to the <code>DISPATCH</code> commands. There are the following options:

			== Options ==

	;<var>/Silent</var>		;<var>/Silent</var>
Line 31:		Line 33:
	;<var>/Call</var>		;<var>/Call</var>
	:Normally, the <code>DISPATCH</code> command will simply jump to the respective label. Now, if you supply the <code>/Call</code> option, instead of jumping (the [[Programmer_Guide/Command_Reference/GOTO\|GOTO]] way), the command will <em>call</em> the respective label (the [[Programmer_Guide/Command_Reference/GOSUB\|GOSUB]] way). In this case, as soon as the control flow reaches an appropriate <code>[[Programmer_Guide/Command_Reference/EXIT\|EXIT]]</code> statement, it will resume with the statement following the <code>DISPATCH /Call</code> command.		:Normally, the <code>DISPATCH</code> command will simply jump to the respective label. Now, if you supply the <code>/Call</code> option, instead of jumping (the [[Programmer_Guide/Command_Reference/GOTO\|GOTO]] way), the command will <em>call</em> the respective label (the [[Programmer_Guide/Command_Reference/GOSUB\|GOSUB]] way). In this case, as soon as the control flow reaches an appropriate <code>[[Programmer_Guide/Command_Reference/EXIT\|EXIT]]</code> statement, it will resume with the statement following the <code>DISPATCH /Call</code> command.

			== Additional <code>READ</code>-style Options ==

	When using <code>READ</code>-style parsing, i.e. when supplying the "/Read" option, there are the following additional options:		When using <code>READ</code>-style parsing, i.e. when supplying the "/Read" option, there are the following additional options:

Christian at 15:15, 23 March 2011

2011-03-23T15:15:48Z

← Older revision		Revision as of 17:15, 23 March 2011
Line 45:		Line 45:

	:If you supply this option, the command will store the arguments (less the command argument!) to the variable <code>D</code>.		:If you supply this option, the command will store the arguments (less the command argument!) to the variable <code>D</code>.

	~~;<var>/C</var>~~

	:Select the style of call to be used. If not specified, a <code>[[Programmer Guide/Command Reference/GOTO and GOSUB\|GOTO]]</code> command is used to jump to the command/default label. If /C is specified, a <code>[[Programmer Guide/Command Reference/GOTO and GOSUB\|GOSUB]]</code> command is used to call the command/default subroutine.

	See the script <code>dispatch_example.sts</code> for an example of usage.		See the script <code>dispatch_example.sts</code> for an example of usage.

Christian at 15:14, 23 March 2011

2011-03-23T15:14:48Z

← Older revision		Revision as of 17:14, 23 March 2011
Line 29:		Line 29:
	:Use this option if your class is being supplied with READ-style instead of [[Programmer Guide/Command Reference/ARG\|ARG]]-style options (the latter is the default).		:Use this option if your class is being supplied with READ-style instead of [[Programmer Guide/Command Reference/ARG\|ARG]]-style options (the latter is the default).

	;<~~car~~>/Call</var>		;<var>/Call</var>
	:Normally, the <code>DISPATCH</code> command will simply jump to the respective label. Now, if you supply the <code>/Call</code> option, instead of jumping (the GOTO way), the command will <em>call</em> the respective label (the GOSUB way). In this case, as soon as the control flow reaches an appropriate <code>EXIT</code> statement, it will resume with the statement following the <code>DISPATCH /Call</code> command.		:Normally, the <code>DISPATCH</code> command will simply jump to the respective label. Now, if you supply the <code>/Call</code> option, instead of jumping (the [[Programmer_Guide/Command_Reference/GOTO\|GOTO]] way), the command will <em>call</em> the respective label (the [[Programmer_Guide/Command_Reference/GOSUB\|GOSUB]] way). In this case, as soon as the control flow reaches an appropriate <code>[[Programmer_Guide/Command_Reference/EXIT\|EXIT]]</code> statement, it will resume with the statement following the <code>DISPATCH /Call</code> command.

	When using <code>READ</code>-style parsing, i.e. when supplying the "/Read" option, there are the following additional options:		When using <code>READ</code>-style parsing, i.e. when supplying the "/Read" option, there are the following additional options:

Christian at 15:13, 23 March 2011

2011-03-23T15:13:28Z

← Older revision		Revision as of 17:13, 23 March 2011
Line 6:		Line 6:
	'''/Read''' [ /Var=<var>A</var> /Delim=<var>C</var> /Args=<var>D</var> ]		'''/Read''' [ /Var=<var>A</var> /Delim=<var>C</var> /Args=<var>D</var> ]

	By default, the function to be invoked is a label whose name is built up from the static prefix "<code>Cmd</code>" and the first argument supplied to the class call. If, for example, there is a class called "<code>Example</code>", and you invoke it with the statement "<code>Example test one two three</code>", the DISPATCH command will jump to the label called "<code>Cmdtest</code>", supplying it with the arguments "<code>one</code>", "<code>two</code>", and "<code>three</code>", respectively.		By default, the function to be invoked is a label whose name is built up from the static prefix <code>Cmd</code> and the first argument supplied to the class call. If, for example, there is a class called <code>Example</code>, and you invoke it with the statement <code>Example test one two three</code>, the DISPATCH command will jump to the label called <code>Cmdtest</code>, supplying it with the arguments <code>one</code>, <code>two</code>, and <code>three</code>, respectively.

	Additionally, the DISPATCH command will store the command (less the prefix "<code>cmd</code>") in the local variable "<code>#cmd</code>". The command argument itself will be removed from the argument list. So the label the <code>DISPATCH</code> command jumps to will only see any further arguments, not the command itself.		Additionally, the <code>DISPATCH</code> command will store the command (less the prefix "<code>cmd</code>") in the local variable <code>#cmd</code>. The command argument itself will be removed from the argument list. So the label the <code>DISPATCH</code> command jumps to will only see any further arguments, not the command itself.

	By default, the <code>DISPATCH</code> command will parse the arguments supplied to the class in the <code>[[Programmer Guide/Command Reference/ARG\|ARG]]</code> style. If you prefer <code>READ</code> style, you may ask for it by supplying the "/Read" option. In this case, you may also choose a delimiter character and several other options (see below).		By default, the <code>DISPATCH</code> command will parse the arguments supplied to the class in the <code>[[Programmer Guide/Command Reference/ARG\|ARG]]</code> style. If you prefer <code>[[Programmer Guide/Command Reference/READ\|READ]]</code> style, you may ask for it by supplying the <code>/Read</code> option. In this case, you may also choose a delimiter character and several other options (see below).

	You may influence all these parameters by either supplying arguments or options to the <code>DISPATCH</code> commands. There are the following options:		You may influence all these parameters by either supplying arguments or options to the <code>DISPATCH</code> commands. There are the following options:

	;<var>/Silent</var>		;<var>/Silent</var>

	:If the command fails, it reports a warning instead of an error.		:If the command fails, it reports a warning instead of an error.

	;<var>/Prefix=X</var>		;<var>/Prefix=X</var>

	:Use <code>X</code> instead of the default label prefix "<code>cmd</code>".		:Use <code>X</code> instead of the default label prefix "<code>cmd</code>".

	;<var>/To=Y</var>		;<var>/To=Y</var>

	:Store the command word (less the prefix) in a variable called <code>Y</code> instead of "<code>#cmd</code>".		:Store the command word (less the prefix) in a variable called <code>Y</code> instead of "<code>#cmd</code>".

	;<var>/Fail=Z</var>		;<var>/Fail=Z</var>

	:If there is no appropriate label to jump to, the command will jump to label <code>Z</code>. If you don't supply the "/Fail=" option, trying to jump to a non-existent label will lead to a run-time error.		:If there is no appropriate label to jump to, the command will jump to label <code>Z</code>. If you don't supply the "/Fail=" option, trying to jump to a non-existent label will lead to a run-time error.

	;<var>/Read</var>		;<var>/Read</var>
			:Use this option if your class is being supplied with READ-style instead of [[Programmer Guide/Command Reference/ARG\|ARG]]-style options (the latter is the default).

	:~~Use this~~ option ~~if your class is being supplied with READ-style~~ instead of ~~[[Programmer Guide~~/~~Command Reference~~/~~ARG\|ARG]]-style options (~~the ~~latter is~~ the ~~default)~~.		;<car>/Call</var>
			:Normally, the <code>DISPATCH</code> command will simply jump to the respective label. Now, if you supply the <code>/Call</code> option, instead of jumping (the GOTO way), the command will <em>call</em> the respective label (the GOSUB way). In this case, as soon as the control flow reaches an appropriate <code>EXIT</code> statement, it will resume with the statement following the <code>DISPATCH /Call</code> command.

	When using <code>READ</code>-style parsing, i.e. when supplying the "/Read" option, there are the following additional options:		When using <code>READ</code>-style parsing, i.e. when supplying the "/Read" option, there are the following additional options:

Christian at 13:28, 15 March 2011

2011-03-15T13:28:48Z

← Older revision		Revision as of 15:28, 15 March 2011
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
			The <code>DISPATCH</code> command, well, dispatches a call to a class, i.e. a call where a class is being called like a macro. In this case, the <code>DISPATCH</code> command regards the first argument supplied to the class call as a function to invoke (see below), and the remaining arguments as arguments to these functions.
	DISPATCH <var>function argList</var> [/Call] [/Silent] [/Prefix=<var>X</var>] [/To=<var>Y</var>] [/Fail=<var>Z</var>]		DISPATCH <var>function argList</var> [/Call] [/Silent] [/Prefix=<var>X</var>] [/To=<var>Y</var>] [/Fail=<var>Z</var>]

	DISPATCH <var>function argList</var> [/Call] [/Silent] [/Prefix=<var>X</var>] [/To=<var>Y</var>] [/Fail=<var>Z</var>]		DISPATCH <var>function argList</var> [/Call] [/Silent] [/Prefix=<var>X</var>] [/To=<var>Y</var>] [/Fail=<var>Z</var>]
	'''/Read''' [ /Var=<var>A</var> /Delim=<var>C</var> /Args=<var>D</var> ]		'''/Read''' [ /Var=<var>A</var> /Delim=<var>C</var> /Args=<var>D</var> ]

	The <code>DISPATCH</code> command can be used within a class to dispatch a call to a class, where the class is being called like a macro. In this case, the <code>DISPATCH</code> command regards the first argument supplied to the class call as a function to invoke (see below), and the remaining arguments as arguments to this function.

	By default, the function to be invoked is a label whose name is built up from the static prefix "<code>Cmd</code>" and the first argument supplied to the class call. If, for example, there is a class called "<code>Example</code>", and you invoke it with the statement "<code>Example test one two three</code>", the DISPATCH command will jump to the label called "<code>Cmdtest</code>", supplying it with the arguments "<code>one</code>", "<code>two</code>", and "<code>three</code>", respectively.		By default, the function to be invoked is a label whose name is built up from the static prefix "<code>Cmd</code>" and the first argument supplied to the class call. If, for example, there is a class called "<code>Example</code>", and you invoke it with the statement "<code>Example test one two three</code>", the DISPATCH command will jump to the label called "<code>Cmdtest</code>", supplying it with the arguments "<code>one</code>", "<code>two</code>", and "<code>three</code>", respectively.

Christian at 13:26, 15 March 2011

2011-03-15T13:26:38Z

← Older revision		Revision as of 15:26, 15 March 2011
Line 3:		Line 3:

	DISPATCH <var>function argList</var> [/Call] [/Silent] [/Prefix=<var>X</var>] [/To=<var>Y</var>] [/Fail=<var>Z</var>]		DISPATCH <var>function argList</var> [/Call] [/Silent] [/Prefix=<var>X</var>] [/To=<var>Y</var>] [/Fail=<var>Z</var>]
	'''/Read''' [ /Var=<~~code~~>A</~~code~~> /Delim=<~~code~~>C</~~code~~> /Args=<~~code~~>D</~~code~~> ]		'''/Read''' [ /Var=<var>A</var> /Delim=<var>C</var> /Args=<var>D</var> ]

	The <code>DISPATCH</code> command can be used within a class to dispatch a call to a class, where the class is being called like a macro. In this case, the <code>DISPATCH</code> command regards the first argument supplied to the class call as a function to invoke (see below), and the remaining arguments as arguments to this function.		The <code>DISPATCH</code> command can be used within a class to dispatch a call to a class, where the class is being called like a macro. In this case, the <code>DISPATCH</code> command regards the first argument supplied to the class call as a function to invoke (see below), and the remaining arguments as arguments to this function.

Christian at 13:26, 15 March 2011

2011-03-15T13:26:14Z

← Older revision		Revision as of 15:26, 15 March 2011
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	DISPATCH <var>function argList</var> [/Call] [/Silent] [/Prefix=X] [/To=Y] [/Fail=Z]		DISPATCH <var>function argList</var> [/Call] [/Silent] [/Prefix=<var>X</var>] [/To=<var>Y</var>] [/Fail=<var>Z</var>]

	DISPATCH <var>function argList</var> [/Call] [/Silent] [/Prefix=X] [/To=Y] [/Fail=Z]		DISPATCH <var>function argList</var> [/Call] [/Silent] [/Prefix=<var>X</var>] [/To=<var>Y</var>] [/Fail=<var>Z</var>]
	'''/Read''' [ /Var=A /Delim=C /Args=D ]		'''/Read''' [ /Var=<code>A</code> /Delim=<code>C</code> /Args=<code>D</code> ]

	The <code>DISPATCH</code> command can be used within a class to dispatch a call to a class, where the class is being called like a macro. In this case, the <code>DISPATCH</code> command regards the first argument supplied to the class call as a function to invoke (see below), and the remaining arguments as arguments to this function.		The <code>DISPATCH</code> command can be used within a class to dispatch a call to a class, where the class is being called like a macro. In this case, the <code>DISPATCH</code> command regards the first argument supplied to the class call as a function to invoke (see below), and the remaining arguments as arguments to this function.

Christian at 13:25, 15 March 2011

2011-03-15T13:25:13Z

← Older revision		Revision as of 15:25, 15 March 2011
Line 3:		Line 3:

	DISPATCH <var>function argList</var> [/Call] [/Silent] [/Prefix=X] [/To=Y] [/Fail=Z]		DISPATCH <var>function argList</var> [/Call] [/Silent] [/Prefix=X] [/To=Y] [/Fail=Z]
	'''/Read''' [ /Var=A /Delim=C /Args=D ]		'''/Read''' [ /Var=A /Delim=C /Args=D ]

	The <code>DISPATCH</code> command can be used within a class to dispatch a call to a class, where the class is being called like a macro. In this case, the <code>DISPATCH</code> command regards the first argument supplied to the class call as a function to invoke (see below), and the remaining arguments as arguments to this function.		The <code>DISPATCH</code> command can be used within a class to dispatch a call to a class, where the class is being called like a macro. In this case, the <code>DISPATCH</code> command regards the first argument supplied to the class call as a function to invoke (see below), and the remaining arguments as arguments to this function.

Christian at 13:24, 15 March 2011

2011-03-15T13:24:48Z

← Older revision		Revision as of 15:24, 15 March 2011
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	DISPATCH <var>function argList</var> [/Call] [/Silent] [/Prefix=X] [/To=Y] [/Fail=Z]		DISPATCH <var>function argList</var> [/Call] [/Silent] [/Prefix=X] [/To=Y] [/Fail=Z]
	DISPATCH <var>function argList</var> [/Call] [/Silent] [/Prefix=X] [/To=Y] [/Fail=Z] '''/Read''' [ /Var=A /Delim=C /Args=D ]
			DISPATCH <var>function argList</var> [/Call] [/Silent] [/Prefix=X] [/To=Y] [/Fail=Z]
			'''/Read''' [ /Var=A /Delim=C /Args=D ]

	The <code>DISPATCH</code> command can be used within a class to dispatch a call to a class, where the class is being called like a macro. In this case, the <code>DISPATCH</code> command regards the first argument supplied to the class call as a function to invoke (see below), and the remaining arguments as arguments to this function.		The <code>DISPATCH</code> command can be used within a class to dispatch a call to a class, where the class is being called like a macro. In this case, the <code>DISPATCH</code> command regards the first argument supplied to the class call as a function to invoke (see below), and the remaining arguments as arguments to this function.