home · contact · privacy
License everything (GPL).
[plomrogue] / src / client / draw_wins.c
1 /* src/client/draw_wins.c
2  *
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.
6  */
7
8 #define _POSIX_C_SOURCE 200809L /* strdup() */
9 #include "draw_wins.h"
10 #include <ncurses.h> /* attr_t, chtype, init_pair(), A_REVERSE, COLOR_PAIR() */
11 #include <stddef.h> /* NULL */
12 #include <stdint.h> /* uint8_t, uint16_t, uint32_t, UINT16_MAX */
13 #include <stdio.h> /* sprintf() */
14 #include <stdlib.h> /* free() */
15 #include <string.h> /* memset(), strchr(), strdup/(), strlen() */
16 #include "../common/rexit.h" /* exit_err(), exit_trouble() */
17 #include "../common/try_malloc.h" /* try_malloc() */
18 #include "keybindings.h" /* struct KeyBindingDB, get_keyname_to_keycode() */
19 #include "windows.h" /* yx_uint16, Win, get_win_by_id() */
20 #include "world.h" /* global world */
21
22
23
24 /* Apply to the winmap of Win "w" the new sizes "new_size_y" and "new_size_x"
25  * to the degree that they extend it. Re-shape the window content accordingly.
26  */
27 static void try_resize_winmap(struct Win * w, int new_size_y, int new_size_x);
28
29 /* In Win "w", write "ch" to coordinate "y"/"x". */
30 static void set_ch_on_yx(struct Win * w, int y, int x, chtype ch);
31
32 /* Add "line" into window "w" with "attri" set on all chars. add_line() selects
33  * one of the other three functions based on the "win"->linebreak mode.
34  *
35  * "wide" writes lines to full width without in-between breaks. "long" breaks
36  * lines on the right window border. "compact" replaces newlines with printable
37  * separator characters. "offset" and "last" are only relevant to the "compact"
38  * mode. "offset" reports the horizontal offset at which the line is drawn from
39  * the lowest existing winmap line on; it is updated to the next offset after
40  * the new line, to be used by the next add_line_compact() call. "last" marks
41  * the line to add as the last in the window, so no further separator is added.
42  */
43 static void add_line(struct Win * win, char * line, attr_t attri,
44                      uint16_t * offset, uint8_t last);
45 static void add_line_wide(struct Win * win, char * line, attr_t attri);
46 static void add_line_long(struct Win * win, char * line, attr_t attri);
47 static void add_line_compact(struct Win * win, char * line, attr_t attri,
48                              uint16_t * offset, uint8_t last);
49
50 /* Add linebreaks-containing "text" to "win", formatted as per "win"->linebreak.
51  *
52  * draw_text_from_bottom() prepends empty lines to "text" to push its last line
53  * to the low frame edge when the frame is of greater height than the winmap
54  * would be otherwise; else, set "win"->center.y to the winmap's lowest line.
55  */
56 static void add_text_with_linebreaks(struct Win * win, char * text);
57 static void draw_text_from_bottom(struct Win * win, char * text);
58
59 /* Return a properly formatted keybinding list line for "kb". */
60 static char * get_kb_line(struct KeyBinding * kb);
61
62 /* Draw from line "start" on config view for keybindings defined at "kb". */
63 static void draw_keybinding_config(struct Win * win, struct KeyBindingDB * kbdb,
64                                    uint16_t offset);
65
66 /* Draw into window "w" from line "start" on a "title" followed by an empty
67  * line followed by a list of all keybindings starting in "kbdb".
68  */
69 static void draw_titled_keybinding_list(char * title, struct Win * win,
70                                         uint16_t * offset, uint8_t last,
71                                         struct KeyBindingDB * kbdb);
72
73
74
75 static void try_resize_winmap(struct Win * win, int new_size_y, int new_size_x)
76 {
77     if (win->winmap_size.y >= new_size_y && win->winmap_size.x >= new_size_x)
78     {
79         return;
80     }
81     if      (win->winmap_size.y > new_size_y)
82     {
83         new_size_y = win->winmap_size.y;
84     }
85     else if (win->winmap_size.x > new_size_x)
86     {
87         new_size_x = win->winmap_size.x;
88     }
89     chtype * old_winmap = win->winmap;
90     uint32_t new_size = sizeof(chtype) * new_size_y * new_size_x;
91     win->winmap = try_malloc(new_size, __func__);
92     uint16_t y, x;
93     for (y = 0; y < new_size_y; y++)
94     {
95         for (x = 0; y < win->winmap_size.y && x < win->winmap_size.x; x++)
96         {
97             chtype ch = old_winmap[(y * win->winmap_size.x) + x];
98             win->winmap[(y * new_size_x) + x] = ch;
99         }
100         for (; x < new_size_x; x++)
101         {
102             win->winmap[(y * new_size_x) + x] = ' ';
103         }
104     }
105     free(old_winmap);
106     win->winmap_size.y = new_size_y;
107     win->winmap_size.x = new_size_x;
108 }
109
110
111
112 static void set_ch_on_yx(struct Win * win, int y, int x, chtype ch)
113 {
114     win->winmap[(y * win->winmap_size.x) + x] = ch;
115 }
116
117
118
119 static void add_line(struct Win * win, char * line, attr_t attri,
120                      uint16_t * offset, uint8_t last)
121 {
122     exit_err(strlen(line) > UINT16_MAX, "Line in add_line() too big.");
123     if      (0 == win->linebreak)
124     {
125         add_line_long(win, line, attri);
126     }
127     else if (1 == win->linebreak)
128     {
129         add_line_wide(win, line, attri);
130     }
131     else if (2 == win->linebreak)
132     {
133         add_line_compact(win, line, attri, offset, last);
134     }
135 }
136
137
138
139 static void add_line_wide(struct Win * win, char * line, attr_t attri)
140 {
141     uint16_t y_start = win->winmap_size.y;
142     uint16_t len_line = strlen(line);
143     try_resize_winmap(win, y_start + 1, win->frame_size.x);
144     try_resize_winmap(win, y_start + 1, len_line);
145     uint16_t x;
146     for (x = 0; x < len_line; x++)
147     {
148         set_ch_on_yx(win, y_start, x, line[x] | attri);
149     }
150     if (attri)
151     {
152         for (; x < win->frame_size.x; x++)
153         {
154             set_ch_on_yx(win, y_start, x, ' ' | attri);
155         }
156     }
157 }
158
159
160
161 static void add_line_long(struct Win * win, char * line, attr_t attri)
162 {
163     uint16_t y_start = win->winmap_size.y;
164     uint16_t len_line = strlen(line);
165     try_resize_winmap(win, y_start + 1, win->frame_size.x);
166     uint16_t x, y, z;
167     for (z = 0, y = y_start; z < len_line; y++)
168     {
169         for (x = 0; x < win->winmap_size.x && z < len_line; x++, z++)
170         {
171             set_ch_on_yx(win, y, x, line[z] | attri);
172         }
173         if (z < len_line)
174         {
175             try_resize_winmap(win, y + 1 + 1, win->winmap_size.x);
176         }
177     }
178 }
179
180
181
182 static void add_line_compact(struct Win * win, char * line, attr_t attri,
183                              uint16_t * offset, uint8_t last)
184 {
185     uint16_t y_start = win->winmap_size.y - (win->winmap_size.y > 0);
186     try_resize_winmap(win, y_start + 1, win->frame_size.x);
187     uint16_t len_line = strlen(line);
188     char * separator = last ? "" : " / ";
189     uint32_t len_line_new = len_line + strlen(separator);
190     char * line_new = try_malloc(len_line_new + 1, __func__);
191     int test = sprintf(line_new, "%s%s", line, separator);
192     exit_trouble(test < 0, __func__, "sprintf");
193     uint16_t x = 0;
194     uint16_t y;
195     uint32_t z;
196     for (z = 0, y = y_start; z < len_line_new; y++)
197     {
198         for (x = * offset; x < win->winmap_size.x && z < len_line_new; x++, z++)
199         {
200             set_ch_on_yx(win, y, x, line_new[z] | attri);
201             if (z + 1 == (uint32_t) len_line)
202             {
203                attri = 0;
204             }
205         }
206         * offset = 0;
207         if (z < len_line_new)
208         {
209             try_resize_winmap(win, y + 1 + 1, win->winmap_size.x);
210         }
211     }
212     free(line_new);
213     *offset = x;
214 }
215
216
217
218 static void add_text_with_linebreaks(struct Win * win, char * text)
219 {
220     char * limit;
221     uint16_t offset = 0;
222     char * text_copy = strdup(text);
223     char * start = text_copy;
224     while (NULL != (limit = strchr(start, '\n')))
225     {
226         (* limit) = '\0';
227         add_line(win, start, 0, &offset, 0);
228         start = limit + 1;
229     }
230     add_line(win, start, 0, &offset, 1);
231     free(text_copy);
232 }
233
234
235
236 static void draw_text_from_bottom(struct Win * win, char * text)
237 {
238     add_text_with_linebreaks(win, text);
239     if (win->winmap_size.y > win->frame_size.y)
240     {
241         win->center.y = win->winmap_size.y - 1;
242     }
243     else if (win->winmap_size.y < win->frame_size.y)
244     {
245         uint16_t new_y_start = win->frame_size.y - win->winmap_size.y;
246         memset(&win->winmap_size, 0, sizeof(struct yx_uint16));
247         free(win->winmap);
248         win->winmap = NULL;
249         do
250         {
251             add_line_wide(win, " ", 0);
252         }
253         while (new_y_start > win->winmap_size.y);
254         if (2 == win->linebreak) /* add_text_with_linebreaks() will start not */
255         {                        /* not after, but within the last line then. */
256             add_line_wide(win, " ", 0);
257         }
258         add_text_with_linebreaks(win, text);
259     }
260 }
261
262
263
264 static char * get_kb_line(struct KeyBinding * kb)
265 {
266     char * keyname = get_keyname_to_keycode(kb->keycode);
267     uint16_t size = strlen(keyname) + 3 + strlen(kb->command->dsc_long) + 1;
268     char * kb_line = try_malloc(size, __func__);
269     int test = sprintf(kb_line, "%s - %s", keyname, kb->command->dsc_long);
270     exit_trouble(test < 0, __func__, "sprintf");
271     free(keyname);
272     return kb_line;
273 }
274
275
276
277 static void draw_keybinding_config(struct Win * win, struct KeyBindingDB * kbdb,
278                                    uint16_t offset)
279 {
280     if (0 == kbdb->n_of_kbs)
281     {
282         add_line(win, "(none)", 0, &offset, 0);
283         return;
284     }
285     uint8_t kb_n;
286     for (kb_n = 0; kb_n < kbdb->n_of_kbs; kb_n++)
287     {
288         attr_t attri = 0;
289         if (kb_n == kbdb->select)
290         {
291             attri = A_REVERSE;
292             if (1 == kbdb->edit)
293             {
294                 attri = attri | A_BLINK;
295             }
296             win->center.y = win->winmap_size.y;
297         }
298         char * kb_line = get_kb_line(&kbdb->kbs[kb_n]);
299         add_line(win, kb_line, attri, &offset, (kbdb->n_of_kbs == kb_n + 1));
300         free(kb_line);
301     }
302 }
303
304
305
306 static void draw_titled_keybinding_list(char * title, struct Win * win,
307                                         uint16_t * offset, uint8_t last,
308                                         struct KeyBindingDB * kbdb)
309 {
310     uint8_t state = 0;
311     uint8_t kb_n = 0;
312     while (0 == state || kb_n < kbdb->n_of_kbs)
313     {
314         if (0 == state)
315         {
316             add_line(win, title, 0, offset, 0);
317             add_line(win, " ", 0, offset, 0);
318             state = 1 + (0 == kbdb->n_of_kbs);
319             continue;
320         }
321         char * kb_line = get_kb_line(&kbdb->kbs[kb_n]);
322         add_line(win, kb_line, 0, offset, (last * kbdb->n_of_kbs == kb_n + 1));
323         free(kb_line);
324         kb_n++;
325     }
326     if (2 == state)
327     {
328         add_line(win, "(none)", 0, offset, last);
329     }
330 }
331
332
333
334 extern void draw_win_log(struct Win * win)
335 {
336     if (!world.log)
337     {
338         return;
339     }
340     draw_text_from_bottom(win, world.log);
341 }
342
343
344
345 extern void draw_win_map(struct Win * win)
346 {
347     init_pair(1, COLOR_WHITE, COLOR_BLUE);
348     init_pair(2, COLOR_BLUE, COLOR_BLACK);
349     attr_t attr_fov = 0;
350     attr_t attr_mem = COLOR_PAIR(2);
351     attr_t attr_sha = COLOR_PAIR(1);
352     try_resize_winmap(win, world.map.length, world.map.length * 2);
353     uint16_t x, y, z;
354     for (y = 0, z = 0; y < world.map.length; y++)
355     {
356         for (x = 0; x < world.map.length; x++)
357         {
358             attr_t attr_c = ' ' == world.mem_map[z] ? attr_sha : attr_mem;
359             chtype c = world.mem_map[z] | attr_c;
360             set_ch_on_yx(win, y, x * 2 + (y % 2), c);
361             if (x + (y % 2) < world.map.length)
362             {
363                 set_ch_on_yx(win, y, x * 2 + (y % 2) + 1, ' ' | attr_c);
364             }
365             z++;
366         }
367     }
368     for (y = 0, z = 0; y < world.map.length; y++)
369     {
370         for (x = 0; x < world.map.length; x++)
371         {
372             if (' ' != world.map.cells[z])
373             {
374                 chtype c = world.map.cells[z] | attr_fov;
375                 set_ch_on_yx(win, y, x * 2 + (y % 2), c);
376                 if (x + (y % 2) < world.map.length)
377                 {
378                     set_ch_on_yx(win, y, x * 2 + (y % 2) + 1, ' ' | attr_fov);
379                 }
380             }
381             z++;
382         }
383     }
384 }
385
386
387
388 extern void draw_win_info(struct Win * win)
389 {
390     char * dsc_turn      = "Turn: ";
391     char * dsc_hitpoints = "\nHitpoints: ";
392     uint16_t maxl = strlen(dsc_turn) + 5 + strlen(dsc_hitpoints) + 3;
393     char * text = try_malloc(maxl + 1, __func__);
394     int test = sprintf(text, "%s%d%s%d", dsc_turn, world.turn, dsc_hitpoints,
395                                          world.player_lifepoints);
396     exit_trouble(test < 0, __func__, "sprintf");
397     add_text_with_linebreaks(win, text);
398     free(text);
399 }
400
401
402
403 extern void draw_win_inventory(struct Win * win)
404 {
405     char * limit;
406     char * text_copy = strdup(world.player_inventory);
407     char * start = text_copy;
408     uint8_t i = 0;
409     uint8_t found_selection = 0;
410     uint16_t offset = 0;
411     while (NULL != (limit = strchr(start, '\n')))
412     {
413         (* limit) = '\0';
414         attr_t attri = 0;
415         if (i == world.player_inventory_select)
416         {
417             found_selection = 1;
418             attri = A_REVERSE;
419             win->center.y = win->winmap_size.y;
420         }
421         add_line(win, start, attri, &offset, 0);
422         start = limit + 1;
423         i++;
424     }
425     win->center.y = !found_selection ? win->winmap_size.y : win->center.y;
426     add_line(win, start, !found_selection * A_REVERSE, &offset, 1);
427     free(text_copy);
428 }
429
430
431
432 extern void draw_win_available_keybindings(struct Win * win)
433 {
434     char * title = "Active window's keys:";
435     struct Win * win_active = get_win_by_id(world.winDB.active);
436     struct KeyBindingDB * kbdb = &win_active->kb;
437     if      (1 == win_active->view)
438     {
439         kbdb = &world.kb_wingeom;
440     }
441     else if (2 == win_active->view)
442     {
443         kbdb = &world.kb_winkeys;
444     }
445     uint16_t offset = 0;
446     draw_titled_keybinding_list(title, win, &offset, 0, kbdb);
447     add_line(win, " ", 0, &offset, 0);
448     title = "Global keys:";
449     draw_titled_keybinding_list(title, win, &offset, 1, &world.kb_global);
450 }
451
452
453
454
455 extern void draw_win_keybindings_global(struct Win * win)
456 {
457     win->center.y = world.kb_global.select;
458     draw_keybinding_config(win, &world.kb_global, 0);
459 }
460
461
462
463 extern void draw_win_keybindings_winconf_geometry(struct Win * win)
464 {
465     win->center.y = world.kb_wingeom.select;
466     draw_keybinding_config(win, &world.kb_wingeom, 0);
467 }
468
469
470
471 extern void draw_win_keybindings_winconf_keybindings(struct Win * win)
472 {
473     win->center.y = world.kb_winkeys.select;
474     draw_keybinding_config(win, &world.kb_winkeys, 0);
475 }
476
477
478
479 extern void draw_winconf_keybindings(struct Win * win)
480 {
481     char * title = "Window's keys:";
482     uint16_t offset = 0;
483     add_line(win, title, 0, &offset, 0);
484     add_line(win, " ", 0, &offset, 0);
485     draw_keybinding_config(win, &win->kb, offset);
486 }
487
488
489
490 extern void draw_winconf_geometry(struct Win * win)
491 {
492     char * title = "Window's geometry:\n\n";
493     char * h_title = "Height to save: ";
494     char h_value[6 + 1];                       /* 6: int16_t value max strlen */
495     int test = sprintf(h_value, "%d", win->target_height);
496     exit_trouble(test < 0, __func__, "sprintf");
497     char * h_plus = " (width in cells)\n\n";
498     char * h_minus = " (negative diff: cells to screen width)\n\n";
499     char * h_type = (1 == win->target_height_type) ? h_minus : h_plus;
500     char * w_title = "Width to save: ";
501     char w_value[6 + 1];
502     test = sprintf(w_value, "%d", win->target_width);
503     exit_trouble(test < 0, __func__, "sprintf");
504     char * w_plus = "(height in cells)\n\n";
505     char * w_minus = " (negative diff: cells to screen height)\n\n";
506     char * w_type = (1 == win->target_width_type)  ? w_minus : w_plus;
507     char * breaks_title = "Linebreak type: ";
508     char * breaks_type = (1 == win->linebreak) ? "wide" : "long";
509     breaks_type        = (2 == win->linebreak) ? "compact" : breaks_type;
510     uint16_t text_size =   strlen(title)
511                          + strlen(h_title) + strlen(h_value) + strlen(h_type)
512                          + strlen(w_title) + strlen(w_value) + strlen(w_type)
513                          + strlen(breaks_title) + strlen(breaks_type);
514     char * text = try_malloc(text_size + 1, __func__);
515     test = sprintf(text, "%s%s%s%s%s%s%s%s%s", title, h_title, h_value, h_type,
516                         w_title, w_value, w_type, breaks_title, breaks_type);
517     exit_trouble(test < 0, __func__, "sprintf");
518     add_text_with_linebreaks(win, text);
519     free(text);
520 }