Programmer Guide/General Descriptions/Macro Environment - Revision history

Jw at 14:35, 14 December 2017

2017-12-14T14:35:06Z

← Older revision		Revision as of 16:35, 14 December 2017
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
			{{TODO}} <!-- macro variables (with no prefix) -->
	The following variables are reserved in the macro environment.		The following variables are reserved in the macro environment.

Line 20:		Line 21:
	If a <code>NEW</code> command creates a new item successfully, the name of the new item is assigned to the variable <code>#NEW</code>. To save the (e.g. automatically generated) name, it must be assigned to another variable before the next <code>NEW</code> command is executed.		If a <code>NEW</code> command creates a new item successfully, the name of the new item is assigned to the variable <code>#NEW</code>. To save the (e.g. automatically generated) name, it must be assigned to another variable before the next <code>NEW</code> command is executed.

	~~#qargYou may use~~ <code>#qarg</code> in order to pass ARG-style arguments to another function without getting them distorted in any way. This sounds stupid, but consider what happens when calling a user-defined function, e.g. <code>HUGO</code>, with the statement "<code>HUGO $#argv</code>": if the ARG-style arguments you got contain whitespace, the function <code>HUGO</code> will end up with a different argument list than expected (and than the caller has passed to your function).		<code>#qarg</code> You may use #qarg in order to pass ARG-style arguments to another function without getting them distorted in any way. This sounds stupid, but consider what happens when calling a user-defined function, e.g. <code>HUGO</code>, with the statement "<code>HUGO $#argv</code>": if the ARG-style arguments you got contain whitespace, the function <code>HUGO</code> will end up with a different argument list than expected (and than the caller has passed to your function).

	If, on the other hand, you use the statement "<code>HUGO $#qargv</code>", the callee, <code>HUGO</code>, will get EXACTLY the same argument(s) as the function calling <code>HUGO</code> has been passed.		If, on the other hand, you use the statement "<code>HUGO $#qargv</code>", the callee, <code>HUGO</code>, will get EXACTLY the same argument(s) as the function calling <code>HUGO</code> has been passed.

Jw at 14:32, 14 December 2017

2017-12-14T14:32:36Z

← Older revision		Revision as of 16:32, 14 December 2017
Line 24:		Line 24:
	If, on the other hand, you use the statement "<code>HUGO $#qargv</code>", the callee, <code>HUGO</code>, will get EXACTLY the same argument(s) as the function calling <code>HUGO</code> has been passed.		If, on the other hand, you use the statement "<code>HUGO $#qargv</code>", the callee, <code>HUGO</code>, will get EXACTLY the same argument(s) as the function calling <code>HUGO</code> has been passed.

	~~#qargc~~<code>#qargc</code> contains the number of ARG-style arguments passed to the current. See <code>#qarg</code> for details.		<code>#qargc</code> contains the number of ARG-style arguments passed to the current. See <code>#qarg</code> for details.

	~~#read~~<code>#READ ~~= numberofassignedvariables~~</code>		<code>#READ</code> - the number of assigned variables

	The variable <code>#READ</code> is set to the number of assigned target-variables by any type of <code>READ</code> command.		The variable <code>#READ</code> is set to the number of assigned target-variables by any type of <code>READ</code> command.

	~~#shell~~<code>#SHELL ~~= newshellid~~</code>		<code>#SHELL</code> - the new shell id

	When the command <code>SHELL</code> is used to start a new shell, the id of the started shell is stored in the variable <code>#SHELL</code> of the caller's environment (see also variable <code>SHELL</code>).		When the command <code>SHELL</code> is used to start a new shell, the id of the started shell is stored in the variable <code>#SHELL</code> of the caller's environment (see also variable <code>SHELL</code>).

	~~#this~~<code>#THIS ~~= instanceItemName~~</code>		<code>#THIS</code> - the instance item name

	When a member function is called, the variable <code>#THIS</code> is set to the name of the instance item.		When a member function is called, the variable <code>#THIS</code> is set to the name of the instance item.

