qep_pkg.h

00001 //////////////////////////////////////////////////////////////////////////////
00002 // Product: QEP/C++
00003 // Last Updated for Version: 4.0.00
00004 // Date of the Last Update:  Apr 06, 2008
00005 //
00006 //                    Q u a n t u m     L e a P s
00007 //                    ---------------------------
00008 //                    innovating embedded systems
00009 //
00010 // Copyright (C) 2002-2008 Quantum Leaps, LLC. All rights reserved.
00011 //
00012 // This software may be distributed and modified under the terms of the GNU
00013 // General Public License version 2 (GPL) as published by the Free Software
00014 // Foundation and appearing in the file GPL.TXT included in the packaging of
00015 // this file. Please note that GPL Section 2[b] requires that all works based
00016 // on this software must also be made publicly available under the terms of
00017 // the GPL ("Copyleft").
00018 //
00019 // Alternatively, this software may be distributed and modified under the
00020 // terms of Quantum Leaps commercial licenses, which expressly supersede
00021 // the GPL and are specifically designed for licensees interested in
00022 // retaining the proprietary status of their code.
00023 //
00024 // Contact information:
00025 // Quantum Leaps Web site:  http://www.quantum-leaps.com
00026 // e-mail:                  info@quantum-leaps.com
00027 //////////////////////////////////////////////////////////////////////////////
00028 #ifndef qep_pkg_h
00029 #define qep_pkg_h
00030 
00031 /// \file
00032 /// \ingroup qep
00033 /// \brief Internal (package scope) QEP/C++ interface.
00034 
00035 #include "qep_port.h"                                              // QEP port
00036 
00037 extern QEvent const QEP_reservedEvt_[];      ///< preallocated reserved events
00038 
00039 /// internal QEP constants
00040 enum QEPConst {
00041     QEP_EMPTY_SIG_ = 0,                ///< empty signal for internal use only
00042 
00043     /// maximum depth of state nesting (including the top level), must be >= 3
00044     QEP_MAX_NEST_DEPTH_ = 6
00045 };
00046 
00047 /// helper macro to trigger internal event in an HSM
00048 #define QEP_TRIG_(state_, sig_) \
00049     ((*(state_))(this, &QEP_reservedEvt_[sig_]))
00050 
00051 /// helper macro to trigger entry action in an HSM
00052 #define QEP_EXIT_(state_) \
00053     if (QEP_TRIG_(state_, Q_EXIT_SIG) == Q_RET_HANDLED) { \
00054         QS_BEGIN_(QS_QEP_STATE_EXIT, QS::smObj_, this) \
00055             QS_OBJ_(this); \
00056             QS_FUN_(state_); \
00057         QS_END_() \
00058     }
00059 
00060 /// helper macro to trigger exit action in an HSM
00061 #define QEP_ENTER_(state_) \
00062     if (QEP_TRIG_(state_, Q_ENTRY_SIG) == Q_RET_HANDLED) { \
00063         QS_BEGIN_(QS_QEP_STATE_ENTRY, QS::smObj_, this) \
00064             QS_OBJ_(this); \
00065             QS_FUN_(state_); \
00066         QS_END_() \
00067     }
00068 
00069 #endif                                                            // qep_pkg_h