xref: /openbsd-src/lib/libcurses/base/lib_scroll.c (revision 1fe33145a0a9b1310a0413297a8deb871918b27f)
1 /*	$OpenBSD: lib_scroll.c,v 1.2 2000/06/19 03:53:45 millert Exp $	*/
2 
3 /****************************************************************************
4  * Copyright (c) 1998,2000 Free Software Foundation, Inc.                   *
5  *                                                                          *
6  * Permission is hereby granted, free of charge, to any person obtaining a  *
7  * copy of this software and associated documentation files (the            *
8  * "Software"), to deal in the Software without restriction, including      *
9  * without limitation the rights to use, copy, modify, merge, publish,      *
10  * distribute, distribute with modifications, sublicense, and/or sell       *
11  * copies of the Software, and to permit persons to whom the Software is    *
12  * furnished to do so, subject to the following conditions:                 *
13  *                                                                          *
14  * The above copyright notice and this permission notice shall be included  *
15  * in all copies or substantial portions of the Software.                   *
16  *                                                                          *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24  *                                                                          *
25  * Except as contained in this notice, the name(s) of the above copyright   *
26  * holders shall not be used in advertising or otherwise to promote the     *
27  * sale, use or other dealings in this Software without prior written       *
28  * authorization.                                                           *
29  ****************************************************************************/
30 
31 /****************************************************************************
32  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
33  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
34  ****************************************************************************/
35 
36 /*
37 **	lib_scroll.c
38 **
39 **	The routine wscrl(win, n).
40 **  positive n scroll the window up (ie. move lines down)
41 **  negative n scroll the window down (ie. move lines up)
42 **
43 */
44 
45 #include <curses.priv.h>
46 
47 MODULE_ID("$From: lib_scroll.c,v 1.17 2000/04/29 21:10:51 tom Exp $")
48 
49 void
50 _nc_scroll_window(WINDOW *win, int const n, NCURSES_SIZE_T const top,
51     NCURSES_SIZE_T const bottom, chtype blank)
52 {
53     int line, j;
54     size_t to_copy = (size_t) (sizeof(chtype) * (win->_maxx + 1));
55 
56     TR(TRACE_MOVE, ("_nc_scroll_window(%p, %d, %d, %d)", win, n, top, bottom));
57 
58     /*
59      * This used to do a line-text pointer-shuffle instead of text copies.
60      * That (a) doesn't work when the window is derived and doesn't have
61      * its own storage, (b) doesn't save you a lot on modern machines
62      * anyway.  Your typical memcpy implementations are coded in
63      * assembler using a tight BLT loop; for the size of copies we're
64      * talking here, the total execution time is dominated by the one-time
65      * setup cost.  So there is no point in trying to be excessively
66      * clever -- esr.
67      */
68 
69     /* shift n lines downwards */
70     if (n < 0) {
71 	for (line = bottom; line >= top - n; line--) {
72 	    memcpy(win->_line[line].text,
73 		win->_line[line + n].text,
74 		to_copy);
75 	    if_USE_SCROLL_HINTS(win->_line[line].oldindex = win->_line[line
76 		    + n].oldindex);
77 	}
78 	for (line = top; line < top - n; line++) {
79 	    for (j = 0; j <= win->_maxx; j++)
80 		win->_line[line].text[j] = blank;
81 	    if_USE_SCROLL_HINTS(win->_line[line].oldindex = _NEWINDEX);
82 	}
83     }
84 
85     /* shift n lines upwards */
86     if (n > 0) {
87 	for (line = top; line <= bottom - n; line++) {
88 	    memcpy(win->_line[line].text,
89 		win->_line[line + n].text,
90 		to_copy);
91 	    if_USE_SCROLL_HINTS(win->_line[line].oldindex = win->_line[line
92 		    + n].oldindex);
93 	}
94 	for (line = bottom; line > bottom - n; line--) {
95 	    for (j = 0; j <= win->_maxx; j++)
96 		win->_line[line].text[j] = blank;
97 	    if_USE_SCROLL_HINTS(win->_line[line].oldindex = _NEWINDEX);
98 	}
99     }
100     touchline(win, top, bottom - top + 1);
101 }
102 
103 int
104 wscrl(WINDOW *win, int n)
105 {
106     T((T_CALLED("wscrl(%p,%d)"), win, n));
107 
108     if (!win || !win->_scroll)
109 	returnCode(ERR);
110 
111     if (n == 0)
112 	returnCode(OK);
113 
114     if ((n > (win->_regbottom - win->_regtop)) ||
115 	(-n > (win->_regbottom - win->_regtop)))
116 	returnCode(ERR);
117 
118     _nc_scroll_window(win, n, win->_regtop, win->_regbottom, _nc_background(win));
119 
120     _nc_synchook(win);
121     returnCode(OK);
122 }
123