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  *      @(#)hash.h      8.1 (Berkeley) 6/6/93
  40  * $FreeBSD$
  41  */
  42
  43 #ifndef hash_h_f6312f46
  44 #define hash_h_f6312f46
  45
  46 /* hash.h --
  47  *
  48  *      This file contains definitions used by the hash module,
  49  *      which maintains hash tables.
  50  */
  51
  52 #include "util.h"
  53
  54 /*
  55  * The following defines one entry in the hash table.
  56  */
  57 typedef struct Hash_Entry {
  58         struct Hash_Entry *next;        /* Link entries within same bucket. */
  59         void            *clientData;    /* Data associated with key. */
  60         unsigned        namehash;       /* hash value of key */
  61         char            name[1];        /* key string */
  62 } Hash_Entry;
  63
  64 typedef struct Hash_Table {
  65         struct Hash_Entry **bucketPtr;  /* Buckets in the table */
  66         int             size;           /* Actual size of array. */
  67         int             numEntries;     /* Number of entries in the table. */
  68         int             mask;           /* Used to select bits for hashing. */
  69 } Hash_Table;
  70
  71 /*
  72  * The following structure is used by the searching routines
  73  * to record where we are in the search.
  74  */
  75 typedef struct Hash_Search {
  76         const Hash_Table *tablePtr;     /* Table being searched. */
  77         int             nextIndex;      /* Next bucket to check */
  78         Hash_Entry      *hashEntryPtr;  /* Next entry in current bucket */
  79 } Hash_Search;
  80
  81 /*
  82  * Macros.
  83  */
  84
  85 /*
  86  * void *Hash_GetValue(const Hash_Entry *h)
  87  */
  88 #define Hash_GetValue(h) ((h)->clientData)
  89
  90 /*
  91  * Hash_SetValue(Hash_Entry *h, void *val);
  92  */
  93 #define Hash_SetValue(h, val) ((h)->clientData = (val))
  94
  95 void Hash_InitTable(Hash_Table *, int);
  96 void Hash_DeleteTable(Hash_Table *);
  97 Hash_Entry *Hash_FindEntry(const Hash_Table *, const char *);
  98 Hash_Entry *Hash_CreateEntry(Hash_Table *, const char *, Boolean *);
  99 void Hash_DeleteEntry(Hash_Table *, Hash_Entry *);
 100 Hash_Entry *Hash_EnumFirst(const Hash_Table *, Hash_Search *);
 101 Hash_Entry *Hash_EnumNext(Hash_Search *);
 102
 103 #endif /* hash_h_f6312f46 */