util/hash.h

   1 /*
   2  * Copyright (c) 1995, 1996, 1997, 1998 Kungliga Tekniska Högskolan
   3  * (Royal Institute of Technology, Stockholm, Sweden).
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * 3. Neither the name of the Institute nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 /*
  35  * hash.h. Header file for hash table functions
  36  */
  37
  38 /* $Id$ */
  39
  40 #include <bool.h>
  41
  42 #define HASHTAB_GROW            0x01
  43
  44 struct hashentry;
  45 typedef struct hashentry Hashentry;
  46
  47 struct hashtab;
  48
  49 typedef struct hashtab Hashtab;
  50 typedef int (*hashtabnew_arg2_t)(void *, void *);
  51 typedef unsigned (*hashtabnew_arg3_t)(void *);
  52
  53 /* prototypes */
  54
  55 Hashtab *hashtabnew(int sz,
  56                     int (*cmp)(void *, void *),
  57                     unsigned (*hash)(void *));  /* Make new hash table */
  58
  59 Hashtab *hashtabnewf(int sz,
  60                      int (*cmp)(void *, void *),
  61                      unsigned (*hash)(void *),
  62                      int flags);        /* Make new hash table */
  63
  64 void *hashtabsearch(Hashtab *htab, /* The hash table */
  65                     void *ptr); /*  The key */
  66
  67
  68 void *hashtabaddreplace(Hashtab *htab,  /* The hash table */
  69                         void *ptr);     /* The element */
  70
  71 void *hashtabadd(Hashtab *htab,
  72                  void *ptr);
  73
  74 int _hashtabdel(Hashtab *htab,  /* The table */
  75                 void *ptr,      /* Key */
  76                 int freep);     /* Free data part? */
  77
  78 void hashtabforeach(Hashtab *htab,
  79                     Bool (*func)(void *ptr, void *arg),
  80                     void *arg);
  81
  82 void hashtabcleantab(Hashtab * htab,
  83                      Bool(*cond) (void *ptr, void *arg),
  84                      void *arg);
  85
  86 void hashtabrelease(Hashtab *htab);
  87
  88 unsigned hashadd(const char *s);                /* Standard hash function */
  89 unsigned hashcaseadd(const char *s);            /* Standard hash function */
  90 unsigned hashjpw(const char *s);                /* another hash function */
  91
  92 /* macros */
  93
  94  /* Don't free space */
  95 #define hashtabdel(htab,key)  _hashtabdel(htab,key,FALSE)
  96
  97 #define hashtabfree(htab,key) _hashtabdel(htab,key,TRUE) /* Do! */