ncurses/base/key_defined.c

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