annotate src/elhash.h @ 120:cca96a509cfe r20-1b12

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