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