window_dlg_statemachine.h File Reference

#include "window.h"
#include "dlg_result.h"

Go to the source code of this file.

Classes
struct	_dlg_vars
struct	_dlg_button_t
struct	_dlg_state
struct	_cl_dlg
struct	_window_dlg_statemachine_t
struct	_window_class_dlg_statemachine_t

Macros
#define	BT_ENABLED   ((uint8_t)(1 << 0))
#define	BT_AUTOEXIT   ((uint8_t)(1 << 2))
#define	DLG_BT_FLG   ((uint8_t)(1 << 0))
#define	DLG_CH_CMD   ((uint8_t)(1 << 1))
#define	DLG_DI_US0   ((uint8_t)(1 << 4))
#define	DLG_DI_US1   ((uint8_t)(1 << 5))
#define	DLG_DI_US2   ((uint8_t)(1 << 6))
#define	DLG_DI_US3   ((uint8_t)(1 << 7))

Typedefs
typedef struct _window_dlg_statemachine_t	window_dlg_statemachine_t
typedef void()	window_draw_dlg_cb_t(window_dlg_statemachine_t *window)
typedef void()	window_event_dlg_cb_t(window_dlg_statemachine_t *window, uint8_t event, void *param)
typedef int(*	dlg_state_func) (_dlg_vars *p_vars, void *p_additional_vars)
typedef void(*	dlg_cb_t) (void)
typedef loop_result_t(*	dlg_loop_cb_t) (_dlg_vars *p_vars, void *p_additional_vars)
typedef struct _window_class_dlg_statemachine_t	window_class_dlg_statemachine_t

Enumerations
enum	loop_result_t { LOOP_RESULT_CONTINUE, LOOP_RESULT_BREAK }

Functions
void	set_repaint_btn_flg (window_dlg_statemachine_t *window)
int	is_repaint_btn_flg (window_dlg_statemachine_t *window)
void	window_dlg_statemachine_draw_progress_tot (window_dlg_statemachine_t *window)
void	window_dlg_statemachine_draw_progress_part (window_dlg_statemachine_t *window)
void	window_dlg_statemachine_draw_progress_none (window_dlg_statemachine_t *window)
rect_ui16_t	_get_dlg_statemachine_button_size (window_dlg_statemachine_t *window)
dlg_result_t	_gui_dlg (const _cl_dlg *_ths, void *p_additional_vars, int32_t ttl)
void	window_dlg_statemachine_draw_0bt (window_dlg_statemachine_t *window)
void	window_dlg_statemachine_draw_1bt (window_dlg_statemachine_t *window)
void	window_dlg_statemachine_event_1bt (window_dlg_statemachine_t *window, uint8_t event, void *param)

Variables
int16_t	WINDOW_CLS_DLG_LOADUNLOAD
const window_class_dlg_statemachine_t	window_class_dlg_statemachine

Macro Definition Documentation

BT_ENABLED

#define BT_ENABLED   ((uint8_t)(1 << 0))

BT_AUTOEXIT

#define BT_AUTOEXIT   ((uint8_t)(1 << 2))

DLG_BT_FLG

#define DLG_BT_FLG   ((uint8_t)(1 << 0))

DLG_CH_CMD

#define DLG_CH_CMD   ((uint8_t)(1 << 1))

DLG_DI_US0

#define DLG_DI_US0   ((uint8_t)(1 << 4))

DLG_DI_US1

#define DLG_DI_US1   ((uint8_t)(1 << 5))

DLG_DI_US2

#define DLG_DI_US2   ((uint8_t)(1 << 6))

DLG_DI_US3

#define DLG_DI_US3   ((uint8_t)(1 << 7))

Typedef Documentation

window_dlg_statemachine_t

typedef struct _window_dlg_statemachine_t window_dlg_statemachine_t

window_draw_dlg_cb_t

typedef void() window_draw_dlg_cb_t(window_dlg_statemachine_t *window)

window_event_dlg_cb_t

typedef void() window_event_dlg_cb_t(window_dlg_statemachine_t *window, uint8_t event, void *param)

dlg_state_func

typedef int(* dlg_state_func) (_dlg_vars *p_vars, void *p_additional_vars)

dlg_cb_t

typedef void(* dlg_cb_t) (void)

dlg_loop_cb_t

