Programmer Guide/Introduction - Revision history

Jw: /* Call Commands */

2018-01-10T08:44:02Z

Call Commands

← Older revision		Revision as of 10:44, 10 January 2018
Line 261:		Line 261:
	A call command is a statement which is used to call a source code object implemented in a script. There a several possible call commands:		A call command is a statement which is used to call a source code object implemented in a script. There a several possible call commands:

	macroname argstring~~</code>~~		macroname argstring
	Calls the macro ''macroname'' with the arguments ''argstring''.		Calls the macro ''macroname'' with the arguments ''argstring''.
	classname argstring		classname argstring

Jw: /* Command results */

2018-01-10T08:43:47Z

Command results

← Older revision		Revision as of 10:43, 10 January 2018
Line 254:		Line 254:

	* The ''completion code'' indicates if the command execution was successful or has failed. It consists of a numerical code, which is stored in the variable <code>RC</code> (0 indicating success), and the corresponing error description, stored in the variable <code>EMSG</code> (empty if <code>RC</code>=0).		* The ''completion code'' indicates if the command execution was successful or has failed. It consists of a numerical code, which is stored in the variable <code>RC</code> (0 indicating success), and the corresponing error description, stored in the variable <code>EMSG</code> (empty if <code>RC</code>=0).
	* The ''command result'' is the value returned by the command. This value replaces the command statement and is used in (optional) assignments. For a lot of commands, the completion code is also used as command result.		* The ''command result'' is the value returned by the command. This value replaces the command statement and is used in (optional) assignments. For a lot of commands, the completion code is also used as the command result.

	Note: Some arguments are keywords, selecting a specific subfunction or value (e.g. a color value). Such keywords are always case insensitive and can be abbreviated to the shortest unique form. A keyword can also be replaced by its index of the keyword-list (if this index value is known).		Note: Some arguments are keywords, selecting a specific subfunction or value (e.g. a color value). Such keywords are always case insensitive and can be abbreviated to the shortest unique form. A keyword can also be replaced by its index of the keyword-list (if this index value is known).

Jw: /* Global Variables */

2016-12-13T09:36:03Z

Global Variables

← Older revision		Revision as of 11:36, 13 December 2016
Line 104:		Line 104:
	\|<var>@PROFILE</var> \|\| The full pathname of the workspace file		\|<var>@PROFILE</var> \|\| The full pathname of the workspace file
	\|}		\|}
			See [[Programmer Guide/Introduction/Global Variables\|Global Variables]] for more details.

	==Macros==		==Macros==

Jw: /* Global Variables */

2016-12-13T09:23:15Z

Global Variables

