System Defines/Macros

Standard defines/macros for the Speect Engine.

Summary

S_BEGIN_C_DECLS	Start block for enclosing C code for inclusion in C++ programs.
S_END_C_DECLS	End block for enclosing C code for inclusion in C++ programs.
NULL	Defined NULL pointer if it has not previously been defined.
S_MAX_PATH_LENGTH	Defined maximum length (size in bytes) of a string buffer for file paths.
S_PATH_SEP	Defined path separator of the file system.
TRUE	Definition of the TRUE value.
FALSE	Definition of the FALSE value.
S_CONCAT	Concatenate two strings.
S_TOSTRING	Return a string of the given argument.
S_VOIDPTR	Cast a pointer to a a pointer of type void.
S_UNUSED	Indicate that a given function parameter or static variable is unused.
S_API	Declares a symbol to be exported for shared library usage.
S_LOCAL	Declares a symbol hidden from other libraries.

Defines

define S_BEGIN_C_DECLS

Start block for enclosing C code for inclusion in C++ programs.

This allows C++ programs to include the C header files of the Speect engine.

define S_END_C_DECLS

End block for enclosing C code for inclusion in C++ programs.

This allows C++ programs to include the C header files of the Speect engine.

define NULL

Defined NULL pointer if it has not previously been defined.

Platform specific value.

define S_MAX_PATH_LENGTH

1024

Defined maximum length (size in bytes) of a string buffer for file paths.

define S_PATH_SEP

Defined path separator of the file system.

Platform specific value.

define TRUE

Definition of the TRUE value.

TRUE = 1.

define FALSE

Definition of the FALSE value.

FALSE = 0.

Macros

macro S_CONCAT(A, B)

Concatenate two strings.

Parameters:

• A –

  String A

• B –

  String B to concatenate to string A.

Return:

Concatenated strings A and B.

macro S_TOSTRING(S)

Return a string of the given argument.

Parameters:

• S –

  Argument to turn into a string.

Return:

"S"

macro S_VOIDPTR(PTR)

Cast a pointer to a a pointer of type void.

Parameters:

• PTR –

  Pointer to cast to void pointer.

Return:

(void*)PTR

macro S_UNUSED(PARAM)

Indicate that a given function parameter or static variable is unused.

Its purpose is to eliminate compiler warnings when using high warning levels.

Parameters:

• PARAM –

  The parameter to mark as being unused.

Visibility

Macros for controlling library symbol visibility and linkage. These macros have platform specific values. S_API and S_LOCAL should be used by plug-in implementations for better portability.

macro S_API

Declares a symbol to be exported for shared library usage.

macro S_LOCAL

Declares a symbol hidden from other libraries.