common.h

Go to the documentation of this file.

/*
 * Copyright 2024 dogtopus
 * SPDX-License-Identifier: MIT
 */
 
#ifndef __MUTEKI_UI_COMMON_H__
#define __MUTEKI_UI_COMMON_H__
 
#include <muteki/common.h>
#include <muteki/threading.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum print_flag_e {
    PRINT_NONE = 0,
    PRINT_INVERT = 0x1,
    PRINT_INVERT_ALT = 0x4,
    PRINT_UNDERSCORE_ONLY = 0x40,
};
 
enum print_str_flag_e {
    PRINT_STR_ENCODING_BIG5 = 0x100,
    PRINT_STR_ENCODING_GB18030 = 0x200,
    PRINT_STR_ENCODING_TIS_620 = 0x400,
};
 
enum str_align_e {
    STR_ALIGN_LEFT = 0,
    STR_ALIGN_RIGHT,
    STR_ALIGN_CENTER,
};
 
enum blit_flag_e {
    BLIT_NONE = 0,
    BLIT_AND = 0x2,
    BLIT_OR = 0x3,
    BLIT_XOR = 0x4,
    BLIT_TRANSPARENT = 0xe,
    BLIT_ALPHA_BLENDING = 0xf,
    BLIT_ALPHA_BLENDING_FAST = 0x10,
};
 
enum lcd_surface_pixfmt_e {
    LCD_SURFACE_PIXFMT_L1 = 1,
    LCD_SURFACE_PIXFMT_L4 = 4,
    LCD_SURFACE_PIXFMT_L8 = 8,
    LCD_SURFACE_PIXFMT_RGB444 = 12,
    LCD_SURFACE_PIXFMT_RGB565 = 16,
    LCD_SURFACE_PIXFMT_RGB = 24,
    LCD_SURFACE_PIXFMT_XRGB = 32,
    LCD_SURFACE_PIXFMT_ARGB = 32,
};
 
enum lcd_surface_encoding_e {
    LCD_SURFACE_ENCODING_HCA = 1,
    LCD_SURFACE_ENCODING_RAW = 2,
};
 
enum rotation_value_e {
    ROTATION_TOP_SIDE_FACING_UP = 0,
    ROTATION_TOP_SIDE_FACING_LEFT,
    ROTATION_TOP_SIDE_FACING_DOWN,
    ROTATION_TOP_SIDE_FACING_RIGHT,
    ROTATION_QUERY = 0xfe,
    ROTATION_APPLY = 0xff,
};
 
enum stroke_predefined_dash_e {
    DASH_NONE = 0,
    DASH_8_8_16_0,
    DASH_4,
    DASH_0_4_16_4_4_4,
    DASH_12_4_4_4_4_4,
    DASH_1,
    DASH_2,
    DASH_16,
    DASH_0_1_8_1_8_1_8_1_4_0 = 12,
    DASH_4_1_8_1_7_1_9_1,
    DASH_3_1_7_1_7_1_4_8,
    DASH_3_1_7_1_7_1_7_1_4_0,
    DASH_0_1_6_1_1_1_4_1_3_1_2_1_5_2_3_0,
    DASH_3_2_5_1_2_1_3_1_4_1_1_1_6_1,
    DASH_7_1_6_1_6_1_6_1_3_0,
    DASH_3_1_6_1_6_1_6_1_7_0,
    DASH_24_8 = 22,
    DASH_CUSTOM = 0x100,
};
 
