Quad EC C Source Code Analysis - Revision history

Robert Wallick: /* Comparison Structure Configurations - Different Returned Outputs */ string/char_array example added

2015-08-21T16:30:34Z

Comparison Structure Configurations - Different Returned Outputs: string/char_array example added

← Older revision		Revision as of 12:30, 21 August 2015
Line 91:		Line 91:
	</pre>		</pre>
	The above return information C coding for '''[[System_Function_TS\|⎕TS]]''' is included because setup for ⎕TS's integers output vector is relatively straightforward, i.e. less complex than a <u>nested</u> vector('''[[System_Function_EC\|⎕EC]]''') but not much more complex than a scalar ('''[[System_Function_T\|⎕T]]''').		The above return information C coding for '''[[System_Function_TS\|⎕TS]]''' is included because setup for ⎕TS's integers output vector is relatively straightforward, i.e. less complex than a <u>nested</u> vector('''[[System_Function_EC\|⎕EC]]''') but not much more complex than a scalar ('''[[System_Function_T\|⎕T]]''').

			<br>4. '''[[System_Function_DR\|⎕DR]]''' (file <'''qf_dr.c'''> code extract) detailed structure configuration for returned string (CHAR_ARRAY) '''char/string vector''' (extracted from function SysFnDR_Show_EM_YY):
			<pre>
			// Variable declarations (type varname), needed for C code extracted just below:
			APLUINT ByteRes; // # bytes in the result
			LPPL_YYSTYPE lpYYRes; // Ptr to the result
			APLNELM aplNELMRes; // Result NELM
			APLCHAR wszTemp[512]; // Temporary APLCHARs Unicode string variable
			HGLOBAL hGlbRes; // Result ...
			LPVOID lpMemRes; // Ptr to result global memory

			// Get the result NELM
			aplNELMRes = lstrlenW (wszTemp);

			// Calculate space needed for the result
			ByteRes = CalcArraySize (ARRAY_CHAR, aplNELMRes, 1);

			// Check for overflow
			if (ByteRes NE (APLU3264) ByteRes)
			goto WSFULL_EXIT;

			// Allocate space for the result
			hGlbRes = DbgGlobalAlloc (GHND, (APLU3264) ByteRes);
			if (hGlbRes EQ NULL)
			goto WSFULL_EXIT;

			// Lock the memory to get a ptr to it
			lpMemRes = MyGlobalLock (hGlbRes);

			#define lpHeader ((LPVARARRAY_HEADER) lpMemRes)
			// Fill in the header
			lpHeader->Sig.nature = VARARRAY_HEADER_SIGNATURE;
			lpHeader->ArrType = ARRAY_CHAR;
			////lpHeader->PermNdx = PERMNDX_NONE; // Already zero from GHND
			////lpHeader->SysVar = FALSE; // Already zero from GHND
			lpHeader->RefCnt = 1;
			lpHeader->NELM = aplNELMRes;
			lpHeader->Rank = 1;
			#undef lpHeader

			// Save the dimension in the result
			*VarArrayBaseToDim (lpMemRes) = aplNELMRes;

			// Point to the data (APLAPA struct)
			lpMemRes = VarArrayDataFmBase (lpMemRes);

			// Copy text to the result
			CopyMemory (lpMemRes, wszTemp, (APLU3264) BytesIn (ARRAY_CHAR, aplNELMRes));

			// No longer need this ptr
			MyGlobalUnlock (hGlbRes); lpMemRes = NULL;

			// Allocate a new YYRes
			lpYYRes = YYAlloc ();

			// Fill in the result token
			lpYYRes->tkToken.tkFlags.TknType = TKT_VARARRAY;
			////lpYYRes->tkToken.tkFlags.ImmType = IMMTYPE_ERROR; // Already zero from YYAlloc
			////lpYYRes->tkToken.tkFlags.NoDisplay = FALSE; // Already zero from YYAlloc
			lpYYRes->tkToken.tkData.tkGlbData = MakePtrTypeGlb (hGlbRes);
			lpYYRes->tkToken.tkCharIndex = lptkFunc->tkCharIndex;

			return lpYYRes;
			</pre>

Robert Wallick: /* Comparison Structure Configurations - Different Returned Outputs */

2015-08-20T21:58:45Z

Comparison Structure Configurations - Different Returned Outputs

← Older revision		Revision as of 17:58, 20 August 2015
Line 35:		Line 35:
	==Comparison Structure Configurations - Different Returned Outputs==		==Comparison Structure Configurations - Different Returned Outputs==

	1. '''[[System_Function_T\|⎕T]]''' (file <'''qf_t.c'''> code extract) <u>'''initial'''</u> ~~structural setup~~ for returned solitary '''scalar number''':		1. '''[[System_Function_T\|⎕T]]''' (file <'''qf_t.c'''> code extract) <u>'''initial'''</u> structure configuration for returned solitary '''scalar number''':
	<pre>		<pre>
	// Allocate a new YYRes		// Allocate a new YYRes
Line 47:		Line 47:
	</pre>		</pre>

	<br>2. '''[[System_Function_EC\|⎕EC]]''' (file <'''qf_ec.c'''> code extract) <u>'''initial'''</u> ~~structural setup~~ for returned 3-element '''nested vector''':		<br>2. '''[[System_Function_EC\|⎕EC]]''' (file <'''qf_ec.c'''> code extract) <u>'''initial'''</u> structure configuration for returned 3-element '''nested vector''':
	<pre>		<pre>
	// Allocate a new YYRes		// Allocate a new YYRes
Line 63:		Line 63:
	See also '''[[Frequently_Used_TypeDef_Structures_and_Variables#tkToken Structures More Detailed Sample Uses Table\|tkToken Sample Uses Table]]'''.		See also '''[[Frequently_Used_TypeDef_Structures_and_Variables#tkToken Structures More Detailed Sample Uses Table\|tkToken Sample Uses Table]]'''.

	<br>3. '''[[System_Function_TS\|⎕TS]]''' (file <'''qf_ts.c'''> code extract) <u>'''more'''</u> substantive ~~structural setup~~ for a returned plain-vanilla / homogeneous 7-element '''unmixed vector''':		<br>3. '''[[System_Function_TS\|⎕TS]]''' (file <'''qf_ts.c'''> code extract) <u>'''more'''</u> substantive structure configuration for a returned plain-vanilla / homogeneous 7-element '''unmixed vector''':
	<pre>		<pre>
	#define lpMemData ((LPAPLINT) lpMemRes) // The following seven vector elements returned are all integers		#define lpMemData ((LPAPLINT) lpMemRes) // The following seven vector elements returned are all integers

Robert Wallick: /* Comparison Prelim Setups - Different Returned Outputs */

2015-08-20T21:56:43Z

Comparison Prelim Setups - Different Returned Outputs

← Older revision		Revision as of 17:56, 20 August 2015
Line 33:		Line 33:
	<br>If execution failed: '''⎕EC''' returns the '''error message''' associated with that failure, a unicode string - as '''[[System_Function_EC\|⎕EC]]''''s third output element.		<br>If execution failed: '''⎕EC''' returns the '''error message''' associated with that failure, a unicode string - as '''[[System_Function_EC\|⎕EC]]''''s third output element.

	==Comparison ~~Prelim Setups~~ - Different Returned Outputs==		==Comparison Structure Configurations - Different Returned Outputs==

	1. '''[[System_Function_T\|⎕T]]''' (file <'''qf_t.c'''> code extract) <u>'''initial'''</u> structural setup for returned solitary '''scalar number''':		1. '''[[System_Function_T\|⎕T]]''' (file <'''qf_t.c'''> code extract) <u>'''initial'''</u> structural setup for returned solitary '''scalar number''':

Robert Wallick: /* Comparison Prelim Setups - Different Returned Outputs */ expanded

2015-08-20T21:42:25Z

Comparison Prelim Setups - Different Returned Outputs: expanded

← Older revision		Revision as of 17:42, 20 August 2015
Line 41:		Line 41:
	// Fill in the result token		// Fill in the result token
	lpYYRes->tkToken.tkFlags.TknType = TKT_VARIMMED;		lpYYRes->tkToken.tkFlags.TknType = TKT_VARIMMED;
	lpYYRes->tkToken.tkFlags.ImmType = IMMTYPE_FLOAT;		lpYYRes->tkToken.tkFlags.ImmType = IMMTYPE_FLOAT; // Or use IMMTYPE_INT for an integer
	// lpYYRes->tkToken.tkFlags.NoDisplay = FALSE; // Already zero from YYAlloc		// lpYYRes->tkToken.tkFlags.NoDisplay = FALSE; // Already zero from YYAlloc
	lpYYRes->tkToken.tkData.tkFloat = aplFloatSec;		lpYYRes->tkToken.tkData.tkFloat = aplFloatSec; // DataType APLFLOAT aplFloatSec Or use DataType APLINT with tkData.tkInteger
	lpYYRes->tkToken.tkCharIndex = lptkFunc->tkCharIndex;		lpYYRes->tkToken.tkCharIndex = lptkFunc->tkCharIndex;
	</pre>		</pre>

Robert Wallick: /* Comparison Prelim Setups - Different Returned Outputs */ wording

2015-08-18T00:35:33Z

Comparison Prelim Setups - Different Returned Outputs: wording

← Older revision		Revision as of 20:35, 17 August 2015
Line 60:		Line 60:

	Differences: Note '''TKT_VARIMMED for ⎕T''' vs. '''TKT_VARARRAY for ⎕EC'''. Also note ⎕EC's use of hGlbRes for nested returned data, re: lpYYRes->tkToken.tkData.tkGlbData = MakePtrTypeGlb (hGlbRes);		Differences: Note '''TKT_VARIMMED for ⎕T''' vs. '''TKT_VARARRAY for ⎕EC'''. Also note ⎕EC's use of hGlbRes for nested returned data, re: lpYYRes->tkToken.tkData.tkGlbData = MakePtrTypeGlb (hGlbRes);
	Nesting occurs in ⎕EC output through the use of '''TKT_VARARRAY''' as token flags token type and through use of nested memory pointer '''MakePtrTypeGlb (hGlbRes)''' in var lpYYRes via the token's global data. ~~Excluding~~ pre-setup work in ⎕EC, comment lines and post-op processing C code, only 4 lines of C code were needed (above) to setup return result variable lpYYRes for ⎕EC.		Nesting occurs in ⎕EC output through the use of '''TKT_VARARRAY''' as token flags token type and through use of nested memory pointer '''MakePtrTypeGlb (hGlbRes)''' in var lpYYRes via the token's global data. From a purely structural perspective, excluding 1)pre-setup work in ⎕EC, 2)comment lines and 3)post-op processing C code, only 4 lines of C code were needed (above) to '''setup''' (not calculate) return result variable lpYYRes for ⎕EC.
	See also '''[[Frequently_Used_TypeDef_Structures_and_Variables#tkToken Structures More Detailed Sample Uses Table\|tkToken Sample Uses Table]]'''.		See also '''[[Frequently_Used_TypeDef_Structures_and_Variables#tkToken Structures More Detailed Sample Uses Table\|tkToken Sample Uses Table]]'''.

Robert Wallick: /* Comparison Prelim Setups - Different Returned Outputs */ wording

2015-08-18T00:30:53Z

Comparison Prelim Setups - Different Returned Outputs: wording

← Older revision		Revision as of 20:30, 17 August 2015
Line 50:		Line 50:
	<pre>		<pre>
	// Allocate a new YYRes		// Allocate a new YYRes
	lpYYRes = YYAlloc ();		lpYYRes = YYAlloc (); // Setup line # 1 for lpYYRes
	// Fill in the result token		// Fill in the result token
	lpYYRes->tkToken.tkFlags.TknType = TKT_VARARRAY;		lpYYRes->tkToken.tkFlags.TknType = TKT_VARARRAY; // Setup line # 2 for lpYYRes
	// lpYYRes->tkToken.tkFlags.ImmType = IMMTYPE_ERROR; // Already zero from YYAlloc		// lpYYRes->tkToken.tkFlags.ImmType = IMMTYPE_ERROR; // Already zero from YYAlloc
	// lpYYRes->tkToken.tkFlags.NoDisplay = FALSE; // Already zero from YYAlloc		// lpYYRes->tkToken.tkFlags.NoDisplay = FALSE; // Already zero from YYAlloc
	lpYYRes->tkToken.tkData.tkGlbData = MakePtrTypeGlb (hGlbRes);		lpYYRes->tkToken.tkData.tkGlbData = MakePtrTypeGlb (hGlbRes); // Setup line # 3 for lpYYRes
	lpYYRes->tkToken.tkCharIndex = lptkFunc->tkCharIndex;		lpYYRes->tkToken.tkCharIndex = lptkFunc->tkCharIndex; // Setup line # 4 for lpYYRes
	</pre>		</pre>

	Differences: Note '''TKT_VARIMMED for ⎕T''' vs. '''TKT_VARARRAY for ⎕EC'''. Also note ⎕EC's use of hGlbRes for nested returned data, re: lpYYRes->tkToken.tkData.tkGlbData = MakePtrTypeGlb (hGlbRes);		Differences: Note '''TKT_VARIMMED for ⎕T''' vs. '''TKT_VARARRAY for ⎕EC'''. Also note ⎕EC's use of hGlbRes for nested returned data, re: lpYYRes->tkToken.tkData.tkGlbData = MakePtrTypeGlb (hGlbRes);
	Nesting occurs in ⎕EC output through the use of '''TKT_VARARRAY''' as token flags token type and through use of nested memory pointer '''MakePtrTypeGlb (hGlbRes)''' in var lpYYRes via the token's global data.		Nesting occurs in ⎕EC output through the use of '''TKT_VARARRAY''' as token flags token type and through use of nested memory pointer '''MakePtrTypeGlb (hGlbRes)''' in var lpYYRes via the token's global data. Excluding pre-setup work in ⎕EC, comment lines and post-op processing C code, only 4 lines of C code were needed (above) to setup return result variable lpYYRes for ⎕EC.
	See also '''[[Frequently_Used_TypeDef_Structures_and_Variables#tkToken Structures More Detailed Sample Uses Table\|tkToken Sample Uses Table]]'''.		See also '''[[Frequently_Used_TypeDef_Structures_and_Variables#tkToken Structures More Detailed Sample Uses Table\|tkToken Sample Uses Table]]'''.

Robert Wallick: /* Comparison Prelim Setups - Different Returned Outputs */ added cross ref link, wording

2015-08-18T00:22:52Z

Comparison Prelim Setups - Different Returned Outputs: added cross ref link, wording

← Older revision		Revision as of 20:22, 17 August 2015
Line 60:		Line 60:

	Differences: Note '''TKT_VARIMMED for ⎕T''' vs. '''TKT_VARARRAY for ⎕EC'''. Also note ⎕EC's use of hGlbRes for nested returned data, re: lpYYRes->tkToken.tkData.tkGlbData = MakePtrTypeGlb (hGlbRes);		Differences: Note '''TKT_VARIMMED for ⎕T''' vs. '''TKT_VARARRAY for ⎕EC'''. Also note ⎕EC's use of hGlbRes for nested returned data, re: lpYYRes->tkToken.tkData.tkGlbData = MakePtrTypeGlb (hGlbRes);
			Nesting occurs in ⎕EC output through the use of '''TKT_VARARRAY''' as token flags token type and through use of nested memory pointer '''MakePtrTypeGlb (hGlbRes)''' in var lpYYRes via the token's global data.
			See also '''[[Frequently_Used_TypeDef_Structures_and_Variables#tkToken Structures More Detailed Sample Uses Table\|tkToken Sample Uses Table]]'''.

	<br>3. '''[[System_Function_TS\|⎕TS]]''' (file <'''qf_ts.c'''> code extract) <u>'''more'''</u> substantive structural setup for a returned plain-vanilla / homogeneous 7-element '''unmixed vector''':		<br>3. '''[[System_Function_TS\|⎕TS]]''' (file <'''qf_ts.c'''> code extract) <u>'''more'''</u> substantive structural setup for a returned plain-vanilla / homogeneous 7-element '''unmixed vector''':

Robert Wallick: /* Comparison Prelim Setups - Different Returned Outputs */ wording

2015-08-11T12:46:46Z

Comparison Prelim Setups - Different Returned Outputs: wording

← Older revision		Revision as of 08:46, 11 August 2015
Line 61:		Line 61:
	Differences: Note '''TKT_VARIMMED for ⎕T''' vs. '''TKT_VARARRAY for ⎕EC'''. Also note ⎕EC's use of hGlbRes for nested returned data, re: lpYYRes->tkToken.tkData.tkGlbData = MakePtrTypeGlb (hGlbRes);		Differences: Note '''TKT_VARIMMED for ⎕T''' vs. '''TKT_VARARRAY for ⎕EC'''. Also note ⎕EC's use of hGlbRes for nested returned data, re: lpYYRes->tkToken.tkData.tkGlbData = MakePtrTypeGlb (hGlbRes);

	<br>3. '''[[System_Function_TS\|⎕TS]]''' (file <'''qf_ts.c'''> code extract) <u>'''more'''</u> substantive structural setup for a returned plain vanilla 7-element '''unmixed vector''':		<br>3. '''[[System_Function_TS\|⎕TS]]''' (file <'''qf_ts.c'''> code extract) <u>'''more'''</u> substantive structural setup for a returned plain-vanilla / homogeneous 7-element '''unmixed vector''':
	<pre>		<pre>
	#define lpMemData ((LPAPLINT) lpMemRes) // The following seven vector elements returned are all integers		#define lpMemData ((LPAPLINT) lpMemRes) // The following seven vector elements returned are all integers

Robert Wallick: /* Comparison Prelim Setups - Different Returned Outputs */ wording

2015-08-11T12:39:20Z

Comparison Prelim Setups - Different Returned Outputs: wording

← Older revision		Revision as of 08:39, 11 August 2015
Line 73:		Line 73:
	#undef lpMemData		#undef lpMemData

	// Memory ptr no longer needed, ~~unlock~~/~~free~~ hGlbRes, reset lpMemRes pointer to null		// Memory ptr no longer needed, allow unlocking/freeing hGlbRes(technically freed upon returning from ⎕TS), reset lpMemRes pointer to null
	MyGlobalUnlock (hGlbRes); lpMemRes = NULL;		MyGlobalUnlock (hGlbRes); lpMemRes = NULL;

Robert Wallick: /* Comparison Prelim Setups - Different Returned Outputs */ wording

2015-08-11T12:35:26Z

Comparison Prelim Setups - Different Returned Outputs: wording

← Older revision		Revision as of 08:35, 11 August 2015
Line 61:		Line 61:
	Differences: Note '''TKT_VARIMMED for ⎕T''' vs. '''TKT_VARARRAY for ⎕EC'''. Also note ⎕EC's use of hGlbRes for nested returned data, re: lpYYRes->tkToken.tkData.tkGlbData = MakePtrTypeGlb (hGlbRes);		Differences: Note '''TKT_VARIMMED for ⎕T''' vs. '''TKT_VARARRAY for ⎕EC'''. Also note ⎕EC's use of hGlbRes for nested returned data, re: lpYYRes->tkToken.tkData.tkGlbData = MakePtrTypeGlb (hGlbRes);

	<br>3. '''[[System_Function_TS\|⎕TS]]''' (file <'''qf_ts.c'''> code extract) <u>'''~~entire~~'''</u> structural setup for a returned plain vanilla 7-element '''unmixed vector''':		<br>3. '''[[System_Function_TS\|⎕TS]]''' (file <'''qf_ts.c'''> code extract) <u>'''more'''</u> substantive structural setup for a returned plain vanilla 7-element '''unmixed vector''':
	<pre>		<pre>
	#define lpMemData ((LPAPLINT) lpMemRes) // The following seven vector elements returned are all integers		#define lpMemData ((LPAPLINT) lpMemRes) // The following seven vector elements returned are all integers