ncurses 5.5
[ncurses.git] / ncurses / base / lib_clreol.c
1 /****************************************************************************
2  * Copyright (c) 1998,1999,2000,2001 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: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
31  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
32  ****************************************************************************/
33
34 /*
35 **      lib_clreol.c
36 **
37 **      The routine wclrtoeol().
38 **
39 */
40
41 #include <curses.priv.h>
42
43 MODULE_ID("$Id: lib_clreol.c,v 1.21 2001/12/19 01:06:04 tom Exp $")
44
45 NCURSES_EXPORT(int)
46 wclrtoeol(WINDOW *win)
47 {
48     int code = ERR;
49
50     T((T_CALLED("wclrtoeol(%p)"), win));
51
52     if (win) {
53         NCURSES_CH_T blank;
54         NCURSES_CH_T *ptr, *end;
55         struct ldat *line;
56         NCURSES_SIZE_T y = win->_cury;
57         NCURSES_SIZE_T x = win->_curx;
58
59         /*
60          * If we have just wrapped the cursor, the clear applies to the
61          * new line, unless we are at the lower right corner.
62          */
63         if ((win->_flags & _WRAPPED) != 0
64             && y < win->_maxy) {
65             win->_flags &= ~_WRAPPED;
66         }
67
68         /*
69          * There's no point in clearing if we're not on a legal
70          * position, either.
71          */
72         if ((win->_flags & _WRAPPED) != 0
73             || y > win->_maxy
74             || x > win->_maxx)
75             returnCode(ERR);
76
77         blank = win->_nc_bkgd;
78         line = &win->_line[y];
79         CHANGED_TO_EOL(line, x, win->_maxx);
80
81         ptr = &(line->text[x]);
82         end = &(line->text[win->_maxx]);
83
84         while (ptr <= end)
85             *ptr++ = blank;
86
87         _nc_synchook(win);
88         code = OK;
89     }
90     returnCode(code);
91 }