enum keycode_e {
    /* 0x00 */
    KEY_ESC = 0x01,
    KEY_LEFT,
    KEY_UP,
    KEY_RIGHT,
    KEY_DOWN,
    KEY_PGUP,
    KEY_PGDN,
    KEY_CAPS = 0x0a,
    KEY_DEL = 0xc,
    KEY_ENTER = 0x0d,
    /* 0x10 */
    KEY_MENU = 0x11,
    KEY_FUNC_MENU = 0x11,
    KEY_FONT = 0x12,
    /* 0x20 */
    KEY_SPACE = ' ',
    KEY_EXCL = '!',
    KEY_TAB = 0x22,
    KEY_HASH = '#',
    KEY_DOLLAR = '$',
    KEY_PERCENT = '%',
    KEY_LPAREN = '(',
    KEY_RPAREN = ')',
    KEY_STAR = '*',
    KEY_COMMA = ',',
    KEY_DASH = '-',
    KEY_DOT = '.',
    /* 0x30 */
    KEY_0 = '0',
    KEY_1 = '1',
    KEY_2 = '2',
    KEY_3 = '3',
    KEY_4 = '4',
    KEY_5 = '5',
    KEY_6 = '6',
    KEY_7 = '7',
    KEY_8 = '8',
    KEY_9 = '9',
    KEY_QUESTION = '?',
    /* 0x40 */
    KEY_AT = '@',
    KEY_A = 'A',
    KEY_B = 'B',
    KEY_C = 'C',
    KEY_D = 'D',
    KEY_E = 'E',
    KEY_F = 'F',
    KEY_G = 'G',
    KEY_H = 'H',
    KEY_I = 'I',
    KEY_J = 'J',
    KEY_K = 'K',
    KEY_L = 'L',
    KEY_M = 'M',
    KEY_N = 'N',
    KEY_O = 'O',
    /* 0x50 */
    KEY_P = 'P',
    KEY_Q = 'Q',
    KEY_R = 'R',
    KEY_S = 'S',
    KEY_T = 'T',
    KEY_U = 'U',
    KEY_V = 'V',
    KEY_W = 'W',
    KEY_X = 'X',
    KEY_Y = 'Y',
    KEY_Z = 'Z',
    /* 0x80 */
    KEY_LANG_CHN = 0x80,
    KEY_LANG_YUE = 0x81,
    KEY_LANG_ENG = 0x82,
    KEY_POWER = 0x83,
    KEY_F1 = 0x84,
    KEY_F2,
    KEY_F3,
    KEY_F4,
    KEY_F5,
    KEY_APP_REC = 0x89,
    KEY_SHIFT = 0x8b,
    KEY_IME = 0x8e,
    KEY_LANG_JPN = 0x8f,
    /* 0x90 */
    KEY_SYMBOL = 0x91,
    KEY_HOME = 0x93,
    KEY_HOME_MENU = 0x93,
    KEY_PRIME_MENU = 0x93,
    KEY_TOGGLE_SC_TC = 0x94,
    KEY_HELP = 0x95,
    KEY_SAVE = 0x96,
    KEY_APP_MP3_PLAYER = 0x98,
    KEY_VOL_BACKLIGHT = 0x9c,
    KEY_SYLLABLE = 0x9e,
    KEY_ORIGINAL_INPUT = 0x9f,
    /* 0xa0 */
    KEY_APP_MISC_3 = 0xa3,
    KEY_APP_FLASHCARD = 0xa3,
    KEY_APP_MISC_5 = 0xa5,
    KEY_APP_DICT_JA_DAJIRIN = 0xa5,
    KEY_APP_GAMES = 0xa5,
    KEY_APP_MISC_6 = 0xa6,
    KEY_APP_DICT_JA_SHINMEIKAI = 0xa6,
    KEY_APP_ALBUM = 0xa6,
    KEY_APP_MISC_7 = 0xa7,
    KEY_APP_DICT_EN_LONGMAN = 0xa7,
    KEY_APP_DICT_JA_EN_GENIUS = 0xa7,
    KEY_APP_MISC_8 = 0xa8,
    KEY_APP_DICT_EN_JA_GENIUS = 0xa8,
    /* 0xb0 */
    KEY_PRIME_APPS = 0xb1,
    KEY_PRIME_PLOT,
    KEY_PRIME_NUM,
    KEY_PRIME_VIEW,
    KEY_PRIME_CAS,
    KEY_PRIME_ALPHA,
    KEY_PRIME_MINUS,
    KEY_PRIME_DECIMAL_POINT,
    KEY_PRIME_PLUS,
    /* 0xc0 */
    KEY_FAV = 0xc0,
    /* 0xd0 */
    KEY_APP_VIDEO_PLAYER = 0xd0,
    KEY_AUX_MENU = 0xd1,
    KEY_APP_TRANSLATOR_EN_ZH = 0xd2,
    KEY_APP_TRANSLATOR_ZH_EN = 0xd3,
    KEY_APP_DICT_EN_PRO = 0xd4,
    /* 0xe0 */
    KEY_APP_DICT_ZH_EN_BESTA = 0xe8,
    KEY_APP_DICT_JA_ZH_BESTA = 0xe9,
    KEY_APP_DICT_ZH_JA_BESTA = 0xea,
    /* 0xf0 */
    KEY_APP_DICT_EN_OXFORD = 0xf2,
    KEY_APP_DICT_EN_ZH_BESTA = 0xf3,
    KEY_EDIT = 0xf5,
    KEY_SEARCH = 0xf6,
    KEY_BACKLIGHT = 0xf8,
    KEY_COMPARE = 0xf9,
    KEY_VOL = 0xfa,
    KEY_BATTERY = 0xfb,
    KEY_CONTRAST = 0xfc,
    KEY_USB_INSERTION = 0xfe,
    KEY_REPEAT = 0xff,
    /* 0x100+ */
    KEY_INS = 0x101,
    KEY_SCROLL_WHEEL_EVENT = 0x102,
    KEY_TTS = 0x104,
    KEY_SHIFT_PGUP = 0xe047,
    KEY_PRIME_HOME = 0xe047,
    KEY_SHIFT_PGDN = 0xe04f,
};
 
