aboutsummaryrefslogtreecommitdiff
path: root/clients/tui.h
blob: 061edbf319763860a472af008471eeb76e11eda5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
#ifndef BOKF_TUI_H
#define BOKF_TUI_H

#include <stddef.h>
#include <stdint.h>

#include <ncursesw/ncurses.h>

/* Shared TUI widgets: the only place that touches ncurses (screens compose
   these; see docs/TUI-GUIDELINES.md). Everything with logic of its own is
   unit-tested in tests/test_tui.c, which links only the pure parts. */

/* Universal keys that have no control code or need a stable name. */
#define TUI_KEY_CTRL_N 0x0e
#define TUI_KEY_CTRL_X 0x18
#define TUI_KEY_CTRL_ENTER (KEY_MAX + 1)

/* Key hooks: widgets call the screen's hook for keys they do not handle. */
#define TUI_HOOK_NONE 0    /* not handled: process the key normally */
#define TUI_HOOK_STAY 1    /* handled: redraw and keep the widget up */
#define TUI_HOOK_BACK 2    /* handled: return "back" */
#define TUI_HOOK_REFRESH 3 /* handled: return "refresh" */
#define TUI_HOOK_SUBMIT 4  /* handled: return "submit" (forms only) */

/* The application supplies input, frame/hints drawing and a quit hook so
   this module stays free of app state (and testable). */
void tui_set_input(int (*fn)(void));
void tui_set_screen(void (*frame)(const char *), void (*hints)(const char *));
void tui_set_quit(void (*fn)(void));
void tui_keys_setup(void);

/* --- text measure and formatting --- */
int tui_disp_width(const char *s);
int tui_disp_width_n(const char *s, size_t n);
void tui_pad_field(char *buf, size_t cap, int width);
void tui_pad_label(char *buf, size_t n, const char *text, int width);
void tui_pad_hdr(char *buf, size_t n, int width, const char *text);
void tui_amt_col(char *buf, size_t n, int width, int64_t ore);
void tui_kr_format(int64_t ore, char *buf, size_t n);
void tui_kr0_format(int64_t ore, char *buf, size_t n);
int tui_parse_kr(const char *s, int64_t *out);

/* --- line editor (pure) --- */
struct tui_ledit {
    char *buf;
    size_t cap;
    size_t len;
    size_t pos; /* caret in bytes */
};

void tui_le_init(struct tui_ledit *e, char *buf, size_t cap);
void tui_le_clear(struct tui_ledit *e);
int tui_le_key(struct tui_ledit *e, int ch);

/* Applies one key to a form field. *pos is the caret ((size_t)-1 = end);
   *fresh replaces the content on the first editing key. Returns whether
   the key was consumed. */
int tui_field_edit(char *buf, size_t cap, size_t *pos, int ch, int *fresh);

/* Date field: digits only, dashes inserted ("20260215" -> "2026-02-15"),
   caret tracked in digit space. */
int tui_date_field_edit(char *buf, size_t cap, size_t *pos, int ch,
                        int *fresh);

/* Line editor at (y,x) with the label already drawn. Returns 1 on Enter,
   2 on Tab, 3 on Shift-Tab, 0 on Esc. */
int tui_edit_field(int y, int x, char *buf, size_t cap, int mask);

/* --- modal dialogs --- */
void tui_message(const char *title, const char *fmt, ...)
    __attribute__((format(printf, 2, 3)));
int tui_confirm(const char *title, const char *fmt, ...)
    __attribute__((format(printf, 2, 3)));

/* --- prompts: write into the caller's buffer, return 0 on Esc --- */
int tui_prompt_into(char *buf, size_t cap, const char *label,
                    const char *def, int mask);
int tui_date_prompt_into(char *buf, size_t cap, const char *label,
                         const char *def);
int tui_amount_prompt_into(int64_t *out, const char *label, int64_t def_ore);
int tui_choice_prompt(const char *label, const char *const *opts, int n,
                      int cur);

/* --- lists --- */
#define TUI_NAV_NONE (-3)

struct tui_list_nav {
    int n, sel, top, view, numw;
    char gotobuf[12];
    char gotolabel[32];
    int goto_active;
};

/* Returns the selected index, or -1 back, -2 refresh, -4 new, -6 remove,
   -7 toggle, TUI_NAV_NONE when nothing happened. */
int tui_nav_key(struct tui_list_nav *v, int ch, int allow_new,
                int allow_remove, int allow_toggle, int menu_mode);

