qep.h

Go to the documentation of this file.

// Product: QEP/C++ platform-independent public interface
// Last Updated for Version: 4.2.00
// Date of the Last Update:  Jul 05, 2011
//
//                    Q u a n t u m     L e a P s
//                    ---------------------------
//                    innovating embedded systems
//
// Copyright (C) 2002-2011 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

#ifdef Q_USE_NAMESPACE
namespace QP {
#endif

class QEP {
public:
    static char const Q_ROM * Q_ROM_VAR getVersion(void);
};


typedef uint8_t QState;

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


class QFsm {
protected:
    QStateHandler m_state;          

public:
    virtual ~QFsm();

    void init(QEvent const *e = (QEvent *)0);

    void dispatch(QEvent const *e);

protected:

    QFsm(QStateHandler initial) : m_state(initial) {}
};

class QHsm {
protected:
    QStateHandler m_state;          

public:
    virtual ~QHsm();

    void init(QEvent const *e = (QEvent *)0);

    void dispatch(QEvent const *e);

    uint8_t isIn(QStateHandler state);

protected:

    QHsm(QStateHandler initial) : m_state(initial) {}

    static QState top(QHsm *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)

//lint -e960 -e1924 ignore MISRA Rule 42 (comma operator) and C-style cast
#define Q_TRAN(target_)  \
    (me->m_state = (QStateHandler)(target_), Q_RET_TRAN)

#define Q_RET_SUPER         ((QState)3)

//lint -e960 -e1924 ignore MISRA Rule 42 (comma operator) and C-style cast
#define Q_SUPER(super_)  \
    (me->m_state = (QStateHandler)(super_),  Q_RET_SUPER)


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

#ifdef Q_USE_NAMESPACE
}                                                              // namespace QP
#endif

// QS software tracing integration, only if enabled
#ifdef Q_SPY                                   // QS software tracing enabled?
    #ifndef qs_h
    #include "qs_port.h"                                    // include QS port
    #endif                                                             // qs_h

    #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

#else
    #ifndef qs_dummy_h
    #include "qs_dummy.h"                   // disable the QS software tracing
    #endif
#endif                                                                // Q_SPY

#endif                                                                // qep_h