log_viewer_int.h

Go to the documentation of this file.

#pragma once
 
#include <stdbool.h>
#include <stdint.h>
 
#include "card_state.h"
#include "gfx.h"
#include "log_text.h"
#include "log_viewer_screen.h"
#include "touch_types.h"
#include "ui_screen.h"
#include "ui_tabs.h"
#include "ui_text.h"
#include "ui_theme.h"

#define SCREEN_W UI_PANEL_W
/* The router owns the band and hands this screen a sub-canvas of what is
 * left, so the screen's own height is the body rather than the panel. */
#define SCREEN_H UI_BODY_H
#define MAX_FBS  3
 
/* ------------------------------------------------------------- browse ---- */

#define LV_FONT_LABEL (&gfx_font_10x20)
#define LV_FONT_BODY  UI_FONT_BODY   
#define LV_FONT_FINE  UI_FONT_FINE   

#define LV_L  UI_MARGIN
#define LV_R  (SCREEN_W - UI_MARGIN)  
#define LV_W  (LV_R - LV_L)           

#define FOOT_H    52
#define FOOT_Y    (SCREEN_H - UI_ALERT_H - 4 - FOOT_H)
#define FOOT_GAP  8   

#define BR_PG_Y     4
#define BR_PG_H     UI_TAP_MIN                
#define BR_PG_W     140                       
#define BR_TAB_W    110                       
#define BR_TAB_H    40                        
#define BR_TABS     gfx_rect_make(LV_L + 3, BR_PG_Y + 4, \
                                  3 * BR_TAB_W + 2 * 4, BR_TAB_H)
#define BR_HEAD_X   368                       
#define BR_HEAD_TY  (BR_PG_Y + (BR_PG_H - 20) / 2)  
#define BR_PREV     gfx_rect_make(LV_R - 2 * BR_PG_W - 8, BR_PG_Y, BR_PG_W, \
                                  BR_PG_H)  

#define BR_NEXT     gfx_rect_make(LV_R - BR_PG_W, BR_PG_Y, BR_PG_W, BR_PG_H)
#define BR_HEAD_END (LV_R - 2 * BR_PG_W - 8 - 8)  
#define BR_HEAD_FAR LV_R                      

#define BR_LIST_Y 60
#define BR_LIST   gfx_rect_make(LV_L, BR_LIST_Y, LV_W, \
                                FOOT_Y - FOOT_GAP - BR_LIST_Y)
#define BR_ROW_H  48  
#define BR_ROWS   7        

#define BR_BAR_W  56
#define BR_BAR    gfx_rect_make(LV_R - 8 - BR_BAR_W, BR_LIST_Y + 30, \
                                BR_BAR_W, BR_ROWS * BR_ROW_H - 4)
#define BR_ROW_X  (LV_L + 8)                          
#define BR_ROW_W  (LV_R - 8 - BR_BAR_W - 8 - BR_ROW_X) 
#define BR_SIZE_W  100
#define BR_DATE_W  160                                    
#define BR_NAME_IN 16                                     
#define BR_SIZE_IN (BR_ROW_W - 16 - BR_SIZE_W)            
#define BR_DATE_IN (BR_SIZE_IN - 16 - BR_DATE_W)          

#define BR_RESCAN gfx_rect_make(LV_L, FOOT_Y, BR_PG_W, FOOT_H)
#define BR_SMALL_W 100  
#define BR_WIFI   gfx_rect_make(LV_L + BR_PG_W + 8, FOOT_Y, BR_SMALL_W, FOOT_H)
#define BR_FILES  gfx_rect_make(LV_L + BR_PG_W + 8 + BR_SMALL_W + 8, FOOT_Y, \
                                BR_SMALL_W, FOOT_H)

#define BR_OPEN   gfx_rect_make(LV_R - BR_PG_W, FOOT_Y, BR_PG_W, FOOT_H)
#define BR_DELETE gfx_rect_make(LV_R - 2 * BR_PG_W - 8, FOOT_Y, BR_PG_W, \
                                FOOT_H)  

#define BR_MSG_X  (LV_L + BR_PG_W + 8 + 2 * (BR_SMALL_W + 8) + 8)
#define BR_MSG_LH 24  

