Difference between revisions of "Scl function"

From STRIDE Wiki
Jump to: navigation, search
m (Text replace - 'Category: SCL' to 'Category:Studio:SCL')
Line 47: Line 47:
  
 
[[Category: Functions]]
 
[[Category: Functions]]
[[Category: SCL]]
+
[[Category:Studio:SCL]]

Revision as of 18:10, 20 August 2009

The scl_function pragma

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 Instrument Build Tool will use those options to generate appropriate function interception code.

Syntax

#pragma scl_function(function-name [,context, name-mangling, group-id])


Parameters Type Description
function-name String Name of the function to define (no quotes)
context 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).
name-mangling String Optional. Type of name mangling to be used when intercepted. Possible values are "EXPLICIT" or "IMPLICIT".
group-id String Optional. User defined identifier representing the group to which this function belongs when solving name mangling conflicts.

Notes

  • 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).

Example

int f(int x); 

void g(void);

#pragma scl_function(f)
#pragma scl_function(g, "DEFINITION", "IMPLICIT", "TEST_GROUP")