197bb221a07c26c63e2f7c586f6852ffad70dae7
[ncurses.git] / ncurses / base / lib_scroll.c
1 /****************************************************************************
2  * Copyright (c) 1998 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
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("$Id: lib_scroll.c,v 1.16 1998/02/11 12:13:55 tom Exp $")
48
49 void _nc_scroll_window(WINDOW *win, int const n, short const top, short const bottom, chtype blank)
50 {
51 int     line, j;
52 size_t  to_copy = (size_t)(sizeof(chtype) * (win->_maxx + 1));
53
54         TR(TRACE_MOVE, ("_nc_scroll_window(%p, %d, %d, %d)", win, n, top,bottom)); 
55
56         /*
57          * This used to do a line-text pointer-shuffle instead of text copies.
58          * That (a) doesn't work when the window is derived and doesn't have
59          * its own storage, (b) doesn't save you a lot on modern machines
60          * anyway.  Your typical memcpy implementations are coded in
61          * assembler using a tight BLT loop; for the size of copies we're
62          * talking here, the total execution time is dominated by the one-time
63          * setup cost.  So there is no point in trying to be excessively
64          * clever -- esr.
65          */
66
67         /* shift n lines downwards */
68         if (n < 0) {
69                 for (line = bottom; line >= top-n; line--) {
70                         memcpy(win->_line[line].text,
71                                win->_line[line+n].text,
72                                to_copy);
73                         if_USE_SCROLL_HINTS(win->_line[line].oldindex = win->_line[line+n].oldindex);
74                 }
75                 for (line = top; line < top-n; line++) {
76                         for (j = 0; j <= win->_maxx; j ++)
77                                 win->_line[line].text[j] = blank;
78                         if_USE_SCROLL_HINTS(win->_line[line].oldindex = _NEWINDEX);
79                 }
80         }
81
82         /* shift n lines upwards */
83         if (n > 0) {
84                 for (line = top; line <= bottom-n; line++) {
85                         memcpy(win->_line[line].text,
86                                win->_line[line+n].text,
87                                to_copy);
88                         if_USE_SCROLL_HINTS(win->_line[line].oldindex = win->_line[line+n].oldindex);
89                 }
90                 for (line = bottom; line > bottom-n; line--) {
91                         for (j = 0; j <= win->_maxx; j ++)
92                                 win->_line[line].text[j] = blank;
93                         if_USE_SCROLL_HINTS(win->_line[line].oldindex = _NEWINDEX);
94                 }
95         }
96         touchline(win, top, bottom-top+1);
97 }
98
99 int
100 wscrl(WINDOW *win, int n)
101 {
102         T((T_CALLED("wscrl(%p,%d)"), win, n));
103
104         if (!win || !win->_scroll)
105                 returnCode(ERR);
106
107         if (n == 0)
108                 returnCode(OK);
109
110         if ((n > (win->_regbottom - win->_regtop)) || 
111             (-n > (win->_regbottom - win->_regtop)))
112             returnCode(ERR);
113
114         _nc_scroll_window(win, n, win->_regtop, win->_regbottom, _nc_background(win));
115
116         _nc_synchook(win);
117         returnCode(OK);
118 }