xref: /openbsd/usr.bin/tic/clear_cmd.c (revision c7ef0cfc)
1*c7ef0cfcSnicm /****************************************************************************
2*c7ef0cfcSnicm  * Copyright 2018,2020 Thomas E. Dickey                                     *
3*c7ef0cfcSnicm  * Copyright 2016,2017 Free Software Foundation, Inc.                       *
4*c7ef0cfcSnicm  *                                                                          *
5*c7ef0cfcSnicm  * Permission is hereby granted, free of charge, to any person obtaining a  *
6*c7ef0cfcSnicm  * copy of this software and associated documentation files (the            *
7*c7ef0cfcSnicm  * "Software"), to deal in the Software without restriction, including      *
8*c7ef0cfcSnicm  * without limitation the rights to use, copy, modify, merge, publish,      *
9*c7ef0cfcSnicm  * distribute, distribute with modifications, sublicense, and/or sell       *
10*c7ef0cfcSnicm  * copies of the Software, and to permit persons to whom the Software is    *
11*c7ef0cfcSnicm  * furnished to do so, subject to the following conditions:                 *
12*c7ef0cfcSnicm  *                                                                          *
13*c7ef0cfcSnicm  * The above copyright notice and this permission notice shall be included  *
14*c7ef0cfcSnicm  * in all copies or substantial portions of the Software.                   *
15*c7ef0cfcSnicm  *                                                                          *
16*c7ef0cfcSnicm  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17*c7ef0cfcSnicm  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18*c7ef0cfcSnicm  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19*c7ef0cfcSnicm  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20*c7ef0cfcSnicm  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21*c7ef0cfcSnicm  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22*c7ef0cfcSnicm  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23*c7ef0cfcSnicm  *                                                                          *
24*c7ef0cfcSnicm  * Except as contained in this notice, the name(s) of the above copyright   *
25*c7ef0cfcSnicm  * holders shall not be used in advertising or otherwise to promote the     *
26*c7ef0cfcSnicm  * sale, use or other dealings in this Software without prior written       *
27*c7ef0cfcSnicm  * authorization.                                                           *
28*c7ef0cfcSnicm  ****************************************************************************/
29*c7ef0cfcSnicm 
30*c7ef0cfcSnicm /****************************************************************************
31*c7ef0cfcSnicm  *  Author: Thomas E. Dickey                                                *
32*c7ef0cfcSnicm  ****************************************************************************/
33*c7ef0cfcSnicm 
34*c7ef0cfcSnicm /*
35*c7ef0cfcSnicm  * clear.c --  clears the terminal's screen
36*c7ef0cfcSnicm  */
37*c7ef0cfcSnicm 
38*c7ef0cfcSnicm #define USE_LIBTINFO
39*c7ef0cfcSnicm #include <clear_cmd.h>
40*c7ef0cfcSnicm 
41*c7ef0cfcSnicm MODULE_ID("$Id: clear_cmd.c,v 1.1 2023/10/17 09:52:10 nicm Exp $")
42*c7ef0cfcSnicm 
43*c7ef0cfcSnicm static int
putch(int c)44*c7ef0cfcSnicm putch(int c)
45*c7ef0cfcSnicm {
46*c7ef0cfcSnicm     return putchar(c);
47*c7ef0cfcSnicm }
48*c7ef0cfcSnicm 
49*c7ef0cfcSnicm int
clear_cmd(bool legacy)50*c7ef0cfcSnicm clear_cmd(bool legacy)
51*c7ef0cfcSnicm {
52*c7ef0cfcSnicm     int retval = tputs(clear_screen, lines > 0 ? lines : 1, putch);
53*c7ef0cfcSnicm     if (!legacy) {
54*c7ef0cfcSnicm 	/* Clear the scrollback buffer if possible. */
55*c7ef0cfcSnicm 	char *E3 = tigetstr("E3");
56*c7ef0cfcSnicm 	if (E3)
57*c7ef0cfcSnicm 	    (void) tputs(E3, lines > 0 ? lines : 1, putch);
58*c7ef0cfcSnicm     }
59*c7ef0cfcSnicm     return retval;
60*c7ef0cfcSnicm }
61