ncurses 5.6 - patch 20071222
[ncurses.git] / ncurses / base / tries.c
1 /****************************************************************************
2  * Copyright (c) 1998-2006,2007 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 <dickey@clark.net> 1997                        *
31  ****************************************************************************/
32
33 /*
34 **      tries.c
35 **
36 **      Functions to manage the tree of partial-completions for keycodes.
37 **
38 */
39
40 #include <curses.priv.h>
41
42 MODULE_ID("$Id: tries.c,v 1.25 2007/09/29 20:37:13 tom Exp $")
43
44 /*
45  * Expand a keycode into the string that it corresponds to, returning null if
46  * no match was found, otherwise allocating a string of the result.
47  */
48 NCURSES_EXPORT(char *)
49 _nc_expand_try(TRIES * tree, unsigned code, int *count, size_t len)
50 {
51     TRIES *ptr = tree;
52     char *result = 0;
53
54     if (code != 0) {
55         while (ptr != 0) {
56             if ((result = _nc_expand_try(ptr->child, code, count, len + 1))
57                 != 0) {
58                 break;
59             }
60             if (ptr->value == code) {
61                 *count -= 1;
62                 if (*count == -1) {
63                     result = typeCalloc(char, len + 2);
64                     break;
65                 }
66             }
67             ptr = ptr->sibling;
68         }
69     }
70     if (result != 0) {
71         if (ptr != 0 && (result[len] = ptr->ch) == 0)
72             *((unsigned char *) (result + len)) = 128;
73 #ifdef TRACE
74         if (len == 0 && USE_TRACEF(TRACE_MAXIMUM)) {
75             _tracef("expand_key %s %s", _tracechar(code), _nc_visbuf(result));
76             _nc_unlock_global(tracef);
77         }
78 #endif
79     }
80     return result;
81 }
82
83 /*
84  * Remove a code from the specified tree, freeing the unused nodes.  Returns
85  * true if the code was found/removed.
86  */
87 NCURSES_EXPORT(int)
88 _nc_remove_key(TRIES ** tree, unsigned code)
89 {
90     T((T_CALLED("_nc_remove_key(%p,%d)"), tree, code));
91
92     if (code == 0)
93         returnCode(FALSE);
94
95     while (*tree != 0) {
96         if (_nc_remove_key(&(*tree)->child, code)) {
97             returnCode(TRUE);
98         }
99         if ((*tree)->value == code) {
100             if ((*tree)->child) {
101                 /* don't cut the whole sub-tree */
102                 (*tree)->value = 0;
103             } else {
104                 TRIES *to_free = *tree;
105                 *tree = (*tree)->sibling;
106                 free(to_free);
107             }
108             returnCode(TRUE);
109         }
110         tree = &(*tree)->sibling;
111     }
112     returnCode(FALSE);
113 }
114
115 /*
116  * Remove a string from the specified tree, freeing the unused nodes.  Returns
117  * true if the string was found/removed.
118  */
119 NCURSES_EXPORT(int)
120 _nc_remove_string(TRIES ** tree, const char *string)
121 {
122     T((T_CALLED("_nc_remove_string(%p,%s)"), tree, _nc_visbuf(string)));
123
124     if (string == 0 || *string == 0)
125         returnCode(FALSE);
126
127     while (*tree != 0) {
128         if (UChar((*tree)->ch) == UChar(*string)) {
129             if (string[1] != 0)
130                 returnCode(_nc_remove_string(&(*tree)->child, string + 1));
131             if ((*tree)->child == 0) {
132                 TRIES *to_free = *tree;
133                 *tree = (*tree)->sibling;
134                 free(to_free);
135                 returnCode(TRUE);
136             } else {
137                 returnCode(FALSE);
138             }
139         }
140         tree = &(*tree)->sibling;
141     }
142     returnCode(FALSE);
143 }