1 /* $OpenBSD: key_defined.c,v 1.2 2023/10/17 09:52:08 nicm Exp $ */
2
3 /****************************************************************************
4 * Copyright 2020,2023 Thomas E. Dickey *
5 * Copyright 2003-2006,2009 Free Software Foundation, Inc. *
6 * *
7 * Permission is hereby granted, free of charge, to any person obtaining a *
8 * copy of this software and associated documentation files (the *
9 * "Software"), to deal in the Software without restriction, including *
10 * without limitation the rights to use, copy, modify, merge, publish, *
11 * distribute, distribute with modifications, sublicense, and/or sell *
12 * copies of the Software, and to permit persons to whom the Software is *
13 * furnished to do so, subject to the following conditions: *
14 * *
15 * The above copyright notice and this permission notice shall be included *
16 * in all copies or substantial portions of the Software. *
17 * *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
21 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
22 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
23 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
24 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
25 * *
26 * Except as contained in this notice, the name(s) of the above copyright *
27 * holders shall not be used in advertising or otherwise to promote the *
28 * sale, use or other dealings in this Software without prior written *
29 * authorization. *
30 ****************************************************************************/
31
32 /****************************************************************************
33 * Author: Thomas E. Dickey, 2003 *
34 ****************************************************************************/
35
36 #include <curses.priv.h>
37 #include <tic.h>
38
39 MODULE_ID("$Id: key_defined.c,v 1.2 2023/10/17 09:52:08 nicm Exp $")
40
41 static int
find_definition(TRIES * tree,const char * str)42 find_definition(TRIES * tree, const char *str)
43 {
44 TRIES *ptr;
45 int result = OK;
46
47 if (VALID_STRING(str) && *str != '\0') {
48 for (ptr = tree; ptr != 0; ptr = ptr->sibling) {
49 if (UChar(*str) == UChar(ptr->ch)) {
50 if (str[1] == '\0' && ptr->child != 0) {
51 result = ERR;
52 } else if ((result = find_definition(ptr->child, str + 1))
53 == OK) {
54 result = ptr->value;
55 } else if (str[1] == '\0') {
56 result = ERR;
57 }
58 }
59 if (result != OK)
60 break;
61 }
62 }
63 return (result);
64 }
65
66 /*
67 * Returns the keycode associated with the given string. If none is found,
68 * return OK. If the string is only a prefix to other strings, return ERR.
69 * Otherwise, return the keycode's value (neither OK/ERR).
70 */
71 NCURSES_EXPORT(int)
NCURSES_SP_NAME(key_defined)72 NCURSES_SP_NAME(key_defined) (NCURSES_SP_DCLx const char *str)
73 {
74 int code = ERR;
75
76 T((T_CALLED("key_defined(%p, %s)"), (void *) SP_PARM, _nc_visbuf(str)));
77 if (SP_PARM != 0 && str != 0) {
78 code = find_definition(SP_PARM->_keytry, str);
79 }
80
81 returnCode(code);
82 }
83
84 #if NCURSES_SP_FUNCS
85 NCURSES_EXPORT(int)
key_defined(const char * str)86 key_defined(const char *str)
87 {
88 return NCURSES_SP_NAME(key_defined) (CURRENT_SCREEN, str);
89 }
90 #endif
91