summaryrefslogtreecommitdiffstats
path: root/veslibrary/ves_clibrary/evel/evel-library/code/evel_library/hashtable.h
blob: a0b2fb76272f832146b59bdb6629bae3db6451f0 (plain)
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
#ifndef HASHTABLE_INCLUDED
#define HASHTABLE_INCLUDED

/*************************************************************************//**
 *
 * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
 *
 * 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.
 *
 ****************************************************************************/

/**************************************************************************//**
 * @file
 * A flexible dynamic hashtable
 *
 * @note  No thread protection so you will need to use appropriate
 * synchronization if use spans multiple threads.
*****************************************************************************/

typedef struct entry_s {
	char *key;
	void *value;
	struct entry_s *next;
} ENTRY_T;

/**************************************************************************//**
 * Hashtable structure
 *****************************************************************************/

typedef struct hashtable_s {
	size_t size;
	int n;
        char *hmName;
	struct entry_s **table;	
} HASHTABLE_T;

typedef struct hashtable_s *HASHTABLE;

#define INITIAL_SIZE (2)
#define GROWTH_FACTOR (2)
#define MAX_LOAD_FACTOR (2)

/**************************************************************************//**
 * Hashtable initialization.
 *
 * Initialize hashtable internal finction
 * @param   size  Size of hashtable
 * @returns Hashtable 
******************************************************************************/
/* Create a new hashtable. */
HASHTABLE_T *ht_sizecreate( size_t size );

/**************************************************************************//**
 * Hashtable initialization.
 *
 * Initialize hashtable default function
 * @returns Hashtable
******************************************************************************/
HASHTABLE_T *ht_create(void);

/**************************************************************************//**
 * Named Hashtable initialization.
 *
 * Initialize Named hashtable default function
 * @param hashtable_name
 * @returns Hashtable
******************************************************************************/
HASHTABLE_T *nht_create(char * hashtable_name);

/**************************************************************************//**
 * Hashtable Destruction
 *
 * Initialize hashtable destroy function
 * @returns Hashtable
******************************************************************************/
void ht_destroy(HASHTABLE_T *hashtable);


/**************************************************************************//**
 * Hash a string for a particular hash table.
 *
 * Initialize the list supplied to be empty.
 *
 * @param   hashtable    Pointer to the hashtable
 * @param   key          String

 * @returns hashvalue
******************************************************************************/
size_t ht_hash( HASHTABLE_T* hashtable, char *key );

/**************************************************************************//**
 * Create a key-value pair.
 *
 * @param   key     key string
 * @param   value   value string
 *
 * @returns hashtable entry
******************************************************************************/
ENTRY_T *ht_newpair( char *key, void *value );

/**************************************************************************//**
 * Insert a key-value pair into a hash table.
 *
 * @param   key     key string
 * @param   value   value string
 *
 * @returns Nothing
******************************************************************************/
void ht_insert( HASHTABLE_T* hashtable, char *key, void *value );

/**************************************************************************//**
 *  Retrieve a key-value pair from a hash table.
 *
 * @param   key     key string
 *
 * @returns  value string
******************************************************************************/
void *ht_search( HASHTABLE_T* hashtable, char *key );

/**************************************************************************//**
 *  Delete a key-value pair from a hash table.
 *
 * @param   key     key string
 *
 * @returns  value string
******************************************************************************/
void ht_delete( HASHTABLE_T* hashtable, char *key );


#endif