ncurses 6.3 - patch 20220514
[ncurses.git] / ncurses / tinfo / alloc_entry.c
1 /****************************************************************************
2  * Copyright 2018-2021,2022 Thomas E. Dickey                                *
3  * Copyright 1998-2013,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: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
32  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
33  *     and: Thomas E. Dickey                        1996-on                 *
34  ****************************************************************************/
35
36 /*
37  * alloc_entry.c -- allocation functions for terminfo entries
38  *
39  *      _nc_copy_entry()
40  *      _nc_init_entry()
41  *      _nc_merge_entry()
42  *      _nc_save_str()
43  *      _nc_wrap_entry()
44  *
45  */
46
47 #include <curses.priv.h>
48
49 #include <tic.h>
50
51 MODULE_ID("$Id: alloc_entry.c,v 1.73 2022/05/08 00:11:44 tom Exp $")
52
53 #define ABSENT_OFFSET    -1
54 #define CANCELLED_OFFSET -2
55
56 static char *stringbuf;         /* buffer for string capabilities */
57 static size_t next_free;        /* next free character in stringbuf */
58
59 NCURSES_EXPORT(void)
60 _nc_init_entry(ENTRY * const tp)
61 /* initialize a terminal type data block */
62 {
63     DEBUG(2, (T_CALLED("_nc_init_entry(tp=%p)"), (void *) tp));
64
65     if (tp == NULL) {
66 #if NO_LEAKS
67         if (stringbuf != NULL) {
68             FreeAndNull(stringbuf);
69         }
70         return;
71 #else
72         _nc_err_abort("_nc_init_entry called without initialization");
73 #endif
74     }
75
76     if (stringbuf == NULL)
77         TYPE_CALLOC(char, (size_t) MAX_ENTRY_SIZE, stringbuf);
78
79     next_free = 0;
80
81     _nc_init_termtype(&(tp->tterm));
82
83     DEBUG(2, (T_RETURN("")));
84 }
85
86 NCURSES_EXPORT(ENTRY *)
87 _nc_copy_entry(ENTRY * oldp)
88 {
89     ENTRY *newp;
90
91     DEBUG(2, (T_CALLED("_nc_copy_entry(oldp=%p)"), (void *) oldp));
92
93     newp = typeCalloc(ENTRY, 1);
94     if (newp != NULL) {
95         *newp = *oldp;
96         _nc_copy_termtype2(&(newp->tterm), &(oldp->tterm));
97     }
98
99     DEBUG(2, (T_RETURN("%p"), (void *) newp));
100     return (newp);
101 }
102
103 /* save a copy of string in the string buffer */
104 NCURSES_EXPORT(char *)
105 _nc_save_str(const char *string)
106 {
107     char *result = 0;
108     size_t old_next_free = next_free;
109     size_t len;
110
111     if (stringbuf != NULL) {
112         if (!VALID_STRING(string))
113             string = "";
114         len = strlen(string) + 1;
115
116         if (len == 1 && next_free != 0) {
117             /*
118              * Cheat a little by making an empty string point to the end of the
119              * previous string.
120              */
121             if (next_free < MAX_ENTRY_SIZE) {
122                 result = (stringbuf + next_free - 1);
123             }
124         } else if (next_free + len < MAX_ENTRY_SIZE) {
125             _nc_STRCPY(&stringbuf[next_free], string, MAX_ENTRY_SIZE);
126             DEBUG(7, ("Saved string %s", _nc_visbuf(string)));
127             DEBUG(7, ("at location %d", (int) next_free));
128             next_free += len;
129             result = (stringbuf + old_next_free);
130         } else {
131             _nc_warning("Too much data, some is lost: %s", string);
132         }
133     }
134     return result;
135 }
136
137 NCURSES_EXPORT(void)
138 _nc_wrap_entry(ENTRY * const ep, bool copy_strings)
139 /* copy the string parts to allocated storage, preserving pointers to it */
140 {
141     int offsets[MAX_ENTRY_SIZE / sizeof(short)];
142     int useoffsets[MAX_USES];
143     unsigned i, n;
144     unsigned nuses;
145     TERMTYPE2 *tp;
146
147     DEBUG(2, (T_CALLED("_nc_wrap_entry(ep=%p, copy_strings=%d)"), (void *)
148               ep, copy_strings));
149     if (ep == NULL || stringbuf == NULL)
150         _nc_err_abort("_nc_wrap_entry called without initialization");
151
152     nuses = ep->nuses;
153     tp = &(ep->tterm);
154     if (copy_strings) {
155         next_free = 0;          /* clear static storage */
156
157         /* copy term_names, Strings, uses */
158         tp->term_names = _nc_save_str(tp->term_names);
159         for_each_string(i, tp) {
160             if (tp->Strings[i] != ABSENT_STRING &&
161                 tp->Strings[i] != CANCELLED_STRING) {
162                 tp->Strings[i] = _nc_save_str(tp->Strings[i]);
163             }
164         }
165
166         for (i = 0; i < nuses; i++) {
167             if (ep->uses[i].name == 0) {
168                 ep->uses[i].name = _nc_save_str(ep->uses[i].name);
169             }
170         }
171
172         free(tp->str_table);
173     }
174
175     assert(tp->term_names >= stringbuf);
176     n = (unsigned) (tp->term_names - stringbuf);
177     for_each_string(i, &(ep->tterm)) {
178         if (i < SIZEOF(offsets)) {
179             if (tp->Strings[i] == ABSENT_STRING) {
180                 offsets[i] = ABSENT_OFFSET;
181             } else if (tp->Strings[i] == CANCELLED_STRING) {
182                 offsets[i] = CANCELLED_OFFSET;
183             } else {
184                 offsets[i] = (int) (tp->Strings[i] - stringbuf);
185             }
186         }
187     }
188
189     for (i = 0; i < nuses; i++) {
190         if (ep->uses[i].name == 0)
191             useoffsets[i] = ABSENT_OFFSET;
192         else
193             useoffsets[i] = (int) (ep->uses[i].name - stringbuf);
194     }
195
196     TYPE_MALLOC(char, next_free, tp->str_table);
197     (void) memcpy(tp->str_table, stringbuf, next_free);
198
199     tp->term_names = tp->str_table + n;
200     for_each_string(i, &(ep->tterm)) {
201         if (i < SIZEOF(offsets)) {
202             if (offsets[i] == ABSENT_OFFSET) {
203                 tp->Strings[i] = ABSENT_STRING;
204             } else if (offsets[i] == CANCELLED_OFFSET) {
205                 tp->Strings[i] = CANCELLED_STRING;
206             } else {
207                 tp->Strings[i] = tp->str_table + offsets[i];
208             }
209         }
210     }
211
212 #if NCURSES_XNAMES
213     if (!copy_strings) {
214         if ((n = (unsigned) NUM_EXT_NAMES(tp)) != 0) {
215             if (n < SIZEOF(offsets)) {
216                 size_t length = 0;
217                 size_t offset;
218                 for (i = 0; i < n; i++) {
219                     length += strlen(tp->ext_Names[i]) + 1;
220                     offsets[i] = (int) (tp->ext_Names[i] - stringbuf);
221                 }
222                 TYPE_MALLOC(char, length, tp->ext_str_table);
223                 for (i = 0, offset = 0; i < n; i++) {
224                     tp->ext_Names[i] = tp->ext_str_table + offset;
225                     _nc_STRCPY(tp->ext_Names[i],
226                                stringbuf + offsets[i],
227                                length - offset);
228                     offset += strlen(tp->ext_Names[i]) + 1;
229                 }
230             }
231         }
232     }
233 #endif
234
235     for (i = 0; i < nuses; i++) {
236         if (useoffsets[i] == ABSENT_OFFSET)
237             ep->uses[i].name = 0;
238         else
239             ep->uses[i].name = (tp->str_table + useoffsets[i]);
240     }
241     DEBUG(2, (T_RETURN("")));
242 }
243
244 NCURSES_EXPORT(void)
245 _nc_merge_entry(ENTRY * const target, ENTRY * const source)
246 /* merge capabilities from `from' entry into `to' entry */
247 {
248     TERMTYPE2 *to = &(target->tterm);
249     TERMTYPE2 *from = &(source->tterm);
250 #if NCURSES_XNAMES
251     TERMTYPE2 copy;
252 #endif
253     unsigned i;
254
255     if (source == 0 || from == 0 || target == 0 || to == 0)
256         return;
257
258 #if NCURSES_XNAMES
259     _nc_copy_termtype2(&copy, from);
260     from = &copy;
261     _nc_align_termtype(to, from);
262 #endif
263     for_each_boolean(i, from) {
264         if (to->Booleans[i] != (NCURSES_SBOOL) CANCELLED_BOOLEAN) {
265             int mergebool = from->Booleans[i];
266
267             if (mergebool == CANCELLED_BOOLEAN)
268                 to->Booleans[i] = FALSE;
269             else if (mergebool == TRUE)
270                 to->Booleans[i] = (NCURSES_SBOOL) mergebool;
271         }
272     }
273
274     for_each_number(i, from) {
275         if (to->Numbers[i] != CANCELLED_NUMERIC) {
276             int mergenum = from->Numbers[i];
277
278             if (mergenum == CANCELLED_NUMERIC)
279                 to->Numbers[i] = ABSENT_NUMERIC;
280             else if (mergenum != ABSENT_NUMERIC)
281                 to->Numbers[i] = (NCURSES_INT2) mergenum;
282         }
283     }
284
285     /*
286      * Note: the copies of strings this makes don't have their own
287      * storage.  This is OK right now, but will be a problem if we
288      * we ever want to deallocate entries.
289      */
290     for_each_string(i, from) {
291         if (to->Strings[i] != CANCELLED_STRING) {
292             char *mergestring = from->Strings[i];
293
294             if (mergestring == CANCELLED_STRING)
295                 to->Strings[i] = ABSENT_STRING;
296             else if (mergestring != ABSENT_STRING)
297                 to->Strings[i] = mergestring;
298         }
299     }
300 #if NCURSES_XNAMES
301     /* Discard the data allocated in _nc_copy_termtype2, but do not use
302      * _nc_free_termtype2 because that frees the string-table (which is
303      * not allocated by _nc_copy_termtype2).
304      */
305     free(copy.Booleans);
306     free(copy.Numbers);
307     free(copy.Strings);
308     free(copy.ext_Names);
309 #endif
310 }
311
312 #if NO_LEAKS
313 NCURSES_EXPORT(void)
314 _nc_alloc_entry_leaks(void)
315 {
316     if (stringbuf != NULL) {
317         FreeAndNull(stringbuf);
318     }
319     next_free = 0;
320 }
321 #endif