Studio:SCL Design Requirements - Revision history

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

2009-08-21T00:09:48Z

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

← Older revision		Revision as of 00:09, 21 August 2009
Line 54:		Line 54:
	*Refer to the '''SCL Wizard''' section of the STRIDE Online Help for information on how to create SCL pragmas.		*Refer to the '''SCL Wizard''' section of the STRIDE Online Help for information on how to create SCL pragmas.

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

Timd: SCL Design Requirements moved to Studio:SCL Design Requirements

2009-08-18T22:50:12Z

SCL Design Requirements moved to Studio:SCL Design Requirements

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

Ivailop: /* Avoiding delegate name mangling conflicts */

2009-03-24T19:12:23Z

Avoiding delegate name mangling conflicts

← Older revision		Revision as of 19:12, 24 March 2009
Line 43:		Line 43:
	</source>		</source>

	== Avoiding ~~delegate~~ name mangling conflicts ==		== Avoiding interception name mangling conflicts ==
	To avoid [[Name_Mangling\|name mangling]] conflicts when using delegates, it is recommended that the implementation of routines (~~Owners~~) and the callers of the routines (~~Users~~) be placed in separate C source files.		To avoid [[Name_Mangling\|name mangling]] conflicts when using ''interceptors'' (formal ''delegates''), it is recommended that the implementation of routines (Definition) and the callers of the routines (Reference) be placed in separate C source files.

	== See Also ==		== See Also ==

Stevel: /* See Also */

2008-10-08T20:25:22Z

Ivailop: /* See Also */

2008-10-02T17:48:25Z

Ivailop: /* See Also */

2008-10-02T15:32:44Z

Ivailop: /* Syntax */

2008-10-01T23:59:41Z

Syntax

← Older revision		Revision as of 23:59, 1 October 2008
Line 36:		Line 36:

	===Syntax===		===Syntax===
	#ifdef _SCL		<source lang=c>
	#define _inline		#ifdef _SCL
	...		#define _inline
	#endif		//...
			#endif
			</source>

	== Avoiding delegate name mangling conflicts ==		== Avoiding delegate name mangling conflicts ==

Ivailop: /* Syntax */

2008-10-01T23:59:13Z

Syntax

← Older revision		Revision as of 23:59, 1 October 2008
Line 23:		Line 23:

	===Syntax===		===Syntax===
	#ifndef <FILE_NAME_H>		<source lang=c>
	#define <FILE_NAME_H>		#ifndef <FILE_NAME_H>
			#define <FILE_NAME_H>

			//... body of header file

	~~... body of header file~~		#endif /* <FILE_NAME_H> */
			</source>
	#endif /* <FILE_NAME_H> */

	== Protecting against unique compiler directives ==		== Protecting against unique compiler directives ==

Stevel: New page: TOC The STRIDE Communication Language (SCL) is a description language used to unambiguously define messages, Remote Function Calls (RFCs), and trace points. The SCL uses standard C sy...

2008-07-16T16:11:16Z

New page: __TOC__ The STRIDE Communication Language (SCL) is a description language used to unambiguously define messages, Remote Function Calls (RFCs), and trace points. The SCL uses standard C sy...

New page

__TOC__

The STRIDE Communication Language (SCL) is a description language used to unambiguously define messages, Remote Function Calls (RFCs), and trace points. The SCL uses standard C syntax along with a set of pragmas to fully describe both types of interfaces and trace points. Refer to the [[SCL_Data_Types|SCL Data Types page]] for more information about compliant data types.

Because an interface definition is independent of the implementation, the SCL requires all interfaces and trace points to be defined within a standard C header file. The following is a set of design constraints required to enable the SCL to be independent of any specific development environment.

== Pragma usage ==
Interfaces and trace points are identified using special [[SCL_Pragmas|SCL pragmas]] contained in header file(s). SCL pragmas are also used to further describe unique parameters and/or fields defined as part of the interface. For example, pointers are ambiguous concerning direction and require further qualification, such as declaring the pointer as input, output, or both. Pragmas can be defined in a separate header that includes other header files containing the prototypes, data structures, etc., or they can be directly inserted into the application header file(s).

The SCL Wizard section of the STRIDE Online Help shows you how to streamline and simplify working with pragmas by allowing you to quickly capture interfaces and accurately qualify payloads and types.

== Interfaces defined in header files ==
Interface definitions (e.g., prototypes, message data structures) must be contained in a standard C header file. All associated user-defined data types (e.g., enumerators, structures, etc.) are also required to be in a header file.

