/*****************************************************************************
* Product: User Interface with State-Local Storage Example
* Last Updated for Version: 4.5.00
* Date of the Last Update:  May 24, 2012
*
*                    Q u a n t u m     L e a P s
*                    ---------------------------
*                    innovating embedded systems
*
* Copyright (C) 2002-2012 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 ui_h
#define ui_h

enum UserSignals {
    QUIT_SIG = Q_USER_SIG,

    /* insert other published signals here ... */
    MAX_PUB_SIG,                               /* the last published signal */

    C_SIG,
    CE_SIG,
    DIGIT_0_SIG,
    DIGIT_1_9_SIG,
    POINT_SIG,
    NEG_SIG,
    ENTER_SIG,
    UP_SIG,
    DOWN_SIG,
    HELP_SIG,

    MAX_SIG                           /* the last signal (keep always last) */
};

typedef struct KeyboardEvtTag {
    QEvt super;                                        /* derived from QEvt */
    uint8_t key_code;                                    /* code of the key */
} KeyboardEvt;

/*..........................................................................*/
typedef struct UI_topTag {
    QActive super;                                   /* derive from QActive */
    QStateHandler history;
    char const * const *help_text;
    uint16_t help_len;
} UI_top;

void   UI_top_ctor(UI_top *me);
QState UI_top_initial(UI_top *me, QEvt const *e);    /* initial pseudostate */
QState UI_top_handler(UI_top *me, QEvt const *e);          /* state handler */
QState UI_top_final  (UI_top *me, QEvt const *e);          /* state handler */

typedef struct UI_memTag {
    UI_top super;                                     /* derive from UI_top */
    uint8_t mem[100];  /* maximum size of any substate (subclass) of UI_top */
} UI_mem;

/*..........................................................................*/
typedef struct UI_numTag {
    UI_top super;                                     /* derive from UI_top */
    NumEntry num_entry;
} UI_num;

QState UI_num_handler(UI_num *me, QEvt const *e);
Q_ASSERT_COMPILE(sizeof(UI_num) < sizeof(UI_mem));

/*..........................................................................*/
typedef struct UI_num_sdTag {                         /* standard deviation */
    UI_num super;                                     /* derive from UI_num */
    double n;
    double sum;
    double sum_sq;
} UI_num_sd;

QState UI_num_sd_handler(UI_num_sd *me, QEvt const *e);
Q_ASSERT_COMPILE(sizeof(UI_num_sd) < sizeof(UI_mem));

/*..........................................................................*/
typedef struct UI_num_lrTag {                          /* linear regression */
    UI_num super;                                     /* derive from UI_num */
    double x;
    double n;
    double xsum;
    double xsum_sq;
    double ysum;
    double ysum_sq;
    double xysum;
} UI_num_lr;

QState UI_num_lr_handler(UI_num_lr *me, QEvt const *e);
Q_ASSERT_COMPILE(sizeof(UI_num_lr) < sizeof(UI_mem));

/*..........................................................................*/
typedef struct UI_helpTag {
    UI_top super;                                     /* derive from UI_top */
    uint16_t help_line;
} UI_help;

QState UI_help_handler(UI_help *me, QEvt const *e);
Q_ASSERT_COMPILE(sizeof(UI_help) < sizeof(UI_mem));

/*--------------------------------------------------------------------------*/
extern QActive * const AO_UI;       /* "opaque" pointer to UI Active Object */

void UI_ctor(void);                 /* global ctor for the UI active object */

#endif