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