ncurses 6.2 - patch 20210619
[ncurses.git] / ncurses / tinfo / alloc_ttype.c
1 /****************************************************************************
2  * Copyright 2018-2020,2021 Thomas E. Dickey                                *
3  * Copyright 1999-2016,2017 Free Software Foundation, Inc.                  *
4  *                                                                          *
5  * Permission is hereby granted, free of charge, to any person obtaining a  *
6  * copy of this software and associated documentation files (the            *
7  * "Software"), to deal in the Software without restriction, including      *
8  * without limitation the rights to use, copy, modify, merge, publish,      *
9  * distribute, distribute with modifications, sublicense, and/or sell       *
10  * copies of the Software, and to permit persons to whom the Software is    *
11  * furnished to do so, subject to the following conditions:                 *
12  *                                                                          *
13  * The above copyright notice and this permission notice shall be included  *
14  * in all copies or substantial portions of the Software.                   *
15  *                                                                          *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23  *                                                                          *
24  * Except as contained in this notice, the name(s) of the above copyright   *
25  * holders shall not be used in advertising or otherwise to promote the     *
26  * sale, use or other dealings in this Software without prior written       *
27  * authorization.                                                           *
28  ****************************************************************************/
29
30 /****************************************************************************
31  *  Author: Thomas E. Dickey <dickey@clark.net> 1999-on                     *
32  ****************************************************************************/
33
34 /*
35  * align_ttype.c --  functions for TERMTYPE
36  *
37  *      _nc_align_termtype()
38  *      _nc_copy_termtype()
39  *
40  */
41
42 #include <curses.priv.h>
43
44 #include <tic.h>
45
46 MODULE_ID("$Id: alloc_ttype.c,v 1.35 2021/06/17 21:11:08 tom Exp $")
47
48 #if NCURSES_XNAMES
49 /*
50  * Merge the a/b lists into dst.  Both a/b are sorted (see _nc_extend_names()),
51  * so we do not have to worry about order dependencies.
52  */
53 static int
54 merge_names(char **dst, char **a, int na, char **b, int nb)
55 {
56     int n = 0;
57     while (na > 0 && nb > 0) {
58         int cmp = strcmp(*a, *b);
59         if (cmp < 0) {
60             dst[n++] = *a++;
61             na--;
62         } else if (cmp > 0) {
63             dst[n++] = *b++;
64             nb--;
65         } else {
66             dst[n++] = *a;
67             a++, b++;
68             na--, nb--;
69         }
70     }
71     while (na-- > 0) {
72         dst[n++] = *a++;
73     }
74     while (nb-- > 0) {
75         dst[n++] = *b++;
76     }
77     DEBUG(4, ("merge_names -> %d", n));
78     return n;
79 }
80
81 static bool
82 find_name(char **table, int item, int length, const char *name)
83 {
84     int n;
85     int result = -1;
86
87     for (n = item; n < length; ++n) {
88         if (!strcmp(table[n], name)) {
89             DEBUG(4, ("found name '%s' @%d", name, n));
90             result = n;
91             break;
92         }
93     }
94     if (result < 0) {
95         DEBUG(4, ("did not find name '%s'", name));
96     }
97     return (result >= 0);
98 }
99
100 #define EXTEND_NUM(num, ext) \
101         DEBUG(4, ("extending " #num " from %d to %d", \
102          to->num, (unsigned short) (to->num + (ext - to->ext)))); \
103         to->num = (unsigned short) (to->num + (ext - to->ext))
104
105 static void
106 realign_data(TERMTYPE2 *to, char **ext_Names,
107              int ext_Booleans,
108              int ext_Numbers,
109              int ext_Strings)
110 {
111     int n, m, base;
112     int to_Booleans = to->ext_Booleans;
113     int to_Numbers = to->ext_Numbers;
114     int to_Strings = to->ext_Strings;
115     int to1, to2, from;
116
117     DEBUG(4, ("realign_data %d/%d/%d vs %d/%d/%d",
118               ext_Booleans,
119               ext_Numbers,
120               ext_Strings,
121               to->ext_Booleans,
122               to->ext_Numbers,
123               to->ext_Strings));
124
125     if (to->ext_Booleans != ext_Booleans) {
126         to1 = 0;
127         to2 = to_Booleans + to1;
128         from = 0;
129         EXTEND_NUM(num_Booleans, ext_Booleans);
130         TYPE_REALLOC(NCURSES_SBOOL, to->num_Booleans, to->Booleans);
131         for (n = to->ext_Booleans - 1,
132              m = ext_Booleans - 1,
133              base = to->num_Booleans - (m + 1); m >= 0; m--) {
134             if (find_name(to->ext_Names, to1, to2, ext_Names[m + from])) {
135                 to->Booleans[base + m] = to->Booleans[base + n--];
136             } else {
137                 to->Booleans[base + m] = FALSE;
138             }
139         }
140         to->ext_Booleans = UShort(ext_Booleans);
141     }
142
143     if (to->ext_Numbers != ext_Numbers) {
144         to1 = to_Booleans;
145         to2 = to_Numbers + to1;
146         from = ext_Booleans;
147         EXTEND_NUM(num_Numbers, ext_Numbers);
148         TYPE_REALLOC(NCURSES_INT2, to->num_Numbers, to->Numbers);
149         for (n = to->ext_Numbers - 1,
150              m = ext_Numbers - 1,
151              base = to->num_Numbers - (m + 1); m >= 0; m--) {
152             if (find_name(to->ext_Names, to1, to2, ext_Names[m + from])) {
153                 to->Numbers[base + m] = to->Numbers[base + n--];
154             } else {
155                 to->Numbers[base + m] = ABSENT_NUMERIC;
156             }
157         }
158         to->ext_Numbers = UShort(ext_Numbers);
159     }
160
161     if (to->ext_Strings != ext_Strings) {
162         to1 = to_Booleans + to_Numbers;
163         to2 = to_Strings + to1;
164         from = ext_Booleans + ext_Numbers;
165         EXTEND_NUM(num_Strings, ext_Strings);
166         TYPE_REALLOC(char *, to->num_Strings, to->Strings);
167         for (n = to->ext_Strings - 1,
168              m = ext_Strings - 1,
169              base = to->num_Strings - (m + 1); m >= 0; m--) {
170             if (find_name(to->ext_Names, to1, to2, ext_Names[m + from])) {
171                 to->Strings[base + m] = to->Strings[base + n--];
172             } else {
173                 to->Strings[base + m] = ABSENT_STRING;
174             }
175         }
176         to->ext_Strings = UShort(ext_Strings);
177     }
178 }
179
180 /*
181  * Returns the first index in ext_Names[] for the given token-type
182  */
183 static unsigned
184 _nc_first_ext_name(TERMTYPE2 *tp, int token_type)
185 {
186     unsigned first;
187
188     switch (token_type) {
189     case BOOLEAN:
190         first = 0;
191         break;
192     case NUMBER:
193         first = tp->ext_Booleans;
194         break;
195     case STRING:
196         first = (unsigned) (tp->ext_Booleans + tp->ext_Numbers);
197         break;
198     default:
199         first = 0;
200         break;
201     }
202     return first;
203 }
204
205 /*
206  * Returns the last index in ext_Names[] for the given token-type
207  */
208 static unsigned
209 _nc_last_ext_name(TERMTYPE2 *tp, int token_type)
210 {
211     unsigned last;
212
213     switch (token_type) {
214     case BOOLEAN:
215         last = tp->ext_Booleans;
216         break;
217     case NUMBER:
218         last = (unsigned) (tp->ext_Booleans + tp->ext_Numbers);
219         break;
220     default:
221     case STRING:
222         last = NUM_EXT_NAMES(tp);
223         break;
224     }
225     return last;
226 }
227
228 /*
229  * Lookup an entry from extended-names, returning -1 if not found
230  */
231 static int
232 _nc_find_ext_name(TERMTYPE2 *tp, char *name, int token_type)
233 {
234     unsigned j;
235     unsigned first = _nc_first_ext_name(tp, token_type);
236     unsigned last = _nc_last_ext_name(tp, token_type);
237
238     for (j = first; j < last; j++) {
239         if (!strcmp(name, tp->ext_Names[j])) {
240             return (int) j;
241         }
242     }
243     return -1;
244 }
245
246 /*
247  * Translate an index into ext_Names[] into the corresponding index into data
248  * (e.g., Booleans[]).
249  */
250 static int
251 _nc_ext_data_index(TERMTYPE2 *tp, int n, int token_type)
252 {
253     switch (token_type) {
254     case BOOLEAN:
255         n += (tp->num_Booleans - tp->ext_Booleans);
256         break;
257     case NUMBER:
258         n += (tp->num_Numbers - tp->ext_Numbers)
259             - (tp->ext_Booleans);
260         break;
261     default:
262     case STRING:
263         n += (tp->num_Strings - tp->ext_Strings)
264             - (tp->ext_Booleans + tp->ext_Numbers);
265     }
266     return n;
267 }
268
269 /*
270  * Adjust tables to remove (not free) an extended name and its corresponding
271  * data.
272  */
273 static bool
274 _nc_del_ext_name(TERMTYPE2 *tp, char *name, int token_type)
275 {
276     int first;
277
278     if ((first = _nc_find_ext_name(tp, name, token_type)) >= 0) {
279         int j;
280         int last = (int) NUM_EXT_NAMES(tp) - 1;
281
282         for (j = first; j < last; j++) {
283             tp->ext_Names[j] = tp->ext_Names[j + 1];
284         }
285         first = _nc_ext_data_index(tp, first, token_type);
286         switch (token_type) {
287         case BOOLEAN:
288             last = tp->num_Booleans - 1;
289             for (j = first; j < last; j++)
290                 tp->Booleans[j] = tp->Booleans[j + 1];
291             tp->ext_Booleans--;
292             tp->num_Booleans--;
293             break;
294         case NUMBER:
295             last = tp->num_Numbers - 1;
296             for (j = first; j < last; j++)
297                 tp->Numbers[j] = tp->Numbers[j + 1];
298             tp->ext_Numbers--;
299             tp->num_Numbers--;
300             break;
301         case STRING:
302             last = tp->num_Strings - 1;
303             for (j = first; j < last; j++)
304                 tp->Strings[j] = tp->Strings[j + 1];
305             tp->ext_Strings--;
306             tp->num_Strings--;
307             break;
308         }
309         return TRUE;
310     }
311     return FALSE;
312 }
313
314 /*
315  * Adjust tables to insert an extended name, making room for new data.  The
316  * index into the corresponding data array is returned.
317  */
318 static int
319 _nc_ins_ext_name(TERMTYPE2 *tp, char *name, int token_type)
320 {
321     unsigned first = _nc_first_ext_name(tp, token_type);
322     unsigned last = _nc_last_ext_name(tp, token_type);
323     unsigned total = NUM_EXT_NAMES(tp) + 1;
324     unsigned j, k;
325
326     for (j = first; j < last; j++) {
327         int cmp = strcmp(name, tp->ext_Names[j]);
328         if (cmp == 0)
329             /* already present */
330             return _nc_ext_data_index(tp, (int) j, token_type);
331         if (cmp < 0) {
332             break;
333         }
334     }
335
336     TYPE_REALLOC(char *, total, tp->ext_Names);
337     for (k = total - 1; k > j; k--)
338         tp->ext_Names[k] = tp->ext_Names[k - 1];
339     tp->ext_Names[j] = name;
340     j = (unsigned) _nc_ext_data_index(tp, (int) j, token_type);
341
342     switch (token_type) {
343     case BOOLEAN:
344         tp->ext_Booleans++;
345         tp->num_Booleans++;
346         TYPE_REALLOC(NCURSES_SBOOL, tp->num_Booleans, tp->Booleans);
347         for (k = (unsigned) (tp->num_Booleans - 1); k > j; k--)
348             tp->Booleans[k] = tp->Booleans[k - 1];
349         break;
350     case NUMBER:
351         tp->ext_Numbers++;
352         tp->num_Numbers++;
353         TYPE_REALLOC(NCURSES_INT2, tp->num_Numbers, tp->Numbers);
354         for (k = (unsigned) (tp->num_Numbers - 1); k > j; k--)
355             tp->Numbers[k] = tp->Numbers[k - 1];
356         break;
357     case STRING:
358         tp->ext_Strings++;
359         tp->num_Strings++;
360         TYPE_REALLOC(char *, tp->num_Strings, tp->Strings);
361         for (k = (unsigned) (tp->num_Strings - 1); k > j; k--)
362             tp->Strings[k] = tp->Strings[k - 1];
363         break;
364     }
365     return (int) j;
366 }
367
368 /*
369  * Look for strings that are marked cancelled, which happen to be the same name
370  * as a boolean or number.  We'll get this as a special case when we get a
371  * cancellation of a name that is inherited from another entry.
372  */
373 static void
374 adjust_cancels(TERMTYPE2 *to, TERMTYPE2 *from)
375 {
376     int first = to->ext_Booleans + to->ext_Numbers;
377     int last = first + to->ext_Strings;
378     int j, k;
379
380     for (j = first; j < last;) {
381         char *name = to->ext_Names[j];
382         int j_str = to->num_Strings - first - to->ext_Strings;
383
384         if (to->Strings[j + j_str] == CANCELLED_STRING) {
385             if (_nc_find_ext_name(from, to->ext_Names[j], BOOLEAN) >= 0) {
386                 if (_nc_del_ext_name(to, name, STRING)
387                     || _nc_del_ext_name(to, name, NUMBER)) {
388                     k = _nc_ins_ext_name(to, name, BOOLEAN);
389                     to->Booleans[k] = FALSE;
390                 } else {
391                     j++;
392                 }
393             } else if (_nc_find_ext_name(from, to->ext_Names[j], NUMBER) >= 0) {
394                 if (_nc_del_ext_name(to, name, STRING)
395                     || _nc_del_ext_name(to, name, BOOLEAN)) {
396                     k = _nc_ins_ext_name(to, name, NUMBER);
397                     to->Numbers[k] = CANCELLED_NUMERIC;
398                 } else {
399                     j++;
400                 }
401             } else if (_nc_find_ext_name(from, to->ext_Names[j], STRING) >= 0) {
402                 if (_nc_del_ext_name(to, name, NUMBER)
403                     || _nc_del_ext_name(to, name, BOOLEAN)) {
404                     k = _nc_ins_ext_name(to, name, STRING);
405                     to->Strings[k] = CANCELLED_STRING;
406                 } else {
407                     j++;
408                 }
409             } else {
410                 j++;
411             }
412         } else {
413             j++;
414         }
415     }
416 }
417
418 NCURSES_EXPORT(void)
419 _nc_align_termtype(TERMTYPE2 *to, TERMTYPE2 *from)
420 {
421     int na;
422     int nb;
423     char **ext_Names;
424
425     na = to ? ((int) NUM_EXT_NAMES(to)) : 0;
426     nb = from ? ((int) NUM_EXT_NAMES(from)) : 0;
427
428     DEBUG(2, ("align_termtype to(%d:%s), from(%d:%s)",
429               na, to ? NonNull(to->term_names) : "?",
430               nb, from ? NonNull(from->term_names) : "?"));
431
432     if (to != NULL && from != NULL && (na != 0 || nb != 0)) {
433         int ext_Booleans, ext_Numbers, ext_Strings;
434         bool used_ext_Names = FALSE;
435
436         if ((na == nb)          /* check if the arrays are equivalent */
437             &&(to->ext_Booleans == from->ext_Booleans)
438             && (to->ext_Numbers == from->ext_Numbers)
439             && (to->ext_Strings == from->ext_Strings)) {
440             int n;
441             bool same;
442
443             for (n = 0, same = TRUE; n < na; n++) {
444                 if (strcmp(to->ext_Names[n], from->ext_Names[n])) {
445                     same = FALSE;
446                     break;
447                 }
448             }
449             if (same)
450                 return;
451         }
452         /*
453          * This is where we pay for having a simple extension representation.
454          * Allocate a new ext_Names array and merge the two ext_Names arrays
455          * into it, updating to's counts for booleans, etc.  Fortunately we do
456          * this only for the terminfo compiler (tic) and comparer (infocmp).
457          */
458         TYPE_MALLOC(char *, (size_t)(na + nb), ext_Names);
459
460         if (to->ext_Strings && (from->ext_Booleans + from->ext_Numbers))
461             adjust_cancels(to, from);
462
463         if (from->ext_Strings && (to->ext_Booleans + to->ext_Numbers))
464             adjust_cancels(from, to);
465
466         ext_Booleans = merge_names(ext_Names,
467                                    to->ext_Names,
468                                    to->ext_Booleans,
469                                    from->ext_Names,
470                                    from->ext_Booleans);
471         ext_Numbers = merge_names(ext_Names + ext_Booleans,
472                                   to->ext_Names
473                                   + to->ext_Booleans,
474                                   to->ext_Numbers,
475                                   from->ext_Names
476                                   + from->ext_Booleans,
477                                   from->ext_Numbers);
478         ext_Strings = merge_names(ext_Names + ext_Numbers + ext_Booleans,
479                                   to->ext_Names
480                                   + to->ext_Booleans
481                                   + to->ext_Numbers,
482                                   to->ext_Strings,
483                                   from->ext_Names
484                                   + from->ext_Booleans
485                                   + from->ext_Numbers,
486                                   from->ext_Strings);
487         /*
488          * Now we must reallocate the Booleans, etc., to allow the data to be
489          * overlaid.
490          */
491         if (na != (ext_Booleans + ext_Numbers + ext_Strings)) {
492             realign_data(to, ext_Names, ext_Booleans, ext_Numbers, ext_Strings);
493             FreeIfNeeded(to->ext_Names);
494             to->ext_Names = ext_Names;
495             DEBUG(2, ("realigned %d extended names for '%s' (to)",
496                       NUM_EXT_NAMES(to), to->term_names));
497             used_ext_Names = TRUE;
498         }
499         if (nb != (ext_Booleans + ext_Numbers + ext_Strings)) {
500             nb = (ext_Booleans + ext_Numbers + ext_Strings);
501             realign_data(from, ext_Names, ext_Booleans, ext_Numbers, ext_Strings);
502             TYPE_REALLOC(char *, (size_t) nb, from->ext_Names);
503             memcpy(from->ext_Names, ext_Names, sizeof(char *) * (size_t) nb);
504             DEBUG(2, ("realigned %d extended names for '%s' (from)",
505                       NUM_EXT_NAMES(from), from->term_names));
506         }
507         if (!used_ext_Names)
508             free(ext_Names);
509     }
510 }
511 #endif
512
513 #define srcINT 1
514 #define dstINT 2
515
516 /*
517  * TERMTYPE and TERMTYPE2 differ only with regard to the values in Numbers.
518  * Use 'mode' to decide which to use.
519  */
520 static void
521 copy_termtype(TERMTYPE2 *dst, const TERMTYPE2 *src, int mode)
522 {
523 #if NCURSES_XNAMES || NCURSES_EXT_NUMBERS
524     unsigned i;
525 #endif
526 #if NCURSES_EXT_NUMBERS
527     short *oldptr = 0;
528     int *newptr = 0;
529 #endif
530
531     DEBUG(2, ("copy_termtype"));
532     *dst = *src;                /* ...to copy the sizes and string-tables */
533
534     TYPE_MALLOC(NCURSES_SBOOL, NUM_BOOLEANS(dst), dst->Booleans);
535     TYPE_MALLOC(char *, NUM_STRINGS(dst), dst->Strings);
536
537     memcpy(dst->Booleans,
538            src->Booleans,
539            NUM_BOOLEANS(dst) * sizeof(dst->Booleans[0]));
540     memcpy(dst->Strings,
541            src->Strings,
542            NUM_STRINGS(dst) * sizeof(dst->Strings[0]));
543
544 #if NCURSES_EXT_NUMBERS
545     if ((mode & dstINT) == 0) {
546         DEBUG(2, ("...convert int ->short"));
547         TYPE_MALLOC(short, NUM_NUMBERS(dst), oldptr);
548         ((TERMTYPE *) dst)->Numbers = oldptr;
549     } else {
550         DEBUG(2, ("...copy without changing size"));
551         TYPE_MALLOC(int, NUM_NUMBERS(dst), newptr);
552         dst->Numbers = newptr;
553     }
554     if ((mode == srcINT) && (oldptr != 0)) {
555         DEBUG(2, ("...copy int ->short"));
556         for (i = 0; i < NUM_NUMBERS(dst); ++i) {
557             if (src->Numbers[i] > MAX_OF_TYPE(short)) {
558                 oldptr[i] = MAX_OF_TYPE(short);
559             } else {
560                 oldptr[i] = (short) src->Numbers[i];
561             }
562         }
563     } else if ((mode == dstINT) && (newptr != 0)) {
564         DEBUG(2, ("...copy short ->int"));
565         for (i = 0; i < NUM_NUMBERS(dst); ++i) {
566             newptr[i] = ((const short *) (src->Numbers))[i];
567         }
568     } else {
569         DEBUG(2, ("...copy %s without change",
570                   (mode & dstINT)
571                   ? "int"
572                   : "short"));
573         memcpy(dst->Numbers,
574                src->Numbers,
575                NUM_NUMBERS(dst) * ((mode & dstINT)
576                                    ? sizeof(int)
577                                    : sizeof(short)));
578     }
579 #else
580     (void) mode;
581     TYPE_MALLOC(short, NUM_NUMBERS(dst), dst->Numbers);
582     memcpy(dst->Numbers,
583            src->Numbers,
584            NUM_NUMBERS(dst) * sizeof(dst->Numbers[0]));
585 #endif
586
587     /* FIXME: we probably should also copy str_table and ext_str_table,
588      * but tic and infocmp are not written to exploit that (yet).
589      */
590
591 #if NCURSES_XNAMES
592     if ((i = NUM_EXT_NAMES(src)) != 0) {
593         TYPE_MALLOC(char *, i, dst->ext_Names);
594         memcpy(dst->ext_Names, src->ext_Names, i * sizeof(char *));
595     } else {
596         dst->ext_Names = 0;
597     }
598 #endif
599 }
600
601 /*
602  * This entrypoint is used by tack 1.07
603  */
604 NCURSES_EXPORT(void)
605 _nc_copy_termtype(TERMTYPE *dst, const TERMTYPE *src)
606 {
607     DEBUG(2, ("_nc_copy_termtype..."));
608     copy_termtype((TERMTYPE2 *) dst, (const TERMTYPE2 *) src, 0);
609 }
610
611 #if NCURSES_EXT_NUMBERS
612 NCURSES_EXPORT(void)
613 _nc_copy_termtype2(TERMTYPE2 *dst, const TERMTYPE2 *src)
614 {
615     DEBUG(2, ("_nc_copy_termtype2..."));
616     copy_termtype(dst, src, srcINT | dstINT);
617 }
618
619 /*
620  * Use this for exporting the internal TERMTYPE2 to the legacy format used via
621  * the CUR macro by applications.
622  */
623 NCURSES_EXPORT(void)
624 _nc_export_termtype2(TERMTYPE *dst, const TERMTYPE2 *src)
625 {
626     DEBUG(2, ("_nc_export_termtype2..."));
627     copy_termtype((TERMTYPE2 *) dst, src, srcINT);
628 }
629 #endif /* NCURSES_EXT_NUMBERS */