Mercurial > hg > xemacs-beta
annotate src/opaque.c @ 5475:248176c74e6b
Merge with trunk.
| author | Mats Lidell <matsl@xemacs.org> |
|---|---|
| date | Sat, 23 Apr 2011 23:47:13 +0200 |
| parents | 308d34e9f07d |
| children | e2fae7783046 |
| rev | line source |
|---|---|
| 428 | 1 /* Opaque Lisp objects. |
| 2 Copyright (C) 1993, 1994, 1995 Sun Microsystems, Inc. | |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5125
diff
changeset
|
3 Copyright (C) 1995, 1996, 2002, 2010 Ben Wing. |
| 428 | 4 |
| 5 This file is part of XEmacs. | |
| 6 | |
|
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5191
diff
changeset
|
7 XEmacs is free software: you can redistribute it and/or modify it |
| 428 | 8 under the terms of the GNU General Public License as published by the |
|
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5191
diff
changeset
|
9 Free Software Foundation, either version 3 of the License, or (at your |
|
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5191
diff
changeset
|
10 option) any later version. |
| 428 | 11 |
| 12 XEmacs is distributed in the hope that it will be useful, but WITHOUT | |
| 13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 15 for more details. | |
| 16 | |
| 17 You should have received a copy of the GNU General Public License | |
|
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5191
diff
changeset
|
18 along with XEmacs. If not, see <http://www.gnu.org/licenses/>. */ |
| 428 | 19 |
| 20 /* Synched up with: Not in FSF. */ | |
| 21 | |
| 22 /* Written by Ben Wing, October 1993. */ | |
| 23 | |
| 24 /* "Opaque" is used internally to hold keep track of allocated memory | |
| 25 so it gets GC'd properly, and to store arbitrary data in places | |
| 26 where a Lisp_Object is required and which may get GC'd. (e.g. as | |
| 27 the argument to record_unwind_protect()). Once created in C, | |
| 28 opaque objects cannot be resized. | |
| 29 | |
| 30 OPAQUE OBJECTS SHOULD NEVER ESCAPE TO THE LISP LEVEL. Some code | |
| 31 depends on this. As such, opaque objects are a generalization | |
| 32 of the Qunbound marker. | |
| 33 */ | |
| 34 | |
| 35 #include <config.h> | |
| 36 #include "lisp.h" | |
| 37 #include "opaque.h" | |
| 38 | |
| 3263 | 39 #ifndef NEW_GC |
| 428 | 40 Lisp_Object Vopaque_ptr_free_list; |
| 3263 | 41 #endif /* not NEW_GC */ |
| 428 | 42 |
| 43 /* Should never, ever be called. (except by an external debugger) */ | |
| 44 static void | |
| 2286 | 45 print_opaque (Lisp_Object obj, Lisp_Object printcharfun, |
| 46 int UNUSED (escapeflag)) | |
| 428 | 47 { |
| 442 | 48 const Lisp_Opaque *p = XOPAQUE (obj); |
| 428 | 49 |
| 800 | 50 write_fmt_string |
| 51 (printcharfun, | |
|
5146
88bd4f3ef8e4
make lrecord UID's have a separate UID space for each object, resurrect debug SOE code in extents.c
Ben Wing <ben@xemacs.org>
parents:
5127
diff
changeset
|
52 "#<INTERNAL OBJECT (XEmacs bug?) (opaque, size=%lu) 0x%x>", |
|
88bd4f3ef8e4
make lrecord UID's have a separate UID space for each object, resurrect debug SOE code in extents.c
Ben Wing <ben@xemacs.org>
parents:
5127
diff
changeset
|
53 (long)(p->size), LISP_OBJECT_UID (obj)); |
| 428 | 54 } |
| 55 | |
| 665 | 56 inline static Bytecount |
| 57 aligned_sizeof_opaque (Bytecount opaque_size) | |
| 456 | 58 { |
| 826 | 59 return MAX_ALIGN_SIZE (offsetof (Lisp_Opaque, data) + opaque_size); |
| 456 | 60 } |
| 61 | |
| 665 | 62 static Bytecount |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5125
diff
changeset
|
63 sizeof_opaque (Lisp_Object obj) |
| 428 | 64 { |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5125
diff
changeset
|
65 return aligned_sizeof_opaque (XOPAQUE (obj)->size); |
| 428 | 66 } |
| 67 | |
| 68 /* Return an opaque object of size SIZE. | |
| 69 If DATA is OPAQUE_CLEAR, the object's data is memset to '\0' bytes. | |
| 70 If DATA is OPAQUE_UNINIT, the object's data is uninitialized. | |
| 71 Else the object's data is initialized by copying from DATA. */ | |
| 72 Lisp_Object | |
| 665 | 73 make_opaque (const void *data, Bytecount size) |
| 428 | 74 { |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3017
diff
changeset
|
75 Lisp_Object obj = |
|
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3017
diff
changeset
|
76 ALLOC_SIZED_LISP_OBJECT (aligned_sizeof_opaque (size), opaque); |
|
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3017
diff
changeset
|
77 Lisp_Opaque *p = XOPAQUE (obj); |
| 428 | 78 p->size = size; |
| 79 | |
| 80 if (data == OPAQUE_CLEAR) | |
| 81 memset (p->data, '\0', size); | |
| 82 else if (data == OPAQUE_UNINIT) | |
| 83 DO_NOTHING; | |
| 84 else | |
| 85 memcpy (p->data, data, size); | |
| 86 | |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3017
diff
changeset
|
87 return obj; |
| 428 | 88 } |
| 89 | |
| 90 /* This will not work correctly for opaques with subobjects! */ | |
| 91 | |
| 92 static int | |
|
4906
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
3263
diff
changeset
|
93 equal_opaque (Lisp_Object obj1, Lisp_Object obj2, int UNUSED (depth), |
|
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
3263
diff
changeset
|
94 int UNUSED (foldcase)) |
| 428 | 95 { |
| 665 | 96 Bytecount size; |
| 428 | 97 return ((size = XOPAQUE_SIZE (obj1)) == XOPAQUE_SIZE (obj2) && |
| 98 !memcmp (XOPAQUE_DATA (obj1), XOPAQUE_DATA (obj2), size)); | |
| 99 } | |
| 100 | |
| 101 /* This will not work correctly for opaques with subobjects! */ | |
| 102 | |
| 2515 | 103 static Hashcode |
|
5191
71ee43b8a74d
Add #'equalp as a hash test by default; add #'define-hash-table-test, GNU API
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
104 hash_opaque (Lisp_Object obj, int UNUSED (depth), int UNUSED (equalp)) |
| 428 | 105 { |
| 106 if (XOPAQUE_SIZE (obj) == sizeof (unsigned long)) | |
| 2515 | 107 return *((Hashcode *) XOPAQUE_DATA (obj)); |
| 428 | 108 else |
| 109 return memory_hash (XOPAQUE_DATA (obj), XOPAQUE_SIZE (obj)); | |
| 110 } | |
| 111 | |
| 1204 | 112 static const struct memory_description opaque_description[] = { |
| 428 | 113 { XD_END } |
| 114 }; | |
| 115 | |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
116 DEFINE_DUMPABLE_SIZABLE_LISP_OBJECT ("opaque", opaque, |
|
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
117 0, print_opaque, 0, |
|
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
118 equal_opaque, hash_opaque, |
|
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
119 opaque_description, |
|
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
120 sizeof_opaque, Lisp_Opaque); |
| 428 | 121 |
| 122 /* stuff to handle opaque pointers */ | |
| 123 | |
| 124 /* Should never, ever be called. (except by an external debugger) */ | |
| 125 static void | |
| 2286 | 126 print_opaque_ptr (Lisp_Object obj, Lisp_Object printcharfun, |
| 127 int UNUSED (escapeflag)) | |
| 428 | 128 { |
| 442 | 129 const Lisp_Opaque_Ptr *p = XOPAQUE_PTR (obj); |
| 428 | 130 |
| 800 | 131 write_fmt_string |
| 132 (printcharfun, | |
|
5146
88bd4f3ef8e4
make lrecord UID's have a separate UID space for each object, resurrect debug SOE code in extents.c
Ben Wing <ben@xemacs.org>
parents:
5127
diff
changeset
|
133 "#<INTERNAL OBJECT (XEmacs bug?) (opaque-ptr, adr=0x%lx) 0x%x>", |
|
88bd4f3ef8e4
make lrecord UID's have a separate UID space for each object, resurrect debug SOE code in extents.c
Ben Wing <ben@xemacs.org>
parents:
5127
diff
changeset
|
134 (long)(p->ptr), LISP_OBJECT_UID (obj)); |
| 428 | 135 } |
| 136 | |
| 137 static int | |
|
4906
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
3263
diff
changeset
|
138 equal_opaque_ptr (Lisp_Object obj1, Lisp_Object obj2, int UNUSED (depth), |
|
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
3263
diff
changeset
|
139 int UNUSED (foldcase)) |
| 428 | 140 { |
| 141 return (XOPAQUE_PTR (obj1)->ptr == XOPAQUE_PTR (obj2)->ptr); | |
| 142 } | |
| 143 | |
| 2515 | 144 static Hashcode |
|
5191
71ee43b8a74d
Add #'equalp as a hash test by default; add #'define-hash-table-test, GNU API
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
145 hash_opaque_ptr (Lisp_Object obj, int UNUSED (depth), int UNUSED (equalp)) |
| 428 | 146 { |
| 2515 | 147 return (Hashcode) XOPAQUE_PTR (obj)->ptr; |
| 428 | 148 } |
| 149 | |
| 1575 | 150 static const struct memory_description opaque_ptr_description[] = { |
| 151 { XD_END } | |
| 152 }; | |
| 153 | |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
154 DEFINE_NODUMP_LISP_OBJECT ("opaque-ptr", opaque_ptr, |
|
5124
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
155 0, print_opaque_ptr, 0, |
|
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
156 equal_opaque_ptr, hash_opaque_ptr, |
|
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
157 opaque_ptr_description, Lisp_Opaque_Ptr); |
| 428 | 158 |
| 159 Lisp_Object | |
| 160 make_opaque_ptr (void *val) | |
| 161 { | |
| 3263 | 162 #ifdef NEW_GC |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5125
diff
changeset
|
163 Lisp_Object res = ALLOC_NORMAL_LISP_OBJECT (opaque_ptr); |
| 3263 | 164 #else /* not NEW_GC */ |
| 1204 | 165 Lisp_Object res = alloc_managed_lcrecord (Vopaque_ptr_free_list); |
| 3263 | 166 #endif /* not NEW_GC */ |
| 428 | 167 set_opaque_ptr (res, val); |
| 168 return res; | |
| 169 } | |
| 170 | |
| 171 /* Be very very careful with this. Same admonitions as with | |
| 172 free_cons() apply. */ | |
| 173 | |
| 174 void | |
| 175 free_opaque_ptr (Lisp_Object ptr) | |
| 176 { | |
| 3263 | 177 #ifdef NEW_GC |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5125
diff
changeset
|
178 free_normal_lisp_object (ptr); |
| 3263 | 179 #else /* not NEW_GC */ |
| 428 | 180 free_managed_lcrecord (Vopaque_ptr_free_list, ptr); |
| 3263 | 181 #endif /* not NEW_GC */ |
| 428 | 182 } |
| 183 | |
| 3263 | 184 #ifndef NEW_GC |
| 428 | 185 void |
| 1204 | 186 reinit_opaque_early (void) |
| 428 | 187 { |
| 647 | 188 Vopaque_ptr_free_list = make_lcrecord_list (sizeof (Lisp_Opaque_Ptr), |
| 189 &lrecord_opaque_ptr); | |
| 428 | 190 staticpro_nodump (&Vopaque_ptr_free_list); |
| 191 } | |
| 3263 | 192 #endif /* not NEW_GC */ |
| 428 | 193 |
| 194 void | |
| 195 init_opaque_once_early (void) | |
| 196 { | |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3017
diff
changeset
|
197 INIT_LISP_OBJECT (opaque); |
|
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3017
diff
changeset
|
198 INIT_LISP_OBJECT (opaque_ptr); |
| 442 | 199 |
| 3263 | 200 #ifndef NEW_GC |
| 1204 | 201 reinit_opaque_early (); |
| 3263 | 202 #endif /* not NEW_GC */ |
| 428 | 203 } |