26090828e3bf3ac67bf0a27ee499b1d5ca091b85
[ncurses.git] / ncurses / base / lib_newwin.c
1 /****************************************************************************
2  * Copyright (c) 1998-2008,2009 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: 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  ****************************************************************************/
35
36 /*
37 **      lib_newwin.c
38 **
39 **      The routines newwin(), subwin() and their dependent
40 **
41 */
42
43 #include <curses.priv.h>
44 #include <stddef.h>
45
46 MODULE_ID("$Id: lib_newwin.c,v 1.58 2009/06/06 17:53:11 tom Exp $")
47
48 #define window_is(name) ((sp)->_##name == win)
49
50 #if USE_REENTRANT
51 #define remove_window(name) \
52                 sp->_##name = 0
53 #else
54 #define remove_window(name) \
55                 sp->_##name = 0; \
56                 if (win == name) \
57                     name = 0
58 #endif
59
60 static void
61 remove_window_from_screen(WINDOW *win)
62 {
63     SCREEN *sp;
64
65     for (each_screen(sp)) {
66         if (window_is(curscr)) {
67             remove_window(curscr);
68             break;
69         } else if (window_is(stdscr)) {
70             remove_window(stdscr);
71             break;
72         } else if (window_is(newscr)) {
73             remove_window(newscr);
74             break;
75         }
76     }
77 }
78
79 NCURSES_EXPORT(int)
80 _nc_freewin(WINDOW *win)
81 {
82     WINDOWLIST *p, *q;
83     int i;
84     int result = ERR;
85
86     T((T_CALLED("_nc_freewin(%p)"), win));
87
88     if (win != 0) {
89         if (_nc_try_global(curses) == 0) {
90             q = 0;
91             for (each_window(SP, p)) {
92                 if (&(p->win) == win) {
93                     remove_window_from_screen(win);
94                     if (q == 0)
95                         WindowList(SP) = p->next;
96                     else
97                         q->next = p->next;
98
99                     if (!(win->_flags & _SUBWIN)) {
100                         for (i = 0; i <= win->_maxy; i++)
101                             FreeIfNeeded(win->_line[i].text);
102                     }
103                     free(win->_line);
104                     free(p);
105
106                     result = OK;
107                     T(("...deleted win=%p", win));
108                     break;
109                 }
110                 q = p;
111             }
112             _nc_unlock_global(curses);
113         }
114     }
115     returnCode(result);
116 }
117
118 NCURSES_EXPORT(WINDOW *)
119 NCURSES_SP_NAME(newwin) (NCURSES_SP_DCLx
120                          int num_lines, int num_columns, int begy, int begx)
121 {
122     WINDOW *win;
123     NCURSES_CH_T *ptr;
124     int i;
125
126     T((T_CALLED("newwin(%d,%d,%d,%d)"), num_lines, num_columns, begy, begx));
127
128     if (begy < 0 || begx < 0 || num_lines < 0 || num_columns < 0)
129         returnWin(0);
130
131     if (num_lines == 0)
132         num_lines = SP_PARM->_lines_avail - begy;
133     if (num_columns == 0)
134         num_columns = screen_columns(SP_PARM) - begx;
135
136     win = NCURSES_SP_NAME(_nc_makenew) (NCURSES_SP_ARGx
137                                         num_lines, num_columns, begy, begx, 0);
138     if (win == 0)
139         returnWin(0);
140
141     for (i = 0; i < num_lines; i++) {
142         win->_line[i].text = typeCalloc(NCURSES_CH_T, (unsigned) num_columns);
143         if (win->_line[i].text == 0) {
144             (void) _nc_freewin(win);
145             returnWin(0);
146         }
147         for (ptr = win->_line[i].text;
148              ptr < win->_line[i].text + num_columns;
149              ptr++)
150             SetChar(*ptr, BLANK_TEXT, BLANK_ATTR);
151     }
152
153     returnWin(win);
154 }
155
156 #if NCURSES_SP_FUNCS
157 NCURSES_EXPORT(WINDOW *)
158 newwin(int num_lines, int num_columns, int begy, int begx)
159 {
160     return NCURSES_SP_NAME(newwin) (CURRENT_SCREEN,
161                                     num_lines, num_columns,
162                                     begy, begx);
163 }
164 #endif
165
166 NCURSES_EXPORT(WINDOW *)
167 derwin(WINDOW *orig, int num_lines, int num_columns, int begy, int begx)
168 {
169 #if NCURSES_SP_FUNCS
170     SCREEN *sp = CURRENT_SCREEN;
171 #endif
172     WINDOW *win;
173     int i;
174     int flags = _SUBWIN;
175
176     T((T_CALLED("derwin(%p,%d,%d,%d,%d)"), orig, num_lines, num_columns,
177        begy, begx));
178
179     /*
180      * make sure window fits inside the original one
181      */
182     if (begy < 0 || begx < 0 || orig == 0 || num_lines < 0 || num_columns < 0)
183         returnWin(0);
184     if (begy + num_lines > orig->_maxy + 1
185         || begx + num_columns > orig->_maxx + 1)
186         returnWin(0);
187
188     if (num_lines == 0)
189         num_lines = orig->_maxy + 1 - begy;
190
191     if (num_columns == 0)
192         num_columns = orig->_maxx + 1 - begx;
193
194     if (orig->_flags & _ISPAD)
195         flags |= _ISPAD;
196
197     win = NCURSES_SP_NAME(_nc_makenew) (NCURSES_SP_ARGx num_lines, num_columns,
198                                         orig->_begy + begy,
199                                         orig->_begx + begx, flags);
200     if (win == 0)
201         returnWin(0);
202
203     win->_pary = begy;
204     win->_parx = begx;
205     WINDOW_ATTRS(win) = WINDOW_ATTRS(orig);
206     win->_nc_bkgd = orig->_nc_bkgd;
207
208     for (i = 0; i < num_lines; i++)
209         win->_line[i].text = &orig->_line[begy++].text[begx];
210
211     win->_parent = orig;
212
213     returnWin(win);
214 }
215
216 NCURSES_EXPORT(WINDOW *)
217 subwin(WINDOW *w, int l, int c, int y, int x)
218 {
219     T((T_CALLED("subwin(%p, %d, %d, %d, %d)"), w, l, c, y, x));
220     T(("parent has begy = %ld, begx = %ld", (long) w->_begy, (long) w->_begx));
221
222     returnWin(derwin(w, l, c, y - w->_begy, x - w->_begx));
223 }
224
225 static bool
226 dimension_limit(int value)
227 {
228     NCURSES_SIZE_T test = value;
229     return (test == value && value > 0);
230 }
231
232 NCURSES_EXPORT(WINDOW *)
233 NCURSES_SP_NAME(_nc_makenew) (NCURSES_SP_DCLx
234                               int num_lines,
235                               int num_columns,
236                               int begy,
237                               int begx,
238                               int flags)
239 {
240     int i;
241     WINDOWLIST *wp;
242     WINDOW *win;
243     bool is_pad = (flags & _ISPAD);
244
245     T((T_CALLED("_nc_makenew(%p,%d,%d,%d,%d)"),
246        SP_PARM, num_lines, num_columns, begy, begx));
247
248     if (SP_PARM == 0)
249         returnWin(0);
250
251     if (!dimension_limit(num_lines) || !dimension_limit(num_columns))
252         returnWin(0);
253
254     if ((wp = typeCalloc(WINDOWLIST, 1)) == 0)
255         returnWin(0);
256
257     win = &(wp->win);
258
259     if ((win->_line = typeCalloc(struct ldat, ((unsigned) num_lines))) == 0) {
260         free(win);
261         returnWin(0);
262     }
263
264     _nc_lock_global(curses);
265
266     win->_curx = 0;
267     win->_cury = 0;
268     win->_maxy = num_lines - 1;
269     win->_maxx = num_columns - 1;
270     win->_begy = begy;
271     win->_begx = begx;
272     win->_yoffset = SP_PARM->_topstolen;
273
274     win->_flags = flags;
275     WINDOW_ATTRS(win) = A_NORMAL;
276     SetChar(win->_nc_bkgd, BLANK_TEXT, BLANK_ATTR);
277
278     win->_clear = (is_pad
279                    ? FALSE
280                    : (num_lines == screen_lines(SP_PARM)
281                       && num_columns == screen_columns(SP_PARM)));
282     win->_idlok = FALSE;
283     win->_idcok = TRUE;
284     win->_scroll = FALSE;
285     win->_leaveok = FALSE;
286     win->_use_keypad = FALSE;
287     win->_delay = -1;
288     win->_immed = FALSE;
289     win->_sync = 0;
290     win->_parx = -1;
291     win->_pary = -1;
292     win->_parent = 0;
293
294     win->_regtop = 0;
295     win->_regbottom = num_lines - 1;
296
297     win->_pad._pad_y = -1;
298     win->_pad._pad_x = -1;
299     win->_pad._pad_top = -1;
300     win->_pad._pad_bottom = -1;
301     win->_pad._pad_left = -1;
302     win->_pad._pad_right = -1;
303
304     for (i = 0; i < num_lines; i++) {
305         /*
306          * This used to do
307          *
308          * win->_line[i].firstchar = win->_line[i].lastchar = _NOCHANGE;
309          *
310          * which marks the whole window unchanged.  That's how
311          * SVr1 curses did it, but SVr4 curses marks the whole new
312          * window changed.
313          *
314          * With the old SVr1-like code, say you have stdscr full of
315          * characters, then create a new window with newwin(),
316          * then do a printw(win, "foo        ");, the trailing spaces are
317          * completely ignored by the following refreshes.  So, you
318          * get "foojunkjunk" on the screen instead of "foo        " as
319          * you actually intended.
320          *
321          * SVr4 doesn't do this.  Instead the spaces are actually written.
322          * So that's how we want ncurses to behave.
323          */
324         win->_line[i].firstchar = 0;
325         win->_line[i].lastchar = num_columns - 1;
326
327         if_USE_SCROLL_HINTS(win->_line[i].oldindex = i);
328     }
329
330     if (!is_pad && (begx + num_columns == screen_columns(SP_PARM))) {
331         win->_flags |= _ENDLINE;
332
333         if (begx == 0 && num_lines == screen_lines(SP_PARM) && begy == 0)
334             win->_flags |= _FULLWIN;
335
336         if (begy + num_lines == screen_lines(SP_PARM))
337             win->_flags |= _SCROLLWIN;
338     }
339
340     wp->next = WindowList(SP_PARM);
341     wp->screen = SP_PARM;
342     WindowList(SP_PARM) = wp;
343
344     T((T_CREATE("window %p"), win));
345
346     _nc_unlock_global(curses);
347     returnWin(win);
348 }
349
350 #if NCURSES_SP_FUNCS
351 NCURSES_EXPORT(WINDOW *)
352 _nc_makenew(int num_lines, int num_columns, int begy, int begx, int flags)
353 {
354     return NCURSES_SP_NAME(_nc_makenew) (CURRENT_SCREEN,
355                                          num_lines, num_columns,
356                                          begy, begx, flags);
357 }
358 #endif
359
360 /*
361  * wgetch() and other functions with a WINDOW* parameter may use a SCREEN*
362  * internally, and it is useful to allow those to be invoked without switching
363  * SCREEN's, e.g., for multi-threaded applications.
364  */
365 #if NCURSES_SP_FUNCS
366 NCURSES_EXPORT(WINDOW *)
367 _nc_curscr_of(SCREEN *sp)
368 {
369     return sp == 0 ? 0 : sp->_curscr;
370 }
371
372 NCURSES_EXPORT(WINDOW *)
373 _nc_newscr_of(SCREEN *sp)
374 {
375     return sp == 0 ? 0 : sp->_newscr;
376 }
377
378 NCURSES_EXPORT(WINDOW *)
379 _nc_stdscr_of(SCREEN *sp)
380 {
381     return sp == 0 ? 0 : sp->_stdscr;
382 }
383 #endif