Scl function - Revision history

Ivailop: /* Syntax */

2015-09-29T22:20:24Z

Syntax

← Older revision		Revision as of 22:20, 29 September 2015
Line 32:		Line 32:
	\| ''name-mangling''		\| ''name-mangling''
	\| String		\| String
	\| Optional. Type of [[Name_Mangling\|name mangling]] to be used when intercepted. Possible values are ''"EXPLICIT"'' or ''"IMPLICIT"''. If the ''context'' argument is defined the default will be '''IMPLICIT'''. Note that if '''EXPLICIT''' is set the '''srTEST_INTERCEPT(<function_name>)"''' macro is required.		\| Optional. Type of [[Name_Mangling\|name mangling]] to be used when intercepted. Possible values are ''"EXPLICIT"'' or ''"IMPLICIT"''. If the ''context'' argument is defined the default will be '''IMPLICIT'''. Note that if '''EXPLICIT''' is set the '''srTEST_INTERCEPT('''<function_name>''')''' macro is required.
	\|-		\|-
	\| ''group-id''		\| ''group-id''

Ivailop: /* Examples */

2015-09-29T22:15:19Z

Examples

← Older revision		Revision as of 22:15, 29 September 2015
Line 44:		Line 44:

	=== Examples ===		=== Examples ===
	Using the ~~defaults for~~ ''~~IMPLICIT~~'' and ''~~STRIDE_TEST_GROUP~~''		Using the default "IMPLICIT" ''name-mangling'' and "STRIDE_TEST_GROUP" ''group-id''
	<source lang=c>		<source lang=c>
	void boo(void);		void boo(void);
Line 52:		Line 52:


	Setting a specific ''~~GROUP ID~~''		Setting a specific ''name-mangling'' and ''group-id''
	<source lang=c>		<source lang=c>
	void boo(void);		void boo(void);

	#pragma scl_function(boo, "DEFINITION", ''IMPLICIT'', ''MY_TEST_GROUP'')		#pragma scl_function(boo, "DEFINITION", "IMPLICIT", "MY_TEST_GROUP")
	</source>		</source>

Marku at 20:09, 6 July 2015

2015-07-06T20:09:44Z

← Older revision		Revision as of 20:09, 6 July 2015
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	The ''SCL function'' pragma allows capturing a global function for doubling or remoting. During the build process the [[Build Tools \| Stride ~~Compiler~~]] generates [[Intercept Module~~\|IM source code~~]] that provides the correct logic for the test.		The ''SCL function'' pragma allows capturing a global function for doubling or remoting. During the build process the [[Build Tools \| Stride Build Tools]] generates [[Intercept Module]] that provides the correct logic for the test.

	<source lang=c>		<source lang=c>

Marku at 16:18, 2 July 2015

2015-07-02T16:18:12Z

← Older revision		Revision as of 16:18, 2 July 2015
Line 12:		Line 12:

	=== Syntax ===		=== Syntax ===
	The ''scl_function'' pragma allows the user to capture a function. When captured for the purpose of interception (~~in which case the term~~ '''intercept-able''' ~~is used throughout~~ the ~~documentation)~~ optional arguments ~~allow specification of~~ how the intercept should be executed. The [[s2sinstrument\|Instrument Build Tool]] will use those options to generate appropriate function interception code.		The ''scl_function'' pragma allows the user to capture a function. When captured for the purpose of interception ('''intercept-able''') the optional arguments are used to specify how the intercept should be executed. The [[s2sinstrument\|Instrument Build Tool]] will use those options to generate appropriate function interception code.

	#pragma scl_function(function-name [,context, name-mangling, group-id])		#pragma scl_function(function-name [,context, name-mangling, group-id])
Line 28:		Line 28:
	\| ''context''		\| ''context''
	\| String		\| String
	\| Optional. Context in which the function is going to be intercepted. Possible values are ''"REFERENCE"'' - intercept at the function call (~~aka user~~) or ''"DEFINITION"'' - intercept at the function definition (~~aka owner~~).		\| Optional. Context in which the function is going to be intercepted. Possible values are ''"REFERENCE"'' - intercept at the function call (i.e. where the function is called) or ''"DEFINITION"'' - intercept at the function definition (i.e. where the function is implemented).
	\|-		\|-
	\| ''name-mangling''		\| ''name-mangling''
	\| String		\| String
	\| Optional. Type of [[Name_Mangling\|name mangling]] to be used when intercepted. Possible values are ''"EXPLICIT"'' or ''"IMPLICIT"''.		\| Optional. Type of [[Name_Mangling\|name mangling]] to be used when intercepted. Possible values are ''"EXPLICIT"'' or ''"IMPLICIT"''. If the ''context'' argument is defined the default will be '''IMPLICIT'''. Note that if '''EXPLICIT''' is set the '''srTEST_INTERCEPT(<function_name>)"''' macro is required.
	\|-		\|-
	\| ''group-id''		\| ''group-id''
	\| String		\| String
	\| Optional. User defined identifier representing the group to which this function belongs when ~~solving name mangling conflicts~~.		\| Optional. User defined identifier representing the group to which this function belongs when enabling interception. The default ''group-id'' is set to '''STRIDE_TEST_GROUP'''.
	\|}		\|}

	=== Notes ===		=== Notes ===
	* The function must be declared as a designator with external linkage.		* The function must be declared as a designator with external linkage.
	* A compilation error is reported if an attempt is made to capture a function more than once (~~with either [[scl_func]] or~~ scl_function).		* A compilation error is reported if an attempt is made to capture a function more than once.

			=== Examples ===
			Using the defaults for ''IMPLICIT'' and ''STRIDE_TEST_GROUP''
			<source lang=c>
			void boo(void);

			#pragma scl_function(boo, "DEFINITION")
			</source>


			Setting a specific ''GROUP ID''
			<source lang=c>
			void boo(void);

			#pragma scl_function(boo, "DEFINITION", ''IMPLICIT'', ''MY_TEST_GROUP'')
			</source>

