plomlompom.com Git - plomrogue/blob - src/windows.c

   1 /* windows.c */
   2
   3 #include "windows.h"
   4 #include <stdint.h>    /* for uint8_t, uint16_t, uint32_t, UINT16_MAX */
   5 #include <ncurses.h>   /* for typedefs WINDOW, chtype, wresize(), getmaxx(), */
   6                        /* getmaxy(), delwin(), mvwaddch(), mvwaddstr(),      */
   7                        /* newpad(), wnoutrefres(), erase(), werase(),        */
   8                        /* pnoutrefresh(), doupdate(), getmaxyx()   */
   9 #include <stdlib.h>    /* for malloc(), free() */
  10 #include <string.h>    /* for strlen(), strnlen(), memcpy() */
  11 #include "yx_uint16.h" /* for struct yx_uint16 */
  12 #include "misc.h"      /* for center_offset(), try_malloc() */
  13 #include "main.h"      /* for world global */
  14 #include "rexit.h"     /* for exit_err() */
  15
  16
  17
  18 /* Fit virtual screen's width to minimum width demanded by current windows'
  19  * geometries.
  20  */
  21 static void refit_pad();
  22
  23 /* Update geometry (sizes, positions) of window "w" and its successors in the
  24  * window chain. For the positioning algorithm place_win() is used.
  25  */
  26 static void update_wins(struct Win * w);
  27 static void place_win(struct Win * w);
  28
  29 /* Draw scroll hint (a line saying that there are "dist" more elements of
  30  * "unit" further into the direction symbolized by the "dir" char) into virtual
  31  * screen pad, onto an appropriate edge of either a window or the screen; the
  32  * left or right edge if "dir" is "<" or ">", or the upper or lower edge if it
  33  * is "^" or "v". "start" should be either the start coordinate of a window's
  34  * frame or .y=0, .x=wm->pad_offset if it describes the virtual screen pad.
  35  * winscroll_hint() and padscroll_hint() are wrappers to simplify these uses.
  36  */
  37 static void scroll_hint(struct yx_uint16 fsize, char dir, uint16_t dist,
  38                         char * unit, struct yx_uint16 start);
  39 static void winscroll_hint(struct Win * w, char dir, uint16_t dist);
  40 static void padscroll_hint(char dir, uint16_t dist);
  41
  42 /* Draw contents of all windows in window chain from window "w" onwards. */
  43 static void draw_wins(struct Win * w);
  44
  45 /* draw_win_borderlines() draws the vertical and horizontal borders of window
  46  * "w" sans corners into the virtual screen "pad", and draws the top border
  47  * line as the windows' title bar (highlighted if the window is described
  48  * active by "active" being == 1).
  49  *
  50  * draw_wins_borderlines() calls draw_win_borderlines() recursively on all
  51  * windows from "w" on. "w_active" is a pointer to the one window that
  52  * draw_win_borderlines() is supposed to handle as the active window.
  53  *
  54  * Finally, draw_wins_bordercorners() draws into "pad" the borders of window "w"
  55  * and all its successors.
  56  */
  57 static void draw_win_borderlines(struct Win * w, char active, WINDOW * pad);
  58 static void draw_wins_borderlines(struct Win * w, struct Win * w_active,
  59                                   WINDOW * pad);
  60 static void draw_wins_bordercorners(struct Win * w, WINDOW * pad);
  61
  62 /* Shift active window forwards / backwards in window chain. */
  63 static void shift_win_forward();
  64 static void shift_win_backward();
  65
  66
  67
  68 static void refit_pad()
  69 {
  70     /* Determine rightmost window column. */
  71     uint32_t lastwcol = 0;
  72     struct Win * wp = world.wmeta->chain_start;
  73     while (wp != 0)
  74     {
  75         if ((uint32_t) wp->start.x + (uint32_t) wp->framesize.x > lastwcol + 1)
  76         {
  77             lastwcol = (uint32_t) wp->start.x + (uint32_t) wp->framesize.x - 1;
  78         }
  79         wp = wp->next;
  80     }
  81
  82     /* Only resize the pad if the rightmost window column has changed. */
  83     char * err_s = "refit_pad() extends virtual screen beyond legal sizes.";
  84     char * err_m = "refit_pad() triggers memory alloc error via wresize().";
  85     if (getmaxx(world.wmeta->pad) + 1 != lastwcol)
  86     {
  87         uint8_t t = (lastwcol + 2 > UINT16_MAX);
  88         exit_err(t, err_s);
  89         t = wresize(world.wmeta->pad, getmaxy(world.wmeta->pad), lastwcol + 2);
  90         exit_err(t, err_m);
  91     }
  92 }
  93
  94
  95
  96 static void update_wins(struct Win * w)
  97 {
  98     place_win(w);
  99     refit_pad();
 100     if (0 != w->next)
 101     {
 102         update_wins(w->next);
 103     }
 104 }
 105
 106
 107
 108 static void place_win(struct Win * w)
 109 {
 110     /* If w is first window, it goes into the upper-left corner. */
 111     w->start.x = 0;
 112     w->start.y = 1;                             /* Leave space for title bar. */
 113     if (0 != w->prev)
 114     {
 115
 116         /* If w is not first winddow, fit its top left corner to the top right
 117          * corner of w_top, the last predecessor window starting at the top.
 118          */
 119         struct Win * w_top = w->prev;
 120         while (w_top->start.y != 1)
 121         {
 122             w_top = w_top->prev;
 123         }
 124         w->start.x = w_top->start.x + w_top->framesize.x + 1;
 125
 126         /* Fit w's top left corner to bottom left corner of its immediate
 127          * predecessor window if enough empty space is found there.
 128          */
 129         uint16_t w_prev_maxy = w->prev->start.y + w->prev->framesize.y;
 130         if (   w->framesize.x <= w->prev->framesize.x
 131             && w->framesize.y <  world.wmeta->padsize.y - w_prev_maxy)
 132         {
 133             w->start.x = w->prev->start.x;
 134             w->start.y = w_prev_maxy + 1;
 135         }
 136
 137         /* Failing that, try to fit the top left corner to the top right corner
 138          * of the last predecessor w_test 1) not followed by top windows or any
 139          * other windows with a left corner further rightwards than its own left
 140          * corner 2) with enough space rightwards for w until the bottom right
 141          * corner of w_thro directly throning over it 3) and with this same
 142          * space extending for enough to the bottom for fitting in w.
 143          */
 144         else
 145         {
 146             struct Win * w_test = w->prev;
 147             struct Win * w_thro;
 148             while (w_test != w_top)
 149             {
 150                 w_thro = w_test->prev;
 151                 while (w_test->start.y <= w_thro->start.y)
 152                 {
 153                     w_thro = w_thro->prev;
 154                 }
 155                 uint16_t w_thro_bottom = w_thro->start.y + w_thro->framesize.y;
 156                 uint16_t free_width = (w_thro->start.x + w_thro->framesize.x)
 157                                       - (w_test->start.x + w_test->framesize.x);
 158                 if (   w->framesize.y < world.wmeta->padsize.y - w_thro_bottom
 159                     && w->framesize.x < free_width)
 160                 {
 161                     w->start.x = w_test->start.x + w_test->framesize.x + 1;
 162                     w->start.y = w_thro_bottom + 1;
 163                     break;
 164                 }
 165                 w_test = w_thro;
 166             }
 167         }
 168     }
 169 }
 170
 171
 172
 173 static void scroll_hint(struct yx_uint16 fsize, char dir, uint16_t dist,
 174                         char * unit, struct yx_uint16 start)
 175 {
 176     /* Decide on alignment (vertical/horizontal?), thereby hint text space. */
 177     char * more = "more";
 178     uint16_t dsc_space = fsize.x;
 179     if ('<' == dir || '>' == dir)
 180     {
 181         dsc_space = fsize.y;
 182     }                                  /* vv-- 10 = max strlen for uint16_t */
 183     char scrolldsc[1 + strlen(more) + 1 + 10 + 1 + strlen(unit) + 1 + 1];
 184     sprintf(scrolldsc, " %d %s %s ", dist, more, unit);
 185
 186     /* Decide on offset of the description text inside the scroll hint line. */
 187     uint16_t dsc_offset = 1;
 188     if (dsc_space > strlen(scrolldsc) + 1)
 189     {
 190         dsc_offset = (dsc_space - strlen(scrolldsc)) / 2;
 191     }
 192
 193     /* Draw scroll hint line as dir symbols bracketing description text. */
 194     uint16_t draw_offset = 0;
 195     if      ('>' == dir)
 196     {
 197         draw_offset = fsize.x - 1;
 198     }
 199     else if ('v' == dir)
 200     {
 201         draw_offset = fsize.y - 1;
 202     }
 203     uint16_t q = 0;
 204     for (; q < dsc_space; q++)
 205     {
 206         chtype c = dir | A_REVERSE;
 207         if (q >= dsc_offset && q < strlen(scrolldsc) + dsc_offset)
 208         {
 209             c = scrolldsc[q - dsc_offset] | A_REVERSE;
 210         }
 211         if ('<' == dir || '>' == dir)
 212         {
 213             mvwaddch(world.wmeta->pad, start.y + q, start.x + draw_offset, c);
 214         }
 215         else
 216         {
 217             mvwaddch(world.wmeta->pad, start.y + draw_offset, start.x + q, c);
 218         }
 219     }
 220 }
 221
 222
 223 static void padscroll_hint(char dir, uint16_t dist)
 224 {
 225     struct yx_uint16 start;
 226     start.y = 0;
 227     start.x = world.wmeta->pad_offset;
 228     scroll_hint(world.wmeta->padsize, dir, dist, "columns", start);
 229 }
 230
 231
 232
 233 static void winscroll_hint(struct Win * w, char dir, uint16_t dist)
 234 {
 235     char * unit = "lines";
 236     if ('<' == dir || '>' == dir)
 237     {
 238         unit = "columns";
 239     }
 240     struct yx_uint16 start = w->start;
 241     scroll_hint(w->framesize, dir, dist, unit, start);
 242 }
 243
 244
 245
 246 static void draw_wins(struct Win * w)
 247 {
 248     w->draw(w);
 249     uint16_t y, x, size_y, size_x;
 250     size_y = w->winmapsize.y;
 251     size_x = w->winmapsize.x;
 252     uint16_t offset_y = center_offset(w->center.y, size_y, w->framesize.y);
 253     uint16_t offset_x = center_offset(w->center.x, size_x, w->framesize.x);
 254     for (y = offset_y; y < w->framesize.y + offset_y && y < size_y; y++)
 255     {
 256         for (x = offset_x; x < w->framesize.x + offset_x && x < size_x; x++)
 257         {
 258             chtype ch = w->winmap[(y * w->winmapsize.x) + x];
 259             mvwaddch(world.wmeta->pad, w->start.y + (y - offset_y),
 260                                        w->start.x + (x - offset_x), ch);
 261         }
 262     }
 263     free(w->winmap);
 264     w->winmap = NULL;
 265     w->winmapsize.y = 0;
 266     w->winmapsize.x = 0;
 267     if (offset_y > 0)
 268     {
 269         winscroll_hint(w, '^', offset_y + 1);
 270     }
 271     if (size_y > offset_y + w->framesize.y)
 272     {
 273         winscroll_hint(w, 'v', size_y - ((offset_y + w->framesize.y) - 1));
 274     }
 275     if (offset_x > 0)
 276     {
 277         winscroll_hint(w, '<', offset_x + 1);
 278     }
 279     if (size_x > offset_x + w->framesize.x)
 280     {
 281         winscroll_hint(w, '>', size_x - ((offset_x + w->framesize.x) - 1));
 282     }
 283     if (0 != w->next)
 284     {
 285         return draw_wins(w->next);
 286     }
 287 }
 288
 289
 290
 291 static void draw_win_borderlines(struct Win * w, char active, WINDOW * pad)
 292 {
 293     /* Draw vertical and horizontal border lines. */
 294     uint16_t y, x;
 295     for (y = w->start.y; y <= w->start.y + w->framesize.y; y++)
 296     {
 297         mvwaddch(pad, y, w->start.x - 1,              '|');
 298         mvwaddch(pad, y, w->start.x + w->framesize.x, '|');
 299     }
 300     for (x = w->start.x; x <= w->start.x + w->framesize.x; x++)
 301     {
 302         mvwaddch(pad, w->start.y - 1,              x, '-');
 303         mvwaddch(pad, w->start.y + w->framesize.y, x, '-');
 304     }
 305
 306     /* Draw as much as possible of the title into center of top border line. */
 307     char min_title_length_visible = 3;  /* min. 1 char + 2 padding/decoration */
 308     if (w->framesize.x >= min_title_length_visible)
 309     {
 310         uint16_t title_offset = 0;
 311         if (w->framesize.x > strlen(w->title) + 2)
 312         {
 313             title_offset = (w->framesize.x - (strlen(w->title) + 2)) / 2;
 314         }                                    /* +2 is for padding/decoration */
 315         uint16_t length_visible = strnlen(w->title, w->framesize.x - 2);
 316         char title[length_visible + 3];
 317         char decoration = ' ';
 318         if (1 == active)
 319         {
 320             decoration = '$';
 321         }
 322         memcpy(title + 1, w->title, length_visible);
 323         title[0] = title[length_visible + 1] = decoration;
 324         title[length_visible + 2] = '\0';
 325         mvwaddstr(pad, w->start.y - 1, w->start.x + title_offset, title);
 326     }
 327 }
 328
 329
 330
 331 static void draw_wins_borderlines(struct Win * w, struct Win * w_active,
 332                                   WINDOW * pad)
 333 {
 334     char active = 0;
 335     if (w == w_active)
 336     {
 337         active = 1;
 338     }
 339     draw_win_borderlines(w, active, pad);
 340     if (0 != w->next)
 341     {
 342         draw_wins_borderlines(w->next, w_active, pad);
 343     }
 344 }
 345
 346
 347
 348 static void draw_wins_bordercorners(struct Win * w, WINDOW * pad)
 349 {
 350     mvwaddch(pad, w->start.y - 1, w->start.x - 1, '+');
 351     mvwaddch(pad, w->start.y - 1, w->start.x + w->framesize.x, '+');
 352     mvwaddch(pad, w->start.y + w->framesize.y, w->start.x - 1, '+');
 353     mvwaddch(pad, w->start.y + w->framesize.y, w->start.x + w->framesize.x,'+');
 354     if (0 != w->next)
 355     {
 356         draw_wins_bordercorners(w->next, pad);
 357     }
 358 }
 359
 360
 361
 362 static void shift_win_forward()
 363 {
 364     if (world.wmeta->active == world.wmeta->chain_end)
 365     {
 366         world.wmeta->chain_end = world.wmeta->active->prev;
 367         world.wmeta->chain_end->next = 0;
 368         world.wmeta->active->next = world.wmeta->chain_start;
 369         world.wmeta->active->next->prev = world.wmeta->active;
 370         world.wmeta->chain_start = world.wmeta->active;
 371         world.wmeta->chain_start->prev = 0;
 372     }
 373     else
 374     {
 375         struct Win * old_prev = world.wmeta->active->prev;
 376         struct Win * old_next = world.wmeta->active->next;
 377         if (world.wmeta->chain_end == world.wmeta->active->next)
 378         {
 379             world.wmeta->chain_end = world.wmeta->active;
 380             world.wmeta->active->next = 0;
 381         }
 382         else
 383         {
 384             world.wmeta->active->next = old_next->next;
 385             world.wmeta->active->next->prev = world.wmeta->active;
 386         }
 387         if (world.wmeta->chain_start == world.wmeta->active)
 388         {
 389             world.wmeta->chain_start = old_next;
 390         }
 391         else
 392         {
 393             old_prev->next = old_next;
 394         }
 395         old_next->prev = old_prev;
 396         old_next->next = world.wmeta->active;
 397         world.wmeta->active->prev = old_next;
 398     }
 399 }
 400
 401
 402
 403 static void shift_win_backward()
 404 {
 405     if (world.wmeta->active == world.wmeta->chain_start)
 406     {
 407         world.wmeta->chain_start = world.wmeta->active->next;
 408         world.wmeta->chain_start->prev = 0;
 409         world.wmeta->active->prev = world.wmeta->chain_end;
 410         world.wmeta->active->prev->next = world.wmeta->active;
 411         world.wmeta->chain_end = world.wmeta->active;
 412         world.wmeta->chain_end->next = 0;
 413     }
 414     else
 415     {
 416         struct Win * old_prev = world.wmeta->active->prev;
 417         struct Win * old_next = world.wmeta->active->next;
 418         if (world.wmeta->chain_start == world.wmeta->active->prev)
 419         {
 420             world.wmeta->chain_start = world.wmeta->active;
 421             world.wmeta->active->prev = 0;
 422         }
 423         else
 424         {
 425             world.wmeta->active->prev = old_prev->prev;
 426             world.wmeta->active->prev->next = world.wmeta->active;
 427         }
 428         if (world.wmeta->chain_end == world.wmeta->active)
 429         {
 430             world.wmeta->chain_end = old_prev;
 431         }
 432         else
 433         {
 434             old_next->prev = old_prev;
 435         }
 436         old_prev->next = old_next;
 437         old_prev->prev = world.wmeta->active;
 438         world.wmeta->active->next = old_prev;
 439     }
 440 }
 441
 442
 443
 444 extern void init_win_meta(WINDOW * screen)
 445 {
 446     char * f_name = "init_win_meta()";
 447     char * err_s = "init_win_meta() creates virtual screen beyond legal size.";
 448     char * err_m = "init_win_meta() triggers memory alloc error via newpad().";
 449     world.wmeta         = try_malloc(sizeof(struct WinMeta), f_name);
 450     world.wmeta->screen = screen;
 451     uint32_t maxy_test  = getmaxy(screen);
 452     uint32_t maxx_test  = getmaxx(screen);
 453     uint8_t test = (maxy_test > UINT16_MAX || maxx_test > UINT16_MAX);
 454     exit_err(test, err_s);
 455     world.wmeta->padsize.y   = maxy_test;
 456     world.wmeta->padsize.x   = maxx_test;
 457     world.wmeta->chain_start = 0;
 458     world.wmeta->chain_end   = 0;
 459     world.wmeta->pad_offset  = 0;
 460     world.wmeta->pad         = newpad(world.wmeta->padsize.y, 1);
 461     exit_err(NULL == world.wmeta->pad, err_m);
 462     world.wmeta->active      = 0;
 463 }
 464
 465
 466
 467 extern void init_win(struct Win ** wp, char * title, int16_t height,
 468                      int16_t width, void * func)
 469 {
 470     char * f_name = "init_win()";
 471     struct Win * w  = try_malloc(sizeof(struct Win), f_name);
 472     w->prev         = 0;
 473     w->next         = 0;
 474     w->winmapsize.y = 0;
 475     w->winmapsize.x = 0;
 476     w->winmap = NULL;
 477     w->title        = try_malloc(strlen(title) + 1, f_name);
 478     sprintf(w->title, "%s", title);
 479     w->draw         = func;
 480     w->center.y     = 0;
 481     w->center.x     = 0;
 482     if      (0 < width)
 483     {
 484         w->framesize.x = width;
 485     }
 486     else if (0 >= width)
 487     {
 488         w->framesize.x = world.wmeta->padsize.x + width;
 489     }
 490     if      (0 < height && height <= world.wmeta->padsize.y - 1)
 491     {
 492         w->framesize.y = height;
 493     }
 494     else if (0 >= height && world.wmeta->padsize.y + (height - 1) > 0)
 495     {
 496         w->framesize.y = world.wmeta->padsize.y + (height - 1);
 497     }
 498     *wp = w;
 499 }
 500
 501
 502
 503 extern void free_winmeta()
 504 {
 505     delwin(world.wmeta->pad);
 506     free(world.wmeta);
 507 }
 508
 509
 510
 511 extern void free_win(struct Win * win)
 512 {
 513     free(win->title);
 514     free(win);
 515 }
 516
 517
 518
 519 extern void append_win(struct Win * w)
 520 {
 521     if (0 != world.wmeta->chain_start)
 522     {
 523         w->prev = world.wmeta->chain_end;
 524         world.wmeta->chain_end->next = w;
 525     }
 526     else
 527     {
 528         world.wmeta->active = w;
 529         world.wmeta->chain_start = w;
 530     }
 531     world.wmeta->chain_end = w;
 532     update_wins(w);
 533 }
 534
 535
 536
 537 extern void suspend_win(struct Win * w)
 538 {
 539     if (world.wmeta->chain_start != w)
 540     {
 541         w->prev->next = w->next;
 542     }
 543     else
 544     {
 545         world.wmeta->chain_start = w->next;
 546     }
 547     char pad_refitted = 0;
 548     if (world.wmeta->chain_end != w)
 549     {
 550         w->next->prev = w->prev;
 551         if (world.wmeta->active == w)
 552         {
 553             world.wmeta->active = w->next;
 554         }
 555         update_wins(w->next);      /* Positioning of successor windows may be */
 556         pad_refitted = 1;          /* affected / need correction. Note that   */
 557     }                              /* update_wins() already refits the pad,   */
 558     else                           /* voiding later need for that.            */
 559     {
 560         world.wmeta->chain_end = w->prev;
 561         if (world.wmeta->active == w)
 562         {
 563             world.wmeta->active = w->prev;
 564         }
 565     }
 566
 567     w->prev = 0;
 568     w->next = 0;
 569
 570     if (0 == pad_refitted)
 571     {
 572         refit_pad();
 573     }
 574 }
 575
 576
 577
 578 extern void reset_pad_offset(uint16_t new_offset)
 579 {
 580     if (new_offset >= 0
 581         && (new_offset < world.wmeta->pad_offset
 582             || new_offset + world.wmeta->padsize.x < getmaxx(world.wmeta->pad)))
 583     {
 584         world.wmeta->pad_offset = new_offset;
 585     }
 586 }
 587
 588
 589
 590 extern void resize_active_win(struct yx_uint16 size)
 591 {
 592     if (0 != world.wmeta->active
 593         && size.x > 0 && size.y > 0 && size.y < world.wmeta->padsize.y)
 594     {
 595         world.wmeta->active->framesize = size;
 596         update_wins(world.wmeta->active);         /* Positioning of following */
 597     }                                             /* windows may be affected. */
 598 }
 599
 600
 601
 602 extern void cycle_active_win(char dir)
 603 {
 604     if (0 != world.wmeta->active)
 605     {
 606         if ('f' == dir)
 607         {
 608             if (world.wmeta->active->next != 0)
 609             {
 610                 world.wmeta->active = world.wmeta->active->next;
 611             }
 612             else
 613             {
 614                 world.wmeta->active = world.wmeta->chain_start;
 615             }
 616         }
 617         else
 618         {
 619             if (world.wmeta->active->prev != 0)
 620             {
 621                 world.wmeta->active = world.wmeta->active->prev;
 622             }
 623             else
 624             {
 625                 world.wmeta->active = world.wmeta->chain_end;
 626             }
 627         }
 628     }
 629 }
 630
 631
 632
 633 extern void shift_active_win(char dir)
 634 {
 635     if (   0 == world.wmeta->active  /* No shifting with < 2 windows visible. */
 636         || world.wmeta->chain_start == world.wmeta->chain_end)
 637     {
 638         return;
 639     }
 640     if ('f' == dir)
 641     {
 642         shift_win_forward();
 643     }
 644     else
 645     {
 646         shift_win_backward();
 647     }
 648     update_wins(world.wmeta->chain_start);
 649 }
 650
 651
 652
 653 extern void draw_all_wins()
 654 {
 655     /* Empty everything before filling it a-new. */
 656     erase();
 657     wnoutrefresh(world.wmeta->screen);
 658     werase(world.wmeta->pad);
 659     if (world.wmeta->chain_start)
 660     {
 661
 662         /* Draw windows' borders first, then windows. */
 663         draw_wins_borderlines(world.wmeta->chain_start, world.wmeta->active,
 664                               world.wmeta->pad);
 665         draw_wins_bordercorners(world.wmeta->chain_start, world.wmeta->pad);
 666         draw_wins(world.wmeta->chain_start);
 667
 668         /* Draw virtual screen scroll hints. */
 669         if (world.wmeta->pad_offset > 0)
 670         {
 671             padscroll_hint('<', world.wmeta->pad_offset + 1);
 672         }
 673         uint16_t size_x = getmaxx(world.wmeta->pad);
 674         uint16_t right_edge = world.wmeta->pad_offset + world.wmeta->padsize.x;
 675         if (right_edge < size_x - 1)
 676         {
 677             padscroll_hint('>', size_x - right_edge);
 678         }
 679
 680         /* Write pad segment to be shown on physical screen to screen buffer. */
 681         pnoutrefresh(world.wmeta->pad, 0, world.wmeta->pad_offset, 0, 0,
 682                      world.wmeta->padsize.y, world.wmeta->padsize.x - 1);
 683     }
 684
 685     /* Only at the end write accumulated changes to the physical screen. */
 686     doupdate();
 687 }