Studio:Scl conform - Revision history

Ivailop: /* Syntax */

2012-01-04T20:35:46Z

Syntax

← Older revision		Revision as of 20:35, 4 January 2012
Line 20:		Line 20:
	* 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 passed 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.
	\|-		\|-
	\| ''size-name''		\| ''size-name''

Ivailop at 00:11, 12 November 2011

2011-11-12T00:11:44Z

← Older revision		Revision as of 00:11, 12 November 2011
Line 1:		Line 1:
	== The scl_conform pragma ==		= The scl_conform pragma =
	The scl_conform pragma allows the user to define a conformant array within a payload. The payload can be a C structure or a parameter declaration list. The conformant array must be the last item in the payload (e.g., the last field in the structure, or the last parameter in the declaration list). Because of this, only the payload name and the name of the size field in that payload are required. The SCL compiler automatically assumes the conformant array field within the specified payload.		The scl_conform pragma allows the user to define a conformant array within a payload. The payload can be a C structure or a parameter declaration list. The conformant array must be the last item in the payload (e.g., the last field in the structure, or the last parameter in the declaration list). Because of this, only the payload name and the name of the size field in that payload are required. The SCL compiler automatically assumes the conformant array field within the specified payload.

Ivailop at 00:11, 12 November 2011

2011-11-12T00:11:19Z

← Older revision		Revision as of 00:11, 12 November 2011
Line 2:		Line 2:
	The scl_conform pragma allows the user to define a conformant array within a payload. The payload can be a C structure or a parameter declaration list. The conformant array must be the last item in the payload (e.g., the last field in the structure, or the last parameter in the declaration list). Because of this, only the payload name and the name of the size field in that payload are required. The SCL compiler automatically assumes the conformant array field within the specified payload.		The scl_conform pragma allows the user to define a conformant array within a payload. The payload can be a C structure or a parameter declaration list. The conformant array must be the last item in the payload (e.g., the last field in the structure, or the last parameter in the declaration list). Because of this, only the payload name and the name of the size field in that payload are required. The SCL compiler automatically assumes the conformant array field within the specified payload.

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

	== Syntax ==		== Syntax ==

Ivailop: /* The scl_conform pragma */

2011-11-12T00:10:32Z

The scl_conform pragma

