qep.h

Go to the documentation of this file.

/*****************************************************************************
* Product:  QEP/C platform-independent public interface
* Last Updated for Version: 4.4.00
* Date of the Last Update:  Jan 17, 2012
*
*                    Q u a n t u m     L e a P s
*                    ---------------------------
*                    innovating embedded systems
*
* Copyright (C) 2002-2012 Quantum Leaps, LLC. All rights reserved.
*
* This software may be distributed and modified under the terms of the GNU
* General Public License version 2 (GPL) as published by the Free Software
* Foundation and appearing in the file GPL.TXT included in the packaging of
* this file. Please note that GPL Section 2[b] requires that all works based
* on this software must also be made publicly available under the terms of
* the GPL ("Copyleft").
*
* Alternatively, this software may be distributed and modified under the
* terms of Quantum Leaps commercial licenses, which expressly supersede
* the GPL and are specifically designed for licensees interested in
* retaining the proprietary status of their code.
*
* Contact information:
* Quantum Leaps Web site:  http://www.quantum-leaps.com
* e-mail:                  info@quantum-leaps.com
*****************************************************************************/
#ifndef qep_h
#define qep_h

#include "qevent.h"        /* QEP event processor needs the QEvent facility */

/****************************************************************************/
char_t const Q_ROM * Q_ROM_VAR QEP_getVersion(void);

/****************************************************************************/

typedef uint8_t QState;

typedef QState (*QStateHandler)(void *me, QEvent const *e);

#define Q_STATE_CAST(handler_)  ((QStateHandler)(handler_))

/****************************************************************************/
typedef struct QFsmTag {
    QStateHandler state;         
} QFsm;

#define QFsm_ctor(me_, initial_) ((me_)->state = (initial_))

/****************************************************************************/
void QFsm_init(QFsm *me, QEvent const *e);

void QFsm_dispatch(QFsm *me, QEvent const *e);


/****************************************************************************/
typedef struct QFsmTag QHsm;

/* public methods */

#define QHsm_ctor(me_, initial_) ((me_)->state  = (initial_))

void QHsm_init(QHsm *me, QEvent const *e);

void QHsm_dispatch(QHsm *me, QEvent const *e);

uint8_t QHsm_isIn(QHsm *me, QStateHandler state);

/* protected methods */

QState QHsm_top(void *me, QEvent const *e);

#define Q_RET_IGNORED       ((QState)1)

#define Q_IGNORED()         (Q_RET_IGNORED)

#define Q_RET_HANDLED       ((QState)0)

#define Q_HANDLED()         (Q_RET_HANDLED)

#define Q_RET_TRAN          ((QState)2)

#define Q_TRAN(target_)  \
    (((QFsm *)me)->state = Q_STATE_CAST(target_), Q_RET_TRAN)

#define Q_RET_SUPER         ((QState)3)

#define Q_SUPER(super_)  \
    (((QHsm *)me)->state = Q_STATE_CAST(super_),  Q_RET_SUPER)


#define Q_EVENT_CAST(class_) ((class_ const *)e)

/****************************************************************************/
enum QReservedSignals {
    Q_ENTRY_SIG = 1,                   
    Q_EXIT_SIG,                         
    Q_INIT_SIG,                  
    Q_USER_SIG      
};

#ifdef Q_SPY

    #if (Q_SIGNAL_SIZE == 1)

        #define QS_SIG_(sig_)       QS_u8_(sig_)
    #elif (Q_SIGNAL_SIZE == 2)
        #define QS_SIG_(sig_)       QS_u16_(sig_)
    #elif (Q_SIGNAL_SIZE == 4)
        #define QS_SIG_(sig_)       QS_u32_(sig_)
    #endif

#endif                                                             /* Q_SPY */

#endif                                                             /* qep_h */