#define BR_EMPTY  gfx_rect_make(104, 150, 816, 160)

#define TX_ROW_H  22  
#define TX_ROWS   15  
#define TX_COLS   92  
#define TX_ROW_X  (BR_ROW_X + 8)  
#define TX_BACK   gfx_rect_make(LV_L, FOOT_Y, 140, FOOT_H)
#define BR_BAR_MIN 32  

#define DQ_BOX    gfx_rect_make(162, 100, 700, 280)
#define DQ_CANCEL gfx_rect_make(186, 304, 300, 56)  
#define DQ_DELETE gfx_rect_make(538, 304, 300, 56)  
 
/* ------------------------------------------------------------- import ---- */

#define IM_TOP    44
#define IM_LEFT   gfx_rect_make(LV_L, IM_TOP, 400, FOOT_Y - FOOT_GAP - IM_TOP)
#define IM_RIGHT  gfx_rect_make(LV_L + 408, IM_TOP, LV_W - 408, \
                                FOOT_Y - FOOT_GAP - IM_TOP)
#define IM_ROW_H  48  
#define IM_ROWS   7        
#define IM_KEY_LH 24       
#define IM_WARN_LH 22      
#define IM_BTN_Y  FOOT_Y  
#define IM_BTN_H  FOOT_H  
#define IM_BTN_W  ((LV_W - 3 * 8) / 4)   
#define IM_BTN(i) gfx_rect_make(LV_L + (i) * (IM_BTN_W + 8), IM_BTN_Y, \
                                IM_BTN_W, IM_BTN_H)

#define IM_FAIL   gfx_rect_make(44, 150, 936, 160)
 
/* --------------------------------------------------------------- plot ---- */

#define PV_SUM_Y   4  
#define CHIP_Y     28  
#define CHIP_H     44  
#define CHIP_X     LV_L  
#define CHIP_W     240  
#define CHIP_GAP   16  
#define PV_TOP     (CHIP_Y + CHIP_H + 8)  
#define PV_PANEL_H (FOOT_Y - FOOT_GAP - 16 - 4 - PV_TOP)  
#define PV_PANEL   gfx_rect_make(LV_L, PV_TOP, LV_W, PV_PANEL_H)
#define PV_X       (LV_L + 8)  
#define PV_Y       (PV_TOP + 8)  
#define PV_W       (LV_W - 16)  
#define PV_H       (PV_PANEL_H - 16)  
#define PV_BAND    10  
#define PV_DIV_X   6  
#define PV_DIV_Y   4  
#define PV_POS_Y   (PV_Y + PV_H + 2)
#define PV_POS_H   4  
#define PV_MIN_WIN 8
#define PV_PAN_SLOP 10
#define PV_EMPTY   (-1)
#define PV_BACK    gfx_rect_make(LV_L, FOOT_Y, 140, FOOT_H)
#define PV_PREV    gfx_rect_make(LV_L + 148, FOOT_Y, 96, FOOT_H)  
#define PV_NEXT    gfx_rect_make(LV_L + 252, FOOT_Y, 96, FOOT_H)  
#define PV_LINE_X  (LV_L + 364)  
#define PV_NONE    gfx_rect_make(104, 150, 816, 120)
 
_Static_assert(FOOT_Y + FOOT_H + 4 <= SCREEN_H - UI_ALERT_H,
               "the footer ends 4px above the alert band");
_Static_assert(FOOT_H >= UI_TAP_MIN, "the footer's buttons are a finger tall");
_Static_assert(BR_ROW_H >= UI_TAP_MIN, "a file row is a finger tall");
_Static_assert(IM_ROW_H >= UI_TAP_MIN, "a column row is a finger tall");
_Static_assert(30 + BR_ROWS * BR_ROW_H <= FOOT_Y - FOOT_GAP - BR_LIST_Y,
               "the file list's rows fit its panel");
_Static_assert(BR_PG_Y + BR_PG_H + 8 <= BR_LIST_Y,
               "PREV and NEXT end 8px above the list");
_Static_assert(LV_L + 3 + 3 * BR_TAB_W + 2 * 4 + 3 + 16 <= BR_HEAD_X,
               "the tabs end before the header's text");
