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