Macros for the component header

Collaboration diagram for Macros for the component header:

Defines
#define	PUBLIC_STATE_DEF(component)   typedef struct component##_public_state_s
#define	PUBLIC_STATE_T(component)   component##_public_state_t
#define	NO_PUBLIC_STATE(component)   typedef STATE_T(component) PUBLIC_STATE_T(component)
#define	IMPORT(component)

---

Detailed Description

file.

---

Define Documentation

#define IMPORT

(

component

)

Value:

IMPORT_STATE(component);\
        IMPORT_INITOR(component);\
        IMPORT_FINITOR(component)

Invoke this macro in a component's header file to expose the component's public state and its generated initialisation and finalisation functions.

Parameters:

component

Name of the component

Definition at line 865 of file state_utils.h.

#define NO_PUBLIC_STATE

(

component

)

typedef STATE_T(component) PUBLIC_STATE_T(component)

Invoke this macro in a component's header file in place of PUBLIC_STATE_DEF(component) to say that the component's global state is simply its private state (if any ).

Parameters:

component

Name of the component

Definition at line 857 of file state_utils.h.

#define PUBLIC_STATE_DEF

(

component

)

typedef struct component##_public_state_s

Invoke this macro in a component's header file to open the definition of the component's public state structure:

• PUBLIC_STATE_DEF(component) {...}

Parameters:

component

Name of the component

Definition at line 840 of file state_utils.h.

#define PUBLIC_STATE_T

(

component

)

component##_public_state_t

Invoke this macro in a component's header file to close the definition of the component's public state:

• PUBLIC_STATE_DEF(component){...} PUBLIC_STATE_T(component);

Parameters:

component

Name of the component

Definition at line 849 of file state_utils.h.