2 /* $NetBSD: hash.h,v 1.1.1.1 1999/11/19 04:30:56 mrg Exp $ */
5 * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
6 * Copyright (c) 1988, 1989 by Adam de Boor
7 * Copyright (c) 1989 by Berkeley Softworks
10 * This code is derived from software contributed to Berkeley by
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. All advertising materials mentioning features or use of this software
22 * must display the following acknowledgement:
23 * This product includes software developed by the University of
24 * California, Berkeley and its contributors.
25 * 4. Neither the name of the University nor the names of its contributors
26 * may be used to endorse or promote products derived from this software
27 * without specific prior written permission.
29 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
30 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
31 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
33 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
34 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
35 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
37 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
38 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
41 * from: @(#)hash.h 8.1 (Berkeley) 6/6/93
46 * This file contains definitions used by the hash module,
47 * which maintains hash tables.
54 * The following defines one entry in the hash table.
57 typedef struct Hash_Entry {
58 struct Hash_Entry *next; /* Used to link together all the
59 * entries associated with the same
61 ClientData clientData; /* Arbitrary piece of data associated
63 unsigned namehash; /* hash value of key */
64 char name[1]; /* key string */
67 typedef struct Hash_Table {
68 struct Hash_Entry **bucketPtr;
69 /* 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. */
77 * The following structure is used by the searching routines
78 * to record where we are in the search.
81 typedef struct Hash_Search {
82 Hash_Table *tablePtr; /* Table being searched. */
83 int nextIndex; /* Next bucket to check (after
85 Hash_Entry *hashEntryPtr; /* Next entry to check in current
94 * ClientData Hash_GetValue(h)
98 #define Hash_GetValue(h) ((h)->clientData)
101 * Hash_SetValue(h, val);
106 #define Hash_SetValue(h, val) ((h)->clientData = (ClientData) (val))
114 #define Hash_GetKey(h) ((h)->name)
118 * Hash_Size(n) returns the number of words in an object of n bytes
121 #define Hash_Size(n) (((n) + sizeof (int) - 1) / sizeof (int))
123 void Hash_InitTable(Hash_Table *, int);
124 void Hash_DeleteTable(Hash_Table *);
125 Hash_Entry *Hash_FindEntry(Hash_Table *, char *);
126 Hash_Entry *Hash_CreateEntry(Hash_Table *, char *, Boolean *);
127 void Hash_DeleteEntry(Hash_Table *, Hash_Entry *);
128 Hash_Entry *Hash_EnumFirst(Hash_Table *, Hash_Search *);
129 Hash_Entry *Hash_EnumNext(Hash_Search *);