← Older revision		Revision as of 11:23, 13 December 2016
Line 86:		Line 86:

	===Global Variables===		===Global Variables===
	The application environment contains a global variable space, which can be accessed from the whole application, i.e. from every ~~runnign~~ shell. The name prefix character <code>@</code> is used to denote the global variable space. The global variables are used for configuration purposes and should not be changed. The following table shows some of the most important global variables.		The application environment contains a global variable space, which can be accessed from the whole application, i.e. from every running shell. The name prefix character <code>@</code> is used to denote the global variable space. The global variables are used for configuration purposes and should not be changed. The following table shows some of the most important global variables.
	{\|class="einrahmen"		{\|class="einrahmen"
	!name !!description		!name !!description

Toni: /* Local Items */

2016-01-28T15:06:10Z

Local Items

← Older revision		Revision as of 17:06, 28 January 2016
Line 151:		Line 151:

	===Local Items===		===Local Items===
	Normally, [[Programmer_Guide/Shell_Items\|shell items]] created in a macro remain existing when the macro is finished~~, but~~ in some cases ~~this is not true because~~ [[Programmer_Guide/Shell_Items#Temporary shell items\|temporary shell items]] are created, which are automatically deleted at the end of macro execution. ~~This is very confusing since this paragraph does not reveal under which circumstances~~ items ~~are temporary~~.		Normally the [[Programmer_Guide/Shell_Items\|shell items]] created in a macro remain existing when the macro is finished. But in some cases [[Programmer_Guide/Shell_Items#Temporary shell items\|temporary shell items]] are created, which are automatically deleted at the end of macro execution. Read the introduction to [[Programmer_Guide/Shell_Items\|shell items]] for more information.

	==Classes, Instances==		==Classes, Instances==

Toni: /* Macro Variables */

2016-01-28T15:03:46Z

Macro Variables

← Older revision		Revision as of 17:03, 28 January 2016
Line 147:		Line 147:
	\|}		\|}

	:;Note: A macro can share its local variable space with a called macro or subroutine (see <code>[[Programmer_Guide/Command_Reference/MACRO\|MACROX]]</code>, <code>[[Programmer_Guide/Command_Reference/GOSUB\|GOSUBX]]</code>). In this case the called macro has full access to the variables of the caller. This feature can be useful but also dangerous and should be used with care.

			:;Note: A macro can share its local variable space with a called macro or subroutine (see <code>[[Programmer_Guide/Command_Reference/MACRO\|MACROX]]</code>, <code>[[Programmer_Guide/Command_Reference/GOSUB\|GOSUBX]]</code>). In this case the called macro has full access to the variables of the caller. This feature can be useful but also dangerous and should be used with care.

	===Local Items===		===Local Items===

Toni: /* Macro Variables */

2016-01-28T15:03:24Z

Macro Variables

← Older revision		Revision as of 17:03, 28 January 2016
Line 147:		Line 147:
	\|}		\|}

			:;Note: A macro can share its local variable space with a called macro or subroutine (see <code>[[Programmer_Guide/Command_Reference/MACRO\|MACROX]]</code>, <code>[[Programmer_Guide/Command_Reference/GOSUB\|GOSUBX]]</code>). In this case the called macro has full access to the variables of the caller. This feature can be useful but also dangerous and should be used with care.

	Note: A macro can share its local variable space with a called macro or subroutine (see <code>[[Programmer_Guide/Command_Reference/MACRO\|MACROX]]</code>, <code>[[Programmer_Guide/Command_Reference/GOSUB\|GOSUBX]]</code>).

			===Local Items===
	Normally, [[Programmer_Guide/Shell_Items\|shell items]] created in a macro remain existing when the macro is finished, but in some cases this is not true because [[Programmer_Guide/Shell_Items#Temporary shell items\|temporary shell items]] are created, which are automatically deleted at the end of macro execution. This is very confusing since this paragraph does not reveal under which circumstances items are temporary.		Normally, [[Programmer_Guide/Shell_Items\|shell items]] created in a macro remain existing when the macro is finished, but in some cases this is not true because [[Programmer_Guide/Shell_Items#Temporary shell items\|temporary shell items]] are created, which are automatically deleted at the end of macro execution. This is very confusing since this paragraph does not reveal under which circumstances items are temporary.

Toni: /* Macro Variables */

2016-01-28T14:55:17Z

Macro Variables

← Older revision		Revision as of 16:55, 28 January 2016
Line 120:		Line 120:
	<u>Variables assigned on macro call:</u>		<u>Variables assigned on macro call:</u>
	{\|class="einrahmen"		{\|class="einrahmen"
	!name !!description ~~!!see also~~		!name !!description
	\|-		\|-
	\|<var>#ARGV</var>, <var>#ARGC</var> \|\| The macro argument string without parsing information and the number of arguments passed to the macro. These variables are used for "read:"-style argument passing.		\|<var>#ARGV</var>, <var>#ARGC</var> \|\| The macro argument string without parsing information and the number of arguments passed to the macro. These variables are used for "read:"-style argument passing. (see: [[Programmer_Guide/Source_code#Definition of Macros\|macro header]], <code>[[Programmer_Guide/Command_Reference/READ\|READVAR]]</code>)
	\|see [[Programmer_Guide/Source_code#Definition of Macros\|macro header]], <code>[[Programmer_Guide/Command_Reference/READ\|READVAR]]</code>
	\|-		\|-
	\|<var>#QARGV</var>, <var>#QARGC</var> \|\| The macro argument string with parsing information and the number of arguments passed to the macro. These variables are used for "arg:" and "argopt:"-style argument passing.		\|<var>#QARGV</var>, <var>#QARGC</var> \|\| The macro argument string with parsing information and the number of arguments passed to the macro. These variables are used for "arg:" and "argopt:"-style argument passing. (see: [[Programmer_Guide/Source_code#Definition of Macros\|macro header]], <code>[[Programmer_Guide/Command_Reference/ARG\|ARG]]</code>, <code>[[Programmer_Guide/Command_Reference/SHIFT\|SHIFT]]</code>)
	\|see [[Programmer_Guide/Source_code#Definition of Macros\|macro header]], <code>[[Programmer_Guide/Command_Reference/ARG\|ARG]]</code>, <code>[[Programmer_Guide/Command_Reference/SHIFT\|SHIFT]]</code>
	\|-		\|-
	\|<var>#MAC</var> \|\| The name of the called macro.		\|<var>#MAC</var> \|\| The name of the called macro.
	\|}		\|}

	<u>Additonal local variables assigned on member function call:</u>		<u>Additonal local variables assigned on member function call:</u>
	{\|class="einrahmen"		{\|class="einrahmen"
	!name !!description ~~!!see also~~		!name !!description
	\|-		\|-
	\|<var>#THIS</var> \|\| The name of the instance item owning the member function.		\|<var>#THIS</var> \|\| The name of the instance item owning the member function.
Line 139:		Line 136:
	\|<var>#THISMF</var> \|\| The name of the called member function.		\|<var>#THISMF</var> \|\| The name of the called member function.
	\|}		\|}

	<u>Local variables generated/used by commands:</u>		<u>Local variables generated/used by commands:</u>
	{\|class="einrahmen"		{\|class="einrahmen"
	!name !!description ~~!!see also~~		!name !!description
	\|-		\|-
	\|<var>#READ</var> \|\| The result returned by the last <code>[[Programmer_Guide/Command_Reference/READ\|READ]]</code> command. Normally this is the number of assigned variables		\|<var>#READ</var> \|\| The result returned by the last <code>[[Programmer_Guide/Command_Reference/READ\|READ]]</code> command. Normally this is the number of assigned variables

Toni: /* Macro Variables */

2016-01-28T14:53:15Z

Macro Variables

← Older revision		Revision as of 16:53, 28 January 2016
Line 128:		Line 128:
	\|see [[Programmer_Guide/Source_code#Definition of Macros\|macro header]], <code>[[Programmer_Guide/Command_Reference/ARG\|ARG]]</code>, <code>[[Programmer_Guide/Command_Reference/SHIFT\|SHIFT]]</code>		\|see [[Programmer_Guide/Source_code#Definition of Macros\|macro header]], <code>[[Programmer_Guide/Command_Reference/ARG\|ARG]]</code>, <code>[[Programmer_Guide/Command_Reference/SHIFT\|SHIFT]]</code>
	\|-		\|-
	\|<var>#~~THIS</var> \|\| The name of the instance item owning the member function.~~		\|<var>#MAC</var> \|\| The name of the called macro.
	\|-
	~~\|<var>#THISMF~~</var> \|\| The name of the called ~~member function~~.
	\|}		\|}

Line 137:		Line 135:
	!name !!description !!see also		!name !!description !!see also
	\|-		\|-
	\|<var>#~~READ~~</var> \|\| The ~~result returned by~~ the ~~last <code>[[Programmer_Guide/Command_Reference/READ\|READ]]</code> command~~.		\|<var>#THIS</var> \|\| The name of the instance item owning the member function.
	\|-		\|-
	\|<var>#~~MSG~~</var> \|\| The ~~result string returned by the last <code>[[Programmer_Guide/Command_Reference/MESSAGE\|MSG]]</code> command.~~		\|<var>#THISMF</var> \|\| The name of the called member function.
	\|-
	~~\|<var>#NEW</var> \|\| The result string returned by the last <code>[[Programmer_Guide/Command_Reference/NEW\|NEW]]</code> command (normally, the ID~~ of the ~~shell item created)~~.
	\|}		\|}

Toni: /* Macro Variables */

2016-01-28T14:51:33Z

Macro Variables

← Older revision		Revision as of 16:51, 28 January 2016
Line 118:		Line 118:
	The execution environment of a macro (basically, its local variable space) is created when the execution of the macro starts and deleted at the end of the macro execution. Besides user-defined local variables, there are a number of pre-defined local variables shown in the following table:		The execution environment of a macro (basically, its local variable space) is created when the execution of the macro starts and deleted at the end of the macro execution. Besides user-defined local variables, there are a number of pre-defined local variables shown in the following table:

			<u>Variables assigned on macro call:</u>
	{\|class="einrahmen"		{\|class="einrahmen"
	!name !!description !!see also		!name !!description !!see also
	\|-		\|-
	\|<var>#ARGV</var>, <var>#ARGC</var> \|\| The macro argument string without parsing and the number of arguments passed to the macro. These variables ~~are generated on macro start and~~ are used for "read:"-style argument passing.		\|<var>#ARGV</var>, <var>#ARGC</var> \|\| The macro argument string without parsing information and the number of arguments passed to the macro. These variables are used for "read:"-style argument passing.
	\|see [[Programmer_Guide/Source_code#Definition of Macros\|macro header]], <code>[[Programmer_Guide/Command_Reference/READ\|READVAR]]</code>		\|see [[Programmer_Guide/Source_code#Definition of Macros\|macro header]], <code>[[Programmer_Guide/Command_Reference/READ\|READVAR]]</code>
	\|-		\|-
	\|<var>#QARGV</var>, <var>#QARGC</var> \|\| The macro argument string with parsing information and the number of arguments passed to the macro.~~<BR>~~These variables are ~~generated on macro start and~~ used for "arg:" and "argopt:"-style argument passing.		\|<var>#QARGV</var>, <var>#QARGC</var> \|\| The macro argument string with parsing information and the number of arguments passed to the macro. These variables are used for "arg:" and "argopt:"-style argument passing.
	\|see [[Programmer_Guide/Source_code#Definition of Macros\|macro header]], <code>[[Programmer_Guide/Command_Reference/ARG\|ARG]]</code>, <code>[[Programmer_Guide/Command_Reference/SHIFT\|SHIFT]]</code>		\|see [[Programmer_Guide/Source_code#Definition of Macros\|macro header]], <code>[[Programmer_Guide/Command_Reference/ARG\|ARG]]</code>, <code>[[Programmer_Guide/Command_Reference/SHIFT\|SHIFT]]</code>
	\|-		\|-
	\|<var>#~~MAC~~</var> \|\| The name of the ~~macro being executed~~.		\|<var>#THIS</var> \|\| The name of the instance item owning the member function.
			\|-
			\|<var>#THISMF</var> \|\| The name of the called member function.
			\|}

			<u>Additonal local variables assigned on member function call:</u>
			{\|class="einrahmen"
			!name !!description !!see also
	\|-		\|-
	\|<var>#READ</var> \|\| The result returned by the last <code>[[Programmer_Guide/Command_Reference/READ\|READ]]</code> command.		\|<var>#READ</var> \|\| The result returned by the last <code>[[Programmer_Guide/Command_Reference/READ\|READ]]</code> command.
Line 135:		Line 143:
	\|<var>#NEW</var> \|\| The result string returned by the last <code>[[Programmer_Guide/Command_Reference/NEW\|NEW]]</code> command (normally, the ID of the shell item created).		\|<var>#NEW</var> \|\| The result string returned by the last <code>[[Programmer_Guide/Command_Reference/NEW\|NEW]]</code> command (normally, the ID of the shell item created).
	\|}		\|}

			<u>Local variables generated/used by commands:</u>
			{\|class="einrahmen"
			!name !!description !!see also
			\|-
			\|<var>#READ</var> \|\| The result returned by the last <code>[[Programmer_Guide/Command_Reference/READ\|READ]]</code> command. Normally this is the number of assigned variables
			\|-
			\|<var>#MSG</var> \|\| The result string returned by the last <code>[[Programmer_Guide/Command_Reference/MESSAGE\|MSG]]</code> command.
			\|-
			\|<var>#NEW</var> \|\| The result string returned by the last <code>[[Programmer_Guide/Command_Reference/NEW\|NEW]]</code> command. Normally the ID of the shell item created.
			\|}


	Note: A macro can share its local variable space with a called macro or subroutine (see <code>[[Programmer_Guide/Command_Reference/MACRO\|MACROX]]</code>, <code>[[Programmer_Guide/Command_Reference/GOSUB\|GOSUBX]]</code>).		Note: A macro can share its local variable space with a called macro or subroutine (see <code>[[Programmer_Guide/Command_Reference/MACRO\|MACROX]]</code>, <code>[[Programmer_Guide/Command_Reference/GOSUB\|GOSUBX]]</code>).