1 /****************************************************************************
2 * Copyright (c) 1998-2009,2011 Free Software Foundation, Inc. *
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: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
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. *
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 *
27 ****************************************************************************/
29 /****************************************************************************
30 * Author: Thomas E. Dickey *
31 * and: Juergen Pfeifer *
32 ****************************************************************************/
35 * This is an extension to the curses library. It provides callers with a hook
36 * into the NCURSES data to resize windows, primarily for use by programs
37 * running in an X Window terminal (e.g., xterm). I abstracted this module
38 * from my application library for NCURSES because it must be compiled with
39 * the private data structures -- T.Dickey 1995/7/4.
42 #include <curses.priv.h>
45 #define CUR SP_TERMTYPE
48 MODULE_ID("$Id: resizeterm.c,v 1.45 2012/07/07 17:07:23 tom Exp $")
51 * If we're trying to be reentrant, do not want any local statics.
54 #define EXTRA_ARGS , CurLines, CurCols
55 #define EXTRA_DCLS , int CurLines, int CurCols
57 static int current_lines;
58 static int current_cols;
59 #define CurLines current_lines
60 #define CurCols current_cols
61 #define EXTRA_ARGS /* nothing */
62 #define EXTRA_DCLS /* nothing */
67 show_window_sizes(const char *name)
72 _nc_lock_global(curses);
73 for (each_screen(sp)) {
74 _tracef("%s resizing: %p: %2d x %2d (%2d x %2d)", name, (void *) sp,
77 screen_lines(sp), screen_columns(sp));
78 for (each_window(sp, wp)) {
79 _tracef(" window %p is %2ld x %2ld at %2ld,%2ld",
81 (long) wp->win._maxy + 1,
82 (long) wp->win._maxx + 1,
84 (long) wp->win._begx);
87 _nc_unlock_global(curses);
92 * Return true if the given dimensions do not match the internal terminal
96 NCURSES_SP_NAME(is_term_resized) (NCURSES_SP_DCLx int ToLines, int ToCols)
98 T((T_CALLED("is_term_resized(%p, %d, %d)"), (void *) SP_PARM, ToLines, ToCols));
99 returnCode(ToLines > 0
101 && (ToLines != screen_lines(SP_PARM)
102 || ToCols != screen_columns(SP_PARM)));
107 is_term_resized(int ToLines, int ToCols)
109 return NCURSES_SP_NAME(is_term_resized) (CURRENT_SCREEN, ToLines, ToCols);
116 ripped_window(WINDOW *win)
118 ripoff_t *result = 0;
123 SCREEN *sp = _nc_screen_of(win);
125 for (each_ripoff(rop)) {
126 if (rop->win == win && rop->line != 0) {
136 * Returns the number of lines from the bottom for the beginning of a ripped
140 ripped_bottom(WINDOW *win)
147 SCREEN *sp = _nc_screen_of(win);
149 for (each_ripoff(rop)) {
152 if (rop->win == win) {
162 * Return the number of levels of child-windows under the current window.
165 child_depth(WINDOW *cmp)
170 #ifdef USE_SP_WINDOWLIST
171 SCREEN *sp = _nc_screen_of(cmp);
175 for (each_window(sp, wp)) {
176 WINDOW *tst = &(wp->win);
177 if (tst->_parent == cmp) {
178 depth = 1 + child_depth(tst);
187 * Return the number of levels of parent-windows above the current window.
190 parent_depth(WINDOW *cmp)
196 while ((tst = cmp->_parent) != 0) {
205 * FIXME: must adjust position so it's within the parent!
208 adjust_window(WINDOW *win, int ToLines, int ToCols, int stolen EXTRA_DCLS)
211 int bottom = CurLines + _nc_screen_of(win)->_topstolen - stolen;
212 int myLines = win->_maxy + 1;
213 int myCols = win->_maxx + 1;
214 ripoff_t *rop = ripped_window(win);
216 T((T_CALLED("adjust_window(%p,%d,%d)%s depth %d/%d currently %ldx%ld at %ld,%ld"),
217 (void *) win, ToLines, ToCols,
218 (rop != 0) ? " (rip)" : "",
221 (long) getmaxy(win), (long) getmaxx(win),
222 (long) getbegy(win) + win->_yoffset, (long) getbegx(win)));
224 if (rop != 0 && rop->line < 0) {
226 * If it is a ripped-off window at the bottom of the screen, simply
227 * move it to the same relative position.
229 win->_begy = (NCURSES_SIZE_T) (ToLines - ripped_bottom(win) - 0 - win->_yoffset);
230 if (rop->hook == _nc_slk_initialize)
236 } else if (win->_begy >= bottom) {
238 * If it is below the bottom of the new screen, move up by the same
239 * amount that the screen shrank.
241 win->_begy = (NCURSES_SIZE_T) (win->_begy + (ToLines - CurLines));
243 if (myLines == (CurLines - stolen)
244 && ToLines != CurLines) {
245 myLines = ToLines - stolen;
246 } else if (myLines == CurLines
247 && ToLines != CurLines) {
252 if (myLines > ToLines) {
259 if (myCols == CurCols
260 && ToCols != CurCols)
263 result = wresize(win, myLines, myCols);
268 * If we're decreasing size, recursively search for windows that have no
269 * children, decrease those to fit, then decrease the containing window, etc.
272 decrease_size(NCURSES_SP_DCLx int ToLines, int ToCols, int stolen EXTRA_DCLS)
278 T((T_CALLED("decrease_size(%p, %d, %d)"), (void *) SP_PARM, ToLines, ToCols));
282 TR(TRACE_UPDATE, ("decreasing size of windows to %dx%d, depth=%d",
283 ToLines, ToCols, depth));
284 for (each_window(SP_PARM, wp)) {
285 WINDOW *win = &(wp->win);
287 if (!(win->_flags & _ISPAD)) {
288 if (child_depth(win) == depth) {
290 if (adjust_window(win, ToLines, ToCols,
291 stolen EXTRA_ARGS) != OK)
302 * If we're increasing size, recursively search for windows that have no
303 * parent, increase those to fit, then increase the contained window, etc.
306 increase_size(NCURSES_SP_DCLx int ToLines, int ToCols, int stolen EXTRA_DCLS)
312 T((T_CALLED("increase_size(%p, %d, %d)"), (void *) SP_PARM, ToLines, ToCols));
316 TR(TRACE_UPDATE, ("increasing size of windows to %dx%d, depth=%d",
317 ToLines, ToCols, depth));
318 for (each_window(SP_PARM, wp)) {
319 WINDOW *win = &(wp->win);
321 if (!(win->_flags & _ISPAD)) {
322 if (parent_depth(win) == depth) {
324 if (adjust_window(win, ToLines, ToCols,
325 stolen EXTRA_ARGS) != OK)
336 * This function reallocates NCURSES window structures, with no side-effects
340 NCURSES_SP_NAME(resize_term) (NCURSES_SP_DCLx int ToLines, int ToCols)
342 int result = OK EXTRA_ARGS;
345 T((T_CALLED("resize_term(%p,%d,%d) old(%d,%d)"),
346 (void *) SP_PARM, ToLines, ToCols,
347 (SP_PARM == 0) ? -1 : screen_lines(SP_PARM),
348 (SP_PARM == 0) ? -1 : screen_columns(SP_PARM)));
354 _nc_nonsp_lock_global(curses);
356 was_stolen = (screen_lines(SP_PARM) - SP_PARM->_lines_avail);
357 if (NCURSES_SP_NAME(is_term_resized) (NCURSES_SP_ARGx ToLines, ToCols)) {
358 int myLines = CurLines = screen_lines(SP_PARM);
359 int myCols = CurCols = screen_columns(SP_PARM);
362 if (USE_TRACEF(TRACE_UPDATE)) {
363 show_window_sizes("before");
364 _nc_unlock_global(tracef);
367 if (ToLines > screen_lines(SP_PARM)) {
368 result = increase_size(NCURSES_SP_ARGx
371 was_stolen EXTRA_ARGS);
377 && (ToCols > screen_columns(SP_PARM))) {
378 result = increase_size(NCURSES_SP_ARGx
381 was_stolen EXTRA_ARGS);
387 && (ToLines < myLines ||
389 result = decrease_size(NCURSES_SP_ARGx
392 was_stolen EXTRA_ARGS);
396 screen_lines(SP_PARM) = (NCURSES_SIZE_T) ToLines;
397 screen_columns(SP_PARM) = (NCURSES_SIZE_T) ToCols;
399 #ifdef USE_TERM_DRIVER
400 CallDriver_2(SP_PARM, setsize, ToLines, ToCols);
402 lines = (NCURSES_SIZE_T) ToLines;
403 columns = (NCURSES_SIZE_T) ToCols;
406 SP_PARM->_lines_avail = (NCURSES_SIZE_T) (ToLines - was_stolen);
408 if (SP_PARM->oldhash) {
409 FreeAndNull(SP_PARM->oldhash);
411 if (SP_PARM->newhash) {
412 FreeAndNull(SP_PARM->newhash);
415 if (USE_TRACEF(TRACE_UPDATE)) {
416 SET_LINES(ToLines - was_stolen);
418 show_window_sizes("after");
419 _nc_unlock_global(tracef);
427 * Always update LINES, to allow for call from lib_doupdate.c which
428 * needs to have the count adjusted by the stolen (ripped off) lines.
430 SET_LINES(ToLines - was_stolen);
434 _nc_nonsp_unlock_global(curses);
441 resize_term(int ToLines, int ToCols)
444 _nc_sp_lock_global(curses);
445 res = NCURSES_SP_NAME(resize_term) (CURRENT_SCREEN, ToLines, ToCols);
446 _nc_sp_unlock_global(curses);
452 * This function reallocates NCURSES window structures. It is invoked in
453 * response to a SIGWINCH interrupt. Other user-defined windows may also need
456 * Because this performs memory allocation, it should not (in general) be
457 * invoked directly from the signal handler.
460 NCURSES_SP_NAME(resizeterm) (NCURSES_SP_DCLx int ToLines, int ToCols)
464 T((T_CALLED("resizeterm(%p, %d,%d) old(%d,%d)"),
465 (void *) SP_PARM, ToLines, ToCols,
466 (SP_PARM == 0) ? -1 : screen_lines(SP_PARM),
467 (SP_PARM == 0) ? -1 : screen_columns(SP_PARM)));
471 SP_PARM->_sig_winch = FALSE;
473 if (NCURSES_SP_NAME(is_term_resized) (NCURSES_SP_ARGx ToLines, ToCols)) {
476 bool slk_visible = (SP_PARM != 0
477 && SP_PARM->_slk != 0
478 && !(SP_PARM->_slk->hidden));
484 result = NCURSES_SP_NAME(resize_term) (NCURSES_SP_ARGx ToLines, ToCols);
487 clearok(CurScreen(SP_PARM), TRUE); /* screen contents are unknown */
489 /* ripped-off lines are a special case: if we did not lengthen
490 * them, we haven't moved them either. repaint them, too.
492 * for the rest - stdscr and other windows - the client has to
493 * decide which to repaint, since without panels, ncurses does
494 * not know which are really on top.
496 for (each_ripoff(rop)) {
497 if (rop->win != StdScreen(SP_PARM)
501 if (rop->hook != _nc_slk_initialize) {
503 wnoutrefresh(rop->win);
508 /* soft-keys are a special case: we _know_ how to repaint them */
510 NCURSES_SP_NAME(slk_restore) (NCURSES_SP_ARG);
511 NCURSES_SP_NAME(slk_touch) (NCURSES_SP_ARG);
512 NCURSES_SP_NAME(slk_refresh) (NCURSES_SP_ARG);
517 safe_ungetch(SP_PARM, KEY_RESIZE); /* so application can know this */
526 resizeterm(int ToLines, int ToCols)
528 return NCURSES_SP_NAME(resizeterm) (CURRENT_SCREEN, ToLines, ToCols);