Studio:Scl struct sized - Revision history

Ivailop: /* Syntax */

2012-01-04T20:35:01Z

Syntax

← Older revision		Revision as of 20:35, 4 January 2012
Line 21:		Line 21:
	* The structure type may not be a member of an union.		* The structure type may not be a member of an union.
	* The structure type may not be a member of any other structure unless it is the last member.		* The structure type may not be a member of any other structure unless it is the last member.
	* The structure type may not be ~~passed~~ as a function ~~parameter~~ (but a pointer to it is allowed).		* The structure type may not be used as a formal parameter or return value of a function (but a pointer to it is allowed).
	* The structure type ~~may~~ reside ~~only~~ within ~~IN or INOUT~~ memory ~~blocks~~.		* The structure type cannot reside within OUT memory block.
	* If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).		* If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).
	\|-		\|-

Ivailop: /* Examples */

2011-11-12T00:14:42Z

Examples

← Older revision		Revision as of 00:14, 12 November 2011
Line 45:		Line 45:

	#ifdef _SCL		#ifdef _SCL
	#pragma scl_struct_sized(SimpleSizedStruct, size);		#pragma scl_struct_sized(SimpleSizedStruct, size)
	#endif		#endif

Line 61:		Line 61:

	#ifdef _SCL		#ifdef _SCL
	#pragma scl_struct_sized(ConformantArraySizedStruct, size);		#pragma scl_struct_sized(ConformantArraySizedStruct, size)
	#endif		#endif

Ivailop: /* Examples */

2011-11-12T00:14:17Z

Examples

← Older revision		Revision as of 00:14, 12 November 2011
Line 43:		Line 43:
	int moreJunk;		int moreJunk;
	} SimpleSizedStruct;		} SimpleSizedStruct;

	~~extern void f(SimpleSizedStruct* ps);~~

	#ifdef _SCL		#ifdef _SCL
	~~#pragma scl_function(f)~~		#pragma scl_struct_sized(SimpleSizedStruct, size);
	#pragma scl_struct_sized(*f.ps, size);
	#endif		#endif

Line 62:		Line 59:
	int ary[1]; // variable length array whose length depends on the size		int ary[1]; // variable length array whose length depends on the size
	} ConformantArraySizedStruct;		} ConformantArraySizedStruct;

	~~extern void f(ConformantArraySizedStruct* ps);~~

	#ifdef _SCL		#ifdef _SCL
	~~#pragma scl_function(f)~~		#pragma scl_struct_sized(ConformantArraySizedStruct, size);
	#pragma scl_struct_sized(*f.ps, size);
	#endif		#endif

Ivailop at 00:11, 12 November 2011

2011-11-12T00:11:33Z

← Older revision		Revision as of 00:11, 12 November 2011
Line 1:		Line 1:
	== The scl_struct_sized pragma ==		= The scl_struct_sized pragma =

	The scl_struct_sized pragma is used to identify a sized structure. A sized structure is a C programming convention for representing a structure whose size is variable and defined by one of the members of the structure. This pragma is infrequently used, but must be used, whenever the programmer defined size does not match the C language size of the structure (as calculated by the sizeof macro).		The scl_struct_sized pragma is used to identify a sized structure. A sized structure is a C programming convention for representing a structure whose size is variable and defined by one of the members of the structure. This pragma is infrequently used, but must be used, whenever the programmer defined size does not match the C language size of the structure (as calculated by the sizeof macro).

Ivailop at 00:10, 12 November 2011

2011-11-12T00:10:35Z

← Older revision		Revision as of 00:10, 12 November 2011
Line 1:		Line 1:
	= The scl_struct_sized pragma =		== The scl_struct_sized pragma ==

	The scl_struct_sized pragma is used to identify a sized structure. A sized structure is a C programming convention for representing a structure whose size is variable and defined by one of the members of the structure. This pragma is infrequently used, but must be used, whenever the programmer defined size does not match the C language size of the structure (as calculated by the sizeof macro).		The scl_struct_sized pragma is used to identify a sized structure. A sized structure is a C programming convention for representing a structure whose size is variable and defined by one of the members of the structure. This pragma is infrequently used, but must be used, whenever the programmer defined size does not match the C language size of the structure (as calculated by the sizeof macro).

			NOTE: ''For an alternative use case of sized structure please look at [[scl_conform]] pragma.''

	~~= STRIDE Version Support=~~
	~~Available in STRIDE 3.0.0103 (StoneSteps Tower 3) and later versions~~
	== Syntax ==		== Syntax ==
	#pragma scl_struct_sized(type-name, size-field)		#pragma scl_struct_sized(type-name, size-field)
