qf_pkg.hpp

Go to the documentation of this file.

 
#ifndef QF_PKG_HPP
#define QF_PKG_HPP
 
#define QF_EVT_CONST_CAST_(e_) const_cast<QEvt *>(e_)
 
// QF-specific critical section...
#ifndef QF_CRIT_STAT_TYPE
    #define QF_CRIT_STAT_
 
    #define QF_CRIT_E_()        QF_CRIT_ENTRY(dummy)
 
    #define QF_CRIT_X_()        QF_CRIT_EXIT(dummy)
 
#elif (!defined QF_CRIT_STAT_)
    #define QF_CRIT_STAT_       QF_CRIT_STAT_TYPE critStat_;
    #define QF_CRIT_E_()        QF_CRIT_ENTRY(critStat_)
    #define QF_CRIT_X_()        QF_CRIT_EXIT(critStat_)
#endif  // QF_CRIT_STAT_TYPE
 
// Assertions inside the crticial section ------------------------------------
#ifdef Q_NASSERT // Q_NASSERT defined--assertion checking disabled
 
    #define Q_ASSERT_CRIT_(id_, test_)  ((void)0)
    #define Q_REQUIRE_CRIT_(id_, test_) ((void)0)
    #define Q_ERROR_CRIT_(id_)          ((void)0)
 
#else  // Q_NASSERT not defined--assertion checking enabled
 
    #define Q_ASSERT_CRIT_(id_, test_) do {\
        if ((test_)) {} else { \
            QF_CRIT_X_(); \
            Q_onAssert(&Q_this_module_[0], static_cast<int_t>(id_)); \
        } \
    } while (false)
 
    #define Q_REQUIRE_CRIT_(id_, test_) Q_ASSERT_CRIT_((id_), (test_))
 
    #define Q_ERROR_CRIT_(id_) do { \
        QF_CRIT_X_(); \
        Q_onAssert(&Q_this_module_[0], static_cast<int_t>(id_)); \
    } while (false)
 
#endif // Q_NASSERT
 
 
namespace QP {
 
// package-scope objects -----------------------------------------------------
extern QF_EPOOL_TYPE_ QF_pool_[QF_MAX_EPOOL]; 
extern std::uint_fast8_t QF_maxPool_; 
extern QSubscrList *QF_subscrList_;   
extern enum_t QF_maxPubSignal_;       
 
//............................................................................
struct QFreeBlock {
    QFreeBlock * volatile m_next;    
};
 
//............................................................................
// The following flags and bitmasks are for the fields of the @c refCtr_
// attribute of the QP::QTimeEvt class (inherited from QEvt). This attribute
// is NOT used for reference counting in time events, because the @c poolId_
// attribute is zero ("static events").
//
constexpr std::uint8_t TE_IS_LINKED    = 1U << 7U;  // flag
constexpr std::uint8_t TE_WAS_DISARMED = 1U << 6U;  // flag
constexpr std::uint8_t TE_TICK_RATE    = 0x0FU;     // bitmask
 
//****************************************************************************
// internal helper inline functions
 
inline std::uint8_t QF_EVT_POOL_ID_ (QEvt const * const e) noexcept {
    return e->poolId_;
}
 
inline std::uint8_t QF_EVT_REF_CTR_ (QEvt const * const e) noexcept {
    return e->refCtr_;
}
 
inline void QF_EVT_REF_CTR_INC_(QEvt const * const e) noexcept {
    ++(QF_EVT_CONST_CAST_(e))->refCtr_;
}
 
inline void QF_EVT_REF_CTR_DEC_(QEvt const * const e) noexcept {
    --(QF_EVT_CONST_CAST_(e))->refCtr_;
}
 
} // namespace QP
 
#define QF_PTR_RANGE_(x_, min_, max_)  (((min_) <= (x_)) && ((x_) <= (max_)))
 
#define QF_PTR_AT_(base_, i_) (base_[i_])
 
#endif  // QF_PKG_HPP