ngui.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314
  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. struct ngui_slider {
  91. int dragging;
  92. };
  93. /* A flat menu panel: the surface, a body rectangle for the caller's widgets
  94. * and a one-line footer for status text. There is no title bar or close
  95. * button; the app is dismissed by clicking outside it or pressing Esc. Use
  96. * on one chromeless canvas window created with u_win_create_popover(). */
  97. struct ngui_popover {
  98. struct ngui_rect body;
  99. struct ngui_rect footer;
  100. };
  101. /* A two-line list row with optional signal bars and right-aligned text. */
  102. struct ngui_row {
  103. const char *title;
  104. const char *subtitle;
  105. const char *trailing;
  106. int bars; /* -1 none, 0..4 signal strength bars */
  107. int selected;
  108. };
  109. struct ngui {
  110. unsigned short *px;
  111. int w, h;
  112. struct ngui_theme theme;
  113. /* Fonts are owned by ufont.c's heap arena. ngui_font_attach() opens
  114. * them; ngui_font_detach() frees the arena (the browser calls it before
  115. * heap_reset()). NULL means the 8x16 bitmap fallback. */
  116. struct ufont_face *font;
  117. struct ufont_face *font_bold;
  118. struct ufont_face *font_italic;
  119. struct ufont_face *font_bold_italic;
  120. struct ufont_face *font_mono;
  121. struct ufont_face *font_emoji; /* lazy fallback face */
  122. int emoji_loaded;
  123. int font_px;
  124. /* Current pointer state, content-relative. */
  125. int mouse_x, mouse_y;
  126. unsigned int buttons;
  127. int inside;
  128. int focused;
  129. /* Scroll accumulated since the previous frame, in pixels. */
  130. int scroll_x, scroll_y;
  131. /* Press/release edges collected by ngui_begin(). */
  132. unsigned int pressed;
  133. unsigned int released;
  134. int press_x, press_y;
  135. int release_x, release_y;
  136. int clicked;
  137. int focus_claimed;
  138. unsigned int hot;
  139. unsigned int active;
  140. unsigned int focus;
  141. struct ngui_rect clip[4];
  142. int nclip;
  143. int dirty;
  144. unsigned int last_blink;
  145. int caret_on;
  146. int keys[32];
  147. unsigned int key_head, key_tail;
  148. int last_mouse_x, last_mouse_y;
  149. int last_inside, last_focused;
  150. /* Pointer motion is throttled: a redraw is needed for hover feedback,
  151. * but not for every 200 Hz mouse report. A pending motion is flushed
  152. * once 33 ms have passed, so the final hover state still appears. */
  153. unsigned int motion_ms;
  154. int motion_pending;
  155. };
  156. void ngui_init(struct ngui *ui, unsigned short *fb, int w, int h);
  157. void ngui_font_attach(struct ngui *ui); /* opens /ramfs/fonts; no-op if absent */
  158. void ngui_font_detach(struct ngui *ui); /* frees the ufont arena */
  159. int ngui_begin(struct ngui *ui); /* 1 = app should redraw */
  160. void ngui_end(struct ngui *ui);
  161. /* Same bookkeeping, but only publish the canvas when `present` is nonzero.
  162. * Lets an app poll input without copying an unchanged frame every loop. */
  163. void ngui_end_ex(struct ngui *ui, int present);
  164. void ngui_invalidate(struct ngui *ui);
  165. void ngui_set_focus(struct ngui *ui, unsigned int id);
  166. unsigned int ngui_focus(struct ngui *ui);
  167. int ngui_key(struct ngui *ui);
  168. int ngui_key_peek(struct ngui *ui);
  169. /* Layout: cut a rectangle off one side of `r` and return the piece. */
  170. struct ngui_rect ngui_cut_top(struct ngui_rect *r, int h);
  171. struct ngui_rect ngui_cut_bottom(struct ngui_rect *r, int h);
  172. struct ngui_rect ngui_cut_left(struct ngui_rect *r, int w);
  173. struct ngui_rect ngui_cut_right(struct ngui_rect *r, int w);
  174. void ngui_inset(struct ngui_rect *r, int n);
  175. int ngui_rect_contains(const struct ngui_rect *r, int x, int y);
  176. /* Primitives. All drawing is clipped to the current clip stack and canvas. */
  177. void ngui_push_clip(struct ngui *ui, struct ngui_rect r);
  178. void ngui_pop_clip(struct ngui *ui);
  179. void ngui_fill_rect(struct ngui *ui, struct ngui_rect r, unsigned short color);
  180. void ngui_frame(struct ngui *ui, struct ngui_rect r, unsigned short color);
  181. void ngui_fill_round_rect(struct ngui *ui, struct ngui_rect r,
  182. int tl, int tr, int br, int bl,
  183. unsigned short color);
  184. void ngui_frame_round(struct ngui *ui, struct ngui_rect r,
  185. int tl, int tr, int br, int bl, int thickness,
  186. unsigned short color);
  187. void ngui_line(struct ngui *ui, int x0, int y0, int x1, int y1,
  188. unsigned short color);
  189. void ngui_text(struct ngui *ui, int x, int y, const char *s,
  190. unsigned short color);
  191. void ngui_text_n(struct ngui *ui, int x, int y, const char *s,
  192. unsigned int n, unsigned short color);
  193. /* UTF-8 variants with the primary face -> emoji fallback stack. */
  194. void ngui_text_utf8(struct ngui *ui, int x, int y, const char *s,
  195. unsigned short color);
  196. void ngui_text_n_utf8(struct ngui *ui, int x, int y, const char *s,
  197. unsigned int n, unsigned short color);
  198. unsigned int ngui_text_width_utf8(struct ngui *ui, const char *s);
  199. void ngui_text_ellipsis_utf8(struct ngui *ui, struct ngui_rect r,
  200. int x, int y, const char *s,
  201. unsigned short color);
  202. void ngui_text_styled(struct ngui *ui, int x, int y, const char *s,
  203. unsigned int n, unsigned short color, int scale, int bold);
  204. /* Browser-oriented style: arbitrary pixel size, optional italic and mono. */
  205. void ngui_text_px(struct ngui *ui, int x, int y, const char *s,
  206. unsigned int n, unsigned short color, int px, int bold,
  207. int italic, int mono);
  208. void ngui_text_rot180(struct ngui *ui, int x, int y, const char *s,
  209. unsigned int n, unsigned short color);
  210. void ngui_text_ellipsis(struct ngui *ui, struct ngui_rect r, int x, int y,
  211. const char *s, unsigned short color);
  212. unsigned int ngui_text_width(const char *s);
  213. unsigned int ngui_text_width_n(const char *s, unsigned int n, int scale);
  214. unsigned int ngui_text_width_ui(struct ngui *ui, const char *s);
  215. unsigned int ngui_text_width_px(struct ngui *ui, const char *s, unsigned int n,
  216. int px, int bold, int italic, int mono);
  217. int ngui_text_ascent(struct ngui *ui, int px, int mono);
  218. int ngui_text_line_height(struct ngui *ui, int px, int mono);
  219. /* Face-aware variants: a non-NULL `face` (an @font-face loaded by the
  220. * caller) overrides the built-in regular/bold/italic/mono selection. */
  221. unsigned int ngui_text_width_face(struct ngui *ui, struct ufont_face *face,
  222. const char *s, unsigned int n, int px,
  223. int bold, int italic, int mono);
  224. int ngui_text_ascent_face(struct ngui *ui, struct ufont_face *face, int px,
  225. int mono);
  226. int ngui_text_line_height_face(struct ngui *ui, struct ufont_face *face,
  227. int px, int mono);
  228. void ngui_text_px_face(struct ngui *ui, struct ufont_face *face, int x,
  229. int y, const char *s, unsigned int n,
  230. unsigned short color, int px, int bold, int italic,
  231. int mono);
  232. void ngui_icon(struct ngui *ui, struct ngui_rect r, enum ngui_icon icon,
  233. unsigned short color);
  234. /* Widgets. IDs must be stable across frames. */
  235. int ngui_button(struct ngui *ui, unsigned int id, struct ngui_rect r,
  236. const char *label);
  237. int ngui_menu_item(struct ngui *ui, unsigned int id, struct ngui_rect r,
  238. const char *label, const char *shortcut, int checked);
  239. int ngui_menu_item_utf8(struct ngui *ui, unsigned int id, struct ngui_rect r,
  240. const char *label, const char *shortcut, int checked);
  241. int ngui_icon_button(struct ngui *ui, unsigned int id, struct ngui_rect r,
  242. enum ngui_icon icon);
  243. /* Menu panel component (see struct ngui_popover). */
  244. void ngui_popover_begin(struct ngui *ui, struct ngui_popover *p);
  245. void ngui_popover_footer(struct ngui *ui, const struct ngui_popover *p,
  246. const char *text, unsigned short color);
  247. /* Section caption with an optional right-aligned action button; returns 1
  248. * when the action fired. */
  249. int ngui_section(struct ngui *ui, struct ngui_rect r, const char *caption,
  250. unsigned int action_id, const char *action);
  251. int ngui_list_row(struct ngui *ui, unsigned int id, struct ngui_rect r,
  252. const struct ngui_row *row);
  253. int ngui_list_row_utf8(struct ngui *ui, unsigned int id, struct ngui_rect r,
  254. const struct ngui_row *row);
  255. void ngui_signal_bars(struct ngui *ui, struct ngui_rect r, int bars,
  256. unsigned short color);
  257. /* A two-line quick-settings tile (rounded, active when `on`). */
  258. int ngui_tile(struct ngui *ui, unsigned int id, struct ngui_rect r,
  259. const char *title, const char *subtitle, int on);
  260. /* Horizontal slider; writes *value and returns 1 when it changed. */
  261. int ngui_slider(struct ngui *ui, unsigned int id, struct ngui_slider *s,
  262. struct ngui_rect r, int *value, int min, int max);
  263. int ngui_text_input(struct ngui *ui, unsigned int id, struct ngui_rect r,
  264. struct ngui_input *in);
  265. void ngui_input_set(struct ngui_input *in, const char *s);
  266. /* Copy a field's real value out (a secret field's '*' mask is bypassed). */
  267. void ngui_input_value(const struct ngui_input *in, char *out,
  268. unsigned int max);
  269. /* Scrolling pane: call begin, draw the content with scroll->offset, end. */
  270. void ngui_scroll_begin(struct ngui *ui, struct ngui_rect r,
  271. struct ngui_scroll *s);
  272. void ngui_scroll_end(struct ngui *ui, struct ngui_rect r,
  273. struct ngui_scroll *s);
  274. /* Apply pending wheel/touchpad scroll to s when the pointer is over r and
  275. * consume it. Call after ngui_scroll_begin() set view_h/content_h. */
  276. int ngui_scroll_wheel(struct ngui *ui, struct ngui_rect r,
  277. struct ngui_scroll *s);
  278. void ngui_scroll_to(struct ngui_scroll *s, int offset);
  279. void ngui_scroll_ensure_visible(struct ngui_scroll *s, int y, int h);
  280. int ngui_scroll_keys(struct ngui *ui, struct ngui_scroll *s);
  281. #endif