ngui.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304
  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. #define NGUI_INPUT_MAX 512
  11. #define NGUI_MOTION_REDRAW_MS 33
  12. #define NGUI_INPUT_CHANGED 1
  13. #define NGUI_INPUT_SUBMIT 2
  14. #define NGUI_INPUT_CANCEL 4
  15. #define NGUI_INPUT_NEXT 8 /* Tab: move to the next field (with CANCEL) */
  16. /* Key codes from io.c. Arrows are 0x100..; the page/home/end keys are
  17. * produced by the extended PS/2 path. */
  18. #define NGUI_KEY_ESC 0x1B
  19. #define NGUI_KEY_BACKSPACE 0x08
  20. #define NGUI_KEY_TAB 0x09
  21. #define NGUI_KEY_LEFT 0x100
  22. #define NGUI_KEY_RIGHT 0x101
  23. #define NGUI_KEY_UP 0x102
  24. #define NGUI_KEY_DOWN 0x103
  25. #define NGUI_KEY_PAGE_UP 0x104
  26. #define NGUI_KEY_PAGE_DOWN 0x105
  27. #define NGUI_KEY_HOME 0x106
  28. #define NGUI_KEY_END 0x107
  29. #define NGUI_KEY_DELETE 0x108
  30. #define NGUI_KEY_CTRL_LEFT 0x109
  31. #define NGUI_KEY_CTRL_RIGHT 0x10A
  32. #define NGUI_KEY_CTRL_DELETE 0x10B
  33. #define NGUI_KEY_CTRL_BACKSPACE 0x10C
  34. #define NGUI_RGB(r, g, b) \
  35. ((unsigned short)((((r) >> 3) << 11) | (((g) >> 2) << 5) | ((b) >> 3)))
  36. struct ufont_face;
  37. struct ngui_rect {
  38. int x, y, w, h;
  39. };
  40. struct ngui_theme {
  41. unsigned short bg;
  42. unsigned short panel;
  43. unsigned short panel_alt;
  44. unsigned short border;
  45. unsigned short text;
  46. unsigned short text_dim;
  47. unsigned short accent;
  48. unsigned short selection;
  49. unsigned short button;
  50. unsigned short button_hot;
  51. unsigned short button_down;
  52. unsigned short icon_folder;
  53. unsigned short icon_file;
  54. unsigned short icon_disk;
  55. unsigned short error;
  56. unsigned short success;
  57. unsigned short warning;
  58. };
  59. extern const struct ngui_theme ngui_theme_dark;
  60. enum ngui_icon {
  61. NGUI_ICON_FOLDER,
  62. NGUI_ICON_FILE,
  63. NGUI_ICON_DISK,
  64. NGUI_ICON_UP,
  65. NGUI_ICON_HOME,
  66. NGUI_ICON_REFRESH,
  67. NGUI_ICON_PLUS,
  68. NGUI_ICON_CHEVRON_LEFT,
  69. NGUI_ICON_CHEVRON_RIGHT
  70. };
  71. struct ngui_input {
  72. char text[NGUI_INPUT_MAX];
  73. unsigned int len;
  74. unsigned int cursor;
  75. unsigned int scroll; /* first visible character */
  76. unsigned int anchor; /* mouse selection anchor (== cursor: none) */
  77. int dragging; /* a press in the field is extending a selection */
  78. int disabled; /* ignore input and paint the value dimmed */
  79. int secret; /* paint '*' per character (passwords) */
  80. const char *placeholder;
  81. unsigned int last_click_ms; /* previous press, for double-click select-all */
  82. };
  83. struct ngui_scroll {
  84. int offset; /* pixels scrolled from the top */
  85. int content_h;
  86. int view_h;
  87. int dragging;
  88. int drag_dy;
  89. };
  90. /* A flat menu panel: the surface, a body rectangle for the caller's widgets
  91. * and a one-line footer for status text. There is no title bar or close
  92. * button; the app is dismissed by clicking outside it or pressing Esc. Use
  93. * on one chromeless canvas window created with u_win_create_popover(). */
  94. struct ngui_popover {
  95. struct ngui_rect body;
  96. struct ngui_rect footer;
  97. };
  98. /* A two-line list row with optional signal bars and right-aligned text. */
  99. struct ngui_row {
  100. const char *title;
  101. const char *subtitle;
  102. const char *trailing;
  103. int bars; /* -1 none, 0..4 signal strength bars */
  104. int selected;
  105. };
  106. struct ngui {
  107. unsigned short *px;
  108. int w, h;
  109. struct ngui_theme theme;
  110. /* Fonts are owned by ufont.c's heap arena. ngui_font_attach() opens
  111. * them; ngui_font_detach() frees the arena (the browser calls it before
  112. * heap_reset()). NULL means the 8x16 bitmap fallback. */
  113. struct ufont_face *font;
  114. struct ufont_face *font_bold;
  115. struct ufont_face *font_italic;
  116. struct ufont_face *font_bold_italic;
  117. struct ufont_face *font_mono;
  118. struct ufont_face *font_emoji; /* lazy fallback face */
  119. int emoji_loaded;
  120. int font_px;
  121. /* Current pointer state, content-relative. */
  122. int mouse_x, mouse_y;
  123. unsigned int buttons;
  124. int inside;
  125. int focused;
  126. /* Scroll accumulated since the previous frame, in pixels. */
  127. int scroll_x, scroll_y;
  128. /* Press/release edges collected by ngui_begin(). */
  129. unsigned int pressed;
  130. unsigned int released;
  131. int press_x, press_y;
  132. int release_x, release_y;
  133. int clicked;
  134. int focus_claimed;
  135. unsigned int hot;
  136. unsigned int active;
  137. unsigned int focus;
  138. struct ngui_rect clip[4];
  139. int nclip;
  140. int dirty;
  141. unsigned int last_blink;
  142. int caret_on;
  143. int keys[32];
  144. unsigned int key_head, key_tail;
  145. int last_mouse_x, last_mouse_y;
  146. int last_inside, last_focused;
  147. /* Pointer motion is throttled: a redraw is needed for hover feedback,
  148. * but not for every 200 Hz mouse report. A pending motion is flushed
  149. * once 33 ms have passed, so the final hover state still appears. */
  150. unsigned int motion_ms;
  151. int motion_pending;
  152. };
  153. void ngui_init(struct ngui *ui, unsigned short *fb, int w, int h);
  154. void ngui_font_attach(struct ngui *ui); /* opens /ramfs/fonts; no-op if absent */
  155. void ngui_font_detach(struct ngui *ui); /* frees the ufont arena */
  156. int ngui_begin(struct ngui *ui); /* 1 = app should redraw */
  157. void ngui_end(struct ngui *ui);
  158. /* Same bookkeeping, but only publish the canvas when `present` is nonzero.
  159. * Lets an app poll input without copying an unchanged frame every loop. */
  160. void ngui_end_ex(struct ngui *ui, int present);
  161. void ngui_invalidate(struct ngui *ui);
  162. void ngui_set_focus(struct ngui *ui, unsigned int id);
  163. unsigned int ngui_focus(struct ngui *ui);
  164. int ngui_key(struct ngui *ui);
  165. int ngui_key_peek(struct ngui *ui);
  166. /* Layout: cut a rectangle off one side of `r` and return the piece. */
  167. struct ngui_rect ngui_cut_top(struct ngui_rect *r, int h);
  168. struct ngui_rect ngui_cut_bottom(struct ngui_rect *r, int h);
  169. struct ngui_rect ngui_cut_left(struct ngui_rect *r, int w);
  170. struct ngui_rect ngui_cut_right(struct ngui_rect *r, int w);
  171. void ngui_inset(struct ngui_rect *r, int n);
  172. int ngui_rect_contains(const struct ngui_rect *r, int x, int y);
  173. /* Primitives. All drawing is clipped to the current clip stack and canvas. */
  174. void ngui_push_clip(struct ngui *ui, struct ngui_rect r);
  175. void ngui_pop_clip(struct ngui *ui);
  176. void ngui_fill_rect(struct ngui *ui, struct ngui_rect r, unsigned short color);
  177. void ngui_frame(struct ngui *ui, struct ngui_rect r, unsigned short color);
  178. void ngui_fill_round_rect(struct ngui *ui, struct ngui_rect r,
  179. int tl, int tr, int br, int bl,
  180. unsigned short color);
  181. void ngui_frame_round(struct ngui *ui, struct ngui_rect r,
  182. int tl, int tr, int br, int bl, int thickness,
  183. unsigned short color);
  184. void ngui_line(struct ngui *ui, int x0, int y0, int x1, int y1,
  185. unsigned short color);
  186. void ngui_text(struct ngui *ui, int x, int y, const char *s,
  187. unsigned short color);
  188. void ngui_text_n(struct ngui *ui, int x, int y, const char *s,
  189. unsigned int n, unsigned short color);
  190. /* UTF-8 variants with the primary face -> emoji fallback stack. */
  191. void ngui_text_utf8(struct ngui *ui, int x, int y, const char *s,
  192. unsigned short color);
  193. void ngui_text_n_utf8(struct ngui *ui, int x, int y, const char *s,
  194. unsigned int n, unsigned short color);
  195. unsigned int ngui_text_width_utf8(struct ngui *ui, const char *s);
  196. void ngui_text_ellipsis_utf8(struct ngui *ui, struct ngui_rect r,
  197. int x, int y, const char *s,
  198. unsigned short color);
  199. void ngui_text_styled(struct ngui *ui, int x, int y, const char *s,
  200. unsigned int n, unsigned short color, int scale, int bold);
  201. /* Browser-oriented style: arbitrary pixel size, optional italic and mono. */
  202. void ngui_text_px(struct ngui *ui, int x, int y, const char *s,
  203. unsigned int n, unsigned short color, int px, int bold,
  204. int italic, int mono);
  205. void ngui_text_rot180(struct ngui *ui, int x, int y, const char *s,
  206. unsigned int n, unsigned short color);
  207. void ngui_text_ellipsis(struct ngui *ui, struct ngui_rect r, int x, int y,
  208. const char *s, unsigned short color);
  209. unsigned int ngui_text_width(const char *s);
  210. unsigned int ngui_text_width_n(const char *s, unsigned int n, int scale);
  211. unsigned int ngui_text_width_ui(struct ngui *ui, const char *s);
  212. unsigned int ngui_text_width_px(struct ngui *ui, const char *s, unsigned int n,
  213. int px, int bold, int italic, int mono);
  214. int ngui_text_ascent(struct ngui *ui, int px, int mono);
  215. int ngui_text_line_height(struct ngui *ui, int px, int mono);
  216. /* Face-aware variants: a non-NULL `face` (an @font-face loaded by the
  217. * caller) overrides the built-in regular/bold/italic/mono selection. */
  218. unsigned int ngui_text_width_face(struct ngui *ui, struct ufont_face *face,
  219. const char *s, unsigned int n, int px,
  220. int bold, int italic, int mono);
  221. int ngui_text_ascent_face(struct ngui *ui, struct ufont_face *face, int px,
  222. int mono);
  223. int ngui_text_line_height_face(struct ngui *ui, struct ufont_face *face,
  224. int px, int mono);
  225. void ngui_text_px_face(struct ngui *ui, struct ufont_face *face, int x,
  226. int y, const char *s, unsigned int n,
  227. unsigned short color, int px, int bold, int italic,
  228. int mono);
  229. void ngui_icon(struct ngui *ui, struct ngui_rect r, enum ngui_icon icon,
  230. unsigned short color);
  231. /* Widgets. IDs must be stable across frames. */
  232. int ngui_button(struct ngui *ui, unsigned int id, struct ngui_rect r,
  233. const char *label);
  234. int ngui_menu_item(struct ngui *ui, unsigned int id, struct ngui_rect r,
  235. const char *label, const char *shortcut, int checked);
  236. int ngui_menu_item_utf8(struct ngui *ui, unsigned int id, struct ngui_rect r,
  237. const char *label, const char *shortcut, int checked);
  238. int ngui_icon_button(struct ngui *ui, unsigned int id, struct ngui_rect r,
  239. enum ngui_icon icon);
  240. /* Menu panel component (see struct ngui_popover). */
  241. void ngui_popover_begin(struct ngui *ui, struct ngui_popover *p);
  242. void ngui_popover_footer(struct ngui *ui, const struct ngui_popover *p,
  243. const char *text, unsigned short color);
  244. /* Section caption with an optional right-aligned action button; returns 1
  245. * when the action fired. */
  246. int ngui_section(struct ngui *ui, struct ngui_rect r, const char *caption,
  247. unsigned int action_id, const char *action);
  248. int ngui_list_row(struct ngui *ui, unsigned int id, struct ngui_rect r,
  249. const struct ngui_row *row);
  250. int ngui_list_row_utf8(struct ngui *ui, unsigned int id, struct ngui_rect r,
  251. const struct ngui_row *row);
  252. void ngui_signal_bars(struct ngui *ui, struct ngui_rect r, int bars,
  253. unsigned short color);
  254. int ngui_text_input(struct ngui *ui, unsigned int id, struct ngui_rect r,
  255. struct ngui_input *in);
  256. void ngui_input_set(struct ngui_input *in, const char *s);
  257. /* Copy a field's real value out (a secret field's '*' mask is bypassed). */
  258. void ngui_input_value(const struct ngui_input *in, char *out,
  259. unsigned int max);
  260. /* Scrolling pane: call begin, draw the content with scroll->offset, end. */
  261. void ngui_scroll_begin(struct ngui *ui, struct ngui_rect r,
  262. struct ngui_scroll *s);
  263. void ngui_scroll_end(struct ngui *ui, struct ngui_rect r,
  264. struct ngui_scroll *s);
  265. /* Apply pending wheel/touchpad scroll to s when the pointer is over r and
  266. * consume it. Call after ngui_scroll_begin() set view_h/content_h. */
  267. int ngui_scroll_wheel(struct ngui *ui, struct ngui_rect r,
  268. struct ngui_scroll *s);
  269. void ngui_scroll_to(struct ngui_scroll *s, int offset);
  270. void ngui_scroll_ensure_visible(struct ngui_scroll *s, int y, int h);
  271. int ngui_scroll_keys(struct ngui *ui, struct ngui_scroll *s);
  272. #endif