ncurses 6.2 - patch 20200829
[ncurses.git] / ncurses / base / lib_beep.c
1 /****************************************************************************
2  * Copyright 2020 Thomas E. Dickey                                          *
3  * Copyright 1998-2013,2014 Free Software Foundation, Inc.                  *
4  *                                                                          *
5  * Permission is hereby granted, free of charge, to any person obtaining a  *
6  * copy of this software and associated documentation files (the            *
7  * "Software"), to deal in the Software without restriction, including      *
8  * without limitation the rights to use, copy, modify, merge, publish,      *
9  * distribute, distribute with modifications, sublicense, and/or sell       *
10  * copies of the Software, and to permit persons to whom the Software is    *
11  * furnished to do so, subject to the following conditions:                 *
12  *                                                                          *
13  * The above copyright notice and this permission notice shall be included  *
14  * in all copies or substantial portions of the Software.                   *
15  *                                                                          *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23  *                                                                          *
24  * Except as contained in this notice, the name(s) of the above copyright   *
25  * holders shall not be used in advertising or otherwise to promote the     *
26  * sale, use or other dealings in this Software without prior written       *
27  * authorization.                                                           *
28  ****************************************************************************/
29
30 /****************************************************************************
31  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
32  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
33  *     and: Thomas E. Dickey                        1996-on                 *
34  *     and: Juergen Pfeifer                         2009                    *
35  ****************************************************************************/
36
37 /*
38  *      beep.c
39  *
40  *      The routine beep().
41  *
42  */
43
44 #include <curses.priv.h>
45
46 #ifndef CUR
47 #define CUR SP_TERMTYPE
48 #endif
49
50 MODULE_ID("$Id: lib_beep.c,v 1.18 2020/02/02 23:34:34 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(%p)"), (void *) SP_PARM));
66
67 #ifdef USE_TERM_DRIVER
68     if (SP_PARM != 0)
69         res = CallDriver_1(SP_PARM, td_doBeepOrFlash, TRUE);
70 #else
71     /* FIXME: should make sure that we are not in altchar mode */
72     if (cur_term == 0) {
73         res = ERR;
74     } else if (bell) {
75         res = NCURSES_PUTP2_FLUSH("bell", bell);
76     } else if (flash_screen) {
77         res = NCURSES_PUTP2_FLUSH("flash_screen", flash_screen);
78         _nc_flush();
79     }
80 #endif
81
82     returnCode(res);
83 }
84
85 #if NCURSES_SP_FUNCS
86 NCURSES_EXPORT(int)
87 beep(void)
88 {
89     return NCURSES_SP_NAME(beep) (CURRENT_SCREEN);
90 }
91 #endif