ncurses/base/resizeterm.c

   1 /****************************************************************************
   2  * Copyright (c) 1998-2007,2008 Free Software Foundation, Inc.              *
   3  *                                                                          *
   4  * Permission is hereby granted, free of charge, to any person obtaining a  *
   5  * copy of this software and associated documentation files (the            *
   6  * "Software"), to deal in the Software without restriction, including      *
   7  * without limitation the rights to use, copy, modify, merge, publish,      *
   8  * distribute, distribute with modifications, sublicense, and/or sell       *
   9  * copies of the Software, and to permit persons to whom the Software is    *
  10  * furnished to do so, subject to the following conditions:                 *
  11  *                                                                          *
  12  * The above copyright notice and this permission notice shall be included  *
  13  * in all copies or substantial portions of the Software.                   *
  14  *                                                                          *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  18  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  21  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  22  *                                                                          *
  23  * Except as contained in this notice, the name(s) of the above copyright   *
  24  * holders shall not be used in advertising or otherwise to promote the     *
  25  * sale, use or other dealings in this Software without prior written       *
  26  * authorization.                                                           *
  27  ****************************************************************************/
  28
  29 /****************************************************************************
  30  *  Author: Thomas E. Dickey                                                *
  31  ****************************************************************************/
  32
  33 /*
  34  * This is an extension to the curses library.  It provides callers with a hook
  35  * into the NCURSES data to resize windows, primarily for use by programs
  36  * running in an X Window terminal (e.g., xterm).  I abstracted this module
  37  * from my application library for NCURSES because it must be compiled with
  38  * the private data structures -- T.Dickey 1995/7/4.
  39  */
  40
  41 #include <curses.priv.h>
  42 #include <term.h>
  43
  44 MODULE_ID("$Id: resizeterm.c,v 1.28 2008/01/06 01:23:36 tom Exp $")
  45
  46 #define stolen_lines (screen_lines - SP->_lines_avail)
  47
  48 /*
  49  * If we're trying to be reentrant, do not want any local statics.
  50  */
  51 #if USE_REENTRANT
  52 #define EXTRA_ARGS ,     CurLines,     CurCols
  53 #define EXTRA_DCLS , int CurLines, int CurCols
  54 #else
  55 static int current_lines;
  56 static int current_cols;
  57 #define CurLines current_lines
  58 #define CurCols  current_cols
  59 #define EXTRA_ARGS              /* nothing */
  60 #define EXTRA_DCLS              /* nothing */
  61 #endif
  62
  63 #ifdef TRACE
  64 static void
  65 show_window_sizes(const char *name)
  66 {
  67     WINDOWLIST *wp;
  68
  69     _nc_lock_global(windowlist);
  70     _tracef("%s resizing: %2d x %2d (%2d x %2d)", name, LINES, COLS,
  71             screen_lines, screen_columns);
  72     for (wp = _nc_windows; wp != 0; wp = wp->next) {
  73         _tracef("  window %p is %2ld x %2ld at %2ld,%2ld",
  74                 &(wp->win),
  75                 (long) wp->win._maxy + 1,
  76                 (long) wp->win._maxx + 1,
  77                 (long) wp->win._begy,
  78                 (long) wp->win._begx);
  79     }
  80     _nc_unlock_global(windowlist);
  81 }
  82 #endif
  83
  84 /*
  85  * Return true if the given dimensions do not match the internal terminal
  86  * structure's size.
  87  */
  88 NCURSES_EXPORT(bool)
  89 is_term_resized(int ToLines, int ToCols)
  90 {
  91     T((T_CALLED("is_term_resized(%d, %d)"), ToLines, ToCols));
  92     returnCode(ToLines > 0
  93                && ToCols > 0
  94                && (ToLines != screen_lines
  95                    || ToCols != screen_columns));
  96 }
  97
  98 /*
  99  */
 100 static ripoff_t *
 101 ripped_window(WINDOW *win)
 102 {
 103     ripoff_t *result = 0;
 104     ripoff_t *rop;
 105
 106     if (win != 0) {
 107         for (rop = ripoff_stack; (rop - ripoff_stack) < N_RIPS; rop++) {
 108             if (rop->win == win && rop->line != 0) {
 109                 result = rop;
 110                 break;
 111             }
 112         }
 113     }
 114     return result;
 115 }
 116
 117 /*
 118  * Returns the number of lines from the bottom for the beginning of a ripped
 119  * off window.
 120  */
 121 static int
 122 ripped_bottom(WINDOW *win)
 123 {
 124     int result = 0;
 125     ripoff_t *rop;
 126
 127     if (win != 0) {
 128         for (rop = ripoff_stack; (rop - ripoff_stack) < N_RIPS; rop++) {
 129             if (rop->line < 0) {
 130                 result -= rop->line;
 131                 if (rop->win == win) {
 132                     break;
 133                 }
 134             }
 135         }
 136     }
 137     return result;
 138 }
 139
 140 /*
 141  * Return the number of levels of child-windows under the current window.
 142  */
 143 static int
 144 child_depth(WINDOW *cmp)
 145 {
 146     int depth = 0;
 147
 148     if (cmp != 0) {
 149         WINDOWLIST *wp;
 150
 151         for (wp = _nc_windows; wp != 0; wp = wp->next) {
 152             WINDOW *tst = &(wp->win);
 153             if (tst->_parent == cmp) {
 154                 depth = 1 + child_depth(tst);
 155                 break;
 156             }
 157         }
 158     }
 159     return depth;
 160 }
 161
 162 /*
 163  * Return the number of levels of parent-windows above the current window.
 164  */
 165 static int
 166 parent_depth(WINDOW *cmp)
 167 {
 168     int depth = 0;
 169
 170     if (cmp != 0) {
 171         WINDOW *tst;
 172         while ((tst = cmp->_parent) != 0) {
 173             ++depth;
 174             cmp = tst;
 175         }
 176     }
 177     return depth;
 178 }
 179
 180 /*
 181  * FIXME: must adjust position so it's within the parent!
 182  */
 183 static int
 184 adjust_window(WINDOW *win, int ToLines, int ToCols, int stolen EXTRA_DCLS)
 185 {
 186     int result;
 187     int bottom = CurLines + SP->_topstolen - stolen;
 188     int myLines = win->_maxy + 1;
 189     int myCols = win->_maxx + 1;
 190     ripoff_t *rop = ripped_window(win);
 191
 192     T((T_CALLED("adjust_window(%p,%d,%d)%s depth %d/%d currently %ldx%ld at %ld,%ld"),
 193        win, ToLines, ToCols,
 194        (rop != 0) ? " (rip)" : "",
 195        parent_depth(win),
 196        child_depth(win),
 197        (long) getmaxy(win), (long) getmaxx(win),
 198        (long) getbegy(win) + win->_yoffset, (long) getbegx(win)));
 199
 200     if (rop != 0 && rop->line < 0) {
 201         /*
 202          * If it is a ripped-off window at the bottom of the screen, simply
 203          * move it to the same relative position.
 204          */
 205         win->_begy = ToLines - ripped_bottom(win) - 0 - win->_yoffset;
 206     } else if (win->_begy >= bottom) {
 207         /*
 208          * If it is below the bottom of the new screen, move up by the same
 209          * amount that the screen shrank.
 210          */
 211         win->_begy += (ToLines - CurLines);
 212     } else {
 213         if (myLines == CurLines - stolen
 214             && ToLines != CurLines)
 215             myLines = ToLines - stolen;
 216         else if (myLines == CurLines
 217                  && ToLines != CurLines)
 218             myLines = ToLines;
 219     }
 220
 221     if (myLines > ToLines)
 222         myLines = ToLines;
 223
 224     if (myCols > ToCols)
 225         myCols = ToCols;
 226
 227     if (myLines == CurLines
 228         && ToLines != CurLines)
 229         myLines = ToLines;
 230
 231     if (myCols == CurCols
 232         && ToCols != CurCols)
 233         myCols = ToCols;
 234
 235     result = wresize(win, myLines, myCols);
 236     returnCode(result);
 237 }
 238
 239 /*
 240  * If we're decreasing size, recursively search for windows that have no
 241  * children, decrease those to fit, then decrease the containing window, etc.
 242  */
 243 static int
 244 decrease_size(int ToLines, int ToCols, int stolen EXTRA_DCLS)
 245 {
 246     bool found;
 247     int depth = 0;
 248     WINDOWLIST *wp;
 249
 250     T((T_CALLED("decrease_size(%d, %d)"), ToLines, ToCols));
 251
 252     do {
 253         found = FALSE;
 254         TR(TRACE_UPDATE, ("decreasing size of windows to %dx%d, depth=%d",
 255                           ToLines, ToCols, depth));
 256         for (wp = _nc_windows; wp != 0; wp = wp->next) {
 257             WINDOW *win = &(wp->win);
 258
 259             if (!(win->_flags & _ISPAD)) {
 260                 if (child_depth(win) == depth) {
 261                     found = TRUE;
 262                     if (adjust_window(win, ToLines, ToCols,
 263                                       stolen EXTRA_ARGS) != OK)
 264                         returnCode(ERR);
 265                 }
 266             }
 267         }
 268         ++depth;
 269     } while (found);
 270     returnCode(OK);
 271 }
 272
 273 /*
 274  * If we're increasing size, recursively search for windows that have no
 275  * parent, increase those to fit, then increase the contained window, etc.
 276  */
 277 static int
 278 increase_size(int ToLines, int ToCols, int stolen EXTRA_DCLS)
 279 {
 280     bool found;
 281     int depth = 0;
 282     WINDOWLIST *wp;
 283
 284     T((T_CALLED("increase_size(%d, %d)"), ToLines, ToCols));
 285
 286     do {
 287         found = FALSE;
 288         TR(TRACE_UPDATE, ("increasing size of windows to %dx%d, depth=%d",
 289                           ToLines, ToCols, depth));
 290         for (wp = _nc_windows; wp != 0; wp = wp->next) {
 291             WINDOW *win = &(wp->win);
 292
 293             if (!(win->_flags & _ISPAD)) {
 294                 if (parent_depth(win) == depth) {
 295                     found = TRUE;
 296                     if (adjust_window(win, ToLines, ToCols,
 297                                       stolen EXTRA_ARGS) != OK)
 298                         returnCode(ERR);
 299                 }
 300             }
 301         }
 302         ++depth;
 303     } while (found);
 304     returnCode(OK);
 305 }
 306
 307 /*
 308  * This function reallocates NCURSES window structures, with no side-effects
 309  * such as ungetch().
 310  */
 311 NCURSES_EXPORT(int)
 312 resize_term(int ToLines, int ToCols)
 313 {
 314     int result = OK EXTRA_ARGS;
 315     int was_stolen;
 316
 317     T((T_CALLED("resize_term(%d,%d) old(%d,%d)"),
 318        ToLines, ToCols,
 319        screen_lines, screen_columns));
 320
 321     if (SP == 0) {
 322         returnCode(ERR);
 323     }
 324
 325     _nc_lock_global(windowlist);
 326
 327     was_stolen = (screen_lines - SP->_lines_avail);
 328     if (is_term_resized(ToLines, ToCols)) {
 329         int myLines = CurLines = screen_lines;
 330         int myCols = CurCols = screen_columns;
 331
 332 #ifdef TRACE
 333         if (USE_TRACEF(TRACE_UPDATE)) {
 334             show_window_sizes("before");
 335             _nc_unlock_global(tracef);
 336         }
 337 #endif
 338         if (ToLines > screen_lines) {
 339             increase_size(myLines = ToLines, myCols, was_stolen EXTRA_ARGS);
 340             CurLines = myLines;
 341             CurCols = myCols;
 342         }
 343
 344         if (ToCols > screen_columns) {
 345             increase_size(myLines, myCols = ToCols, was_stolen EXTRA_ARGS);
 346             CurLines = myLines;
 347             CurCols = myCols;
 348         }
 349
 350         if (ToLines < myLines ||
 351             ToCols < myCols) {
 352             decrease_size(ToLines, ToCols, was_stolen EXTRA_ARGS);
 353         }
 354
 355         screen_lines = lines = ToLines;
 356         screen_columns = columns = ToCols;
 357
 358         SP->_lines_avail = lines - was_stolen;
 359
 360         if (SP->oldhash) {
 361             FreeAndNull(SP->oldhash);
 362         }
 363         if (SP->newhash) {
 364             FreeAndNull(SP->newhash);
 365         }
 366 #ifdef TRACE
 367         if (USE_TRACEF(TRACE_UPDATE)) {
 368             SET_LINES(ToLines - was_stolen);
 369             SET_COLS(ToCols);
 370             show_window_sizes("after");
 371             _nc_unlock_global(tracef);
 372         }
 373 #endif
 374     }
 375
 376     /*
 377      * Always update LINES, to allow for call from lib_doupdate.c which
 378      * needs to have the count adjusted by the stolen (ripped off) lines.
 379      */
 380     SET_LINES(ToLines - was_stolen);
 381     SET_COLS(ToCols);
 382
 383     _nc_unlock_global(windowlist);
 384
 385     returnCode(result);
 386 }
 387
 388 /*
 389  * This function reallocates NCURSES window structures.  It is invoked in
 390  * response to a SIGWINCH interrupt.  Other user-defined windows may also need
 391  * to be reallocated.
 392  *
 393  * Because this performs memory allocation, it should not (in general) be
 394  * invoked directly from the signal handler.
 395  */
 396 NCURSES_EXPORT(int)
 397 resizeterm(int ToLines, int ToCols)
 398 {
 399     int result = ERR;
 400
 401     T((T_CALLED("resizeterm(%d,%d) old(%d,%d)"),
 402        ToLines, ToCols,
 403        screen_lines, screen_columns));
 404
 405     if (SP != 0) {
 406         result = OK;
 407         SP->_sig_winch = FALSE;
 408
 409         if (is_term_resized(ToLines, ToCols)) {
 410 #if USE_SIGWINCH
 411             ripoff_t *rop;
 412             bool slk_visible = (SP != 0
 413                                 && SP->_slk != 0
 414                                 && !(SP->_slk->hidden));
 415
 416             if (slk_visible) {
 417                 slk_clear();
 418             }
 419 #endif
 420             result = resize_term(ToLines, ToCols);
 421
 422 #if USE_SIGWINCH
 423             ungetch(KEY_RESIZE);        /* so application can know this */
 424             clearok(curscr, TRUE);      /* screen contents are unknown */
 425
 426             /* ripped-off lines are a special case: if we did not lengthen
 427              * them, we haven't moved them either.  repaint them, too.
 428              */
 429             for (rop = ripoff_stack; (rop - ripoff_stack) < N_RIPS; rop++) {
 430                 if (rop->win != stdscr
 431                     && rop->win != 0
 432                     && rop->line < 0) {
 433
 434                     if (rop->hook != _nc_slk_initialize) {
 435                         touchwin(rop->win);
 436                         wnoutrefresh(rop->win);
 437                     }
 438                 }
 439             }
 440
 441             /* soft-keys are a special case: we _know_ how to repaint them */
 442             if (slk_visible) {
 443                 slk_restore();
 444                 slk_touch();
 445
 446                 slk_refresh();
 447             }
 448 #endif
 449         }
 450     }
 451
 452     returnCode(result);
 453 }