qpcpp/ports/qt/mingw/qf_port.h

//****************************************************************************
// Product: QF/C++ port to Qt5
// Last Updated for Version: 5.1.0
// Date of the Last Update:  Sep 28, 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 3 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 qf_port_h
#define qf_port_h

                               // event queue and thread types for the Qt port
#define QF_EQUEUE_TYPE              QEQueue
#define QF_OS_OBJECT_TYPE           void *
#define QF_THREAD_TYPE              void *

                    // The maximum number of active objects in the application
#define QF_MAX_ACTIVE               63
                                      // The number of system clock tick rates
#define QF_MAX_TICK_RATE            2

                        // various QF object sizes configuration for this port
#define QF_EVENT_SIZ_SIZE           4
#define QF_EQUEUE_CTR_SIZE          4
#define QF_MPOOL_SIZ_SIZE           4
#define QF_MPOOL_CTR_SIZE           4
#define QF_TIMEEVT_CTR_SIZE         4

                                            // Qt critical section, see NOTE01
// QF_CRIT_STAT_TYPE not defined
#define QF_CRIT_ENTRY(dummy)        (QP::QF_enterCriticalSection())
#define QF_CRIT_EXIT(dummy)         (QP::QF_leaveCriticalSection())

#include "qep_port.h"                                              // QEP port
#include "qequeue.h"                               // Qt port uses event-queue
#include "qmpool.h"                                // Qt port uses memory-pool
#include "qf.h"                    // QF platform-independent public interface
#ifdef QT_GUI_LIB
    #include "guiapp.h"     // GUI QF application interface (only when needed)
    #include "guiactive.h"  // GUI active objects interface (only when needed)
#endif

namespace QP {

void QF_enterCriticalSection(void);
void QF_leaveCriticalSection(void);
void QF_setTickRate(unsigned ticksPerSec);              // set clock tick rate
void QF_onClockTick(void);        // clock tick callback (provided in the app)

#ifdef Q_SPY
void QS_onEvent(void);
#endif

}                                                              // namespace QP

//****************************************************************************
// interface used only inside QF, but not in applications

#ifdef qf_pkg_h
    // Qt-specific event queue customization
    #define QACTIVE_EQUEUE_WAIT_(me_) \
        while ((me_)->m_eQueue.m_frontEvt == static_cast<QEvt const *>(0)) \
           static_cast<QWaitCondition*>((me_)->m_osObject)->wait(&QF_qtMutex_)

    #define QACTIVE_EQUEUE_SIGNAL_(me_) \
        static_cast<QWaitCondition*>((me_)->m_osObject)->wakeOne()

    #define QACTIVE_EQUEUE_ONEMPTY_(me_) ((void)0)

    // Qt-specific event pool operations
    #define QF_EPOOL_TYPE_            QMPool
    #define QF_EPOOL_INIT_(p_, poolSto_, poolSize_, evtSize_) \
        (p_).init(poolSto_, poolSize_, evtSize_)
    #define QF_EPOOL_EVENT_SIZE_(p_)  ((p_).getBlockSize())
    #define QF_EPOOL_GET_(p_, e_, m_) \
        ((e_) = static_cast<QEvt *>((p_).get((m_))))
    #define QF_EPOOL_PUT_(p_, e_)     ((p_).put(e_))

    #include <QMutex>
    #include <QWaitCondition>

namespace QP {
    extern QMutex QF_qtMutex_;
}                                                              // namespace QP

#endif

// undefine the conflicting Q_ASSERT definition from Qt
#ifdef Q_ASSERT
    #undef Q_ASSERT
#endif

//****************************************************************************
// NOTE01:
// QF, like all real-time frameworks, needs to execute certain sections of
// code indivisibly to avoid data corruption. The most straightforward way of
// protecting such critical sections of code is disabling and enabling
// interrupts, which Win32 does not allow.
//
// This QF port uses therefore a single package-scope Qt QMutex object
// QF_qtMutex_ to protect all critical sections.
//

#endif                                                            // qf_port_h