6 #include "libcitadel.h"
9 typedef struct Payload Payload;
13 * \brief Hash Payload storage Structure; filled in linear.
15 void *Data; /**< the Data belonging to this storage */
16 DeleteHashDataFunc Destructor; /**< if we want to destroy Data, do it with this function. */
21 * \brief Hash key element; sorted by key
23 long Key; /**< Numeric Hashkey comperator for hash sorting */
24 long Position; /**< Pointer to a Payload struct in the Payload Aray */
25 char *HashKey; /**< the Plaintext Hashkey */
26 long HKLen; /**< length of the Plaintext Hashkey */
27 Payload *PL; /**< pointer to our payload for sorting */
32 * \brief Hash structure; holds arrays of Hashkey and Payload.
34 Payload **Members; /**< Our Payload members. This fills up linear */
35 HashKey **LookupTable; /**< Hash Lookup table. Elements point to members, and are sorted by their hashvalue */
36 char **MyKeys; /**< this keeps the members for a call of GetHashKeys */
37 HashFunc Algorithm; /**< should we use an alternating algorithm to calc the hash values? */
38 long nMembersUsed; /**< how many pointers inside of the array are used? */
39 long MemberSize; /**< how big is Members and LookupTable? */
40 long tainted; /**< if 0, we're hashed, else s.b. else sorted us in his own way. */
41 long uniq; /**< are the keys going to be uniq? */
46 * \brief Anonymous Hash Iterator Object. used for traversing the whole array from outside
53 * \brief Iterate over the hash and call PrintEntry.
54 * \param Hash your Hashlist structure
55 * \param Trans is called so you could for example print 'A:' if the next entries are like that.
56 * Must be aware to receive NULL in both pointers.
57 * \param PrintEntry print entry one by one
58 * \returns the number of items printed
60 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry)
70 for (i=0; i < Hash->nMembersUsed; i++) {
75 if (Hash->LookupTable[i - 1] == NULL)
78 Previous = Hash->Members[Hash->LookupTable[i-1]->Position]->Data;
80 if (Hash->LookupTable[i] == NULL) {
85 Next = Hash->Members[Hash->LookupTable[i]->Position]->Data;
86 KeyStr = Hash->LookupTable[i]->HashKey;
89 Trans(Previous, Next, i % 2);
90 PrintEntry(KeyStr, Next, i % 2);
97 * \brief verify the contents of a hash list; here for debugging purposes.
98 * \param Hash your Hashlist structure
99 * \param First Functionpointer to allow you to print your payload
100 * \param Second Functionpointer to allow you to print your payload
103 int dbg_PrintHash(HashList *Hash, PrintHashContent First, PrintHashContent Second)
107 const char *bla = "";
114 if (Hash->MyKeys != NULL)
117 Hash->MyKeys = (char**) malloc(sizeof(char*) * Hash->nMembersUsed);
119 printf("----------------------------------\n");
121 for (i=0; i < Hash->nMembersUsed; i++) {
123 if (Hash->LookupTable[i] == NULL)
131 key = Hash->LookupTable[i]->Key;
132 foo = Hash->LookupTable[i]->HashKey;
134 bar = First(Hash->Members[Hash->LookupTable[i]->Position]->Data);
136 bla = Second(Hash->Members[Hash->LookupTable[i]->Position]->Data);
139 printf (" ---- Hashkey[%ld][%ld]: '%s' Value: '%s' ; %s\n", i, key, foo, bar, bla);
143 printf("----------------------------------\n");
150 * \brief instanciate a new hashlist
151 * \returns the newly allocated list.
153 HashList *NewHash(int Uniq, HashFunc F)
156 NewList = malloc (sizeof(HashList));
157 memset(NewList, 0, sizeof(HashList));
159 NewList->Members = malloc(sizeof(Payload*) * 100);
160 memset(NewList->Members, 0, sizeof(Payload*) * 100);
162 NewList->LookupTable = malloc(sizeof(HashKey*) * 100);
163 memset(NewList->LookupTable, 0, sizeof(HashKey*) * 100);
165 NewList->MemberSize = 100;
166 NewList->tainted = 0;
167 NewList->uniq = Uniq;
168 NewList->Algorithm = F;
173 int GetCount(HashList *Hash)
175 if(Hash==NULL) return 0;
176 return Hash->nMembersUsed;
181 * \brief private destructor for one hash element.
182 * \param Data an element to free using the user provided destructor, or just plain free
184 static void DeleteHashPayload (Payload *Data)
186 /** do we have a destructor for our payload? */
187 if (Data->Destructor)
188 Data->Destructor(Data->Data);
194 * \brief destroy a hashlist and all of its members
195 * \param Hash Hash to destroy. Is NULL'ed so you are shure its done.
197 void DeleteHash(HashList **Hash)
205 for (i=0; i < FreeMe->nMembersUsed; i++)
207 /** get rid of our payload */
208 if (FreeMe->Members[i] != NULL)
210 DeleteHashPayload(FreeMe->Members[i]);
211 free(FreeMe->Members[i]);
213 /** delete our hashing data */
214 if (FreeMe->LookupTable[i] != NULL)
216 free(FreeMe->LookupTable[i]->HashKey);
217 free(FreeMe->LookupTable[i]);
220 /** now, free our arrays... */
221 free(FreeMe->LookupTable);
222 free(FreeMe->Members);
223 /** did s.b. want an array of our keys? free them. */
224 if (FreeMe->MyKeys != NULL)
225 free(FreeMe->MyKeys);
226 /** buye bye cruel world. */
232 * \brief Private function to increase the hash size.
233 * \param Hash the Hasharray to increase
235 static void IncreaseHashSize(HashList *Hash)
237 /* Ok, Our space is used up. Double the available space. */
238 Payload **NewPayloadArea;
244 /** double our payload area */
245 NewPayloadArea = (Payload**) malloc(sizeof(Payload*) * Hash->MemberSize * 2);
246 memset(&NewPayloadArea[Hash->MemberSize], 0, sizeof(Payload*) * Hash->MemberSize);
247 memcpy(NewPayloadArea, Hash->Members, sizeof(Payload*) * Hash->MemberSize);
249 Hash->Members = NewPayloadArea;
251 /** double our hashtable area */
252 NewTable = malloc(sizeof(HashKey*) * Hash->MemberSize * 2);
253 memset(&NewTable[Hash->MemberSize], 0, sizeof(HashKey*) * Hash->MemberSize);
254 memcpy(NewTable, Hash->LookupTable, sizeof(HashKey*) * Hash->MemberSize);
255 free(Hash->LookupTable);
256 Hash->LookupTable = NewTable;
258 Hash->MemberSize *= 2;
263 * \brief private function to add a new item to / replace an existing in - the hashlist
264 * if the hash list is full, its re-alloced with double size.
265 * \parame Hash our hashlist to manipulate
266 * \param HashPos where should we insert / replace?
267 * \param HashKeyStr the Hash-String
268 * \param HKLen length of HashKeyStr
269 * \param Data your Payload to add
270 * \param Destructor Functionpointer to free Data. if NULL, default free() is used.
272 static void InsertHashItem(HashList *Hash,
275 const char *HashKeyStr,
278 DeleteHashDataFunc Destructor)
280 Payload *NewPayloadItem;
286 if (Hash->nMembersUsed >= Hash->MemberSize)
287 IncreaseHashSize (Hash);
289 /** Arrange the payload */
290 NewPayloadItem = (Payload*) malloc (sizeof(Payload));
291 NewPayloadItem->Data = Data;
292 NewPayloadItem->Destructor = Destructor;
293 /** Arrange the hashkey */
294 NewHashKey = (HashKey*) malloc (sizeof(HashKey));
295 NewHashKey->HashKey = (char *) malloc (HKLen + 1);
296 NewHashKey->HKLen = HKLen;
297 memcpy (NewHashKey->HashKey, HashKeyStr, HKLen + 1);
298 NewHashKey->Key = HashBinKey;
299 NewHashKey->PL = NewPayloadItem;
300 /** our payload is queued at the end... */
301 NewHashKey->Position = Hash->nMembersUsed;
302 /** but if we should be sorted into a specific place... */
303 if ((Hash->nMembersUsed != 0) &&
304 (HashPos != Hash->nMembersUsed) ) {
307 ItemsAfter = Hash->nMembersUsed - HashPos;
308 /** make space were we can fill us in */
311 memmove(&Hash->LookupTable[HashPos + 1],
312 &Hash->LookupTable[HashPos],
313 ItemsAfter * sizeof(HashKey*));
317 Hash->Members[Hash->nMembersUsed] = NewPayloadItem;
318 Hash->LookupTable[HashPos] = NewHashKey;
319 Hash->nMembersUsed++;
323 * \brief if the user has tainted the hash, but wants to insert / search items by their key
324 * we need to search linear through the array. You have been warned that this will take more time!
325 * \param Hash Our Hash to manipulate
326 * \param HashBinKey the Hash-Number to lookup.
327 * \returns the position (most closely) matching HashBinKey (-> Caller needs to compare! )
329 static long FindInTaintedHash(HashList *Hash, long HashBinKey)
336 for (SearchPos = 0; SearchPos < Hash->nMembersUsed; SearchPos ++) {
337 if (Hash->LookupTable[SearchPos]->Key == HashBinKey){
345 * \brief Private function to lookup the Item / the closest position to put it in
346 * \param Hash Our Hash to manipulate
347 * \param HashBinKey the Hash-Number to lookup.
348 * \returns the position (most closely) matching HashBinKey (-> Caller needs to compare! )
350 static long FindInHash(HashList *Hash, long HashBinKey)
359 return FindInTaintedHash(Hash, HashBinKey);
361 SearchPos = Hash->nMembersUsed / 2;
362 StepWidth = SearchPos / 2;
363 while ((SearchPos > 0) &&
364 (SearchPos < Hash->nMembersUsed))
366 /** Did we find it? */
367 if (Hash->LookupTable[SearchPos]->Key == HashBinKey){
370 /** are we Aproximating in big steps? */
372 if (Hash->LookupTable[SearchPos]->Key > HashBinKey)
373 SearchPos -= StepWidth;
375 SearchPos += StepWidth;
378 else { /** We are right next to our target, within 4 positions */
379 if (Hash->LookupTable[SearchPos]->Key > HashBinKey) {
380 if ((SearchPos > 0) &&
381 (Hash->LookupTable[SearchPos - 1]->Key < HashBinKey))
386 if ((SearchPos + 1 < Hash->nMembersUsed) &&
387 (Hash->LookupTable[SearchPos + 1]->Key > HashBinKey))
398 * \brief private abstract wrapper around the hashing algorithm
399 * \param HKey the hash string
400 * \param HKLen length of HKey
401 * \returns the calculated hash value
403 inline static long CalcHashKey (HashList *Hash, const char *HKey, long HKLen)
408 if (Hash->Algorithm == NULL)
409 return hashlittle(HKey, HKLen, 9283457);
411 return Hash->Algorithm(HKey, HKLen);
416 * \brief Add a new / Replace an existing item in the Hash
417 * \param HashList the list to manipulate
418 * \param HKey the hash-string to store Data under
419 * \param HKeyLen Length of HKey
420 * \param Data the payload you want to associate with HKey
421 * \param DeleteIt if not free() should be used to delete Data set to NULL, else DeleteIt is used.
423 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt)
431 /** first, find out were we could fit in... */
432 HashBinKey = CalcHashKey(Hash, HKey, HKLen);
433 HashAt = FindInHash(Hash, HashBinKey);
435 if (HashAt >= Hash->MemberSize)
436 IncreaseHashSize (Hash);
438 /** oh, we're brand new... */
439 if (Hash->LookupTable[HashAt] == NULL) {
440 InsertHashItem(Hash, HashAt, HashBinKey, HKey, HKLen, Data, DeleteIt);
441 }/** Insert After? */
442 else if (Hash->LookupTable[HashAt]->Key > HashBinKey) {
443 InsertHashItem(Hash, HashAt, HashBinKey, HKey, HKLen, Data, DeleteIt);
444 }/** Insert before? */
445 else if (Hash->LookupTable[HashAt]->Key < HashBinKey) {
446 InsertHashItem(Hash, HashAt + 1, HashBinKey, HKey, HKLen, Data, DeleteIt);
448 else { /** Ok, we have a colision. replace it. */
452 PayloadPos = Hash->LookupTable[HashAt]->Position;
453 DeleteHashPayload(Hash->Members[PayloadPos]);
454 Hash->Members[PayloadPos]->Data = Data;
455 Hash->Members[PayloadPos]->Destructor = DeleteIt;
458 InsertHashItem(Hash, HashAt + 1, HashBinKey, HKey, HKLen, Data, DeleteIt);
464 * \brief Lookup the Data associated with HKey
465 * \param Hash the Hashlist to search in
466 * \param HKey the hashkey to look up
467 * \param HKLen length of HKey
468 * \param Data returns the Data associated with HKey
469 * \returns 0 if not found, 1 if.
471 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data)
483 /** first, find out were we could be... */
484 HashBinKey = CalcHashKey(Hash, HKey, HKLen);
485 HashAt = FindInHash(Hash, HashBinKey);
486 if ((HashAt < 0) || /**< Not found at the lower edge? */
487 (HashAt >= Hash->nMembersUsed) || /**< Not found at the upper edge? */
488 (Hash->LookupTable[HashAt]->Key != HashBinKey)) { /**< somewhere inbetween but no match? */
492 else { /** GOTCHA! */
495 MemberPosition = Hash->LookupTable[HashAt]->Position;
496 *Data = Hash->Members[MemberPosition]->Data;
502 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Payload)
508 * \brief get the Keys present in this hash, simila to array_keys() in PHP
509 * Attention: List remains to Hash! don't modify or free it!
510 * \param Hash Your Hashlist to extract the keys from
511 * \param List returns the list of hashkeys stored in Hash
513 int GetHashKeys(HashList *Hash, char ***List)
518 if (Hash->MyKeys != NULL)
521 Hash->MyKeys = (char**) malloc(sizeof(char*) * Hash->nMembersUsed);
522 for (i=0; i < Hash->nMembersUsed; i++) {
524 Hash->MyKeys[i] = Hash->LookupTable[i]->HashKey;
526 *List = (char**)Hash->MyKeys;
527 return Hash->nMembersUsed;
531 * \brief creates a hash-linear iterator object
532 * \returns the hash iterator
534 HashPos *GetNewHashPos(void)
538 Ret = (HashPos*)malloc(sizeof(HashPos));
544 * \brief frees a linear hash iterator
546 void DeleteHashPos(HashPos **DelMe)
557 * \brief Get the data located where HashPos Iterator points at, and Move HashPos one forward
558 * \param Hash your Hashlist to follow
559 * \param HKLen returns Length of Hashkey Returned
560 * \param HashKey returns the Hashkey corrosponding to HashPos
561 * \param Data returns the Data found at HashPos
562 * \returns whether the item was found or not.
564 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, char **HashKey, void **Data)
568 if ((Hash == NULL) || (Hash->nMembersUsed <= At->Position))
570 *HKLen = Hash->LookupTable[At->Position]->HKLen;
571 *HashKey = Hash->LookupTable[At->Position]->HashKey;
572 PayloadPos = Hash->LookupTable[At->Position]->Position;
573 *Data = Hash->Members[PayloadPos]->Data;
579 * \brief sorting function for sorting the Hash alphabeticaly by their strings
580 * \param Key1 first item
581 * \param Key2 second item
583 static int SortByKeys(const void *Key1, const void* Key2)
585 HashKey *HKey1, *HKey2;
586 HKey1 = *(HashKey**) Key1;
587 HKey2 = *(HashKey**) Key2;
589 return strcasecmp(HKey1->HashKey, HKey2->HashKey);
593 * \brief sorting function for sorting the Hash alphabeticaly reverse by their strings
594 * \param Key1 first item
595 * \param Key2 second item
597 static int SortByKeysRev(const void *Key1, const void* Key2)
599 HashKey *HKey1, *HKey2;
600 HKey1 = *(HashKey**) Key1;
601 HKey2 = *(HashKey**) Key2;
603 return strcasecmp(HKey2->HashKey, HKey1->HashKey);
607 * \brief sorting function to regain hash-sequence and revert tainted status
608 * \param Key1 first item
609 * \param Key2 second item
611 static int SortByHashKeys(const void *Key1, const void* Key2)
613 HashKey *HKey1, *HKey2;
614 HKey1 = *(HashKey**) Key1;
615 HKey2 = *(HashKey**) Key2;
617 return HKey1->Key > HKey2->Key;
622 * \brief sort the hash alphabeticaly by their keys.
623 * Caution: This taints the hashlist, so accessing it later
624 * will be significantly slower! You can un-taint it by SortByHashKeyStr
625 * \param Hash the list to sort
626 * \param Order 0/1 Forward/Backward
628 void SortByHashKey(HashList *Hash, int Order)
630 if (Hash->nMembersUsed < 2)
632 qsort(Hash->LookupTable, Hash->nMembersUsed, sizeof(HashKey*),
633 (Order)?SortByKeys:SortByKeysRev);
638 * \brief sort the hash by their keys (so it regains untainted state).
639 * this will result in the sequence the hashing allgorithm produces it by default.
640 * \param Hash the list to sort
642 void SortByHashKeyStr(HashList *Hash)
645 if (Hash->nMembersUsed < 2)
647 qsort(Hash->LookupTable, Hash->nMembersUsed, sizeof(HashKey*), SortByHashKeys);
652 * \brief gives user sort routines access to the hash payload
653 * \param Searchentry to retrieve Data to
654 * \returns Data belonging to HashVoid
656 const void *GetSearchPayload(const void *HashVoid)
658 return (*(HashKey**)HashVoid)->PL->Data;
662 * \brief sort the hash by your sort function. see the following sample.
663 * this will result in the sequence the hashing allgorithm produces it by default.
664 * \param Hash the list to sort
665 * \param SortBy Sortfunction; see below how to implement this
667 void SortByPayload(HashList *Hash, CompareFunc SortBy)
669 if (Hash->nMembersUsed < 2)
671 qsort(Hash->LookupTable, Hash->nMembersUsed, sizeof(HashKey*), SortBy);
679 * given you've put char * into your hash as a payload, a sort function might
681 * int SortByChar(const void* First, const void* Second)
684 * a = (char*) GetSearchPayload(First);
685 * b = (char*) GetSearchPayload(Second);
686 * return strcmp (a, b);
692 * Generic function to free a pointer. This can be used as a callback with the
693 * hash table, even on systems where free() is defined as a macro or has had other
694 * horrible things done to it.
696 void generic_free_handler(void *ptr) {