enum scroll_wheel_e {
    SCROLL_DOWN,
    SCROLL_UP,
};
 
enum ui_event_type_e {
    UI_EVENT_TYPE_INVALID = 0,
    UI_EVENT_TYPE_TOUCH_BEGIN = 1,
    UI_EVENT_TYPE_TOUCH_MOVE = 2,
    UI_EVENT_TYPE_TOUCH_END = 8,
    UI_EVENT_TYPE_KEY = 16,
    UI_EVENT_TYPE_KEY_UP = 0x100000,
};
 
enum font_type_e {
    SANS_TINY_CJK_NORMAL = 0,
    SANS_BOLD_TINY_CJK_NORMAL,
    SANS_ITALIC_TINY_CJK_REGULAR_NORMAL,
    SANS_BOLDITALIC_TINY_CJK_REGULAR_NORMAL,
    SERIF_SMALL_CJK,
    SERIF_BOLD_SMALL_CJK,
    SERIF_ITALIC_SMALL_CJK_REGULAR,
    SERIF_BOLDITALIC_SMALL_CJK_REGULAR,
    SERIF_CJK,
    SERIF_BOLD_CJK,
    SERIF_ITALIC_CJK_REGULAR,
    SERIF_BOLDITALIC_CJK_REGULAR,
    SERIF_LARGE_CJK,
    SERIF_BOLD_LARGE_CJK,
    SERIF_ITALIC_LARGE_CJK,
    SERIF_BOLDITALIC_LARGE_CJK,
    MONOSPACE_CJK,
    MONOSPACE_TINY_NOCJK,
    SERIF_CJK_18,
    SERIF_BOLD_CJK_19,
    SERIF_SMALL_CJK_20,
    SANS_TINY_NOCJK,
    SANS_BOLD_TINY_NOCJK,
    SANS_ITALIC_TINY_NOCJK,
    SANS_BOLDITALIC_TINY_NOCJK,
    SERIF_SMALL_CJK_25,
    SERIF_BOLD_SMALL_CJK_26,
    SERIF_ITALIC_SMALL_CJK_REGULAR_27,
    SERIF_BOLDITALIC_SMALL_CJK_REGULAR_28,
    SERIF_CJK_29,
    SERIF_BOLD_CJK_30,
    SERIF_ITALIC_CJK_REGULAR_31,
    SERIF_BOLDITALIC_CJK_REGULAR_32,
    SERIF_HUGE_CJK_LARGE,
    SANS_HUGE_CJK_LARGE,
    SERIF_ITALIC_HUGE_CJK_LARGE,
    SANS_ITALIC_HUGE_CJK_LARGE,
};
 
struct lcd_surface_s;
struct lcd_cursor_s;
struct ui_rect_s;
struct lcd_draw_s;
struct lcd_font_s;
struct lcd_lock_s;
struct lcd_base_s;
struct lcd_thread_safe_s;
struct ui_event_base_s;
struct ui_event_prime_s;
struct ui_message_s;
struct ui_component_s;
struct ui_multipress_event_s;
 
typedef struct lcd_surface_s lcd_surface_t;
typedef struct lcd_cursor_s lcd_cursor_t;
typedef struct ui_rect_s ui_rect_t;
typedef struct lcd_draw_s lcd_draw_t;
typedef struct lcd_font_s lcd_font_t;
typedef struct lcd_lock_s lcd_lock_t;
typedef struct lcd_base_s lcd_base_t;
typedef struct lcd_thread_safe_s lcd_thread_safe_t;
typedef struct ui_event_base_s ui_event_base_t;
typedef struct ui_event_prime_s ui_event_prime_t;
typedef struct ui_message_s ui_message_t;
typedef struct ui_component_s ui_component_t;
typedef struct ui_multipress_event_s ui_multipress_event_t;
 
#if defined(MUTEKI_HAS_PRIME_UI_EVENT) && MUTEKI_HAS_PRIME_UI_EVENT == 1
#define ui_event_s ui_event_prime_s
typedef struct ui_event_prime_s ui_event_t;
#else
#define ui_event_s ui_event_base_s
typedef struct ui_event_base_s ui_event_t;
#endif
 
