plomlompom.com Git - plomrogue/blob - src/client/wincontrol.c

   1 /* src/client/wincontrol.c */
   2
   3 #include "wincontrol.h"
   4 #include <errno.h> /* global errno */
   5 #include <dirent.h> /* DIR, struct dirent, opendir(), closedir(), readdir() */
   6 #include <stdint.h> /* uint8_t, uint16_t, uint32_t */
   7 #include <stdio.h> /* FILE */
   8 #include <stdlib.h> /* free(), atoi() */
   9 #include <string.h> /* strlen(), strchr(), strstr(), memcpy() */
  10 #include "../common/readwrite.h" /* try_fopen(), textfile_sizes(), try_fgets(),
  11                                   * textfile_sizes(), try_fwrite(), try_fgetc(),
  12                                   * try_fclose_unlink_rename(), try_fputc()
  13                                   */
  14 #include "../common/rexit.h" /* exit_err(), exit_trouble() */
  15 #include "../common/try_malloc.h" /* try_malloc() */
  16 #include "../common/yx_uint16.h" /* struct yx_uint16 */
  17 #include "draw_wins.h" /* draw_win_map(), draw_win_info(), draw_win_log(),
  18                         * draw_win_available_keybindings(),
  19                         * draw_win_inventory(), draw_win_keybindings_global(),
  20                         * draw_win_keybindings_winconf_geometry(),
  21                         * draw_win_keybindings_winconf_keybindings(),
  22                         * draw_winconf_geometry(), draw_winconf_keybindings()
  23                         */
  24 #include "keybindings.h" /* struct KeyBinding, free_keybindings() */
  25 #include "windows.h" /* struct Win, resize_active_win(), reset_pad_offset(),
  26                       * append_win(), suspend_win(), init_win(), free_win()
  27                       */
  28 #include "world.h" /* global world */
  29
  30
  31
  32 /* Return string "prefix" + "id"; malloc()'s string, remember to call free()! */
  33 static char * string_prefixed_id(char * prefix, char id);
  34
  35 /* Initialize Winconf of "id" from appropriate config file.*/
  36 static void init_winconf_from_file(char id, struct WinConf * winconf);
  37
  38 /* Wrapper around init_win() called with values from Winconf of "id". */
  39 static void init_win_from_winconf(char id);
  40
  41 /* Save title, draw function, size of window identified by "id" to conffile. */
  42 static void save_win_config(char id);
  43
  44 /* Free data pointed to inside individual WinConf struct of "id". */
  45 static void free_winconf_data(char id);
  46
  47 /* Write geometry of a window to its WinConf, as positive or negative values
  48  * (dependent on state ofWinConf->height_type / WinConf->width_type).
  49  */
  50 static void set_winconf_geometry(char id);
  51
  52 /* Get WinConf by "id"; get id of WinConf mothering "win". */
  53 static struct WinConf * get_winconf_by_id(char id);
  54
  55 /* Get (Win->draw) function identified by "c"; NULL if c not mapped to one. */
  56 static void * get_drawfunc_by_char(char c);
  57
  58 /* Iterate over chars of world.winconf_db.winconf_ids array. Restart after \0.*/
  59 static char get_next_winconf_id();
  60
  61
  62
  63 static char * string_prefixed_id(char * prefix, char id)
  64 {
  65     uint8_t size = strlen(prefix) + 2;
  66     char * path = try_malloc(size, "string_prefixed_id()");
  67     sprintf(path, "%s_", prefix);
  68     path[size - 2] = id;
  69     return path;
  70 }
  71
  72
  73
  74 static void init_winconf_from_file(char id, struct WinConf * winconf)
  75 {
  76     /* Assign WinConf id to filename path, error message context, winconf->id.*/
  77     char * tmp = "init_winconf_from_file() on window id '_'";
  78     char * context = try_malloc(strlen(tmp) + 1, "init_winconf_from_file()");
  79     memcpy(context, tmp, strlen(tmp) + 1);
  80     context[strlen(tmp) - 2] = id;
  81     char * path = string_prefixed_id("confclient/windows/Win_", id);
  82     winconf->id = id;
  83
  84     /* Prepare reading in file line by line into "line" array. */
  85     FILE * file = try_fopen(path, "r", context);
  86     free(path);
  87     uint32_t linemax = textfile_sizes(file, NULL);
  88     char line[linemax + 1];
  89
  90     /* Read/determine winconf->title, ->draw, ->height(_type),->width(_type). */
  91     try_fgets(line, linemax + 1, file, context);
  92     winconf->title = try_malloc(strlen(line), context);
  93     memcpy(winconf->title, line, strlen(line) - 1); /* Eliminate newline char */
  94     winconf->title[strlen(line) - 1] = '\0';        /* char at end of string. */
  95     try_fgets(line, linemax + 1, file, context);
  96     winconf->draw = line[0];
  97     try_fgets(line, linemax + 1, file, context);
  98     winconf->height = atoi(line);
  99     winconf->height_type = (0 >= winconf->height);
 100     try_fgets(line, linemax + 1, file, context);
 101     winconf->width = atoi(line);
 102     winconf->width_type = (0 >= winconf->width);
 103
 104     /* Read in window-specific keybindings (winconf->kb). */
 105     char command[linemax + 1];
 106     char * cmdptr;
 107     struct KeyBinding ** loc_last_ptr = &winconf->kb.kbs;
 108     * loc_last_ptr = 0;
 109     while (try_fgets(command, linemax + 1, file, context))
 110     {
 111         if ('\n' == command[0] || 0 == command[0])
 112         {
 113             break;
 114         }
 115         * loc_last_ptr = try_malloc(sizeof(struct KeyBinding), context);
 116         struct KeyBinding * kb_p = * loc_last_ptr;
 117         kb_p->next = 0;
 118         kb_p->key = atoi(command);
 119         cmdptr = strchr(command, ' ') + 1;
 120         cmdptr[strlen(cmdptr) - 1] = '\0';
 121         kb_p->command = get_command(cmdptr);
 122         loc_last_ptr = & kb_p->next;
 123     }
 124
 125     /* Init remaining values to zero and cleaning up. */
 126     winconf->view = 0;
 127     winconf->kb.edit = 0;
 128     winconf->kb.select = 0;
 129     try_fclose(file, context);
 130     free(context);
 131 }
 132
 133
 134
 135 static void init_win_from_winconf(char id)
 136 {
 137     char * err = "get_drawfunc_by_char() returns NULL to init_win_from_file().";
 138     struct WinConf * winconf = get_winconf_by_id(id);
 139     void * f = get_drawfunc_by_char(winconf->draw);
 140     exit_err(NULL == f, err);
 141     init_win(&winconf->win, winconf->title, winconf->height, winconf->width, f);
 142 }
 143
 144
 145
 146 static void save_win_config(char id)
 147 {
 148     char * f_name = "save_win_config()";
 149
 150     /* Prepare atomic file saving. */
 151     char * path_tmp = string_prefixed_id("confclient/windows/Win_tmp_", id);
 152     FILE * file = try_fopen(path_tmp, "w", f_name);
 153
 154     /* Save, line by line, ->title, ->draw, ->height and ->width. */
 155     struct WinConf * wc = get_winconf_by_id(id);
 156     uint8_t size = strlen(wc->title) + 2;
 157     if (size < 7)  /* Ensure that at least 5 + 2 char fit into line so that   */
 158     {              /* the digit representation of any uint16_t may be stored. */
 159         size = 7;
 160     }
 161     char line[size];
 162     sprintf(line, "%s\n", wc->title);
 163     try_fwrite(line, sizeof(char), strlen(line), file, f_name);
 164     sprintf(line, "%c\n", wc->draw);
 165     try_fwrite(line, sizeof(char), strlen(line), file, f_name);
 166     sprintf(line, "%d\n", wc->height);
 167     try_fwrite(line, sizeof(char), strlen(line), file, f_name);
 168     sprintf(line, "%d\n", wc->width);
 169     try_fwrite(line, sizeof(char), strlen(line), file, f_name);
 170
 171     /* Save window-specific keybindings (->kb.kbs). */
 172     uint16_t linemax = 0;
 173     struct KeyBinding * kb_p = wc->kb.kbs;
 174     while (0 != kb_p)
 175     {
 176         if (strlen(kb_p->command->dsc_short) > linemax)
 177         {
 178             linemax = strlen(kb_p->command->dsc_short);
 179         }
 180         kb_p = kb_p->next;
 181     }
 182     linemax = linemax + 6;          /* + 6: + 3 digits + whitespace + \n + \0 */
 183     char kb_line[linemax];
 184     kb_p = wc->kb.kbs;
 185     while (0 != kb_p)
 186     {
 187         sprintf(kb_line, "%d %s\n", kb_p->key, kb_p->command->dsc_short);
 188         try_fwrite(kb_line, sizeof(char), strlen(kb_line), file, f_name);
 189         kb_p = kb_p->next;
 190     }
 191
 192     /* Finish atomic file saving and clean up. */
 193     char * path = string_prefixed_id("confclient/windows/Win_", id);
 194     try_fclose_unlink_rename(file, path_tmp, path, f_name);
 195     free(path);
 196     free(path_tmp);
 197 }
 198
 199
 200
 201 static void free_winconf_data(char id)
 202 {
 203     struct WinConf * wc = get_winconf_by_id(id);
 204     free(wc->title);
 205     free_keybindings(wc->kb.kbs);
 206     free_win(wc->win);
 207 }
 208
 209
 210
 211 static void set_winconf_geometry(char id)
 212 {
 213     struct WinConf * wcp = get_winconf_by_id(id);
 214     if      (0 == wcp->height_type)
 215     {
 216         wcp->height = wcp->win->framesize.y;
 217     }
 218     else if (1 == wcp->height_type)
 219     {
 220         wcp->height = wcp->win->framesize.y - world.wmeta.padsize.y + 1;
 221     }
 222     if      (0 == wcp->width_type)
 223     {
 224         wcp->width = wcp->win->framesize.x;
 225     }
 226     else if (1 == wcp->width_type)
 227     {
 228         wcp->width = wcp->win->framesize.x - world.wmeta.padsize.x;
 229     }
 230 }
 231
 232
 233
 234 static struct WinConf * get_winconf_by_id(char id)
 235 {
 236     uint8_t i = 0;
 237     while (1)
 238     {
 239         if (id == world.winconf_db.winconfs[i].id)
 240         {
 241             return &world.winconf_db.winconfs[i];
 242         }
 243         i++;
 244     }
 245 }
 246
 247
 248
 249 static void * get_drawfunc_by_char(char c)
 250 {
 251
 252     if      ('c' == c)
 253     {
 254         return draw_win_inventory;
 255     }
 256     else if ('i' == c)
 257     {
 258         return draw_win_info;
 259     }
 260     else if ('l' == c)
 261     {
 262         return draw_win_log;
 263     }
 264     else if ('k' == c)
 265     {
 266         return draw_win_available_keybindings;
 267     }
 268     else if ('m' == c)
 269     {
 270         return draw_win_map;
 271     }
 272     else if ('0' == c)
 273     {
 274         return draw_win_keybindings_global;
 275     }
 276     else if ('1' == c)
 277     {
 278         return draw_win_keybindings_winconf_geometry;
 279     }
 280     else if ('2' == c)
 281     {
 282         return draw_win_keybindings_winconf_keybindings;
 283     }
 284     return NULL;
 285 }
 286
 287
 288
 289 static char get_next_winconf_id()
 290 {
 291     static uint8_t i = 0;
 292     char c = world.winconf_db.winconf_ids[i];
 293     if (0 == c)
 294     {
 295         i = 0;
 296         return c;
 297     }
 298     i++;
 299     return c;
 300 }
 301
 302
 303
 304 extern struct WinConf * get_winconf_by_win(struct Win * win)
 305 {
 306     uint8_t i = 0;
 307     while (1)
 308     {
 309         if (win == world.winconf_db.winconfs[i].win)
 310         {
 311             return &world.winconf_db.winconfs[i];
 312         }
 313         i++;
 314     }
 315 }
 316
 317
 318
 319 extern struct Win * get_win_by_id(char id)
 320 {
 321     struct WinConf * wc = get_winconf_by_id(id);
 322     return wc->win;
 323 }
 324
 325
 326
 327 extern void init_winconfs()
 328 {
 329     char * f_name = "init_winconfs()";
 330
 331     /* Fill world.winconf_db.winconf_ids with confclient/windows/Win_*
 332      * filenames' end chars.
 333      */
 334     uint8_t max_wins = 255;         /* Maximum number of window ids to store. */
 335     DIR * dp = opendir("confclient/windows");
 336     exit_trouble(NULL == dp, f_name, "opendir()");
 337     struct dirent * fn;
 338     errno = 0;
 339     char * winconf_ids = try_malloc(max_wins + 1, f_name);
 340     uint8_t i = 0;
 341     char id;
 342     while (NULL != (fn = readdir(dp)) && i < max_wins)
 343     {
 344         if (5 == strlen(fn->d_name) && fn->d_name == strstr(fn->d_name, "Win_"))
 345         {
 346             id = fn->d_name[4];
 347             winconf_ids[i] = id;
 348             i++;
 349         }
 350     }
 351     winconf_ids[i] = '\0';
 352     exit_trouble(errno, f_name, "readdir()");
 353     exit_trouble(closedir(dp), f_name, "closedir()");
 354     world.winconf_db.winconf_ids = try_malloc(strlen(winconf_ids) + 1, f_name);
 355     memcpy(world.winconf_db.winconf_ids, winconf_ids, strlen(winconf_ids) + 1);
 356     free(winconf_ids);
 357
 358     /* Initialize world.winconf_db.winconfs from Win_* files named in
 359      * world.winconf_db.winconf_ids.
 360      */
 361     size_t size = strlen(world.winconf_db.winconf_ids) * sizeof(struct WinConf);
 362     world.winconf_db.winconfs = try_malloc(size, f_name);
 363     i = 0;
 364     while (0 != (id = get_next_winconf_id()))
 365     {
 366         init_winconf_from_file(id, &world.winconf_db.winconfs[i]);
 367         i++;
 368     }
 369 }
 370
 371
 372
 373 extern void free_winconfs()
 374 {
 375     char id;
 376     while (0 != (id = get_next_winconf_id()))
 377     {
 378         free_winconf_data(id);
 379     }
 380     free(world.winconf_db.winconf_ids);
 381     free(world.winconf_db.winconfs);
 382 }
 383
 384
 385
 386 extern void init_wins()
 387 {
 388     char id;
 389     while (0 != (id = get_next_winconf_id()))
 390     {
 391         init_win_from_winconf(id);
 392     }
 393 }
 394
 395
 396
 397 extern void sorted_wintoggle_and_activate()
 398 {
 399     char * f_name = "sorted_wintoggle_and_activate()";
 400
 401     /* Read from file order of windows to be toggled + active win selection. */
 402     char * path = "confclient/windows/toggle_order_and_active";
 403     FILE * file = try_fopen(path, "r", f_name);
 404     uint32_t linemax = textfile_sizes(file, NULL);
 405     char win_order[linemax + 1];
 406     try_fgets(win_order, linemax + 1, file, f_name);
 407     int char_or_eof = try_fgetc(file, f_name);
 408     exit_trouble(EOF==char_or_eof, f_name, "fgetc() unexpectedly hitting EOF");
 409     uint8_t a = (uint8_t) char_or_eof;
 410     try_fclose(file, f_name);
 411
 412     /* Toggle windows and set active window selection. */
 413     uint8_t i = 0;
 414     for (; i < strlen(win_order) - 1; i++)
 415     {
 416         if (NULL == strchr(world.winconf_db.winconf_ids, win_order[i]))
 417         {
 418             continue;
 419         }
 420         toggle_window(win_order[i]);
 421         if (a == (uint8_t) win_order[i])
 422         {
 423             world.wmeta.active = get_win_by_id(win_order[i]);
 424         }
 425     }
 426 }
 427
 428
 429
 430 extern void save_win_configs()
 431 {
 432     char * f_name = "save_win_configs()";
 433
 434     /* Save individual world.winconf_db.winconfs to their proper files. */
 435     uint8_t max_wins = 255;     /* n of WinConf fitting into world.winconf_db */
 436     char id;
 437     while (0 != (id = get_next_winconf_id()))
 438     {
 439         save_win_config(id);
 440     }
 441
 442     /* Save order of windows to toggle on start / which to select as active. */
 443     char * path     = "confclient/windows/toggle_order_and_active";
 444     char * path_tmp = "confclient/windows/toggle_order_and_active_tmp";
 445     FILE * file = try_fopen(path_tmp, "w", f_name);
 446     char line[max_wins + 2];
 447     struct Win * w_p = world.wmeta.chain_start;
 448     uint8_t i = 0;
 449     while (0 != w_p && i < max_wins)
 450     {
 451         struct WinConf * wc = get_winconf_by_win(w_p);
 452         line[i] = wc->id;
 453         w_p = w_p->next;
 454         i++;
 455     }
 456     line[i] = '\n';
 457     line[i + 1] = '\0';
 458     try_fwrite(line, sizeof(char), strlen(line), file, f_name);
 459     if (0 != world.wmeta.active)
 460     {
 461         struct WinConf * wc = get_winconf_by_win(world.wmeta.active);
 462         try_fputc(wc->id, file, f_name);
 463     }
 464     try_fclose_unlink_rename(file, path_tmp, path, f_name);
 465 }
 466
 467
 468
 469 extern void toggle_window(char id)
 470 {
 471     struct Win * win = get_win_by_id(id);
 472     if (0 == win->prev && world.wmeta.chain_start != win)   /* Win struct is  */
 473     {                                                       /* outside chain? */
 474         append_win(win);
 475     }
 476     else
 477     {
 478         suspend_win(win);
 479     }
 480 }
 481
 482
 483
 484 extern void toggle_winconfig()
 485 {
 486    struct Win * win = world.wmeta.active;
 487    struct WinConf * wcp = get_winconf_by_win(win);
 488     if      (0 == wcp->view)
 489     {
 490         wcp->view     = 1;
 491         win->draw     = draw_winconf_geometry;
 492         wcp->center   = win->center;
 493         win->center.y = 0;
 494         win->center.x = 0;
 495     }
 496     else if (1 == wcp->view)
 497     {
 498         wcp->view     = 2;
 499         win->draw     = draw_winconf_keybindings;
 500         win->center.x = 0;
 501     }
 502     else
 503     {
 504         wcp->view     = 0;
 505         win->draw     = get_drawfunc_by_char(wcp->draw);
 506         win->center   = wcp->center;
 507     }
 508 }
 509
 510
 511
 512 extern void toggle_win_size_type(char axis)
 513 {
 514     struct Win * win = world.wmeta.active;
 515     struct WinConf * wcp = get_winconf_by_win(win);
 516     if ('y' == axis)
 517     {
 518         wcp->height_type = (0 == wcp->height_type);
 519         set_winconf_geometry(wcp->id);
 520         return;
 521     }
 522     wcp->width_type = (   0 == wcp->width_type
 523                        && win->framesize.x <= world.wmeta.padsize.x);
 524     set_winconf_geometry(wcp->id);
 525 }
 526
 527
 528
 529 extern void scroll_pad(char dir)
 530 {
 531     if      ('+' == dir)
 532     {
 533         reset_pad_offset(world.wmeta.pad_offset + 1);
 534     }
 535     else if ('-' == dir)
 536     {
 537         reset_pad_offset(world.wmeta.pad_offset - 1);
 538     }
 539 }
 540
 541
 542
 543 extern void growshrink_active_window(char change)
 544 {
 545     if (0 != world.wmeta.active)
 546     {
 547         struct yx_uint16 size = world.wmeta.active->framesize;
 548         if      (change == '-')
 549         {
 550             size.y--;
 551         }
 552         else if (change == '+')
 553         {
 554             size.y++;
 555         }
 556         else if (change == '_')
 557         {
 558             size.x--;
 559         }
 560         else if (change == '*')
 561         {
 562             size.x++;
 563         }
 564         resize_active_win(size);
 565         struct WinConf * wcp = get_winconf_by_win(world.wmeta.active);
 566         if (   1 == wcp->width_type
 567             && world.wmeta.active->framesize.x > world.wmeta.padsize.x)
 568         {
 569             wcp->width_type = 0;
 570         }
 571         set_winconf_geometry(wcp->id);
 572     }
 573 }