1 /****************************************************************************
2 * Copyright (c) 1998-2008,2009 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: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *
31 * and: Eric S. Raymond <esr@snark.thyrsus.com> *
32 * and: Thomas E. Dickey 1996-on *
33 * and: Juergen Pfeifer 2009 *
34 ****************************************************************************/
39 ** The routines newwin(), subwin() and their dependent
43 #include <curses.priv.h>
46 MODULE_ID("$Id: lib_newwin.c,v 1.64 2009/11/07 16:27:05 tom Exp $")
48 #define window_is(name) ((sp)->_##name == win)
51 #define remove_window(name) \
54 #define remove_window(name) \
61 remove_window_from_screen(WINDOW *win)
65 #ifdef USE_SP_WINDOWLIST
66 if ((sp = _nc_screen_of(win)) != 0) {
67 if (window_is(curscr)) {
68 remove_window(curscr);
69 } else if (window_is(stdscr)) {
70 remove_window(stdscr);
71 } else if (window_is(newscr)) {
72 remove_window(newscr);
76 for (each_screen(sp)) {
77 if (window_is(curscr)) {
78 remove_window(curscr);
80 } else if (window_is(stdscr)) {
81 remove_window(stdscr);
83 } else if (window_is(newscr)) {
84 remove_window(newscr);
92 _nc_freewin(WINDOW *win)
97 #ifdef USE_SP_WINDOWLIST
98 SCREEN *sp = _nc_screen_of(win); /* pretend this is parameter */
101 T((T_CALLED("_nc_freewin(%p)"), (void *) win));
104 if (_nc_nonsp_try_global(curses) == 0) {
106 for (each_window(SP_PARM, p)) {
107 if (&(p->win) == win) {
108 remove_window_from_screen(win);
110 WindowList(SP_PARM) = p->next;
114 if (!(win->_flags & _SUBWIN)) {
115 for (i = 0; i <= win->_maxy; i++)
116 FreeIfNeeded(win->_line[i].text);
122 T(("...deleted win=%p", (void *) win));
127 _nc_nonsp_unlock_global(curses);
133 NCURSES_EXPORT(WINDOW *)
134 NCURSES_SP_NAME(newwin) (NCURSES_SP_DCLx
135 int num_lines, int num_columns, int begy, int begx)
141 T((T_CALLED("newwin(%p, %d,%d,%d,%d)"), (void *) SP_PARM, num_lines, num_columns,
144 if (begy < 0 || begx < 0 || num_lines < 0 || num_columns < 0)
148 num_lines = SP_PARM->_lines_avail - begy;
149 if (num_columns == 0)
150 num_columns = screen_columns(SP_PARM) - begx;
152 win = NCURSES_SP_NAME(_nc_makenew) (NCURSES_SP_ARGx
153 num_lines, num_columns, begy, begx, 0);
157 for (i = 0; i < num_lines; i++) {
158 win->_line[i].text = typeCalloc(NCURSES_CH_T, (unsigned) num_columns);
159 if (win->_line[i].text == 0) {
160 (void) _nc_freewin(win);
163 for (ptr = win->_line[i].text;
164 ptr < win->_line[i].text + num_columns;
166 SetChar(*ptr, BLANK_TEXT, BLANK_ATTR);
173 NCURSES_EXPORT(WINDOW *)
174 newwin(int num_lines, int num_columns, int begy, int begx)
177 _nc_sp_lock_global(curses);
178 win = NCURSES_SP_NAME(newwin) (CURRENT_SCREEN,
179 num_lines, num_columns, begy, begx);
180 _nc_sp_unlock_global(curses);
185 NCURSES_EXPORT(WINDOW *)
186 derwin(WINDOW *orig, int num_lines, int num_columns, int begy, int begx)
192 SCREEN *sp = _nc_screen_of(orig);
195 T((T_CALLED("derwin(%p,%d,%d,%d,%d)"), (void *) orig, num_lines, num_columns,
199 * make sure window fits inside the original one
201 if (begy < 0 || begx < 0 || orig == 0 || num_lines < 0 || num_columns < 0)
203 if (begy + num_lines > orig->_maxy + 1
204 || begx + num_columns > orig->_maxx + 1)
208 num_lines = orig->_maxy + 1 - begy;
210 if (num_columns == 0)
211 num_columns = orig->_maxx + 1 - begx;
213 if (orig->_flags & _ISPAD)
216 win = NCURSES_SP_NAME(_nc_makenew) (NCURSES_SP_ARGx num_lines, num_columns,
218 orig->_begx + begx, flags);
224 WINDOW_ATTRS(win) = WINDOW_ATTRS(orig);
225 win->_nc_bkgd = orig->_nc_bkgd;
227 for (i = 0; i < num_lines; i++)
228 win->_line[i].text = &orig->_line[begy++].text[begx];
235 NCURSES_EXPORT(WINDOW *)
236 subwin(WINDOW *w, int l, int c, int y, int x)
238 T((T_CALLED("subwin(%p, %d, %d, %d, %d)"), (void *) w, l, c, y, x));
239 T(("parent has begy = %ld, begx = %ld", (long) w->_begy, (long) w->_begx));
241 returnWin(derwin(w, l, c, y - w->_begy, x - w->_begx));
245 dimension_limit(int value)
247 NCURSES_SIZE_T test = value;
248 return (test == value && value > 0);
251 NCURSES_EXPORT(WINDOW *)
252 NCURSES_SP_NAME(_nc_makenew) (NCURSES_SP_DCLx
262 bool is_padwin = (flags & _ISPAD);
264 T((T_CALLED("_nc_makenew(%p,%d,%d,%d,%d)"),
265 (void *) SP_PARM, num_lines, num_columns, begy, begx));
270 if (!dimension_limit(num_lines) || !dimension_limit(num_columns))
273 if ((wp = typeCalloc(WINDOWLIST, 1)) == 0)
278 if ((win->_line = typeCalloc(struct ldat, ((unsigned) num_lines))) == 0) {
283 _nc_nonsp_lock_global(curses);
287 win->_maxy = num_lines - 1;
288 win->_maxx = num_columns - 1;
291 win->_yoffset = SP_PARM->_topstolen;
294 WINDOW_ATTRS(win) = A_NORMAL;
295 SetChar(win->_nc_bkgd, BLANK_TEXT, BLANK_ATTR);
297 win->_clear = (is_padwin
299 : (num_lines == screen_lines(SP_PARM)
300 && num_columns == screen_columns(SP_PARM)));
303 win->_scroll = FALSE;
304 win->_leaveok = FALSE;
305 win->_use_keypad = FALSE;
314 win->_regbottom = num_lines - 1;
316 win->_pad._pad_y = -1;
317 win->_pad._pad_x = -1;
318 win->_pad._pad_top = -1;
319 win->_pad._pad_bottom = -1;
320 win->_pad._pad_left = -1;
321 win->_pad._pad_right = -1;
323 for (i = 0; i < num_lines; i++) {
327 * win->_line[i].firstchar = win->_line[i].lastchar = _NOCHANGE;
329 * which marks the whole window unchanged. That's how
330 * SVr1 curses did it, but SVr4 curses marks the whole new
333 * With the old SVr1-like code, say you have stdscr full of
334 * characters, then create a new window with newwin(),
335 * then do a printw(win, "foo ");, the trailing spaces are
336 * completely ignored by the following refreshes. So, you
337 * get "foojunkjunk" on the screen instead of "foo " as
338 * you actually intended.
340 * SVr4 doesn't do this. Instead the spaces are actually written.
341 * So that's how we want ncurses to behave.
343 win->_line[i].firstchar = 0;
344 win->_line[i].lastchar = num_columns - 1;
346 if_USE_SCROLL_HINTS(win->_line[i].oldindex = i);
349 if (!is_padwin && (begx + num_columns == screen_columns(SP_PARM))) {
350 win->_flags |= _ENDLINE;
352 if (begx == 0 && num_lines == screen_lines(SP_PARM) && begy == 0)
353 win->_flags |= _FULLWIN;
355 if (begy + num_lines == screen_lines(SP_PARM))
356 win->_flags |= _SCROLLWIN;
359 wp->next = WindowList(SP_PARM);
360 wp->screen = SP_PARM;
361 WindowList(SP_PARM) = wp;
363 T((T_CREATE("window %p"), (void *) win));
365 _nc_nonsp_unlock_global(curses);
370 * wgetch() and other functions with a WINDOW* parameter may use a SCREEN*
371 * internally, and it is useful to allow those to be invoked without switching
372 * SCREEN's, e.g., for multi-threaded applications.
375 NCURSES_EXPORT(WINDOW *)
376 _nc_curscr_of(SCREEN *sp)
378 return sp == 0 ? 0 : CurScreen(sp);
381 NCURSES_EXPORT(WINDOW *)
382 _nc_newscr_of(SCREEN *sp)
384 return sp == 0 ? 0 : NewScreen(sp);
387 NCURSES_EXPORT(WINDOW *)
388 _nc_stdscr_of(SCREEN *sp)
390 return sp == 0 ? 0 : StdScreen(sp);