Bash-4.3 patch 46

[thirdparty/bash.git] / hashlib.h

diff --git a/hashlib.h b/hashlib.h
index 9c3dee09eaad2416a1d5c371efcbdd9257473acb..4620e423c73dd58f58e53c96d5a53d8a09cbaeb5 100644 (file)
--- a/hashlib.h
+++ b/hashlib.h
@@ -1,32 +1,41 @@
 /* hashlib.h -- the data structures used in hashing in Bash. */
 
-/* Copyright (C) 1993 Free Software Foundation, Inc.
+/* Copyright (C) 1993-2009 Free Software Foundation, Inc.
 
    This file is part of GNU Bash, the Bourne Again SHell.
 
-   Bash is free software; you can redistribute it and/or modify it under
-   the terms of the GNU General Public License as published by the Free
-   Software Foundation; either version 2, or (at your option) any later
-   version.
+   Bash is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
 
-   Bash is distributed in the hope that it will be useful, but WITHOUT ANY
-   WARRANTY; without even the implied warranty of MERCHANTABILITY or
-   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
-   for more details.
+   Bash is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
 
-   You should have received a copy of the GNU General Public License along
-   with Bash; see the file COPYING.  If not, write to the Free Software
-   Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
+   You should have received a copy of the GNU General Public License
+   along with Bash.  If not, see <http://www.gnu.org/licenses/>.
+*/
 
 #if !defined (_HASHLIB_H_)
 #define _HASHLIB_H_
 
 #include "stdc.h"
 
+#ifndef PTR_T
+#  ifdef __STDC__
+#    define PTR_T void *
+#  else
+#    define PTR_T char *
+#  endif
+#endif
+
 typedef struct bucket_contents {
   struct bucket_contents *next;        /* Link to next hashed key in this bucket. */
   char *key;                   /* What we look up. */
-  char *data;                  /* What we really want. */
+  PTR_T data;                  /* What we really want. */
+  unsigned int khash;          /* What key hashes to */
   int times_found;             /* Number of times this item has been found. */
 } BUCKET_CONTENTS;
 
@@ -36,27 +45,42 @@ typedef struct hash_table {
   int nentries;                        /* How many entries does this table have. */
 } HASH_TABLE;
 
-extern int hash_string __P((const char *, HASH_TABLE *));
-extern int hash_table_nentries __P((HASH_TABLE *));
-extern HASH_TABLE *make_hash_table __P((int));
-extern HASH_TABLE *copy_hash_table __P((HASH_TABLE *, sh_string_func_t *));
-extern BUCKET_CONTENTS *find_hash_item __P((const char *, HASH_TABLE *));
-extern BUCKET_CONTENTS *remove_hash_item __P((const char *, HASH_TABLE *));
-extern BUCKET_CONTENTS *add_hash_item __P((char *, HASH_TABLE *));
-extern void flush_hash_table __P((HASH_TABLE *, sh_free_func_t *));
-extern void dispose_hash_table __P((HASH_TABLE *));
+typedef int hash_wfunc __P((BUCKET_CONTENTS *));
+
+/* Operations on tables as a whole */
+extern HASH_TABLE *hash_create __P((int));
+extern HASH_TABLE *hash_copy __P((HASH_TABLE *, sh_string_func_t *));
+extern void hash_flush __P((HASH_TABLE *, sh_free_func_t *));
+extern void hash_dispose __P((HASH_TABLE *));
+extern void hash_walk __P((HASH_TABLE *, hash_wfunc *));
+
+/* Operations to extract information from or pieces of tables */
+extern int hash_bucket __P((const char *, HASH_TABLE *));
+extern int hash_size __P((HASH_TABLE *));
+
+/* Operations on hash table entries */
+extern BUCKET_CONTENTS *hash_search __P((const char *, HASH_TABLE *, int));
+extern BUCKET_CONTENTS *hash_insert __P((char *, HASH_TABLE *, int));
+extern BUCKET_CONTENTS *hash_remove __P((const char *, HASH_TABLE *, int));
+
+/* Miscellaneous */
+extern unsigned int hash_string __P((const char *));
 
 /* Redefine the function as a macro for speed. */
-#define get_hash_bucket(bucket, table) \
+#define hash_items(bucket, table) \
        ((table && (bucket < table->nbuckets)) ?  \
                table->bucket_array[bucket] : \
                (BUCKET_CONTENTS *)NULL)
 
 /* Default number of buckets in the hash table. */
-#define DEFAULT_HASH_BUCKETS 53        /* was 107 */
+#define DEFAULT_HASH_BUCKETS 64        /* was 107, then 53, must be power of two now */
 
 #define HASH_ENTRIES(ht)       ((ht) ? (ht)->nentries : 0)
 
+/* flags for hash_search and hash_insert */
+#define HASH_NOSRCH    0x01
+#define HASH_CREATE    0x02
+
 #if !defined (NULL)
 #  if defined (__STDC__)
 #    define NULL ((void *) 0)