module.h File Reference

#include "juno/status.h"
#include <stdint.h>

Include dependency graph for module.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
The name of the module type
Declare a juno module implemented as a union
#define	JUNO_MODULE_DECLARE(name)   typedef union name##_TAG name
#define	JUNO_MODULE_BASE_DECLARE(name)   typedef struct name##_TAG name
#define	JUNO_MODULE_DERIVE_DECLARE(name)   JUNO_MODULE_BASE_DECLARE(name)
#define	JUNO_FAILURE_HANDLER   _pfcnFailureHandler
#define	JUNO_FAILURE_USER_DATA   _pvFailurUserData
#define	JUNO_MODULE_EMPTY
#define	JUNO_MODULE_SUPER   tBase
#define	JUNO_MODULE(name, API, base, derived)
#define	JUNO_MODULE_BASE(name, API, members)
#define	JUNO_MODULE_DERIVE(name, base, members)
#define	JUNO_MODULE_GET_API(ptModule, MODULE_BASE_NAME)   ((const MODULE_BASE_NAME *)ptModule)->ptApi

Macro Definition Documentation

JUNO_FAILURE_HANDLER

#define JUNO_FAILURE_HANDLER   _pfcnFailureHandler

Alias for the failure handler for a module

JUNO_FAILURE_USER_DATA

#define JUNO_FAILURE_USER_DATA   _pvFailurUserData

Alias for the failure handler user data for a module

JUNO_MODULE

#define JUNO_MODULE	(		name,
			API,
			base,
			derived
	)

Value:

union name##_TAG \
{ \
    const API *ptApi; \
    base JUNO_MODULE_SUPER; \
    derived \
}

Define a juno module. This needs to be done in the composition root. This is where users define all possible module implementations for a module.

Parameters

name	The name of the module as declared
API	The name of the API type for the module
base	The name of the base implementation type for the module as declared
derived	The derived modules seperated by ;

JUNO_MODULE_BASE

#define JUNO_MODULE_BASE	(		name,
			API,
			members
	)

Value:

struct name##_TAG \
{ \
    const API *ptApi; \
    members \
    JUNO_FAILURE_HANDLER_T JUNO_FAILURE_HANDLER; \
    JUNO_USER_DATA_T *JUNO_FAILURE_USER_DATA; \
}

Implement a base for a module

Parameters

name	The name of the module base implementation as declared
API	The API type for the module
members	The member components of the module base implementation

JUNO_MODULE_BASE_DECLARE

#define JUNO_MODULE_BASE_DECLARE

(

name

)

typedef struct name##_TAG name

Declare a base implementation for the module implemented as a struct

Parameters

name	The name of the base implementation type

JUNO_MODULE_DECLARE

#define JUNO_MODULE_DECLARE

(

name

)

typedef union name##_TAG name

JUNO_MODULE_DERIVE

#define JUNO_MODULE_DERIVE	(		name,
			base,
			members
	)

Value:

struct name##_TAG \
{ \
    base JUNO_MODULE_SUPER; \
    members \
}

Implement a derivation of a module

Parameters

name	The name of the module derivation as declared
base	The name of the base implementation for the module as declared
members	The member components of the module derivation

JUNO_MODULE_DERIVE_DECLARE

#define JUNO_MODULE_DERIVE_DECLARE

(

name

)

JUNO_MODULE_BASE_DECLARE(name)

Declare a derivation of a juno module implemented as a struct

Parameters

name	The name of the derived module type

JUNO_MODULE_EMPTY

#define JUNO_MODULE_EMPTY

Empty macro that indicates a module implementation has no additional members

JUNO_MODULE_GET_API

#define JUNO_MODULE_GET_API	(		ptModule,
			MODULE_BASE_NAME
	)		((const MODULE_BASE_NAME *)ptModule)->ptApi

Get the API pointer from the module

Parameters

ptModule	The module pointer
MODULE_BASE_NAME	The base type of the module

JUNO_MODULE_SUPER

#define JUNO_MODULE_SUPER   tBase

Alias for the module base implementation