c2e3831da2550ace967a7a0432cc05cab973c8a1
[ncurses.git] / ncurses / base / lib_scroll.c
1 /****************************************************************************
2  * Copyright (c) 1998,2000 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_scroll.c
36 **
37 **      The routine wscrl(win, n).
38 **  positive n scroll the window up (ie. move lines down)
39 **  negative n scroll the window down (ie. move lines up)
40 **
41 */
42
43 #include <curses.priv.h>
44
45 MODULE_ID("$Id: lib_scroll.c,v 1.17 2000/04/29 21:10:51 tom Exp $")
46
47 void
48 _nc_scroll_window(WINDOW *win, int const n, NCURSES_SIZE_T const top,
49     NCURSES_SIZE_T 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
74                     + n].oldindex);
75         }
76         for (line = top; line < top - n; line++) {
77             for (j = 0; j <= win->_maxx; j++)
78                 win->_line[line].text[j] = blank;
79             if_USE_SCROLL_HINTS(win->_line[line].oldindex = _NEWINDEX);
80         }
81     }
82
83     /* shift n lines upwards */
84     if (n > 0) {
85         for (line = top; line <= bottom - n; line++) {
86             memcpy(win->_line[line].text,
87                 win->_line[line + n].text,
88                 to_copy);
89             if_USE_SCROLL_HINTS(win->_line[line].oldindex = win->_line[line
90                     + n].oldindex);
91         }
92         for (line = bottom; line > bottom - n; line--) {
93             for (j = 0; j <= win->_maxx; j++)
94                 win->_line[line].text[j] = blank;
95             if_USE_SCROLL_HINTS(win->_line[line].oldindex = _NEWINDEX);
96         }
97     }
98     touchline(win, top, bottom - top + 1);
99 }
100
101 int
102 wscrl(WINDOW *win, int n)
103 {
104     T((T_CALLED("wscrl(%p,%d)"), win, n));
105
106     if (!win || !win->_scroll)
107         returnCode(ERR);
108
109     if (n == 0)
110         returnCode(OK);
111
112     if ((n > (win->_regbottom - win->_regtop)) ||
113         (-n > (win->_regbottom - win->_regtop)))
114         returnCode(ERR);
115
116     _nc_scroll_window(win, n, win->_regtop, win->_regbottom, _nc_background(win));
117
118     _nc_synchook(win);
119     returnCode(OK);
120 }