typedef loop_result_t(* dlg_loop_cb_t) (_dlg_vars *p_vars, void *p_additional_vars)

window_class_dlg_statemachine_t

typedef struct _window_class_dlg_statemachine_t window_class_dlg_statemachine_t

Enumeration Type Documentation

loop_result_t

enum loop_result_t

Enumerator
LOOP_RESULT_CONTINUE
LOOP_RESULT_BREAK

             {
    LOOP_RESULT_CONTINUE,
    LOOP_RESULT_BREAK
} loop_result_t;

Function Documentation

set_repaint_btn_flg()

void set_repaint_btn_flg

(

window_dlg_statemachine_t *

window

)

                                                            {
    window->flags |= DLG_BTN_CH;
}

Here is the caller graph for this function:

is_repaint_btn_flg()

int is_repaint_btn_flg

(

window_dlg_statemachine_t *

window

)

                                                          {
    return window->flags | DLG_BTN_CH;
}

window_dlg_statemachine_draw_progress_tot()

void window_dlg_statemachine_draw_progress_tot

(

window_dlg_statemachine_t *

window

)

                                                                                  {
    if (window->flags & DLG_PRO_CH)
        progress_draw(window->win.rect, window->font_title, window->color_back,
            window->color_text, window->padding, window->vars.progress);
}

Here is the call graph for this function:

window_dlg_statemachine_draw_progress_part()

void window_dlg_statemachine_draw_progress_part

(

window_dlg_statemachine_t *

window

)

                                                                                   {
    if (window->flags & DLG_PPR_CH)
        progress_draw(window->win.rect, window->font_title, window->color_back,
            window->color_text, window->padding, window->vars.part_progress);
}

Here is the call graph for this function:

window_dlg_statemachine_draw_progress_none()

void window_dlg_statemachine_draw_progress_none

(

window_dlg_statemachine_t *

window

)

                                                                                   {
    progress_clr(window->win.rect, window->font_title, window->color_back);
}

Here is the call graph for this function:

_get_dlg_statemachine_button_size()

rect_ui16_t _get_dlg_statemachine_button_size

(

window_dlg_statemachine_t *

window

)

                                                                                 {
    rect_ui16_t rc_btn = window->win.rect;
    rc_btn.y += (rc_btn.h - 40); // 30pixels for button (+ 10 space for grey frame)
    rc_btn.h = 30;
    rc_btn.x += 6;
    rc_btn.w -= 12;
    return rc_btn;
}

Here is the caller graph for this function:

_gui_dlg()

