ncurses 5.6 - patch 20070421
[ncurses.git] / ncurses / base / lib_mvwin.c
1 /****************************************************************************
2  * Copyright (c) 1998-2001,2006 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  ****************************************************************************/
33
34 /*
35 **      lib_mvwin.c
36 **
37 **      The routine mvwin().
38 **
39 */
40
41 #include <curses.priv.h>
42
43 MODULE_ID("$Id: lib_mvwin.c,v 1.14 2006/02/25 22:53:46 tom Exp $")
44
45 NCURSES_EXPORT(int)
46 mvwin(WINDOW *win, int by, int bx)
47 {
48     T((T_CALLED("mvwin(%p,%d,%d)"), win, by, bx));
49
50     if (!win || (win->_flags & _ISPAD))
51         returnCode(ERR);
52
53     /*
54      * mvwin() should only modify the indices.  See test/demo_menus.c and
55      * test/movewindow.c for examples.
56      */
57 #if 0
58     /* Copying subwindows is allowed, but it is expensive... */
59     if (win->_flags & _SUBWIN) {
60         int err = ERR;
61         WINDOW *parent = win->_parent;
62         if (parent) {           /* Now comes the complicated and costly part, you should really
63                                  * try to avoid to move subwindows. Because a subwindow shares
64                                  * the text buffers with its parent, one can't do a simple
65                                  * memmove of the text buffers. One has to create a copy, then
66                                  * to relocate the subwindow and then to do a copy.
67                                  */
68             if ((by - parent->_begy == win->_pary) &&
69                 (bx - parent->_begx == win->_parx))
70                 err = OK;       /* we don't actually move */
71             else {
72                 WINDOW *clone = dupwin(win);
73                 if (clone) {
74                     /* now we have the clone, so relocate win */
75
76                     werase(win);        /* Erase the original place     */
77                     /* fill with parents background */
78                     wbkgrnd(win, CHREF(parent->_nc_bkgd));
79                     wsyncup(win);       /* Tell the parent(s)           */
80
81                     err = mvderwin(win,
82                                    by - parent->_begy,
83                                    bx - parent->_begx);
84                     if (err != ERR) {
85                         err = copywin(clone, win,
86                                       0, 0, 0, 0, win->_maxy, win->_maxx, 0);
87                         if (ERR != err)
88                             wsyncup(win);
89                     }
90                     if (ERR == delwin(clone))
91                         err = ERR;
92                 }
93             }
94         }
95         returnCode(err);
96     }
97 #endif
98
99     if (by + win->_maxy > screen_lines - 1
100         || bx + win->_maxx > screen_columns - 1
101         || by < 0
102         || bx < 0)
103         returnCode(ERR);
104
105     /*
106      * Whether or not the window is moved, touch the window's contents so
107      * that a following call to 'wrefresh()' will paint the window at the
108      * new location.  This ensures that if the caller has refreshed another
109      * window at the same location, that this one will be displayed.
110      */
111     win->_begy = by;
112     win->_begx = bx;
113     returnCode(touchwin(win));
114 }