ngui.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348
  1. /* ngui: tiny immediate-mode GUI toolkit for ring-3 canvas windows.
  2. *
  3. * The toolkit owns no memory: the app passes its framebuffer and keeps the
  4. * state structs for text fields and scroll panes. Everything is RGB565 and
  5. * ASCII, using the kernel's 8x16 font. See ucmd_files.c for a user. */
  6. #ifndef NGUI_H
  7. #define NGUI_H
  8. #include "syscall.h"
  9. #include "wm_abi.h"
  10. #include "icon_abi.h"
  11. #define NGUI_INPUT_MAX 512
  12. #define NGUI_MOTION_REDRAW_MS 33
  13. /* Corner radius shared by cards, tiles, list rows and dialogs. */
  14. #define NGUI_RADIUS 6
  15. #define NGUI_INPUT_CHANGED 1
  16. #define NGUI_INPUT_SUBMIT 2
  17. #define NGUI_INPUT_CANCEL 4
  18. #define NGUI_INPUT_NEXT 8 /* Tab: move to the next field (with CANCEL) */
  19. /* Key codes from io.c. Arrows are 0x100..; the page/home/end keys are
  20. * produced by the extended PS/2 path. */
  21. #define NGUI_KEY_ESC 0x1B
  22. #define NGUI_KEY_BACKSPACE 0x08
  23. #define NGUI_KEY_TAB 0x09
  24. #define NGUI_KEY_LEFT 0x100
  25. #define NGUI_KEY_RIGHT 0x101
  26. #define NGUI_KEY_UP 0x102
  27. #define NGUI_KEY_DOWN 0x103
  28. #define NGUI_KEY_PAGE_UP 0x104
  29. #define NGUI_KEY_PAGE_DOWN 0x105
  30. #define NGUI_KEY_HOME 0x106
  31. #define NGUI_KEY_END 0x107
  32. #define NGUI_KEY_DELETE 0x108
  33. #define NGUI_KEY_CTRL_LEFT 0x109
  34. #define NGUI_KEY_CTRL_RIGHT 0x10A
  35. #define NGUI_KEY_CTRL_DELETE 0x10B
  36. #define NGUI_KEY_CTRL_BACKSPACE 0x10C
  37. #define NGUI_RGB(r, g, b) \
  38. ((unsigned short)((((r) >> 3) << 11) | (((g) >> 2) << 5) | ((b) >> 3)))
  39. struct ufont_face;
  40. struct ngui_rect {
  41. int x, y, w, h;
  42. };
  43. struct ngui_theme {
  44. unsigned short bg;
  45. unsigned short panel;
  46. unsigned short panel_alt;
  47. unsigned short border;
  48. unsigned short text;
  49. unsigned short text_dim;
  50. unsigned short accent;
  51. unsigned short selection;
  52. unsigned short button;
  53. unsigned short button_hot;
  54. unsigned short button_down;
  55. unsigned short icon_folder;
  56. unsigned short icon_file;
  57. unsigned short icon_disk;
  58. unsigned short error;
  59. unsigned short success;
  60. unsigned short warning;
  61. };
  62. extern const struct ngui_theme ngui_theme_dark;
  63. /* Icons come from the Adwaita symbolic set (include/icon_abi.h): ngui loads
  64. * /ramfs/icons/adwaita16.icn on first use and tints the 16 px masks with the
  65. * colour passed to ngui_icon(). Both packs carry the bundle; without it
  66. * ngui_icon() draws nothing. */
  67. #define NGUI_ICON_ENUM_(e, name, file) NGUI_ICON_##e,
  68. enum ngui_icon {
  69. ICON_LIST(NGUI_ICON_ENUM_)
  70. NGUI_ICON_COUNT
  71. };
  72. #undef NGUI_ICON_ENUM_
  73. #define NGUI_ICON_PATH ICON_BUNDLE_PATH
  74. /* Short display name of an icon ("folder", "back", ...). */
  75. const char *ngui_icon_name(enum ngui_icon icon);
  76. struct ngui_input {
  77. char text[NGUI_INPUT_MAX];
  78. unsigned int len;
  79. unsigned int cursor;
  80. unsigned int scroll; /* first visible character */
  81. unsigned int anchor; /* mouse selection anchor (== cursor: none) */
  82. int dragging; /* a press in the field is extending a selection */
  83. int disabled; /* ignore input and paint the value dimmed */
  84. int secret; /* paint '*' per character (passwords) */
  85. const char *placeholder;
  86. unsigned int last_click_ms; /* previous press, for double-click select-all */
  87. };
  88. struct ngui_scroll {
  89. int offset; /* pixels scrolled from the top */
  90. int content_h;
  91. int view_h;
  92. int dragging;
  93. int drag_dy;
  94. int hide_bar; /* wheel/keys only; draw no scrollbar */
  95. /* The bar is an overlay: it reserves no layout width, stays hidden
  96. * while the pointer is outside the pane and slides in on hover. */
  97. int bar_vis; /* 0 hidden .. animation target shown */
  98. int bar_target; /* requested visibility (0 or full) */
  99. int bar_hot; /* pointer is over the scrollbar strip */
  100. unsigned int bar_ms; /* last animation step (u_ticks_ms) */
  101. };
  102. struct ngui_slider {
  103. int dragging;
  104. };
  105. /* A flat menu panel: the surface, a body rectangle for the caller's widgets
  106. * and a one-line footer for status text. There is no title bar or close
  107. * button; the app is dismissed by clicking outside it or pressing Esc. Use
  108. * on one chromeless canvas window created with u_win_create_popover(). */
  109. struct ngui_popover {
  110. struct ngui_rect body;
  111. struct ngui_rect footer;
  112. };
  113. /* A two-line list row with optional signal bars and right-aligned text. */
  114. struct ngui_row {
  115. const char *title;
  116. const char *subtitle;
  117. const char *trailing;
  118. int bars; /* -1 none, 0..4 signal strength bars */
  119. int selected;
  120. };
  121. struct ngui {
  122. unsigned short *px;
  123. int w, h;
  124. struct ngui_theme theme;
  125. /* Fonts are owned by ufont.c's heap arena. ngui_font_attach() opens
  126. * them; ngui_font_detach() frees the arena (the browser calls it before
  127. * heap_reset()). NULL means the 8x16 bitmap fallback. */
  128. struct ufont_face *font;
  129. struct ufont_face *font_bold;
  130. struct ufont_face *font_italic;
  131. struct ufont_face *font_bold_italic;
  132. struct ufont_face *font_mono;
  133. struct ufont_face *font_emoji; /* lazy fallback face */
  134. int emoji_loaded;
  135. int font_px;
  136. /* Current pointer state, content-relative. */
  137. int mouse_x, mouse_y;
  138. unsigned int buttons;
  139. int inside;
  140. int focused;
  141. /* Scroll accumulated since the previous frame, in pixels. */
  142. int scroll_x, scroll_y;
  143. /* Press/release edges collected by ngui_begin(). `pressed` and
  144. * `released` are the left button; the right-button edges let an app
  145. * open a context menu without taking the normal click path. */
  146. unsigned int pressed;
  147. unsigned int released;
  148. unsigned int right_pressed;
  149. unsigned int right_released;
  150. int press_x, press_y;
  151. int release_x, release_y;
  152. int right_press_x, right_press_y;
  153. int right_release_x, right_release_y;
  154. int clicked;
  155. int focus_claimed;
  156. unsigned int hot;
  157. unsigned int active;
  158. unsigned int focus;
  159. struct ngui_rect clip[4];
  160. int nclip;
  161. int dirty;
  162. unsigned int last_blink;
  163. int caret_on;
  164. int keys[32];
  165. unsigned int key_head, key_tail;
  166. int last_mouse_x, last_mouse_y;
  167. int last_inside, last_focused;
  168. /* Pointer motion is throttled: a redraw is needed for hover feedback,
  169. * but not for every 200 Hz mouse report. A pending motion is flushed
  170. * once 33 ms have passed, so the final hover state still appears. */
  171. unsigned int motion_ms;
  172. int motion_pending;
  173. /* Mouse cursor (enum cursor_shape): widgets set `cursor` while they
  174. * draw a frame (a text field under the pointer asks for the I-beam);
  175. * ngui_begin() resets it to the arrow for every redrawn frame and
  176. * ngui_end_ex() sends it to the kernel when it changed. */
  177. int cursor;
  178. int cursor_sent;
  179. int cursor_frame; /* this frame was redrawn (begin returned 1) */
  180. };
  181. void ngui_init(struct ngui *ui, unsigned short *fb, int w, int h);
  182. void ngui_font_attach(struct ngui *ui); /* opens /ramfs/fonts; no-op if absent */
  183. void ngui_font_detach(struct ngui *ui); /* frees the ufont arena */
  184. int ngui_begin(struct ngui *ui); /* 1 = app should redraw */
  185. void ngui_end(struct ngui *ui);
  186. /* Same bookkeeping, but only publish the canvas when `present` is nonzero.
  187. * Lets an app poll input without copying an unchanged frame every loop. */
  188. void ngui_end_ex(struct ngui *ui, int present);
  189. void ngui_invalidate(struct ngui *ui);
  190. void ngui_set_focus(struct ngui *ui, unsigned int id);
  191. unsigned int ngui_focus(struct ngui *ui);
  192. int ngui_key(struct ngui *ui);
  193. int ngui_key_peek(struct ngui *ui);
  194. /* Layout: cut a rectangle off one side of `r` and return the piece. */
  195. struct ngui_rect ngui_cut_top(struct ngui_rect *r, int h);
  196. struct ngui_rect ngui_cut_bottom(struct ngui_rect *r, int h);
  197. struct ngui_rect ngui_cut_left(struct ngui_rect *r, int w);
  198. struct ngui_rect ngui_cut_right(struct ngui_rect *r, int w);
  199. void ngui_inset(struct ngui_rect *r, int n);
  200. int ngui_rect_contains(const struct ngui_rect *r, int x, int y);
  201. /* Primitives. All drawing is clipped to the current clip stack and canvas. */
  202. void ngui_push_clip(struct ngui *ui, struct ngui_rect r);
  203. void ngui_pop_clip(struct ngui *ui);
  204. void ngui_fill_rect(struct ngui *ui, struct ngui_rect r, unsigned short color);
  205. void ngui_frame(struct ngui *ui, struct ngui_rect r, unsigned short color);
  206. void ngui_fill_round_rect(struct ngui *ui, struct ngui_rect r,
  207. int tl, int tr, int br, int bl,
  208. unsigned short color);
  209. void ngui_frame_round(struct ngui *ui, struct ngui_rect r,
  210. int tl, int tr, int br, int bl, int thickness,
  211. unsigned short color);
  212. void ngui_line(struct ngui *ui, int x0, int y0, int x1, int y1,
  213. unsigned short color);
  214. void ngui_text(struct ngui *ui, int x, int y, const char *s,
  215. unsigned short color);
  216. void ngui_text_n(struct ngui *ui, int x, int y, const char *s,
  217. unsigned int n, unsigned short color);
  218. /* UTF-8 variants with the primary face -> emoji fallback stack. */
  219. void ngui_text_utf8(struct ngui *ui, int x, int y, const char *s,
  220. unsigned short color);
  221. void ngui_text_n_utf8(struct ngui *ui, int x, int y, const char *s,
  222. unsigned int n, unsigned short color);
  223. unsigned int ngui_text_width_utf8(struct ngui *ui, const char *s);
  224. void ngui_text_ellipsis_utf8(struct ngui *ui, struct ngui_rect r,
  225. int x, int y, const char *s,
  226. unsigned short color);
  227. void ngui_text_styled(struct ngui *ui, int x, int y, const char *s,
  228. unsigned int n, unsigned short color, int scale, int bold);
  229. /* Browser-oriented style: arbitrary pixel size, optional italic and mono. */
  230. void ngui_text_px(struct ngui *ui, int x, int y, const char *s,
  231. unsigned int n, unsigned short color, int px, int bold,
  232. int italic, int mono);
  233. void ngui_text_rot180(struct ngui *ui, int x, int y, const char *s,
  234. unsigned int n, unsigned short color);
  235. void ngui_text_ellipsis(struct ngui *ui, struct ngui_rect r, int x, int y,
  236. const char *s, unsigned short color);
  237. unsigned int ngui_text_width(const char *s);
  238. unsigned int ngui_text_width_n(const char *s, unsigned int n, int scale);
  239. unsigned int ngui_text_width_ui(struct ngui *ui, const char *s);
  240. unsigned int ngui_text_width_px(struct ngui *ui, const char *s, unsigned int n,
  241. int px, int bold, int italic, int mono);
  242. int ngui_text_ascent(struct ngui *ui, int px, int mono);
  243. int ngui_text_line_height(struct ngui *ui, int px, int mono);
  244. /* Face-aware variants: a non-NULL `face` (an @font-face loaded by the
  245. * caller) overrides the built-in regular/bold/italic/mono selection. */
  246. unsigned int ngui_text_width_face(struct ngui *ui, struct ufont_face *face,
  247. const char *s, unsigned int n, int px,
  248. int bold, int italic, int mono);
  249. int ngui_text_ascent_face(struct ngui *ui, struct ufont_face *face, int px,
  250. int mono);
  251. int ngui_text_line_height_face(struct ngui *ui, struct ufont_face *face,
  252. int px, int mono);
  253. void ngui_text_px_face(struct ngui *ui, struct ufont_face *face, int x,
  254. int y, const char *s, unsigned int n,
  255. unsigned short color, int px, int bold, int italic,
  256. int mono);
  257. void ngui_icon(struct ngui *ui, struct ngui_rect r, enum ngui_icon icon,
  258. unsigned short color);
  259. /* Widgets. IDs must be stable across frames. */
  260. int ngui_button(struct ngui *ui, unsigned int id, struct ngui_rect r,
  261. const char *label);
  262. int ngui_menu_item(struct ngui *ui, unsigned int id, struct ngui_rect r,
  263. const char *label, const char *shortcut, int checked);
  264. int ngui_menu_item_utf8(struct ngui *ui, unsigned int id, struct ngui_rect r,
  265. const char *label, const char *shortcut, int checked);
  266. int ngui_icon_button(struct ngui *ui, unsigned int id, struct ngui_rect r,
  267. enum ngui_icon icon);
  268. /* Menu panel component (see struct ngui_popover). */
  269. void ngui_popover_begin(struct ngui *ui, struct ngui_popover *p);
  270. void ngui_popover_footer(struct ngui *ui, const struct ngui_popover *p,
  271. const char *text, unsigned short color);
  272. /* Section caption with an optional right-aligned action button; returns 1
  273. * when the action fired. */
  274. int ngui_section(struct ngui *ui, struct ngui_rect r, const char *caption,
  275. unsigned int action_id, const char *action);
  276. int ngui_list_row(struct ngui *ui, unsigned int id, struct ngui_rect r,
  277. const struct ngui_row *row);
  278. int ngui_list_row_utf8(struct ngui *ui, unsigned int id, struct ngui_rect r,
  279. const struct ngui_row *row);
  280. void ngui_signal_bars(struct ngui *ui, struct ngui_rect r, int bars,
  281. unsigned short color);
  282. /* A two-line quick-settings tile (rounded, active when `on`). */
  283. int ngui_tile(struct ngui *ui, unsigned int id, struct ngui_rect r,
  284. const char *title, const char *subtitle, int on);
  285. /* Horizontal slider; writes *value and returns 1 when it changed. */
  286. int ngui_slider(struct ngui *ui, unsigned int id, struct ngui_slider *s,
  287. struct ngui_rect r, int *value, int min, int max);
  288. int ngui_text_input(struct ngui *ui, unsigned int id, struct ngui_rect r,
  289. struct ngui_input *in);
  290. /* Ask for `shape` (enum cursor_shape) while the pointer is in `r` (and in
  291. * the current clip); returns 1 when it is. ngui_set_cursor() sets it
  292. * unconditionally for the current frame. */
  293. int ngui_cursor_rect(struct ngui *ui, struct ngui_rect r, int shape);
  294. void ngui_set_cursor(struct ngui *ui, int shape);
  295. void ngui_input_set(struct ngui_input *in, const char *s);
  296. /* Copy a field's real value out (a secret field's '*' mask is bypassed). */
  297. void ngui_input_value(const struct ngui_input *in, char *out,
  298. unsigned int max);
  299. /* Scrolling pane: call begin, draw the content with scroll->offset, end. */
  300. void ngui_scroll_begin(struct ngui *ui, struct ngui_rect r,
  301. struct ngui_scroll *s);
  302. void ngui_scroll_end(struct ngui *ui, struct ngui_rect r,
  303. struct ngui_scroll *s);
  304. /* Apply pending wheel/touchpad scroll to s when the pointer is over r and
  305. * consume it. Call after ngui_scroll_begin() set view_h/content_h. */
  306. int ngui_scroll_wheel(struct ngui *ui, struct ngui_rect r,
  307. struct ngui_scroll *s);
  308. void ngui_scroll_to(struct ngui_scroll *s, int offset);
  309. void ngui_scroll_ensure_visible(struct ngui_scroll *s, int y, int h);
  310. int ngui_scroll_keys(struct ngui *ui, struct ngui_scroll *s);
  311. #endif