libcitadel/lib/hash.c

   1 #include <stdint.h>
   2 #include <stdlib.h>
   3 #include <string.h>
   4 //dbg
   5 #include <stdio.h>
   6 #include "libcitadel.h"
   7 #include "lookup3.h"
   8
   9 typedef struct Payload Payload;
  10
  11 struct Payload {
  12         /**
  13          * \brief Hash Payload storage Structure; filled in linear.
  14          */
  15         void *Data; /**< the Data belonging to this storage */
  16         DeleteHashDataFunc Destructor; /**< if we want to destroy Data, do it with this function. */
  17 };
  18
  19 struct HashKey {
  20         /**
  21          * \brief Hash key element; sorted by key
  22          */
  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 */
  28 };
  29
  30 struct HashList {
  31         /**
  32          * \brief Hash structure; holds arrays of Hashkey and Payload.
  33          */
  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? */
  42 };
  43
  44 struct HashPos {
  45         /**
  46          * \brief Anonymous Hash Iterator Object. used for traversing the whole array from outside
  47          */
  48         long Position;
  49 };
  50
  51
  52 /**
  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
  59  */
  60 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry)
  61 {
  62         int i;
  63         void *Previous;
  64         void *Next;
  65         const char* KeyStr;
  66
  67         for (i=0; i < Hash->nMembersUsed; i++) {
  68                 if (i==0) {
  69                         Previous = NULL;
  70                 }
  71                 else {
  72                         if (Hash->LookupTable[i - 1] == NULL)
  73                                 Previous = NULL;
  74                         else
  75                                 Previous = Hash->Members[Hash->LookupTable[i-1]->Position]->Data;
  76                 }
  77                 if (Hash->LookupTable[i] == NULL) {
  78                         KeyStr = "";
  79                         Next = NULL;
  80                 }
  81                 else {
  82                         Next = Hash->Members[Hash->LookupTable[i]->Position]->Data;
  83                         KeyStr = Hash->LookupTable[i]->HashKey;
  84                 }
  85
  86                 Trans(Previous, Next, i % 2);
  87                 PrintEntry(KeyStr, Next, i % 2);
  88         }
  89         return i;
  90 }
  91
  92
  93 /**
  94  * \brief verify the contents of a hash list; here for debugging purposes.
  95  * \param Hash your Hashlist structure
  96  * \param First Functionpointer to allow you to print your payload
  97  * \param Second Functionpointer to allow you to print your payload
  98  * \returns 0
  99  */
 100 int dbg_PrintHash(HashList *Hash, PrintHashContent First, PrintHashContent Second)
 101 {
 102         const char *foo;
 103         const char *bar;
 104         const char *bla = "";
 105         long key;
 106         long i;
 107         if (Hash->MyKeys != NULL)
 108                 free (Hash->MyKeys);
 109
 110         Hash->MyKeys = (char**) malloc(sizeof(char*) * Hash->nMembersUsed);
 111 #ifdef DEBUG
 112         printf("----------------------------------\n");
 113 #endif
 114         for (i=0; i < Hash->nMembersUsed; i++) {
 115
 116                 if (Hash->LookupTable[i] == NULL)
 117                 {
 118                         foo = "";
 119                         bar = "";
 120                         key = 0;
 121                 }
 122                 else
 123                 {
 124                         key = Hash->LookupTable[i]->Key;
 125                         foo = Hash->LookupTable[i]->HashKey;
 126                         if (First != NULL)
 127                                 bar = First(Hash->Members[Hash->LookupTable[i]->Position]->Data);
 128                         if (Second != NULL)
 129                                 bla = Second(Hash->Members[Hash->LookupTable[i]->Position]->Data);
 130                 }
 131 #ifdef DEBUG
 132                 printf (" ---- Hashkey[%ld][%ld]: '%s' Value: '%s' ; %s\n", i, key, foo, bar, bla);
 133 #endif
 134         }
 135 #ifdef DEBUG
 136         printf("----------------------------------\n");
 137 #endif
 138         return 0;
 139 }
 140
 141
 142 /**
 143  * \brief instanciate a new hashlist
 144  * \returns the newly allocated list.
 145  */
 146 HashList *NewHash(int Uniq, HashFunc F)
 147 {
 148         HashList *NewList;
 149         NewList = malloc (sizeof(HashList));
 150         memset(NewList, 0, sizeof(HashList));
 151
 152         NewList->Members = malloc(sizeof(Payload*) * 100);
 153         memset(NewList->Members, 0, sizeof(Payload*) * 100);
 154
 155         NewList->LookupTable = malloc(sizeof(HashKey*) * 100);
 156         memset(NewList->LookupTable, 0, sizeof(HashKey*) * 100);
 157
 158         NewList->MemberSize = 100;
 159         NewList->tainted = 0;
 160         NewList->uniq = Uniq;
 161         NewList->Algorithm = F;
 162
 163         return NewList;
 164 }
 165
 166 int GetCount(HashList *Hash)
 167 {
 168         return Hash->nMembersUsed;
 169 }
 170
 171
 172 /**
 173  * \brief private destructor for one hash element.
 174  * \param Data an element to free using the user provided destructor, or just plain free
 175  */
 176 static void DeleteHashPayload (Payload *Data)
 177 {
 178         /** do we have a destructor for our payload? */
 179         if (Data->Destructor)
 180                 Data->Destructor(Data->Data);
 181         else
 182                 free(Data->Data);
 183 }
 184
 185 /**
 186  * \brief destroy a hashlist and all of its members
 187  * \param Hash Hash to destroy. Is NULL'ed so you are shure its done.
 188  */
 189 void DeleteHash(HashList **Hash)
 190 {
 191         int i;
 192         HashList *FreeMe;
 193
 194         FreeMe = *Hash;
 195         if (FreeMe == NULL)
 196                 return;
 197         for (i=0; i < FreeMe->nMembersUsed; i++)
 198         {
 199                 /** get rid of our payload */
 200                 if (FreeMe->Members[i] != NULL)
 201                 {
 202                         DeleteHashPayload(FreeMe->Members[i]);
 203                         free(FreeMe->Members[i]);
 204                 }
 205                 /** delete our hashing data */
 206                 if (FreeMe->LookupTable[i] != NULL)
 207                 {
 208                         free(FreeMe->LookupTable[i]->HashKey);
 209                         free(FreeMe->LookupTable[i]);
 210                 }
 211         }
 212         /** now, free our arrays... */
 213         free(FreeMe->LookupTable);
 214         free(FreeMe->Members);
 215         /** did s.b. want an array of our keys? free them. */
 216         if (FreeMe->MyKeys != NULL)
 217                 free(FreeMe->MyKeys);
 218         /** buye bye cruel world. */
 219         free (FreeMe);
 220         *Hash = NULL;
 221 }
 222
 223 /**
 224  * \brief Private function to increase the hash size.
 225  * \param Hash the Hasharray to increase
 226  */
 227 static void IncreaseHashSize(HashList *Hash)
 228 {
 229         /* Ok, Our space is used up. Double the available space. */
 230         Payload **NewPayloadArea;
 231         HashKey **NewTable;
 232
 233         /** double our payload area */
 234         NewPayloadArea = (Payload**) malloc(sizeof(Payload*) * Hash->MemberSize * 2);
 235         memset(&NewPayloadArea[Hash->MemberSize], 0, sizeof(Payload*) * Hash->MemberSize);
 236         memcpy(NewPayloadArea, Hash->Members, sizeof(Payload*) * Hash->MemberSize);
 237         free(Hash->Members);
 238         Hash->Members = NewPayloadArea;
 239
 240         /** double our hashtable area */
 241         NewTable = malloc(sizeof(HashKey*) * Hash->MemberSize * 2);
 242         memset(&NewTable[Hash->MemberSize], 0, sizeof(HashKey*) * Hash->MemberSize);
 243         memcpy(NewTable, Hash->LookupTable, sizeof(HashKey*) * Hash->MemberSize);
 244         free(Hash->LookupTable);
 245         Hash->LookupTable = NewTable;
 246
 247         Hash->MemberSize *= 2;
 248 }
 249
 250
 251 /**
 252  * \brief private function to add a new item to / replace an existing in -  the hashlist
 253  * if the hash list is full, its re-alloced with double size.
 254  * \parame Hash our hashlist to manipulate
 255  * \param HashPos where should we insert / replace?
 256  * \param HashKeyStr the Hash-String
 257  * \param HKLen length of HashKeyStr
 258  * \param Data your Payload to add
 259  * \param Destructor Functionpointer to free Data. if NULL, default free() is used.
 260  */
 261 static void InsertHashItem(HashList *Hash,
 262                            long HashPos,
 263                            long HashBinKey,
 264                            const char *HashKeyStr,
 265                            long HKLen,
 266                            void *Data,
 267                            DeleteHashDataFunc Destructor)
 268 {
 269         Payload *NewPayloadItem;
 270         HashKey *NewHashKey;
 271
 272         if (Hash->nMembersUsed >= Hash->MemberSize)
 273                 IncreaseHashSize (Hash);
 274
 275         /** Arrange the payload */
 276         NewPayloadItem = (Payload*) malloc (sizeof(Payload));
 277         NewPayloadItem->Data = Data;
 278         NewPayloadItem->Destructor = Destructor;
 279         /** Arrange the hashkey */
 280         NewHashKey = (HashKey*) malloc (sizeof(HashKey));
 281         NewHashKey->HashKey = (char *) malloc (HKLen + 1);
 282         NewHashKey->HKLen = HKLen;
 283         memcpy (NewHashKey->HashKey, HashKeyStr, HKLen + 1);
 284         NewHashKey->Key = HashBinKey;
 285         NewHashKey->PL = NewPayloadItem;
 286         /** our payload is queued at the end... */
 287         NewHashKey->Position = Hash->nMembersUsed;
 288         /** but if we should be sorted into a specific place... */
 289         if ((Hash->nMembersUsed != 0) &&
 290             (HashPos != Hash->nMembersUsed) ) {
 291                 long ItemsAfter;
 292
 293                 ItemsAfter = Hash->nMembersUsed - HashPos;
 294                 /** make space were we can fill us in */
 295                 if (ItemsAfter > 0)
 296                 {
 297                         memmove(&Hash->LookupTable[HashPos + 1],
 298                                 &Hash->LookupTable[HashPos],
 299                                 ItemsAfter * sizeof(HashKey*));
 300                 }
 301         }
 302
 303         Hash->Members[Hash->nMembersUsed] = NewPayloadItem;
 304         Hash->LookupTable[HashPos] = NewHashKey;
 305         Hash->nMembersUsed++;
 306 }
 307
 308 /**
 309  * \brief if the user has tainted the hash, but wants to insert / search items by their key
 310  *  we need to search linear through the array. You have been warned that this will take more time!
 311  * \param Hash Our Hash to manipulate
 312  * \param HashBinKey the Hash-Number to lookup.
 313  * \returns the position (most closely) matching HashBinKey (-> Caller needs to compare! )
 314  */
 315 static long FindInTaintedHash(HashList *Hash, long HashBinKey)
 316 {
 317         long SearchPos;
 318
 319         for (SearchPos = 0; SearchPos < Hash->nMembersUsed; SearchPos ++) {
 320                 if (Hash->LookupTable[SearchPos]->Key == HashBinKey){
 321                         return SearchPos;
 322                 }
 323         }
 324         return SearchPos;
 325 }
 326
 327 /**
 328  * \brief Private function to lookup the Item / the closest position to put it in
 329  * \param Hash Our Hash to manipulate
 330  * \param HashBinKey the Hash-Number to lookup.
 331  * \returns the position (most closely) matching HashBinKey (-> Caller needs to compare! )
 332  */
 333 static long FindInHash(HashList *Hash, long HashBinKey)
 334 {
 335         long SearchPos;
 336         long StepWidth;
 337
 338         if (Hash->tainted)
 339                 return FindInTaintedHash(Hash, HashBinKey);
 340
 341         SearchPos = Hash->nMembersUsed / 2;
 342         StepWidth = SearchPos / 2;
 343         while ((SearchPos > 0) &&
 344                (SearchPos < Hash->nMembersUsed))
 345         {
 346                 /** Did we find it? */
 347                 if (Hash->LookupTable[SearchPos]->Key == HashBinKey){
 348                         return SearchPos;
 349                 }
 350                 /** are we Aproximating in big steps? */
 351                 if (StepWidth > 1){
 352                         if (Hash->LookupTable[SearchPos]->Key > HashBinKey)
 353                                 SearchPos -= StepWidth;
 354                         else
 355                                 SearchPos += StepWidth;
 356                         StepWidth /= 2;
 357                 }
 358                 else { /** We are right next to our target, within 4 positions */
 359                         if (Hash->LookupTable[SearchPos]->Key > HashBinKey) {
 360                                 if ((SearchPos > 0) &&
 361                                     (Hash->LookupTable[SearchPos - 1]->Key < HashBinKey))
 362                                         return SearchPos;
 363                                 SearchPos --;
 364                         }
 365                         else {
 366                                 if ((SearchPos + 1 < Hash->nMembersUsed) &&
 367                                     (Hash->LookupTable[SearchPos + 1]->Key > HashBinKey))
 368                                         return SearchPos;
 369                                 SearchPos ++;
 370                         }
 371                         StepWidth--;
 372                 }
 373         }
 374         return SearchPos;
 375 }
 376
 377 /**
 378  * \brief private abstract wrapper around the hashing algorithm
 379  * \param HKey the hash string
 380  * \param HKLen length of HKey
 381  * \returns the calculated hash value
 382  */
 383 inline static long CalcHashKey (HashList *Hash, const char *HKey, long HKLen)
 384 {
 385         if (Hash->Algorithm == NULL)
 386                 return hashlittle(HKey, HKLen, 9283457);
 387         else
 388                 return Hash->Algorithm(HKey, HKLen);
 389 }
 390
 391
 392 /**
 393  * \brief Add a new / Replace an existing item in the Hash
 394  * \param HashList the list to manipulate
 395  * \param HKey the hash-string to store Data under
 396  * \param HKeyLen Length of HKey
 397  * \param Data the payload you want to associate with HKey
 398  * \param DeleteIt if not free() should be used to delete Data set to NULL, else DeleteIt is used.
 399  */
 400 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt)
 401 {
 402         long HashBinKey;
 403         long HashAt;
 404
 405         /** first, find out were we could fit in... */
 406         HashBinKey = CalcHashKey(Hash, HKey, HKLen);
 407         HashAt = FindInHash(Hash, HashBinKey);
 408
 409         if (HashAt >= Hash->MemberSize)
 410                 IncreaseHashSize (Hash);
 411
 412         /** oh, we're brand new... */
 413         if (Hash->LookupTable[HashAt] == NULL) {
 414                 InsertHashItem(Hash, HashAt, HashBinKey, HKey, HKLen, Data, DeleteIt);
 415         }/** Insert After? */
 416         else if (Hash->LookupTable[HashAt]->Key > HashBinKey) {
 417                 InsertHashItem(Hash, HashAt, HashBinKey, HKey, HKLen, Data, DeleteIt);
 418         }/** Insert before? */
 419         else if (Hash->LookupTable[HashAt]->Key < HashBinKey) {
 420                 InsertHashItem(Hash, HashAt + 1, HashBinKey, HKey, HKLen, Data, DeleteIt);
 421         }
 422         else { /** Ok, we have a colision. replace it. */
 423                 if (Hash->uniq) {
 424                         long PayloadPos;
 425
 426                         PayloadPos = Hash->LookupTable[HashAt]->Position;
 427                         DeleteHashPayload(Hash->Members[PayloadPos]);
 428                         Hash->Members[PayloadPos]->Data = Data;
 429                         Hash->Members[PayloadPos]->Destructor = DeleteIt;
 430                 }
 431                 else {
 432                         InsertHashItem(Hash, HashAt + 1, HashBinKey, HKey, HKLen, Data, DeleteIt);
 433                 }
 434         }
 435 }
 436
 437 /**
 438  * \brief Lookup the Data associated with HKey
 439  * \param Hash the Hashlist to search in
 440  * \param HKey the hashkey to look up
 441  * \param HKLen length of HKey
 442  * \param Data returns the Data associated with HKey
 443  * \returns 0 if not found, 1 if.
 444  */
 445 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data)
 446 {
 447         long HashBinKey;
 448         long HashAt;
 449
 450         if (HKLen <= 0) {
 451                 *Data = NULL;
 452                 return  0;
 453         }
 454         /** first, find out were we could be... */
 455         HashBinKey = CalcHashKey(Hash, HKey, HKLen);
 456         HashAt = FindInHash(Hash, HashBinKey);
 457         if ((HashAt < 0) || /**< Not found at the lower edge? */
 458             (HashAt >= Hash->nMembersUsed) || /**< Not found at the upper edge? */
 459             (Hash->LookupTable[HashAt]->Key != HashBinKey)) { /**< somewhere inbetween but no match? */
 460                 *Data = NULL;
 461                 return 0;
 462         }
 463         else { /** GOTCHA! */
 464                 long MemberPosition;
 465
 466                 MemberPosition = Hash->LookupTable[HashAt]->Position;
 467                 *Data = Hash->Members[MemberPosition]->Data;
 468                 return 1;
 469         }
 470 }
 471
 472 /* TODO? */
 473 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Payload)
 474 {
 475         return 0;
 476 }
 477
 478 /**
 479  * \brief get the Keys present in this hash, simila to array_keys() in PHP
 480  *  Attention: List remains to Hash! don't modify or free it!
 481  * \param Hash Your Hashlist to extract the keys from
 482  * \param List returns the list of hashkeys stored in Hash
 483  */
 484 int GetHashKeys(HashList *Hash, char ***List)
 485 {
 486         long i;
 487         if (Hash->MyKeys != NULL)
 488                 free (Hash->MyKeys);
 489
 490         Hash->MyKeys = (char**) malloc(sizeof(char*) * Hash->nMembersUsed);
 491         for (i=0; i < Hash->nMembersUsed; i++) {
 492
 493                 Hash->MyKeys[i] = Hash->LookupTable[i]->HashKey;
 494         }
 495         *List = (char**)Hash->MyKeys;
 496         return Hash->nMembersUsed;
 497 }
 498
 499 /**
 500  * \brief creates a hash-linear iterator object
 501  * \returns the hash iterator
 502  */
 503 HashPos *GetNewHashPos(void)
 504 {
 505         HashPos *Ret;
 506
 507         Ret = (HashPos*)malloc(sizeof(HashPos));
 508         Ret->Position = 0;
 509         return Ret;
 510 }
 511
 512 /**
 513  * \brief frees a linear hash iterator
 514  */
 515 void DeleteHashPos(HashPos **DelMe)
 516 {
 517         free(*DelMe);
 518         *DelMe = NULL;
 519 }
 520
 521
 522 /**
 523  * \brief Get the data located where HashPos Iterator points at, and Move HashPos one forward
 524  * \param Hash your Hashlist to follow
 525  * \param HKLen returns Length of Hashkey Returned
 526  * \param HashKey returns the Hashkey corrosponding to HashPos
 527  * \param Data returns the Data found at HashPos
 528  * \returns whether the item was found or not.
 529  */
 530 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, char **HashKey, void **Data)
 531 {
 532         long PayloadPos;
 533
 534         if (Hash->nMembersUsed <= At->Position)
 535                 return 0;
 536         *HKLen = Hash->LookupTable[At->Position]->HKLen;
 537         *HashKey = Hash->LookupTable[At->Position]->HashKey;
 538         PayloadPos = Hash->LookupTable[At->Position]->Position;
 539         *Data = Hash->Members[PayloadPos]->Data;
 540         At->Position++;
 541         return 1;
 542 }
 543
 544 /**
 545  * \brief sorting function for sorting the Hash alphabeticaly by their strings
 546  * \param Key1 first item
 547  * \param Key2 second item
 548  */
 549 static int SortByKeys(const void *Key1, const void* Key2)
 550 {
 551         HashKey *HKey1, *HKey2;
 552         HKey1 = *(HashKey**) Key1;
 553         HKey2 = *(HashKey**) Key2;
 554
 555         return strcasecmp(HKey1->HashKey, HKey2->HashKey);
 556 }
 557
 558 /**
 559  * \brief sorting function for sorting the Hash alphabeticaly reverse by their strings
 560  * \param Key1 first item
 561  * \param Key2 second item
 562  */
 563 static int SortByKeysRev(const void *Key1, const void* Key2)
 564 {
 565         HashKey *HKey1, *HKey2;
 566         HKey1 = *(HashKey**) Key1;
 567         HKey2 = *(HashKey**) Key2;
 568
 569         return strcasecmp(HKey2->HashKey, HKey1->HashKey);
 570 }
 571
 572 /**
 573  * \brief sorting function to regain hash-sequence and revert tainted status
 574  * \param Key1 first item
 575  * \param Key2 second item
 576  */
 577 static int SortByHashKeys(const void *Key1, const void* Key2)
 578 {
 579         HashKey *HKey1, *HKey2;
 580         HKey1 = *(HashKey**) Key1;
 581         HKey2 = *(HashKey**) Key2;
 582
 583         return HKey1->Key > HKey2->Key;
 584 }
 585
 586
 587 /**
 588  * \brief sort the hash alphabeticaly by their keys.
 589  * Caution: This taints the hashlist, so accessing it later
 590  * will be significantly slower! You can un-taint it by SortByHashKeyStr
 591  * \param Hash the list to sort
 592  * \param Order 0/1 Forward/Backward
 593  */
 594 void SortByHashKey(HashList *Hash, int Order)
 595 {
 596         if (Hash->nMembersUsed < 2)
 597                 return;
 598         qsort(Hash->LookupTable, Hash->nMembersUsed, sizeof(HashKey*),
 599               (Order)?SortByKeys:SortByKeysRev);
 600         Hash->tainted = 1;
 601 }
 602
 603 /**
 604  * \brief sort the hash by their keys (so it regains untainted state).
 605  * this will result in the sequence the hashing allgorithm produces it by default.
 606  * \param Hash the list to sort
 607  */
 608 void SortByHashKeyStr(HashList *Hash)
 609 {
 610         Hash->tainted = 0;
 611         if (Hash->nMembersUsed < 2)
 612                 return;
 613         qsort(Hash->LookupTable, Hash->nMembersUsed, sizeof(HashKey*), SortByHashKeys);
 614 }
 615
 616
 617 /**
 618  * \brief gives user sort routines access to the hash payload
 619  * \param Searchentry to retrieve Data to
 620  * \returns Data belonging to HashVoid
 621  */
 622 const void *GetSearchPayload(const void *HashVoid)
 623 {
 624         return (*(HashKey**)HashVoid)->PL->Data;
 625 }
 626
 627 /**
 628  * \brief sort the hash by your sort function. see the following sample.
 629  * this will result in the sequence the hashing allgorithm produces it by default.
 630  * \param Hash the list to sort
 631  * \param SortBy Sortfunction; see below how to implement this
 632  */
 633 void SortByPayload(HashList *Hash, CompareFunc SortBy)
 634 {
 635         if (Hash->nMembersUsed < 2)
 636                 return;
 637         qsort(Hash->LookupTable, Hash->nMembersUsed, sizeof(HashKey*), SortBy);
 638         Hash->tainted = 1;
 639 }
 640
 641
 642
 643
 644 /**
 645  * given you've put char * into your hash as a payload, a sort function might
 646  * look like this:
 647  * int SortByChar(const void* First, const void* Second)
 648  * {
 649  *      char *a, *b;
 650  *      a = (char*) GetSearchPayload(First);
 651  *      b = (char*) GetSearchPayload(Second);
 652  *      return strcmp (a, b);
 653  * }
 654  */