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

   1 /* windows.c */
   2
   3 #include "windows.h"
   4 #include <stdint.h>    /* for uint16_t, uint32_t */
   5 #include <ncurses.h>   /* for LOTS of stuff */
   6 #include <stdlib.h>    /* for malloc(), free() */
   7 #include <string.h>    /* for strlen(), memcpy() */
   8 #include "yx_uint16.h" /* for yx_uint16 coordinates */
   9
  10
  11
  12 /* Fit virtual screen's width to minimum width demanded by current windows'
  13  * geometries.
  14  */
  15 static void refit_pad(struct WinMeta * wmeta);
  16
  17
  18
  19 /* Update geometry (sizes, positions) of window "w" and its successors in the
  20  * window chain. For the positioning algorithm place_win() is used.
  21  */
  22 static void update_wins(struct WinMeta * wmeta, struct Win * w);
  23 static void place_win(struct WinMeta * wmeta, struct Win * w);
  24
  25
  26
  27 /* Destroy window "w"'s ncurses window (and set w.Frame.curses_win to 0). */
  28 static void destroy_win(struct Win * w);
  29
  30
  31
  32 /* Draw contents of all windows in window chain from window "w" onwards. */
  33 static void draw_wins(struct Win * w);
  34
  35
  36
  37 /* draw_win_borderlines() draws the vertical and horizontal borders of window
  38  * "w" sans corners into the virtual screen "pad", and draws the top border
  39  * line as the windows' title bar (highlighted if the window is described
  40  * active by "active" being set). draw_wins_borderlines().
  41  *
  42  * draw_wins_borderlines() calls draw_win_borderlines() recursively on all
  43  * windows from "w" on. "w_active" is a pointer to the one window that
  44  * draw_win_borderlines() is supposed to handle as the active window.
  45  *
  46  * Finally, draw_wins_bordercorners draws into "pad" the borders of window "w"
  47  * and all its successors.
  48  */
  49 static void draw_win_borderlines(struct Win * w, char active, WINDOW * pad);
  50 static void draw_wins_borderlines(struct Win * w, struct Win * w_active,
  51                                   WINDOW * pad);
  52 static void draw_wins_bordercorners(struct Win * w, WINDOW * pad);
  53
  54
  55
  56 static void refit_pad(struct WinMeta * wmeta)
  57 {
  58     /* Determine rightmost window column. */
  59     uint16_t lastwincol = 0;
  60     struct Win * w_p = wmeta->chain_start;
  61     while (w_p != 0)
  62     {
  63         if (w_p->start.x + w_p->frame.size.x > lastwincol + 1)
  64         {
  65             lastwincol = w_p->start.x + w_p->frame.size.x - 1;
  66         }
  67         w_p = w_p->next;
  68     }
  69
  70     /* Only resize the pad if the rightmost window column has changed. */
  71     if (getmaxx(wmeta->padframe.curses_win) != lastwincol)
  72     {
  73         wresize(wmeta->padframe.curses_win,
  74                 getmaxy(wmeta->padframe.curses_win), lastwincol + 2);
  75     }
  76 }
  77
  78
  79
  80 static void update_wins (struct WinMeta * wmeta, struct Win * w)
  81 {
  82     if (0 != w->frame.curses_win)
  83     {
  84         destroy_win (w);
  85     }
  86     place_win(wmeta, w);
  87     refit_pad(wmeta);
  88     w->frame.curses_win = subpad(wmeta->padframe.curses_win,
  89                                  w->frame.size.y, w->frame.size.x,
  90                                  w->start.y, w->start.x);
  91     if (0 != w->next)
  92     {
  93         update_wins (wmeta, w->next);
  94     }
  95 }
  96
  97
  98
  99 static void place_win (struct WinMeta * wmeta, struct Win * w)
 100 {
 101     /* First window goes into the upper-left corner. */
 102     w->start.x = 0;
 103     w->start.y = 1;                             /* Leave space for title bar. */
 104     if (0 != w->prev)
 105     {
 106
 107         /* Non-first window fallbacks to: fit rightwards of rightmost border. */
 108         struct Win * w_top = w->prev;
 109         while (w_top->start.y != 1)
 110         {
 111             w_top = w_top->prev;
 112         }
 113         w->start.x = w_top->start.x + w_top->frame.size.x + 1;
 114
 115         /* Fit window below its predecessor if that one directly thrones over
 116          * empty space wide and high enough.
 117          */
 118         uint16_t w_prev_maxy = w->prev->start.y
 119                                + getmaxy(w->prev->frame.curses_win);
 120         if (   w->frame.size.x <= w->prev->frame.size.x
 121             && w->frame.size.y <  wmeta->padframe.size.y - w_prev_maxy)
 122         {
 123             w->start.x = w->prev->start.x;
 124             w->start.y = w_prev_maxy + 1;
 125         }
 126
 127         /* Failing that, try to open a new sub column below the nearest
 128          * predecessor window that thrones over enough empty space.
 129          */
 130         else
 131         {
 132             struct Win * w_up = w->prev;
 133             struct Win * w_upup = w_up;
 134             uint16_t widthdiff;
 135             while (w_up != w_top)
 136             {
 137                 w_upup = w_up->prev;
 138                 while (1)
 139                 {
 140                     if (w_up->start.y != w_upup->start.y)
 141                     {
 142                         break;
 143                     }
 144                     w_upup = w_upup->prev;
 145                 }
 146                 w_prev_maxy = w_upup->start.y
 147                               + getmaxy(w_upup->frame.curses_win);
 148                 widthdiff = (w_upup->start.x + w_upup->frame.size.x)
 149                             - (w_up->start.x + w_up->frame.size.x);
 150                 if (   w->frame.size.y < wmeta->padframe.size.y - w_prev_maxy
 151                     && w->frame.size.x < widthdiff)
 152                 {
 153                     w->start.x = w_up->start.x + w_up->frame.size.x + 1 ;
 154                     w->start.y = w_prev_maxy + 1;
 155                     break;
 156                 }
 157                 w_up = w_upup;
 158             }
 159         }
 160     }
 161 }
 162
 163
 164
 165 static void destroy_win (struct Win * w)
 166 {
 167     delwin(w->frame.curses_win);
 168     w->frame.curses_win = 0;
 169 }
 170
 171
 172
 173 static void draw_wins (struct Win * w)
 174 {
 175     w->draw(w);
 176     if (0 != w->next)
 177     {
 178         draw_wins (w->next);
 179     }
 180 }
 181
 182
 183
 184 static void draw_win_borderlines(struct Win * w, char active, WINDOW * pad)
 185 {
 186     /* Draw vertical and horizontal border lines. */
 187     uint16_t y, x;
 188     for (y = w->start.y; y <= w->start.y + w->frame.size.y; y++)
 189     {
 190         mvwaddch(pad, y, w->start.x - 1,               '|');
 191         mvwaddch(pad, y, w->start.x + w->frame.size.x, '|');
 192     }
 193     for (x = w->start.x; x <= w->start.x + w->frame.size.x; x++)
 194     {
 195         mvwaddch(pad, w->start.y - 1,               x, '-');
 196         mvwaddch(pad, w->start.y + w->frame.size.y, x, '-');
 197     }
 198
 199     /* Draw as much as possible of the title into center of top border line. */
 200     char min_title_length_visible = 3;  /* min. 1 char + 2 padding/decoration */
 201     if (w->frame.size.x >= min_title_length_visible)
 202     {
 203         uint16_t title_offset = 0;
 204         if (w->frame.size.x > strlen(w->title) + 2)
 205         {
 206             title_offset = (w->frame.size.x - (strlen(w->title) + 2)) / 2;
 207         }                                     /* +2 is for padding/decoration */
 208         uint16_t length_visible = strnlen(w->title, w->frame.size.x - 2);
 209         char title[length_visible + 3];
 210         char decoration = ' ';
 211         if (1 == active)
 212         {
 213             decoration = '$';
 214         }
 215         memcpy(title + 1, w->title, length_visible);
 216         title[0] = title[length_visible + 1] = decoration;
 217         title[length_visible + 2] = '\0';
 218         mvwaddstr(pad, w->start.y - 1, w->start.x + title_offset, title);
 219     }
 220 }
 221
 222
 223
 224 static void draw_wins_borderlines(struct Win * w, struct Win * w_active,
 225                                   WINDOW * pad)
 226 {
 227     char active = 0;
 228     if (w == w_active)
 229     {
 230         active = 1;
 231     }
 232     draw_win_borderlines(w, active, pad);
 233     if (0 != w->next)
 234     {
 235         draw_wins_borderlines (w->next, w_active, pad);
 236     }
 237 }
 238
 239
 240
 241 static void draw_wins_bordercorners(struct Win * w, WINDOW * pad)
 242 {
 243     mvwaddch(pad, w->start.y - 1, w->start.x - 1, '+');
 244     mvwaddch(pad, w->start.y - 1, w->start.x + w->frame.size.x, '+');
 245     mvwaddch(pad, w->start.y + w->frame.size.y, w->start.x - 1, '+');
 246     mvwaddch(pad,
 247              w->start.y + w->frame.size.y, w->start.x + w->frame.size.x, '+');
 248     if (0 != w->next)
 249     {
 250         draw_wins_bordercorners(w->next, pad);
 251     }
 252 }
 253
 254
 255
 256 extern struct WinMeta init_win_meta(WINDOW * screen)
 257 {
 258     struct WinMeta wmeta;
 259     wmeta.screen              = screen;
 260     wmeta.padframe.size.y     = getmaxy(screen);
 261     wmeta.padframe.size.x     = getmaxx(screen);
 262     wmeta.chain_start         = 0;
 263     wmeta.chain_end           = 0;
 264     wmeta.pad_offset          = 0;
 265     wmeta.padframe.curses_win = newpad(wmeta.padframe.size.y, 1);
 266     wmeta.active              = 0;
 267     return wmeta;
 268 }
 269
 270
 271
 272 extern struct Win init_win(struct WinMeta * wmeta, char * title,
 273                            void * data, void * func)
 274 {
 275     struct Win w;
 276     w.prev             = 0;
 277     w.next             = 0;
 278     w.frame.curses_win = 0;
 279     w.title            = title;
 280     w.frame.size.x     = 20;
 281     w.frame.size.y     = wmeta->padframe.size.y - 1;
 282     w.data             = data;
 283     w.draw             = func;
 284     return w;
 285 }
 286
 287
 288
 289 extern void append_win(struct WinMeta * wmeta, struct Win * w)
 290 {
 291     if (0 != wmeta->chain_start)
 292     {
 293         w->prev = wmeta->chain_end;
 294         wmeta->chain_end->next = w;
 295     }
 296     else
 297     {
 298         wmeta->active = w;
 299         wmeta->chain_start = w;
 300     }
 301     wmeta->chain_end = w;
 302     update_wins(wmeta, w);
 303 }
 304
 305
 306
 307 extern void suspend_win(struct WinMeta * wmeta, struct Win * w)
 308 {
 309     destroy_win(w);
 310
 311     if (wmeta->chain_start != w)
 312     {
 313         w->prev->next = w->next;
 314     }
 315     else
 316     {
 317         wmeta->chain_start = w->next;
 318     }
 319     char pad_refitted = 0;
 320     if (wmeta->chain_end != w)
 321     {
 322         w->next->prev = w->prev;
 323         if (wmeta->active == w)
 324         {
 325             wmeta->active = w->next;
 326         }
 327         update_wins(wmeta, w->next); /* Positioning of successor windows may  */
 328         pad_refitted = 1;            /* be affected / need correction. Note   */
 329     }                                /* that update_wins() already refits the */
 330     else                             /* pad, voiding later need for that.     */
 331     {
 332         wmeta->chain_end = w->prev;
 333         if (wmeta->active == w)
 334         {
 335             wmeta->active = w->prev;
 336         }
 337     }
 338
 339     w->prev = 0;
 340     w->next = 0;
 341
 342     if (0 == pad_refitted)
 343     {
 344         refit_pad(wmeta);
 345     }
 346 }
 347
 348
 349
 350 extern void reset_pad_offset(struct WinMeta * wmeta, uint16_t new_offset)
 351 {
 352     if (new_offset >= 0
 353         && (new_offset < wmeta->pad_offset
 354             || new_offset + wmeta->padframe.size.x
 355                < getmaxx(wmeta->padframe.curses_win)))
 356     {
 357         wmeta->pad_offset = new_offset;
 358     }
 359 }
 360
 361
 362
 363 extern void resize_active_win(struct WinMeta * wmeta, struct yx_uint16 size)
 364 {
 365     if (0 != wmeta->active
 366         && size.x > 0 && size.y > 0
 367         && size.y < wmeta->padframe.size.y)
 368     {
 369         wmeta->active->frame.size = size;
 370         update_wins(wmeta, wmeta->chain_start);   /* Positioning of successor */
 371     }                                             /* windows may be affected. */
 372 }
 373
 374
 375
 376 extern void cycle_active_win(struct WinMeta * wmeta, char dir)
 377 {
 378     if (0 != wmeta->active)
 379     {
 380         if ('n' == dir)
 381         {
 382             if (wmeta->active->next != 0)
 383             {
 384                 wmeta->active = wmeta->active->next;
 385             }
 386             else
 387             {
 388                 wmeta->active = wmeta->chain_start;
 389             }
 390         }
 391         else
 392         {
 393             if (wmeta->active->prev != 0)
 394             {
 395                 wmeta->active = wmeta->active->prev;
 396             }
 397             else
 398             {
 399                 wmeta->active = wmeta->chain_end;
 400             }
 401         }
 402     }
 403 }
 404
 405
 406
 407 extern void shift_active_win(struct WinMeta * wmeta, char dir)
 408 {
 409     if (0 != wmeta->active                        /* No shifting with less    */
 410         && wmeta->chain_start != wmeta->chain_end /* than one window visible. */
 411         && (dir == 'f' || dir == 'b'))
 412     {
 413         struct Win * w_shift = wmeta->active, * w_p, * w_p_next;
 414
 415         /* Check if shifting will lead to wrapping. */
 416         char wrap = 0;
 417         if (   (dir == 'f' && w_shift == wmeta->chain_end)
 418             || (dir == 'b' && w_shift == wmeta->chain_start))
 419         {
 420             wrap = 1;
 421         }
 422
 423         /* Suspend all visible windows, remember their order in wins[]. */
 424         uint16_t i, i_max;
 425         for (w_p  = wmeta->chain_start, i_max = 1;
 426              w_p != wmeta->chain_end;
 427              w_p  = w_p->next)
 428         {
 429             i_max++;
 430         }
 431         struct Win ** wins = malloc(i_max * sizeof(struct Win *));
 432         for (i = 0, w_p = wmeta->chain_start;
 433              i < i_max;
 434              i++)
 435         {
 436             w_p_next = w_p->next;
 437             suspend_win(wmeta, w_p);
 438             wins[i] = w_p;
 439             w_p = w_p_next;
 440         }
 441
 442         /* Re-append all previously visible windows in the new order. */
 443         if (wrap)
 444         {
 445             if (dir == 'f')
 446             {
 447                 append_win(wmeta, w_shift);
 448                 for (i = 0; i < i_max - 1; i++)
 449                 {
 450                     append_win(wmeta, wins[i]);
 451                 }
 452             }
 453             else
 454             {
 455                 for (i = 1; i < i_max; i++)
 456                 {
 457                     append_win(wmeta, wins[i]);
 458                 }
 459                 append_win(wmeta, w_shift);
 460             }
 461         }
 462         else
 463         {
 464             for (i = 0; i < i_max; i++)
 465             {
 466                 if (   (dir == 'f' && w_shift == wins[i])
 467                     || (dir == 'b' && w_shift == wins[i+1]))
 468                 {
 469                     append_win(wmeta, wins[i+1]);
 470                     append_win(wmeta, wins[i]);
 471                     i++;
 472                 }
 473                 else
 474                 {
 475                     append_win(wmeta, wins[i]);
 476                 }
 477             }
 478         }
 479         free(wins);
 480
 481         wmeta->active = w_shift;  /* Otherwise lastly appended win is active. */
 482     }
 483 }
 484
 485
 486
 487 extern void draw_all_wins(struct WinMeta * wmeta)
 488 {
 489     /* Empty everything before filling it a-new. */
 490     erase();
 491     wnoutrefresh(wmeta->screen);
 492     werase(wmeta->padframe.curses_win);
 493     if (wmeta->chain_start)
 494     {
 495
 496         /* Draw windows' contents first, then their borders. */
 497         draw_wins(wmeta->chain_start);
 498         draw_wins_borderlines(wmeta->chain_start, wmeta->active,
 499                               wmeta->padframe.curses_win);
 500         draw_wins_bordercorners(wmeta->chain_start, wmeta->padframe.curses_win);
 501
 502         /* Draw virtual screen scroll hints. */
 503         if (wmeta->pad_offset > 0)
 504         {
 505             draw_scroll_hint(&wmeta->padframe,
 506                              wmeta->pad_offset, wmeta->pad_offset + 1, '<');
 507         }
 508         if (wmeta->pad_offset + wmeta->padframe.size.x
 509             < getmaxx(wmeta->padframe.curses_win) - 1)
 510         {
 511             draw_scroll_hint(&wmeta->padframe,
 512                              wmeta->pad_offset + wmeta->padframe.size.x - 1,
 513                              getmaxx(wmeta->padframe.curses_win)
 514                              - (wmeta->pad_offset + wmeta->padframe.size.x),
 515                              '>');
 516         }
 517
 518         /* Write virtual screen segment to be shown on physical screen into */
 519         /* ncurses screen buffer. */
 520         pnoutrefresh(wmeta->padframe.curses_win, 0, wmeta->pad_offset, 0, 0,
 521                      wmeta->padframe.size.y, wmeta->padframe.size.x-1);
 522     }
 523
 524     /* Only at the end write accumulated changes to the physical screen. */
 525     doupdate();
 526 }
 527
 528
 529
 530 extern void draw_scroll_hint(struct Frame * frame, uint16_t pos, uint32_t dist,
 531                              char dir)
 532 {
 533     /* Decide on alignment (vertical/horizontal?), thereby scroll hint text. */
 534     char * more = "more";
 535     char * unit_cols = "columns";
 536     char * unit_rows = "lines";
 537     uint16_t dsc_space = frame->size.x;
 538     char * unit = unit_rows;
 539     if ('<' == dir || '>' == dir)
 540     {
 541         dsc_space = frame->size.y;
 542         unit = unit_cols;
 543     }
 544     char * scrolldsc = malloc((4 * sizeof(char)) + strlen(more) + strlen(unit)
 545                               + 10);                /* 10 = uint32 max strlen */
 546     sprintf(scrolldsc, " %d %s %s ", dist, more, unit);
 547
 548     /* Decide on offset of the description text inside the scroll hint line. */
 549     char offset = 1, q;
 550     if (dsc_space > strlen(scrolldsc) + 1)
 551     {
 552         offset = (dsc_space - strlen(scrolldsc)) / 2;
 553     }
 554
 555     /* Draw scroll hint line as dir symbols bracketing description text. */
 556     chtype symbol;
 557     for (q = 0; q < dsc_space; q++)
 558     {
 559         if (q >= offset && q < strlen(scrolldsc) + offset)
 560         {
 561             symbol = scrolldsc[q - offset] | A_REVERSE;
 562         }
 563         else
 564         {
 565             symbol = dir | A_REVERSE;
 566         }
 567         if ('<' == dir || '>' == dir)
 568         {
 569             mvwaddch(frame->curses_win, q, pos, symbol);
 570         }
 571         else
 572         {
 573             mvwaddch(frame->curses_win, pos, q, symbol);
 574         }
 575     }
 576
 577     free(scrolldsc);
 578 }