== Trace points defined within a header file ==
Trace point definitions (e.g., data structures, unique IDs, etc.) must be contained in a standard C header file.

== Globally scoped routines ==
Functions identified for remote usages must be declared global in scope (they cannot be static). Intercept Modules work with any compiler and require name binding during compilation.

== Nested include protection ==
All header files that contain SCL pragmas, data structures, etc., are required to protect against nested inclusion. The following is a recommended approach to protect against including a file more than once:

===Syntax===
#ifndef <FILE_NAME_H>
#define <FILE_NAME_H>

... body of header file

#endif /* <FILE_NAME_H> */

== Protecting against unique compiler directives ==
All header files that contain SCL pragmas, data structures, prototypes, etc., are required to protect against using non-standard compiler directives. A recommended approach is to define the directive as '''empty''' when using an SCL front-end compiler:

===Syntax===
#ifdef _SCL
#define _inline
...
#endif

== Avoiding delegate name mangling conflicts ==
To avoid [[Name_Mangling|name mangling]] conflicts when using delegates, it is recommended that the implementation of routines (Owners) and the callers of the routines (Users) be placed in separate C source files.

== See Also ==
*[[SCL Pragmas]]
*[[SCL Structure]]
*[[SCL Data Types]]
*[[SCL Message Attributes]]
*For detailed instructions on working with SCL, including code samples and examples, refer to the [[http://www.s2technologies.com/pdf/s2sSCLReferenceGuide.pdf SCL Reference Guide]].
*Refer to the '''SCL Wizard''' section of the STRIDE Online Help for information on how to create SCL pragmas.

[[Category: SCL_Reference]]

← Older revision		Revision as of 20:25, 8 October 2008
Line 51:		Line 51:
	*[[SCL Data Types]]		*[[SCL Data Types]]
	*[[SCL Message Attributes]]		*[[SCL Message Attributes]]
	*For detailed instructions on working with SCL, including code samples and examples, refer to the [~~http~~:~~//www.s2technologies.com/pdf/~~s2sSCLReferenceGuide.pdf SCL Reference Guide].		*For detailed instructions on working with SCL, including code samples and examples, refer to the [[Media:s2sSCLReferenceGuide.pdf\|SCL Reference Guide]].
	*Refer to the '''SCL Wizard''' section of the STRIDE Online Help for information on how to create SCL pragmas.		*Refer to the '''SCL Wizard''' section of the STRIDE Online Help for information on how to create SCL pragmas.

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

← Older revision		Revision as of 17:48, 2 October 2008
Line 54:		Line 54:
	*Refer to the '''SCL Wizard''' section of the STRIDE Online Help for information on how to create SCL pragmas.		*Refer to the '''SCL Wizard''' section of the STRIDE Online Help for information on how to create SCL pragmas.

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

← Older revision		Revision as of 15:32, 2 October 2008
Line 51:		Line 51:
	*[[SCL Data Types]]		*[[SCL Data Types]]
	*[[SCL Message Attributes]]		*[[SCL Message Attributes]]
	*For detailed instructions on working with SCL, including code samples and examples, refer to the [[http://www.s2technologies.com/pdf/s2sSCLReferenceGuide.pdf SCL Reference Guide]].		*For detailed instructions on working with SCL, including code samples and examples, refer to the [http://www.s2technologies.com/pdf/s2sSCLReferenceGuide.pdf SCL Reference Guide].
	*Refer to the '''SCL Wizard''' section of the STRIDE Online Help for information on how to create SCL pragmas.		*Refer to the '''SCL Wizard''' section of the STRIDE Online Help for information on how to create SCL pragmas.

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

Studio:SCL Design Requirements - Revision history

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

Timd: SCL Design Requirements moved to Studio:SCL Design Requirements

Ivailop: /* Avoiding delegate name mangling conflicts */

Stevel: /* See Also */

Ivailop: /* See Also */

Ivailop: /* See Also */

Ivailop: /* Syntax */

Ivailop: /* Syntax */

Stevel: New page: __TOC__ The STRIDE Communication Language (SCL) is a description language used to unambiguously define messages, Remote Function Calls (RFCs), and trace points. The SCL uses standard C sy...

Stevel: New page: TOC The STRIDE Communication Language (SCL) is a description language used to unambiguously define messages, Remote Function Calls (RFCs), and trace points. The SCL uses standard C sy...