ereader_ui_steps.h

Go to the documentation of this file.

 
#pragma once
 
#include <stddef.h>
#include <stdint.h>
 
#include "er_pageturn.h"
#include "ra8_app.h"
#include "ra8_batt.h"
#include "ra8_board_ek_ra8d2.h"
#include "ra8_box.h"
#include "ra8_display_pal.h"
#include "ra8_display_pal_policy.h"
#include "ra8_keyboard.h"
#include "ra8_panel.h"
#include "ra8_panel_timing.h"
#include "ra8_port_constants.h"
#include "ra8_ui.h"
#include "ra8_widget.h"
#include "reflow.h"
 
/* ===========================================================================
 * Compile-time configuration -- typed enums per the no-magic-number rule.
 * =========================================================================== */

typedef enum : uint16_t {
  k_er_fb_w = k_panel_width_px,  
  k_er_fb_h = k_panel_height_px, 
} er_fb_dim_t;

typedef enum : uint16_t {
  k_er_settle_ms = 500U, 
  k_er_frame_ms  = 25U,  
  k_er_led_every = 16U,  
} er_fb_misc_t;

typedef enum : uint32_t {
  k_er_paper     = 0xFFFFFFU, 
  k_er_ink       = 0x000000U, 
  k_er_ink_muted = 0x555555U, 
  k_er_rule      = 0xAAAAAAU, 
  k_er_rule_soft = 0xCCCCCCU, 
  k_er_fill      = 0xDDDDDDU, 
  k_er_fill_deep = 0x888888U, 
} er_color_t;

typedef enum : uint16_t {
  k_er_statusbar_h  = 64U,  
  k_er_footer_h     = 56U,  
  k_er_nav_h        = 88U,  
  k_er_toolbar_h    = 72U,  
  k_er_margin_x     = 64U,  
  k_er_pad_ui       = 32U,  
  k_er_body_gap     = 24U,  
  k_er_line_h       = 26U,  
  k_er_glyph_w      = 8U,   
  k_er_glyph_h      = 16U,  
  k_er_text_inset_y = 24U,  
  k_er_text_pad     = 6U,   
  k_er_hair         = 1U,   
  k_er_border_w     = 2U,   
  k_er_progress_h   = 6U,   
  k_er_progress_gap = 12U,  
  k_er_blank_lines  = 2U,   
  k_er_grid_cols    = 2U,   
  k_er_grid_gap     = 28U,  
  k_er_tile_gap     = 8U,   
  k_er_card_label_h = 20U,  
  k_er_card_bar_h   = 8U,   
  k_er_count_w      = 200U, 
} er_layout_t;

typedef enum : uint16_t {
  k_er_page_current = 12U,  
  k_er_page_total   = 248U, 
  k_er_pct_full     = 100U, 
} er_progress_t;

typedef enum : uint16_t {
  k_er_max_nodes = 64U, 
} er_node_cap_t;

typedef enum : uint16_t {
  k_er_screen_library  = 1U, 
  k_er_screen_reading  = 2U, 
  k_er_screen_keyboard = 3U, 
  k_er_screen_settings = 4U, 
} er_screen_t;

typedef enum : uint16_t {
  k_er_act_none      = 0U,   
  k_er_act_open_book = 1U,   
  k_er_act_nav       = 2U,   
  k_er_act_search    = 3U,   
  k_er_act_settings  = 4U,   
  k_er_act_key_base  = 100U, 
} er_action_t;

typedef enum : uint8_t {
  k_er_touch_channel    = (uint8_t)k_ra8_board_touch_i3c_channel, 
  k_er_touch_max_points = 1U,                                     
} er_touch_cfg_t;

typedef enum : uint8_t {
  k_er_fg_addr      = 0x36U, 
  k_er_fg_reg_soc   = 0x04U, 
  k_er_fg_reg_crate = 0x16U, 
  k_er_fg_sign      = 0x80U, 
} er_fg_cfg_t;

typedef enum : int32_t {
  k_er_nag_h        = 72, 
  k_er_nag_margin   = 24, 
  k_er_nag_top      = 96, 
  k_er_nag_text_dx  = 28, 
  k_er_nag_text_dy  = 28, 
  k_er_nag_dec_max  = 4,  
  k_er_nag_dec_ten  = 10, 
  k_er_nag_line_max = 48, 
  k_er_batt_every   = 40, 
} er_nag_cfg_t;

typedef enum : uint32_t {
  k_er_nag_low_bg  = 0x555555U, 
  k_er_nag_crit_bg = 0x000000U, 
  k_er_nag_text    = 0xFFFFFFU, 
} er_nag_color_t;

typedef enum : uint16_t {
  k_er_max_targets   = 32U,  
  k_er_back_w        = 240U, 
  k_er_page_back_cap = 16U,  
} er_hit_cap_t;

typedef struct {
  const char* title;  
  const char* author; 
  uint16_t    pct;    
} er_book_t;

typedef struct {
  const char* xhtml;    
  uint32_t    len;      
  const char* href;     
  uint32_t    href_len; 
} er_chapter_t;

