event.h

Go to the documentation of this file.

 
#ifndef ECU_EVENT_H_
#define ECU_EVENT_H_
 
/*------------------------------------------------------------*/
/*------------------------- INCLUDES -------------------------*/
/*------------------------------------------------------------*/
 
/* STDLib. */
#include <stddef.h>
#include <stdint.h>
 
/* ECU. */
#include "ecu/utils.h"
 
/*------------------------------------------------------------*/
/*-------------------------- MACROS --------------------------*/
/*------------------------------------------------------------*/
 
#define ECU_EVENT_BASE_CAST(event_ptr_) \
    ((struct ecu_event *)(event_ptr_))
 
#define ECU_EVENT_CONST_BASE_CAST(event_ptr_) \
    ((const struct ecu_event *)(event_ptr_))
 
#define ECU_EVENT_CTOR(id_, size_) \
    {                              \
        .id = id_,                 \
        .size = size_              \
    }
 
#define ECU_EVENT_IS_BASE_OF(base_, derived_) \
    ECU_IS_BASE_OF(base_, derived_)
 
#define ECU_EVENT_SIZE_UNUSED \
    ((size_t)0)
 
/*------------------------------------------------------------*/
/*------------------------ EVENT IDS -------------------------*/
/*------------------------------------------------------------*/
 
enum ecu_reserved_event_ids
{
    /*------------------------------------------------------------------*/
    /*--------------------- RESERVED EVENT IDS SECTION -----------------*/
    /*--------- LAST MEMBER MUST EQUAL ECU_VALID_EVENT_ID_BEGIN --------*/
    /*------------------------------------------------------------------*/
    /* ADD FUTURE PRIVATE AND RESERVED EVENTS HERE. */
    ECU_RESERVED_EVENT_ID = -1, 
    /*******************************/
    ECU_VALID_EVENT_ID_BEGIN = 0, 
    /*------------------------------------------------------------------*/
    /*--------------------- AVAILABLE EVENT IDS SECTION ----------------*/
    /*--------- FIRST MEMBER MUST EQUAL ECU_VALID_EVENT_ID_BEGIN -------*/
    /*------------------------------------------------------------------*/
    ECU_USER_EVENT_ID_BEGIN = ECU_VALID_EVENT_ID_BEGIN 
};
 
typedef int32_t ecu_event_id_t;
 
/*------------------------------------------------------------*/
/*--------------------------- EVENT --------------------------*/
/*------------------------------------------------------------*/
 
struct ecu_event
{
    ecu_event_id_t id;
 
    size_t size;
};
 
/*------------------------------------------------------------*/
/*------------------ EVENT MEMBER FUNCTIONS ------------------*/
/*------------------------------------------------------------*/
 
#ifdef __cplusplus
extern "C" {
#endif
 
extern void ecu_event_ctor(struct ecu_event *me, ecu_event_id_t id, size_t size);
extern ecu_event_id_t ecu_event_id(const struct ecu_event *me);
 
extern size_t ecu_event_size(const struct ecu_event *me);
#ifdef __cplusplus
}
#endif
 
#endif /* ECU_EVENT_H_ */