#if defined(MUTEKI_HAS_THREAD_SAFE_LCD) && MUTEKI_HAS_THREAD_SAFE_LCD == 1
#define lcd_s lcd_thread_safe_s
typedef struct lcd_thread_safe_s lcd_t;
#else
#define lcd_s lcd_base_s
typedef struct lcd_base_s lcd_t;
#endif
 
struct lcd_surface_s {
    char magic[2]; // 0:2
    short width; // 2:4
    short height; // 4:6
    short depth; // 6:8
    short xsize; // 8:10
    short encoding; // 10:12
    int *palette; // 12:16
    void *buffer; // 16:20
}; // 20 bytes
 
struct lcd_cursor_s {
    short x; // 0x0:0x2 (lcd_t[0x5c:0x5e])
    short y; // 0x2:0x4 (lcd_t[0x5e:0x60])
    unsigned int size; // 0x4:0x8 (lcd_t[0x60:0x64])
    short type; // 0x8:0xa (lcd_t[0x64:0x66])
    short unk_0xa; // 0xa:0xc (lcd_t[0x66:0x68])
    short grab_count; // 0xc:0xe (lcd_t[0x68:0x6a])
    short unk_0xe; // 0xe:0x10 (lcd_t[0x6a:0x6c])
}; // 0x10 bytes
 
struct ui_rect_s {
    short x0; // (lcd_t[0x6c:0x6e])
    short y0; // (lcd_t[0x6e:0x70])
    short x1; // (lcd_t[0x70:0x72])
    short y1; // (lcd_t[0x72:0x74])
}; // 0x8 bytes
 
struct lcd_draw_s {
    int unk_0x0; // 0x0:0x4 (lcd_t[0x14:0x18])
    int fg_color; // 0x4:0x8 (lcd_t[0x18:0x1c])
    unsigned int stroke_dash_pattern; // 0x8:0xc (lcd_t[0x1c:0x20])
    short stroke_size; // 0xc:0xe (lcd_t[0x20:0x22])
    short stroke_dash; // 0xe:0x10 (lcd_t[0x22:0x24])
    int unk_0x10; // 0x10:0x14 (lcd_t[0x24:0x28])
    int unk_0x14; // 0x14:0x18 (lcd_t[0x28:0x2c])
    int unk_0x18; // 0x18:0x1c (lcd_t[0x2c:0x30])
    int unk_0x1c; // 0x1c:0x20 (lcd_t[0x30:0x34])
}; // 0x20 bytes
 
struct lcd_font_s {
    short type; // 0x0:0x2 (lcd[0x34:0x36])
    short height; // 0x2:0x4 (lcd[0x36:0x38])
    short unk_0x4; // 0x4:0x6 (lcd[0x38:0x3a])
    short unk_0x6; // 0x6:0x8 (lcd[0x3a:0x3c])
    short unk_0x8; // 0x8:0xa (lcd[0x3c:0x3e])
    short unk_0xa; // 0xa:0xc (lcd[0x3e:0x40])
    short unk_0xc; // 0xc:0xe (lcd[0x40:0x42])
    short unk_0xe[13]; // 0xe:0x28 (lcd[0x42:0x5c])
}; // 0x28 bytes
 
struct lcd_lock_s {
    int unk_0x0; // 0x0:0x4 (lcd_thread_safe_t[0x94:0x98])
    critical_section_t *cs; // 0x4:0x8 (lcd_thread_safe_t[0x98:0x9c])
    void (*lock)(void); // 0x8:0xc (lcd_thread_safe_t[0x9c:0xa0])
    void (*unlock)(void); // 0xc:0x10 (lcd_thread_safe_t[0xa0:0xa4])
    int unk_0xa4[23]; // 0x10:0x6c (lcd_thread_safe_t[0xa4:0x100])
}; // 0x6c bytes
 
typedef int (*lcd_rotate_callback_t)(lcd_t *self, int rotation);
 
struct lcd_base_s {
    lcd_surface_t *surface; // 0x0:0x4
    void *pixel_end; // 0x4:0x8
    size_t pixel_size; // 0x8:0xc
    int bg_color; // 0xc:0x10
    int transparent_color; // 0x10:0x14
    lcd_draw_t draw; // 0x14:0x34
    lcd_font_t font; // 0x34:0x5c
    lcd_cursor_t saved_cursor; // 0x5c:0x6c
    ui_rect_t drawing_area; // 0x6c:0x74
    int unk_0x74[3]; // 0x74:0x80
    lcd_cursor_t *cursor; // 0x80:0x84
    short width; // 0x84:0x86
    short height; // 0x86:0x88
    int rotation; // 0x88:0x8c
    short depth_bytes; // 0x8c:0x8e
    short xsize; // 0x8e:0x90
    lcd_rotate_callback_t rotate; // 0x90:0x94
}; // 0x94 bytes
 
