libguile/hashtab.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM_HASHTAB_H
   4 #define SCM_HASHTAB_H
   5
   6 /* Copyright (C) 1995,1996,1999,2000,2001, 2003, 2004, 2006, 2008, 2009, 2011 Free Software Foundation, Inc.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public License
  10  * as published by the Free Software Foundation; either version 3 of
  11  * the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21  * 02110-1301 USA
  22  */
  23
  24 \f
  25
  26 #include "libguile/__scm.h"
  27
  28 \f
  29
  30 #define SCM_HASHTABLE_P(x) (SCM_HAS_TYP7 (x, scm_tc7_hashtable))
  31 #define SCM_VALIDATE_HASHTABLE(pos, arg) \
  32   SCM_MAKE_VALIDATE_MSG (pos, arg, HASHTABLE_P, "hash-table")
  33 #define SCM_HASHTABLE_VECTOR(h)  SCM_CELL_OBJECT_1 (h)
  34 #define SCM_SET_HASHTABLE_VECTOR(x, v) SCM_SET_CELL_OBJECT_1 ((x), (v))
  35 #define SCM_HASHTABLE(x)           ((scm_t_hashtable *) SCM_CELL_WORD_2 (x))
  36 #define SCM_HASHTABLE_N_ITEMS(x)   (SCM_HASHTABLE (x)->n_items)
  37 #define SCM_SET_HASHTABLE_N_ITEMS(x, n)   (SCM_HASHTABLE (x)->n_items = n)
  38 #define SCM_HASHTABLE_INCREMENT(x) (SCM_HASHTABLE_N_ITEMS(x)++)
  39 #define SCM_HASHTABLE_DECREMENT(x) (SCM_HASHTABLE_N_ITEMS(x)--)
  40 #define SCM_HASHTABLE_UPPER(x)     (SCM_HASHTABLE (x)->upper)
  41 #define SCM_HASHTABLE_LOWER(x)     (SCM_HASHTABLE (x)->lower)
  42
  43 #define SCM_HASHTABLE_N_BUCKETS(h) \
  44  SCM_SIMPLE_VECTOR_LENGTH (SCM_HASHTABLE_VECTOR (h))
  45 #define SCM_HASHTABLE_BUCKET(h, i) \
  46   SCM_SIMPLE_VECTOR_REF (SCM_HASHTABLE_VECTOR (h), i)
  47 #define SCM_SET_HASHTABLE_BUCKET(h, i, x) \
  48   SCM_SIMPLE_VECTOR_SET (SCM_HASHTABLE_VECTOR (h), i, x)
  49
  50 /* Function that computes a hash of OBJ modulo MAX.  */
  51 typedef unsigned long (*scm_t_hash_fn) (SCM obj, unsigned long max,
  52                                         void *closure);
  53
  54 /* Function that returns the value associated with OBJ in ALIST according to
  55    some equality predicate.  */
  56 typedef SCM (*scm_t_assoc_fn) (SCM obj, SCM alist, void *closure);
  57
  58 /* Function to fold over the entries of a hash table.  */
  59 typedef SCM (*scm_t_hash_fold_fn) (void *closure, SCM key, SCM value,
  60                                    SCM result);
  61
  62 /* Function to iterate over the handles (key-value pairs) of a hash
  63    table.  */
  64 typedef SCM (*scm_t_hash_handle_fn) (void *closure, SCM handle);
  65
  66 typedef struct scm_t_hashtable {
  67   unsigned long n_items;        /* number of items in table */
  68   unsigned long lower;          /* when to shrink */
  69   unsigned long upper;          /* when to grow */
  70   int size_index;               /* index into hashtable_size */
  71   int min_size_index;           /* minimum size_index */
  72   scm_t_hash_fn hash_fn;  /* for rehashing after a GC. */
  73 } scm_t_hashtable;
  74
  75 \f
  76
  77 SCM_API SCM scm_vector_to_hash_table (SCM vector);
  78 SCM_API SCM scm_c_make_hash_table (unsigned long k);
  79 SCM_API SCM scm_make_hash_table (SCM n);
  80
  81 SCM_API SCM scm_hash_table_p (SCM h);
  82
  83 SCM_INTERNAL void scm_i_rehash (SCM table, scm_t_hash_fn hash_fn,
  84                                 void *closure, const char *func_name);
  85
  86
  87 SCM_API SCM scm_hash_fn_get_handle (SCM table, SCM obj,
  88                                     scm_t_hash_fn hash_fn,
  89                                     scm_t_assoc_fn assoc_fn,
  90                                     void *closure);
  91 SCM_API SCM scm_hash_fn_create_handle_x (SCM table, SCM obj, SCM init,
  92                                          scm_t_hash_fn hash_fn,
  93                                          scm_t_assoc_fn assoc_fn,
  94                                          void *closure);
  95 SCM_API SCM scm_hash_fn_ref (SCM table, SCM obj, SCM dflt,
  96                              scm_t_hash_fn hash_fn,
  97                              scm_t_assoc_fn assoc_fn,
  98                              void *closure);
  99 SCM_API SCM scm_hash_fn_set_x (SCM table, SCM obj, SCM val,
 100                                scm_t_hash_fn hash_fn,
 101                                scm_t_assoc_fn assoc_fn,
 102                                void *closure);
 103 SCM_API SCM scm_hash_fn_remove_x (SCM table, SCM obj,
 104                                   scm_t_hash_fn hash_fn,
 105                                   scm_t_assoc_fn assoc_fn,
 106                                   void *closure);
 107 SCM_API SCM scm_internal_hash_fold (scm_t_hash_fold_fn fn, void *closure,
 108                                     SCM init, SCM table);
 109 SCM_API void scm_internal_hash_for_each_handle (scm_t_hash_handle_fn fn,
 110                                                 void *closure, SCM table);
 111 SCM_API SCM scm_hash_clear_x (SCM table);
 112
 113 SCM_API SCM scm_hashq_get_handle (SCM table, SCM obj);
 114 SCM_API SCM scm_hashq_create_handle_x (SCM table, SCM obj, SCM init);
 115 SCM_API SCM scm_hashq_ref (SCM table, SCM obj, SCM dflt);
 116 SCM_API SCM scm_hashq_set_x (SCM table, SCM obj, SCM val);
 117 SCM_API SCM scm_hashq_remove_x (SCM table, SCM obj);
 118 SCM_API SCM scm_hashv_get_handle (SCM table, SCM obj);
 119 SCM_API SCM scm_hashv_create_handle_x (SCM table, SCM obj, SCM init);
 120 SCM_API SCM scm_hashv_ref (SCM table, SCM obj, SCM dflt);
 121 SCM_API SCM scm_hashv_set_x (SCM table, SCM obj, SCM val);
 122 SCM_API SCM scm_hashv_remove_x (SCM table, SCM obj);
 123 SCM_API SCM scm_hash_get_handle (SCM table, SCM obj);
 124 SCM_API SCM scm_hash_create_handle_x (SCM table, SCM obj, SCM init);
 125 SCM_API SCM scm_hash_ref (SCM table, SCM obj, SCM dflt);
 126 SCM_API SCM scm_hash_set_x (SCM table, SCM obj, SCM val);
 127 SCM_API SCM scm_hash_remove_x (SCM table, SCM obj);
 128 SCM_API SCM scm_hashx_get_handle (SCM hash, SCM assoc, SCM table, SCM obj);
 129 SCM_API SCM scm_hashx_create_handle_x (SCM hash, SCM assoc, SCM table, SCM obj, SCM init);
 130 SCM_API SCM scm_hashx_ref (SCM hash, SCM assoc, SCM table, SCM obj, SCM dflt);
 131 SCM_API SCM scm_hashx_set_x (SCM hash, SCM assoc, SCM table, SCM obj, SCM val);
 132 SCM_API SCM scm_hashx_remove_x (SCM hash, SCM assoc, SCM table, SCM obj);
 133 SCM_API SCM scm_hash_fold (SCM proc, SCM init, SCM hash);
 134 SCM_API SCM scm_hash_for_each (SCM proc, SCM hash);
 135 SCM_API SCM scm_hash_for_each_handle (SCM proc, SCM hash);
 136 SCM_API SCM scm_hash_map_to_list (SCM proc, SCM hash);
 137 SCM_API SCM scm_hash_count (SCM hash, SCM pred);
 138 SCM_INTERNAL void scm_i_hashtable_print (SCM exp, SCM port, scm_print_state *pstate);
 139 SCM_INTERNAL void scm_init_hashtab (void);
 140
 141 #endif  /* SCM_HASHTAB_H */
 142
 143 /*
 144   Local Variables:
 145   c-file-style: "gnu"
 146   End:
 147 */