Add comment saying file is deprecated

[pf3gnuchains/gcc-fork.git] / include / hashtab.h

diff --git a/include/hashtab.h b/include/hashtab.h
index c75b23c..4f67448 100644 (file)
--- a/include/hashtab.h
+++ b/include/hashtab.h
@@ -14,7 +14,7 @@ GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
+Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.  */
 
 /* This package implements basic hash table functionality.  It is possible
    to search for an entry, create an entry and destroy an entry.
@@ -71,24 +71,32 @@ typedef int (*htab_trav) (void **, void *);
    Iff it returns NULL, the hash table implementation will pass an error
    code back to the user, so if your code doesn't handle errors,
    best if you use xcalloc instead.  */
-typedef PTR (*htab_alloc) (size_t, size_t);
+typedef void *(*htab_alloc) (size_t, size_t);
 
 /* We also need a free() routine.  */
-typedef void (*htab_free) (PTR);
+typedef void (*htab_free) (void *);
 
 /* Memory allocation and deallocation; variants which take an extra
    argument.  */
-typedef PTR (*htab_alloc_with_arg) (void *, size_t, size_t);
+typedef void *(*htab_alloc_with_arg) (void *, size_t, size_t);
 typedef void (*htab_free_with_arg) (void *, void *);
 
+/* This macro defines reserved value for empty table entry.  */
+
+#define HTAB_EMPTY_ENTRY    ((PTR) 0)
+
+/* This macro defines reserved value for table entry which contained
+   a deleted element. */
+
+#define HTAB_DELETED_ENTRY  ((PTR) 1)
+
 /* Hash tables are of the following type.  The structure
    (implementation) of this type is not needed for using the hash
    tables.  All work with hash table should be executed only through
    functions mentioned below.  The size of this structure is subject to
    change.  */
 
-struct htab GTY(())
-{
+struct GTY(()) htab {
   /* Pointer to hash function.  */
   htab_hash hash_f;
 
@@ -99,7 +107,7 @@ struct htab GTY(())
   htab_del del_f;
 
   /* Table itself.  */
-  PTR * GTY ((use_param, length ("%h.size"))) entries;
+  void ** GTY ((use_param, length ("%h.size"))) entries;
 
   /* Current size (in entries) of the hash table.  */
   size_t size;
@@ -123,7 +131,7 @@ struct htab GTY(())
   htab_free free_f;
 
   /* Alternate allocate/free functions, which take an extra argument.  */
-  PTR GTY((skip)) alloc_arg;
+  void * GTY((skip)) alloc_arg;
   htab_alloc_with_arg alloc_with_arg_f;
   htab_free_with_arg free_with_arg_f;
 
@@ -145,7 +153,7 @@ extern htab_t       htab_create_alloc  (size_t, htab_hash,
 
 extern htab_t  htab_create_alloc_ex (size_t, htab_hash,
                                       htab_eq, htab_del,
-                                      PTR, htab_alloc_with_arg,
+                                      void *, htab_alloc_with_arg,
                                       htab_free_with_arg);
 
 /* Backward-compatibility functions.  */
@@ -154,18 +162,17 @@ extern htab_t htab_try_create (size_t, htab_hash, htab_eq, htab_del);
 
 extern void    htab_set_functions_ex (htab_t, htab_hash,
                                        htab_eq, htab_del,
-                                       PTR, htab_alloc_with_arg,
+                                       void *, htab_alloc_with_arg,
                                        htab_free_with_arg);
 
 extern void    htab_delete (htab_t);
 extern void    htab_empty (htab_t);
 
-extern PTR     htab_find (htab_t, const void *);
-extern PTR     *htab_find_slot (htab_t, const void *, enum insert_option);
-extern PTR     htab_find_with_hash (htab_t, const void *, hashval_t);
-extern PTR     *htab_find_slot_with_hash (htab_t, const void *,
-                                          hashval_t,
-                                          enum insert_option);
+extern void *  htab_find (htab_t, const void *);
+extern void ** htab_find_slot (htab_t, const void *, enum insert_option);
+extern void *  htab_find_with_hash (htab_t, const void *, hashval_t);
+extern void ** htab_find_slot_with_hash (htab_t, const void *,
+                                         hashval_t, enum insert_option);
 extern void    htab_clear_slot (htab_t, void **);
 extern void    htab_remove_elt (htab_t, void *);
 extern void    htab_remove_elt_with_hash (htab_t, void *, hashval_t);
@@ -184,10 +191,10 @@ extern htab_hash htab_hash_pointer;
 extern htab_eq htab_eq_pointer;
 
 /* A hash function for null-terminated strings.  */
-extern hashval_t htab_hash_string (const PTR);
+extern hashval_t htab_hash_string (const void *);
 
 /* An iterative hash function for arbitrary data.  */
-extern hashval_t iterative_hash (const PTR, size_t, hashval_t);
+extern hashval_t iterative_hash (const void *, size_t, hashval_t);
 /* Shorthand for hashing something with an intrinsic size.  */
 #define iterative_hash_object(OB,INIT) iterative_hash (&OB, sizeof (OB), INIT)