ncurses/tinfo/alloc_entry.c

   1 /****************************************************************************
   2  * Copyright (c) 1998-2005,2006 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  * alloc_entry.c -- allocation functions for terminfo entries
  37  *
  38  *      _nc_copy_entry()
  39  *      _nc_init_entry()
  40  *      _nc_merge_entry()
  41  *      _nc_save_str()
  42  *      _nc_wrap_entry()
  43  *
  44  */
  45
  46 #include <curses.priv.h>
  47
  48 #include <tic.h>
  49 #include <term_entry.h>
  50
  51 MODULE_ID("$Id: alloc_entry.c,v 1.47 2006/12/16 19:06:58 tom Exp $")
  52
  53 #define ABSENT_OFFSET    -1
  54 #define CANCELLED_OFFSET -2
  55
  56 #define MAX_STRTAB      4096    /* documented maximum entry size */
  57
  58 static char *stringbuf;         /* buffer for string capabilities */
  59 static size_t next_free;        /* next free character in stringbuf */
  60
  61 NCURSES_EXPORT(void)
  62 _nc_init_entry(TERMTYPE *const tp)
  63 /* initialize a terminal type data block */
  64 {
  65     unsigned i;
  66
  67 #if NO_LEAKS
  68     if (tp == 0 && stringbuf != 0) {
  69         FreeAndNull(stringbuf);
  70         return;
  71     }
  72 #endif
  73
  74     if (stringbuf == 0)
  75         stringbuf = (char *) malloc(MAX_STRTAB);
  76
  77 #if NCURSES_XNAMES
  78     tp->num_Booleans = BOOLCOUNT;
  79     tp->num_Numbers = NUMCOUNT;
  80     tp->num_Strings = STRCOUNT;
  81     tp->ext_Booleans = 0;
  82     tp->ext_Numbers = 0;
  83     tp->ext_Strings = 0;
  84 #endif
  85     if (tp->Booleans == 0)
  86         tp->Booleans = typeMalloc(NCURSES_SBOOL, BOOLCOUNT);
  87     if (tp->Numbers == 0)
  88         tp->Numbers = typeMalloc(short, NUMCOUNT);
  89     if (tp->Strings == 0)
  90         tp->Strings = typeMalloc(char *, STRCOUNT);
  91
  92     for_each_boolean(i, tp)
  93         tp->Booleans[i] = FALSE;
  94
  95     for_each_number(i, tp)
  96         tp->Numbers[i] = ABSENT_NUMERIC;
  97
  98     for_each_string(i, tp)
  99         tp->Strings[i] = ABSENT_STRING;
 100
 101     next_free = 0;
 102 }
 103
 104 NCURSES_EXPORT(ENTRY *)
 105 _nc_copy_entry(ENTRY * oldp)
 106 {
 107     ENTRY *newp = typeCalloc(ENTRY, 1);
 108
 109     if (newp != 0) {
 110         *newp = *oldp;
 111         _nc_copy_termtype(&(newp->tterm), &(oldp->tterm));
 112     }
 113     return newp;
 114 }
 115
 116 /* save a copy of string in the string buffer */
 117 NCURSES_EXPORT(char *)
 118 _nc_save_str(const char *const string)
 119 {
 120     char *result = 0;
 121     size_t old_next_free = next_free;
 122     size_t len = strlen(string) + 1;
 123
 124     if (len == 1 && next_free != 0) {
 125         /*
 126          * Cheat a little by making an empty string point to the end of the
 127          * previous string.
 128          */
 129         if (next_free < MAX_STRTAB) {
 130             result = (stringbuf + next_free - 1);
 131         }
 132     } else if (next_free + len < MAX_STRTAB) {
 133         strcpy(&stringbuf[next_free], string);
 134         DEBUG(7, ("Saved string %s", _nc_visbuf(string)));
 135         DEBUG(7, ("at location %d", (int) next_free));
 136         next_free += len;
 137         result = (stringbuf + old_next_free);
 138     } else {
 139         _nc_warning("Too much data, some is lost");
 140     }
 141     return result;
 142 }
 143
 144 NCURSES_EXPORT(void)
 145 _nc_wrap_entry(ENTRY * const ep, bool copy_strings)
 146 /* copy the string parts to allocated storage, preserving pointers to it */
 147 {
 148     int offsets[MAX_ENTRY_SIZE / 2], useoffsets[MAX_USES];
 149     unsigned i, n;
 150     unsigned nuses = ep->nuses;
 151     TERMTYPE *tp = &(ep->tterm);
 152
 153     if (copy_strings) {
 154         next_free = 0;          /* clear static storage */
 155
 156         /* copy term_names, Strings, uses */
 157         tp->term_names = _nc_save_str(tp->term_names);
 158         for_each_string(i, tp) {
 159             if (tp->Strings[i] != ABSENT_STRING &&
 160                 tp->Strings[i] != CANCELLED_STRING) {
 161                 tp->Strings[i] = _nc_save_str(tp->Strings[i]);
 162             }
 163         }
 164
 165         for (i = 0; i < nuses; i++) {
 166             if (ep->uses[i].name == 0) {
 167                 ep->uses[i].name = _nc_save_str(ep->uses[i].name);
 168             }
 169         }
 170
 171         free(tp->str_table);
 172     }
 173
 174     n = tp->term_names - stringbuf;
 175     for_each_string(i, &(ep->tterm)) {
 176         if (tp->Strings[i] == ABSENT_STRING)
 177             offsets[i] = ABSENT_OFFSET;
 178         else if (tp->Strings[i] == CANCELLED_STRING)
 179             offsets[i] = CANCELLED_OFFSET;
 180         else
 181             offsets[i] = tp->Strings[i] - stringbuf;
 182     }
 183
 184     for (i = 0; i < nuses; i++) {
 185         if (ep->uses[i].name == 0)
 186             useoffsets[i] = ABSENT_OFFSET;
 187         else
 188             useoffsets[i] = ep->uses[i].name - stringbuf;
 189     }
 190
 191     if ((tp->str_table = typeMalloc(char, next_free)) == (char *) 0)
 192           _nc_err_abort(MSG_NO_MEMORY);
 193     (void) memcpy(tp->str_table, stringbuf, next_free);
 194
 195     tp->term_names = tp->str_table + n;
 196     for_each_string(i, &(ep->tterm)) {
 197         if (offsets[i] == ABSENT_OFFSET)
 198             tp->Strings[i] = ABSENT_STRING;
 199         else if (offsets[i] == CANCELLED_OFFSET)
 200             tp->Strings[i] = CANCELLED_STRING;
 201         else
 202             tp->Strings[i] = tp->str_table + offsets[i];
 203     }
 204
 205 #if NCURSES_XNAMES
 206     if (!copy_strings) {
 207         if ((n = NUM_EXT_NAMES(tp)) != 0) {
 208             unsigned length = 0;
 209             for (i = 0; i < n; i++) {
 210                 length += strlen(tp->ext_Names[i]) + 1;
 211                 offsets[i] = tp->ext_Names[i] - stringbuf;
 212             }
 213             if ((tp->ext_str_table = typeMalloc(char, length)) == 0)
 214                   _nc_err_abort(MSG_NO_MEMORY);
 215             for (i = 0, length = 0; i < n; i++) {
 216                 tp->ext_Names[i] = tp->ext_str_table + length;
 217                 strcpy(tp->ext_Names[i], stringbuf + offsets[i]);
 218                 length += strlen(tp->ext_Names[i]) + 1;
 219             }
 220         }
 221     }
 222 #endif
 223
 224     for (i = 0; i < nuses; i++) {
 225         if (useoffsets[i] == ABSENT_OFFSET)
 226             ep->uses[i].name = 0;
 227         else
 228             ep->uses[i].name = (tp->str_table + useoffsets[i]);
 229     }
 230 }
 231
 232 NCURSES_EXPORT(void)
 233 _nc_merge_entry(TERMTYPE *const to, TERMTYPE *const from)
 234 /* merge capabilities from `from' entry into `to' entry */
 235 {
 236     unsigned i;
 237
 238 #if NCURSES_XNAMES
 239     _nc_align_termtype(to, from);
 240 #endif
 241     for_each_boolean(i, from) {
 242         if (to->Booleans[i] != (char) CANCELLED_BOOLEAN) {
 243             int mergebool = from->Booleans[i];
 244
 245             if (mergebool == CANCELLED_BOOLEAN)
 246                 to->Booleans[i] = FALSE;
 247             else if (mergebool == TRUE)
 248                 to->Booleans[i] = mergebool;
 249         }
 250     }
 251
 252     for_each_number(i, from) {
 253         if (to->Numbers[i] != CANCELLED_NUMERIC) {
 254             int mergenum = from->Numbers[i];
 255
 256             if (mergenum == CANCELLED_NUMERIC)
 257                 to->Numbers[i] = ABSENT_NUMERIC;
 258             else if (mergenum != ABSENT_NUMERIC)
 259                 to->Numbers[i] = mergenum;
 260         }
 261     }
 262
 263     /*
 264      * Note: the copies of strings this makes don't have their own
 265      * storage.  This is OK right now, but will be a problem if we
 266      * we ever want to deallocate entries.
 267      */
 268     for_each_string(i, from) {
 269         if (to->Strings[i] != CANCELLED_STRING) {
 270             char *mergestring = from->Strings[i];
 271
 272             if (mergestring == CANCELLED_STRING)
 273                 to->Strings[i] = ABSENT_STRING;
 274             else if (mergestring != ABSENT_STRING)
 275                 to->Strings[i] = mergestring;
 276         }
 277     }
 278 }
 279
 280 #if NO_LEAKS
 281 NCURSES_EXPORT(void)
 282 _nc_alloc_entry_leaks(void)
 283 {
 284     if (stringbuf != 0) {
 285         FreeAndNull(stringbuf);
 286     }
 287     next_free = 0;
 288 }
 289 #endif