dlg_result_t _gui_dlg	(	const _cl_dlg *	_ths,
		void *	p_additional_vars,
		int32_t	ttl
	)

                                                                                 {
    clr_logs();
 
    window_dlg_statemachine_t dlg;
    memset(&dlg, 0, sizeof(dlg));
    dlg._ths = _ths;
    int16_t id_capture = window_capture();
    int16_t id = window_create_ptr(WINDOW_CLS_DLG_LOADUNLOAD, 0, gui_defaults.msg_box_sz, &dlg);
    window_1 = (window_t *)&dlg;
    gui_reset_jogwheel();
    gui_invalidate();
    window_set_capture(id);
 
    _dlg_vars *const p_vars = &(dlg.vars);
 
    uint32_t start_tick = HAL_GetTick();
 
    //inicialization cb given in parameter
    if (_ths->on_load != NULL)
        _ths->on_load();
 
    while ((size_t)(p_vars->phase) < _ths->count) //negative number will force exit
    {
        //loop cb given in parameter
        if (_ths->on_loop != NULL) {
            if (_ths->on_loop(p_vars, p_additional_vars) == LOOP_RESULT_BREAK)
                break;
        }
 
        //time to live reached?
        if ((uint32_t)(HAL_GetTick() - start_tick) >= (uint32_t)ttl) {
            if (_ths->on_timeout != NULL)
                _ths->on_timeout();
            break;
        }
 
        //button auto exit flag must be handled here
        //state could change phase
        if (
            (p_vars->flags & DLG_BT_FLG) && //button clicked
            (_ths->p_states[p_vars->phase].p_button->flags & BT_AUTOEXIT) //autoexit flag on current button
        ) {
            break;
        }
 
        int part_progress = _ths->p_states[p_vars->phase].state_fnc(p_vars, p_additional_vars); //state machine
 
        //forced exit
        //intended to be used as handling  user clicked exit button
        //any state change phase to -1 and force exit
        if ((size_t)(p_vars->phase) >= _ths->count)
            break;
 
        p_vars->flags &= ~DLG_BT_FLG; //disable button clicked
 
        is_part_log(part_progress); //log raw value obtained from state
 
        //calculate partial progress (progress of current phase)
        if (part_progress > p_vars->part_progress)
            p_vars->part_progress = (uint8_t)part_progress; //progress can only rise
        if (part_progress > 100)
            p_vars->part_progress = 100;
        if (part_progress < 0)
            p_vars->part_progress = 0;
 
        if (p_vars->prev_part_progress != p_vars->part_progress) {
            dlg.flags |= (p_vars->prev_part_progress != p_vars->part_progress) ? DLG_PPR_CH : 0;
        }
 
        //phase changed
        if (p_vars->prev_phase != p_vars->phase) {
            p_vars->part_progress = 0;
            dlg.flags |= DLG_PHA_CH;
            gui_invalidate();
            p_vars->base_progress = 100 * _phase_time_total(p_vars->prev_phase, _ths) / p_vars->time_total;
            p_vars->prev_phase = p_vars->phase;
            p_vars->tick_part_start = HAL_GetTick();
 
            phase_changed_log(p_vars->phase, p_vars->base_progress);
        }
 
        //calculate "total" progress
        //p_vars->part_progress MUST remain unscaled
        //p_vars->base_progress is scaled
        part_progress = (int)(p_vars->part_progress) * (_ths->p_states[p_vars->phase].time) / p_vars->time_total;
        p_vars->progress = p_vars->base_progress + part_progress;
 
        //in last phase maximum progress is 100
        //in all other phases maximum progress is 99
        if ((size_t)(p_vars->phase) == _ths->count - 1) {
            if (p_vars->progress > 100)
                p_vars->progress = 100;
        } else {
            if (p_vars->progress > 99)
                p_vars->progress = 99;
        }
 
        //progress changed
        dlg.flags |= (p_vars->prev_progress != p_vars->progress) ? DLG_PRO_CH : 0;
 
        if (dlg.flags & (DLG_PRX_CH)) //any progress changed
        {
            gui_invalidate();
            progress_changed_log(p_vars->progress);
            p_vars->prev_progress = p_vars->progress;
        }
 
        print_log();
        gui_loop();
    }
    if (_ths->on_done != NULL)
        _ths->on_done();
    window_destroy(id);
    window_set_capture(id_capture);
    window_invalidate(0);
    return DLG_OK;
}

Here is the call graph for this function:

Here is the caller graph for this function:

window_dlg_statemachine_draw_0bt()

void window_dlg_statemachine_draw_0bt

(

window_dlg_statemachine_t *

window

)

                                                                         {
    rect_ui16_t rc_btn = _get_dlg_statemachine_button_size(window);
 
    display->fill_rect(rc_btn, window->color_back);
}

Here is the call graph for this function:

window_dlg_statemachine_draw_1bt()

void window_dlg_statemachine_draw_1bt

(

window_dlg_statemachine_t *

window

)

                                                                         {
    rect_ui16_t rc_btn = _get_dlg_statemachine_button_size(window);
    const char *label = window->_ths->p_states[window->vars.phase].p_button->labels[0];
    int enabled = window->_ths->p_states[window->vars.phase].p_button->flags & BT_ENABLED ? 1 : 0;
    button_draw(rc_btn, label, window->font_title, enabled);
}

Here is the call graph for this function:

window_dlg_statemachine_event_1bt()

void window_dlg_statemachine_event_1bt	(	window_dlg_statemachine_t *	window,
		uint8_t	event,
		void *	param
	)

                                {
    switch (event) {
    case WINDOW_EVENT_BTN_DN:
    //case WINDOW_EVENT_BTN_UP:
    case WINDOW_EVENT_CLICK:
        window->vars.flags |= DLG_BT_FLG;
        return;
    }
}

Variable Documentation

WINDOW_CLS_DLG_LOADUNLOAD

int16_t WINDOW_CLS_DLG_LOADUNLOAD

window_class_dlg_statemachine

const window_class_dlg_statemachine_t window_class_dlg_statemachine