rkhevt.h

Go to the documentation of this file.

/*
 *  --------------------------------------------------------------------------
 *
 *                                Framework RKH
 *                                -------------
 *
 *            State-machine framework for reactive embedded systems
 *
 *                      Copyright (C) 2010 Leandro Francucci.
 *          All rights reserved. Protected by international copyright laws.
 *
 *
 *  RKH is free software: you can redistribute it and/or modify it under the
 *  terms of the GNU General Public License as published by the Free Software
 *  Foundation, either version 3 of the License, or (at your option) any
 *  later version.
 *
 *  RKH is distributed in the hope that it will be useful, but WITHOUT ANY
 *  WARRANTY; without even the implied warranty of MERCHANTABILITY or
 *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 *  more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with RKH, see copying.txt file.
 *
 *  Contact information:
 *  RKH web site:   http://sourceforge.net/projects/rkh-reactivesys/
 *  e-mail:         francuccilea@gmail.com
 *  ---------------------------------------------------------------------------
 */

/* -------------------------- Development history -------------------------- */
/*
 *  2015.10.24  LeFr  v2.4.05  Initial version
 */

/* -------------------------------- Authors -------------------------------- */
/*
 *  LeFr  Leandro Francucci  francuccilea@gmail.com
 */

/* --------------------------------- Notes --------------------------------- */
/* --------------------------------- Module -------------------------------- */
#ifndef __RKHEVT_H__
#define __RKHEVT_H__

/* ----------------------------- Include files ----------------------------- */
#include "rkhtype.h"
#include "rkhcfg.h"

/* ---------------------- External C language linkage ---------------------- */
#ifdef __cplusplus
extern "C" {
#endif

/* --------------------------------- Macros -------------------------------- */
#define RKH_EVT_CAST(_e)      ((RKH_EVT_T *)(_e))

#define RKH_CAST_EVT(e)       ((RKH_EVT_T *)(e))

#if RKH_CFG_FWK_DYN_EVT_EN == RKH_ENABLED
    #define RKH_INC_REF(evt) \
        if (RKH_CAST_EVT(evt)->pool != 0) \
        { \
            ++RKH_CAST_EVT(evt)->nref; \
        }
#else
    #define RKH_INC_REF(evt) \
        (void)0
#endif

/* -------------------------------- Constants ------------------------------ */
/* ------------------------------- Data types ------------------------------ */
#if RKH_CFG_FWK_SIZEOF_EVT == 8
typedef rui8_t RKH_SIG_T;
#elif RKH_CFG_FWK_SIZEOF_EVT == 16
typedef rui16_t RKH_SIG_T;
#elif RKH_CFG_FWK_SIZEOF_EVT == 32
typedef rui32_t RKH_SIG_T;
#else
typedef rui8_t RKH_SIG_T;
#endif

#if RKH_CFG_FWK_SIZEOF_EVT_SIZE == 8
typedef rui8_t RKH_ES_T;
#elif RKH_CFG_FWK_SIZEOF_EVT_SIZE == 16
typedef rui16_t RKH_ES_T;
#elif RKH_CFG_FWK_SIZEOF_EVT_SIZE == 32
typedef rui32_t RKH_ES_T;
#else
typedef rui8_t RKH_ES_T;
#endif

typedef struct RKH_EVT_T
{
    RKH_SIG_T e;

    rui8_t nref;

    rui8_t pool;
} RKH_EVT_T;

/* -------------------------- External variables --------------------------- */
/* -------------------------- Function prototypes -------------------------- */
/* -------------------- External C language linkage end -------------------- */
#ifdef __cplusplus
}
#endif

/* ------------------------------ Module end ------------------------------- */
#endif

/* ------------------------------ End of file ------------------------------ */