Jw at 14:31, 14 December 2017

2017-12-14T14:31:29Z

← Older revision		Revision as of 16:31, 14 December 2017
Line 16:		Line 16:
	The variable <code>#MAC</code> identifies the currently active macro <code>macroname</code>, the subroutine <code>labelname</code> or the member function <code>classname</code>.		The variable <code>#MAC</code> identifies the currently active macro <code>macroname</code>, the subroutine <code>labelname</code> or the member function <code>classname</code>.

	~~#new~~<code>#NEW ~~= newitemname~~</code>		<code>#NEW</code> - newitemname

	If a <code>NEW</code> command creates a new item successfully, the name of the new item is assigned to the variable <code>#NEW</code>. To save the (e.g. automatically generated) name, it must be assigned to another variable before the next <code>NEW</code> command is executed.		If a <code>NEW</code> command creates a new item successfully, the name of the new item is assigned to the variable <code>#NEW</code>. To save the (e.g. automatically generated) name, it must be assigned to another variable before the next <code>NEW</code> command is executed.

Jw at 14:31, 14 December 2017

2017-12-14T14:31:03Z

← Older revision		Revision as of 16:31, 14 December 2017
Line 10:		Line 10:
	When a macro, subroutine or member function is called, the variable <code>#ARGV</code> contains the argument string passed by the calling command. The command <code>READVAR</code> or (for macros only) the extended header format can be used to separate the arguments.		When a macro, subroutine or member function is called, the variable <code>#ARGV</code> contains the argument string passed by the calling command. The command <code>READVAR</code> or (for macros only) the extended header format can be used to separate the arguments.

	If a macro passes its environment to another macro (<code>MACROX</code>) or a subroutine (<code>GOSUBX</code>) the variables <code>#ARGV</code>, <code>#ARGC</code> and <code>#MAC</code> in its environment are changed!~~#mac~~<code>#MAC = macroname\|labelname\|classname~~</code>~~		If a macro passes its environment to another macro (<code>MACROX</code>) or a subroutine (<code>GOSUBX</code>) the variables <code>#ARGV</code>, <code>#ARGC</code> and <code>#MAC</code> in its environment are changed!

			<code>#MAC</code> - the macroname\|labelname\|classname

	The variable <code>#MAC</code> identifies the currently active macro <code>macroname</code>, the subroutine <code>labelname</code> or the member function <code>classname</code>.		The variable <code>#MAC</code> identifies the currently active macro <code>macroname</code>, the subroutine <code>labelname</code> or the member function <code>classname</code>.

Jw: /* Macro, Subroutine and Member Function Environment (first character = #) */

2017-12-14T14:28:34Z