int tui_select_list(const char *title, char **items, int n, int start,
                    int allow_refresh, int *cursor, int allow_new,
                    const char *archive_action, int allow_toggle);
int tui_select_list_hook(const char *title, char **items, int n, int start,
                         int allow_refresh, int *cursor, int allow_new,
                         const char *archive_action, int allow_toggle,
                         int (*key)(void *ud, int ch), void *ud);
int tui_menu(const char *title, const char *const *items, int n,
             int allow_new, int *cursor);

/* --- frame, status, hints, pager --- */
void tui_set_status(const char *status, const char *right);
void tui_frame(const char *title);
void tui_hints(const char *s);
void tui_redraw(void);
#define TUI_PAGER_SAVE 0x1 /* 's' returns 2 (the save action) */
int tui_pager(const char *title, const char *text, const char *action_hint);
int tui_pager_hook(const char *title, const char *text,
                   const char *extra_hint, unsigned flags,
                   int (*key)(void *ud, int ch), void *ud);

/* --- forms --- */
enum {
    TUI_F_TEXT = 0,
    TUI_F_DATE,
    TUI_F_AMOUNT,
    TUI_F_CHOICE,
    TUI_F_ACTION,
};

#define TUI_FORM_BACK (-1)
#define TUI_FORM_PAGE 10
#define TUI_FORM_REFRESH (-2)
#define TUI_FORM_SUBMIT (-8)

struct tui_form_field {
    const char *label;
    char *value; /* text storage for TEXT/DATE (also CHOICE labels/ACTION) */
    size_t cap;
    int kind;
    int mask;                      /* TEXT: '*' instead of the content */
    int64_t *ore;                  /* TUI_F_AMOUNT */
    const char *const *choices;    /* TUI_F_CHOICE */
    int nchoices;
    int *choice;                   /* TUI_F_CHOICE: current index */
};

int tui_form_next(int sel, int n, int ch);
int tui_form_run(const char *title, struct tui_form_field *f, int n,
                 int can_edit);
int tui_form_run_hook(const char *title, struct tui_form_field *f, int n,
                      int can_edit, int (*key)(void *ud, int ch), void *ud);

/* --- row table --- */
enum { TUI_RT_EDIT = 0, TUI_RT_INFO, TUI_RT_DATE };

struct tui_rt_col {
    const char *header;
    int x;
    int width;
    int kind;
};

struct tui_rt {
    int nrows, maxrows, ncols, neditable;
    const struct tui_rt_col *cols;
    int y;
    int row, col;
    int fresh;
    size_t pos;
    void (*cell)(void *, int, int, char **, size_t *);
    void (*info)(void *, int, char *, size_t);
    void *ud;
    int (*key)(void *, int);
    /* Writes the dim status line shown under the table ('\n' -> ' '). */
    void (*footer)(void *, char *, size_t);
    /* Optional header fields drawn above the table; focus starts there. */
    struct tui_form_field *fields;
    int nfields;
    int focus; /* header field index, or -1 for the table */
};

void tui_rt_init(struct tui_rt *t, int nrows, int maxrows, int ncols,
                 const struct tui_rt_col *cols, int y,
                 void (*cell)(void *, int, int, char **, size_t *),
                 void (*info)(void *, int, char *, size_t), void *ud);
void tui_rt_set_key(struct tui_rt *t, int (*key)(void *ud, int ch));
void tui_rt_set_footer(struct tui_rt *t,
                       void (*footer)(void *ud, char *buf, size_t n));
void tui_rt_set_fields(struct tui_rt *t, struct tui_form_field *fields, int n);
int tui_rt_blank_row(struct tui_rt *t, int row);
int tui_rt_normalize(struct tui_rt *t);
int tui_rt_move(struct tui_rt *t, int dr, int dc);
int tui_rt_tab(struct tui_rt *t, int dir);
int tui_rt_clear(struct tui_rt *t);
int tui_rt_col_of(const struct tui_rt *t, int ecol);
int tui_rt_run(const char *title, struct tui_rt *t, const char *hint);

/* Focus order for a row table with header fields: fields first, then the
   editable cells row by row, wrapping back to the first field. focus -1 is
   the table, 0..nf-1 the fields; dir 1 = Tab, -1 = Shift-Tab. When the new
   focus is in the table, updates the row and col pointers. */
int tui_rt_focus_step(int focus, int nf, int *row, int *col, int nrows,
                      int neditable, int dir);

/* The footer line (above the hints) and its flattening. */
int tui_rt_footer_row(int lines);
void tui_rt_footer_flatten(char *s);

#endif