src/dict-splay.c

   1 /* dict-splay.c - Abstract dictionary type
   2  * Copyright 2000-2004 srvx Development Team
   3  *
   4  * This file is part of srvx.
   5  *
   6  * srvx is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  */
  16
  17 #include "common.h"
  18 #include "dict.h"
  19
  20 /*
  21  *    Create new dictionary.
  22  */
  23 dict_t
  24 dict_new(void)
  25 {
  26     dict_t dict = calloc(1, sizeof(*dict));
  27     return dict;
  28 }
  29
  30 /*
  31  *    Return number of entries in the dictionary.
  32  */
  33 unsigned int
  34 dict_size(dict_t dict)
  35 {
  36     return dict->count;
  37 }
  38
  39 /*
  40  *    Set the function to be called when freeing a key structure.
  41  *    If the function is NULL, just forget about the pointer.
  42  */
  43 void
  44 dict_set_free_keys(dict_t dict, free_f free_keys)
  45 {
  46     dict->free_keys = free_keys;
  47 }
  48
  49 /*
  50  *    Set the function to free data.
  51  * If the function is NULL, just forget about the pointer.
  52  */
  53 void
  54 dict_set_free_data(dict_t dict, free_f free_data)
  55 {
  56     dict->free_data = free_data;
  57 }
  58
  59 const char *
  60 dict_foreach(dict_t dict, dict_iterator_f it_f, void *extra)
  61 {
  62     dict_iterator_t it;
  63
  64     for (it=dict_first(dict); it; it=iter_next(it)) {
  65         if (it_f(iter_key(it), iter_data(it), extra)) return iter_key(it);
  66     }
  67     return NULL;
  68 }
  69
  70 /*
  71  *   This function finds a node and pulls it to the top of the tree.
  72  *   This helps balance the tree and auto-cache things you search for.
  73  */
  74 static struct dict_node*
  75 dict_splay(struct dict_node *node, const char *key)
  76 {
  77     struct dict_node N, *l, *r, *y;
  78     if (!node) return NULL;
  79     N.l = N.r = NULL;
  80     l = r = &N;
  81
  82     while (1) {
  83         int res = irccasecmp(key, node->key);
  84         if (!res) break;
  85         if (res < 0) {
  86             if (!node->l) break;
  87             res = irccasecmp(key, node->l->key);
  88             if (res < 0) {
  89                 y = node->l;
  90                 node->l = y->r;
  91                 y->r = node;
  92                 node = y;
  93                 if (!node->l) break;
  94             }
  95             r->l = node;
  96             r = node;
  97             node = node->l;
  98         } else { /* res > 0 */
  99             if (!node->r) break;
 100             res = irccasecmp(key, node->r->key);
 101             if (res > 0) {
 102                 y = node->r;
 103                 node->r = y->l;
 104                 y->l = node;
 105                 node = y;
 106                 if (!node->r) break;
 107             }
 108             l->r = node;
 109             l = node;
 110             node = node->r;
 111         }
 112     }
 113     l->r = node->l;
 114     r->l = node->r;
 115     node->l = N.r;
 116     node->r = N.l;
 117     return node;
 118 }
 119
 120 /*
 121  *    Free node.  Free data/key using free_f functions.
 122  */
 123 static void
 124 dict_dispose_node(struct dict_node *node, free_f free_keys, free_f free_data)
 125 {
 126     if (free_keys && node->key) {
 127         if (free_keys == free)
 128             free((void*)node->key);
 129         else
 130             free_keys((void*)node->key);
 131     }
 132     if (free_data && node->data) {
 133         if (free_data == free)
 134             free(node->data);
 135         else
 136             free_data(node->data);
 137     }
 138     free(node);
 139 }
 140
 141 /*
 142  *    Insert an entry into the dictionary.
 143  *    Key ordering (and uniqueness) is determined by case-insensitive
 144  *    string comparison.
 145  */
 146 void
 147 dict_insert(dict_t dict, const char *key, void *data)
 148 {
 149     struct dict_node *new_node;
 150     if (!key)
 151         return;
 152     new_node = malloc(sizeof(struct dict_node));
 153     new_node->key = key;
 154     new_node->data = data;
 155     if (dict->root) {
 156         int res;
 157         dict->root = dict_splay(dict->root, key);
 158         res = irccasecmp(key, dict->root->key);
 159         if (res < 0) {
 160             /* insert just "before" current root */
 161             new_node->l = dict->root->l;
 162             new_node->r = dict->root;
 163             dict->root->l = NULL;
 164             if (dict->root->prev) {
 165                 dict->root->prev->next = new_node;
 166             } else {
 167                 dict->first = new_node;
 168             }
 169             new_node->prev = dict->root->prev;
 170             new_node->next = dict->root;
 171             dict->root->prev = new_node;
 172             dict->root = new_node;
 173         } else if (res > 0) {
 174             /* insert just "after" current root */
 175             new_node->r = dict->root->r;
 176             new_node->l = dict->root;
 177             dict->root->r = NULL;
 178             if (dict->root->next) {
 179                 dict->root->next->prev = new_node;
 180             } else {
 181                 dict->last = new_node;
 182             }
 183             new_node->next = dict->root->next;
 184             new_node->prev = dict->root;
 185             dict->root->next = new_node;
 186             dict->root = new_node;
 187         } else {
 188             /* maybe we don't want to overwrite it .. oh well */
 189             if (dict->free_data) {
 190                 if (dict->free_data == free)
 191                     free(dict->root->data);
 192                 else
 193                     dict->free_data(dict->root->data);
 194             }
 195             if (dict->free_keys) {
 196                 if (dict->free_keys == free)
 197                     free((void*)dict->root->key);
 198                 else
 199                     dict->free_keys((void*)dict->root->key);
 200             }
 201             free(new_node);
 202             dict->root->key = key;
 203             dict->root->data = data;
 204             /* decrement the count since we dropped the node */
 205             dict->count--;
 206         }
 207     } else {
 208         new_node->l = new_node->r = NULL;
 209         new_node->next = new_node->prev = NULL;
 210         dict->root = dict->first = dict->last = new_node;
 211     }
 212     dict->count++;
 213 }
 214
 215 /*
 216  *    Remove an entry from the dictionary.
 217  *    Return non-zero if it was found, or zero if the key was not in the
 218  *    dictionary.
 219  */
 220 int
 221 dict_remove2(dict_t dict, const char *key, int no_dispose)
 222 {
 223     struct dict_node *new_root, *old_root;
 224
 225     if (!dict->root)
 226         return 0;
 227     dict->root = dict_splay(dict->root, key);
 228     if (irccasecmp(key, dict->root->key))
 229         return 0;
 230
 231     if (!dict->root->l) {
 232         new_root = dict->root->r;
 233     } else {
 234         new_root = dict_splay(dict->root->l, key);
 235         new_root->r = dict->root->r;
 236     }
 237     if (dict->root->prev) dict->root->prev->next = dict->root->next;
 238     if (dict->first == dict->root) dict->first = dict->first->next;
 239     if (dict->root->next) dict->root->next->prev = dict->root->prev;
 240     if (dict->last == dict->root) dict->last = dict->last->prev;
 241     old_root = dict->root;
 242     dict->root = new_root;
 243     dict->count--;
 244     if (no_dispose) {
 245         free(old_root);
 246     } else {
 247         dict_dispose_node(old_root, dict->free_keys, dict->free_data);
 248     }
 249     return 1;
 250 }
 251
 252 /*
 253  *    Find an entry in the dictionary.
 254  *    If "found" is non-NULL, set it to non-zero if the key was found.
 255  *    Return the data associated with the key (or NULL if the key was
 256  *    not found).
 257  */
 258 void*
 259 dict_find(dict_t dict, const char *key, int *found)
 260 {
 261     int was_found;
 262     if (!dict || !dict->root || !key) {
 263         if (found)
 264             *found = 0;
 265         return NULL;
 266     }
 267     dict->root = dict_splay(dict->root, key);
 268     was_found = !irccasecmp(key, dict->root->key);
 269     if (found)
 270         *found = was_found;
 271     return was_found ? dict->root->data : NULL;
 272 }
 273
 274 /*
 275  *    Delete an entire dictionary.
 276  */
 277 void
 278 dict_delete(dict_t dict)
 279 {
 280     dict_iterator_t it, next;
 281     if (!dict)
 282         return;
 283     for (it=dict_first(dict); it; it=next) {
 284         next = iter_next(it);
 285         dict_dispose_node(it, dict->free_keys, dict->free_data);
 286     }
 287     free(dict);
 288 }
 289
 290 struct dict_sanity_struct {
 291     unsigned int node_count;
 292     struct dict_node *bad_node;
 293     char error[128];
 294 };
 295
 296 static int
 297 dict_sanity_check_node(struct dict_node *node, struct dict_sanity_struct *dss)
 298 {
 299     if (!node->key) {
 300         snprintf(dss->error, sizeof(dss->error), "Node %p had null key", node);
 301         return 1;
 302     }
 303     if (node->l) {
 304         if (dict_sanity_check_node(node->l, dss)) return 1;
 305         if (irccasecmp(node->l->key, node->key) >= 0) {
 306             snprintf(dss->error, sizeof(dss->error), "Node %p's left child's key '%s' >= its key '%s'", node, node->l->key, node->key);
 307             return 1;
 308         }
 309     }
 310     if (node->r) {
 311         if (dict_sanity_check_node(node->r, dss)) return 1;
 312         if (irccasecmp(node->key, node->r->key) >= 0) {
 313             snprintf(dss->error, sizeof(dss->error), "Node %p's right child's key '%s' <= its key '%s'", node, node->r->key, node->key);
 314             return 1;
 315         }
 316     }
 317     dss->node_count++;
 318     return 0;
 319 }
 320
 321 /*
 322  *    Perform sanity checks on the dict's internal structure.
 323  */
 324 char *
 325 dict_sanity_check(dict_t dict)
 326 {
 327     struct dict_sanity_struct dss;
 328     dss.node_count = 0;
 329     dss.bad_node = 0;
 330     dss.error[0] = 0;
 331     if (dict->root && dict_sanity_check_node(dict->root, &dss)) {
 332         return strdup(dss.error);
 333     } else if (dss.node_count != dict->count) {
 334         snprintf(dss.error, sizeof(dss.error), "Counted %d nodes but expected %d.", dss.node_count, dict->count);
 335         return strdup(dss.error);
 336     } else {
 337         return 0;
 338     }
 339 }