ncurses 5.9 - patch 20121117
[ncurses.git] / ncurses / tinfo / make_hash.c
1 /****************************************************************************
2  * Copyright (c) 1998-2011,2012 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: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
31  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
32  *     and: Thomas E. Dickey                        1996-on                 *
33  ****************************************************************************/
34
35 /*
36  *      make_hash.c --- build-time program for constructing comp_captab.c
37  *
38  */
39
40 #include <build.priv.h>
41
42 #include <tic.h>
43 #include <hashsize.h>
44
45 #include <ctype.h>
46
47 MODULE_ID("$Id: make_hash.c,v 1.9 2012/11/18 01:30:03 tom Exp $")
48
49 /*
50  *      _nc_make_hash_table()
51  *
52  *      Takes the entries in table[] and hashes them into hash_table[]
53  *      by name.  There are CAPTABSIZE entries in table[] and HASHTABSIZE
54  *      slots in hash_table[].
55  *
56  */
57
58 #undef MODULE_ID
59 #define MODULE_ID(id)           /*nothing */
60 #include <tinfo/doalloc.c>
61
62 /*
63  *      int hash_function(string)
64  *
65  *      Computes the hashing function on the given string.
66  *
67  *      The current hash function is the sum of each consectutive pair
68  *      of characters, taken as two-byte integers, mod HASHTABSIZE.
69  *
70  */
71
72 static int
73 hash_function(const char *string)
74 {
75     long sum = 0;
76
77     while (*string) {
78         sum += (long) (*string + (*(string + 1) << 8));
79         string++;
80     }
81
82     return (int) (sum % HASHTABSIZE);
83 }
84
85 static void
86 _nc_make_hash_table(struct name_table_entry *table,
87                     HashValue * hash_table)
88 {
89     short i;
90     int hashvalue;
91     int collisions = 0;
92
93     for (i = 0; i < HASHTABSIZE; i++) {
94         hash_table[i] = -1;
95     }
96     for (i = 0; i < CAPTABSIZE; i++) {
97         hashvalue = hash_function(table[i].nte_name);
98
99         if (hash_table[hashvalue] >= 0)
100             collisions++;
101
102         if (hash_table[hashvalue] != 0)
103             table[i].nte_link = hash_table[hashvalue];
104         hash_table[hashvalue] = i;
105     }
106
107     printf("/* %d collisions out of %d entries */\n", collisions, CAPTABSIZE);
108 }
109
110 /*
111  * This filter reads from standard input a list of tab-delimited columns,
112  * (e.g., from Caps.filtered) computes the hash-value of a specified column and
113  * writes the hashed tables to standard output.
114  *
115  * By compiling the hash table at build time, we're able to make the entire
116  * set of terminfo and termcap tables readonly (and also provide some runtime
117  * performance enhancement).
118  */
119
120 #define MAX_COLUMNS BUFSIZ      /* this _has_ to be worst-case */
121
122 static int
123 count_columns(char **list)
124 {
125     int result = 0;
126     if (list != 0) {
127         while (*list++) {
128             ++result;
129         }
130     }
131     return result;
132 }
133
134 static char **
135 parse_columns(char *buffer)
136 {
137     static char **list;
138
139     int col = 0;
140
141     if (list == 0 && (list = typeCalloc(char *, MAX_COLUMNS)) == 0)
142           return (0);
143
144     if (*buffer != '#') {
145         while (*buffer != '\0') {
146             char *s;
147             for (s = buffer; (*s != '\0') && !isspace(UChar(*s)); s++)
148                 /*EMPTY */ ;
149             if (s != buffer) {
150                 char mark = *s;
151                 *s = '\0';
152                 if ((s - buffer) > 1
153                     && (*buffer == '"')
154                     && (s[-1] == '"')) {        /* strip the quotes */
155                     assert(s > buffer + 1);
156                     s[-1] = '\0';
157                     buffer++;
158                 }
159                 list[col] = buffer;
160                 col++;
161                 if (mark == '\0')
162                     break;
163                 while (*++s && isspace(UChar(*s)))
164                     /*EMPTY */ ;
165                 buffer = s;
166             } else
167                 break;
168         }
169     }
170     return col ? list : 0;
171 }
172
173 int
174 main(int argc, char **argv)
175 {
176     struct name_table_entry *name_table = typeCalloc(struct
177                                                      name_table_entry, CAPTABSIZE);
178     HashValue *hash_table = typeCalloc(HashValue, HASHTABSIZE);
179     const char *root_name = "";
180     int column = 0;
181     int bigstring = 0;
182     int n;
183     char buffer[BUFSIZ];
184
185     static const char *typenames[] =
186     {"BOOLEAN", "NUMBER", "STRING"};
187
188     short BoolCount = 0;
189     short NumCount = 0;
190     short StrCount = 0;
191
192     /* The first argument is the column-number (starting with 0).
193      * The second is the root name of the tables to generate.
194      */
195     if (argc <= 3
196         || (column = atoi(argv[1])) <= 0
197         || (column >= MAX_COLUMNS)
198         || *(root_name = argv[2]) == 0
199         || (bigstring = atoi(argv[3])) < 0
200         || name_table == 0
201         || hash_table == 0) {
202         fprintf(stderr, "usage: make_hash column root_name bigstring\n");
203         exit(EXIT_FAILURE);
204     }
205
206     /*
207      * Read the table into our arrays.
208      */
209     for (n = 0; (n < CAPTABSIZE) && fgets(buffer, BUFSIZ, stdin);) {
210         char **list, *nlp = strchr(buffer, '\n');
211         if (nlp)
212             *nlp = '\0';
213         list = parse_columns(buffer);
214         if (list == 0)          /* blank or comment */
215             continue;
216         if (column > count_columns(list)) {
217             fprintf(stderr, "expected %d columns, have %d:\n%s\n",
218                     column,
219                     count_columns(list),
220                     buffer);
221             exit(EXIT_FAILURE);
222         }
223         name_table[n].nte_link = -1;    /* end-of-hash */
224         name_table[n].nte_name = strdup(list[column]);
225         if (!strcmp(list[2], "bool")) {
226             name_table[n].nte_type = BOOLEAN;
227             name_table[n].nte_index = BoolCount++;
228         } else if (!strcmp(list[2], "num")) {
229             name_table[n].nte_type = NUMBER;
230             name_table[n].nte_index = NumCount++;
231         } else if (!strcmp(list[2], "str")) {
232             name_table[n].nte_type = STRING;
233             name_table[n].nte_index = StrCount++;
234         } else {
235             fprintf(stderr, "Unknown type: %s\n", list[2]);
236             exit(EXIT_FAILURE);
237         }
238         n++;
239     }
240     _nc_make_hash_table(name_table, hash_table);
241
242     /*
243      * Write the compiled tables to standard output
244      */
245     if (bigstring) {
246         int len = 0;
247         int nxt;
248
249         printf("static const char %s_names_text[] = \\\n", root_name);
250         for (n = 0; n < CAPTABSIZE; n++) {
251             nxt = (int) strlen(name_table[n].nte_name) + 5;
252             if (nxt + len > 72) {
253                 printf("\\\n");
254                 len = 0;
255             }
256             printf("\"%s\\0\" ", name_table[n].nte_name);
257             len += nxt;
258         }
259         printf(";\n\n");
260
261         len = 0;
262         printf("static name_table_data const %s_names_data[] =\n",
263                root_name);
264         printf("{\n");
265         for (n = 0; n < CAPTABSIZE; n++) {
266             printf("\t{ %15d,\t%10s,\t%3d, %3d }%c\n",
267                    len,
268                    typenames[name_table[n].nte_type],
269                    name_table[n].nte_index,
270                    name_table[n].nte_link,
271                    n < CAPTABSIZE - 1 ? ',' : ' ');
272             len += (int) strlen(name_table[n].nte_name) + 1;
273         }
274         printf("};\n\n");
275         printf("static struct name_table_entry *_nc_%s_table = 0;\n\n", root_name);
276     } else {
277
278         printf("static struct name_table_entry %s _nc_%s_table[] =\n",
279                bigstring ? "" : "const",
280                root_name);
281         printf("{\n");
282         for (n = 0; n < CAPTABSIZE; n++) {
283             _nc_SPRINTF(buffer, _nc_SLIMIT(sizeof(buffer)) "\"%s\"",
284                         name_table[n].nte_name);
285             printf("\t{ %15s,\t%10s,\t%3d, %3d }%c\n",
286                    buffer,
287                    typenames[name_table[n].nte_type],
288                    name_table[n].nte_index,
289                    name_table[n].nte_link,
290                    n < CAPTABSIZE - 1 ? ',' : ' ');
291         }
292         printf("};\n\n");
293     }
294
295     printf("static const HashValue _nc_%s_hash_table[%d] =\n",
296            root_name,
297            HASHTABSIZE + 1);
298     printf("{\n");
299     for (n = 0; n < HASHTABSIZE; n++) {
300         printf("\t%3d,\n", hash_table[n]);
301     }
302     printf("\t0\t/* base-of-table */\n");
303     printf("};\n\n");
304
305     printf("#if (BOOLCOUNT!=%d)||(NUMCOUNT!=%d)||(STRCOUNT!=%d)\n",
306            BoolCount, NumCount, StrCount);
307     printf("#error\t--> term.h and comp_captab.c disagree about the <--\n");
308     printf("#error\t--> numbers of booleans, numbers and/or strings <--\n");
309     printf("#endif\n\n");
310
311     free(hash_table);
312     return EXIT_SUCCESS;
313 }