lib/ecoli_keyval.h

   1 /*
   2  * Copyright (c) 2016, Olivier MATZ <zer0@droids-corp.org>
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of the University of California, Berkeley nor the
  13  *       names of its contributors may be used to endorse or promote products
  14  *       derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /**
  29  * Simple hash table API
  30  *
  31  * This file provides functions to store objects in hash tables, using strings
  32  * as keys.
  33  */
  34
  35 #ifndef ECOLI_KEYVAL_
  36 #define ECOLI_KEYVAL_
  37
  38 #include <stdio.h>
  39 #include <stdbool.h>
  40
  41 typedef void (*ec_keyval_elt_free_t)(void *);
  42
  43 struct ec_keyval;
  44
  45 /**
  46  * Create a hash table.
  47  *
  48  * @return
  49  *   The hash table, or NULL on error (errno is set).
  50  */
  51 struct ec_keyval *ec_keyval(void);
  52
  53 /**
  54  * Get a value from the hash table.
  55  *
  56  * @param keyval
  57  *   The hash table.
  58  * @param key
  59  *   The key string.
  60  * @return
  61  *   The element if it is found, or NULL on error (errno is set).
  62  *   In case of success but the element is NULL, errno is set to 0.
  63  */
  64 void *ec_keyval_get(const struct ec_keyval *keyval, const char *key);
  65
  66 /**
  67  * Check if the hash table contains this key.
  68  *
  69  * @param keyval
  70  *   The hash table.
  71  * @param key
  72  *   The key string.
  73  * @return
  74  *   true if it contains the key, else false.
  75  */
  76 bool ec_keyval_has_key(const struct ec_keyval *keyval, const char *key);
  77
  78 /**
  79  * Delete an object from the hash table.
  80  *
  81  * @param keyval
  82  *   The hash table.
  83  * @param key
  84  *   The key string.
  85  * @return
  86  *   0 on success, or -1 on error (errno is set).
  87  */
  88 int ec_keyval_del(struct ec_keyval *keyval, const char *key);
  89
  90 /**
  91  * Add/replace an object in the hash table.
  92  *
  93  * @param keyval
  94  *   The hash table.
  95  * @param key
  96  *   The key string.
  97  * @param val
  98  *   The pointer to be saved in the hash table.
  99  * @param free_cb
 100  *   An optional pointer to a destructor function called when an
 101  *   object is destroyed (ec_keyval_del() or ec_keyval_free()).
 102  * @return
 103  *   0 on success, or -1 on error (errno is set).
 104  *   On error, the passed value is freed (free_cb(val) is called).
 105  */
 106 int ec_keyval_set(struct ec_keyval *keyval, const char *key, void *val,
 107         ec_keyval_elt_free_t free_cb);
 108
 109 /**
 110  * Free a hash table an all its objects.
 111  *
 112  * @param keyval
 113  *   The hash table.
 114  */
 115 void ec_keyval_free(struct ec_keyval *keyval);
 116
 117 /**
 118  * Get the length of a hash table.
 119  *
 120  * @param keyval
 121  *   The hash table.
 122  * @return
 123  *   The length of the hash table.
 124  */
 125 size_t ec_keyval_len(const struct ec_keyval *keyval);
 126
 127 /**
 128  * Duplicate a hash table
 129  *
 130  * A reference counter is shared between the clones of
 131  * hash tables so that the objects are freed only when
 132  * the last reference is destroyed.
 133  *
 134  * @param keyval
 135  *   The hash table.
 136  * @return
 137  *   The duplicated hash table, or NULL on error (errno is set).
 138  */
 139 struct ec_keyval *ec_keyval_dup(const struct ec_keyval *keyval);
 140
 141 /**
 142  * Dump a hash table.
 143  *
 144  * @param out
 145  *   The stream where the dump is sent.
 146  * @param keyval
 147  *   The hash table.
 148  */
 149 void ec_keyval_dump(FILE *out, const struct ec_keyval *keyval);
 150
 151 #endif