typedef struct {
  uint32_t chapter; 
  uint32_t page;    
} er_loc_t;

typedef enum : uint32_t {
  k_er_font_cap    = 512U * 1024U,       
  k_er_font_min    = 16U,                
  k_er_reflow_px   = 22U,                
  k_er_spi_chan    = 0U,                 
  k_er_reflow_ink  = 0xFF101010U,        
  k_er_reflow_link = 0xFF2A52BEU,        
  k_er_img_arena   = 2U * 1024U * 1024U, 
 
  /* Layer-3 glyph atlas (#164): cache rasterised body glyphs in SDRAM so page
   * turns reuse them instead of re-running stb_truetype every frame. */
  k_er_glyph_cell_px    = 64U,                                     
  k_er_glyph_cell_bytes = k_er_glyph_cell_px * k_er_glyph_cell_px, 
  k_er_glyph_cells      = 256U,                                    
  k_er_glyph_buckets    = 512U,                                    
} er_reflow_cfg_t;

typedef enum : uint32_t {
  k_er_chapter_none = 0xFFFFFFFFU, 
} er_reflow_sentinel_t;
 
/* ===========================================================================
 * Shared read-only content tables (defined in main.c -- single site).
 * =========================================================================== */

extern const char k_er_wordmark[6];
extern const char k_er_lib_heading[];  
extern const char k_er_status_right[]; 
extern const char k_er_search_hint[];  
extern const char k_er_count_text[];   
extern const char k_er_book_title[];   
extern const char k_er_page_label[];   
extern const char k_er_chapter[];      

extern const char* const k_er_nav_items[];
typedef enum : uint16_t {
  k_er_nav_count       = 4U, 
  k_er_nav_idx_setting = 3U, 
} er_nav_count_t;

extern const er_book_t k_er_books[];
typedef enum : uint16_t {
  k_er_book_count = 6U, 
} er_book_count_t;

extern const char* const k_er_body_lines[];
typedef enum : uint16_t {
  k_er_body_line_count = 10U, 
} er_body_count_t;

extern const er_chapter_t k_er_spine[];
typedef enum : uint16_t {
  k_er_spine_count = 2U, 
} er_spine_count_t;
 
/* ===========================================================================
 * Shared mutable file-scope state (defined in main.c -- single site).
 * =========================================================================== */
 
extern display_fb_t         s_fb;              
extern ra8_ui_target_t      s_targets[];       
extern uint16_t             s_target_count;    
extern ra8_kbd_layout_t     s_kb;              
extern ra8_kbd_text_t       s_query;           
extern uint32_t             s_chapter_idx;     
extern uint32_t             s_reading_page;    
extern uint32_t             s_reading_pages;   
extern reflow_t             s_reflow_engine;   
extern bool                 s_reflow_open;     
extern uint32_t             s_reflow_chapter;  
extern int32_t              s_reflow_w;        
extern int32_t              s_reflow_h;        
extern uint8_t              s_font_buf[];      
extern uint32_t             s_font_len;        
extern bool                 s_have_font;       
extern uint8_t              s_img_arena_buf[]; 
extern er_loc_t             s_loc_back[];      
extern uint32_t             s_loc_back_count;  
extern ra8_ui_nav_t         s_nav;             
extern ra8_batt_nag_t       s_batt_nag;        
extern uint8_t              s_batt_soc;        
extern ra8_batt_monitor_t   s_batt_mon;        
extern bool                 s_nag_region_only; 
extern display_turn_event_t s_pending_event;   

extern volatile uint32_t g_er_cur_page;  
extern volatile uint32_t g_er_turns;     
extern volatile uint32_t g_er_last_hint; 
 
/* ===========================================================================
 * Text helpers (ereader_ui_screens.c) -- shared by every band renderer.
 * =========================================================================== */

void er_text_left(int32_t x, int32_t y, const char* str, uint32_t color);

void er_text_right(int32_t right, int32_t y, const char* str, uint32_t color);
 
/* ===========================================================================
 * Screen rendering + in-content navigation (ereader_ui_screens.c).
 * =========================================================================== */

void er_render_library(void);

void er_render_reading(void);

bool er_apply_pageturn(er_dir_t dir);

bool er_reading_link_tap(int32_t x, int32_t y);

void er_push_loc(void);

uint32_t er_spine_count(void);
 
/* ===========================================================================
 * Keyboard rendering (ereader_ui_input.c).
 * =========================================================================== */

void er_render_keyboard(void);
 
/* ===========================================================================
 * Battery nag + input polling (ereader_ui_input.c).
 * =========================================================================== */

void er_nag_render(ra8_widget_t* w);

void er_poll_touch(void);

void er_poll_buttons(void);

void er_poll_battery(void);
 
/* ===========================================================================
 * Screen dispatch + panel flush (main.c) -- called from the input helpers.
 * =========================================================================== */

void er_render_current(void);

void er_render_nag_region(void);

void er_flush_event(display_turn_event_t event);