ncurses/base/key_defined.c

   1 /****************************************************************************
   2  * Copyright 2020,2023 Thomas E. Dickey                                     *
   3  * Copyright 2003-2006,2009 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, 2003                                          *
  32  ****************************************************************************/
  33
  34 #include <curses.priv.h>
  35 #include <tic.h>
  36
  37 MODULE_ID("$Id: key_defined.c,v 1.11 2023/06/24 15:36:32 tom Exp $")
  38
  39 static int
  40 find_definition(TRIES * tree, const char *str)
  41 {
  42     TRIES *ptr;
  43     int result = OK;
  44
  45     if (VALID_STRING(str) && *str != '\0') {
  46         for (ptr = tree; ptr != 0; ptr = ptr->sibling) {
  47             if (UChar(*str) == UChar(ptr->ch)) {
  48                 if (str[1] == '\0' && ptr->child != 0) {
  49                     result = ERR;
  50                 } else if ((result = find_definition(ptr->child, str + 1))
  51                            == OK) {
  52                     result = ptr->value;
  53                 } else if (str[1] == '\0') {
  54                     result = ERR;
  55                 }
  56             }
  57             if (result != OK)
  58                 break;
  59         }
  60     }
  61     return (result);
  62 }
  63
  64 /*
  65  * Returns the keycode associated with the given string.  If none is found,
  66  * return OK.  If the string is only a prefix to other strings, return ERR.
  67  * Otherwise, return the keycode's value (neither OK/ERR).
  68  */
  69 NCURSES_EXPORT(int)
  70 NCURSES_SP_NAME(key_defined) (NCURSES_SP_DCLx const char *str)
  71 {
  72     int code = ERR;
  73
  74     T((T_CALLED("key_defined(%p, %s)"), (void *) SP_PARM, _nc_visbuf(str)));
  75     if (SP_PARM != 0 && str != 0) {
  76         code = find_definition(SP_PARM->_keytry, str);
  77     }
  78
  79     returnCode(code);
  80 }
  81
  82 #if NCURSES_SP_FUNCS
  83 NCURSES_EXPORT(int)
  84 key_defined(const char *str)
  85 {
  86     return NCURSES_SP_NAME(key_defined) (CURRENT_SCREEN, str);
  87 }
  88 #endif