qep.h

Go to the documentation of this file.

/*****************************************************************************
* Product: QP/C
* Last Updated for Version: 4.5.04
* Date of the Last Update:  Feb 01, 2013
*
*                    Q u a n t u m     L e a P s
*                    ---------------------------
*                    innovating embedded systems
*
* Copyright (C) 2002-2013 Quantum Leaps, LLC. All rights reserved.
*
* This program is open source 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 2 of the License, or
* (at your option) any later version.
*
* Alternatively, this program may be distributed and modified under the
* terms of Quantum Leaps commercial licenses, which expressly supersede
* the GNU General Public License and are specifically designed for
* licensees interested in retaining the proprietary status of their code.
*
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
*
* Contact information:
* Quantum Leaps Web sites: http://www.quantum-leaps.com
*                          http://www.state-machine.com
* e-mail:                  info@quantum-leaps.com
*****************************************************************************/
#ifndef qep_h
#define qep_h

#include "qevt.h"            /* QEP event processor needs the QEvt facility */


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

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

typedef uint8_t QState;

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

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

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

#define QFsm_ctor(me_, initial_) do { \
    (me_)->state = Q_STATE_CAST(0); \
    (me_)->temp  = (initial_); \
} while (0)

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

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


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


/* public methods */

#define QHsm_ctor(me_, initial_) do { \
    (me_)->state = Q_STATE_CAST(&QHsm_top); \
    (me_)->temp  = (initial_); \
} while (0)

#define QHsm_state(me_) (Q_STATE_CAST((me_)->state))

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

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

uint8_t QHsm_isIn(QHsm * const me, QStateHandler const state);

/* protected methods */

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

#define Q_RET_HANDLED       ((QState)0)

#define Q_HANDLED()         (Q_RET_HANDLED)

#define Q_RET_IGNORED       ((QState)1)

#define Q_IGNORED()         (Q_RET_IGNORED)

#define Q_RET_TRAN          ((QState)2)

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

#define Q_RET_SUPER         ((QState)3)

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

#define Q_RET_UNHANDLED    ((QState)4)

#define Q_UNHANDLED()      (Q_RET_UNHANDLED)

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

#endif                                                             /* qep_h */