Marku at 22:16, 1 July 2015

2015-07-01T22:16:12Z

← Older revision		Revision as of 22:16, 1 July 2015
Line 1:		Line 1:
	= The ~~scl_function~~ pragma =		__NOTOC__
			The ''SCL function'' pragma allows capturing a global function for doubling or remoting. During the build process the [[Build Tools \| Stride Compiler]] generates [[Intercept Module\|IM source code]] that provides the correct logic for the test.

	~~The ''scl_function'' pragma allows the user to capture a function. All interfaces that STRIDE works with must be captured.~~		<source lang=c>
			int foo(int x);

	~~When captured for the purpose of interception~~ (~~in which case the term '''intercept-able''' is used throught the documentation~~) ~~optional arguments allow specification of how would it be done. The [[s2sinstrument\|Instrument Build Tool]] will use those options to generate appropriate function interception code.~~		void boo(void);

	== Syntax ==		#pragma scl_function(foo)
			#pragma scl_function(boo, "DEFINITION", "IMPLICIT", "TEST_GROUP")
			</source>

			=== Syntax ===
			The ''scl_function'' pragma allows the user to capture a function. When captured for the purpose of interception (in which case the term '''intercept-able''' is used throughout the documentation) optional arguments allow specification of how the intercept should be executed. The [[s2sinstrument\|Instrument Build Tool]] will use those options to generate appropriate function interception code.

	#pragma scl_function(function-name [,context, name-mangling, group-id])		#pragma scl_function(function-name [,context, name-mangling, group-id])
Line 32:		Line 39:
	\|}		\|}

	== Notes ==		=== Notes ===
	* The function must be declared as a designator with external linkage.		* The function must be declared as a designator with external linkage.
	* A compilation error is reported if an attempt is made to capture a function more than once (with either [[scl_func]] or scl_function).		* A compilation error is reported if an attempt is made to capture a function more than once (with either [[scl_func]] or scl_function).

	~~== Example ==~~
	~~<source lang=c>~~
	~~int foo(int x);~~

	~~void boo(void);~~

	~~#pragma scl_function(foo)~~
	~~#pragma scl_function(boo, "DEFINITION", "IMPLICIT", "TEST_GROUP")~~
	~~</source>~~

	~~[[Category:SCL]]~~

Ivailop at 16:38, 14 June 2011

2011-06-14T16:38:53Z

← Older revision		Revision as of 16:38, 14 June 2011
Line 1:		Line 1:
	= The scl_function pragma =		= The scl_function pragma =

	The scl_function pragma allows the user to capture a function. All interfaces that STRIDE works with must be captured.		The ''scl_function'' pragma allows the user to capture a function. All interfaces that STRIDE works with must be captured.

	When captured for the purpose of interception (in which case the term '''intercept-able''' is used throught the documentation) optional arguments allow specification of how would it be done. The [[s2sinstrument\|Instrument Build Tool]] will use those options to generate appropriate function interception code.		When captured for the purpose of interception (in which case the term '''intercept-able''' is used throught the documentation) optional arguments allow specification of how would it be done. The [[s2sinstrument\|Instrument Build Tool]] will use those options to generate appropriate function interception code.
Line 16:		Line 16:
	\|-		\|-
	\| ''function-name''		\| ''function-name''
	\| ~~String~~		\| Identifier
	\| Name of the function to capture ~~(no quotes)~~		\| Name of the function to capture.
	\|-		\|-
	\| ''context''		\| ''context''
Line 38:		Line 38:
	== Example ==		== Example ==
	<source lang=c>		<source lang=c>
	int f(int x);		int foo(int x);

	void g(void);		void boo(void);

	#pragma scl_function(f)		#pragma scl_function(foo)
	#pragma scl_function(g, "DEFINITION", "IMPLICIT", "TEST_GROUP")		#pragma scl_function(boo, "DEFINITION", "IMPLICIT", "TEST_GROUP")
	</source>		</source>

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

Marku: moved Studio:Scl function to Scl function over redirect

2010-02-02T22:06:02Z

moved Studio:Scl function to Scl function over redirect

← Older revision	Revision as of 22:06, 2 February 2010
(No difference)

Marku: /* Example */

2010-02-02T22:05:46Z

Example

← Older revision		Revision as of 22:05, 2 February 2010
Line 46:		Line 46:
	</source>		</source>

	[[Category~~:Studio:Functions]]~~		[[Category:SCL]]
	~~[[Category:Studio~~:SCL]]

Ivailop: /* Syntax */

2009-10-20T04:15:52Z

Syntax

← Older revision		Revision as of 04:15, 20 October 2009
Line 17:		Line 17:
	\| ''function-name''		\| ''function-name''
	\| String		\| String
	\| Name of the function to ~~define~~ (no quotes)		\| Name of the function to capture (no quotes)
	\|-		\|-
	\| ''context''		\| ''context''

Timd at 23:49, 21 August 2009

2009-08-21T23:49:49Z

← Older revision		Revision as of 23:49, 21 August 2009
Line 48:		Line 48:
	[[Category:Studio:Functions]]		[[Category:Studio:Functions]]
	[[Category:Studio:SCL]]		[[Category:Studio:SCL]]
	~~[[Category:TestUnit Pragmas]]~~