ncurses/base/define_key.c

   1 /****************************************************************************
   2  * Copyright (c) 1998-2009,2014 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: Thomas E. Dickey                        1997-on                 *
  31  *     and: Juergen Pfeifer                         2009                    *
  32  ****************************************************************************/
  33
  34 #include <curses.priv.h>
  35
  36 MODULE_ID("$Id: define_key.c,v 1.21 2014/03/08 20:32:59 tom Exp $")
  37
  38 NCURSES_EXPORT(int)
  39 NCURSES_SP_NAME(define_key) (NCURSES_SP_DCLx const char *str, int keycode)
  40 {
  41     int code = ERR;
  42
  43     T((T_CALLED("define_key(%p, %s,%d)"), (void *) SP_PARM, _nc_visbuf(str), keycode));
  44     if (SP_PARM == 0 || !HasTInfoTerminal(SP_PARM)) {
  45         code = ERR;
  46     } else if (keycode > 0) {
  47         unsigned ukey = (unsigned) keycode;
  48
  49 #ifdef USE_TERM_DRIVER
  50 #define CallHasKey(keycode) CallDriver_1(SP_PARM, td_kyExist, keycode)
  51 #else
  52 #define CallHasKey(keycode) NCURSES_SP_NAME(has_key)(NCURSES_SP_ARGx keycode)
  53 #endif
  54
  55         if (str != 0) {
  56             NCURSES_SP_NAME(define_key) (NCURSES_SP_ARGx str, 0);
  57         } else if (CallHasKey(keycode)) {
  58             while (_nc_remove_key(&(SP_PARM->_keytry), ukey))
  59                 code = OK;
  60         }
  61         if (str != 0) {
  62             if (NCURSES_SP_NAME(key_defined) (NCURSES_SP_ARGx str) == 0) {
  63                 if (_nc_add_to_try(&(SP_PARM->_keytry), str, ukey) == OK) {
  64                     code = OK;
  65                 } else {
  66                     code = ERR;
  67                 }
  68             } else {
  69                 code = ERR;
  70             }
  71         }
  72     } else {
  73         while (_nc_remove_string(&(SP_PARM->_keytry), str))
  74             code = OK;
  75     }
  76     returnCode(code);
  77 }
  78
  79 #if NCURSES_SP_FUNCS
  80 NCURSES_EXPORT(int)
  81 define_key(const char *str, int keycode)
  82 {
  83     return NCURSES_SP_NAME(define_key) (CURRENT_SCREEN, str, keycode);
  84 }
  85 #endif