XEmacs 21.2-b1
[chise/xemacs-chise.git-] / src / elhash.h
1 /* Lisp interface to hash tables -- include file.
2    Copyright (C) 1995, 1996 Ben Wing.
3
4 This file is part of XEmacs.
5
6 XEmacs is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the
8 Free Software Foundation; either version 2, or (at your option) any
9 later version.
10
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with XEmacs; see the file COPYING.  If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA.  */
20
21 /* Synched up with: Not in FSF. */
22
23 #ifndef _XEMACS_ELHASH_H_
24 #define _XEMACS_ELHASH_H_
25
26 DECLARE_LRECORD (hashtable, struct hashtable);
27
28 #define XHASHTABLE(x) XRECORD (x, hashtable, struct hashtable)
29 #define XSETHASHTABLE(x, p) XSETRECORD (x, p, hashtable)
30 #define HASHTABLEP(x) RECORDP (x, hashtable)
31 #define GC_HASHTABLEP(x) GC_RECORDP (x, hashtable)
32 #define CHECK_HASHTABLE(x) CHECK_RECORD (x, hashtable)
33 #define CONCHECK_HASHTABLE(x) CONCHECK_RECORD (x, hashtable)
34
35 enum hashtable_type
36 {
37   HASHTABLE_NONWEAK,
38   HASHTABLE_KEY_WEAK,
39   HASHTABLE_VALUE_WEAK,
40   HASHTABLE_KEY_CAR_WEAK,
41   HASHTABLE_VALUE_CAR_WEAK,
42   HASHTABLE_WEAK
43 };
44
45 enum hashtable_test_fun
46 {
47   HASHTABLE_EQ,
48   HASHTABLE_EQL,
49   HASHTABLE_EQUAL
50 };
51
52 EXFUN (Fcopy_hashtable, 1);
53 EXFUN (Fhashtable_fullness, 1);
54 EXFUN (Fremhash, 2);
55
56 Lisp_Object make_lisp_hashtable (int size,
57                                  enum hashtable_type type,
58                                  enum hashtable_test_fun test_fun);
59
60 void elisp_maphash (int (*fn) (CONST void *key, void *contents,
61                                 void *extra_arg),
62                     Lisp_Object table,
63                     void *extra_arg);
64
65 void elisp_map_remhash (int (*fn) (CONST void *key,
66                                    CONST void *contents,
67                                    void *extra_arg),
68                         Lisp_Object table,
69                         void *extra_arg);
70
71 int finish_marking_weak_hashtables (int (*obj_marked_p) (Lisp_Object),
72                                            void (*markobj) (Lisp_Object));
73 void prune_weak_hashtables (int (*obj_marked_p) (Lisp_Object));
74
75 void *elisp_hvector_malloc (unsigned int, Lisp_Object);
76 void elisp_hvector_free (void *ptr, Lisp_Object table);
77
78 #endif /* _XEMACS_ELHASH_H_ */