Home | History | Annotate | Line # | Download | only in libcurses
touchwin.c revision 1.34
      1 /*	$NetBSD: touchwin.c,v 1.34 2022/04/12 07:03:04 blymn Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1981, 1993, 1994
      5  *	The Regents of the University of California.  All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  * 3. Neither the name of the University nor the names of its contributors
     16  *    may be used to endorse or promote products derived from this software
     17  *    without specific prior written permission.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     29  * SUCH DAMAGE.
     30  */
     31 
     32 #include <sys/cdefs.h>
     33 #ifndef lint
     34 #if 0
     35 static char sccsid[] = "@(#)touchwin.c	8.2 (Berkeley) 5/4/94";
     36 #else
     37 __RCSID("$NetBSD: touchwin.c,v 1.34 2022/04/12 07:03:04 blymn Exp $");
     38 #endif
     39 #endif				/* not lint */
     40 
     41 #include "curses.h"
     42 #include "curses_private.h"
     43 
     44 static int _cursesi_touchline_force(WINDOW *, int, int, int, int);
     45 
     46 /*
     47  * __sync --
     48  *	To be called after each window change.
     49  */
     50 void
     51 __sync(WINDOW *win)
     52 {
     53 
     54 	if (win->flags & __IMMEDOK)
     55 		wrefresh(win);
     56 	if (win->flags & __SYNCOK)
     57 		wsyncup(win);
     58 }
     59 
     60 /*
     61  * is_linetouched --
     62  *	Indicate if line has been touched or not.
     63  */
     64 bool
     65 is_linetouched(WINDOW *win, int line)
     66 {
     67 	if (line > win->maxy)
     68 		return FALSE;
     69 
     70 	__CTRACE(__CTRACE_LINE, "is_linetouched: (%p, line %d, dirty %d)\n",
     71 	    win, line, (win->alines[line]->flags & __ISDIRTY));
     72 	return (win->alines[line]->flags & __ISDIRTY) != 0;
     73 }
     74 
     75 /*
     76  * touchline --
     77  *	Touch count lines starting at start.  This is the SUS v2 compliant
     78  *	version.
     79  */
     80 int
     81 touchline(WINDOW *win, int start, int count)
     82 {
     83 	__CTRACE(__CTRACE_LINE, "touchline: (%p, %d, %d)\n", win, start, count);
     84 	return wtouchln(win, start, count, 1);
     85 }
     86 
     87 /*
     88  * wredrawln --
     89  *	Mark count lines starting at start as corrupted.  Implemented using
     90  *	wtouchln().
     91  */
     92 int wredrawln(WINDOW *win, int start, int count)
     93 {
     94 	__CTRACE(__CTRACE_LINE, "wredrawln: (%p, %d, %d)\n", win, start, count);
     95 	return wtouchln(win, start, count, 1);
     96 }
     97 
     98 /*
     99  * is_wintouched --
    100  *	Check if the window has been touched.
    101  */
    102 bool
    103 is_wintouched(WINDOW *win)
    104 {
    105 	int y, maxy;
    106 
    107 	__CTRACE(__CTRACE_LINE, "is_wintouched: (%p, maxy %d)\n", win,
    108 	    win->maxy);
    109 	maxy = win->maxy;
    110 	for (y = 0; y < maxy; y++) {
    111 		if (is_linetouched(win, y) == TRUE)
    112 			return TRUE;
    113 	}
    114 
    115 	return FALSE;
    116 }
    117 
    118 /*
    119  * touchwin --
    120  *	Make it look like the whole window has been changed.
    121  */
    122 int
    123 touchwin(WINDOW *win)
    124 {
    125 	__CTRACE(__CTRACE_LINE, "touchwin: (%p)\n", win);
    126 	return wtouchln(win, 0, win->maxy, 1);
    127 }
    128 
    129 /*
    130  * redrawwin --
    131  *	Mark entire window as corrupted.  Implemented using wtouchln().
    132  */
    133 int
    134 redrawwin(WINDOW *win)
    135 {
    136 	__CTRACE(__CTRACE_LINE, "redrawwin: (%p)\n", win);
    137 	return wtouchln(win, 0, win->maxy, 1);
    138 }
    139 
    140 /*
    141  * untouchwin --
    142  *	 Make it look like the window has not been changed.
    143  */
    144 int
    145 untouchwin(WINDOW *win)
    146 {
    147 	__CTRACE(__CTRACE_LINE, "untouchwin: (%p)\n", win);
    148 	return wtouchln(win, 0, win->maxy, 0);
    149 }
    150 
    151 /*
    152  * wtouchln --
    153  *	If changed is 1 then touch n lines starting at line.  If changed
    154  *	is 0 then mark the lines as unchanged.
    155  */
    156 int
    157 wtouchln(WINDOW *win, int line, int n, int changed)
    158 {
    159 	int	y;
    160 	__LINE	*wlp;
    161 
    162 	__CTRACE(__CTRACE_LINE, "wtouchln: (%p) %d, %d, %d\n",
    163 	    win, line, n, changed);
    164 	if (line < 0 || win->maxy <= line)
    165 		return ERR;
    166 	if (n < 0)
    167 		return ERR;
    168 	if (n > win->maxy - line)
    169 		n = win->maxy - line;
    170 
    171 	for (y = line; y < line + n; y++) {
    172 		if (changed == 1)
    173 			_cursesi_touchline_force(win, y, 0,
    174 			    (int) win->maxx - 1, 1);
    175 		else {
    176 			wlp = win->alines[y];
    177 			if (*wlp->firstchp >= win->ch_off &&
    178 			    *wlp->firstchp < win->maxx + win->ch_off)
    179 				*wlp->firstchp = win->maxx + win->ch_off;
    180 			if (*wlp->lastchp >= win->ch_off &&
    181 			    *wlp->lastchp < win->maxx + win->ch_off)
    182 				*wlp->lastchp = win->ch_off;
    183 			wlp->flags &= ~(__ISDIRTY | __ISFORCED);
    184 		}
    185 	}
    186 
    187 	return OK;
    188 }
    189 
    190 /*
    191  * Touch all the lines in a window.  If force is set to 1 then screen
    192  * update optimisation will disabled to force the change out.
    193  */
    194 int
    195 __touchwin(WINDOW *win, int force)
    196 {
    197 	int	 y, maxy;
    198 
    199 	__CTRACE(__CTRACE_LINE, "__touchwin: (%p)\n", win);
    200 	maxy = win->maxy;
    201 	for (y = 0; y < maxy; y++)
    202 		_cursesi_touchline_force(win, y, 0, (int) win->maxx - 1,
    203 		    force);
    204 	return OK;
    205 }
    206 
    207 int
    208 __touchline(WINDOW *win, int y, int sx, int ex)
    209 {
    210 
    211 	return _cursesi_touchline_force(win, y, sx, ex, 0);
    212 }
    213 
    214 /*
    215  * Touch line y on window win starting from column sx and ending at
    216  * column ex.  If force is 1 then we mark this line as a forced update
    217  * which will bypass screen optimisation in the refresh code to rewrite
    218  * this line unconditionally (even if refresh thinks the screen matches
    219  * what is in the virtscr)
    220  */
    221 static int
    222 _cursesi_touchline_force(WINDOW *win, int y, int sx, int ex, int force)
    223 {
    224 
    225 	__CTRACE(__CTRACE_LINE, "__touchline: (%p, %d, %d, %d, %d)\n",
    226 	    win, y, sx, ex, force);
    227 	__CTRACE(__CTRACE_LINE, "__touchline: first = %d, last = %d\n",
    228 	    *win->alines[y]->firstchp, *win->alines[y]->lastchp);
    229 	sx += win->ch_off;
    230 	ex += win->ch_off;
    231 	win->alines[y]->flags |= __ISDIRTY;
    232 	if (force == 1)
    233 		win->alines[y]->flags |= __ISFORCED;
    234 	/* firstchp/lastchp are shared between parent window and sub-window. */
    235 	if (*win->alines[y]->firstchp > sx)
    236 		*win->alines[y]->firstchp = sx;
    237 	if (*win->alines[y]->lastchp < ex)
    238 		*win->alines[y]->lastchp = ex;
    239 	__CTRACE(__CTRACE_LINE, "__touchline: first = %d, last = %d\n",
    240 	    *win->alines[y]->firstchp, *win->alines[y]->lastchp);
    241 	return OK;
    242 }
    243 
    244 void
    245 wsyncup(WINDOW *win)
    246 {
    247 
    248 	do {
    249 		__touchwin(win, 0);
    250 		win = win->orig;
    251 	} while (win);
    252 }
    253 
    254 void
    255 wsyncdown(WINDOW *win)
    256 {
    257 	WINDOW *w = win->orig;
    258 
    259 	while (w) {
    260 		if (is_wintouched(w)) {
    261 			__touchwin(win, 0);
    262 			break;
    263 		}
    264 		w = w->orig;
    265 	}
    266 }
    267