1 /****************************************************************************
2 * Copyright (c) 1998-2012,2013 Free Software Foundation, Inc. *
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: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
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. *
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 *
27 ****************************************************************************/
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 ****************************************************************************/
36 * read_entry.c -- Routine for reading in a compiled terminfo file
39 #include <curses.priv.h>
40 #include <hashed_db.h>
44 MODULE_ID("$Id: read_entry.c,v 1.126 2013/12/15 00:35:36 tom Exp $")
46 #define TYPE_CALLOC(type,elts) typeCalloc(type, (unsigned)(elts))
48 #if NCURSES_USE_DATABASE
50 convert_shorts(char *buf, short *Numbers, int count)
53 for (i = 0; i < count; i++) {
54 if (IS_NEG1(buf + 2 * i))
55 Numbers[i] = ABSENT_NUMERIC;
56 else if (IS_NEG2(buf + 2 * i))
57 Numbers[i] = CANCELLED_NUMERIC;
59 Numbers[i] = (short) LOW_MSB(buf + 2 * i);
60 TR(TRACE_DATABASE, ("get Numbers[%d]=%d", i, Numbers[i]));
65 convert_strings(char *buf, char **Strings, int count, int size, char *table)
70 for (i = 0; i < count; i++) {
71 if (IS_NEG1(buf + 2 * i)) {
72 Strings[i] = ABSENT_STRING;
73 } else if (IS_NEG2(buf + 2 * i)) {
74 Strings[i] = CANCELLED_STRING;
75 } else if ((int) LOW_MSB(buf + 2 * i) > size) {
76 Strings[i] = ABSENT_STRING;
78 Strings[i] = (LOW_MSB(buf + 2 * i) + table);
79 TR(TRACE_DATABASE, ("Strings[%d] = %s", i, _nc_visbuf(Strings[i])));
82 /* make sure all strings are NUL terminated */
83 if (VALID_STRING(Strings[i])) {
84 for (p = Strings[i]; p <= table + size; p++)
87 /* if there is no NUL, ignore the string */
89 Strings[i] = ABSENT_STRING;
95 fake_read(char *src, int *offset, int limit, char *dst, unsigned want)
97 int have = (limit - *offset);
100 if ((int) want > have)
101 want = (unsigned) have;
102 memcpy(dst, src + *offset, (size_t) want);
103 *offset += (int) want;
110 #define Read(buf, count) fake_read(buffer, &offset, limit, (char *) buf, (unsigned) count)
112 #define read_shorts(buf, count) \
113 (Read(buf, (count)*2) == (int) (count)*2)
115 #define even_boundary(value) \
116 if ((value) % 2 != 0) Read(buf, 1)
120 _nc_init_termtype(TERMTYPE *const tp)
125 tp->num_Booleans = BOOLCOUNT;
126 tp->num_Numbers = NUMCOUNT;
127 tp->num_Strings = STRCOUNT;
128 tp->ext_Booleans = 0;
132 if (tp->Booleans == 0)
133 TYPE_MALLOC(NCURSES_SBOOL, BOOLCOUNT, tp->Booleans);
134 if (tp->Numbers == 0)
135 TYPE_MALLOC(short, NUMCOUNT, tp->Numbers);
136 if (tp->Strings == 0)
137 TYPE_MALLOC(char *, STRCOUNT, tp->Strings);
139 for_each_boolean(i, tp)
140 tp->Booleans[i] = FALSE;
142 for_each_number(i, tp)
143 tp->Numbers[i] = ABSENT_NUMERIC;
145 for_each_string(i, tp)
146 tp->Strings[i] = ABSENT_STRING;
149 #if NCURSES_USE_DATABASE
151 * Return TGETENT_YES if read, TGETENT_NO if not found or garbled.
154 _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
157 int name_size, bool_count, num_count, str_count, str_size;
159 char buf[MAX_ENTRY_SIZE + 2];
163 TR(TRACE_DATABASE, ("READ termtype header @%d", offset));
165 memset(ptr, 0, sizeof(*ptr));
167 /* grab the header */
168 if (!read_shorts(buf, 6)
169 || !IS_TIC_MAGIC(buf)) {
173 name_size = LOW_MSB(buf + 2);
174 bool_count = LOW_MSB(buf + 4);
175 num_count = LOW_MSB(buf + 6);
176 str_count = LOW_MSB(buf + 8);
177 str_size = LOW_MSB(buf + 10);
180 ("TERMTYPE name_size=%d, bool=%d/%d, num=%d/%d str=%d/%d(%d)",
181 name_size, bool_count, BOOLCOUNT, num_count, NUMCOUNT,
182 str_count, STRCOUNT, str_size));
191 want = (unsigned) (str_size + name_size + 1);
193 /* try to allocate space for the string table */
194 if (str_count * 2 >= MAX_ENTRY_SIZE
195 || (string_table = typeMalloc(char, want)) == 0) {
200 if ((string_table = typeMalloc(char, want)) == 0) {
205 /* grab the name (a null-terminated string) */
206 want = min(MAX_NAME_SIZE, (unsigned) name_size);
207 ptr->str_table = string_table;
208 ptr->term_names = string_table;
209 if ((have = (unsigned) Read(ptr->term_names, want)) != want) {
210 memset(ptr->term_names + have, 0, (size_t) (want - have));
212 ptr->term_names[want] = '\0';
213 string_table += (want + 1);
215 if (have > MAX_NAME_SIZE)
216 offset = (int) (have - MAX_NAME_SIZE);
218 /* grab the booleans */
219 if ((ptr->Booleans = TYPE_CALLOC(NCURSES_SBOOL,
220 max(BOOLCOUNT, bool_count))) == 0
221 || Read(ptr->Booleans, (unsigned) bool_count) < bool_count) {
226 * If booleans end on an odd byte, skip it. The machine they
227 * originally wrote terminfo on must have been a 16-bit
228 * word-oriented machine that would trap out if you tried a
229 * word access off a 2-byte boundary.
231 even_boundary(name_size + bool_count);
233 /* grab the numbers */
234 if ((ptr->Numbers = TYPE_CALLOC(short, max(NUMCOUNT, num_count))) == 0
235 || !read_shorts(buf, num_count)) {
238 convert_shorts(buf, ptr->Numbers, num_count);
240 if ((ptr->Strings = TYPE_CALLOC(char *, max(STRCOUNT, str_count))) == 0)
244 /* grab the string offsets */
245 if (!read_shorts(buf, str_count)) {
248 /* finally, grab the string table itself */
249 if (Read(string_table, (unsigned) str_size) != str_size)
251 convert_strings(buf, ptr->Strings, str_count, str_size, string_table);
255 ptr->num_Booleans = BOOLCOUNT;
256 ptr->num_Numbers = NUMCOUNT;
257 ptr->num_Strings = STRCOUNT;
260 * Read extended entries, if any, after the normal end of terminfo data.
262 even_boundary(str_size);
263 TR(TRACE_DATABASE, ("READ extended_header @%d", offset));
264 if (_nc_user_definable && read_shorts(buf, 5)) {
265 int ext_bool_count = LOW_MSB(buf + 0);
266 int ext_num_count = LOW_MSB(buf + 2);
267 int ext_str_count = LOW_MSB(buf + 4);
268 int ext_str_size = LOW_MSB(buf + 6);
269 int ext_str_limit = LOW_MSB(buf + 8);
270 unsigned need = (unsigned) (ext_bool_count + ext_num_count + ext_str_count);
273 if (need >= (MAX_ENTRY_SIZE / 2)
274 || ext_str_size >= MAX_ENTRY_SIZE
275 || ext_str_limit >= MAX_ENTRY_SIZE
276 || ext_bool_count < 0
280 || ext_str_limit < 0)
283 ptr->num_Booleans = UShort(BOOLCOUNT + ext_bool_count);
284 ptr->num_Numbers = UShort(NUMCOUNT + ext_num_count);
285 ptr->num_Strings = UShort(STRCOUNT + ext_str_count);
287 TYPE_REALLOC(NCURSES_SBOOL, ptr->num_Booleans, ptr->Booleans);
288 TYPE_REALLOC(short, ptr->num_Numbers, ptr->Numbers);
289 TYPE_REALLOC(char *, ptr->num_Strings, ptr->Strings);
291 TR(TRACE_DATABASE, ("extended header is %d/%d/%d(%d:%d)",
292 ext_bool_count, ext_num_count, ext_str_count,
293 ext_str_size, ext_str_limit));
295 TR(TRACE_DATABASE, ("READ %d extended-booleans @%d",
296 ext_bool_count, offset));
297 if ((ptr->ext_Booleans = UShort(ext_bool_count)) != 0) {
298 if (Read(ptr->Booleans + BOOLCOUNT, (unsigned)
299 ext_bool_count) != ext_bool_count)
302 even_boundary(ext_bool_count);
304 TR(TRACE_DATABASE, ("READ %d extended-numbers @%d",
305 ext_num_count, offset));
306 if ((ptr->ext_Numbers = UShort(ext_num_count)) != 0) {
307 if (!read_shorts(buf, ext_num_count))
309 TR(TRACE_DATABASE, ("Before converting extended-numbers"));
310 convert_shorts(buf, ptr->Numbers + NUMCOUNT, ext_num_count);
313 TR(TRACE_DATABASE, ("READ extended-offsets @%d", offset));
314 if ((unsigned) (ext_str_count + (int) need) >= (MAX_ENTRY_SIZE / 2))
316 if ((ext_str_count || need)
317 && !read_shorts(buf, ext_str_count + (int) need))
320 TR(TRACE_DATABASE, ("READ %d bytes of extended-strings @%d",
321 ext_str_limit, offset));
324 ptr->ext_str_table = typeMalloc(char, (size_t) ext_str_limit);
325 if (ptr->ext_str_table == 0)
327 if (Read(ptr->ext_str_table, (unsigned) ext_str_limit) != ext_str_limit)
329 TR(TRACE_DATABASE, ("first extended-string is %s", _nc_visbuf(ptr->ext_str_table)));
332 if ((ptr->ext_Strings = UShort(ext_str_count)) != 0) {
334 ("Before computing extended-string capabilities str_count=%d, ext_str_count=%d",
335 str_count, ext_str_count));
336 convert_strings(buf, ptr->Strings + str_count, ext_str_count,
337 ext_str_limit, ptr->ext_str_table);
338 for (i = ext_str_count - 1; i >= 0; i--) {
339 TR(TRACE_DATABASE, ("MOVE from [%d:%d] %s",
341 _nc_visbuf(ptr->Strings[i + str_count])));
342 ptr->Strings[i + STRCOUNT] = ptr->Strings[i + str_count];
343 if (VALID_STRING(ptr->Strings[i + STRCOUNT]))
344 base += (int) (strlen(ptr->Strings[i + STRCOUNT]) + 1);
345 TR(TRACE_DATABASE, ("... to [%d] %s",
347 _nc_visbuf(ptr->Strings[i + STRCOUNT])));
352 if (ext_str_count >= (MAX_ENTRY_SIZE / 2))
354 if ((ptr->ext_Names = TYPE_CALLOC(char *, need)) == 0)
357 ("ext_NAMES starting @%d in extended_strings, first = %s",
358 base, _nc_visbuf(ptr->ext_str_table + base)));
359 convert_strings(buf + (2 * ext_str_count),
362 ext_str_limit, ptr->ext_str_table + base);
366 ("...done reading terminfo bool %d(%d) num %d(%d) str %d(%d)",
367 ptr->num_Booleans, ptr->ext_Booleans,
368 ptr->num_Numbers, ptr->ext_Numbers,
369 ptr->num_Strings, ptr->ext_Strings));
371 TR(TRACE_DATABASE, ("extend: num_Booleans:%d", ptr->num_Booleans));
373 #endif /* NCURSES_XNAMES */
375 TR(TRACE_DATABASE, ("...done reading terminfo bool %d num %d str %d",
376 bool_count, num_count, str_count));
378 TR(TRACE_DATABASE, ("normal: num_Booleans:%d", ptr->num_Booleans));
382 for (i = bool_count; i < BOOLCOUNT; i++)
383 ptr->Booleans[i] = FALSE;
384 for (i = num_count; i < NUMCOUNT; i++)
385 ptr->Numbers[i] = ABSENT_NUMERIC;
386 for (i = str_count; i < STRCOUNT; i++)
387 ptr->Strings[i] = ABSENT_STRING;
389 return (TGETENT_YES);
394 * _nc_read_file_entry(filename, ptr)
396 * Read the compiled terminfo entry in the given file into the
397 * structure pointed to by ptr, allocating space for the string
401 _nc_read_file_entry(const char *const filename, TERMTYPE *ptr)
402 /* return 1 if read, 0 if not found or garbled */
407 char buffer[MAX_ENTRY_SIZE + 1];
409 if (_nc_access(filename, R_OK) < 0
410 || (fp = fopen(filename, "rb")) == 0) {
411 TR(TRACE_DATABASE, ("cannot open terminfo %s (errno=%d)", filename, errno));
414 if ((limit = (int) fread(buffer, sizeof(char), sizeof(buffer), fp))
417 TR(TRACE_DATABASE, ("read terminfo %s", filename));
418 if ((code = _nc_read_termtype(ptr, buffer, limit)) == TGETENT_NO) {
419 _nc_free_termtype(ptr);
432 * Return if if we can build the filename of a ".db" file.
435 make_db_filename(char *filename, unsigned limit, const char *const path)
437 static const char suffix[] = DBM_SUFFIX;
439 size_t lens = sizeof(suffix) - 1;
440 size_t size = strlen(path);
441 size_t test = lens + size;
446 && !strcmp(path + size - lens, suffix))
447 _nc_STRCPY(filename, path, limit);
449 _nc_SPRINTF(filename, _nc_SLIMIT(limit) "%s%s", path, suffix);
457 * Return true if we can build the name of a filesystem entry.
460 make_dir_filename(char *filename,
462 const char *const path,
467 #if NCURSES_USE_TERMCAP
468 if (_nc_is_dir_path(path))
471 unsigned need = (unsigned) (LEAF_LEN + 3 + strlen(path) + strlen(name));
474 _nc_SPRINTF(filename, _nc_SLIMIT(limit)
475 "%s/" LEAF_FMT "/%s", path, *name, name);
483 * Build a terminfo pathname and try to read the data. Returns TGETENT_YES on
484 * success, TGETENT_NO on failure.
487 _nc_read_tic_entry(char *filename,
489 const char *const path,
493 int code = TGETENT_NO;
498 if (make_db_filename(filename, limit, path)
499 && (capdbp = _nc_db_open(filename, FALSE)) != 0) {
503 char *save = strdup(name);
505 memset(&key, 0, sizeof(key));
507 key.size = strlen(save);
510 * This lookup could return termcap data, which we do not want. We are
511 * looking for compiled (binary) terminfo data.
513 * cgetent uses a two-level lookup. On the first it uses the given
514 * name to return a record containing only the aliases for an entry.
515 * On the second (using that list of aliases as a key), it returns the
516 * content of the terminal description. We expect second lookup to
517 * return data beginning with the same set of aliases.
519 * For compiled terminfo, the list of aliases in the second case will
520 * be null-terminated. A termcap entry will not be, and will run on
521 * into the description. So we can easily distinguish between the two
522 * (source/binary) by checking the lengths.
524 while (_nc_db_get(capdbp, &key, &data) == 0) {
525 int used = (int) data.size - 1;
526 char *have = (char *) data.data;
529 if (data.size > key.size
530 && IS_TIC_MAGIC(have)) {
531 code = _nc_read_termtype(tp, have, used);
532 if (code == TGETENT_NO) {
533 _nc_free_termtype(tp);
540 * Just in case we have a corrupt database, do not waste time with
547 * Prepare for the second level.
554 } else /* may be either filesystem or flat file */
556 if (make_dir_filename(filename, limit, path, name)) {
557 code = _nc_read_file_entry(filename, tp);
559 #if NCURSES_USE_TERMCAP
560 else if (code != TGETENT_YES) {
561 code = _nc_read_termcap_entry(name, tp);
562 _nc_SPRINTF(filename, _nc_SLIMIT(PATH_MAX)
563 "%.*s", PATH_MAX - 1, _nc_get_source());
568 #endif /* NCURSES_USE_DATABASE */
571 * _nc_read_entry(char *name, char *filename, TERMTYPE *tp)
573 * Find and read the compiled entry for a given terminal type,
574 * if it exists. We take pains here to make sure no combination
575 * of environment variables and terminal type name can be used to
576 * overrun the file buffer.
580 _nc_read_entry(const char *const name, char *const filename, TERMTYPE *const tp)
582 int code = TGETENT_NO;
584 _nc_SPRINTF(filename, _nc_SLIMIT(PATH_MAX)
585 "%.*s", PATH_MAX - 1, name);
587 if (strlen(name) == 0
588 || strcmp(name, ".") == 0
589 || strcmp(name, "..") == 0
590 || _nc_pathlast(name) != 0
591 || strchr(name, NCURSES_PATHSEP) != 0) {
592 TR(TRACE_DATABASE, ("illegal or missing entry name '%s'", name));
594 #if NCURSES_USE_DATABASE
599 _nc_first_db(&state, &offset);
600 while ((path = _nc_next_db(&state, &offset)) != 0) {
601 TR(TRACE_DATABASE, ("_nc_read_tic_entry path=%s, name=%s", path, name));
602 code = _nc_read_tic_entry(filename, PATH_MAX, path, name, tp);
603 if (code == TGETENT_YES) {
608 #elif NCURSES_USE_TERMCAP
609 if (code != TGETENT_YES) {
610 code = _nc_read_termcap_entry(name, tp);
611 _nc_SPRINTF(filename, _nc_SLIMIT(PATH_MAX)
612 "%.*s", PATH_MAX - 1, _nc_get_source());