0093a38246f2d61b69ec5eddc78b8c945bf52509
[ncurses.git] / ncurses / base / lib_beep.c
1 /****************************************************************************
2  * Copyright (c) 1998-2005,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  *      beep.c
38  *
39  *      The routine beep().
40  *
41  */
42
43 #include <curses.priv.h>
44 #include <term.h>               /* beep, flash */
45
46 #ifndef CUR
47 #define CUR SP_TERMTYPE 
48 #endif
49
50 MODULE_ID("$Id: lib_beep.c,v 1.13 2009/05/10 00:48:29 tom Exp $")
51
52 /*
53  *      beep()
54  *
55  *      Sound the current terminal's audible bell if it has one.   If not,
56  *      flash the screen if possible.
57  *
58  */
59
60 NCURSES_EXPORT(int)
61 NCURSES_SP_NAME(beep) (NCURSES_SP_DCL0)
62 {
63     int res = ERR;
64
65     T((T_CALLED("beep()")));
66
67     /* FIXME: should make sure that we are not in altchar mode */
68     if (cur_term == 0) {
69         res = ERR;
70     } else if (bell) {
71         TPUTS_TRACE("bell");
72         res = putp(bell);
73         _nc_flush();
74     } else if (flash_screen) {
75         TPUTS_TRACE("flash_screen");
76         res = putp(flash_screen);
77         _nc_flush();
78     }
79
80     returnCode(res);
81 }
82
83 #if NCURSES_SP_FUNCS
84 NCURSES_EXPORT(int)
85 beep(void)
86 {
87     return NCURSES_SP_NAME(beep) (CURRENT_SCREEN);
88 }
89 #endif