Creating New System Functions - Revision history

Paul Robinson: /* General Reference Notes */

2019-10-13T21:24:27Z

General Reference Notes

← Older revision		Revision as of 17:24, 13 October 2019
Line 454:		Line 454:

	Several Quad functions have been implemented using PHP magic functions, for example Quad VR or <apll>{quad}</apll> [[System Function VR\|VR]] - Visual Representation - uses mnemonic '''SysFnVR_EM_YY''', per definition file qf_vr.c. However, Quad [[System Function VR\|VR]] also has an additional PHP magic header file called in this case mf_quadvr.h. Quad FMT is similarly coded using a PHP magic function header file.		Several Quad functions have been implemented using PHP magic functions, for example Quad VR or <apll>{quad}</apll> [[System Function VR\|VR]] - Visual Representation - uses mnemonic '''SysFnVR_EM_YY''', per definition file qf_vr.c. However, Quad [[System Function VR\|VR]] also has an additional PHP magic header file called in this case mf_quadvr.h. Quad FMT is similarly coded using a PHP magic function header file.


			[[Category:NARS 2000]]

Robert Wallick: new section - ⎕EC as System Function Coding Example

2015-08-10T21:54:47Z

new section - ⎕EC as System Function Coding Example

← Older revision		Revision as of 17:54, 10 August 2015
Line 85:		Line 85:

	NARS has multiple frequently used TypeDefs, Structures and Variables. Familiarity with these structures and the variables employed is essential to gain a better understanding of how NARS C source code works and comprehending program flow, view '''[[Frequently Used TypeDef Structures and Variables]]''' here.		NARS has multiple frequently used TypeDefs, Structures and Variables. Familiarity with these structures and the variables employed is essential to gain a better understanding of how NARS C source code works and comprehending program flow, view '''[[Frequently Used TypeDef Structures and Variables]]''' here.

			==⎕EC as System Function Coding Example, Returning a Nested Array==

			'''[[System_Function_EC\|System Function ⎕EC]]''' is useful to APLers for testing purposes, but it also is useful for NARS source code analysis purposes precisely because - it illustrates how to return a nested vector back to APL, view '''[[Quad EC C Source Code Analysis]]''' here.

	==Setting Up for Cross-Reference Call To Another APL or System Function==		==Setting Up for Cross-Reference Call To Another APL or System Function==

Robert Wallick: added section - Frequently Used TypeDef Structures and Variables

2015-08-06T17:37:19Z

added section - Frequently Used TypeDef Structures and Variables

← Older revision		Revision as of 13:37, 6 August 2015
Line 81:		Line 81:

	Every APL/APL2 Quad System Variable and Quad System Function(niladic, monadic and dyadic) has an entry in the <sysvars.c> table. System function <apll>{quad}</apll>T, because it is niladic, has a zero valence; it is not a System Variable(False); it has a function mnemonic or calling name = SysFnT_EM_YY; it uses zero system variables.		Every APL/APL2 Quad System Variable and Quad System Function(niladic, monadic and dyadic) has an entry in the <sysvars.c> table. System function <apll>{quad}</apll>T, because it is niladic, has a zero valence; it is not a System Variable(False); it has a function mnemonic or calling name = SysFnT_EM_YY; it uses zero system variables.

			==Frequently Used TypeDef Structures and Variables==

			NARS has multiple frequently used TypeDefs, Structures and Variables. Familiarity with these structures and the variables employed is essential to gain a better understanding of how NARS C source code works and comprehending program flow, view '''[[Frequently Used TypeDef Structures and Variables]]''' here.

	==Setting Up for Cross-Reference Call To Another APL or System Function==		==Setting Up for Cross-Reference Call To Another APL or System Function==

Robert Wallick: /* Setting Up for Cross-Reference Call To Another APL or System Function */ searching for tkFcn examples

2015-07-30T23:36:42Z

Setting Up for Cross-Reference Call To Another APL or System Function: searching for tkFcn examples

