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