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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
/*@@
@file StoreKeyedData.c
@date Tue Sep 1 09:57:57 1998
@author Tom Goodale
@desc
Contains routines to store pointers to miscellaneous keyed data
and to search for a particular piece of data.
@enddesc
@version $ID$
@@*/
#include <stdio.h>
#include <stdlib.h>
#include "cctk_Flesh.h"
#include "StoreKeyedData.h"
static const char *rcsid = "$Header$";
CCTK_FILEVERSION(util_StoreKeyedData_c);
/*@@
@routine StoreKeyedData
@date Tue Sep 1 09:59:09 1998
@author Tom Goodale
@desc
Stores a piece of data.
@enddesc
@calls
@calledby
@history
@endhistory
@var list
@vdesc A pointer to the list to store the data in
@vtype pKeyedData **
@vio inout
@vcomment
This should be a pointer to NULL to create a new list.
@endvar
@var key
@vdesc An integer containing the key of the data item
@vtype int
@vio in
@vcomment
@endvar
@var data
@vdesc The data to store
@vtype void *
@vio in
@vcomment
This is a void pointer to any sort of data.
@endvar
@returntype int
@returndesc
This routine returns
0 on success
1 if memory allocation failed
@endreturndesc
@@*/
int StoreKeyedData(pKeyedData **storage, int key, void *data)
{
int return_code;
pKeyedData *new;
/* Allocate memory for the new element on the list. */
new = (pKeyedData *)malloc(sizeof(pKeyedData));
if(new)
{
/* Store the key */
new->key = key;
/* Store the data. */
new->data = data;
/* Link it into the list. */
new->next = (*storage);
new->last = NULL;
if(new->next) new->next->last = new;
(*storage) = new;
return_code = 0;
}
else
{
return_code = 1;
};
return return_code;
}
/*@@
@routine GetKeyedData
@date Tue Sep 1 10:11:10 1998
@author Tom Goodale
@desc
Searches for a keyed data item and returns the appropriate data.
@enddesc
@calls
@calledby
@history
@endhistory
@var list
@vdesc The keyed data storage the data in
@vtype pKeyedData *
@vio in
@vcomment
If this is a pointer to NULL, the routine returns immediately.
@endvar
@var key
@vdesc An integer containing the key of the data item
@vtype int
@vio in
@vcomment
@endvar
@returntype void *
@returndesc
This routine returns
a pointer to the data on success
NULL if the list is NULL or the key was not found.
@endreturndesc
@@*/
void *GetKeyedData(pKeyedData *storage, int key)
{
void *return_val;
pKeyedData *current;
return_val = NULL;
if(storage)
{
/* Traverse the list */
for(current = storage; current ; current = current->next)
{
/* Compare the key */
if(current->key == key)
{
return_val = current->data;
break;
};
};
};
return return_val;
}
/*@@
@routine DestroyKeyedData
@date Tue Sep 1 10:40:49 1998
@author Tom Goodale
@desc
Frees the memory allocated for keyed data storage.
@enddesc
@calls
@calledby
@history
@endhistory
@var storage
@vdesc The storage to destroy.
@vtype pKeyedData *
@vio in
@vcomment
If this is a pointer to NULL, the routine returns immediately.
@endvar
@@*/
void DestroyKeyedData(pKeyedData *storage)
{
pKeyedData *current;
pKeyedData *next;
/* Traverse the list freeing memory. */
for(current = storage; current; current = next)
{
next = current->next;
free(current);
};
}
/*#define TEST_StoreKeyedData*/
#ifdef TEST_StoreKeyedData
/* Test routine to allow the above code to be tested independently of
* other code.
*/
static int first_key = 1;
static char first_data[] = "First Data";
static int second_key = 2;
static char second_data[] = "Second Data";
static int third_key = 3;
static char third_data[] = "Third Data";
#define DETECT_ERROR(error) if(error) {printf("Error on line %d\n", __LINE__); exit(1);}
int main(void)
{
pKeyedData *list;
char *data;
list = NULL;
/* Test creation of the list. */
DETECT_ERROR(StoreKeyedData(&list, first_key, first_data));
DETECT_ERROR(StoreKeyedData(&list, second_key, second_data));
DETECT_ERROR(StoreKeyedData(&list, third_key, third_data));
/* Test accessing the data. */
if((data = GetKeyedData(list, first_key)))
{
printf("Key %d has data %s\n", first_key, data);
};
if((data = GetKeyedData(list, second_key)))
{
printf("Key %d has data %s\n", second_key, data);
};
if((data = GetKeyedData(list, third_key)))
{
printf("Key %d has data %s\n", third_key, data);
};
/* test destroying the list. */
DestroyKeyedData(list);
list = NULL;
return 0;
}
#endif
|
