lib/hash.h

   1 #ifndef HEADER_CURL_HASH_H
   2 #define HEADER_CURL_HASH_H
   3 /***************************************************************************
   4  *                                  _   _ ____  _
   5  *  Project                     ___| | | |  _ \| |
   6  *                             / __| | | | |_) | |
   7  *                            | (__| |_| |  _ <| |___
   8  *                             \___|\___/|_| \_\_____|
   9  *
  10  * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al.
  11  *
  12  * This software is licensed as described in the file COPYING, which
  13  * you should have received as part of this distribution. The terms
  14  * are also available at http://curl.haxx.se/docs/copyright.html.
  15  *
  16  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  17  * copies of the Software, and permit persons to whom the Software is
  18  * furnished to do so, under the terms of the COPYING file.
  19  *
  20  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  21  * KIND, either express or implied.
  22  *
  23  ***************************************************************************/
  24
  25 #include "curl_setup.h"
  26
  27 #include <stddef.h>
  28
  29 #include "llist.h"
  30
  31 /* Hash function prototype */
  32 typedef size_t (*hash_function) (void* key,
  33                                  size_t key_length,
  34                                  size_t slots_num);
  35
  36 /*
  37    Comparator function prototype. Compares two keys.
  38 */
  39 typedef size_t (*comp_function) (void* key1,
  40                                  size_t key1_len,
  41                                  void*key2,
  42                                  size_t key2_len);
  43
  44 typedef void (*curl_hash_dtor)(void *);
  45
  46 struct curl_hash {
  47   struct curl_llist **table;
  48
  49   /* Hash function to be used for this hash table */
  50   hash_function hash_func;
  51
  52   /* Comparator function to compare keys */
  53   comp_function comp_func;
  54   curl_hash_dtor   dtor;
  55   int slots;
  56   size_t size;
  57 };
  58
  59 struct curl_hash_element {
  60   void   *ptr;
  61   char   *key;
  62   size_t key_len;
  63 };
  64
  65 struct curl_hash_iterator {
  66   struct curl_hash *hash;
  67   int slot_index;
  68   struct curl_llist_element *current_element;
  69 };
  70
  71 int Curl_hash_init(struct curl_hash *h,
  72                    int slots,
  73                    hash_function hfunc,
  74                    comp_function comparator,
  75                    curl_hash_dtor dtor);
  76
  77 void *Curl_hash_add(struct curl_hash *h, void *key, size_t key_len, void *p);
  78 int Curl_hash_delete(struct curl_hash *h, void *key, size_t key_len);
  79 void *Curl_hash_pick(struct curl_hash *, void * key, size_t key_len);
  80 void Curl_hash_apply(struct curl_hash *h, void *user,
  81                      void (*cb)(void *user, void *ptr));
  82 int Curl_hash_count(struct curl_hash *h);
  83 void Curl_hash_destroy(struct curl_hash *h);
  84 void Curl_hash_clean(struct curl_hash *h);
  85 void Curl_hash_clean_with_criterium(struct curl_hash *h, void *user,
  86                                     int (*comp)(void *, void *));
  87 size_t Curl_hash_str(void* key, size_t key_length, size_t slots_num);
  88 size_t Curl_str_key_compare(void*k1, size_t key1_len, void*k2,
  89                             size_t key2_len);
  90
  91 void Curl_hash_start_iterate(struct curl_hash *hash,
  92                              struct curl_hash_iterator *iter);
  93 struct curl_hash_element *
  94 Curl_hash_next_element(struct curl_hash_iterator *iter);
  95
  96 void Curl_hash_print(struct curl_hash *h,
  97                      void (*func)(void *));
  98
  99
 100 #endif /* HEADER_CURL_HASH_H */