_Static_assert(BR_HEAD_X + (11 + 17) * 10 + 16 <= BR_HEAD_END,
               "the header's text ends at PREV");
_Static_assert(BR_MSG_X + 28 * 12 + 8 <= LV_R - 2 * BR_PG_W - 8,
               "a footer message's 28 cells stand between FILES and DELETE");
_Static_assert(BR_SMALL_W >= 7 * 10 + 2 * 8,
               "WI-FI and FILES hold DATEIEN's 7 cells of 10 x 20");
_Static_assert(BR_SIZE_W >= 10 * 10,
               "a row's size box holds LOG_DIR's 10 cells");
_Static_assert(BR_DATE_W >= 16 * 10, "a row's date box holds 16 cells");
_Static_assert(BR_NAME_IN + LOG_VIEWER_NAME_CELLS * 10 + 16 <= BR_DATE_IN,
               "a row's name ends 16px before its date");
_Static_assert(LOG_VIEWER_NAME_CELLS < LOG_VIEWER_NAME_MAX,
               "a name of LOG_VIEWER_NAME_CELLS fits its array");
_Static_assert((BR_ROWS * BR_ROW_H - 4) * BR_ROWS / LOG_VIEWER_MAX_FILES >= 32,
               "the scroll bar's thumb is 32px or more on a full page");
_Static_assert(TX_ROWS * TX_ROW_H <= BR_ROWS * BR_ROW_H - 4,
               "the text's rows fit beside the scroll bar");
_Static_assert(TX_COLS * 10 <= BR_ROW_W - 8,
               "a text row fits the browse row's box");
_Static_assert(30 + IM_ROWS * IM_ROW_H <= FOOT_Y - FOOT_GAP - IM_TOP,
               "the column list's rows fit its panel");
_Static_assert(PV_POS_Y + PV_POS_H <= PV_TOP + PV_PANEL_H,
               "the position bar is inside the plot's panel");
_Static_assert(CHIP_X + 4 * CHIP_W + 3 * CHIP_GAP <= LV_R,
               "the four chips stand in the screen's width");

typedef enum { VIEW_BROWSE = 0, VIEW_IMPORT, VIEW_PLOT, VIEW_TEXT } view_t;

#define LV_MSG_MAX 160

typedef enum {
    LV_MSG_NONE = 0,      
    LV_MSG_TEXT,          
    LV_MSG_ERR            
} lv_msg_kind_t;

