1 /* src/client/windows.c
3 * This file is part of PlomRogue. PlomRogue is licensed under the GPL version 3
4 * or any later version. For details on its copyright, license, and warranties,
5 * see the file NOTICE in the root directory of the PlomRogue source package.
8 #define _POSIX_C_SOURCE 200809L /* strnlen() */
10 #include <ncurses.h> /* chtype, getmaxx(), getmaxy(), erase(), werase(),
11 * endwin(), delwin(), wnoutrefresh(), pnoutrefresh(),
12 * doupdate(), refresh(), delwin(), newpad(), mvwaddch(),
15 #include <stddef.h> /* NULL */
16 #include <stdint.h> /* uint8_t, uint16_t, uint32_t, UINT16_MAX */
17 #include <stdio.h> /* sprintf() */
18 #include <stdlib.h> /* free() */
19 #include <string.h> /* memcpy(), strlen(), strnlen(), memset() */
20 #include "../common/rexit.h" /* exit_trouble(), exit_err() */
21 #include "../common/try_malloc.h" /* try_malloc() */
22 #include "draw_wins.h" /* draw_winconf_geometry(), draw_winconf_keybindings(),
23 * draw_win_inventory(), draw_win_info(), draw_win_log(),
24 * draw_win_available_keybindings(), draw_win_map(),
25 * draw_win_keybindings_winconf_keybindings(),
26 * draw_win_keybindings_winconf_geometry(),
27 * draw_win_keybindings_global()
29 #include "wincontrol.h" /* toggle_window() */
30 #include "world.h" /* world */
34 /* Calculate "id"'s window's size from v_screen size and .target_(height/width).
35 * A .target_width == 0 makes the window as wide as .t_screen. .target_height ==
36 * 0 sets the maximum allowed height: one cell smaller than that of .v_screen.
37 * Negative values make width/height so many cells smaller than what 0 would
38 * set. Values that would reduce the window height or width to less than 1 cell
39 * according to the aforementioned rules set the height/width as if they were 0.
41 static void init_win_size_from_winconf_and_v_screen_size(char id);
43 /* Get (Win->draw) function identified by "c"; NULL if c not mapped to one.
44 * match_func() is just a little helper to it.
46 static uint8_t match_func(char c, void (** f) (), char c_m, void (* f_m) ());
47 static void (* get_drawfunc_by_char(char c)) ();
49 /* Iterate over chars of world.winDB.ids array / string. Restart after \0.*/
50 static char get_next_win_id();
52 /* Draw scroll hint (a line saying that there are "dist" more elements of "unit"
53 * further into the direction symbolized by "dir") into .v_screen, onto an
54 * appropriate edge of a window or .v_screen; the left/right edge if "dir" is
55 * "<"/">", or the top/bottom edge if it is "^"/"v". Use "start" as the start
56 * coordinate of the frame that is to contain the scroll hints. winscroll_hint()
57 * is a wrapper that uses the border of window "w" as this frame.
59 static void scroll_hint(struct yx_uint16 fsize, char dir, uint16_t dist,
60 char * unit, struct yx_uint16 start);
61 static void winscroll_hint(struct Win * w, char dir, uint16_t dist);
63 /* draw_win_borderlines() draws vertical/horizontal borders of window "w" sans
64 * corners into .v_screen. It draws the top border line as the windows' title
65 * bar (highlighted if the window is selected as active). It is called
66 * recursively by draw_wins_borderlines() on all windows from "w" on.
67 * draw_wins_bordercorners() draws the border corners of "w" and its successors.
69 static void draw_win_borderlines(struct Win * w);
70 static void draw_wins_borderlines(struct Win * w);
71 static void draw_wins_bordercorners(struct Win * w);
73 /* Draw contents of all windows in window chain from window "w" onwards. */
74 static void draw_wins(struct Win * w);
78 static void init_win_size_from_winconf_and_v_screen_size(char id)
80 struct Win * w = get_win_by_id(id);
81 w->frame_size.y = world.winDB.v_screen_size.y - 1;
82 if ( 0 < w->target_height
83 && w->target_height <= world.winDB.v_screen_size.y - 1)
85 w->frame_size.y = w->target_height;
87 else if ( 0 > w->target_height
88 && world.winDB.v_screen_size.y + (w->target_height - 1) > 0)
90 w->frame_size.y = world.winDB.v_screen_size.y + (w->target_height - 1);
92 w->frame_size.x = world.winDB.v_screen_size.x;
93 if (0 < w->target_width)
95 w->frame_size.x = w->target_width;
97 else if ( 0 > w->target_width
98 && world.winDB.v_screen_size.x + w->target_width > 0)
100 w->frame_size.x = world.winDB.v_screen_size.x + w->target_width;
106 static uint8_t match_func(char c, void (** f) (), char c_m, void (* f_m) ())
118 static void (* get_drawfunc_by_char(char c)) ()
120 void (* f) (struct Win *) = NULL;
121 if ( match_func(c, &f, 'c', draw_win_inventory)
122 || match_func(c, &f, 'i', draw_win_info)
123 || match_func(c, &f, 'l', draw_win_log)
124 || match_func(c, &f, 'k', draw_win_available_keybindings)
125 || match_func(c, &f, 'm', draw_win_map)
126 || match_func(c, &f, '0', draw_win_keybindings_global)
127 || match_func(c, &f, '1', draw_win_keybindings_winconf_geometry)
128 || match_func(c, &f, '2', draw_win_keybindings_winconf_keybindings))
137 static char get_next_win_id()
139 static uint8_t i = 0;
140 char c = world.winDB.ids[i];
152 static void scroll_hint(struct yx_uint16 fsize, char dir, uint16_t dist,
153 char * unit, struct yx_uint16 start)
155 /* Decide on alignment (vertical/horizontal?), thereby hint text space. */
156 char * more = "more";
157 uint16_t dsc_space = fsize.x;
158 if ('<' == dir || '>' == dir)
161 } /* vv-- 10 = max strlen for uint16_t */
162 uint16_t size = 1 + strlen(more) + 1 + 10 + 1 + strlen(unit) + 1 + 1;
163 char * scrolldsc = try_malloc(size, __func__);
164 int test = sprintf(scrolldsc, " %d %s %s ", dist, more, unit);
165 exit_trouble(test < 0, __func__, "sprintf");
167 /* Decide on offset of the description text inside the scroll hint line. */
168 uint16_t dsc_offset = 1;
169 if (dsc_space > strlen(scrolldsc) + 1)
171 dsc_offset = (dsc_space - strlen(scrolldsc)) / 2;
174 /* Draw scroll hint line as dir symbols bracketing description text. */
175 uint16_t draw_offset = 0;
178 draw_offset = fsize.x - 1;
182 draw_offset = fsize.y - 1;
185 for (; q < dsc_space; q++)
187 chtype c = dir | A_REVERSE;
188 if (q >= dsc_offset && q < strlen(scrolldsc) + dsc_offset)
190 c = scrolldsc[q - dsc_offset] | A_REVERSE;
192 if ('<' == dir || '>' == dir)
194 mvwaddch(world.winDB.v_screen, start.y+q, start.x+draw_offset, c);
197 mvwaddch(world.winDB.v_screen, start.y + draw_offset, start.x + q, c);
204 static void winscroll_hint(struct Win * w, char dir, uint16_t dist)
206 char * unit = "lines";
207 if ('<' == dir || '>' == dir)
211 struct yx_uint16 start = w->start;
212 scroll_hint(w->frame_size, dir, dist, unit, start);
217 static void draw_win_borderlines(struct Win * w)
219 /* Draw vertical and horizontal border lines. */
221 for (y = w->start.y; y <= w->start.y + w->frame_size.y; y++)
223 mvwaddch(world.winDB.v_screen, y, w->start.x - 1, '|');
224 mvwaddch(world.winDB.v_screen, y, w->start.x + w->frame_size.x, '|');
226 for (x = w->start.x; x <= w->start.x + w->frame_size.x; x++)
228 mvwaddch(world.winDB.v_screen, w->start.y - 1, x, '-');
229 mvwaddch(world.winDB.v_screen, w->start.y + w->frame_size.y, x, '-');
232 /* Draw as much as possible of the title into center of top border line. */
233 uint8_t min_title_length_visible = 3;/* min. 1 char +2 padding/decoration*/
234 if (w->frame_size.x >= min_title_length_visible)
237 if (w->frame_size.x > strlen(w->title) + 2)
239 offset = (w->frame_size.x - (strlen(w->title) + 2)) / 2;
240 } /* +2 is for padding/decoration */
241 uint16_t length_visible = strnlen(w->title, w->frame_size.x - 2);
242 char * title = try_malloc(length_visible + 3, "draw_win_borderlines");
243 char decoration = ' ';
244 if (w->id == world.winDB.active)
248 memcpy(title + 1, w->title, length_visible);
249 title[0] = title[length_visible + 1] = decoration;
250 title[length_visible + 2] = '\0';
251 mvwaddstr(world.winDB.v_screen, w->start.y-1, w->start.x+offset, title);
258 static void draw_wins_borderlines(struct Win * w)
260 draw_win_borderlines(w);
261 struct Win * next = get_win_after(w->id);
264 draw_wins_borderlines(next);
270 static void draw_wins_bordercorners(struct Win * w)
272 mvwaddch(world.winDB.v_screen,
273 w->start.y - 1, w->start.x - 1, '+');
274 mvwaddch(world.winDB.v_screen,
275 w->start.y - 1, w->start.x + w->frame_size.x, '+');
276 mvwaddch(world.winDB.v_screen,
277 w->start.y + w->frame_size.y, w->start.x - 1, '+');
278 mvwaddch(world.winDB.v_screen, w->start.y + w->frame_size.y,
279 w->start.x + w->frame_size.x, '+');
280 struct Win * next = get_win_after(w->id);
283 draw_wins_bordercorners(next);
289 static void draw_wins(struct Win * w)
291 void (* drawfunc) (struct Win *) = get_drawfunc_by_char(w->id);
294 drawfunc = draw_winconf_geometry;
296 else if (2 == w->view)
298 drawfunc = draw_winconf_keybindings;
301 uint16_t size_y = w->winmap_size.y;
302 uint16_t size_x = w->winmap_size.x;
303 uint16_t offset_y = center_offset(w->center.y, size_y, w->frame_size.y);
304 uint16_t offset_x = center_offset(w->center.x, size_x, w->frame_size.x);
306 for (y = offset_y; y < w->frame_size.y + offset_y && y < size_y; y++)
308 for (x = offset_x; x < w->frame_size.x + offset_x && x < size_x; x++)
310 chtype ch = w->winmap[(y * w->winmap_size.x) + x];
311 mvwaddch(world.winDB.v_screen, w->start.y + (y - offset_y),
312 w->start.x + (x - offset_x), ch);
315 free(w->winmap); /* NULL so draw_wins.c's try_resize_winmap() may always */
316 w->winmap = NULL;/* free() it before (re-)allocation, even the first time.*/
317 memset(&w->winmap_size, 0, sizeof(struct yx_uint16));
320 winscroll_hint(w, '^', offset_y + 1);
322 if (size_y > offset_y + w->frame_size.y)
324 winscroll_hint(w, 'v', size_y - ((offset_y + w->frame_size.y) - 1));
328 winscroll_hint(w, '<', offset_x + 1);
330 if (size_x > offset_x + w->frame_size.x)
332 winscroll_hint(w, '>', size_x - ((offset_x + w->frame_size.x) - 1));
334 struct Win * next = get_win_after(w->id);
343 extern uint8_t get_win_pos_in_order(char c)
346 for (i = 0; c != world.winDB.order[i]; i++);
352 extern struct Win * get_win_after(char c)
354 return get_win_by_id(world.winDB.order[get_win_pos_in_order(c) + 1]);
359 extern uint16_t center_offset(uint16_t position, uint32_t mapsize,
363 if (mapsize > frame_size)
365 if (position > frame_size / 2)
367 if (position < mapsize - (frame_size / 2))
369 offset = position - (frame_size / 2);
373 offset = mapsize - frame_size;
382 extern struct Win * get_win_by_id(char id)
385 while ('\0' != world.winDB.ids[i])
387 if (id == world.winDB.ids[i])
389 return &world.winDB.wins[i];
398 extern void make_v_screen_and_init_win_sizes()
400 char * err_s = "creating an illegaly large virtual screen";
401 char * err_m = "triggering a memory allocation error via newpad";
402 uint32_t maxy_test = getmaxy(world.winDB.t_screen);
403 uint32_t maxx_test = getmaxx(world.winDB.t_screen);
404 exit_trouble(maxy_test>UINT16_MAX || maxx_test>UINT16_MAX, __func__, err_s);
405 world.winDB.v_screen_size.y = maxy_test;
406 world.winDB.v_screen_size.x = maxx_test;
407 world.winDB.v_screen = newpad(world.winDB.v_screen_size.y, 1);
408 exit_trouble(!world.winDB.v_screen, __func__, err_m);
410 while (0 != (id = get_next_win_id()))
412 init_win_size_from_winconf_and_v_screen_size(id);
418 extern void free_winDB()
421 while (0 != (id = get_next_win_id()))
423 struct Win * wc = get_win_by_id(id);
427 free(world.winDB.ids);
428 free(world.winDB.wins);
429 free(world.winDB.order);
434 extern void winch_called()
441 extern void reset_windows_on_winch()
443 endwin(); /* "[S]tandard way" to recalibrate ncurses post SIGWINCH, says */
444 refresh(); /* <http://invisible-island.net/ncurses/ncurses-intro.html>. */
445 char * tmp_order = try_malloc(strlen(world.winDB.order) + 1, __func__);
446 int test = sprintf(tmp_order, "%s", world.winDB.order);
447 exit_trouble(test < 0, __func__, "sprintf");
449 char tmp_active = world.winDB.active;
450 for (i = 0; i < strlen(tmp_order); toggle_window(tmp_order[i]), i++);
451 delwin(world.winDB.v_screen);
452 make_v_screen_and_init_win_sizes();
453 for (i = 0; i < strlen(tmp_order); toggle_window(tmp_order[i]), i++);
455 world.winDB.active = tmp_active;
460 extern void draw_all_wins()
462 /* Empty everything before filling it a-new. */
464 wnoutrefresh(world.winDB.t_screen);
465 werase(world.winDB.v_screen);
466 if (world.winDB.active)
469 /* Draw borders, wins. Order matters: corners should overwrite lines. */
470 draw_wins_borderlines(get_win_by_id(world.winDB.order[0]));
471 draw_wins_bordercorners(get_win_by_id(world.winDB.order[0]));
472 draw_wins(get_win_by_id(world.winDB.order[0]));
474 /* Draw .v_screen scroll hints. */
475 struct yx_uint16 start;
477 start.x = world.winDB.v_screen_offset;
478 char * cols_string = "columns";
479 if (world.winDB.v_screen_offset > 0)
481 scroll_hint(world.winDB.v_screen_size, '<',
482 world.winDB.v_screen_offset + 1, cols_string, start);
484 uint16_t size_x = getmaxx(world.winDB.v_screen);
485 uint16_t right_edge = world.winDB.v_screen_offset
486 + world.winDB.v_screen_size.x;
487 if (right_edge < size_x - 1)
489 scroll_hint(world.winDB.v_screen_size, '>',
490 size_x - right_edge, cols_string, start);
493 /* Put .v_screen segment to be shown on .t_screen to .t_screen buffer.*/
494 pnoutrefresh(world.winDB.v_screen, 0, world.winDB.v_screen_offset, 0, 0,
495 world.winDB.v_screen_size.y,
496 world.winDB.v_screen_size.x - 1);
499 /* Only at the end write accumulated changes to .t_screen. */