1/* $OpenBSD: lib_mvwin.c,v 1.4 2023/10/17 09:52:08 nicm Exp $ */
2
3/****************************************************************************
4 * Copyright 2020,2021 Thomas E. Dickey                                     *
5 * Copyright 1998-2009,2010 Free Software Foundation, Inc.                  *
6 *                                                                          *
7 * Permission is hereby granted, free of charge, to any person obtaining a  *
8 * copy of this software and associated documentation files (the            *
9 * "Software"), to deal in the Software without restriction, including      *
10 * without limitation the rights to use, copy, modify, merge, publish,      *
11 * distribute, distribute with modifications, sublicense, and/or sell       *
12 * copies of the Software, and to permit persons to whom the Software is    *
13 * furnished to do so, subject to the following conditions:                 *
14 *                                                                          *
15 * The above copyright notice and this permission notice shall be included  *
16 * in all copies or substantial portions of the Software.                   *
17 *                                                                          *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24 * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25 *                                                                          *
26 * Except as contained in this notice, the name(s) of the above copyright   *
27 * holders shall not be used in advertising or otherwise to promote the     *
28 * sale, use or other dealings in this Software without prior written       *
29 * authorization.                                                           *
30 ****************************************************************************/
31
32/****************************************************************************
33 *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
34 *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
35 *     and: Thomas E. Dickey                        1996-on                 *
36 *     and: Juergen Pfeifer                                                 *
37 ****************************************************************************/
38
39/*
40**	lib_mvwin.c
41**
42**	The routine mvwin().
43**
44*/
45
46#include <curses.priv.h>
47
48MODULE_ID("$Id: lib_mvwin.c,v 1.4 2023/10/17 09:52:08 nicm Exp $")
49
50NCURSES_EXPORT(int)
51mvwin(WINDOW *win, int by, int bx)
52{
53#if NCURSES_SP_FUNCS
54    SCREEN *sp = _nc_screen_of(win);
55#endif
56
57    T((T_CALLED("mvwin(%p,%d,%d)"), (void *) win, by, bx));
58
59    if (!win || IS_PAD(win))
60	returnCode(ERR);
61
62    /*
63     * mvwin() should only modify the indices.  See test/demo_menus.c and
64     * test/movewindow.c for examples.
65     */
66#if 0
67    /* Copying subwindows is allowed, but it is expensive... */
68    if (IS_SUBWIN(win)) {
69	int err = ERR;
70	WINDOW *parent = win->_parent;
71	if (parent) {		/* Now comes the complicated and costly part, you should really
72				 * try to avoid to move subwindows. Because a subwindow shares
73				 * the text buffers with its parent, one can't do a simple
74				 * memmove of the text buffers. One has to create a copy, then
75				 * to relocate the subwindow and then to do a copy.
76				 */
77	    if ((by - parent->_begy == win->_pary) &&
78		(bx - parent->_begx == win->_parx))
79		err = OK;	/* we don't actually move */
80	    else {
81		WINDOW *clone = dupwin(win);
82		if (clone) {
83		    /* now we have the clone, so relocate win */
84
85		    werase(win);	/* Erase the original place     */
86		    /* fill with parents background */
87		    wbkgrnd(win, CHREF(parent->_nc_bkgd));
88		    wsyncup(win);	/* Tell the parent(s)           */
89
90		    err = mvderwin(win,
91				   by - parent->_begy,
92				   bx - parent->_begx);
93		    if (err != ERR) {
94			err = copywin(clone, win,
95				      0, 0, 0, 0, win->_maxy, win->_maxx, 0);
96			if (ERR != err)
97			    wsyncup(win);
98		    }
99		    if (ERR == delwin(clone))
100			err = ERR;
101		}
102	    }
103	}
104	returnCode(err);
105    }
106#endif
107
108    if (by + win->_maxy > screen_lines(SP_PARM) - 1
109	|| bx + win->_maxx > screen_columns(SP_PARM) - 1
110	|| by < 0
111	|| bx < 0)
112	returnCode(ERR);
113
114    /*
115     * Whether or not the window is moved, touch the window's contents so
116     * that a following call to 'wrefresh()' will paint the window at the
117     * new location.  This ensures that if the caller has refreshed another
118     * window at the same location, that this one will be displayed.
119     */
120    win->_begy = (NCURSES_SIZE_T) by;
121    win->_begx = (NCURSES_SIZE_T) bx;
122    returnCode(touchwin(win));
123}
124