chiark - git - mdw - mLib/blob - struct/sym.c

   1 /* -*-c-*-
   2  *
   3  * Symbol table management
   4  *
   5  * (c) 1998 Straylight/Edgeware
   6  */
   7
   8 /*----- Licensing notice --------------------------------------------------*
   9  *
  10  * This file is part of the mLib utilities library.
  11  *
  12  * mLib is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU Library General Public License as
  14  * published by the Free Software Foundation; either version 2 of the
  15  * License, or (at your option) any later version.
  16  *
  17  * mLib is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU Library General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Library General Public
  23  * License along with mLib; if not, write to the Free
  24  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  25  * MA 02111-1307, USA.
  26  */
  27
  28 /*----- Header files ------------------------------------------------------*/
  29
  30 /* --- ANSI headers --- */
  31
  32 #include <string.h>
  33
  34 /* --- Local headers --- */
  35
  36 #include "alloc.h"
  37 #include "arena.h"
  38 #include "bits.h"
  39 #include "exc.h"
  40 #include "hash.h"
  41 #include "macros.h"
  42 #include "sub.h"
  43 #include "sym.h"
  44 #include "unihash.h"
  45
  46 /*----- Main code ---------------------------------------------------------*/
  47
  48 /* --- @sym_create@ --- *
  49  *
  50  * Arguments:   @sym_table *t@ = symbol table to initialize
  51  *
  52  * Returns:     ---
  53  *
  54  * Use:         Initializes the given symbol table.  Raises @EXC_NOMEM@ if
  55  *              there isn't enough memory.
  56  */
  57
  58 void sym_create(sym_table *t)
  59 {
  60   hash_create(&t->t, SYM_INITSZ);
  61   t->s = &sub_global;
  62   t->load = SYM_LIMIT(SYM_INITSZ);
  63 }
  64
  65 /* --- @sym_destroy@ --- *
  66  *
  67  * Arguments:   @sym_table *t@ = pointer to symbol table in question
  68  *
  69  * Returns:     ---
  70  *
  71  * Use:         Destroys a symbol table, freeing all the memory it used to
  72  *              occupy.
  73  */
  74
  75 void sym_destroy(sym_table *t)
  76 {
  77   sym_iter i;
  78
  79   SYM_MKITER(&i, t);
  80   for (;;) {
  81     sym_base *p;
  82     SYM_NEXT(&i, p);
  83     if (!p)
  84       break;
  85     x_free(t->t.a, p);
  86   }
  87   hash_destroy(&t->t);
  88 }
  89
  90 /* --- @sym_find@ --- *
  91  *
  92  * Arguments:   @sym_table *t@ = pointer to symbol table in question
  93  *              @const char *n@ = pointer to symbol name to look up
  94  *              @long l@ = length of the name string or negative to measure
  95  *              @size_t sz@ = size of desired symbol object, or zero
  96  *              @unsigned *f@ = pointer to a flag, or null.
  97  *
  98  * Returns:     The address of a @sym_base@ structure, or null if not found
  99  *              and @sz@ is zero.
 100  *
 101  * Use:         Looks up a symbol in a given symbol table.  The name is
 102  *              passed by the address of its first character.  The length
 103  *              may be given, in which case the name may contain arbitrary
 104  *              binary data, or it may be given as a negative number, in
 105  *              which case the length of the name is calculated as
 106  *              @strlen(n) + 1@.
 107  *
 108  *              The return value is the address of a pointer to a @sym_base@
 109  *              block (which may have other things on the end, as above).  If
 110  *              the symbol could be found, the return value points to the
 111  *              symbol block.  If the symbol wasn't there, then if @sz@ is
 112  *              nonzero, a new symbol is created and its address is returned;
 113  *              otherwise a null pointer is returned.  The exception
 114  *              @EXC_NOMEM@ is raised if the block can't be allocated.
 115  *
 116  *              The value of @*f@ indicates whether a new symbol entry was
 117  *              created: a nonzero value indicates that an old value was
 118  *              found.
 119  */
 120
 121 void *sym_find(sym_table *t, const char *n, long l, size_t sz, unsigned *f)
 122 {
 123   uint32 hash;
 124   size_t len = 0;
 125   hash_base **bin, **p;
 126   sym_base *q;
 127
 128   /* --- Find the correct bin --- */
 129
 130   len = l < 0 ? strlen(n) : l;
 131   hash = UNIHASH(&unihash_global, n, len);
 132   bin = HASH_BIN(&t->t, hash);
 133
 134   /* --- Search the bin list --- */
 135
 136   for (p = bin; *p; p = &(*p)->next) {
 137     q = (sym_base *)*p;
 138     if (hash == q->b.hash && len == q->len &&
 139         MEMCMP(n, ==, SYM_NAME(q), len)) {
 140
 141       /* --- Found a match --- *
 142        *
 143        * As a minor, and probably pointless, tweak, move the item to the
 144        * front of its bin list.
 145        */
 146
 147       (*p) = q->b.next;
 148       q->b.next = *bin;
 149       *bin = &q->b;
 150
 151       /* --- Return the block --- */
 152
 153       if (f) *f = 1;
 154       return (q);
 155     }
 156   }
 157
 158   /* --- Couldn't find the item there --- */
 159
 160   if (f) *f = 0;
 161   if (!sz) return (0);
 162
 163   /* --- Create a new symbol block and initialize it --- *
 164    *
 165    * The name is attached to the end of the symbol block.
 166    */
 167
 168   q = x_alloc(t->t.a, sz + len + 1);
 169   q->b.next = *bin;
 170   q->b.hash = hash;
 171   q->name = (char *)q + sz;
 172   memcpy(q->name, n, len);
 173   q->name[len] = 0;
 174   q->len = len;
 175   *bin = &q->b;
 176
 177   /* --- Consider growing the array --- */
 178
 179   if (t->load)
 180     t->load--;
 181   if (!t->load && hash_extend(&t->t))
 182     t->load = SYM_LIMIT(t->t.mask/2 + 1);
 183
 184   /* --- Finished that, so return the new symbol block --- */
 185
 186   return (q);
 187 }
 188
 189 /* --- @sym_remove@ --- *
 190  *
 191  * Arguments:   @sym_table *t@ = pointer to a symbol table object
 192  *              @void *p@ = pointer to symbol table entry
 193  *
 194  * Returns:     ---
 195  *
 196  * Use:         Removes the object from the symbol table.  The space occupied
 197  *              by the object and its name is freed; anything else attached
 198  *              to the entry should already be gone by this point.
 199  */
 200
 201 void sym_remove(sym_table *t, void *p)
 202 {
 203   sym_base *q = p;
 204   hash_remove(&t->t, &q->b);
 205   xfree(q);
 206   t->load++;
 207 }
 208
 209 /* --- @sym_mkiter@ --- *
 210  *
 211  * Arguments:   @sym_iter *i@ = pointer to an iterator object
 212  *              @sym_table *t@ = pointer to a symbol table object
 213  *
 214  * Returns:     ---
 215  *
 216  * Use:         Creates a new symbol table iterator which may be used to
 217  *              iterate through a symbol table.
 218  */
 219
 220 void sym_mkiter(sym_iter *i, sym_table *t) { SYM_MKITER(i, t); }
 221
 222 /* --- @sym_next@ --- *
 223  *
 224  * Arguments:   @sym_iter *i@ = pointer to iterator object
 225  *
 226  * Returns:     Pointer to the next symbol found, or null when finished.
 227  *
 228  * Use:         Returns the next symbol from the table.  Symbols are not
 229  *              returned in any particular order.
 230  */
 231
 232 void *sym_next(sym_iter *i)
 233 {
 234   void *p;
 235   SYM_NEXT(i, p);
 236   return (p);
 237 }
 238
 239 /*----- That's all, folks -------------------------------------------------*/