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.19 2005/02/01 10:50:35 harti Exp $
  41  * $DragonFly: src/usr.bin/make/hash.h,v 1.20 2005/08/04 00:21:50 okumoto Exp $
  42  */
  43
  44 #ifndef hash_h_f6312f46
  45 #define hash_h_f6312f46
  46
  47 /* hash.h --
  48  *
  49  *      This file contains definitions used by the hash module,
  50  *      which maintains hash tables.
  51  */
  52
  53 #include <stdbool.h>
  54
  55 /*
  56  * The following defines one entry in the hash table.
  57  */
  58 typedef struct Hash_Entry {
  59         struct Hash_Entry *next;        /* Used to link together all the
  60                                          * entries associated with the same
  61                                          * bucket. */
  62         void            *clientData;    /* Arbitrary piece of data associated
  63                                          * with key. */
  64         unsigned        namehash;       /* hash value of key */
  65         char            name[1];        /* key string */
  66 } Hash_Entry;
  67
  68 typedef struct Hash_Table {
  69         struct Hash_Entry **bucketPtr;  /* Pointers to Hash_Entry, one
  70                                          * for each bucket in the table. */
  71         int             size;           /* Actual size of array. */
  72         int             numEntries;     /* Number of entries in the table. */
  73         int             mask;           /* Used to select bits for hashing. */
  74 } Hash_Table;
  75
  76 /*
  77  * The following structure is used by the searching routines
  78  * to record where we are in the search.
  79  */
  80 typedef struct Hash_Search {
  81         const Hash_Table *tablePtr;     /* Table being searched. */
  82         int             nextIndex;      /* Next bucket to check (after current).*/
  83         Hash_Entry      *hashEntryPtr;  /* Next entry in current bucket */
  84 } Hash_Search;
  85
  86 /*
  87  * Macros.
  88  */
  89
  90 /*
  91  * void *Hash_GetValue(const Hash_Entry *h)
  92  */
  93 #define Hash_GetValue(h) ((h)->clientData)
  94
  95 /*
  96  * Hash_SetValue(Hash_Entry *h, void *val);
  97  */
  98 #define Hash_SetValue(h, val) ((h)->clientData = (val))
  99
 100 void Hash_InitTable(Hash_Table *, int);
 101 void Hash_DeleteTable(Hash_Table *);
 102 Hash_Entry *Hash_FindEntry(const Hash_Table *, const char *);
 103 Hash_Entry *Hash_CreateEntry(Hash_Table *, const char *, bool *);
 104 void Hash_DeleteEntry(Hash_Table *, Hash_Entry *);
 105 Hash_Entry *Hash_EnumFirst(const Hash_Table *, Hash_Search *);
 106 Hash_Entry *Hash_EnumNext(Hash_Search *);
 107
 108 #endif /* hash_h_f6312f46 */