ncurses/base/lib_flash.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  *      flash.c
  39  *
  40  *      The routine flash().
  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_flash.c,v 1.15 2020/02/02 23:34:34 tom Exp $")
  51
  52 /*
  53  *      flash()
  54  *
  55  *      Flash the current terminal's screen if possible.   If not,
  56  *      sound the audible bell if one exists.
  57  *
  58  */
  59
  60 NCURSES_EXPORT(int)
  61 NCURSES_SP_NAME(flash) (NCURSES_SP_DCL0)
  62 {
  63     int res = ERR;
  64
  65     T((T_CALLED("flash(%p)"), (void *) SP_PARM));
  66 #ifdef USE_TERM_DRIVER
  67     if (SP_PARM != 0)
  68         res = CallDriver_1(SP_PARM, td_doBeepOrFlash, FALSE);
  69 #else
  70     if (HasTerminal(SP_PARM)) {
  71         /* FIXME: should make sure that we are not in altchar mode */
  72         if (flash_screen) {
  73             res = NCURSES_PUTP2_FLUSH("flash_screen", flash_screen);
  74         } else if (bell) {
  75             res = NCURSES_PUTP2_FLUSH("bell", bell);
  76         }
  77     }
  78 #endif
  79     returnCode(res);
  80 }
  81
  82 #if NCURSES_SP_FUNCS
  83 NCURSES_EXPORT(int)
  84 flash(void)
  85 {
  86     return NCURSES_SP_NAME(flash) (CURRENT_SCREEN);
  87 }
  88 #endif