xref: /openbsd-src/lib/libcurses/base/lib_clreol.c (revision c7ef0cfc17afcba97172c25e1e3a943e893bc632)
1 /* $OpenBSD: lib_clreol.c,v 1.5 2023/10/17 09:52:08 nicm Exp $ */
2 
3 /****************************************************************************
4  * Copyright 2020,2021 Thomas E. Dickey                                     *
5  * Copyright 1998-2001,2009 Free Software Foundation, Inc.                  *
6  *                                                                          *
7  * Permission is hereby granted, free of charge, to any person obtaining a  *
8  * copy of this software and associated documentation files (the            *
9  * "Software"), to deal in the Software without restriction, including      *
10  * without limitation the rights to use, copy, modify, merge, publish,      *
11  * distribute, distribute with modifications, sublicense, and/or sell       *
12  * copies of the Software, and to permit persons to whom the Software is    *
13  * furnished to do so, subject to the following conditions:                 *
14  *                                                                          *
15  * The above copyright notice and this permission notice shall be included  *
16  * in all copies or substantial portions of the Software.                   *
17  *                                                                          *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25  *                                                                          *
26  * Except as contained in this notice, the name(s) of the above copyright   *
27  * holders shall not be used in advertising or otherwise to promote the     *
28  * sale, use or other dealings in this Software without prior written       *
29  * authorization.                                                           *
30  ****************************************************************************/
31 
32 /****************************************************************************
33  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
34  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
35  ****************************************************************************/
36 
37 /*
38 **	lib_clreol.c
39 **
40 **	The routine wclrtoeol().
41 **
42 */
43 
44 #include <curses.priv.h>
45 
46 MODULE_ID("$Id: lib_clreol.c,v 1.5 2023/10/17 09:52:08 nicm Exp $")
47 
NCURSES_EXPORT(int)48 NCURSES_EXPORT(int)
49 wclrtoeol(WINDOW *win)
50 {
51     int code = ERR;
52 
53     T((T_CALLED("wclrtoeol(%p)"), (void *) win));
54 
55     if (win) {
56 	NCURSES_CH_T blank;
57 	NCURSES_CH_T *ptr, *end;
58 	struct ldat *line;
59 	NCURSES_SIZE_T y = win->_cury;
60 	NCURSES_SIZE_T x = win->_curx;
61 
62 	/*
63 	 * If we have just wrapped the cursor, the clear applies to the
64 	 * new line, unless we are at the lower right corner.
65 	 */
66 	if (IS_WRAPPED(win) != 0
67 	    && y < win->_maxy) {
68 	    win->_flags &= ~_WRAPPED;
69 	}
70 
71 	/*
72 	 * There's no point in clearing if we're not on a legal
73 	 * position, either.
74 	 */
75 	if (IS_WRAPPED(win)
76 	    || y > win->_maxy
77 	    || x > win->_maxx)
78 	    returnCode(ERR);
79 
80 	blank = win->_nc_bkgd;
81 	line = &win->_line[y];
82 	CHANGED_TO_EOL(line, x, win->_maxx);
83 
84 	ptr = &(line->text[x]);
85 	end = &(line->text[win->_maxx]);
86 
87 	while (ptr <= end)
88 	    *ptr++ = blank;
89 
90 	_nc_synchook(win);
91 	code = OK;
92     }
93     returnCode(code);
94 }
95