4
** The author disclaims copyright to this source code. In place of
5
** a legal notice, here is a blessing:
7
** May you do good and not evil.
8
** May you find forgiveness for yourself and forgive others.
9
** May you share freely, never taking more than you give.
11
*************************************************************************
12
** This is the header file for the generic hash-table implemenation
15
** $Id: hash.h,v 1.8 2004/08/20 14:08:51 drh Exp $
17
#ifndef _SQLITE_HASH_H_
18
#define _SQLITE_HASH_H_
20
/* Forward declarations of structures. */
21
typedef struct Hash Hash;
22
typedef struct HashElem HashElem;
24
/* A complete hash table is an instance of the following structure.
25
** The internals of this structure are intended to be opaque -- client
26
** code should not attempt to access or modify the fields of this structure
27
** directly. Change this structure only by using the routines below.
28
** However, many of the "procedures" and "functions" for modifying and
29
** accessing this structure are really macros, so we can't really make
30
** this structure opaque.
33
char keyClass; /* SQLITE_HASH_INT, _POINTER, _STRING, _BINARY */
34
char copyKey; /* True if copy of key made on insert */
35
int count; /* Number of entries in this table */
36
HashElem *first; /* The first element of the array */
37
int htsize; /* Number of buckets in the hash table */
38
struct _ht { /* the hash table */
39
int count; /* Number of entries with this hash */
40
HashElem *chain; /* Pointer to first entry with this hash */
44
/* Each element in the hash table is an instance of the following
45
** structure. All elements are stored on a single doubly-linked list.
47
** Again, this structure is intended to be opaque, but it can't really
48
** be opaque because it is used by macros.
51
HashElem *next, *prev; /* Next and previous elements in the table */
52
void *data; /* Data associated with this element */
53
void *pKey; int nKey; /* Key associated with this element */
57
** There are 4 different modes of operation for a hash table:
59
** SQLITE_HASH_INT nKey is used as the key and pKey is ignored.
61
** SQLITE_HASH_POINTER pKey is used as the key and nKey is ignored.
63
** SQLITE_HASH_STRING pKey points to a string that is nKey bytes long
64
** (including the null-terminator, if any). Case
65
** is ignored in comparisons.
67
** SQLITE_HASH_BINARY pKey points to binary data nKey bytes long.
68
** memcmp() is used to compare keys.
70
** A copy of the key is made for SQLITE_HASH_STRING and SQLITE_HASH_BINARY
71
** if the copyKey parameter to HashInit is 1.
73
/* #define SQLITE_HASH_INT 1 // NOT USED */
74
/* #define SQLITE_HASH_POINTER 2 // NOT USED */
75
#define SQLITE_HASH_STRING 3
76
#define SQLITE_HASH_BINARY 4
79
** Access routines. To delete, insert a NULL pointer.
81
void sqlite3HashInit(Hash*, int keytype, int copyKey);
82
void *sqlite3HashInsert(Hash*, const void *pKey, int nKey, void *pData);
83
void *sqlite3HashFind(const Hash*, const void *pKey, int nKey);
84
void sqlite3HashClear(Hash*);
87
** Macros for looping over all elements of a hash table. The idiom is
93
** for(p=sqliteHashFirst(&h); p; p=sqliteHashNext(p)){
94
** SomeStructure *pData = sqliteHashData(p);
95
** // do something with pData
98
#define sqliteHashFirst(H) ((H)->first)
99
#define sqliteHashNext(E) ((E)->next)
100
#define sqliteHashData(E) ((E)->data)
101
#define sqliteHashKey(E) ((E)->pKey)
102
#define sqliteHashKeysize(E) ((E)->nKey)
105
** Number of entries in a hash table
107
#define sqliteHashCount(H) ((H)->count)
109
#endif /* _SQLITE_HASH_H_ */