typedef struct {
    view_t view;                        
    log_viewer_io_t io;                 
 
    /* The folder the browse view lists, and its three tabs. */
    log_viewer_tab_t tab;               
    ui_tabs_t tabs;                     
    /* The tab of the file s.name names: the plot and the import read it
     * again from there whatever the tabs show since. */
    log_viewer_tab_t open_tab;          
    /* The logger's count of files created, as this screen last saw it. */
    unsigned written_seen;              
 
    log_viewer_file_t files[LOG_VIEWER_MAX_FILES];  
    int n_files;                        
    int n_card;                         
    int first;                          
    int listed;                         
    card_state_t card;                  
    int sel;                            
    int scroll;                         
    /* The card's name when the page was read: another name on RESCAN is
     * another card, and it opens on its first page. */
    char volume[LOG_VIEWER_NAME_MAX];   
    unsigned mounts;                    
    unsigned open_mounts;               
 
    /* A finger on the scroll bar: the thumb follows it, held where it took
     * the thumb, grab px below the thumb's top. */
    bool bar_drag;                      
    int bar_grab;                       
 
    char name[LOG_VIEWER_NAME_MAX];     
    /* The footer message, kept as its text's ID and name, not as words,
     * so lv_message() words it in the language showing when it is drawn. */
    lv_msg_kind_t msg_kind;           
    ui_text_id_t msg_id;              
    log_err_t msg_err;                
    char msg_name[LOG_VIEWER_NAME_MAX]; 
    bool message_ok;
 
    /*
     * The file DELETE asked about, or "" while no question is open.  A copy
     * of the name rather than an index into the list: the question has to
     * delete the file it named, whatever happens to the list behind it.
     */
    char doomed[LOG_VIEWER_NAME_MAX];
    uint64_t doomed_size;               
    /* The one contact whose press on the question counts: the panel reports
     * up to five, and a second finger lifting off DELETE did not press it. */
    bool q_down;
    uint8_t q_id;                       
 
    log_analysis_t an;                  
    bool have_analysis;                 
    int delim_index;                    
    log_conv_t conv;                    
    int picked[LOG_MAX_SERIES];         
    int n_picked;                       
    int col_scroll;                     
 
    log_data_t data;                    
    bool have_data;                     
    int cursor;                         
 
    log_text_t text;      
    int text_scroll;      
 
    /*
     * The samples the plot shows: [win0, win0 + win_n).  The whole file
     * until two fingers zoom in, and it stays where they leave it.
     */
    int win0;                           
    int win_n;                          
 
    /*
     * Two fingers on the plot: spreading or pinching zooms, moving both
     * together pans.  The sample under the fingers' midpoint at the start
     * stays under the midpoint as they move.
     */
    bool pinch;                         
    uint8_t pinch_id[2];                
    int16_t pinch_x[2];                 
    float pinch_d0;                     
    float pinch_s0;                     
    float pinch_n0;                     
 
    /*
     * One finger panning a zoomed view (SET_PLOT_PAN).  Until the finger has
     * moved PV_PAN_SLOP px it is a tap: the cursor follows it.  Past that it
     * pans, the cursor goes back to where it was before the touch, and the
     * sample under the finger stays under it.
     */
    bool panning;                       
    int16_t pan_x0;                     
    int pan_win0;                       
    int pan_cursor0;                    
 
    /* press tracking, shared by the list views */
    bool pressing;                      
    int press_row;                      
    int press_y0;                       
    int press_scroll0;                  
    bool dragged;                       
    int press_btn;                      
    uint8_t press_id;                   
    int16_t press_x;                    
 
    /* The contact that holds a press on a button or a row, where it came
     * down, and whether it has been further than the slop from there: its
     * release is asked whether it is a tap (tap_on()). */
    bool tap_have;                      
    bool tap_moved;                     
    uint8_t tap_id;                     
    int16_t tap_x0,                         
            tap_y0;                         
 
    bool valid[MAX_FBS];                
} lv_state_t;
 
/* Defined in log_viewer_screen.c. */
extern lv_state_t lv_s;
#define s lv_s
 
/* --- log_viewer_screen.c: the series' colours, the plot's traces, the
 *     tabs, the card's listing and paging -------------------------------- */

extern const ui_color_id_t lv_series_color[LOG_MAX_SERIES];
/* Filled by lv_compute_spans() (log_viewer_load.c). */
extern int16_t lv_span[LOG_MAX_SERIES][PV_W][2];
extern gfx_color_t lv_band[PV_W * PV_BAND];
extern float lv_lo[LOG_MAX_SERIES];
extern float lv_hi[LOG_MAX_SERIES];
extern const log_viewer_tab_t lv_tab_at[LOG_TAB_COUNT];

void lv_point(log_viewer_tab_t tab);
const char *lv_volume_now(void);
unsigned lv_mounts_now(void);
const char *lv_page_edge(int sign);
void lv_read_page(log_page_dir_t dir, const char *key);
void lv_rescan(void);
bool lv_paged(void);
bool lv_can_prev(void);
bool lv_can_next(void);
void lv_drop_data(void);
bool lv_can_delete(void);
void lv_bar_thumb(int *y, int *h);
int lv_bar_scroll_at(int top);

void lv_bar_thumb_of(int total, int visible, int scroll, int *y, int *h);

int lv_bar_scroll_of(int total, int visible, int top);

int lv_text_total(void);

void lv_close_text(void);
 
/* --- log_viewer_load.c -------------------------------------------------- */

void lv_say(ui_text_id_t id, const char *name);

void lv_say_err(log_err_t err);

void lv_quiet(void);

const char *lv_message(char *buf, size_t n);
const char *lv_delim_text(char delimiter);
void lv_run_analysis(void);
void lv_compute_spans(void);
void lv_load_data(void);
void lv_open_selected(void);
 
/* --- log_viewer_draw.c -------------------------------------------------- */

void lv_render(gfx_canvas_t *c, int buffer_index);
 
/* --- log_viewer_events.c ------------------------------------------------ */

void lv_event(const touch_event_t *e);