Imported Upstream version 3.13.6
[platform/upstream/nss.git] / mozilla / security / nss / lib / libpkix / pkix_pl_nss / system / pkix_pl_primhash.h
1 /* ***** BEGIN LICENSE BLOCK *****
2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3  *
4  * The contents of this file are subject to the Mozilla Public License Version
5  * 1.1 (the "License"); you may not use this file except in compliance with
6  * the License. You may obtain a copy of the License at
7  * http://www.mozilla.org/MPL/
8  *
9  * Software distributed under the License is distributed on an "AS IS" basis,
10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11  * for the specific language governing rights and limitations under the
12  * License.
13  *
14  * The Original Code is the PKIX-C library.
15  *
16  * The Initial Developer of the Original Code is
17  * Sun Microsystems, Inc.
18  * Portions created by the Initial Developer are
19  * Copyright 2004-2007 Sun Microsystems, Inc.  All Rights Reserved.
20  *
21  * Contributor(s):
22  *   Sun Microsystems, Inc.
23  *
24  * Alternatively, the contents of this file may be used under the terms of
25  * either the GNU General Public License Version 2 or later (the "GPL"), or
26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27  * in which case the provisions of the GPL or the LGPL are applicable instead
28  * of those above. If you wish to allow use of your version of this file only
29  * under the terms of either the GPL or the LGPL, and not to allow others to
30  * use your version of this file under the terms of the MPL, indicate your
31  * decision by deleting the provisions above and replace them with the notice
32  * and other provisions required by the GPL or the LGPL. If you do not delete
33  * the provisions above, a recipient may use your version of this file under
34  * the terms of any one of the MPL, the GPL or the LGPL.
35  *
36  * ***** END LICENSE BLOCK ***** */
37 /*
38  * pkix_pl_primhash.h
39  *
40  * Primitive Hashtable Definition
41  *
42  */
43
44 #ifndef _PKIX_PL_PRIMHASH_H
45 #define _PKIX_PL_PRIMHASH_H
46
47 #include "pkix_pl_common.h"
48
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52
53 typedef struct pkix_pl_HT_Elem pkix_pl_HT_Elem;
54
55 typedef struct pkix_pl_PrimHashTable pkix_pl_PrimHashTable;
56
57 typedef struct pkix_pl_Integer pkix_pl_Integer;
58
59 struct pkix_pl_Integer{
60         PKIX_UInt32 ht_int;
61 };
62
63 struct pkix_pl_HT_Elem {
64         void *key;
65         void *value;
66         PKIX_UInt32 hashCode;
67         pkix_pl_HT_Elem *next;
68 };
69
70 struct pkix_pl_PrimHashTable {
71         pkix_pl_HT_Elem **buckets;
72         PKIX_UInt32 size;
73 };
74
75 /* see source file for function documentation */
76
77 PKIX_Error *
78 pkix_pl_PrimHashTable_Create(
79         PKIX_UInt32 numBuckets,
80         pkix_pl_PrimHashTable **pResult,
81         void *plContext);
82
83 PKIX_Error *
84 pkix_pl_PrimHashTable_Add(
85         pkix_pl_PrimHashTable *ht,
86         void *key,
87         void *value,
88         PKIX_UInt32 hashCode,
89         PKIX_PL_EqualsCallback keyComp,
90         void *plContext);
91
92 PKIX_Error *
93 pkix_pl_PrimHashTable_Remove(
94         pkix_pl_PrimHashTable *ht,
95         void *key,
96         PKIX_UInt32 hashCode,
97         PKIX_PL_EqualsCallback keyComp,
98         void **pKey,
99         void **pValue,
100         void *plContext);
101
102 PKIX_Error *
103 pkix_pl_PrimHashTable_Lookup(
104         pkix_pl_PrimHashTable *ht,
105         void *key,
106         PKIX_UInt32 hashCode,
107         PKIX_PL_EqualsCallback keyComp,
108         void **pResult,
109         void *plContext);
110
111 PKIX_Error*
112 pkix_pl_PrimHashTable_Destroy(
113         pkix_pl_PrimHashTable *ht,
114         void *plContext);
115
116 PKIX_Error *
117 pkix_pl_PrimHashTable_GetBucketSize(
118         pkix_pl_PrimHashTable *ht,
119         PKIX_UInt32 hashCode,
120         PKIX_UInt32 *pBucketSize,
121         void *plContext);
122
123 PKIX_Error *
124 pkix_pl_PrimHashTable_RemoveFIFO(
125         pkix_pl_PrimHashTable *ht,
126         PKIX_UInt32 hashCode,
127         void **pKey,
128         void **pValue,
129         void *plContext);
130
131 #ifdef __cplusplus
132 }
133 #endif
134
135 #endif /* _PKIX_PL_PRIMHASH_H */