test/movewindow.c

   1 /****************************************************************************
   2  * Copyright 2018-2020,2021 Thomas E. Dickey                                *
   3  * Copyright 2006-2013,2017 Free Software Foundation, Inc.                  *
   4  *                                                                          *
   5  * Permission is hereby granted, free of charge, to any person obtaining a  *
   6  * copy of this software and associated documentation files (the            *
   7  * "Software"), to deal in the Software without restriction, including      *
   8  * without limitation the rights to use, copy, modify, merge, publish,      *
   9  * distribute, distribute with modifications, sublicense, and/or sell       *
  10  * copies of the Software, and to permit persons to whom the Software is    *
  11  * furnished to do so, subject to the following conditions:                 *
  12  *                                                                          *
  13  * The above copyright notice and this permission notice shall be included  *
  14  * in all copies or substantial portions of the Software.                   *
  15  *                                                                          *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23  *                                                                          *
  24  * Except as contained in this notice, the name(s) of the above copyright   *
  25  * holders shall not be used in advertising or otherwise to promote the     *
  26  * sale, use or other dealings in this Software without prior written       *
  27  * authorization.                                                           *
  28  ****************************************************************************/
  29 /*
  30  * $Id: movewindow.c,v 1.52 2021/12/18 18:57:55 tom Exp $
  31  *
  32  * Demonstrate move functions for windows and derived windows from the curses
  33  * library.
  34  *
  35  * Author: Thomas E. Dickey
  36  */
  37 /*
  38 derwin
  39 mvderwin
  40 subwin
  41 mvwin
  42
  43 TODO:
  44     add command to reset subwindow's origin to coincide with parent.
  45     add command to delete subwindow (check if it has subwindows though)
  46  */
  47
  48 #include <test.priv.h>
  49
  50 #if HAVE_MVDERWIN && HAVE_MVWIN
  51
  52 #include <popup_msg.h>
  53
  54 #ifdef HAVE_XCURSES
  55 #undef derwin
  56 #endif
  57
  58 #undef LINE_MAX
  59
  60 #define LINE_MIN        2
  61 #define LINE_MAX        (LINES - 2)
  62 #define COL_MIN         2
  63 #define COL_MAX         (COLS - 2)
  64
  65 typedef struct {
  66     int y, x;
  67 } PAIR;
  68
  69 typedef struct {
  70     WINDOW *parent;             /* need this since WINDOW->_parent is not portable */
  71     WINDOW *child;              /* the actual value */
  72 } FRAME;
  73
  74 static void head_line(CONST_FMT char *fmt, ...) GCC_PRINTFLIKE(1, 2);
  75 static void tail_line(CONST_FMT char *fmt, ...) GCC_PRINTFLIKE(1, 2);
  76
  77 static unsigned num_windows;
  78 static FRAME *all_windows;
  79
  80 static void
  81 failed(const char *s)
  82 {
  83     perror(s);
  84     endwin();
  85     ExitProgram(EXIT_FAILURE);
  86 }
  87
  88 static void
  89 message(int lineno, CONST_FMT char *fmt, va_list argp)
  90 {
  91     int y, x;
  92
  93     getyx(stdscr, y, x);
  94     move(lineno, 0);
  95     clrtoeol();
  96
  97 #ifdef HAVE_XCURSES
  98     {
  99         char buffer[1024];
 100         vsprintf(buffer, fmt, argp);
 101         addstr(buffer);
 102     }
 103 #elif defined(HAVE_VW_PRINTW)
 104     vw_printw(stdscr, fmt, argp);
 105 #else
 106     vwprintw(stdscr, fmt, argp);
 107 #endif
 108
 109     move(y, x);
 110     refresh();
 111 }
 112
 113 static void
 114 head_line(CONST_FMT char *fmt, ...)
 115 {
 116     va_list argp;
 117
 118     va_start(argp, fmt);
 119     message(0, fmt, argp);
 120     va_end(argp);
 121 }
 122
 123 static void
 124 tail_line(CONST_FMT char *fmt, ...)
 125 {
 126     va_list argp;
 127
 128     va_start(argp, fmt);
 129     message(LINES - 1, fmt, argp);
 130     va_end(argp);
 131 }
 132
 133 /*
 134  * Arrow keys move cursor, return location at current on non-arrow key.
 135  */
 136 static PAIR *
 137 selectcell(WINDOW *parent,
 138            WINDOW *child,
 139            int uli, int ulj,
 140            int lri, int lrj,
 141            bool relative,
 142            bool * more)
 143 {
 144     static PAIR res;            /* result cell */
 145     int si = lri - uli + 1;     /* depth of the select area */
 146     int sj = lrj - ulj + 1;     /* width of the select area */
 147     int i = 0, j = 0;           /* offsets into the select area */
 148
 149     res.y = uli;
 150     res.x = ulj;
 151
 152     if (child != 0) {
 153         if (relative) {
 154             getparyx(child, i, j);
 155         } else {
 156             getbegyx(child, i, j);
 157             i -= uli + getbegy(parent);
 158             j -= ulj + getbegx(parent);
 159         }
 160     }
 161
 162     if (more)
 163         *more = FALSE;
 164
 165     for (;;) {
 166         bool moved = FALSE;
 167
 168         tail_line("Upper left [%2d,%2d] Lower right [%2d,%2d] -> %d,%d -> %d,%d",
 169                   uli, ulj,
 170                   lri, lrj,
 171                   i, j,
 172                   uli + i, ulj + j);
 173         wmove(parent, uli + i, ulj + j);
 174
 175         switch (wgetch(parent)) {
 176         case KEY_UP:
 177             i += si - 1;
 178             moved = TRUE;
 179             break;
 180         case KEY_DOWN:
 181             i++;
 182             moved = TRUE;
 183             break;
 184         case KEY_LEFT:
 185             j += sj - 1;
 186             moved = TRUE;
 187             break;
 188         case KEY_RIGHT:
 189             j++;
 190             moved = TRUE;
 191             break;
 192         case QUIT:
 193             /* FALLTHRU */
 194         case ESCAPE:
 195             return ((PAIR *) 0);
 196 #ifdef NCURSES_MOUSE_VERSION
 197         case KEY_MOUSE:
 198             {
 199                 MEVENT event;
 200
 201                 getmouse(&event);
 202                 if (event.y > uli && event.x > ulj) {
 203                     if (parent != stdscr) {
 204                         i = event.y - getbegy(parent) - uli;
 205                         j = event.x - getbegx(parent) - ulj;
 206                     } else {
 207                         i = event.y - uli;
 208                         j = event.x - ulj;
 209                     }
 210                 } else {
 211                     beep();
 212                     break;
 213                 }
 214             }
 215 #endif
 216             /* FALLTHRU */
 217         default:
 218             res.y = uli + i;
 219             res.x = ulj + j;
 220             return (&res);
 221         }
 222
 223         if (si <= 0)
 224             i = 0;
 225         else
 226             i %= si;
 227
 228         if (sj <= 0)
 229             j = 0;
 230         else
 231             j %= sj;
 232
 233         /*
 234          * If the caller can handle continuous movement, return the result.
 235          */
 236         if (moved && more) {
 237             *more = TRUE;
 238             res.y = uli + i;
 239             res.x = ulj + j;
 240             return (&res);
 241         }
 242     }
 243 }
 244
 245 /*
 246  * Ask user for a window definition.
 247  */
 248 static bool
 249 getwindow(WINDOW *parent, PAIR * ul, PAIR * lr)
 250 {
 251     int min_col = (parent == stdscr) ? COL_MIN : 0;
 252     int max_col = (parent == stdscr) ? COL_MAX : getmaxx(parent);
 253     int min_line = (parent == stdscr) ? LINE_MIN : 0;
 254     int max_line = (parent == stdscr) ? LINE_MAX : getmaxy(parent);
 255     PAIR *tmp;
 256     bool result = FALSE;
 257
 258     head_line("Use arrows to move cursor, anything else to mark corner 1");
 259     if ((tmp = selectcell(parent, 0,
 260                           min_line, min_col,
 261                           max_line, max_col,
 262                           FALSE,
 263                           (bool *) 0)) != 0) {
 264         *ul = *tmp;
 265         MvWAddCh(parent, ul->y, ul->x, '*');
 266
 267         head_line("Use arrows to move cursor, anything else to mark corner 2");
 268         if ((tmp = selectcell(parent, 0,
 269                               ul->y, ul->x,
 270                               max_line, max_col,
 271                               FALSE,
 272                               (bool *) 0)) != 0) {
 273             *lr = *tmp;
 274             MvWAddCh(parent, lr->y, lr->x, '*');
 275             wmove(parent, lr->y, lr->x);
 276             wsyncdown(parent);
 277             wrefresh(parent);
 278             result = (lr->y != ul->y && lr->x != ul->x);
 279         }
 280     }
 281     head_line("done");
 282     return result;
 283 }
 284
 285 /*
 286  * Draw a box inside the given window.
 287  */
 288 static void
 289 box_inside(WINDOW *win)
 290 {
 291     int y0, x0;
 292     int y1, x1;
 293
 294     getyx(win, y0, x0);
 295     getmaxyx(win, y1, x1);
 296
 297     MvWHLine(win, 0, 0, ACS_HLINE, x1);
 298     MvWHLine(win, y1 - 1, 0, ACS_HLINE, x1);
 299
 300     MvWVLine(win, 0, 0, ACS_VLINE, y1);
 301     MvWVLine(win, 0, x1 - 1, ACS_VLINE, y1);
 302
 303     MvWAddCh(win, 0, 0, ACS_ULCORNER);
 304     MvWAddCh(win, y1 - 1, 0, ACS_LLCORNER);
 305     MvWAddCh(win, 0, x1 - 1, ACS_URCORNER);
 306     MvWAddCh(win, y1 - 1, x1 - 1, ACS_LRCORNER);
 307
 308     wsyncdown(win);
 309     wmove(win, y0, x0);
 310     wrefresh(win);
 311 }
 312
 313 /*
 314  * Add a window to our list.
 315  */
 316 static void
 317 add_window(WINDOW *parent, WINDOW *child)
 318 {
 319     static unsigned have = 0;
 320     unsigned need = ((num_windows + 1) | 31) + 1;
 321
 322     keypad(child, TRUE);
 323     if (need > have) {
 324         all_windows = typeRealloc(FRAME, need, all_windows);
 325         if (!all_windows)
 326             failed("add_window");
 327     }
 328     all_windows[num_windows].parent = parent;
 329     all_windows[num_windows].child = child;
 330     num_windows++;
 331 }
 332
 333 static int
 334 window2num(WINDOW *win)
 335 {
 336     int n;
 337     int result = -1;
 338     for (n = 0; n < (int) num_windows; ++n) {
 339         if (win == all_windows[n].child) {
 340             result = n;
 341             break;
 342         }
 343     }
 344     return result;
 345 }
 346
 347 static WINDOW *
 348 parent_of(WINDOW *win)
 349 {
 350     WINDOW *result = 0;
 351     int n = window2num(win);
 352     if (n >= 0)
 353         result = all_windows[n].parent;
 354     return result;
 355 }
 356
 357 static void
 358 repaint_one(WINDOW *win)
 359 {
 360     touchwin(win);
 361     wnoutrefresh(win);
 362 }
 363
 364 static void
 365 refresh_all(WINDOW *win)
 366 {
 367     unsigned n;
 368
 369     for (n = 0; n < num_windows; ++n) {
 370         if (all_windows[n].child != win) {
 371             repaint_one(all_windows[n].child);
 372         }
 373     }
 374
 375     repaint_one(win);
 376     doupdate();
 377 }
 378
 379 static WINDOW *
 380 next_window(WINDOW *win)
 381 {
 382     WINDOW *result = win;
 383     int n = window2num(win);
 384
 385     if (n++ >= 0) {
 386         result = all_windows[(unsigned) n % num_windows].child;
 387         wmove(result, 0, 0);
 388         wrefresh(result);
 389     }
 390     return result;
 391 }
 392
 393 static WINDOW *
 394 prev_window(WINDOW *win)
 395 {
 396     WINDOW *result = win;
 397     int n = window2num(win);
 398
 399     if (n-- >= 0) {
 400         if (n < 0)
 401             n = (int) (num_windows - 1);
 402         result = all_windows[(unsigned) n % num_windows].child;
 403         wmove(result, 0, 0);
 404         wrefresh(result);
 405     }
 406     return result;
 407 }
 408
 409 static void
 410 recur_move_window(WINDOW *parent, int dy, int dx)
 411 {
 412     unsigned n;
 413
 414     for (n = 0; n < num_windows; ++n) {
 415         if (all_windows[n].parent == parent) {
 416             mvwin(all_windows[n].child, dy, dx);
 417             recur_move_window(all_windows[n].child, dy, dx);
 418         }
 419     }
 420 }
 421
 422 /*
 423  * test mvwin().
 424  */
 425 static bool
 426 move_window(WINDOW *win, bool recur)
 427 {
 428     WINDOW *parent = parent_of(win);
 429     bool result = FALSE;
 430
 431     if (parent != 0) {
 432         bool top = (parent == stdscr);
 433         int min_col = top ? COL_MIN : 0;
 434         int max_col = top ? COL_MAX : getmaxx(parent);
 435         int min_line = top ? LINE_MIN : 0;
 436         int max_line = top ? LINE_MAX : getmaxy(parent);
 437         PAIR *tmp;
 438         bool more;
 439
 440         head_line("Select new position for %swindow", top ? "" : "sub");
 441
 442         while ((tmp = selectcell(parent,
 443                                  win,
 444                                  min_line, min_col,
 445                                  max_line, max_col,
 446                                  FALSE,
 447                                  &more)) != 0) {
 448             int y0, x0;
 449             getbegyx(parent, y0, x0);
 450             /*
 451              * Moving a subwindow has the effect of moving a viewport around
 452              * the screen.  The parent window retains the contents of the
 453              * subwindow in the original location, but the viewport will show
 454              * the contents (again) at the new location.  So it will look odd
 455              * when testing.
 456              */
 457             if (mvwin(win, y0 + tmp->y, x0 + tmp->x) != ERR) {
 458                 if (recur) {
 459                     recur_move_window(win, tmp->y, tmp->x);
 460                 }
 461                 refresh_all(win);
 462                 doupdate();
 463                 result = TRUE;
 464             } else {
 465                 result = FALSE;
 466             }
 467             if (!more)
 468                 break;
 469         }
 470     }
 471     head_line("done");
 472     return result;
 473 }
 474
 475 static void
 476 show_derwin(WINDOW *win)
 477 {
 478     int pary, parx, maxy, maxx;
 479
 480     getmaxyx(win, maxy, maxx);
 481     getparyx(win, pary, parx);
 482
 483     head_line("Select new position for derived window at %d,%d (%d,%d)",
 484               pary, parx, maxy, maxx);
 485 }
 486
 487 /*
 488  * test mvderwin().
 489  */
 490 static bool
 491 move_derwin(WINDOW *win)
 492 {
 493     WINDOW *parent = parent_of(win);
 494     bool result = FALSE;
 495
 496     if (parent != 0) {
 497         bool top = (parent == stdscr);
 498         int min_col = top ? COL_MIN : 0;
 499         int max_col = top ? COL_MAX : getmaxx(parent);
 500         int min_line = top ? LINE_MIN : 0;
 501         int max_line = top ? LINE_MAX : getmaxy(parent);
 502         PAIR *tmp;
 503         bool more;
 504
 505         show_derwin(win);
 506         while ((tmp = selectcell(parent,
 507                                  win,
 508                                  min_line, min_col,
 509                                  max_line, max_col,
 510                                  TRUE,
 511                                  &more)) != 0) {
 512             if (mvderwin(win, tmp->y, tmp->x) != ERR) {
 513                 refresh_all(win);
 514                 doupdate();
 515                 repaint_one(win);
 516                 doupdate();
 517                 result = TRUE;
 518                 show_derwin(win);
 519             } else {
 520                 flash();
 521             }
 522             if (!more)
 523                 break;
 524         }
 525     }
 526     head_line("done");
 527     return result;
 528 }
 529
 530 static void
 531 fill_window(WINDOW *win, chtype ch)
 532 {
 533     int y, x;
 534     int y0, x0;
 535     int y1, x1;
 536
 537     getyx(win, y0, x0);
 538     getmaxyx(win, y1, x1);
 539     for (y = 0; y < y1; ++y) {
 540         for (x = 0; x < x1; ++x) {
 541             MvWAddCh(win, y, x, ch);
 542         }
 543     }
 544     wsyncdown(win);
 545     wmove(win, y0, x0);
 546     wrefresh(win);
 547 }
 548
 549 static void
 550 fill_with_pattern(WINDOW *win)
 551 {
 552     int y, x;
 553     int y0, x0;
 554     int y1, x1;
 555     int ch = 'a';
 556
 557     getyx(win, y0, x0);
 558     getmaxyx(win, y1, x1);
 559     for (y = 0; y < y1; ++y) {
 560         for (x = 0; x < x1; ++x) {
 561             MvWAddCh(win, y, x, (chtype) ch);
 562             if (++ch > 'z')
 563                 ch = 'a';
 564         }
 565     }
 566     wsyncdown(win);
 567     wmove(win, y0, x0);
 568     wrefresh(win);
 569 }
 570
 571 #define lines_of(ul,lr) (lr.y - ul.y + 1)
 572 #define cols_of(ul,lr)  (lr.x - ul.x + 1)
 573 #define pair_of(ul)     ul.y, ul.x
 574
 575 static WINDOW *
 576 create_my_window(WINDOW *current)
 577 {
 578     PAIR ul, lr;
 579     WINDOW *result = 0;
 580
 581     if (getwindow(stdscr, &ul, &lr)) {
 582         result = newwin(lines_of(ul, lr), cols_of(ul, lr), pair_of(ul));
 583         if (result != 0) {
 584             fill_window(result, 'c');
 585             add_window(stdscr, result);
 586         }
 587     }
 588     if (result == 0)
 589         result = current;
 590     return result;
 591 }
 592
 593 static WINDOW *
 594 create_my_derwin(WINDOW *parent)
 595 {
 596     PAIR ul, lr;
 597     WINDOW *result = 0;
 598
 599     if (getwindow(parent, &ul, &lr)) {
 600         result = derwin(parent, lines_of(ul, lr), cols_of(ul, lr), pair_of(ul));
 601         if (result != 0) {
 602             fill_window(result, 'd');
 603             add_window(parent, result);
 604         }
 605     }
 606     if (result == 0)
 607         result = parent;
 608     return result;
 609 }
 610
 611 static WINDOW *
 612 create_my_subwin(WINDOW *parent)
 613 {
 614     PAIR ul, lr;
 615     WINDOW *result = 0;
 616
 617     if (getwindow(parent, &ul, &lr)) {
 618         result = subwin(parent,
 619                         lines_of(ul, lr),
 620                         cols_of(ul, lr),
 621                         ul.y + getbegy(parent),
 622                         ul.x + getbegx(parent));
 623         if (result != 0) {
 624             fill_window(result, 's');
 625             add_window(parent, result);
 626         }
 627     }
 628     if (result == 0)
 629         result = parent;
 630     return result;
 631 }
 632
 633 static void
 634 show_help(WINDOW *current)
 635 {
 636     /* *INDENT-OFF* */
 637     static struct {
 638         int     key;
 639         CONST_FMT char * msg;
 640     } help[] = {
 641         { HELP_KEY_1,   "Show this screen" },
 642         { 'b',          "Draw a box inside the current window" },
 643         { 'c',          "Create a new window" },
 644         { 'd',          "Create a new derived window" },
 645         { 'D',          "Move derived window (moves viewport)" },
 646         { 'f',          "Fill the current window with the next character" },
 647         { 'F',          "Fill the current window with a pattern" },
 648         { 'm',          "Move the current window" },
 649         { 'M',          "Move the current window (and its children)" },
 650         { 'q',          "Quit" },
 651         { 's',          "Create a new subwindow" },
 652         { CTRL('L'),    "Repaint all windows, doing current one last" },
 653         { CTRL('N'),    "Cursor to next window" },
 654         { CTRL('P'),    "Cursor to previous window" },
 655     };
 656     /* *INDENT-ON* */
 657
 658     char **msgs = typeCalloc(char *, SIZEOF(help) + 1);
 659     size_t n;
 660
 661     for (n = 0; n < SIZEOF(help); ++n) {
 662         size_t need = (21 + strlen(help[n].msg));
 663         msgs[n] = typeMalloc(char, need);
 664         _nc_SPRINTF(msgs[n], _nc_SLIMIT(need)
 665                     "%-20s%s", keyname(help[n].key), help[n].msg);
 666     }
 667     popup_msg2(current, msgs);
 668     for (n = 0; n < SIZEOF(help); ++n) {
 669         free(msgs[n]);
 670     }
 671     free(msgs);
 672 }
 673
 674 int
 675 main(int argc GCC_UNUSED, char *argv[]GCC_UNUSED)
 676 {
 677     WINDOW *current_win;
 678     int ch;
 679     bool done = FALSE;
 680
 681     initscr();
 682     cbreak();
 683     noecho();
 684     nonl();
 685     intrflush(stdscr, FALSE);
 686
 687     add_window(0, current_win = stdscr);
 688
 689 #ifdef NCURSES_MOUSE_VERSION
 690     (void) mousemask(BUTTON1_CLICKED, (mmask_t *) NULL);
 691 #endif /* NCURSES_MOUSE_VERSION */
 692
 693     while (!done && (ch = wgetch(current_win)) != ERR) {
 694         int y, x;
 695
 696         getyx(current_win, y, x);
 697
 698         switch (ch) {
 699         case HELP_KEY_1:
 700             show_help(current_win);
 701             break;
 702         case 'b':
 703             box_inside(current_win);
 704             break;
 705         case 'c':
 706             current_win = create_my_window(current_win);
 707             break;
 708         case 'd':
 709             current_win = create_my_derwin(current_win);
 710             break;
 711         case 'D':
 712             if (!move_derwin(current_win)) {
 713                 tail_line("error");
 714                 continue;
 715             }
 716             break;
 717         case 'f':
 718             fill_window(current_win, (chtype) wgetch(current_win));
 719             break;
 720         case 'F':
 721             fill_with_pattern(current_win);
 722             break;
 723         case 'm':
 724         case 'M':
 725             if (!move_window(current_win, (ch == 'M'))) {
 726                 tail_line("error");
 727                 continue;
 728             }
 729             break;
 730         case 'q':
 731             done = TRUE;
 732             break;
 733         case 's':
 734             current_win = create_my_subwin(current_win);
 735             break;
 736         case CTRL('L'):
 737             refresh_all(current_win);
 738             break;
 739         case CTRL('N'):
 740             current_win = next_window(current_win);
 741             break;
 742         case CTRL('P'):
 743             current_win = prev_window(current_win);
 744             break;
 745 #if 0
 746             /* want to allow cursor to move around the current window too */
 747             /* want to test the resizing of windows and subwindows too */
 748             /* want to allow deleting a window also */
 749 #endif
 750         default:
 751             wmove(current_win, y, x);
 752             tail_line("unrecognized key (use '?' for help)");
 753             beep();
 754             continue;
 755         }
 756         tail_line("size [%d,%d] begin [%d,%d] parent [%d,%d]",
 757                   getmaxy(current_win),
 758                   getmaxx(current_win),
 759                   getbegy(current_win),
 760                   getbegx(current_win),
 761                   getpary(current_win),
 762                   getparx(current_win));
 763         wmove(current_win, 0, 0);
 764     }
 765     endwin();
 766 #if NO_LEAKS
 767     free(all_windows);
 768 #endif
 769     ExitProgram(EXIT_SUCCESS);
 770 }
 771 #else
 772 int
 773 main(void)
 774 {
 775     printf("This program requires the curses mvderwin and mvwin functions\n");
 776     ExitProgram(EXIT_FAILURE);
 777 }
 778 #endif