usr.bin/make/hash.h

   1 /*
   2  * Copyright (c) 1988, 1989, 1990, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  * Copyright (c) 1988, 1989 by Adam de Boor
   5  * Copyright (c) 1989 by Berkeley Softworks
   6  * All rights reserved.
   7  *
   8  * This code is derived from software contributed to Berkeley by
   9  * Adam de Boor.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. All advertising materials mentioning features or use of this software
  20  *    must display the following acknowledgement:
  21  *      This product includes software developed by the University of
  22  *      California, Berkeley and its contributors.
  23  * 4. Neither the name of the University nor the names of its contributors
  24  *    may be used to endorse or promote products derived from this software
  25  *    without specific prior written permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37  * SUCH DAMAGE.
  38  *
  39  *      from: @(#)hash.h        8.1 (Berkeley) 6/6/93
  40  * $FreeBSD: src/usr.bin/make/hash.h,v 1.8 1999/08/28 01:03:30 peter Exp $
  41  * $DragonFly: src/usr.bin/make/hash.h,v 1.6 2004/11/12 22:42:36 dillon Exp $
  42  */
  43
  44 /* hash.h --
  45  *
  46  *      This file contains definitions used by the hash module,
  47  *      which maintains hash tables.
  48  */
  49
  50 #ifndef _HASH
  51 #define _HASH
  52
  53 /*
  54  * The following defines one entry in the hash table.
  55  */
  56
  57 typedef struct Hash_Entry {
  58     struct Hash_Entry *next;            /* Used to link together all the
  59                                          * entries associated with the same
  60                                          * bucket. */
  61     void *            clientData;       /* Arbitrary piece of data associated
  62                                          * with key. */
  63     unsigned          namehash;         /* hash value of key */
  64     char              name[1];          /* key string */
  65 } Hash_Entry;
  66
  67 typedef struct Hash_Table {
  68     struct Hash_Entry **bucketPtr;/* Pointers to Hash_Entry, one
  69                                  * for each bucket in the table. */
  70     int         size;           /* Actual size of array. */
  71     int         numEntries;     /* Number of entries in the table. */
  72     int         mask;           /* Used to select bits for hashing. */
  73 } Hash_Table;
  74
  75 /*
  76  * The following structure is used by the searching routines
  77  * to record where we are in the search.
  78  */
  79
  80 typedef struct Hash_Search {
  81     Hash_Table  *tablePtr;      /* Table being searched. */
  82     int         nextIndex;      /* Next bucket to check (after current). */
  83     Hash_Entry  *hashEntryPtr;  /* Next entry to check in current bucket. */
  84 } Hash_Search;
  85
  86 /*
  87  * Macros.
  88  */
  89
  90 /*
  91  * void * Hash_GetValue(h)
  92  *     Hash_Entry *h;
  93  */
  94
  95 #define Hash_GetValue(h) ((h)->clientData)
  96
  97 /*
  98  * Hash_SetValue(h, val);
  99  *     Hash_Entry *h;
 100  *     char *val;
 101  */
 102
 103 #define Hash_SetValue(h, val) ((h)->clientData = (void *) (val))
 104
 105 /*
 106  * Hash_Size(n) returns the number of words in an object of n bytes
 107  */
 108
 109 #define Hash_Size(n)    (((n) + sizeof (int) - 1) / sizeof (int))
 110
 111 void Hash_InitTable(Hash_Table *, int);
 112 void Hash_DeleteTable(Hash_Table *);
 113 Hash_Entry *Hash_FindEntry(Hash_Table *, char *);
 114 Hash_Entry *Hash_CreateEntry(Hash_Table *, char *, Boolean *);
 115 void Hash_DeleteEntry(Hash_Table *, Hash_Entry *);
 116 Hash_Entry *Hash_EnumFirst(Hash_Table *, Hash_Search *);
 117 Hash_Entry *Hash_EnumNext(Hash_Search *);
 118
 119 #endif /* _HASH */