← Older revision		Revision as of 19:36, 30 July 2015
Line 99:		Line 99:
	In order to cross calculate '''⍴R'''(the shape of right hand argument variable '''R''' - tkFcn/UTF16_RHO (shortly will be processing inside function Rho) '''is passed''' in the above example '''from''' call-from up-arrow code(file <pf_uarrow.c>) - the APL '''take''' function). Another reference to <lptkFunc> would be similar to function tokening use above, but say to the LeftShoe symbol (UTF16_LEFTSHOE or APL's '''⊂ enclose''' symbol). An often used element of the function token is <tkCharIndex> which is used as the caret pointer in case an error occurs and an error message would then be formed into '''[[System_Variable_DM\|⎕DM]]''' and '''[[System_Command_SI\|)SI]]''', workspace state indicator would get set. The function token structure is key to allowing APL's interpreter know how to keep track of where the program is processing-at and, as needed, correctly report errors.		In order to cross calculate '''⍴R'''(the shape of right hand argument variable '''R''' - tkFcn/UTF16_RHO (shortly will be processing inside function Rho) '''is passed''' in the above example '''from''' call-from up-arrow code(file <pf_uarrow.c>) - the APL '''take''' function). Another reference to <lptkFunc> would be similar to function tokening use above, but say to the LeftShoe symbol (UTF16_LEFTSHOE or APL's '''⊂ enclose''' symbol). An often used element of the function token is <tkCharIndex> which is used as the caret pointer in case an error occurs and an error message would then be formed into '''[[System_Variable_DM\|⎕DM]]''' and '''[[System_Command_SI\|)SI]]''', workspace state indicator would get set. The function token structure is key to allowing APL's interpreter know how to keep track of where the program is processing-at and, as needed, correctly report errors.

	For the full list of available UTF16_* variables, see file <symbolnames.h>.		For the full list of available UTF16_* variables, see file <symbolnames.h>. To search in Visual Studio 2013 (load NARS2000 project first) - for existing NARS '''examples''' of where tkFcn is used, i.e. set up, in VS2013 - Edit - FindAndReplace - FindInFiles use search string "<u>'''tkFcn.'''</u>" and note the dot as the rightmost "search on" char; and click the [Find All] button.

	==Source Code Derived List of APL System Functions==		==Source Code Derived List of APL System Functions==

Robert Wallick: /* Setting Up for Cross-Reference Call To Another APL or System Function */ wording

2015-07-30T14:52:15Z

Setting Up for Cross-Reference Call To Another APL or System Function: wording

← Older revision		Revision as of 10:52, 30 July 2015
Line 86:		Line 86:
	In creating a new System Function or even a new APL function, it can be useful to call another already established '''APL or system''' function to perform part of the new pre-processing-configuration-setup or post-close-done requirements. One of the frequently encountered parameters to nearly every '''<u>function call</u>''' is a parameter usually named '''lptkFunc''' or '''tkFcn''' - known variously as line pointer to a token function or just token function. tkFcn will be potentially needed in the soon-to-be-called function in case it mandates use for something else; it represents sort of a dynamically changing location-operation recognition tracker. As an analogy, '''Windows''' operating system uses program registrations(ref. software installs and regedit) so Windows will "know" each program when it runs and can report errors and abends; '''NARS''' uses token-function structures so its APL Interpreter will know each APL and system function as it in turn runs.		In creating a new System Function or even a new APL function, it can be useful to call another already established '''APL or system''' function to perform part of the new pre-processing-configuration-setup or post-close-done requirements. One of the frequently encountered parameters to nearly every '''<u>function call</u>''' is a parameter usually named '''lptkFunc''' or '''tkFcn''' - known variously as line pointer to a token function or just token function. tkFcn will be potentially needed in the soon-to-be-called function in case it mandates use for something else; it represents sort of a dynamically changing location-operation recognition tracker. As an analogy, '''Windows''' operating system uses program registrations(ref. software installs and regedit) so Windows will "know" each program when it runs and can report errors and abends; '''NARS''' uses token-function structures so its APL Interpreter will know each APL and system function as it in turn runs.

	From file <pf_uarrow.c>, the following lines were extracted:		From file <pf_uarrow.c>, the following lines were edit-extracted:
	<pre>		<pre>
	TOKEN tkFcn = {0}; // ~~Function~~ token		TOKEN tkFcn = {0}; // tkFcn token function struct. var defined, initialized to zero in vars declaration section of uarrow function.
	[...]		[...] // Intermediary unrelated code
	// Setup a token for use in calling ~~the~~ {~~rho,~~ the shape of} function:		// Setup token structure for use in calling rho {the shape of} function (which uarrow i.e. APL's "take" now needs):
	tkFcn.tkFlags.TknType = TKT_FCNIMMED;		tkFcn.tkFlags.TknType = TKT_FCNIMMED;
	tkFcn.tkFlags.ImmType = IMMTYPE_PRIMFCN;		tkFcn.tkFlags.ImmType = IMMTYPE_PRIMFCN;
	////tkFcn.tkFlags.NoDisplay = FALSE; // ~~Already~~ zero from = {0}		////tkFcn.tkFlags.NoDisplay = FALSE; // Commented out because already zero from = {0}
	tkFcn.tkData.tkChar = UTF16_RHO; // Unicode transformation format, 16-bit-coding for Rho - ~~identifying the~~ function/operator being called.		tkFcn.tkData.tkChar = UTF16_RHO; // Unicode transformation format, 16-bit-coding for Rho - identifies function/operator being called.
	tkFcn.tkCharIndex = lptkFunc->tkCharIndex; // Standard caret pointer		tkFcn.tkCharIndex = lptkFunc->tkCharIndex; // Standard caret pointer
	</pre>		</pre>

Robert Wallick: /* Setting Up for Cross-Reference Call To Another APL or System Function */ expanded wording

2015-07-30T03:45:49Z

Setting Up for Cross-Reference Call To Another APL or System Function: expanded wording

← Older revision		Revision as of 23:45, 29 July 2015
Line 84:		Line 84:
	==Setting Up for Cross-Reference Call To Another APL or System Function==		==Setting Up for Cross-Reference Call To Another APL or System Function==

	In creating a new System Function or even a new APL function, it can be useful to call another already established '''APL or system''' function to perform part of the new pre-processing-configuration-setup or post-close-done requirements. One of the frequently encountered parameters to nearly every '''<u>function call</u>''' is a parameter usually named '''lptkFunc''' or '''tkFcn''' - known variously as line pointer to a token function or just token function. tkFcn will be potentially needed in the soon-to-be-called function in case it mandates use for something else; it represents sort of a dynamically changing location-operation recognition tracker. As an analogy, '''Windows''' operating system uses a program ~~registration process~~(ref. regedit); '''NARS''' uses token-~~functions~~.		In creating a new System Function or even a new APL function, it can be useful to call another already established '''APL or system''' function to perform part of the new pre-processing-configuration-setup or post-close-done requirements. One of the frequently encountered parameters to nearly every '''<u>function call</u>''' is a parameter usually named '''lptkFunc''' or '''tkFcn''' - known variously as line pointer to a token function or just token function. tkFcn will be potentially needed in the soon-to-be-called function in case it mandates use for something else; it represents sort of a dynamically changing location-operation recognition tracker. As an analogy, '''Windows''' operating system uses program registrations(ref. software installs and regedit) so Windows will "know" each program when it runs and can report errors and abends; '''NARS''' uses token-function structures so its APL Interpreter will know each APL and system function as it in turn runs.

	From file <pf_uarrow.c>, the following lines were extracted:		From file <pf_uarrow.c>, the following lines were extracted:

Robert Wallick: /* Setting Up for Cross-Reference Call To Another APL or System Function */ correction

2015-07-30T01:55:30Z

Setting Up for Cross-Reference Call To Another APL or System Function: correction

← Older revision		Revision as of 21:55, 29 July 2015
Line 97:		Line 97:
	tkFcn.tkCharIndex = lptkFunc->tkCharIndex; // Standard caret pointer		tkFcn.tkCharIndex = lptkFunc->tkCharIndex; // Standard caret pointer
	</pre>		</pre>
	In order to cross calculate '''⍴R'''(the shape of right hand argument variable '''R''' - tkFcn/UTF16_RHO '''is passed''' in the above example '''to''' up-arrow - the APL '''take''' function). Another reference to <lptkFunc> would be similar to function tokening use above, but say to the LeftShoe symbol (UTF16_LEFTSHOE or APL's '''⊂ enclose''' symbol). An often used element of the function token is <tkCharIndex> which is used as the caret pointer in case an error occurs and an error message would then be formed into '''[[System_Variable_DM\|⎕DM]]''' and '''[[System_Command_SI\|)SI]]''', workspace state indicator would get set. The function token structure is key to allowing APL's interpreter know how to keep track of where the program is processing-at and, as needed, correctly report errors.		In order to cross calculate '''⍴R'''(the shape of right hand argument variable '''R''' - tkFcn/UTF16_RHO (shortly will be processing inside function Rho) '''is passed''' in the above example '''from''' call-from up-arrow code(file <pf_uarrow.c>) - the APL '''take''' function). Another reference to <lptkFunc> would be similar to function tokening use above, but say to the LeftShoe symbol (UTF16_LEFTSHOE or APL's '''⊂ enclose''' symbol). An often used element of the function token is <tkCharIndex> which is used as the caret pointer in case an error occurs and an error message would then be formed into '''[[System_Variable_DM\|⎕DM]]''' and '''[[System_Command_SI\|)SI]]''', workspace state indicator would get set. The function token structure is key to allowing APL's interpreter know how to keep track of where the program is processing-at and, as needed, correctly report errors.

	For the full list of available UTF16_* variables, see file <symbolnames.h>.		For the full list of available UTF16_* variables, see file <symbolnames.h>.

Robert Wallick: /* Setting Up for Cross-Reference Call To Another APL or System Function */

2015-07-30T01:42:21Z

Setting Up for Cross-Reference Call To Another APL or System Function

← Older revision		Revision as of 21:42, 29 July 2015
Line 98:		Line 98:
	</pre>		</pre>
	In order to cross calculate '''⍴R'''(the shape of right hand argument variable '''R''' - tkFcn/UTF16_RHO '''is passed''' in the above example '''to''' up-arrow - the APL '''take''' function). Another reference to <lptkFunc> would be similar to function tokening use above, but say to the LeftShoe symbol (UTF16_LEFTSHOE or APL's '''⊂ enclose''' symbol). An often used element of the function token is <tkCharIndex> which is used as the caret pointer in case an error occurs and an error message would then be formed into '''[[System_Variable_DM\|⎕DM]]''' and '''[[System_Command_SI\|)SI]]''', workspace state indicator would get set. The function token structure is key to allowing APL's interpreter know how to keep track of where the program is processing-at and, as needed, correctly report errors.		In order to cross calculate '''⍴R'''(the shape of right hand argument variable '''R''' - tkFcn/UTF16_RHO '''is passed''' in the above example '''to''' up-arrow - the APL '''take''' function). Another reference to <lptkFunc> would be similar to function tokening use above, but say to the LeftShoe symbol (UTF16_LEFTSHOE or APL's '''⊂ enclose''' symbol). An often used element of the function token is <tkCharIndex> which is used as the caret pointer in case an error occurs and an error message would then be formed into '''[[System_Variable_DM\|⎕DM]]''' and '''[[System_Command_SI\|)SI]]''', workspace state indicator would get set. The function token structure is key to allowing APL's interpreter know how to keep track of where the program is processing-at and, as needed, correctly report errors.

			For the full list of available UTF16_* variables, see file <symbolnames.h>.

	==Source Code Derived List of APL System Functions==		==Source Code Derived List of APL System Functions==

Robert Wallick: /* Setting Up for Cross-Reference Call To Another APL or System Function */ wording

2015-07-30T01:33:59Z

Setting Up for Cross-Reference Call To Another APL or System Function: wording

← Older revision		Revision as of 21:33, 29 July 2015
Line 97:		Line 97:
	tkFcn.tkCharIndex = lptkFunc->tkCharIndex; // Standard caret pointer		tkFcn.tkCharIndex = lptkFunc->tkCharIndex; // Standard caret pointer
	</pre>		</pre>
	In order to cross calculate '''⍴R'''(the shape of ~~argument~~ right argument variable R - tkFcn/UTF16_RHO '''is passed''' in the above example '''to''' up-arrow - the APL '''take''' function). Another reference to <lptkFunc> would be similar to function tokening use above, but say to the LeftShoe symbol (UTF16_LEFTSHOE or APL's '''⊂ enclose''' symbol). An often used element of the function token is <tkCharIndex> which is used as the caret pointer in case an error occurs and an error message would then be formed into '''[[System_Variable_DM\|⎕DM]]''' and '''[[System_Command_SI\|)SI]]''', workspace state indicator would get set. The function token structure is key to allowing APL's interpreter know how to keep track of where the program is processing-at and, as needed, correctly report errors.		In order to cross calculate '''⍴R'''(the shape of right hand argument variable '''R''' - tkFcn/UTF16_RHO '''is passed''' in the above example '''to''' up-arrow - the APL '''take''' function). Another reference to <lptkFunc> would be similar to function tokening use above, but say to the LeftShoe symbol (UTF16_LEFTSHOE or APL's '''⊂ enclose''' symbol). An often used element of the function token is <tkCharIndex> which is used as the caret pointer in case an error occurs and an error message would then be formed into '''[[System_Variable_DM\|⎕DM]]''' and '''[[System_Command_SI\|)SI]]''', workspace state indicator would get set. The function token structure is key to allowing APL's interpreter know how to keep track of where the program is processing-at and, as needed, correctly report errors.

	==Source Code Derived List of APL System Functions==		==Source Code Derived List of APL System Functions==

Robert Wallick: new section - Setting Up for Call To Another APL or System Function

2015-07-30T01:29:16Z

new section - Setting Up for Call To Another APL or System Function

← Older revision		Revision as of 21:29, 29 July 2015
Line 81:		Line 81:

	Every APL/APL2 Quad System Variable and Quad System Function(niladic, monadic and dyadic) has an entry in the <sysvars.c> table. System function <apll>{quad}</apll>T, because it is niladic, has a zero valence; it is not a System Variable(False); it has a function mnemonic or calling name = SysFnT_EM_YY; it uses zero system variables.		Every APL/APL2 Quad System Variable and Quad System Function(niladic, monadic and dyadic) has an entry in the <sysvars.c> table. System function <apll>{quad}</apll>T, because it is niladic, has a zero valence; it is not a System Variable(False); it has a function mnemonic or calling name = SysFnT_EM_YY; it uses zero system variables.

			==Setting Up for Cross-Reference Call To Another APL or System Function==

			In creating a new System Function or even a new APL function, it can be useful to call another already established '''APL or system''' function to perform part of the new pre-processing-configuration-setup or post-close-done requirements. One of the frequently encountered parameters to nearly every '''<u>function call</u>''' is a parameter usually named '''lptkFunc''' or '''tkFcn''' - known variously as line pointer to a token function or just token function. tkFcn will be potentially needed in the soon-to-be-called function in case it mandates use for something else; it represents sort of a dynamically changing location-operation recognition tracker. As an analogy, '''Windows''' operating system uses a program registration process(ref. regedit); '''NARS''' uses token-functions.

			From file <pf_uarrow.c>, the following lines were extracted:
			<pre>
			TOKEN tkFcn = {0}; // Function token
			[...]
			// Setup a token for use in calling the {rho, the shape of} function:
			tkFcn.tkFlags.TknType = TKT_FCNIMMED;
			tkFcn.tkFlags.ImmType = IMMTYPE_PRIMFCN;
			////tkFcn.tkFlags.NoDisplay = FALSE; // Already zero from = {0}
			tkFcn.tkData.tkChar = UTF16_RHO; // Unicode transformation format, 16-bit-coding for Rho - identifying the function/operator being called.
			tkFcn.tkCharIndex = lptkFunc->tkCharIndex; // Standard caret pointer
			</pre>
			In order to cross calculate '''⍴R'''(the shape of argument right argument variable R - tkFcn/UTF16_RHO '''is passed''' in the above example '''to''' up-arrow - the APL '''take''' function). Another reference to <lptkFunc> would be similar to function tokening use above, but say to the LeftShoe symbol (UTF16_LEFTSHOE or APL's '''⊂ enclose''' symbol). An often used element of the function token is <tkCharIndex> which is used as the caret pointer in case an error occurs and an error message would then be formed into '''[[System_Variable_DM\|⎕DM]]''' and '''[[System_Command_SI\|)SI]]''', workspace state indicator would get set. The function token structure is key to allowing APL's interpreter know how to keep track of where the program is processing-at and, as needed, correctly report errors.

	==Source Code Derived List of APL System Functions==		==Source Code Derived List of APL System Functions==