ncurses 6.1 - patch 20190803
[ncurses.git] / ncurses / base / lib_scroll.c
1 /****************************************************************************
2  * Copyright (c) 1998-2011,2019 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: Thomas E. Dickey 1996-2003                                      *
31  *     and: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
32  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
33  ****************************************************************************/
34
35 /*
36 **      lib_scroll.c
37 **
38 **      The routine wscrl(win, n).
39 **  positive n scroll the window up (ie. move lines down)
40 **  negative n scroll the window down (ie. move lines up)
41 **
42 */
43
44 #include <curses.priv.h>
45
46 MODULE_ID("$Id: lib_scroll.c,v 1.31 2019/08/03 22:27:55 tom Exp $")
47
48 NCURSES_EXPORT(void)
49 _nc_scroll_window(WINDOW *win,
50                   int const n,
51                   int const top,
52                   int const bottom,
53                   NCURSES_CH_T blank)
54 {
55     int limit;
56     int line;
57     int j;
58     size_t to_copy = (sizeof(NCURSES_CH_T) * (size_t) (win->_maxx + 1));
59
60     TR(TRACE_MOVE, ("_nc_scroll_window(%p, %d, %ld, %ld)",
61                     (void *) win, n, (long) top, (long) bottom));
62
63     if (top < 0
64         || bottom < top
65         || bottom > win->_maxy) {
66         TR(TRACE_MOVE, ("nothing to scroll"));
67         return;
68     }
69
70     /*
71      * This used to do a line-text pointer-shuffle instead of text copies.
72      * That (a) doesn't work when the window is derived and doesn't have
73      * its own storage, (b) doesn't save you a lot on modern machines
74      * anyway.  Your typical memcpy implementations are coded in
75      * assembler using a tight BLT loop; for the size of copies we're
76      * talking here, the total execution time is dominated by the one-time
77      * setup cost.  So there is no point in trying to be excessively
78      * clever -- esr.
79      */
80 #define BottomLimit(n) ((n) >= 0 && (n) >= top)
81 #define TopLimit(n)    ((n) <= win->_maxy && (n) <= bottom)
82
83     /* shift n lines downwards */
84     if (n < 0) {
85         limit = top - n;
86         for (line = bottom; line >= limit && BottomLimit(line); line--) {
87             TR(TRACE_MOVE, ("...copying %d to %d", line + 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 =
92                                 win->_line[line + n].oldindex);
93         }
94         for (line = top; line < limit && TopLimit(line); line++) {
95             TR(TRACE_MOVE, ("...filling %d", line));
96             for (j = 0; j <= win->_maxx; j++)
97                 win->_line[line].text[j] = blank;
98             if_USE_SCROLL_HINTS(win->_line[line].oldindex = _NEWINDEX);
99         }
100     }
101
102     /* shift n lines upwards */
103     if (n > 0) {
104         limit = bottom - n;
105         for (line = top; line <= limit && TopLimit(line); line++) {
106             memcpy(win->_line[line].text,
107                    win->_line[line + n].text,
108                    to_copy);
109             if_USE_SCROLL_HINTS(win->_line[line].oldindex =
110                                 win->_line[line + n].oldindex);
111         }
112         for (line = bottom; line > limit && BottomLimit(line); line--) {
113             for (j = 0; j <= win->_maxx; j++)
114                 win->_line[line].text[j] = blank;
115             if_USE_SCROLL_HINTS(win->_line[line].oldindex = _NEWINDEX);
116         }
117     }
118     touchline(win, top, bottom - top + 1);
119
120     if_WIDEC({
121         if (WINDOW_EXT(win, addch_used) != 0) {
122             int next = WINDOW_EXT(win, addch_y) + n;
123             if (next < 0 || next > win->_maxy) {
124                 TR(TRACE_VIRTPUT,
125                    ("Alert discarded multibyte on scroll"));
126                 WINDOW_EXT(win, addch_y) = 0;
127             } else {
128                 TR(TRACE_VIRTPUT, ("scrolled working position to %d,%d",
129                                    WINDOW_EXT(win, addch_y),
130                                    WINDOW_EXT(win, addch_x)));
131                 WINDOW_EXT(win, addch_y) = next;
132             }
133         }
134     })
135 }
136
137 NCURSES_EXPORT(int)
138 wscrl(WINDOW *win, int n)
139 {
140     T((T_CALLED("wscrl(%p,%d)"), (void *) win, n));
141
142     if (!win || !win->_scroll) {
143         TR(TRACE_MOVE, ("...scrollok is false"));
144         returnCode(ERR);
145     }
146
147     if (n != 0) {
148         _nc_scroll_window(win, n, win->_regtop, win->_regbottom, win->_nc_bkgd);
149         _nc_synchook(win);
150     }
151     returnCode(OK);
152 }