struct lcd_thread_safe_s {
    lcd_surface_t *surface; // 0x0:0x4
    void *pixel_end; // 0x4:0x8
    size_t pixel_size; // 0x8:0xc
    int bg_color; // 0xc:0x10
    int transparent_color; // 0x10:0x14
    lcd_draw_t draw; // 0x14:0x34
    lcd_font_t font; // 0x34:0x5c
    lcd_cursor_t saved_cursor; // 0x5c:0x6c
    ui_rect_t drawing_area; // 0x6c:0x74
    int unk_0x74[3]; // 0x74:0x80
    lcd_cursor_t *cursor; // 0x80:0x84
    short width; // 0x84:0x86
    short height; // 0x86:0x88
    int rotation; // 0x88:0x8c
    short depth_bytes; // 0x8c:0x8e
    short xsize; // 0x8e:0x90
    lcd_rotate_callback_t rotate; // 0x90:0x94
    int unk_0x94; // 0x94:0x98
    critical_section_t *cs; // 0x98:0x9c
    void (*lock)(void); // 0x9c:0xa0
    void (*unlock)(void); // 0xa0:0xa4
    int unk_0xa4[23]; // 0xa4:0x100
};
 
struct ui_multipress_event_s {
    unsigned int type;
    unsigned short finger_id;
    union {
        struct {
            unsigned short key_code0;
            unsigned short key_code1;
        };
        struct {
            unsigned short touch_x;
            unsigned short touch_y;
        };
    };
    unsigned short unk_0xb;
};
 
struct ui_event_base_s {
    ui_component_t *recipient; // 0-4
    int event_type; // 4-8 16: key (?).
    union {
        struct {
            unsigned short key_code0; // 8-10
            unsigned short key_code1; // 10-12 sometimes set when 2 keys are pressed simultaneously. Does not always work.
        };
        struct {
            unsigned short touch_x;
            unsigned short touch_y;
        };
    };
    union {
        void *usb_data; // 12-16 pointer that only shows up on USB insertion event.
        unsigned int scroll_wheel;
    };
 
    void *unk16; // 16-20 sometimes a pointer especially on unstable USB connection? junk data?
    void *unk20; // 20-24 seems to be always 0. Unused?
};
 
struct ui_event_prime_s {
    ui_component_t *recipient; // 0-4
    int event_type; // 4-8 16: key (?).
    union {
        struct {
            unsigned short key_code0; // 8-10
            unsigned short key_code1; // 10-12 sometimes set when 2 keys are pressed simultaneously. Does not always work.
        };
        struct {
            unsigned short touch_x;
            unsigned short touch_y;
        };
    };
    union {
        void *usb_data; // 12-16 pointer that only shows up on USB insertion event.
        unsigned int scroll_wheel;
    };
    void *unk16; // 16-20 sometimes a pointer especially on unstable USB connection? junk data?
    void *unk20; // 20-24 seems to be always 0. Unused?
    unsigned short available_multipress_events; // 24-26
    unsigned short unk_0x1a; // 26-28
    ui_multipress_event_t multipress_events[8]; // 28-124
};
 
struct ui_message_s {
    ui_event_t event; // 0x0:0x18
    int unk_0x18; // 0x18:0x1c
}; // 0x1c bytes
 
struct ui_component_s {
    ui_component_t *next; // 0x0:0x4
    ui_component_t *parent; // 0x4:0x8
    unsigned short state; // 0x8:0xa
    short unk_0xa; // 0xa:0xc
    ui_rect_t footprint; // 0xc:0x14
    void (*on_change_state)(ui_component_t *self, unsigned short mask, bool value); // 0x14:0x18
    void (*on_erase_bg)(ui_component_t *self); // 0x18:0x1c
    void (*on_draw)(ui_component_t *self); // 0x1c:0x20
    void (*on_event)(ui_component_t *self, ui_event_t *event); // 0x20:0x24
    void *unk_0x24; // 0x24:0x2a
    short unk_0x28;
    short unk_0x2a; // 0x2a:0x2c
    int unk_0x2c; // 0x2c:0x30
    unsigned short tag; // 0x30:0x32
    short unk_0x32; // 0x32:0x34
};
 
#define RGB_FROM_U8(r, g, b) ((r & 0xff) << 16 | ((g & 0xff) << 8) | (b & 0xff))
 
#ifdef __cplusplus
} // extern "C"
#endif
 
#endif // __MUTEKI_UI_COMMON_H__