1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
/*
* Copyright (c) 2004, Stefan Walter
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above
* copyright notice, this list of conditions and the
* following disclaimer.
* * Redistributions in binary form must reproduce the
* above copyright notice, this list of conditions and
* the following disclaimer in the documentation and/or
* other materials provided with the distribution.
* * The names of contributors to this software may not be
* used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
* THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*/
/*
* Originally from apache 2.0
* Modifications for general use by <stef@memberwebs.com>
*/
/* Copyright 2000-2004 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef __HSH_H__
#define __HSH_H__
/*
* ARGUMENT DOCUMENTATION
*
* ht: The hashtable
* key: Pointer to the key value
* klen: The length of the key
* val: Pointer to the value
* hi: A hashtable iterator
* stamp: A unix timestamp
*/
/* ----------------------------------------------------------------------------------
* TYPES
*/
/* Abstract type for hash tables. */
typedef struct hsh_t hsh_t;
/* Abstract type for scanning hash tables. */
typedef struct hsh_index_t hsh_index_t;
/* -----------------------------------------------------------------------------
* MAIN
*/
/*
* hsh_create : Create a hash table
* - returns an allocated hashtable
*/
hsh_t* hsh_create();
/*
* hsh_free : Free a hash table
*/
void hsh_free(hsh_t* ht);
/*
* hsh_count: Number of values in hash table
* - returns the number of entries in hash table
*/
unsigned int hsh_count(hsh_t* ht);
/*
* hsh_get: Retrieves a value from the hash table
* - returns the value of the entry
*/
void* hsh_get(hsh_t* ht, const void* key, size_t klen);
/*
* hsh_set: Set a value in the hash table
* - returns 1 if the entry was added properly
*/
int hsh_set(hsh_t* ht, const void* key, size_t klen, void* val);
/*
* hsh_rem: Remove a value from the hash table
* - returns the value of the removed entry
*/
void* hsh_rem(hsh_t* ht, const void* key, size_t klen);
/*
* hsh_first: Start enumerating through the hash table
* - returns a hash iterator
*/
hsh_index_t* hsh_first(hsh_t* ht);
/*
* hsh_next: Enumerate through hash table
* - returns the hash iterator or null when no more entries
*/
hsh_index_t* hsh_next(hsh_index_t* hi);
/*
* hsh_this: While enumerating get current value
* - returns the value that the iterator currently points to
*/
void* hsh_this(hsh_index_t* hi, const void** key, size_t* klen);
/*
* hsh_clear: Clear all values from has htable.
*/
void hsh_clear(hsh_t* ht);
/*
* This can be passed as 'klen' in any of the above functions to indicate
* a string-valued key, and have hash compute the length automatically.
*/
#define HSH_KEY_STRING (-1)
/*
* This can be passed as 'klen' in any of the above functions to indicate
* use of the key pointer directly as a hash.
*/
#define HSH_KEY_DIRECT (-2)
#endif /* __HSH_H__ */
|