Line 18:		Line 18:
	The following restrictions apply:		The following restrictions apply:
	* The structure type may not be pointed to by a sized pointer.		* The structure type may not be pointed to by a sized pointer.
	* The structure type may not be a member of any other structure ~~or union~~.		* The structure type may not be used in an array.
			* The structure type may not be a member of an union.
			* The structure type may not be a member of any other structure unless it is the last member.
	* The structure type may not be passed as a function parameter (but a pointer to it is allowed).		* The structure type may not be passed as a function parameter (but a pointer to it is allowed).
	* The structure type may reside only within IN or INOUT memory blocks.		* The structure type may reside only within IN or INOUT memory blocks.
	* If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).		* If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).
	* If the last member of the structure is an array, the array's element type may not contain a sized structure or a conformant array (see [[scl_conform]]).

	\|-		\|-
	\| ''size-field''		\| ''size-field''
	\| Member		\| Member
	\| Identifies a field within the sized structure whose value determines the actual runtime size of the structure. The following restrictions apply:		\| Identifies a field within the sized structure whose value determines the actual runtime size of the structure. The following restrictions apply:
	* The type of the size-field must be an integral type ~~(int, short, char)~~.		* The type of the size-field must be an integral type.
	* The value (at runtime) is expected to be greater than the type size of the structure (as determined by the sizeof macro).		* The value (at runtime) is expected to be greater than the type size of the structure (as determined by the sizeof macro).
	* The size-field must reside within the same payload block as the sized structure.		* The size-field must reside within the same payload block as the sized structure.
Line 73:		Line 73:

	== See Also ==		== See Also ==
	* For additional information on ~~scl_string~~, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf\|SCL Reference Guide]].		* For additional information on scl_struct_sized, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf\|SCL Reference Guide]].

	[[Category:Studio:SCL]]		[[Category:Studio:SCL]]

Timd: Text replace - 'Category: SCL' to 'Category:Studio:SCL'

2009-08-21T00:12:03Z

Text replace - 'Category: SCL' to 'Category:Studio:SCL'

← Older revision		Revision as of 00:12, 21 August 2009
Line 75:		Line 75:
	* For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf\|SCL Reference Guide]].		* For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf\|SCL Reference Guide]].

	[[Category: SCL]]		[[Category:Studio:SCL]]

Timd: Scl struct sized moved to Studio:Scl struct sized

2009-08-18T22:38:59Z

Scl struct sized moved to Studio:Scl struct sized

← Older revision	Revision as of 22:38, 18 August 2009
(No difference)

Robg: /* Example 2 */

2008-11-18T19:34:29Z

Example 2

← Older revision		Revision as of 19:34, 18 November 2008
Line 54:		Line 54:

	=== Example 2 ===		=== Example 2 ===
	This example shows the declaration of a sized struct containing a variable length array whose actual length is proportional to the value of the size field. In this case the array bound is ~~defined~~ as ~~zero~~ but ~~another commonly used bound~~ is ~~1. (An array bound~~ of ~~zero is not officially ANSI C, and is usually supported only under specific compiler option~~.)		This example shows the declaration of a sized struct containing a variable length array whose actual length is proportional to the value of the size field. In this case the array bound is declared as 1, but by convention is really controlled by the value of the size field.
	<source lang=c>		<source lang=c>

Line 60:		Line 60:
	int size;		int size;
	int someJunk;		int someJunk;
	int ary[0]; // variable length array whose length depends on the size		int ary[1]; // variable length array whose length depends on the size
	} ConformantArraySizedStruct;		} ConformantArraySizedStruct;

Robg: /* Example 2 */

2008-11-05T18:56:16Z

Example 2

← Older revision		Revision as of 18:56, 5 November 2008
Line 63:		Line 63:
	} ConformantArraySizedStruct;		} ConformantArraySizedStruct;

	extern void f(~~SimpleSizedStruct~~* ps);		extern void f(ConformantArraySizedStruct* ps);

	#ifdef _SCL		#ifdef _SCL

Robg: /* Example 2 */

2008-11-05T18:54:43Z

Example 2

← Older revision		Revision as of 18:54, 5 November 2008
Line 64:		Line 64:

	extern void f(SimpleSizedStruct* ps);		extern void f(SimpleSizedStruct* ps);

			#ifdef _SCL
	#pragma scl_function(f)		#pragma scl_function(f)
	#pragma scl_struct_sized(*f.ps, size);		#pragma scl_struct_sized(*f.ps, size);
			#endif

	</source>		</source>