ncurses/base/define_key.c

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