← Older revision		Revision as of 00:10, 12 November 2011
Line 1:		Line 1:
	= The scl_conform pragma=		== The scl_conform pragma ==
	The scl_conform pragma allows the user to define a conformant array within a payload. The payload can be a C structure or a parameter declaration list. The conformant array must be the last item in the payload (e.g., the last field in the structure, or the last parameter in the declaration list). Because of this, only the payload name and the name of the size field in that payload are required. The SCL compiler automatically assumes the conformant array field within the specified payload.		The scl_conform pragma allows the user to define a conformant array within a payload. The payload can be a C structure or a parameter declaration list. The conformant array must be the last item in the payload (e.g., the last field in the structure, or the last parameter in the declaration list). Because of this, only the payload name and the name of the size field in that payload are required. The SCL compiler automatically assumes the conformant array field within the specified payload.

	~~'''Note~~:''~~' Because scl_conform is a rarely-used SCL pragma, you may find~~ [[scl_ptr_sized]] ~~to be more appropriate for your interface~~.		NOTE: ''For an alternative use case of sized structure please look at [[scl_ptr_sized]] pragma.''

	== Syntax ==		== Syntax ==
Line 15:		Line 15:
	\| String		\| String
	\| Name of the structure or function that encapsulates the conformant array		\| Name of the structure or function that encapsulates the conformant array
			The following restrictions apply:
			* The structure type may not be pointed to by a sized pointer.
			* 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 reside only within IN or INOUT memory blocks.
	\|-		\|-
	\| ''size-name''		\| ''size-name''
	\| Member		\| Member
	\| Name of the structure field or function parameter that contains the size of the array		\| Name of the structure field or function parameter that contains the size of the array
			The following restrictions apply:
			* The type of the size-name must be an integral type.
			* The size-field must reside within the same payload block as the structure or the function payload.
	\|-		\|-
	\| ''max-size''		\| ''max-size''
Line 24:		Line 34:
	\| Maximum size of the conformant array		\| Maximum size of the conformant array
	\|}		\|}

	~~== Notes ==~~
	* This pragma can only be used after the payload structure has been defined.
	* For additional information on scl_conform, including constraints, refer to the section on scl_conform in the [[Media:s2sSCLReferenceGuide.pdf\|SCL Reference Guide]].

	== Example ==		== Example ==
Line 45:		Line 51:
	#pragma scl_conform( CmdPayload_t, bufferSize, MAX_BUFFER_SIZE )		#pragma scl_conform( CmdPayload_t, bufferSize, MAX_BUFFER_SIZE )
	</source>		</source>

			== See Also ==
			* For additional information on scl_conform, including constraints, refer to the section on scl_conform 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:10:52Z

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

← Older revision		Revision as of 00:10, 21 August 2009
Line 46:		Line 46:
	</source>		</source>

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

Timd: Scl conform moved to Studio:Scl conform

2009-08-18T22:45:54Z

Scl conform moved to Studio:Scl conform

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

Stevel at 20:04, 8 October 2008

2008-10-08T20:04:09Z

← Older revision		Revision as of 20:04, 8 October 2008
Line 27:		Line 27:
	== Notes ==		== Notes ==
	* This pragma can only be used after the payload structure has been defined.		* This pragma can only be used after the payload structure has been defined.
	* For additional information on scl_conform, including constraints, refer to the section on scl_conform in the [~~http~~:~~//www.s2technologies.com/pdf/~~s2sSCLReferenceGuide.pdf SCL Reference Guide].		* For additional information on scl_conform, including constraints, refer to the section on scl_conform in the [[Media:s2sSCLReferenceGuide.pdf\|SCL Reference Guide]].

	== Example ==		== Example ==

Ivailop: /* Example */

2008-10-02T17:52:00Z

Example

← Older revision		Revision as of 17:52, 2 October 2008
Line 46:		Line 46:
	</source>		</source>

	[[Category: ~~SCL_Reference~~]]		[[Category: SCL]]

Ivailop: /* Example */

2008-10-02T00:07:29Z

Example

← Older revision		Revision as of 00:07, 2 October 2008
Line 30:		Line 30:

	== Example ==		== Example ==
			<source lang=c>
			/* Constant defining the maximum array size */
			#define MAX_BUFFER_SIZE 20

	/* ~~Constant~~ defining the ~~maximum array size~~ */		/* Structure defining a message payload with a conformant array */
	~~#define MAX_BUFFER_SIZE 20~~		/* The array field must be the last member in the payload */
			typedef struct {
			int f1;
			short bufferSize;
			char buffer[1];
			} CmdPayload_t;

	~~/* Structure defining a message payload with a conformant array */~~		/* Use the scl_conform pragma to define the conformant arrays */
			#pragma scl_conform( CmdPayload_t, bufferSize, MAX_BUFFER_SIZE )
	~~/* The array field must be the last member in the payload */~~		</source>
	~~typedef struct {~~
	~~int f1;~~
	~~short bufferSize;~~
	~~char buffer[1];~~
	~~} CmdPayload_t;~~

	/* Use the scl_conform pragma to define the conformant arrays */
	#pragma scl_conform( CmdPayload_t, bufferSize, MAX_BUFFER_SIZE )

	[[Category: SCL_Reference]]		[[Category: SCL_Reference]]

Ivailop: /* Notes */

2008-10-02T00:06:52Z

Notes

← Older revision		Revision as of 00:06, 2 October 2008
Line 27:		Line 27:
	== Notes ==		== Notes ==
	* This pragma can only be used after the payload structure has been defined.		* This pragma can only be used after the payload structure has been defined.
	* For additional information on scl_conform, including constraints, refer to the section on scl_conform in the [[http://www.s2technologies.com/pdf/s2sSCLReferenceGuide.pdf SCL Reference Guide]].		* For additional information on scl_conform, including constraints, refer to the section on scl_conform in the [http://www.s2technologies.com/pdf/s2sSCLReferenceGuide.pdf SCL Reference Guide].

	== Example ==		== Example ==