qequeue.h

Go to the documentation of this file.

// Product: QP/C++
// Last Updated for Version: 4.5.04
// Date of the Last Update:  Jan 16, 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 qequeue_h
#define qequeue_h


#ifndef QF_EQUEUE_CTR_SIZE

    #define QF_EQUEUE_CTR_SIZE 1
#endif

QP_BEGIN_

#if (QF_EQUEUE_CTR_SIZE == 1)





    typedef uint8_t QEQueueCtr;
#elif (QF_EQUEUE_CTR_SIZE == 2)
    typedef uint16_t QEQueueCtr;
#elif (QF_EQUEUE_CTR_SIZE == 4)
    typedef uint32_t QEQueueCtr;
#else
    #error "QF_EQUEUE_CTR_SIZE defined incorrectly, expected 1, 2, or 4"
#endif


class QEQueue {
private:

    QEvt const *m_frontEvt;

    QEvt const **m_ring;

    QEQueueCtr m_end;

    QEQueueCtr m_head;

    QEQueueCtr m_tail;

    QEQueueCtr m_nFree;

    QEQueueCtr m_nMin;

public:

    void init(QEvt const *qSto[], QEQueueCtr const qLen);

    void postFIFO(QEvt const * const e);

    void postLIFO(QEvt const * const e);

    QEvt const *get(void);

    QEQueueCtr getNFree(void) const {
        return m_nFree;
    }

    bool isEmpty(void) const {
        return m_frontEvt == static_cast<QEvt const *>(0);
    }

private:
    friend class QF;
    friend class QActive;
};

QP_END_

#endif                                                            // qequeue_h