ncurses 5.7 - patch 20090221
[ncurses.git] / ncurses / base / lib_flash.c
1 /****************************************************************************
2  * Copyright (c) 1998-2000,2009 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  *     and: Thomas E. Dickey                        1996-on                 *
33  *     and: Juergen Pfeifer                         2009                    *
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("$Id: lib_flash.c,v 1.7 2009/02/15 00:35:15 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 NCURSES_SP_NAME(flash) (NCURSES_SP_DCL0)
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
77 #if NCURSES_SP_FUNCS
78 NCURSES_EXPORT(int)
79 flash(void)
80 {
81     return NCURSES_SP_NAME(flash) (CURRENT_SCREEN);
82 }
83 #endif