ncurses/base/lib_flash.c

   1 /****************************************************************************
   2  * Copyright (c) 1998-2009,2011 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
  45 #ifndef CUR
  46 #define CUR SP_TERMTYPE
  47 #endif
  48
  49 MODULE_ID("$Id: lib_flash.c,v 1.12 2011/05/28 21:53:45 tom Exp $")
  50
  51 /*
  52  *      flash()
  53  *
  54  *      Flash the current terminal's screen if possible.   If not,
  55  *      sound the audible bell if one exists.
  56  *
  57  */
  58
  59 NCURSES_EXPORT(int)
  60 NCURSES_SP_NAME(flash) (NCURSES_SP_DCL0)
  61 {
  62     int res = ERR;
  63
  64     T((T_CALLED("flash(%p)"), (void *) SP_PARM));
  65 #ifdef USE_TERM_DRIVER
  66     if (SP_PARM != 0)
  67         res = CallDriver_1(SP_PARM, doBeepOrFlash, FALSE);
  68 #else
  69     if (HasTerminal(SP_PARM)) {
  70         /* FIXME: should make sure that we are not in altchar mode */
  71         if (flash_screen) {
  72             TPUTS_TRACE("flash_screen");
  73             res = putp(flash_screen);
  74             _nc_flush();
  75         } else if (bell) {
  76             TPUTS_TRACE("bell");
  77             res = putp(bell);
  78             _nc_flush();
  79         }
  80     }
  81 #endif
  82     returnCode(res);
  83 }
  84
  85 #if NCURSES_SP_FUNCS
  86 NCURSES_EXPORT(int)
  87 flash(void)
  88 {
  89     return NCURSES_SP_NAME(flash) (CURRENT_SCREEN);
  90 }
  91 #endif