Home | History | Annotate | Line # | Download | only in libcurses
scroll.c revision 1.28 
      1 /*	$NetBSD: scroll.c,v 1.28 2024/12/05 04:08:12 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[] = "@(#)scroll.c	8.3 (Berkeley) 5/4/94";
     36 #else
     37 __RCSID("$NetBSD: scroll.c,v 1.28 2024/12/05 04:08:12 blymn Exp $");
     38 #endif
     39 #endif				/* not lint */
     40 
     41 #include "curses.h"
     42 #include "curses_private.h"
     43 
     44 /*
     45  * scroll --
     46  *	Scroll the window up a line.
     47  */
     48 int
     49 scroll(WINDOW *win)
     50 {
     51 
     52 	return wscrl(win, 1);
     53 }
     54 
     55 #ifndef _CURSES_USE_MACROS
     56 
     57 /*
     58  * scrl --
     59  *	Scroll stdscr n lines - up if n is positive, down if n is negative.
     60  */
     61 int
     62 scrl(int nlines)
     63 {
     64 
     65 	return wscrl(stdscr, nlines);
     66 }
     67 
     68 /*
     69  * setscrreg --
     70  *	Set the top and bottom of the scrolling region for stdscr.
     71  */
     72 int
     73 setscrreg(int top, int bottom)
     74 {
     75 
     76 	return wsetscrreg(stdscr, top, bottom);
     77 }
     78 
     79 /*
     80  * getscrreg --
     81  *	Get the top and bottom of the scrolling region for stdscr.
     82  */
     83 int
     84 getscrreg(int *top, int *bottom)
     85 {
     86 
     87 	return wgetscrreg(stdscr, top, bottom);
     88 }
     89 
     90 #endif
     91 
     92 /*
     93  * wscrl --
     94  *	Scroll a window n lines - up if n is positive, down if n is negative.
     95  */
     96 int
     97 wscrl(WINDOW *win, int nlines)
     98 {
     99 	int     oy, ox;
    100 
    101 	__CTRACE(__CTRACE_WINDOW, "wscrl: (%p) lines=%d\n", win, nlines);
    102 
    103 	if (!(win->flags & __SCROLLOK))
    104 		return ERR;
    105 	if (!nlines)
    106 		return OK;
    107 
    108 	getyx(win, oy, ox);
    109 	__CTRACE(__CTRACE_WINDOW, "wscrl: y=%d\n", oy);
    110 	wmove(win, win->scr_t, 1);
    111 	winsdelln(win, 0 - nlines);
    112 	wmove(win, oy, ox);
    113 
    114 	if (win == curscr) {
    115 		__cputchar('\n');
    116 		if (!__NONL)
    117 			win->curx = 0;
    118 		__CTRACE(__CTRACE_WINDOW, "scroll: win == curscr\n");
    119 	}
    120 	return OK;
    121 }
    122 
    123 /*
    124  * wsetscrreg --
    125  *	Set the top and bottom of the scrolling region for win.
    126  */
    127 int
    128 wsetscrreg(WINDOW *win, int top, int bottom)
    129 {
    130 	if (top < 0 || bottom >= win->maxy || bottom - top < 1)
    131 		return ERR;
    132 	win->scr_t = top;
    133 	win->scr_b = bottom;
    134 	return OK;
    135 }
    136 
    137 /*
    138  * wgetscrreg --
    139  *	Get the top and bottom of the scrolling region for win.
    140  */
    141 int
    142 wgetscrreg(WINDOW *win, int *top, int *bottom)
    143 {
    144 	*top = win->scr_t;
    145 	*bottom = win->scr_b;
    146 	return OK;
    147 }
    148 
    149 /*
    150  * has_ic --
    151  *	Does the terminal have insert- and delete-character?
    152  */
    153 bool
    154 has_ic(void)
    155 {
    156 
    157 	if (insert_character != NULL && delete_character != NULL)
    158 		return true;
    159 	else
    160 		return false;
    161 }
    162 
    163 /*
    164  * has_ic --
    165  *	Does the terminal have insert- and delete-line?
    166  */
    167 bool
    168 has_il(void)
    169 {
    170 	if (insert_line !=NULL && delete_line != NULL)
    171 		return true;
    172 	else
    173 		return false;
    174 }
    175