xref: /openbsd/lib/libcurses/base/lib_flash.c (revision 133306f0)
1 /*	$OpenBSD: lib_flash.c,v 1.3 2001/01/22 18:01:39 millert Exp $	*/
2 
3 /****************************************************************************
4  * Copyright (c) 1998,2000 Free Software Foundation, Inc.                   *
5  *                                                                          *
6  * Permission is hereby granted, free of charge, to any person obtaining a  *
7  * copy of this software and associated documentation files (the            *
8  * "Software"), to deal in the Software without restriction, including      *
9  * without limitation the rights to use, copy, modify, merge, publish,      *
10  * distribute, distribute with modifications, sublicense, and/or sell       *
11  * copies of the Software, and to permit persons to whom the Software is    *
12  * furnished to do so, subject to the following conditions:                 *
13  *                                                                          *
14  * The above copyright notice and this permission notice shall be included  *
15  * in all copies or substantial portions of the Software.                   *
16  *                                                                          *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24  *                                                                          *
25  * Except as contained in this notice, the name(s) of the above copyright   *
26  * holders shall not be used in advertising or otherwise to promote the     *
27  * sale, use or other dealings in this Software without prior written       *
28  * authorization.                                                           *
29  ****************************************************************************/
30 
31 /****************************************************************************
32  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
33  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
34  ****************************************************************************/
35 
36 /*
37  *	flash.c
38  *
39  *	The routine flash().
40  *
41  */
42 
43 #include <curses.priv.h>
44 #include <term.h>		/* beep, flash */
45 
46 MODULE_ID("$From: lib_flash.c,v 1.6 2000/12/10 02:43:27 tom Exp $")
47 
48 /*
49  *	flash()
50  *
51  *	Flash the current terminal's screen if possible.   If not,
52  *	sound the audible bell if one exists.
53  *
54  */
55 
56 NCURSES_EXPORT(int)
57 flash(void)
58 {
59     int res = ERR;
60 
61     T((T_CALLED("flash()")));
62 
63     /* FIXME: should make sure that we are not in altchar mode */
64     if (flash_screen) {
65 	TPUTS_TRACE("flash_screen");
66 	res = putp(flash_screen);
67 	_nc_flush();
68     } else if (bell) {
69 	TPUTS_TRACE("bell");
70 	res = putp(bell);
71 	_nc_flush();
72     }
73 
74     returnCode(res);
75 }
76