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