/*****************************************************************************
* Product: "Deferred Event" state pattern example
* Last Updated for Version: 6.3.7
* Date of the Last Update:  2018-12-13
*
*                    Q u a n t u m  L e a P s
*                    ------------------------
*                    Modern Embedded Software
*
* Copyright (C) 2005-2018 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 <www.gnu.org/licenses/>.
*
* Contact information:
* <www.state-machine.com/licensing>
* <info@state-machine.com>
*****************************************************************************/
#include "qpn.h"     /* QP-nano API */
#include "bsp.h"     /* Board Support Package */
#include "defer.h"   /* Application interface */

#include "safe_std.h" /* portable "safe" <stdio.h>/<string.h> facilities */

/*..........................................................................*/
typedef struct TServerTag { /* Transaction Server active object */
    QActive super;          /* inherit QActive */

    QEvt deferredRequest;   /* deferred request event */
    /* optionally other storage for deferring other event types... */
} TServer;

/* hierarchical state machine ... */
static QState TServer_initial    (TServer * const me);
static QState TServer_operational(TServer * const me);
static QState TServer_idle       (TServer * const me);
static QState TServer_receiving  (TServer * const me);
static QState TServer_authorizing(TServer * const me);
static QState TServer_final      (TServer * const me);

/* helper functions */
void TServer_deferRequest(TServer * const me);
void TServer_recallRequest(TServer * const me);

/* Global objects ----------------------------------------------------------*/
TServer AO_TServer; /* the single instance of the TServer active object */

/*..........................................................................*/
void TServer_ctor(void) {
    QActive_ctor((QActive *)&AO_TServer, Q_STATE_CAST(&TServer_initial));
}
/* HSM definition ----------------------------------------------------------*/
QState TServer_initial(TServer * const me) {
    me->deferredRequest.sig = 0U; /* no deferred requests */
    return Q_TRAN(&TServer_operational);
}
/*..........................................................................*/
QState TServer_final(TServer * const me) {
    QState status;
    switch (Q_SIG(me)) {
        case Q_ENTRY_SIG: {
            QF_stop(); /* terminate the application */
            status = Q_HANDLED();
            break;
        }
        default: {
            status = Q_SUPER(&QHsm_top);
            break;
        }
    }
    return status;
}
/*..........................................................................*/
QState TServer_operational(TServer * const me) {
    QState status;
    switch (Q_SIG(me)) {
        case Q_INIT_SIG: {
            status = Q_TRAN(&TServer_idle);
            break;
        }
        case NEW_REQUEST_SIG: {
            TServer_deferRequest(me); /* defer the request */
            status = Q_HANDLED();
            break;
        }
        case TERMINATE_SIG: {
            status = Q_TRAN(&TServer_final);
            break;
        }
        default: {
            status = Q_SUPER(&QHsm_top);
            break;
        }
    }
    return status;
}
/*..........................................................................*/
QState TServer_idle(TServer * const me) {
    QState status;
    switch (Q_SIG(me)) {
        case Q_ENTRY_SIG: {
            PRINTF_S("%s\n", "-> idle");
            TServer_recallRequest(me); /* recall the request */
            status = Q_HANDLED();
            break;
        }
        case NEW_REQUEST_SIG: {
            PRINTF_S("Processing request #%d\n", (int)Q_PAR(me));
            status = Q_TRAN(&TServer_receiving);
            break;
        }
        default: {
            status = Q_SUPER(&TServer_operational);
            break;
        }
    }
    return status;
}
/*..........................................................................*/
QState TServer_receiving(TServer * const me) {
    QState status;
    switch (Q_SIG(me)) {
        case Q_ENTRY_SIG: {
            PRINTF_S("%s\n", "-> receiving");

            /* one-shot timeout in 1 second */
            QActive_armX(&me->super, 0U, BSP_TICKS_PER_SEC, 0U);
            status = Q_HANDLED();
            break;
        }
        case Q_TIMEOUT_SIG: {
            status = Q_TRAN(&TServer_authorizing);
            break;
        }
        default: {
            status = Q_SUPER(&TServer_operational);
            break;
        }
    }
    return status;
}
/*..........................................................................*/
QState TServer_authorizing(TServer * const me) {
    QState status;
    switch (Q_SIG(me)) {
        case Q_ENTRY_SIG: {
            PRINTF_S("%s\n", "-> authorizing");
            /* one-shot timeout in 2 seconds */
            QActive_armX(&me->super, 0U, 2U*BSP_TICKS_PER_SEC, 0U);
            status = Q_HANDLED();
            break;
        }
        case Q_TIMEOUT_SIG: {
            status = Q_TRAN(&TServer_idle);
            break;
        }
        default: {
            status = Q_SUPER(&TServer_operational);
            break;
        }
    }
    return status;
}

/* helper functions ........................................................*/
void TServer_deferRequest(TServer * const me) {
    if (me->deferredRequest.sig == 0U) { /* the request NOT deferred yet? */
        me->deferredRequest.sig = Q_SIG(me);
        me->deferredRequest.par = Q_PAR(me);
        PRINTF_S("deferring request #%d\n", (int)me->deferredRequest.par);
    }
    else {
        PRINTF_S("!!! cannot defer request #%d\n", (int)Q_PAR(me));
    }
}
void TServer_recallRequest(TServer * const me) {
    if (me->deferredRequest.sig != 0U) { /* the request already deferred? */
        PRINTF_S("recalling request #%d\n", (int)me->deferredRequest.par);
        QACTIVE_POST(&me->super,
                     me->deferredRequest.sig, me->deferredRequest.par);

        me->deferredRequest.sig = 0U; /* request no longer deferred */
    }
    else {
        PRINTF_S("%s\n", "No requests to recall");
    }
}