Macro, Subroutine and Member Function Environment (first character = #)

← Older revision		Revision as of 16:28, 14 December 2017
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	~~====Macro, Subroutine and Member Function Environment (first character = #)====~~

	The following variables are reserved in the macro environment.		The following variables are reserved in the macro environment.

	~~#argc~~<code>#ARGC ~~= numberofarguments~~</code>		<code>#ARGC</code> - the number of arguments

	If a macro is defined with the extended header format (see Macros and Classes), the number of arguments passed is assigned to this variable (otherwise the number of arguments can be found in the variable <code>#read</code> after <code>READVAR #argv</code> has been called). Note that <code>#argc</code> only contains the correct number of arguments if they are blank separated.		If a macro is defined with the extended header format (see Macros and Classes), the number of arguments passed is assigned to this variable (otherwise the number of arguments can be found in the variable <code>#read</code> after <code>READVAR #argv</code> has been called). Note that <code>#argc</code> only contains the correct number of arguments if they are blank separated.

	~~#argv~~<code>#ARGV ~~= argumentstring~~</code>		<code>#ARGV</code> - the argument string

	When a macro, subroutine or member function is called, the variable <code>#ARGV</code> contains the argument string passed by the calling command. The command <code>READVAR</code> or (for macros only) the extended header format can be used to separate the arguments.		When a macro, subroutine or member function is called, the variable <code>#ARGV</code> contains the argument string passed by the calling command. The command <code>READVAR</code> or (for macros only) the extended header format can be used to separate the arguments.

Jw: Jw moved page Programmer Guide/General Descriptions/Macro, Subroutine and Member Function Environment (first character = ) to Programmer Guide/General Descriptions/Macro Environment

2017-12-14T14:27:25Z

Jw moved page Programmer Guide/General Descriptions/Macro, Subroutine and Member Function Environment (first character = ) to Programmer Guide/General Descriptions/Macro Environment

← Older revision	Revision as of 16:27, 14 December 2017
(No difference)

Admin: 1 revision: Initial import

2010-11-18T16:31:46Z

1 revision: Initial import

← Older revision	Revision as of 18:31, 18 November 2010
(No difference)

193.171.195.8: initial import

2010-05-17T13:05:27Z

initial import

New page

{{DISPLAYTITLE:{{SUBPAGENAME}}}}
====Macro, Subroutine and Member Function Environment (first character = #)====

The following variables are reserved in the macro environment.

#argc<code>#ARGC = numberofarguments</code>

If a macro is defined with the extended header format (see Macros and Classes), the number of arguments passed is assigned to this variable (otherwise the number of arguments can be found in the variable <code>#read</code> after <code>READVAR #argv</code> has been called). Note that <code>#argc</code> only contains the correct number of arguments if they are blank separated.

#argv<code>#ARGV = argumentstring</code>

When a macro, subroutine or member function is called, the variable <code>#ARGV</code> contains the argument string passed by the calling command. The command <code>READVAR</code> or (for macros only) the extended header format can be used to separate the arguments.

If a macro passes its environment to another macro (<code>MACROX</code>) or a subroutine (<code>GOSUBX</code>) the variables <code>#ARGV</code>, <code>#ARGC</code> and <code>#MAC</code> in its environment are changed!#mac<code>#MAC = macroname|labelname|classname</code>

The variable <code>#MAC</code> identifies the currently active macro <code>macroname</code>, the subroutine <code>labelname</code> or the member function <code>classname</code>.

#new<code>#NEW = newitemname</code>

If a <code>NEW</code> command creates a new item successfully, the name of the new item is assigned to the variable <code>#NEW</code>. To save the (e.g. automatically generated) name, it must be assigned to another variable before the next <code>NEW</code> command is executed.

#qargYou may use <code>#qarg</code> in order to pass ARG-style arguments to another function without getting them distorted in any way. This sounds stupid, but consider what happens when calling a user-defined function, e.g. <code>HUGO</code>, with the statement "<code>HUGO $#argv</code>": if the ARG-style arguments you got contain whitespace, the function <code>HUGO</code> will end up with a different argument list than expected (and than the caller has passed to your function).

If, on the other hand, you use the statement "<code>HUGO $#qargv</code>", the callee, <code>HUGO</code>, will get EXACTLY the same argument(s) as the function calling <code>HUGO</code> has been passed.

#qargc<code>#qargc</code> contains the number of ARG-style arguments passed to the current. See <code>#qarg</code> for details.

#read<code>#READ = numberofassignedvariables</code>

The variable <code>#READ</code> is set to the number of assigned target-variables by any type of <code>READ</code> command.

#shell<code>#SHELL = newshellid</code>

When the command <code>SHELL</code> is used to start a new shell, the id of the started shell is stored in the variable <code>#SHELL</code> of the caller's environment (see also variable <code>SHELL</code>).

#this<code>#THIS = instanceItemName</code>

When a member function is called, the variable <code>#THIS</code> is set to the name of the instance item.