Mercurial > hg > xemacs-beta
annotate src/lrecord.h @ 5180:4cd28c29a7a1
merge
| author | Ben Wing <ben@xemacs.org> |
|---|---|
| date | Mon, 29 Mar 2010 22:52:01 -0500 |
| parents | 14fda1dbdb26 97eb4942aec8 |
| children | 71ee43b8a74d |
| rev | line source |
|---|---|
| 428 | 1 /* The "lrecord" structure (header of a compound lisp object). |
| 2 Copyright (C) 1993, 1994, 1995 Free Software Foundation, Inc. | |
| 5125 | 3 Copyright (C) 1996, 2001, 2002, 2004, 2005, 2009, 2010 Ben Wing. |
| 428 | 4 |
| 5 This file is part of XEmacs. | |
| 6 | |
| 7 XEmacs is free software; you can redistribute it and/or modify it | |
| 8 under the terms of the GNU General Public License as published by the | |
| 9 Free Software Foundation; either version 2, or (at your option) any | |
| 10 later version. | |
| 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 | |
| 18 along with XEmacs; see the file COPYING. If not, write to | |
| 19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
| 20 Boston, MA 02111-1307, USA. */ | |
| 21 | |
| 22 /* Synched up with: Not in FSF. */ | |
| 23 | |
| 2367 | 24 /* This file has been Mule-ized, Ben Wing, 10-13-04. */ |
| 25 | |
| 440 | 26 #ifndef INCLUDED_lrecord_h_ |
| 27 #define INCLUDED_lrecord_h_ | |
| 428 | 28 |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
29 /* All objects other than char and int are implemented as structures and |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
30 passed by reference. Such objects are called "record objects" ("record" |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
31 is another term for "structure"). The "wrapped" value of such an object |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
32 (i.e. when stored in a variable of type Lisp_Object) is simply the raw |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
33 pointer coerced to an integral type the same size as the pointer |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
34 (usually `long'). |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
35 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
36 Under old-GC (i.e. when NEW_GC is not defined), there are two kinds of |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
37 record objects: normal objects (those allocated on their own with |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
38 xmalloc()) and frob-block objects (those allocated as pieces of large, |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
39 usually 2K, chunks of memory known as "frob blocks"). Under NEW_GC, |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
40 there is only one type of record object. Stuff below that applies to |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
41 frob-block objects is assumed to apply to the same type of object as |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
42 normal objects under NEW_GC. |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
43 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
44 Record objects have a header at the beginning of their structure, which |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
45 is used internally to identify the type of the object (so that an |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
46 object's type can be recovered from its pointer); in addition, it holds |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
47 a few flags and a "UID", which for most objects is shown when it is |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
48 printed, and is primarily useful for debugging purposes. The header of |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
49 a normal object is declared as NORMAL_LISP_OBJECT_HEADER and that of a |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
50 frob-block object FROB_BLOCK_LISP_OBJECT_HEADER. |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
51 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
52 FROB_BLOCK_LISP_OBJECT_HEADER boils down to a `struct lrecord_header'. |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
53 This is a 32-bit value made up of bit fields, where 8 bits are used to |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
54 hold the type, 2 or 3 bits are used for flags associated with the |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
55 garbage collector, and the remaining 21 or 22 bits hold the UID. |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
56 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
57 Under NEW_GC, NORMAL_LISP_OBJECT_HEADER also resolves to `struct |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
58 lrecord_header'. Under old-GC, however, NORMAL_LISP_OBJECT_HEADER |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
59 resolves to a `struct old_lcrecord_header' (note the `c'), which is a |
|
5142
f965e31a35f0
reduce lcrecord headers to 2 words, rename printing_unreadable_object
Ben Wing <ben@xemacs.org>
parents:
5128
diff
changeset
|
60 larger structure -- on 32-bit machines it occupies 2 machine words |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
61 instead of 1. Such an object is known internally as an "lcrecord". The |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
62 first word of `struct old_lcrecord_header' is an embedded `struct |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
63 lrecord_header' with the same information as for frob-block objects; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
64 that way, all objects can be cast to a `struct lrecord_header' to |
|
5142
f965e31a35f0
reduce lcrecord headers to 2 words, rename printing_unreadable_object
Ben Wing <ben@xemacs.org>
parents:
5128
diff
changeset
|
65 determine their type or other info. The other word is a pointer, used |
|
f965e31a35f0
reduce lcrecord headers to 2 words, rename printing_unreadable_object
Ben Wing <ben@xemacs.org>
parents:
5128
diff
changeset
|
66 to thread all lcrecords together in one big linked list. |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
67 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
68 Under old-GC, normal objects (i.e. lcrecords) are allocated in |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
69 individual chunks using the underlying allocator (i.e. xmalloc(), which |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
70 is a thin wrapper around malloc()). Frob-block objects are more |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
71 efficient than normal objects, as they have a smaller header and don't |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
72 have the additional memory overhead associated with malloc() -- instead, |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
73 as mentioned above, they are carved out of 2K chunks of memory called |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
74 "frob blocks"). However, it is slightly more tricky to create such |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
75 objects, as they require special routines in alloc.c to create an object |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
76 of each such type and to sweep them during garbage collection. In |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
77 addition, there is currently no mechanism for handling variable-sized |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
78 frob-block objects (e.g. vectors), whereas variable-sized normal objects |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
79 are not a problem. Frob-block objects are typically used for basic |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
80 objects that exist in large numbers, such as `cons' or `string'. |
| 2720 | 81 |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
82 Note that strings are an apparent exception to the statement above that |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
83 variable-sized objects can't be handled. Under old-GC strings work as |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
84 follows. A string consists of two parts -- a fixed-size "string header" |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
85 that is allocated as a standard frob-block object, and a "string-chars" |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
86 structure that is allocated out of special 8K-sized frob blocks that |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
87 have a dedicated garbage-collection handler that compacts the blocks |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
88 during the sweep stage, relocating the string-chars data (but not the |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
89 string headers) to eliminate gaps. Strings larger than 8K are not |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
90 placed in frob blocks, but instead are stored as individually malloc()ed |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
91 blocks of memory. Strings larger than 8K are called "big strings" and |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
92 those smaller than 8K are called "small strings". |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
93 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
94 Under new-GC, there is no difference between big and small strings, |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
95 just as there is no difference between normal and frob-block objects. |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
96 There is only one allocation method, which is capable of handling |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
97 variable-sized objects. This apparently allocates all objects in |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
98 frob blocks according to the size of the object. |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
99 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
100 To create a new normal Lisp object, see the toolbar-button example |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
101 below. To create a new frob-block Lisp object, follow the lead of |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
102 one of the existing frob-block objects, such as extents or events. |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
103 Note that you do not need to supply all the methods (see below); |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
104 reasonable defaults are provided for many of them. Alternatively, if |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
105 you're just looking for a way of encapsulating data (which possibly |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
106 could contain Lisp_Objects in it), you may well be able to use the |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
107 opaque type. |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
108 */ |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
109 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
110 /* |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
111 How to declare a Lisp object: |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
112 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
113 NORMAL_LISP_OBJECT_HEADER: |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
114 Header for normal objects |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
115 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
116 FROB_BLOCK_LISP_OBJECT_HEADER: |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
117 Header for frob-block objects |
| 428 | 118 |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
119 How to allocate a Lisp object: |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
120 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
121 - For normal objects of a fixed size, simply call |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
122 ALLOC_NORMAL_LISP_OBJECT (type), where TYPE is the name of the type |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
123 (e.g. toolbar_button). Such objects can be freed manually using |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
124 free_normal_lisp_object. |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
125 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
126 - For normal objects whose size can vary (and hence which have a |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
127 size_in_bytes_method rather than a static_size), call |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
128 ALLOC_SIZED_LISP_OBJECT (size, type), where TYPE is the |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
129 name of the type. NOTE: You cannot call free_normal_lisp_object() on such |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
130 on object! (At least when not NEW_GC) |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
131 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
132 - For frob-block objects, use |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
133 ALLOC_FROB_BLOCK_LISP_OBJECT (type, lisp_type, var, lrec_ptr). |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
134 But these objects need special handling; if you don't understand this, |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
135 just ignore it. |
| 428 | 136 |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
137 - Some lrecords, which are used totally internally, use the |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
138 noseeum-* functions for debugging reasons. |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
139 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
140 Other operations: |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
141 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
142 - copy_lisp_object (dst, src) |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
143 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
144 - zero_nonsized_lisp_object (obj), zero_sized_lisp_object (obj, size): |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
145 BUT NOTE, it is not necessary to zero out newly allocated Lisp objects. |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
146 This happens automatically. |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
147 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
148 - lisp_object_size (obj): Return the size of a Lisp object. NOTE: This |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
149 requires that the object is properly initialized. |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
150 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
151 - lisp_object_storage_size (obj, stats): Return the storage size of a |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
152 Lisp objcet, including malloc or frob-block overhead; also, if STATS |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
153 is non-NULL, accumulate info about the size and overhead into STATS. |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
154 */ |
|
4930
9f04877ce07e
fix up comments about finalizers and NEWGC internal objects
Ben Wing <ben@xemacs.org>
parents:
4844
diff
changeset
|
155 |
|
9f04877ce07e
fix up comments about finalizers and NEWGC internal objects
Ben Wing <ben@xemacs.org>
parents:
4844
diff
changeset
|
156 #ifdef NEW_GC |
|
9f04877ce07e
fix up comments about finalizers and NEWGC internal objects
Ben Wing <ben@xemacs.org>
parents:
4844
diff
changeset
|
157 /* |
|
9f04877ce07e
fix up comments about finalizers and NEWGC internal objects
Ben Wing <ben@xemacs.org>
parents:
4844
diff
changeset
|
158 There are some limitations under New-GC that lead to the creation of a |
|
9f04877ce07e
fix up comments about finalizers and NEWGC internal objects
Ben Wing <ben@xemacs.org>
parents:
4844
diff
changeset
|
159 large number of new internal object types. I'm not completely sure what |
|
9f04877ce07e
fix up comments about finalizers and NEWGC internal objects
Ben Wing <ben@xemacs.org>
parents:
4844
diff
changeset
|
160 all of them are, but they are at least partially related to limitations |
|
9f04877ce07e
fix up comments about finalizers and NEWGC internal objects
Ben Wing <ben@xemacs.org>
parents:
4844
diff
changeset
|
161 on finalizers. Something else must be going on as well, because |
|
9f04877ce07e
fix up comments about finalizers and NEWGC internal objects
Ben Wing <ben@xemacs.org>
parents:
4844
diff
changeset
|
162 non-dumpable, non-finalizable objects like devices and frames also have |
|
9f04877ce07e
fix up comments about finalizers and NEWGC internal objects
Ben Wing <ben@xemacs.org>
parents:
4844
diff
changeset
|
163 their window-system-specific substructures converted into Lisp objects. |
|
9f04877ce07e
fix up comments about finalizers and NEWGC internal objects
Ben Wing <ben@xemacs.org>
parents:
4844
diff
changeset
|
164 It must have something to do with the fact that these substructures |
|
9f04877ce07e
fix up comments about finalizers and NEWGC internal objects
Ben Wing <ben@xemacs.org>
parents:
4844
diff
changeset
|
165 contain pointers to Lisp objects, but it's not completely clear why -- |
|
9f04877ce07e
fix up comments about finalizers and NEWGC internal objects
Ben Wing <ben@xemacs.org>
parents:
4844
diff
changeset
|
166 object descriptions exist to indicate the size of these structures and |
|
9f04877ce07e
fix up comments about finalizers and NEWGC internal objects
Ben Wing <ben@xemacs.org>
parents:
4844
diff
changeset
|
167 the Lisp object pointers within them. |
|
9f04877ce07e
fix up comments about finalizers and NEWGC internal objects
Ben Wing <ben@xemacs.org>
parents:
4844
diff
changeset
|
168 |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
169 At least one definite issue is that under New-GC dumpable objects cannot |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
170 contain any finalizers (see pdump_register_object()). This means that |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
171 any substructures in dumpable objects that are allocated separately and |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
172 normally freed in a finalizer need instead to be made into actual Lisp |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
173 objects. If those structures are Dynarrs, they need to be made into |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
174 Dynarr Lisp objects (e.g. face-cachel-dynarr or glyph-cachel-dynarr), |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
175 which are created using Dynarr_lisp_new() or Dynarr_new_new2(). |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
176 Furthermore, the objects contained in the Dynarr also need to be Lisp |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
177 objects (e.g. face-cachel or glyph-cachel). |
|
4930
9f04877ce07e
fix up comments about finalizers and NEWGC internal objects
Ben Wing <ben@xemacs.org>
parents:
4844
diff
changeset
|
178 |
|
9f04877ce07e
fix up comments about finalizers and NEWGC internal objects
Ben Wing <ben@xemacs.org>
parents:
4844
diff
changeset
|
179 --ben |
|
9f04877ce07e
fix up comments about finalizers and NEWGC internal objects
Ben Wing <ben@xemacs.org>
parents:
4844
diff
changeset
|
180 */ |
|
9f04877ce07e
fix up comments about finalizers and NEWGC internal objects
Ben Wing <ben@xemacs.org>
parents:
4844
diff
changeset
|
181 #endif |
|
9f04877ce07e
fix up comments about finalizers and NEWGC internal objects
Ben Wing <ben@xemacs.org>
parents:
4844
diff
changeset
|
182 |
| 3263 | 183 #ifdef NEW_GC |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
184 #define ALLOC_NORMAL_LISP_OBJECT(type) alloc_lrecord (&lrecord_##type) |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
185 #define ALLOC_SIZED_LISP_OBJECT(size, type) \ |
|
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
186 alloc_sized_lrecord (size, &lrecord_##type) |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
187 #define NORMAL_LISP_OBJECT_HEADER struct lrecord_header |
|
5120
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
188 #define FROB_BLOCK_LISP_OBJECT_HEADER struct lrecord_header |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
189 #define LISP_OBJECT_FROB_BLOCK_P(obj) 0 |
|
5169
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
190 #define IF_NEW_GC(x) x |
|
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
191 #define IF_OLD_GC(x) 0 |
| 3263 | 192 #else /* not NEW_GC */ |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
193 #define ALLOC_NORMAL_LISP_OBJECT(type) alloc_automanaged_lcrecord (&lrecord_##type) |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
194 #define ALLOC_SIZED_LISP_OBJECT(size, type) \ |
|
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
195 old_alloc_sized_lcrecord (size, &lrecord_##type) |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
196 #define NORMAL_LISP_OBJECT_HEADER struct old_lcrecord_header |
|
5120
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
197 #define FROB_BLOCK_LISP_OBJECT_HEADER struct lrecord_header |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
198 #define LISP_OBJECT_FROB_BLOCK_P(obj) (XRECORD_LHEADER_IMPLEMENTATION(obj)->frob_block_p) |
|
5169
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
199 #define IF_NEW_GC(x) 0 |
|
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
200 #define IF_OLD_GC(x) x |
| 3263 | 201 #endif /* not NEW_GC */ |
| 3024 | 202 |
|
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:
5142
diff
changeset
|
203 #define LISP_OBJECT_UID(obj) (XRECORD_LHEADER (obj)->uid) |
|
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:
5142
diff
changeset
|
204 |
| 1743 | 205 BEGIN_C_DECLS |
| 1650 | 206 |
| 428 | 207 struct lrecord_header |
| 208 { | |
| 1204 | 209 /* Index into lrecord_implementations_table[]. Objects that have been |
| 210 explicitly freed using e.g. free_cons() have lrecord_type_free in this | |
| 211 field. */ | |
| 442 | 212 unsigned int type :8; |
| 213 | |
| 3263 | 214 #ifdef NEW_GC |
| 2720 | 215 /* 1 if the object is readonly from lisp */ |
| 216 unsigned int lisp_readonly :1; | |
| 217 | |
| 218 /* The `free' field is a flag that indicates whether this lrecord | |
| 219 is currently free or not. This is used for error checking and | |
| 220 debugging. */ | |
| 221 unsigned int free :1; | |
| 222 | |
| 3063 | 223 /* The `uid' field is just for debugging/printing convenience. Having |
| 224 this slot doesn't hurt us spacewise, since the bits are unused | |
| 225 anyway. (The bits are used for strings, though.) */ | |
| 2720 | 226 unsigned int uid :22; |
| 227 | |
| 3263 | 228 #else /* not NEW_GC */ |
| 442 | 229 /* If `mark' is 0 after the GC mark phase, the object will be freed |
| 230 during the GC sweep phase. There are 2 ways that `mark' can be 1: | |
| 231 - by being referenced from other objects during the GC mark phase | |
| 232 - because it is permanently on, for c_readonly objects */ | |
| 233 unsigned int mark :1; | |
| 234 | |
| 235 /* 1 if the object resides in logically read-only space, and does not | |
| 236 reference other non-c_readonly objects. | |
| 237 Invariant: if (c_readonly == 1), then (mark == 1 && lisp_readonly == 1) */ | |
| 238 unsigned int c_readonly :1; | |
| 239 | |
| 428 | 240 /* 1 if the object is readonly from lisp */ |
| 442 | 241 unsigned int lisp_readonly :1; |
| 771 | 242 |
|
5142
f965e31a35f0
reduce lcrecord headers to 2 words, rename printing_unreadable_object
Ben Wing <ben@xemacs.org>
parents:
5128
diff
changeset
|
243 /* The `free' field is currently used only for lcrecords under old-GC. |
|
f965e31a35f0
reduce lcrecord headers to 2 words, rename printing_unreadable_object
Ben Wing <ben@xemacs.org>
parents:
5128
diff
changeset
|
244 It is a flag that indicates whether this lcrecord is on a "free list". |
|
f965e31a35f0
reduce lcrecord headers to 2 words, rename printing_unreadable_object
Ben Wing <ben@xemacs.org>
parents:
5128
diff
changeset
|
245 Free lists are used to minimize the number of calls to malloc() when |
|
f965e31a35f0
reduce lcrecord headers to 2 words, rename printing_unreadable_object
Ben Wing <ben@xemacs.org>
parents:
5128
diff
changeset
|
246 we're repeatedly allocating and freeing a number of the same sort of |
|
f965e31a35f0
reduce lcrecord headers to 2 words, rename printing_unreadable_object
Ben Wing <ben@xemacs.org>
parents:
5128
diff
changeset
|
247 lcrecord. Lcrecords on a free list always get marked in a different |
|
f965e31a35f0
reduce lcrecord headers to 2 words, rename printing_unreadable_object
Ben Wing <ben@xemacs.org>
parents:
5128
diff
changeset
|
248 fashion, so we can use this flag as a sanity check to make sure that |
|
f965e31a35f0
reduce lcrecord headers to 2 words, rename printing_unreadable_object
Ben Wing <ben@xemacs.org>
parents:
5128
diff
changeset
|
249 free lists only have freed lcrecords and there are no freed lcrecords |
|
f965e31a35f0
reduce lcrecord headers to 2 words, rename printing_unreadable_object
Ben Wing <ben@xemacs.org>
parents:
5128
diff
changeset
|
250 elsewhere. */ |
|
f965e31a35f0
reduce lcrecord headers to 2 words, rename printing_unreadable_object
Ben Wing <ben@xemacs.org>
parents:
5128
diff
changeset
|
251 unsigned int free :1; |
|
f965e31a35f0
reduce lcrecord headers to 2 words, rename printing_unreadable_object
Ben Wing <ben@xemacs.org>
parents:
5128
diff
changeset
|
252 |
| 3063 | 253 /* The `uid' field is just for debugging/printing convenience. Having |
| 254 this slot doesn't hurt us spacewise, since the bits are unused | |
| 255 anyway. (The bits are used for strings, though.) */ | |
|
5142
f965e31a35f0
reduce lcrecord headers to 2 words, rename printing_unreadable_object
Ben Wing <ben@xemacs.org>
parents:
5128
diff
changeset
|
256 unsigned int uid :20; |
| 934 | 257 |
| 3263 | 258 #endif /* not NEW_GC */ |
| 428 | 259 }; |
| 260 | |
| 261 struct lrecord_implementation; | |
| 442 | 262 int lrecord_type_index (const struct lrecord_implementation *implementation); |
|
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:
5142
diff
changeset
|
263 extern int lrecord_uid_counter[]; |
| 428 | 264 |
| 3263 | 265 #ifdef NEW_GC |
|
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:
5142
diff
changeset
|
266 #define set_lheader_implementation(header,imp) do { \ |
|
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:
5142
diff
changeset
|
267 struct lrecord_header* SLI_header = (header); \ |
|
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:
5142
diff
changeset
|
268 SLI_header->type = (imp)->lrecord_type_index; \ |
|
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:
5142
diff
changeset
|
269 SLI_header->lisp_readonly = 0; \ |
|
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:
5142
diff
changeset
|
270 SLI_header->free = 0; \ |
|
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:
5142
diff
changeset
|
271 SLI_header->uid = lrecord_uid_counter[(imp)->lrecord_type_index]++; \ |
| 2720 | 272 } while (0) |
| 3263 | 273 #else /* not NEW_GC */ |
|
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:
5142
diff
changeset
|
274 #define set_lheader_implementation(header,imp) do { \ |
|
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:
5142
diff
changeset
|
275 struct lrecord_header* SLI_header = (header); \ |
|
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:
5142
diff
changeset
|
276 SLI_header->type = (imp)->lrecord_type_index; \ |
|
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:
5142
diff
changeset
|
277 SLI_header->mark = 0; \ |
|
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:
5142
diff
changeset
|
278 SLI_header->c_readonly = 0; \ |
|
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:
5142
diff
changeset
|
279 SLI_header->lisp_readonly = 0; \ |
|
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:
5142
diff
changeset
|
280 SLI_header->free = 0; \ |
|
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:
5142
diff
changeset
|
281 SLI_header->uid = lrecord_uid_counter[(imp)->lrecord_type_index]++; \ |
| 428 | 282 } while (0) |
| 3263 | 283 #endif /* not NEW_GC */ |
| 428 | 284 |
| 3263 | 285 #ifndef NEW_GC |
| 3024 | 286 struct old_lcrecord_header |
| 428 | 287 { |
| 288 struct lrecord_header lheader; | |
| 289 | |
| 442 | 290 /* The `next' field is normally used to chain all lcrecords together |
| 428 | 291 so that the GC can find (and free) all of them. |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
292 `old_alloc_sized_lcrecord' threads lcrecords together. |
| 428 | 293 |
| 294 The `next' field may be used for other purposes as long as some | |
| 295 other mechanism is provided for letting the GC do its work. | |
| 296 | |
| 297 For example, the event and marker object types allocate members | |
| 298 out of memory chunks, and are able to find all unmarked members | |
| 299 by sweeping through the elements of the list of chunks. */ | |
| 3024 | 300 struct old_lcrecord_header *next; |
| 428 | 301 }; |
| 302 | |
| 303 /* Used for lcrecords in an lcrecord-list. */ | |
| 304 struct free_lcrecord_header | |
| 305 { | |
| 3024 | 306 struct old_lcrecord_header lcheader; |
| 428 | 307 Lisp_Object chain; |
| 308 }; | |
| 3263 | 309 #endif /* not NEW_GC */ |
| 428 | 310 |
| 3931 | 311 /* DON'T FORGET to update .gdbinit.in if you change this list. */ |
| 442 | 312 enum lrecord_type |
| 313 { | |
| 314 /* Symbol value magic types come first to make SYMBOL_VALUE_MAGIC_P fast. | |
| 315 #### This should be replaced by a symbol_value_magic_p flag | |
| 316 in the Lisp_Symbol lrecord_header. */ | |
|
5169
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
317 /* Don't assign any type to 0, so in case we come across zeroed memory |
|
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
318 it will be more obvious when printed */ |
|
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
319 lrecord_type_symbol_value_forward = 1, |
| 3092 | 320 lrecord_type_symbol_value_varalias, |
| 321 lrecord_type_symbol_value_lisp_magic, | |
| 322 lrecord_type_symbol_value_buffer_local, | |
| 442 | 323 lrecord_type_max_symbol_value_magic = lrecord_type_symbol_value_buffer_local, |
| 3092 | 324 lrecord_type_symbol, |
| 325 lrecord_type_subr, | |
|
4677
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3931
diff
changeset
|
326 lrecord_type_multiple_value, |
| 3092 | 327 lrecord_type_cons, |
| 328 lrecord_type_vector, | |
| 329 lrecord_type_string, | |
| 3263 | 330 #ifndef NEW_GC |
| 442 | 331 lrecord_type_lcrecord_list, |
| 3263 | 332 #endif /* not NEW_GC */ |
| 3092 | 333 lrecord_type_compiled_function, |
| 334 lrecord_type_weak_list, | |
| 335 lrecord_type_bit_vector, | |
| 336 lrecord_type_float, | |
| 337 lrecord_type_hash_table, | |
| 338 lrecord_type_lstream, | |
| 339 lrecord_type_process, | |
| 340 lrecord_type_charset, | |
| 341 lrecord_type_coding_system, | |
| 342 lrecord_type_char_table, | |
| 343 lrecord_type_char_table_entry, | |
| 344 lrecord_type_range_table, | |
| 345 lrecord_type_opaque, | |
| 346 lrecord_type_opaque_ptr, | |
| 347 lrecord_type_buffer, | |
| 348 lrecord_type_extent, | |
| 349 lrecord_type_extent_info, | |
| 350 lrecord_type_extent_auxiliary, | |
| 351 lrecord_type_marker, | |
| 352 lrecord_type_event, | |
| 2720 | 353 #ifdef EVENT_DATA_AS_OBJECTS /* not defined */ |
| 934 | 354 lrecord_type_key_data, |
| 355 lrecord_type_button_data, | |
| 356 lrecord_type_motion_data, | |
| 357 lrecord_type_process_data, | |
| 358 lrecord_type_timeout_data, | |
| 359 lrecord_type_eval_data, | |
| 360 lrecord_type_misc_user_data, | |
| 361 lrecord_type_magic_eval_data, | |
| 362 lrecord_type_magic_data, | |
| 1204 | 363 #endif /* EVENT_DATA_AS_OBJECTS */ |
| 3092 | 364 lrecord_type_keymap, |
| 365 lrecord_type_command_builder, | |
| 366 lrecord_type_timeout, | |
| 367 lrecord_type_specifier, | |
| 368 lrecord_type_console, | |
| 369 lrecord_type_device, | |
| 370 lrecord_type_frame, | |
| 371 lrecord_type_window, | |
| 372 lrecord_type_window_mirror, | |
| 373 lrecord_type_gui_item, | |
| 374 lrecord_type_toolbar_button, | |
| 375 lrecord_type_scrollbar_instance, | |
| 376 lrecord_type_color_instance, | |
| 377 lrecord_type_font_instance, | |
| 378 lrecord_type_image_instance, | |
| 379 lrecord_type_glyph, | |
| 380 lrecord_type_face, | |
| 3931 | 381 lrecord_type_fc_config, |
| 3094 | 382 lrecord_type_fc_pattern, |
| 3092 | 383 lrecord_type_database, |
| 384 lrecord_type_tooltalk_message, | |
| 385 lrecord_type_tooltalk_pattern, | |
| 386 lrecord_type_ldap, | |
| 387 lrecord_type_pgconn, | |
| 388 lrecord_type_pgresult, | |
| 389 lrecord_type_devmode, | |
| 390 lrecord_type_mswindows_dialog_id, | |
| 391 lrecord_type_case_table, | |
| 392 lrecord_type_emacs_ffi, | |
| 393 lrecord_type_emacs_gtk_object, | |
| 394 lrecord_type_emacs_gtk_boxed, | |
| 395 lrecord_type_weak_box, | |
| 396 lrecord_type_ephemeron, | |
| 397 lrecord_type_bignum, | |
| 398 lrecord_type_ratio, | |
| 399 lrecord_type_bigfloat, | |
| 3263 | 400 #ifndef NEW_GC |
| 454 | 401 lrecord_type_free, /* only used for "free" lrecords */ |
| 402 lrecord_type_undefined, /* only used for debugging */ | |
| 3263 | 403 #endif /* not NEW_GC */ |
| 3092 | 404 #ifdef NEW_GC |
|
4930
9f04877ce07e
fix up comments about finalizers and NEWGC internal objects
Ben Wing <ben@xemacs.org>
parents:
4844
diff
changeset
|
405 /* See comment up top explaining why these extra object types must exist. */ |
| 3092 | 406 lrecord_type_string_indirect_data, |
| 407 lrecord_type_string_direct_data, | |
| 408 lrecord_type_hash_table_entry, | |
| 409 lrecord_type_syntax_cache, | |
| 410 lrecord_type_buffer_text, | |
| 411 lrecord_type_compiled_function_args, | |
| 412 lrecord_type_tty_console, | |
| 413 lrecord_type_stream_console, | |
| 414 lrecord_type_dynarr, | |
| 415 lrecord_type_face_cachel, | |
| 416 lrecord_type_face_cachel_dynarr, | |
| 417 lrecord_type_glyph_cachel, | |
| 418 lrecord_type_glyph_cachel_dynarr, | |
| 419 lrecord_type_x_device, | |
| 420 lrecord_type_gtk_device, | |
| 421 lrecord_type_tty_device, | |
| 422 lrecord_type_mswindows_device, | |
| 423 lrecord_type_msprinter_device, | |
| 424 lrecord_type_x_frame, | |
| 425 lrecord_type_gtk_frame, | |
| 426 lrecord_type_mswindows_frame, | |
| 427 lrecord_type_gap_array_marker, | |
| 428 lrecord_type_gap_array, | |
| 429 lrecord_type_extent_list_marker, | |
| 430 lrecord_type_extent_list, | |
| 431 lrecord_type_stack_of_extents, | |
| 432 lrecord_type_tty_color_instance_data, | |
| 433 lrecord_type_tty_font_instance_data, | |
| 434 lrecord_type_specifier_caching, | |
| 435 lrecord_type_expose_ignore, | |
| 436 #endif /* NEW_GC */ | |
| 437 lrecord_type_last_built_in_type /* must be last */ | |
| 442 | 438 }; |
| 439 | |
| 1632 | 440 extern MODULE_API int lrecord_type_count; |
| 428 | 441 |
| 442 struct lrecord_implementation | |
| 443 { | |
| 2367 | 444 const Ascbyte *name; |
| 442 | 445 |
| 934 | 446 /* information for the dumper: is the object dumpable and should it |
| 447 be dumped. */ | |
| 448 unsigned int dumpable :1; | |
| 449 | |
| 442 | 450 /* `marker' is called at GC time, to make sure that all Lisp_Objects |
| 428 | 451 pointed to by this object get properly marked. It should call |
| 452 the mark_object function on all Lisp_Objects in the object. If | |
| 453 the return value is non-nil, it should be a Lisp_Object to be | |
| 454 marked (don't call the mark_object function explicitly on it, | |
| 455 because the GC routines will do this). Doing it this way reduces | |
| 456 recursion, so the object returned should preferably be the one | |
| 457 with the deepest level of Lisp_Object pointers. This function | |
| 1204 | 458 can be NULL, meaning no GC marking is necessary. |
| 459 | |
| 460 NOTE NOTE NOTE: This is not used by KKCC (which uses the data | |
| 461 description below instead), unless the data description is missing. | |
| 462 Yes, this currently means there is logic duplication. Eventually the | |
| 463 mark methods will be removed. */ | |
| 428 | 464 Lisp_Object (*marker) (Lisp_Object); |
| 442 | 465 |
|
5124
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
466 /* `printer' converts the object to a printed representation. `printer' |
|
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
467 should never be NULL (if so, you will get an assertion failure when |
|
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
468 trying to print such an object). Either supply a specific printing |
|
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
469 method, or use the default methods internal_object_printer() (for |
|
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
470 internal objects that should not be visible at Lisp level) or |
|
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
471 external_object_printer() (for objects visible at Lisp level). */ |
| 428 | 472 void (*printer) (Lisp_Object, Lisp_Object printcharfun, int escapeflag); |
| 442 | 473 |
|
5124
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
474 /* `finalizer' is called at GC time when the object is about to be freed. |
|
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
475 It should perform any necessary cleanup, such as freeing malloc()ed |
|
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
476 memory or releasing pointers or handles to objects created in external |
|
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
477 libraries, such as window-system windows or file handles. This can be |
|
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
478 NULL, meaning no special finalization is necessary. */ |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
479 void (*finalizer) (Lisp_Object obj); |
| 442 | 480 |
| 428 | 481 /* This can be NULL, meaning compare objects with EQ(). */ |
|
4906
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4844
diff
changeset
|
482 int (*equal) (Lisp_Object obj1, Lisp_Object obj2, int depth, |
|
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4844
diff
changeset
|
483 int foldcase); |
| 442 | 484 |
| 485 /* `hash' generates hash values for use with hash tables that have | |
| 486 `equal' as their test function. This can be NULL, meaning use | |
| 487 the Lisp_Object itself as the hash. But, you must still satisfy | |
| 488 the constraint that if two objects are `equal', then they *must* | |
| 489 hash to the same value in order for hash tables to work properly. | |
| 490 This means that `hash' can be NULL only if the `equal' method is | |
| 491 also NULL. */ | |
| 2515 | 492 Hashcode (*hash) (Lisp_Object, int); |
| 428 | 493 |
| 1204 | 494 /* Data layout description for your object. See long comment below. */ |
| 495 const struct memory_description *description; | |
| 428 | 496 |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
497 /* Only one of `static_size' and `size_in_bytes_method' is non-0. If |
|
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
498 `static_size' is 0, this type is not instantiable by |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
499 ALLOC_NORMAL_LISP_OBJECT(). If both are 0 (this should never happen), |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
500 this object cannot be instantiated; you will get an abort() if you |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
501 try.*/ |
| 665 | 502 Bytecount static_size; |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
503 Bytecount (*size_in_bytes_method) (Lisp_Object); |
| 442 | 504 |
| 505 /* The (constant) index into lrecord_implementations_table */ | |
| 506 enum lrecord_type lrecord_type_index; | |
| 507 | |
| 3263 | 508 #ifndef NEW_GC |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
509 /* A "frob-block" lrecord is any lrecord that's not an lcrecord, i.e. |
| 3024 | 510 one that does not have an old_lcrecord_header at the front and which |
| 1204 | 511 is (usually) allocated in frob blocks. */ |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
512 unsigned int frob_block_p :1; |
| 3263 | 513 #endif /* not NEW_GC */ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
514 |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
515 /**********************************************************************/ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
516 /* Remaining stuff is not assignable statically using |
|
5170
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
517 DEFINE_*_LISP_OBJECT, but must be assigned with OBJECT_HAS_METHOD, |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
518 OBJECT_HAS_PROPERTY or the like. */ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
519 |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
520 /* These functions allow any object type to have builtin property |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
521 lists that can be manipulated from the lisp level with |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
522 `get', `put', `remprop', and `object-plist'. */ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
523 Lisp_Object (*getprop) (Lisp_Object obj, Lisp_Object prop); |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
524 int (*putprop) (Lisp_Object obj, Lisp_Object prop, Lisp_Object val); |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
525 int (*remprop) (Lisp_Object obj, Lisp_Object prop); |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
526 Lisp_Object (*plist) (Lisp_Object obj); |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
527 |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
528 /* `disksave' is called at dump time. It is used for objects that |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
529 contain pointers or handles to objects created in external libraries, |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
530 such as window-system windows or file handles. Such external objects |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
531 cannot be dumped, so it is necessary to release them at dump time and |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
532 arrange somehow or other for them to be resurrected if necessary later |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
533 on. |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
534 |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
535 It seems that even non-dumpable objects may be around at dump time, |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
536 and a disksave may be provided. (In fact, the only object currently |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
537 with a disksave, lstream, is non-dumpable.) |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
538 |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
539 Objects rarely need to provide this method; most of the time it will |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
540 be NULL. */ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
541 void (*disksave) (Lisp_Object); |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
542 |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
543 #ifdef MEMORY_USAGE_STATS |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
544 /* Return memory-usage information about the object in question, stored |
|
5170
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
545 into STATS. |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
546 |
|
5170
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
547 Two types of information are stored: storage (including overhead) for |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
548 ancillary non-Lisp structures attached to the object, and storage |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
549 (including overhead) for ancillary Lisp objects attached to the |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
550 object. The third type of memory-usage information (storage for the |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
551 object itself) is not noted here, because it's computed automatically |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
552 by the calling function. Also, the computed storage for ancillary |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
553 Lisp objects is the sum of all three source of memory associated with |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
554 the Lisp object: the object itself, ancillary non-Lisp structures and |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
555 ancillary Lisp objects. Note also that the `struct usage_stats u' at |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
556 the beginning of the STATS structure is for ancillary non-Lisp usage |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
557 *ONLY*; do not store any memory into it related to ancillary Lisp |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
558 objects. |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
559 |
|
5170
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
560 Note that it may be subjective which Lisp objects are considered |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
561 "attached" to the object. Some guidelines: |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
562 |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
563 -- Lisp objects which are "internal" to the main object and not |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
564 accessible except through the main object should be included |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
565 -- Objects linked by a weak reference should *NOT* be included |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
566 */ |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
567 void (*memory_usage) (Lisp_Object obj, struct generic_usage_stats *stats); |
|
5158
9e0b43d3095c
more cleanups to object-memory-usage stuff
Ben Wing <ben@xemacs.org>
parents:
5157
diff
changeset
|
568 |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
569 /* List of tags to be given to the extra statistics, one per statistic. |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
570 Qnil or Qt can be present to separate off different slices. Qnil |
|
5170
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
571 separates different slices within the same group of statistics. |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
572 These represent different ways of partitioning the same memory space. |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
573 Qt separates different groups; these represent different spaces of |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
574 memory. |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
575 |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
576 If Qt is not present, all slices describe extra non-Lisp-Object memory |
|
5170
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
577 associated with a Lisp object. If Qt is present, slices before Qt |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
578 describe non-Lisp-Object memory, as before, and slices after Qt |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
579 describe ancillary Lisp-Object memory logically associated with the |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
580 object. For example, if the object is a table, then ancillary |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
581 Lisp-Object memory might be the entries in the table. This info is |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
582 only advisory since it will duplicate memory described elsewhere and |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
583 since it may not be possible to be completely accurate, e.g. it may |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
584 not be clear what to count in "ancillary objects", and the value may |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
585 be too high if the same object occurs multiple times in the table. */ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
586 Lisp_Object memusage_stats_list; |
|
5170
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
587 |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
588 /* --------------------------------------------------------------------- */ |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
589 |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
590 /* The following are automatically computed based on the value in |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
591 `memusage_stats_list' (see compute_memusage_stats_length()). */ |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
592 |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
593 /* Total number of additional type-specific statistics related to memory |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
594 usage. */ |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
595 Elemcount num_extra_memusage_stats; |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
596 |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
597 /* Number of additional type-specific statistics belonging to the first |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
598 slice of the group describing non-Lisp-Object memory usage for this |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
599 object. These stats occur starting at offset 0. */ |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
600 Elemcount num_extra_nonlisp_memusage_stats; |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
601 |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
602 /* The offset into the extra statistics at which the Lisp-Object |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
603 memory-usage statistics begin. */ |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
604 Elemcount offset_lisp_ancillary_memusage_stats; |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
605 |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
606 /* Number of additional type-specific statistics belonging to the first |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
607 slice of the group describing Lisp-Object memory usage for this |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
608 object. These stats occur starting at offset |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
609 `offset_lisp_ancillary_memusage_stats'. */ |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
610 Elemcount num_extra_lisp_ancillary_memusage_stats; |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
611 |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
612 #endif /* MEMORY_USAGE_STATS */ |
| 428 | 613 }; |
| 614 | |
| 617 | 615 /* All the built-in lisp object types are enumerated in `enum lrecord_type'. |
| 442 | 616 Additional ones may be defined by a module (none yet). We leave some |
| 617 room in `lrecord_implementations_table' for such new lisp object types. */ | |
| 618 #define MODULE_DEFINABLE_TYPE_COUNT 32 | |
| 619 | |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
620 extern MODULE_API struct lrecord_implementation * |
| 1632 | 621 lrecord_implementations_table[lrecord_type_last_built_in_type + MODULE_DEFINABLE_TYPE_COUNT]; |
| 428 | 622 |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
623 /* Given a Lisp object, return its implementation |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
624 (struct lrecord_implementation) */ |
| 428 | 625 #define XRECORD_LHEADER_IMPLEMENTATION(obj) \ |
| 442 | 626 LHEADER_IMPLEMENTATION (XRECORD_LHEADER (obj)) |
| 627 #define LHEADER_IMPLEMENTATION(lh) lrecord_implementations_table[(lh)->type] | |
| 428 | 628 |
| 3092 | 629 #include "gc.h" |
| 630 | |
| 631 #ifdef NEW_GC | |
| 632 #include "vdb.h" | |
| 633 #endif /* NEW_GC */ | |
| 634 | |
| 428 | 635 extern int gc_in_progress; |
| 636 | |
| 3263 | 637 #ifdef NEW_GC |
| 2720 | 638 #include "mc-alloc.h" |
| 639 | |
| 2994 | 640 #ifdef ALLOC_TYPE_STATS |
| 2720 | 641 void init_lrecord_stats (void); |
| 642 void inc_lrecord_stats (Bytecount size, const struct lrecord_header *h); | |
| 643 void dec_lrecord_stats (Bytecount size_including_overhead, | |
| 644 const struct lrecord_header *h); | |
| 3092 | 645 int lrecord_stats_heap_size (void); |
| 2994 | 646 #endif /* ALLOC_TYPE_STATS */ |
| 2720 | 647 |
| 648 /* Tell mc-alloc how to call a finalizer. */ | |
| 3092 | 649 #define MC_ALLOC_CALL_FINALIZER(ptr) \ |
| 650 { \ | |
| 651 Lisp_Object MCACF_obj = wrap_pointer_1 (ptr); \ | |
| 652 struct lrecord_header *MCACF_lheader = XRECORD_LHEADER (MCACF_obj); \ | |
| 653 if (XRECORD_LHEADER (MCACF_obj) && LRECORDP (MCACF_obj) \ | |
| 654 && !LRECORD_FREE_P (MCACF_lheader) ) \ | |
| 655 { \ | |
| 656 const struct lrecord_implementation *MCACF_implementation \ | |
| 657 = LHEADER_IMPLEMENTATION (MCACF_lheader); \ | |
| 658 if (MCACF_implementation && MCACF_implementation->finalizer) \ | |
| 659 { \ | |
| 660 GC_STAT_FINALIZED; \ | |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
661 MCACF_implementation->finalizer (MCACF_obj); \ |
| 3092 | 662 } \ |
| 663 } \ | |
| 664 } while (0) | |
| 2720 | 665 |
| 666 /* Tell mc-alloc how to call a finalizer for disksave. */ | |
| 667 #define MC_ALLOC_CALL_FINALIZER_FOR_DISKSAVE(ptr) \ | |
| 668 { \ | |
| 669 Lisp_Object MCACF_obj = wrap_pointer_1 (ptr); \ | |
| 670 struct lrecord_header *MCACF_lheader = XRECORD_LHEADER (MCACF_obj); \ | |
| 671 if (XRECORD_LHEADER (MCACF_obj) && LRECORDP (MCACF_obj) \ | |
| 672 && !LRECORD_FREE_P (MCACF_lheader) ) \ | |
| 673 { \ | |
| 674 const struct lrecord_implementation *MCACF_implementation \ | |
| 675 = LHEADER_IMPLEMENTATION (MCACF_lheader); \ | |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
676 if (MCACF_implementation && MCACF_implementation->disksave) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
677 MCACF_implementation->disksave (MCACF_obj); \ |
| 2720 | 678 } \ |
| 679 } while (0) | |
| 680 | |
| 681 #define LRECORD_FREE_P(ptr) \ | |
| 682 (((struct lrecord_header *) ptr)->free) | |
| 683 | |
| 684 #define MARK_LRECORD_AS_FREE(ptr) \ | |
| 685 ((void) (((struct lrecord_header *) ptr)->free = 1)) | |
| 686 | |
| 687 #define MARK_LRECORD_AS_NOT_FREE(ptr) \ | |
| 688 ((void) (((struct lrecord_header *) ptr)->free = 0)) | |
| 689 | |
| 690 #define MARKED_RECORD_P(obj) MARKED_P (obj) | |
| 691 #define MARKED_RECORD_HEADER_P(lheader) MARKED_P (lheader) | |
| 692 #define MARK_RECORD_HEADER(lheader) MARK (lheader) | |
| 693 #define UNMARK_RECORD_HEADER(lheader) UNMARK (lheader) | |
| 694 | |
| 695 #define LISP_READONLY_RECORD_HEADER_P(lheader) ((lheader)->lisp_readonly) | |
| 696 #define SET_LISP_READONLY_RECORD_HEADER(lheader) \ | |
| 697 ((void) ((lheader)->lisp_readonly = 1)) | |
| 698 #define MARK_LRECORD_AS_LISP_READONLY(ptr) \ | |
| 699 ((void) (((struct lrecord_header *) ptr)->lisp_readonly = 1)) | |
| 700 | |
| 3263 | 701 #else /* not NEW_GC */ |
| 2720 | 702 |
|
5059
c8f90d61dcf3
fix memory usage stats to include pdumped objects
Ben Wing <ben@xemacs.org>
parents:
4967
diff
changeset
|
703 enum lrecord_alloc_status |
|
c8f90d61dcf3
fix memory usage stats to include pdumped objects
Ben Wing <ben@xemacs.org>
parents:
4967
diff
changeset
|
704 { |
|
c8f90d61dcf3
fix memory usage stats to include pdumped objects
Ben Wing <ben@xemacs.org>
parents:
4967
diff
changeset
|
705 ALLOC_IN_USE, |
|
c8f90d61dcf3
fix memory usage stats to include pdumped objects
Ben Wing <ben@xemacs.org>
parents:
4967
diff
changeset
|
706 ALLOC_FREE, |
|
c8f90d61dcf3
fix memory usage stats to include pdumped objects
Ben Wing <ben@xemacs.org>
parents:
4967
diff
changeset
|
707 ALLOC_ON_FREE_LIST |
|
c8f90d61dcf3
fix memory usage stats to include pdumped objects
Ben Wing <ben@xemacs.org>
parents:
4967
diff
changeset
|
708 }; |
|
c8f90d61dcf3
fix memory usage stats to include pdumped objects
Ben Wing <ben@xemacs.org>
parents:
4967
diff
changeset
|
709 |
|
c8f90d61dcf3
fix memory usage stats to include pdumped objects
Ben Wing <ben@xemacs.org>
parents:
4967
diff
changeset
|
710 void tick_lrecord_stats (const struct lrecord_header *h, |
|
c8f90d61dcf3
fix memory usage stats to include pdumped objects
Ben Wing <ben@xemacs.org>
parents:
4967
diff
changeset
|
711 enum lrecord_alloc_status status); |
|
c8f90d61dcf3
fix memory usage stats to include pdumped objects
Ben Wing <ben@xemacs.org>
parents:
4967
diff
changeset
|
712 |
| 2720 | 713 #define LRECORD_FREE_P(ptr) \ |
| 714 (((struct lrecord_header *) ptr)->type == lrecord_type_free) | |
| 715 | |
| 716 #define MARK_LRECORD_AS_FREE(ptr) \ | |
| 717 ((void) (((struct lrecord_header *) ptr)->type = lrecord_type_free)) | |
| 718 | |
| 442 | 719 #define MARKED_RECORD_P(obj) (XRECORD_LHEADER (obj)->mark) |
| 428 | 720 #define MARKED_RECORD_HEADER_P(lheader) ((lheader)->mark) |
| 721 #define MARK_RECORD_HEADER(lheader) ((void) ((lheader)->mark = 1)) | |
| 722 #define UNMARK_RECORD_HEADER(lheader) ((void) ((lheader)->mark = 0)) | |
| 723 | |
| 724 #define C_READONLY_RECORD_HEADER_P(lheader) ((lheader)->c_readonly) | |
| 725 #define LISP_READONLY_RECORD_HEADER_P(lheader) ((lheader)->lisp_readonly) | |
| 442 | 726 #define SET_C_READONLY_RECORD_HEADER(lheader) do { \ |
| 727 struct lrecord_header *SCRRH_lheader = (lheader); \ | |
| 728 SCRRH_lheader->c_readonly = 1; \ | |
| 729 SCRRH_lheader->lisp_readonly = 1; \ | |
| 730 SCRRH_lheader->mark = 1; \ | |
| 731 } while (0) | |
| 428 | 732 #define SET_LISP_READONLY_RECORD_HEADER(lheader) \ |
| 733 ((void) ((lheader)->lisp_readonly = 1)) | |
| 3263 | 734 #endif /* not NEW_GC */ |
| 1676 | 735 |
| 736 #ifdef USE_KKCC | |
| 737 #define RECORD_DESCRIPTION(lheader) lrecord_memory_descriptions[(lheader)->type] | |
| 738 #else /* not USE_KKCC */ | |
| 442 | 739 #define RECORD_MARKER(lheader) lrecord_markers[(lheader)->type] |
| 1676 | 740 #endif /* not USE_KKCC */ |
| 428 | 741 |
| 934 | 742 #define RECORD_DUMPABLE(lheader) (lrecord_implementations_table[(lheader)->type])->dumpable |
| 1204 | 743 |
| 744 /* Data description stuff | |
| 934 | 745 |
| 1204 | 746 Data layout descriptions describe blocks of memory (in particular, Lisp |
| 747 objects and other objects on the heap, and global objects with pointers | |
| 748 to such heap objects), including their size and a list of the elements | |
| 749 that need relocating, marking or other special handling. They are | |
| 750 currently used in two places: by pdump [the new, portable dumper] and | |
| 751 KKCC [the new garbage collector]. The two subsystems use the | |
| 752 descriptions in different ways, and as a result some of the descriptions | |
| 753 are appropriate only for one or the other, when it is known that only | |
| 754 that subsystem will use the description. (This is particularly the case | |
| 755 with objects that can't be dumped, because pdump needs more info than | |
| 756 KKCC.) However, properly written descriptions are appropriate for both, | |
| 757 and you should strive to write your descriptions that way, since the | |
| 758 dumpable status of an object may change and new uses for the | |
| 759 descriptions may be created. (An example that comes to mind is a | |
| 760 facility for determining the memory usage of XEmacs data structures -- | |
| 761 like `buffer-memory-usage', `window-memory-usage', etc. but more | |
| 762 general.) | |
| 763 | |
| 764 More specifically: | |
| 428 | 765 |
| 1204 | 766 Pdump (the portable dumper) needs to write out all objects in heap |
| 767 space, and later on (in another invocation of XEmacs) load them back | |
| 768 into the heap, relocating all pointers to the heap objects in the global | |
| 769 data space. ("Heap" means anything malloc()ed, including all Lisp | |
| 770 objects, and "global data" means anything declared globally or | |
| 771 `static'.) Pdump, then, needs to be told about the location of all | |
| 772 global pointers to heap objects, all the description of all such | |
| 773 objects, including their size and any pointers to other heap (aka | |
| 774 "relocatable") objects. (Pdump assumes that the heap may occur in | |
| 775 different places in different invocations -- therefore, it is not enough | |
| 776 simply to write out the entire heap and later reload it at the same | |
| 777 location -- but that global data is always in the same place, and hence | |
| 778 pointers to it do not need to be relocated. This assumption holds true | |
| 779 in general for modern operating systems, but would be broken, for | |
| 780 example, in a system without virtual memory, or when dealing with shared | |
| 781 libraries. Also, unlike unexec, pdump does not usually write out or | |
| 782 restore objects in the global data space, and thus they need to be | |
| 783 initialized every time XEmacs is loaded. This is the purpose of the | |
| 784 reinit_*() functions throughout XEmacs. [It's possible, however, to make | |
| 785 pdump restore global data. This must be done, of course, for heap | |
| 786 pointers, but is also done for other values that are not easy to | |
| 787 recompute -- in particular, values established by the Lisp code loaded | |
| 788 at dump time.]) Note that the data type `Lisp_Object' is basically just | |
| 789 a relocatable pointer disguised as a long, and in general pdump treats | |
| 790 the Lisp_Object values and pointers to Lisp objects (e.g. Lisp_Object | |
| 791 vs. `struct frame *') identically. (NOTE: This equivalence depends | |
| 792 crucially on the current "minimal tagbits" implementation of Lisp_Object | |
| 793 pointers.) | |
| 428 | 794 |
| 1204 | 795 Descriptions are used by pdump in three places: (a) descriptions of Lisp |
| 796 objects, referenced in the DEFINE_*LRECORD_*IMPLEMENTATION*() call; (b) | |
| 797 descriptions of global objects to be dumped, registered by | |
| 798 dump_add_root_block(); (c) descriptions of global pointers to | |
| 2367 | 799 non-Lisp_Object heap objects, registered by dump_add_root_block_ptr(). |
| 1204 | 800 The descriptions need to tell pdump which elements of your structure are |
| 801 Lisp_Objects or structure pointers, plus the descriptions in turn of the | |
| 802 non-Lisp_Object structures pointed to. If these structures are you own | |
| 803 private ones, you will have to write these recursive descriptions | |
| 804 yourself; otherwise, you are reusing a structure already in existence | |
| 805 elsewhere and there is probably already a description for it. | |
| 806 | |
| 807 Pdump does not care about Lisp objects that cannot be dumped (the | |
| 808 dumpable flag to DEFINE_*LRECORD_*IMPLEMENTATION*() is 0). | |
| 809 | |
| 810 KKCC also uses data layout descriptions, but differently. It cares | |
| 811 about all objects, dumpable or not, but specifically only wants to know | |
| 812 about Lisp_Objects in your object and in structures pointed to. Thus, | |
| 813 it doesn't care about things like pointers to structures ot other blocks | |
| 814 of memory with no Lisp Objects in them, which pdump would care a lot | |
| 815 about. | |
| 816 | |
| 817 Technically, then, you could write your description differently | |
| 818 depending on whether your object is dumpable -- the full pdump | |
| 819 description if so, the abbreviated KKCC description if not. In fact, | |
| 820 some descriptions are written this way. This is dangerous, though, | |
| 821 because another use might come along for the data descriptions, that | |
| 822 doesn't care about the dumper flag and makes use of some of the stuff | |
| 823 normally omitted from the "abbreviated" description -- see above. | |
| 824 | |
| 5094 | 825 A memory_description is an array of values. The first value of each |
| 826 line is a type, the second the offset in the lrecord structure. The | |
| 827 third and following elements are parameters; their presence, type and | |
| 828 number is type-dependent. | |
| 771 | 829 |
| 1204 | 830 The description ends with an "XD_END" record. |
| 771 | 831 |
| 832 The top-level description of an lrecord or lcrecord does not need | |
| 833 to describe every element, just the ones that need to be relocated, | |
| 834 since the size of the lrecord is known. (The same goes for nested | |
| 835 structures, whenever the structure size is given, rather than being | |
| 836 defaulted by specifying 0 for the size.) | |
| 837 | |
| 1204 | 838 A sized_memory_description is a memory_description plus the size of the |
| 839 block of memory. The size field in a sized_memory_description can be | |
| 840 given as zero, i.e. unspecified, meaning that the last element in the | |
| 841 structure is described in the description and the size of the block can | |
| 842 therefore be computed from it. (This is useful for stretchy arrays.) | |
| 843 | |
| 844 memory_descriptions are used to describe lrecords (the size of the | |
| 845 lrecord is elsewhere in its description, attached to its methods, so it | |
| 846 does not need to be given here) and global objects, where the size is an | |
| 847 argument to the call to dump_add_root_block(). | |
| 848 sized_memory_descriptions are used for pointers and arrays in | |
| 2367 | 849 memory_descriptions and for calls to dump_add_root_block_ptr(). (#### |
| 1204 | 850 It is not obvious why this is so in the latter case. Probably, calls to |
| 2367 | 851 dump_add_root_block_ptr() should use plain memory_descriptions and have |
| 1204 | 852 the size be an argument to the call.) |
| 853 | |
| 854 NOTE: Anywhere that a sized_memory_description occurs inside of a plain | |
| 855 memory_description, a "description map" can be substituted. Rather than | |
| 856 being an actual description, this describes how to find the description | |
| 857 by looking inside of the object being described. This is a convenient | |
| 858 way to describe Lisp objects with subtypes and corresponding | |
| 859 type-specific data. | |
| 428 | 860 |
| 861 Some example descriptions : | |
| 440 | 862 |
| 814 | 863 struct Lisp_String |
| 864 { | |
| 865 struct lrecord_header lheader; | |
| 866 Bytecount size; | |
| 867 | 867 Ibyte *data; |
| 814 | 868 Lisp_Object plist; |
| 869 }; | |
| 870 | |
| 1204 | 871 static const struct memory_description cons_description[] = { |
| 440 | 872 { XD_LISP_OBJECT, offsetof (Lisp_Cons, car) }, |
| 873 { XD_LISP_OBJECT, offsetof (Lisp_Cons, cdr) }, | |
| 428 | 874 { XD_END } |
| 875 }; | |
| 876 | |
| 440 | 877 Which means "two lisp objects starting at the 'car' and 'cdr' elements" |
| 428 | 878 |
| 1204 | 879 static const struct memory_description string_description[] = { |
| 814 | 880 { XD_BYTECOUNT, offsetof (Lisp_String, size) }, |
| 1204 | 881 { XD_OPAQUE_DATA_PTR, offsetof (Lisp_String, data), XD_INDIRECT (0, 1) }, |
| 814 | 882 { XD_LISP_OBJECT, offsetof (Lisp_String, plist) }, |
| 883 { XD_END } | |
| 884 }; | |
| 885 | |
| 886 "A pointer to string data at 'data', the size of the pointed array being | |
| 887 the value of the size variable plus 1, and one lisp object at 'plist'" | |
| 888 | |
| 889 If your object has a pointer to an array of Lisp_Objects in it, something | |
| 890 like this: | |
| 891 | |
| 892 struct Lisp_Foo | |
| 893 { | |
| 894 ...; | |
| 895 int count; | |
| 896 Lisp_Object *objects; | |
| 897 ...; | |
| 898 } | |
| 899 | |
| 2367 | 900 You'd use XD_BLOCK_PTR, something like: |
| 814 | 901 |
| 1204 | 902 static const struct memory_description foo_description[] = { |
| 903 ... | |
| 904 { XD_INT, offsetof (Lisp_Foo, count) }, | |
| 2367 | 905 { XD_BLOCK_PTR, offsetof (Lisp_Foo, objects), |
| 2551 | 906 XD_INDIRECT (0, 0), { &lisp_object_description } }, |
| 1204 | 907 ... |
| 908 }; | |
| 909 | |
|
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4937
diff
changeset
|
910 lisp_object_description is declared in gc.c, like this: |
| 1204 | 911 |
| 912 static const struct memory_description lisp_object_description_1[] = { | |
| 814 | 913 { XD_LISP_OBJECT, 0 }, |
| 914 { XD_END } | |
| 915 }; | |
| 916 | |
| 1204 | 917 const struct sized_memory_description lisp_object_description = { |
| 814 | 918 sizeof (Lisp_Object), |
| 1204 | 919 lisp_object_description_1 |
| 814 | 920 }; |
| 921 | |
| 2367 | 922 Another example of XD_BLOCK_PTR: |
| 428 | 923 |
| 1204 | 924 typedef struct htentry |
| 814 | 925 { |
| 926 Lisp_Object key; | |
| 927 Lisp_Object value; | |
| 1204 | 928 } htentry; |
| 814 | 929 |
| 930 struct Lisp_Hash_Table | |
| 931 { | |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
932 NORMAL_LISP_OBJECT_HEADER header; |
| 814 | 933 Elemcount size; |
| 934 Elemcount count; | |
| 935 Elemcount rehash_count; | |
| 936 double rehash_size; | |
| 937 double rehash_threshold; | |
| 938 Elemcount golden_ratio; | |
| 939 hash_table_hash_function_t hash_function; | |
| 940 hash_table_test_function_t test_function; | |
| 1204 | 941 htentry *hentries; |
| 814 | 942 enum hash_table_weakness weakness; |
| 943 Lisp_Object next_weak; // Used to chain together all of the weak | |
| 944 // hash tables. Don't mark through this. | |
| 945 }; | |
| 946 | |
| 1204 | 947 static const struct memory_description htentry_description_1[] = { |
| 948 { XD_LISP_OBJECT, offsetof (htentry, key) }, | |
| 949 { XD_LISP_OBJECT, offsetof (htentry, value) }, | |
| 814 | 950 { XD_END } |
| 951 }; | |
| 952 | |
| 1204 | 953 static const struct sized_memory_description htentry_description = { |
| 954 sizeof (htentry), | |
| 955 htentry_description_1 | |
| 814 | 956 }; |
| 957 | |
| 1204 | 958 const struct memory_description hash_table_description[] = { |
| 814 | 959 { XD_ELEMCOUNT, offsetof (Lisp_Hash_Table, size) }, |
| 2367 | 960 { XD_BLOCK_PTR, offsetof (Lisp_Hash_Table, hentries), XD_INDIRECT (0, 1), |
| 2551 | 961 { &htentry_description } }, |
| 814 | 962 { XD_LO_LINK, offsetof (Lisp_Hash_Table, next_weak) }, |
| 963 { XD_END } | |
| 964 }; | |
| 965 | |
| 966 Note that we don't need to declare all the elements in the structure, just | |
| 967 the ones that need to be relocated (Lisp_Objects and structures) or that | |
| 968 need to be referenced as counts for relocated objects. | |
| 969 | |
| 1204 | 970 A description map looks like this: |
| 971 | |
| 972 static const struct sized_memory_description specifier_extra_description_map [] = { | |
| 973 { offsetof (Lisp_Specifier, methods) }, | |
| 974 { offsetof (struct specifier_methods, extra_description) }, | |
| 975 { -1 } | |
| 976 }; | |
| 977 | |
| 978 const struct memory_description specifier_description[] = { | |
| 979 ... | |
| 2367 | 980 { XD_BLOCK_ARRAY, offset (Lisp_Specifier, data), 1, |
| 2551 | 981 { specifier_extra_description_map } }, |
| 1204 | 982 ... |
| 983 { XD_END } | |
| 984 }; | |
| 985 | |
| 986 This would be appropriate for an object that looks like this: | |
| 987 | |
| 988 struct specifier_methods | |
| 989 { | |
| 990 ... | |
| 991 const struct sized_memory_description *extra_description; | |
| 992 ... | |
| 993 }; | |
| 994 | |
| 995 struct Lisp_Specifier | |
| 996 { | |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
997 NORMAL_LISP_OBJECT_HEADER header; |
| 1204 | 998 struct specifier_methods *methods; |
| 999 | |
| 1000 ... | |
| 1001 // type-specific extra data attached to a specifier | |
| 1002 max_align_t data[1]; | |
| 1003 }; | |
| 1004 | |
| 1005 The description map means "retrieve a pointer into the object at offset | |
| 1006 `offsetof (Lisp_Specifier, methods)' , then in turn retrieve a pointer | |
| 1007 into that object at offset `offsetof (struct specifier_methods, | |
| 1008 extra_description)', and that is the sized_memory_description to use." | |
| 1009 There can be any number of indirections, which can be either into | |
| 1010 straight pointers or Lisp_Objects. The way that description maps are | |
| 1011 distinguished from normal sized_memory_descriptions is that in the | |
| 1012 former, the memory_description pointer is NULL. | |
| 1013 | |
| 1014 --ben | |
| 1015 | |
| 814 | 1016 |
| 1017 The existing types : | |
| 1018 | |
| 1019 | |
| 428 | 1020 XD_LISP_OBJECT |
| 1204 | 1021 |
|
5169
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
1022 A Lisp_Object. This is also the type to use for pointers to other lrecords |
| 1204 | 1023 (e.g. struct frame *). |
| 428 | 1024 |
| 440 | 1025 XD_LISP_OBJECT_ARRAY |
| 1204 | 1026 |
|
5169
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
1027 An array of Lisp_Objects or (equivalently) pointers to lrecords. |
| 771 | 1028 The parameter (i.e. third element) is the count. This would be declared |
| 1029 as Lisp_Object foo[666]. For something declared as Lisp_Object *foo, | |
| 2367 | 1030 use XD_BLOCK_PTR, whose description parameter is a sized_memory_description |
| 771 | 1031 consisting of only XD_LISP_OBJECT and XD_END. |
| 440 | 1032 |
|
5169
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
1033 XD_INLINE_LISP_OBJECT_BLOCK_PTR |
|
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
1034 |
|
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
1035 An pointer to a contiguous block of inline Lisp objects -- i.e., the Lisp |
|
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
1036 object itself rather than a Lisp_Object pointer is stored in the block. |
|
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
1037 This is used only under NEW_GC and is useful for increased efficiency when |
|
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
1038 an array of the same kind of object is needed. Examples of the use of this |
|
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
1039 type are Lisp dynarrs, where the array elements are inline Lisp objects |
|
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
1040 rather than non-Lisp structures, as is normally the case; and hash tables, |
|
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
1041 where the key/value pairs are encapsulated as hash-table-entry objects and |
|
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
1042 an array of inline hash-table-entry objects is stored. |
|
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
1043 |
| 428 | 1044 XD_LO_LINK |
| 1204 | 1045 |
| 771 | 1046 Weak link in a linked list of objects of the same type. This is a |
| 1047 link that does NOT generate a GC reference. Thus the pdumper will | |
| 1048 not automatically add the referenced object to the table of all | |
| 1049 objects to be dumped, and when storing and loading the dumped data | |
| 1050 will automatically prune unreferenced objects in the chain and link | |
| 1051 each referenced object to the next referenced object, even if it's | |
| 1052 many links away. We also need to special handling of a similar | |
| 1053 nature for the root of the chain, which will be a staticpro()ed | |
| 1054 object. | |
| 432 | 1055 |
| 428 | 1056 XD_OPAQUE_PTR |
| 1204 | 1057 |
| 428 | 1058 Pointer to undumpable data. Must be NULL when dumping. |
| 1059 | |
| 2551 | 1060 XD_OPAQUE_PTR_CONVERTIBLE |
| 1061 | |
| 1062 Pointer to data which is not directly dumpable but can be converted | |
| 1063 to a dumpable, opaque external representation. The parameter is | |
| 1064 a pointer to an opaque_convert_functions struct. | |
| 1065 | |
| 1066 XD_OPAQUE_DATA_CONVERTIBLE | |
| 1067 | |
| 1068 Data which is not directly dumpable but can be converted to a | |
| 1069 dumpable, opaque external representation. The parameter is a | |
| 1070 pointer to an opaque_convert_functions struct. | |
| 1071 | |
| 2367 | 1072 XD_BLOCK_PTR |
| 1204 | 1073 |
| 771 | 1074 Pointer to block of described memory. (This is misnamed: It is NOT |
| 1075 necessarily a pointer to a struct foo.) Parameters are number of | |
| 1204 | 1076 contiguous blocks and sized_memory_description. |
| 771 | 1077 |
| 2367 | 1078 XD_BLOCK_ARRAY |
| 1204 | 1079 |
| 771 | 1080 Array of blocks of described memory. Parameters are number of |
| 2367 | 1081 structures and sized_memory_description. This differs from XD_BLOCK_PTR |
| 771 | 1082 in that the parameter is declared as struct foo[666] instead of |
| 1083 struct *foo. In other words, the block of memory holding the | |
| 1084 structures is within the containing structure, rather than being | |
| 1085 elsewhere, with a pointer in the containing structure. | |
| 428 | 1086 |
| 1204 | 1087 NOTE NOTE NOTE: Be sure that you understand the difference between |
| 2367 | 1088 XD_BLOCK_PTR and XD_BLOCK_ARRAY: |
| 1204 | 1089 - struct foo bar[666], i.e. 666 inline struct foos |
| 2367 | 1090 --> XD_BLOCK_ARRAY, argument 666, pointing to a description of |
| 1204 | 1091 struct foo |
| 1092 - struct foo *bar, i.e. pointer to a block of 666 struct foos | |
| 2367 | 1093 --> XD_BLOCK_PTR, argument 666, pointing to a description of |
| 1204 | 1094 struct foo |
| 1095 - struct foo *bar[666], i.e. 666 pointers to separate blocks of struct foos | |
| 2367 | 1096 --> XD_BLOCK_ARRAY, argument 666, pointing to a description of |
| 1204 | 1097 a single pointer to struct foo; the description is a single |
| 2367 | 1098 XD_BLOCK_PTR, argument 1, which in turn points to a description |
| 1204 | 1099 of struct foo. |
| 1100 | |
| 2367 | 1101 NOTE also that an XD_BLOCK_PTR of 666 foos is equivalent to an |
| 1102 XD_BLOCK_PTR of 1 bar, where the description of `bar' is an | |
| 1103 XD_BLOCK_ARRAY of 666 foos. | |
| 1104 | |
| 428 | 1105 XD_OPAQUE_DATA_PTR |
| 1204 | 1106 |
| 428 | 1107 Pointer to dumpable opaque data. Parameter is the size of the data. |
| 1108 Pointed data must be relocatable without changes. | |
| 1109 | |
| 771 | 1110 XD_UNION |
| 1204 | 1111 |
| 1112 Union of two or more different types of data. Parameters are a constant | |
| 1113 which determines which type the data is (this is usually an XD_INDIRECT, | |
| 1114 referring to one of the fields in the structure), and a "sizing lobby" (a | |
| 1115 sized_memory_description, which points to a memory_description and | |
| 1116 indicates its size). The size field in the sizing lobby describes the | |
| 1117 size of the union field in the object, and the memory_description in it | |
| 1118 is referred to as a "union map" and has a special interpretation: The | |
| 1119 offset field is replaced by a constant, which is compared to the first | |
| 1120 parameter of the XD_UNION descriptor to determine if this description | |
| 1121 applies to the union data, and XD_INDIRECT references refer to the | |
| 1122 containing object and description. Note that the description applies | |
| 2367 | 1123 "inline" to the union data, like XD_BLOCK_ARRAY and not XD_BLOCK_PTR. |
| 1204 | 1124 If the union data is a pointer to different types of structures, each |
| 2367 | 1125 element in the memory_description should be an XD_BLOCK_PTR. See |
|
5176
8b2f75cecb89
rename objects* (.c, .h and .el files) to fontcolor*
Ben Wing <ben@xemacs.org>
parents:
4967
diff
changeset
|
1126 unicode.c, redisplay.c and fontcolor.c for examples of XD_UNION. |
| 1204 | 1127 |
| 1128 XD_UNION_DYNAMIC_SIZE | |
| 1129 | |
| 1130 Same as XD_UNION except that this is used for objects where the size of | |
| 1131 the object containing the union varies depending on the particular value | |
| 1132 of the union constant. That is, an object with plain XD_UNION typically | |
| 1133 has the union declared as `union foo' or as `void *', where an object | |
| 1134 with XD_UNION_DYNAMIC_SIZE typically has the union as the last element, | |
| 2367 | 1135 and declared as something like Rawbyte foo[1]. With plain XD_UNION, the |
| 1204 | 1136 object is (usually) of fixed size and always contains enough space for |
| 1137 the data associated with all possible union constants, and thus the union | |
| 1138 constant can potentially change during the lifetime of the object. With | |
| 1139 XD_UNION_DYNAMIC_SIZE, however, the union constant is fixed at the time | |
| 1140 of creation of the object, and the size of the object is computed | |
| 1141 dynamically at creation time based on the size of the data associated | |
| 1142 with the union constant. Currently, the only difference between XD_UNION | |
| 1143 and XD_UNION_DYNAMIC_SIZE is how the size of the union data is | |
| 1144 calculated, when (a) the structure containing the union has no size | |
| 1145 given; (b) the union occurs as the last element in the structure; and (c) | |
| 1146 the union has no size given (in the first-level sized_memory_description | |
| 1147 pointed to). In this circumstance, the size of XD_UNION comes from the | |
| 1148 max size of the data associated with all possible union constants, | |
| 1149 whereas the size of XD_UNION_DYNAMIC_SIZE comes from the size of the data | |
| 1150 associated with the currently specified (and unchangeable) union | |
| 1151 constant. | |
| 771 | 1152 |
| 2367 | 1153 XD_ASCII_STRING |
| 1204 | 1154 |
| 2367 | 1155 Pointer to a C string, purely ASCII. |
| 428 | 1156 |
| 1157 XD_DOC_STRING | |
| 1204 | 1158 |
| 2367 | 1159 Pointer to a doc string (C string in pure ASCII if positive, |
| 1160 opaque value if negative) | |
| 428 | 1161 |
| 1162 XD_INT_RESET | |
| 1204 | 1163 |
| 428 | 1164 An integer which will be reset to a given value in the dump file. |
| 1165 | |
| 1204 | 1166 XD_ELEMCOUNT |
| 771 | 1167 |
| 665 | 1168 Elemcount value. Used for counts. |
| 647 | 1169 |
| 665 | 1170 XD_BYTECOUNT |
| 1204 | 1171 |
| 665 | 1172 Bytecount value. Used for counts. |
| 647 | 1173 |
| 665 | 1174 XD_HASHCODE |
| 1204 | 1175 |
| 665 | 1176 Hashcode value. Used for the results of hashing functions. |
| 428 | 1177 |
| 1178 XD_INT | |
| 1204 | 1179 |
| 428 | 1180 int value. Used for counts. |
| 1181 | |
| 1182 XD_LONG | |
| 1204 | 1183 |
| 428 | 1184 long value. Used for counts. |
| 1185 | |
| 771 | 1186 XD_BYTECOUNT |
| 1204 | 1187 |
| 771 | 1188 bytecount value. Used for counts. |
| 1189 | |
| 428 | 1190 XD_END |
| 1204 | 1191 |
| 428 | 1192 Special type indicating the end of the array. |
| 1193 | |
| 1194 | |
| 1195 Special macros: | |
| 1204 | 1196 |
| 1197 XD_INDIRECT (line, delta) | |
| 1198 Usable where a count, size, offset or union constant is requested. Gives | |
| 1199 the value of the element which is at line number 'line' in the | |
| 1200 description (count starts at zero) and adds delta to it, which must | |
| 1201 (currently) be positive. | |
| 428 | 1202 */ |
| 1203 | |
| 1204 | 1204 enum memory_description_type |
| 647 | 1205 { |
| 440 | 1206 XD_LISP_OBJECT_ARRAY, |
| 428 | 1207 XD_LISP_OBJECT, |
| 3092 | 1208 #ifdef NEW_GC |
|
5169
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
1209 XD_INLINE_LISP_OBJECT_BLOCK_PTR, |
| 3092 | 1210 #endif /* NEW_GC */ |
| 428 | 1211 XD_LO_LINK, |
| 1212 XD_OPAQUE_PTR, | |
| 2551 | 1213 XD_OPAQUE_PTR_CONVERTIBLE, |
| 1214 XD_OPAQUE_DATA_CONVERTIBLE, | |
| 1215 XD_OPAQUE_DATA_PTR, | |
| 2367 | 1216 XD_BLOCK_PTR, |
| 1217 XD_BLOCK_ARRAY, | |
| 771 | 1218 XD_UNION, |
| 1204 | 1219 XD_UNION_DYNAMIC_SIZE, |
| 2367 | 1220 XD_ASCII_STRING, |
| 428 | 1221 XD_DOC_STRING, |
| 1222 XD_INT_RESET, | |
| 665 | 1223 XD_BYTECOUNT, |
| 1224 XD_ELEMCOUNT, | |
| 1225 XD_HASHCODE, | |
| 428 | 1226 XD_INT, |
| 1227 XD_LONG, | |
| 1204 | 1228 XD_END |
| 428 | 1229 }; |
| 1230 | |
| 1204 | 1231 enum data_description_entry_flags |
| 647 | 1232 { |
| 1204 | 1233 /* If set, KKCC does not process this entry. |
| 1234 | |
| 1235 (1) One obvious use is with things that pdump saves but which do not get | |
| 1236 marked normally -- for example the next and prev fields in a marker. The | |
| 1237 marker chain is weak, with its entries removed when they are finalized. | |
| 1238 | |
| 1239 (2) This can be set on structures not containing any Lisp objects, or (more | |
| 1240 usefully) on structures that contain Lisp objects but where the objects | |
| 1241 always occur in another structure as well. For example, the extent lists | |
| 1242 kept by a buffer keep the extents in two lists, one sorted by the start | |
| 1243 of the extent and the other by the end. There's no point in marking | |
| 1244 both, since each contains the same objects as the other; but when dumping | |
| 1245 (if we were to dump such a structure), when computing memory size, etc., | |
| 1246 it's crucial to tag both sides. | |
| 1247 */ | |
| 1248 XD_FLAG_NO_KKCC = 1, | |
| 1249 /* If set, pdump does not process this entry. */ | |
| 1250 XD_FLAG_NO_PDUMP = 2, | |
| 1251 /* Indicates that this is a "default" entry in a union map. */ | |
| 1252 XD_FLAG_UNION_DEFAULT_ENTRY = 4, | |
| 3263 | 1253 #ifndef NEW_GC |
| 1204 | 1254 /* Indicates that this is a free Lisp object we're marking. |
| 1255 Only relevant for ERROR_CHECK_GC. This occurs when we're marking | |
| 1256 lcrecord-lists, where the objects have had their type changed to | |
| 1257 lrecord_type_free and also have had their free bit set, but we mark | |
| 1258 them as normal. */ | |
|
5169
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
1259 XD_FLAG_FREE_LISP_OBJECT = 8, |
| 3263 | 1260 #endif /* not NEW_GC */ |
| 1204 | 1261 #if 0 |
| 1262 /* Suggestions for other possible flags: */ | |
| 1263 | |
| 1264 /* Eliminate XD_UNION_DYNAMIC_SIZE and replace it with a flag, like this. */ | |
| 1265 XD_FLAG_UNION_DYNAMIC_SIZE = 16, | |
| 1266 /* Require that everyone who uses a description map has to flag it, so | |
| 1267 that it's easy to tell, when looking through the code, where the | |
| 1268 description maps are and who's using them. This might also become | |
| 1269 necessary if for some reason the format of the description map is | |
| 1270 expanded and we need to stick a pointer in the second slot (although | |
| 1271 we could still ensure that the second slot in the first entry was NULL | |
| 1272 or <0). */ | |
|
5169
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
1273 XD_FLAG_DESCRIPTION_MAP = 32, |
| 1204 | 1274 #endif |
| 428 | 1275 }; |
| 1276 | |
| 2551 | 1277 union memory_contents_description |
| 1278 { | |
| 1279 /* The first element is used by static initializers only. We always read | |
| 1280 from one of the other two pointers. */ | |
| 1281 const void *write_only; | |
| 1282 const struct sized_memory_description *descr; | |
| 1283 const struct opaque_convert_functions *funcs; | |
| 1284 }; | |
| 1285 | |
| 1204 | 1286 struct memory_description |
| 1287 { | |
| 1288 enum memory_description_type type; | |
| 1289 Bytecount offset; | |
| 1290 EMACS_INT data1; | |
| 2551 | 1291 union memory_contents_description data2; |
| 1204 | 1292 /* Indicates which subsystems process this entry, plus (potentially) other |
| 1293 flags that apply to this entry. */ | |
| 1294 int flags; | |
| 1295 }; | |
| 428 | 1296 |
| 1204 | 1297 struct sized_memory_description |
| 1298 { | |
| 1299 Bytecount size; | |
| 1300 const struct memory_description *description; | |
| 1301 }; | |
| 1302 | |
| 2551 | 1303 |
| 1304 struct opaque_convert_functions | |
| 1305 { | |
| 1306 /* Used by XD_OPAQUE_PTR_CONVERTIBLE and | |
| 1307 XD_OPAQUE_DATA_CONVERTIBLE */ | |
| 1308 | |
| 1309 /* Converter to external representation, for those objects from | |
| 1310 external libraries that can't be directly dumped as opaque data | |
| 1311 because they contain pointers. This is called at dump time to | |
| 1312 convert to an opaque, pointer-less representation. | |
| 1313 | |
| 1314 This function must put a pointer to the opaque result in *data | |
| 1315 and its size in *size. */ | |
|
5169
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
1316 void (*convert) (const void *object, void **data, Bytecount *size); |
| 2551 | 1317 |
| 1318 /* Post-conversion cleanup. Optional (null if not provided). | |
| 1319 | |
| 1320 When provided it will be called post-dumping to free any storage | |
| 1321 allocated for the conversion results. */ | |
|
5169
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
1322 void (*convert_free) (const void *object, void *data, Bytecount size); |
| 2551 | 1323 |
| 1324 /* De-conversion. | |
| 1325 | |
| 1326 At reload time, rebuilds the object from the converted form. | |
| 1327 "object" is 0 for the PTR case, return is ignored in the DATA | |
| 1328 case. */ | |
|
5169
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5160
diff
changeset
|
1329 void *(*deconvert) (void *object, void *data, Bytecount size); |
| 2551 | 1330 |
| 1331 }; | |
| 1332 | |
| 1204 | 1333 extern const struct sized_memory_description lisp_object_description; |
| 1334 | |
| 1335 #define XD_INDIRECT(val, delta) (-1 - (Bytecount) ((val) | ((delta) << 8))) | |
| 428 | 1336 |
| 1204 | 1337 #define XD_IS_INDIRECT(code) ((code) < 0) |
| 1338 #define XD_INDIRECT_VAL(code) ((-1 - (code)) & 255) | |
| 1339 #define XD_INDIRECT_DELTA(code) ((-1 - (code)) >> 8) | |
| 1340 | |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1341 /* DEFINE_*_LISP_OBJECT is for objects with constant size. (Either |
|
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1342 DEFINE_DUMPABLE_LISP_OBJECT for objects that can be saved in a dumped |
|
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1343 executable, or DEFINE_NODUMP_LISP_OBJECT for objects that cannot be |
|
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1344 saved -- e.g. that contain pointers to non-persistent external objects |
|
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1345 such as window-system windows.) |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
1346 |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1347 DEFINE_*_SIZABLE_LISP_OBJECT is for objects whose size varies. |
|
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1348 |
|
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1349 DEFINE_*_FROB_BLOCK_LISP_OBJECT is for objects that are allocated in |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
1350 large blocks ("frob blocks"), which are parceled up individually. Such |
|
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
1351 objects need special handling in alloc.c. This does not apply to |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1352 NEW_GC, because it does this automatically. |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
1353 |
|
5120
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1354 DEFINE_*_INTERNAL_LISP_OBJECT is for "internal" objects that should |
|
5124
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
1355 never be visible on the Lisp level. This is a shorthand for the most |
|
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
1356 common type of internal objects, which have no equal or hash method |
|
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
1357 (since they generally won't appear in hash tables), no finalizer and |
|
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
1358 internal_object_printer() as their print method (which prints that the |
|
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
1359 object is internal and shouldn't be visible externally). For internal |
|
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
1360 objects needing a finalizer, equal or hash method, or wanting to |
|
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
1361 customize the print method, use the normal DEFINE_*_LISP_OBJECT |
|
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
1362 mechanism for defining these objects. |
|
5120
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1363 |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1364 DEFINE_MODULE_* is for objects defined in an external module. |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
1365 |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1366 MAKE_LISP_OBJECT and MAKE_MODULE_LISP_OBJECT are what underlies all of |
|
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1367 these; they define a structure containing pointers to object methods |
|
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1368 and other info such as the size of the structure containing the object. |
| 428 | 1369 */ |
| 1370 | |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1371 /* #### FIXME What's going on here? */ |
| 800 | 1372 #if defined (ERROR_CHECK_TYPES) |
| 1373 # define DECLARE_ERROR_CHECK_TYPES(c_name, structtype) | |
| 428 | 1374 #else |
| 800 | 1375 # define DECLARE_ERROR_CHECK_TYPES(c_name, structtype) |
| 428 | 1376 #endif |
| 1377 | |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1378 /********* The dumpable versions *********** */ |
| 934 | 1379 |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1380 #define DEFINE_DUMPABLE_LISP_OBJECT(name,c_name,marker,printer,nuker,equal,hash,desc,structtype) \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1381 MAKE_LISP_OBJECT(name,c_name,1 /*dumpable*/,marker,printer,nuker,equal,hash,desc,sizeof (structtype),0,0,structtype) |
| 934 | 1382 |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1383 #define DEFINE_DUMPABLE_SIZABLE_LISP_OBJECT(name,c_name,marker,printer,nuker,equal,hash,desc,sizer,structtype) \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1384 MAKE_LISP_OBJECT(name,c_name,1 /*dumpable*/,marker,printer,nuker,equal,hash,desc,0,sizer,0,structtype) |
| 934 | 1385 |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1386 #define DEFINE_DUMPABLE_FROB_BLOCK_LISP_OBJECT(name,c_name,marker,printer,nuker,equal,hash,desc,structtype) \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1387 MAKE_LISP_OBJECT(name,c_name,1 /*dumpable*/,marker,printer,nuker,equal,hash,desc,sizeof(structtype),0,1,structtype) |
| 934 | 1388 |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1389 #define DEFINE_DUMPABLE_FROB_BLOCK_SIZABLE_LISP_OBJECT(name,c_name,marker,printer,nuker,equal,hash,desc,sizer,structtype) \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1390 MAKE_LISP_OBJECT(name,c_name,1 /*dumpable*/,marker,printer,nuker,equal,hash,desc,0,sizer,1,structtype) |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
1391 |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1392 #define DEFINE_DUMPABLE_INTERNAL_LISP_OBJECT(name,c_name,marker,desc,structtype) \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1393 DEFINE_DUMPABLE_LISP_OBJECT(name,c_name,marker,internal_object_printer,0,0,0,desc,structtype) |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1394 |
|
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1395 #define DEFINE_DUMPABLE_SIZABLE_INTERNAL_LISP_OBJECT(name,c_name,marker,desc,sizer,structtype) \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1396 DEFINE_DUMPABLE_SIZABLE_LISP_OBJECT(name,c_name,marker,internal_object_printer,0,0,0,desc,sizer,structtype) |
| 934 | 1397 |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1398 /********* The non-dumpable versions *********** */ |
| 934 | 1399 |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1400 #define DEFINE_NODUMP_LISP_OBJECT(name,c_name,marker,printer,nuker,equal,hash,desc,structtype) \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1401 MAKE_LISP_OBJECT(name,c_name,0 /*non-dumpable*/,marker,printer,nuker,equal,hash,desc,sizeof (structtype),0,0,structtype) |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
1402 |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1403 #define DEFINE_NODUMP_SIZABLE_LISP_OBJECT(name,c_name,marker,printer,nuker,equal,hash,desc,sizer,structtype) \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1404 MAKE_LISP_OBJECT(name,c_name,0 /*non-dumpable*/,marker,printer,nuker,equal,hash,desc,0,sizer,0,structtype) |
| 934 | 1405 |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1406 #define DEFINE_NODUMP_FROB_BLOCK_LISP_OBJECT(name,c_name,marker,printer,nuker,equal,hash,desc,structtype) \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1407 MAKE_LISP_OBJECT(name,c_name,0 /*non-dumpable*/,marker,printer,nuker,equal,hash,desc,sizeof(structtype),0,1,structtype) |
| 934 | 1408 |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1409 #define DEFINE_NODUMP_FROB_BLOCK_SIZABLE_LISP_OBJECT(name,c_name,marker,printer,nuker,equal,hash,desc,sizer,structtype) \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1410 MAKE_LISP_OBJECT(name,c_name,0 /*non-dumpable*/,marker,printer,nuker,equal,hash,desc,0,sizer,1,structtype) |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
1411 |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1412 #define DEFINE_NODUMP_INTERNAL_LISP_OBJECT(name,c_name,marker,desc,structtype) \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1413 DEFINE_NODUMP_LISP_OBJECT(name,c_name,marker,internal_object_printer,0,0,0,desc,structtype) |
| 934 | 1414 |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1415 #define DEFINE_NODUMP_SIZABLE_INTERNAL_LISP_OBJECT(name,c_name,marker,desc,sizer,structtype) \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1416 DEFINE_NODUMP_SIZABLE_LISP_OBJECT(name,c_name,marker,internal_object_printer,0,0,0,desc,sizer,structtype) |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1417 |
|
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1418 /********* MAKE_LISP_OBJECT, the underlying macro *********** */ |
| 934 | 1419 |
| 3263 | 1420 #ifdef NEW_GC |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1421 #define MAKE_LISP_OBJECT(name,c_name,dumpable,marker,printer,nuker, \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1422 equal,hash,desc,size,sizer,frob_block_p,structtype) \ |
| 2720 | 1423 DECLARE_ERROR_CHECK_TYPES(c_name, structtype) \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1424 struct lrecord_implementation lrecord_##c_name = \ |
| 2720 | 1425 { name, dumpable, marker, printer, nuker, equal, hash, desc, \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1426 size, sizer, lrecord_type_##c_name } |
| 3263 | 1427 #else /* not NEW_GC */ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1428 #define MAKE_LISP_OBJECT(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,size,sizer,frob_block_p,structtype) \ |
| 1204 | 1429 DECLARE_ERROR_CHECK_TYPES(c_name, structtype) \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1430 struct lrecord_implementation lrecord_##c_name = \ |
| 934 | 1431 { name, dumpable, marker, printer, nuker, equal, hash, desc, \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1432 size, sizer, lrecord_type_##c_name, frob_block_p } |
| 3263 | 1433 #endif /* not NEW_GC */ |
| 934 | 1434 |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1435 |
|
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1436 /********* The module dumpable versions *********** */ |
|
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1437 |
|
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1438 #define DEFINE_DUMPABLE_MODULE_LISP_OBJECT(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,structtype) \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1439 MAKE_MODULE_LISP_OBJECT(name,c_name,1 /*dumpable*/,marker,printer,nuker,equal,hash,desc,sizeof (structtype),0,0,structtype) |
| 934 | 1440 |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1441 #define DEFINE_DUMPABLE_MODULE_SIZABLE_LISP_OBJECT(name,c_name,dumpable,marker,printer,nuker,equal,hash,desc,sizer,structtype) \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1442 MAKE_MODULE_LISP_OBJECT(name,c_name,1 /*dumpable*/,marker,printer,nuker,equal,hash,desc,0,sizer,0,structtype) |
| 934 | 1443 |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1444 /********* The module non-dumpable versions *********** */ |
|
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1445 |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1446 #define DEFINE_NODUMP_MODULE_LISP_OBJECT(name,c_name,dumpable,marker, \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1447 printer,nuker,equal,hash,desc,structtype) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1448 MAKE_MODULE_LISP_OBJECT(name,c_name,0 /*non-dumpable*/,marker,printer, \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1449 nuker,equal,hash,desc,sizeof (structtype),0,0,structtype) |
| 934 | 1450 |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1451 #define DEFINE_NODUMP_MODULE_SIZABLE_LISP_OBJECT(name,c_name,dumpable, \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1452 marker,printer,nuker,equal,hash,desc,sizer,structtype) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1453 MAKE_MODULE_LISP_OBJECT(name,c_name,0 /*non-dumpable*/,marker,printer, \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1454 nuker,equal,hash,desc,0,sizer,0,structtype) |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1455 |
|
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1456 /********* MAKE_MODULE_LISP_OBJECT, the underlying macro *********** */ |
| 934 | 1457 |
| 3263 | 1458 #ifdef NEW_GC |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1459 #define MAKE_MODULE_LISP_OBJECT(name,c_name,dumpable,marker,printer, \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1460 nuker,equal,hash,desc,size,sizer,frob_block_p,structtype) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1461 DECLARE_ERROR_CHECK_TYPES(c_name, structtype) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1462 int lrecord_type_##c_name; \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1463 struct lrecord_implementation lrecord_##c_name = \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1464 { name, dumpable, marker, printer, nuker, equal, hash, desc, \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1465 size, sizer, lrecord_type_last_built_in_type } |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1466 #else /* not NEW_GC */ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1467 #define MAKE_MODULE_LISP_OBJECT(name,c_name,dumpable,marker,printer, \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1468 nuker,equal,hash,desc,size,sizer,frob_block_p,structtype) \ |
| 2720 | 1469 DECLARE_ERROR_CHECK_TYPES(c_name, structtype) \ |
| 1470 int lrecord_type_##c_name; \ | |
| 1471 struct lrecord_implementation lrecord_##c_name = \ | |
| 1472 { name, dumpable, marker, printer, nuker, equal, hash, desc, \ | |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1473 size, sizer, lrecord_type_last_built_in_type, frob_block_p } |
| 3263 | 1474 #endif /* not NEW_GC */ |
| 934 | 1475 |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1476 #ifdef MEMORY_USAGE_STATS |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1477 #define INIT_MEMORY_USAGE_STATS(type) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1478 do \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1479 { \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1480 lrecord_implementations_table[lrecord_type_##type]-> \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1481 memusage_stats_list = Qnil; \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1482 lrecord_implementations_table[lrecord_type_##type]-> \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1483 num_extra_memusage_stats = -1; \ |
|
5158
9e0b43d3095c
more cleanups to object-memory-usage stuff
Ben Wing <ben@xemacs.org>
parents:
5157
diff
changeset
|
1484 lrecord_implementations_table[lrecord_type_##type]-> \ |
|
9e0b43d3095c
more cleanups to object-memory-usage stuff
Ben Wing <ben@xemacs.org>
parents:
5157
diff
changeset
|
1485 num_extra_nonlisp_memusage_stats = -1; \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1486 staticpro (&lrecord_implementations_table[lrecord_type_##type]-> \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1487 memusage_stats_list); \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1488 } while (0) |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1489 #else |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1490 #define INIT_MEMORY_USAGE_STATS(type) DO_NOTHING |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1491 #endif /* (not) MEMORY_USAGE_STATS */ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1492 |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1493 #define INIT_LISP_OBJECT_BEGINNING(type) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1494 do \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1495 { \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1496 lrecord_implementations_table[lrecord_type_##type] = &lrecord_##type; \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1497 INIT_MEMORY_USAGE_STATS (type); \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1498 } while (0) |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1499 |
| 1676 | 1500 #ifdef USE_KKCC |
| 1501 extern MODULE_API const struct memory_description *lrecord_memory_descriptions[]; | |
| 1502 | |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1503 #define INIT_LISP_OBJECT(type) do { \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1504 INIT_LISP_OBJECT_BEGINNING (type); \ |
| 1676 | 1505 lrecord_memory_descriptions[lrecord_type_##type] = \ |
| 1506 lrecord_implementations_table[lrecord_type_##type]->description; \ | |
| 1507 } while (0) | |
| 1508 #else /* not USE_KKCC */ | |
| 1632 | 1509 extern MODULE_API Lisp_Object (*lrecord_markers[]) (Lisp_Object); |
| 442 | 1510 |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
1511 #define INIT_LISP_OBJECT(type) do { \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1512 INIT_LISP_OBJECT_BEGINNING (type); \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1513 lrecord_markers[lrecord_type_##type] = \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1514 lrecord_implementations_table[lrecord_type_##type]->marker; \ |
| 442 | 1515 } while (0) |
| 1676 | 1516 #endif /* not USE_KKCC */ |
| 428 | 1517 |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1518 #define INIT_MODULE_LISP_OBJECT(type) do { \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1519 lrecord_type_##type = lrecord_type_count++; \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1520 lrecord_##type.lrecord_type_index = lrecord_type_##type; \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1521 INIT_LISP_OBJECT (type); \ |
| 444 | 1522 } while (0) |
| 1523 | |
| 996 | 1524 #ifdef HAVE_SHLIB |
| 1525 /* Allow undefining types in order to support module unloading. */ | |
| 1526 | |
| 1676 | 1527 #ifdef USE_KKCC |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
1528 #define UNDEF_LISP_OBJECT(type) do { \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1529 lrecord_implementations_table[lrecord_type_##type] = NULL; \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1530 lrecord_memory_descriptions[lrecord_type_##type] = NULL; \ |
| 1676 | 1531 } while (0) |
| 1532 #else /* not USE_KKCC */ | |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
1533 #define UNDEF_LISP_OBJECT(type) do { \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1534 lrecord_implementations_table[lrecord_type_##type] = NULL; \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1535 lrecord_markers[lrecord_type_##type] = NULL; \ |
| 996 | 1536 } while (0) |
| 1676 | 1537 #endif /* not USE_KKCC */ |
| 996 | 1538 |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1539 #define UNDEF_MODULE_LISP_OBJECT(type) do { \ |
| 996 | 1540 if (lrecord_##type.lrecord_type_index == lrecord_type_count - 1) { \ |
| 1541 /* This is the most recently defined type. Clean up nicely. */ \ | |
| 1542 lrecord_type_##type = lrecord_type_count--; \ | |
| 1543 } /* Else we can't help leaving a hole with this implementation. */ \ | |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1544 UNDEF_LISP_OBJECT(type); \ |
| 996 | 1545 } while (0) |
| 1546 | |
| 1547 #endif /* HAVE_SHLIB */ | |
| 1548 | |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1549 /*************** Macros for declaring that a Lisp object has a |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1550 particular method, or for calling such a method. ********/ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1551 |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1552 /* Declare that object-type TYPE has method M; used in |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1553 initialization routines */ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1554 #define OBJECT_HAS_METHOD(type, m) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1555 (lrecord_##type.m = type##_##m) |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1556 /* Same but the method name come before the type */ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1557 #define OBJECT_HAS_PREMETHOD(type, m) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1558 (lrecord_##type.m = m##_##type) |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1559 /* Same but the name of the method is explicitly given */ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1560 #define OBJECT_HAS_NAMED_METHOD(type, m, func) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1561 (lrecord_##type.m = (func)) |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1562 /* Object type has a property with the given value. */ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1563 #define OBJECT_HAS_PROPERTY(type, prop, val) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1564 (lrecord_##type.prop = (val)) |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1565 |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1566 /* Does the given object method exist? */ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1567 #define HAS_OBJECT_METH_P(obj, m) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1568 (!!(XRECORD_LHEADER_IMPLEMENTATION (obj)->m)) |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1569 /* Call an object method. */ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1570 #define OBJECT_METH(obj, m, args) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1571 ((XRECORD_LHEADER_IMPLEMENTATION (obj)->m) args) |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1572 |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1573 /* Call an object method, if it exists. */ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1574 #define MAYBE_OBJECT_METH(obj, m, args) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1575 do \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1576 { \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1577 const struct lrecord_implementation *_mom_imp = \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1578 XRECORD_LHEADER_IMPLEMENTATION (obj); \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1579 if (_mom_imp->m) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1580 ((_mom_imp->m) args); \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1581 } while (0) |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1582 |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1583 /* Call an object method, if it exists, or return GIVEN. NOTE: |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1584 Multiply-evaluates OBJ. */ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1585 #define OBJECT_METH_OR_GIVEN(obj, m, args, given) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1586 (HAS_OBJECT_METH_P (obj, m) ? OBJECT_METH (obj, m, args) : (given)) |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1587 |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1588 #define OBJECT_PROPERTY(obj, prop) (XRECORD_LHEADER_IMPLEMENTATION (obj)->prop) |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1589 |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1590 /************** Other stuff **************/ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1591 |
| 428 | 1592 #define LRECORDP(a) (XTYPE (a) == Lisp_Type_Record) |
| 1593 #define XRECORD_LHEADER(a) ((struct lrecord_header *) XPNTR (a)) | |
| 1594 | |
| 1595 #define RECORD_TYPEP(x, ty) \ | |
| 647 | 1596 (LRECORDP (x) && (XRECORD_LHEADER (x)->type == (unsigned int) (ty))) |
| 442 | 1597 |
| 1598 /* Steps to create a new object: | |
| 1599 | |
| 1600 1. Declare the struct for your object in a header file somewhere. | |
| 1601 Remember that it must begin with | |
| 1602 | |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1603 NORMAL_LISP_OBJECT_HEADER header; |
| 442 | 1604 |
|
5120
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1605 2. Put the "standard junk" (DECLARE_LISP_OBJECT()/XFOO/etc.) below the |
| 617 | 1606 struct definition -- see below. |
| 442 | 1607 |
| 1608 3. Add this header file to inline.c. | |
| 1609 | |
| 1610 4. Create the methods for your object. Note that technically you don't | |
| 1611 need any, but you will almost always want at least a mark method. | |
| 1612 | |
| 1204 | 1613 4. Create the data layout description for your object. See |
| 1614 toolbar_button_description below; the comment above in `struct lrecord', | |
| 1615 describing the purpose of the descriptions; and comments elsewhere in | |
| 1616 this file describing the exact syntax of the description structures. | |
| 1617 | |
|
5120
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1618 6. Define your object with DEFINE_*_LISP_OBJECT() or some |
|
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1619 variant. At the minimum, you need to decide whether your object can |
|
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1620 be dumped. Objects that are created as part of the loadup process and |
|
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1621 need to be persistent across dumping should be created dumpable. |
|
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1622 Nondumpable objects are generally those associated with display, |
|
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1623 particularly those containing a pointer to an external library object |
|
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1624 (e.g. a window-system window). |
| 442 | 1625 |
| 1204 | 1626 7. Include the header file in the .c file where you defined the object. |
| 442 | 1627 |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
1628 8. Put a call to INIT_LISP_OBJECT() for the object in the |
| 442 | 1629 .c file's syms_of_foo() function. |
| 1630 | |
| 1204 | 1631 9. Add a type enum for the object to enum lrecord_type, earlier in this |
| 442 | 1632 file. |
| 1633 | |
| 1204 | 1634 --ben |
| 1635 | |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1636 An example: |
| 428 | 1637 |
| 442 | 1638 ------------------------------ in toolbar.h ----------------------------- |
| 1639 | |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1640 struct toolbar_button |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1641 { |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1642 NORMAL_LISP_OBJECT_HEADER header; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1643 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1644 Lisp_Object next; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1645 Lisp_Object frame; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1646 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1647 Lisp_Object up_glyph; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1648 Lisp_Object down_glyph; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1649 Lisp_Object disabled_glyph; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1650 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1651 Lisp_Object cap_up_glyph; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1652 Lisp_Object cap_down_glyph; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1653 Lisp_Object cap_disabled_glyph; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1654 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1655 Lisp_Object callback; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1656 Lisp_Object enabled_p; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1657 Lisp_Object help_string; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1658 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1659 char enabled; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1660 char down; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1661 char pushright; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1662 char blank; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1663 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1664 int x, y; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1665 int width, height; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1666 int dirty; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1667 int vertical; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1668 int border_width; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1669 }; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1670 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1671 [[ the standard junk: ]] |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1672 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1673 DECLARE_LISP_OBJECT (toolbar_button, struct toolbar_button); |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1674 #define XTOOLBAR_BUTTON(x) XRECORD (x, toolbar_button, struct toolbar_button) |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1675 #define wrap_toolbar_button(p) wrap_record (p, toolbar_button) |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1676 #define TOOLBAR_BUTTONP(x) RECORDP (x, toolbar_button) |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1677 #define CHECK_TOOLBAR_BUTTON(x) CHECK_RECORD (x, toolbar_button) |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1678 #define CONCHECK_TOOLBAR_BUTTON(x) CONCHECK_RECORD (x, toolbar_button) |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1679 |
| 442 | 1680 ------------------------------ in toolbar.c ----------------------------- |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1681 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1682 #include "toolbar.h" |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1683 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1684 ... |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1685 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1686 static const struct memory_description toolbar_button_description [] = { |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1687 { XD_LISP_OBJECT, offsetof (struct toolbar_button, next) }, |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1688 { XD_LISP_OBJECT, offsetof (struct toolbar_button, frame) }, |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1689 { XD_LISP_OBJECT, offsetof (struct toolbar_button, up_glyph) }, |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1690 { XD_LISP_OBJECT, offsetof (struct toolbar_button, down_glyph) }, |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1691 { XD_LISP_OBJECT, offsetof (struct toolbar_button, disabled_glyph) }, |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1692 { XD_LISP_OBJECT, offsetof (struct toolbar_button, cap_up_glyph) }, |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1693 { XD_LISP_OBJECT, offsetof (struct toolbar_button, cap_down_glyph) }, |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1694 { XD_LISP_OBJECT, offsetof (struct toolbar_button, cap_disabled_glyph) }, |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1695 { XD_LISP_OBJECT, offsetof (struct toolbar_button, callback) }, |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1696 { XD_LISP_OBJECT, offsetof (struct toolbar_button, enabled_p) }, |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1697 { XD_LISP_OBJECT, offsetof (struct toolbar_button, help_string) }, |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1698 { XD_END } |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1699 }; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1700 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1701 static Lisp_Object |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1702 allocate_toolbar_button (struct frame *f, int pushright) |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1703 { |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1704 struct toolbar_button *tb; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1705 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1706 tb = XTOOLBAR_BUTTON (ALLOC_NORMAL_LISP_OBJECT (toolbar_button)); |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1707 tb->next = Qnil; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1708 tb->frame = wrap_frame (f); |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1709 tb->up_glyph = Qnil; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1710 tb->down_glyph = Qnil; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1711 tb->disabled_glyph = Qnil; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1712 tb->cap_up_glyph = Qnil; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1713 tb->cap_down_glyph = Qnil; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1714 tb->cap_disabled_glyph = Qnil; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1715 tb->callback = Qnil; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1716 tb->enabled_p = Qnil; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1717 tb->help_string = Qnil; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1718 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1719 tb->pushright = pushright; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1720 tb->x = tb->y = tb->width = tb->height = -1; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1721 tb->dirty = 1; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1722 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1723 return wrap_toolbar_button (tb); |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1724 } |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1725 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1726 static Lisp_Object |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1727 mark_toolbar_button (Lisp_Object obj) |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1728 { |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1729 struct toolbar_button *data = XTOOLBAR_BUTTON (obj); |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1730 mark_object (data->next); |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1731 mark_object (data->frame); |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1732 mark_object (data->up_glyph); |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1733 mark_object (data->down_glyph); |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1734 mark_object (data->disabled_glyph); |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1735 mark_object (data->cap_up_glyph); |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1736 mark_object (data->cap_down_glyph); |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1737 mark_object (data->cap_disabled_glyph); |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1738 mark_object (data->callback); |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1739 mark_object (data->enabled_p); |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1740 return data->help_string; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1741 } |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1742 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1743 DEFINE_NODUMP_LISP_OBJECT ("toolbar-button", toolbar_button, |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1744 mark_toolbar_button, |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1745 external_object_printer, 0, 0, 0, |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1746 toolbar_button_description, |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1747 struct toolbar_button); |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1748 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1749 ... |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1750 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1751 void |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1752 syms_of_toolbar (void) |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1753 { |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1754 INIT_LISP_OBJECT (toolbar_button); |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1755 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1756 ...; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1757 } |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1758 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1759 ------------------------------ in inline.c ----------------------------- |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1760 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1761 #ifdef HAVE_TOOLBARS |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1762 #include "toolbar.h" |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1763 #endif |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1764 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1765 ------------------------------ in lrecord.h ----------------------------- |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1766 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1767 enum lrecord_type |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1768 { |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1769 ... |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1770 lrecord_type_toolbar_button, |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1771 ... |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1772 }; |
| 442 | 1773 |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1774 ------------------------------ in .gdbinit.in.in ----------------------------- |
| 442 | 1775 |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1776 ... |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1777 else |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1778 if $lrecord_type == lrecord_type_toolbar_button |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1779 pstructtype toolbar_button |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1780 ... |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1781 ... |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1782 ... |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1783 end |
| 442 | 1784 |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1785 --ben |
| 1204 | 1786 |
| 442 | 1787 */ |
| 1788 | |
| 1789 /* | |
| 1790 | |
| 1791 Note: Object types defined in external dynamically-loaded modules (not | |
|
5120
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1792 part of the XEmacs main source code) should use DECLARE_*_MODULE_LISP_OBJECT |
|
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1793 and DEFINE_*_MODULE_LISP_OBJECT rather than DECLARE_*_LISP_OBJECT |
|
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1794 and DEFINE_*_LISP_OBJECT. The MODULE versions declare and |
| 3029 | 1795 allocate an enumerator for the type being defined. |
| 442 | 1796 |
| 1797 */ | |
| 1798 | |
| 428 | 1799 |
| 800 | 1800 #ifdef ERROR_CHECK_TYPES |
| 428 | 1801 |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1802 # define DECLARE_LISP_OBJECT(c_name, structtype) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1803 extern struct lrecord_implementation lrecord_##c_name; \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1804 DECLARE_INLINE_HEADER ( \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1805 structtype * \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1806 error_check_##c_name (Lisp_Object obj, const Ascbyte *file, int line) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1807 ) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1808 { \ |
| 788 | 1809 assert_at_line (RECORD_TYPEP (obj, lrecord_type_##c_name), file, line); \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1810 return (structtype *) XPNTR (obj); \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1811 } \ |
| 428 | 1812 extern Lisp_Object Q##c_name##p |
| 1813 | |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1814 # define DECLARE_MODULE_API_LISP_OBJECT(c_name, structtype) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1815 extern MODULE_API struct lrecord_implementation lrecord_##c_name; \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1816 DECLARE_INLINE_HEADER ( \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1817 structtype * \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1818 error_check_##c_name (Lisp_Object obj, const Ascbyte *file, int line) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1819 ) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1820 { \ |
| 1632 | 1821 assert_at_line (RECORD_TYPEP (obj, lrecord_type_##c_name), file, line); \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1822 return (structtype *) XPNTR (obj); \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1823 } \ |
| 1632 | 1824 extern MODULE_API Lisp_Object Q##c_name##p |
| 1825 | |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1826 # define DECLARE_MODULE_LISP_OBJECT(c_name, structtype) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1827 extern int lrecord_type_##c_name; \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1828 extern struct lrecord_implementation lrecord_##c_name; \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1829 DECLARE_INLINE_HEADER ( \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1830 structtype * \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1831 error_check_##c_name (Lisp_Object obj, const Ascbyte *file, int line) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1832 ) \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1833 { \ |
| 788 | 1834 assert_at_line (RECORD_TYPEP (obj, lrecord_type_##c_name), file, line); \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1835 return (structtype *) XPNTR (obj); \ |
|
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1836 } \ |
| 444 | 1837 extern Lisp_Object Q##c_name##p |
| 442 | 1838 |
| 788 | 1839 # define XRECORD(x, c_name, structtype) \ |
| 1840 error_check_##c_name (x, __FILE__, __LINE__) | |
| 428 | 1841 |
| 826 | 1842 DECLARE_INLINE_HEADER ( |
| 1843 Lisp_Object | |
| 2367 | 1844 wrap_record_1 (const void *ptr, enum lrecord_type ty, const Ascbyte *file, |
| 800 | 1845 int line) |
| 826 | 1846 ) |
| 617 | 1847 { |
| 793 | 1848 Lisp_Object obj = wrap_pointer_1 (ptr); |
| 1849 | |
| 788 | 1850 assert_at_line (RECORD_TYPEP (obj, ty), file, line); |
| 617 | 1851 return obj; |
| 1852 } | |
| 1853 | |
| 788 | 1854 #define wrap_record(ptr, ty) \ |
| 1855 wrap_record_1 (ptr, lrecord_type_##ty, __FILE__, __LINE__) | |
| 617 | 1856 |
| 800 | 1857 #else /* not ERROR_CHECK_TYPES */ |
| 428 | 1858 |
|
5120
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1859 # define DECLARE_LISP_OBJECT(c_name, structtype) \ |
| 428 | 1860 extern Lisp_Object Q##c_name##p; \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1861 extern struct lrecord_implementation lrecord_##c_name |
|
5120
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1862 # define DECLARE_MODULE_API_LISP_OBJECT(c_name, structtype) \ |
|
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1863 extern MODULE_API Lisp_Object Q##c_name##p; \ |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
1864 extern MODULE_API struct lrecord_implementation lrecord_##c_name |
|
5120
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1865 # define DECLARE_MODULE_LISP_OBJECT(c_name, structtype) \ |
| 442 | 1866 extern Lisp_Object Q##c_name##p; \ |
| 647 | 1867 extern int lrecord_type_##c_name; \ |
| 444 | 1868 extern struct lrecord_implementation lrecord_##c_name |
| 428 | 1869 # define XRECORD(x, c_name, structtype) ((structtype *) XPNTR (x)) |
| 617 | 1870 /* wrap_pointer_1 is so named as a suggestion not to use it unless you |
| 1871 know what you're doing. */ | |
| 1872 #define wrap_record(ptr, ty) wrap_pointer_1 (ptr) | |
| 428 | 1873 |
| 800 | 1874 #endif /* not ERROR_CHECK_TYPES */ |
| 428 | 1875 |
| 442 | 1876 #define RECORDP(x, c_name) RECORD_TYPEP (x, lrecord_type_##c_name) |
| 428 | 1877 |
| 1878 /* Note: we now have two different kinds of type-checking macros. | |
| 1879 The "old" kind has now been renamed CONCHECK_foo. The reason for | |
| 1880 this is that the CONCHECK_foo macros signal a continuable error, | |
| 1881 allowing the user (through debug-on-error) to substitute a different | |
| 1882 value and return from the signal, which causes the lvalue argument | |
| 1883 to get changed. Quite a lot of code would crash if that happened, | |
| 1884 because it did things like | |
| 1885 | |
| 1886 foo = XCAR (list); | |
| 1887 CHECK_STRING (foo); | |
| 1888 | |
| 1889 and later on did XSTRING (XCAR (list)), assuming that the type | |
| 1890 is correct (when it might be wrong, if the user substituted a | |
| 1891 correct value in the debugger). | |
| 1892 | |
| 1893 To get around this, I made all the CHECK_foo macros signal a | |
| 1894 non-continuable error. Places where a continuable error is OK | |
| 1895 (generally only when called directly on the argument of a Lisp | |
| 1896 primitive) should be changed to use CONCHECK(). | |
| 1897 | |
| 1898 FSF Emacs does not have this problem because RMS took the cheesy | |
| 1899 way out and disabled returning from a signal entirely. */ | |
| 1900 | |
| 1901 #define CONCHECK_RECORD(x, c_name) do { \ | |
| 442 | 1902 if (!RECORD_TYPEP (x, lrecord_type_##c_name)) \ |
| 428 | 1903 x = wrong_type_argument (Q##c_name##p, x); \ |
| 1904 } while (0) | |
| 1905 #define CONCHECK_NONRECORD(x, lisp_enum, predicate) do {\ | |
| 1906 if (XTYPE (x) != lisp_enum) \ | |
| 1907 x = wrong_type_argument (predicate, x); \ | |
| 1908 } while (0) | |
| 1909 #define CHECK_RECORD(x, c_name) do { \ | |
| 442 | 1910 if (!RECORD_TYPEP (x, lrecord_type_##c_name)) \ |
| 428 | 1911 dead_wrong_type_argument (Q##c_name##p, x); \ |
| 1912 } while (0) | |
| 1913 #define CHECK_NONRECORD(x, lisp_enum, predicate) do { \ | |
| 1914 if (XTYPE (x) != lisp_enum) \ | |
| 1915 dead_wrong_type_argument (predicate, x); \ | |
| 1916 } while (0) | |
| 1917 | |
| 3263 | 1918 #ifndef NEW_GC |
| 1204 | 1919 /*-------------------------- lcrecord-list -----------------------------*/ |
| 1920 | |
| 1921 struct lcrecord_list | |
| 1922 { | |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1923 NORMAL_LISP_OBJECT_HEADER header; |
| 1204 | 1924 Lisp_Object free; |
| 1925 Elemcount size; | |
| 1926 const struct lrecord_implementation *implementation; | |
| 1927 }; | |
| 1928 | |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1929 DECLARE_LISP_OBJECT (lcrecord_list, struct lcrecord_list); |
| 1204 | 1930 #define XLCRECORD_LIST(x) XRECORD (x, lcrecord_list, struct lcrecord_list) |
| 1931 #define wrap_lcrecord_list(p) wrap_record (p, lcrecord_list) | |
| 1932 #define LCRECORD_LISTP(x) RECORDP (x, lcrecord_list) | |
| 1933 /* #define CHECK_LCRECORD_LIST(x) CHECK_RECORD (x, lcrecord_list) | |
| 1934 Lcrecord lists should never escape to the Lisp level, so | |
| 1935 functions should not be doing this. */ | |
| 1936 | |
| 826 | 1937 /* Various ways of allocating lcrecords. All bytes (except lcrecord |
| 1204 | 1938 header) are zeroed in returned structure. |
| 1939 | |
| 1940 See above for a discussion of the difference between plain lrecords and | |
| 1941 lrecords. lcrecords themselves are divided into three types: (1) | |
| 1942 auto-managed, (2) hand-managed, and (3) unmanaged. "Managed" refers to | |
| 1943 using a special object called an lcrecord-list to keep track of freed | |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1944 lcrecords, which can freed with free_normal_lisp_object() or the like |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1945 and later be recycled when a new lcrecord is required, rather than |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1946 requiring new malloc(). Thus, allocation of lcrecords can be very |
| 1204 | 1947 cheap. (Technically, the lcrecord-list manager could divide up large |
| 1948 chunks of memory and allocate out of that, mimicking what happens with | |
| 1949 lrecords. At that point, however, we'd want to rethink the whole | |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1950 division between lrecords and lcrecords.) |
| 1204 | 1951 |
| 1952 NOTE: There is a fundamental limitation of lcrecord-lists, which is that | |
| 1953 they only handle blocks of a particular, fixed size. Thus, objects that | |
| 1954 can be of varying sizes need to do various tricks. These considerations | |
| 1955 in particular dictate the various types of management: | |
| 1956 | |
| 1957 -- "Auto-managed" means that you just go ahead and allocate the lcrecord | |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1958 whenever you want, using ALLOC_NORMAL_LISP_OBJECT(), and the appropriate |
| 1204 | 1959 lcrecord-list manager is automatically created. To free, you just call |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
1960 "free_normal_lisp_object()" and the appropriate lcrecord-list manager is |
| 1204 | 1961 automatically located and called. The limitation here of course is that |
| 1962 all your objects are of the same size. (#### Eventually we should have a | |
| 1963 more sophisticated system that tracks the sizes seen and creates one | |
| 1964 lcrecord list per size, indexed in a hash table. Usually there are only | |
| 1965 a limited number of sizes, so this works well.) | |
| 826 | 1966 |
| 1204 | 1967 -- "Hand-managed" exists because we haven't yet written the more |
| 1968 sophisticated scheme for auto-handling different-sized lcrecords, as | |
| 1969 described in the end of the last paragraph. In this model, you go ahead | |
| 1970 and create the lcrecord-list objects yourself for the sizes you will | |
| 1971 need, using make_lcrecord_list(). Then, create lcrecords using | |
| 1972 alloc_managed_lcrecord(), passing in the lcrecord-list you created, and | |
| 1973 free them with free_managed_lcrecord(). | |
| 1974 | |
| 1975 -- "Unmanaged" means you simply allocate lcrecords, period. No | |
| 1976 lcrecord-lists, no way to free them. This may be suitable when the | |
| 1977 lcrecords are variable-sized and (a) you're too lazy to write the code | |
| 1978 to hand-manage them, or (b) the objects you create are always or almost | |
| 1979 always Lisp-visible, and thus there's no point in freeing them (and it | |
| 1980 wouldn't be safe to do so). You just create them with | |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
1981 ALLOC_SIZED_LISP_OBJECT(), and that's it. |
| 1204 | 1982 |
| 1983 --ben | |
| 1984 | |
| 1985 Here is an in-depth look at the steps required to create a allocate an | |
| 1986 lcrecord using the hand-managed style. Since this is the most | |
| 1987 complicated, you will learn a lot about the other styles as well. In | |
| 1988 addition, there is useful general information about what freeing an | |
| 1989 lcrecord really entails, and what are the precautions: | |
| 1990 | |
| 1991 1) Create an lcrecord-list object using make_lcrecord_list(). This is | |
| 1992 often done at initialization. Remember to staticpro_nodump() this | |
| 1993 object! The arguments to make_lcrecord_list() are the same as would be | |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
1994 passed to ALLOC_SIZED_LISP_OBJECT(). |
| 428 | 1995 |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
1996 2) Instead of calling ALLOC_SIZED_LISP_OBJECT(), call |
|
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
1997 alloc_managed_lcrecord() and pass the lcrecord-list earlier created. |
| 1204 | 1998 |
| 1999 3) When done with the lcrecord, call free_managed_lcrecord(). The | |
| 2000 standard freeing caveats apply: ** make sure there are no pointers to | |
| 2001 the object anywhere! ** | |
| 2002 | |
| 2003 4) Calling free_managed_lcrecord() is just like kissing the | |
| 2004 lcrecord goodbye as if it were garbage-collected. This means: | |
| 2005 -- the contents of the freed lcrecord are undefined, and the | |
| 2006 contents of something produced by alloc_managed_lcrecord() | |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
2007 are undefined, just like for ALLOC_SIZED_LISP_OBJECT(). |
| 1204 | 2008 -- the mark method for the lcrecord's type will *NEVER* be called |
| 2009 on freed lcrecords. | |
| 2010 -- the finalize method for the lcrecord's type will be called | |
| 2011 at the time that free_managed_lcrecord() is called. | |
| 2012 */ | |
| 2013 | |
| 2014 /* UNMANAGED MODEL: */ | |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
2015 Lisp_Object old_alloc_lcrecord (const struct lrecord_implementation *); |
|
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
2016 Lisp_Object old_alloc_sized_lcrecord (Bytecount size, |
|
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
2017 const struct lrecord_implementation *); |
| 1204 | 2018 |
| 2019 /* HAND-MANAGED MODEL: */ | |
| 2020 Lisp_Object make_lcrecord_list (Elemcount size, | |
| 2021 const struct lrecord_implementation | |
| 2022 *implementation); | |
| 2023 Lisp_Object alloc_managed_lcrecord (Lisp_Object lcrecord_list); | |
| 2024 void free_managed_lcrecord (Lisp_Object lcrecord_list, Lisp_Object lcrecord); | |
| 2025 | |
| 2026 /* AUTO-MANAGED MODEL: */ | |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
2027 MODULE_API Lisp_Object |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
2028 alloc_automanaged_sized_lcrecord (Bytecount size, |
|
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
2029 const struct lrecord_implementation *imp); |
|
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
2030 MODULE_API Lisp_Object |
|
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
2031 alloc_automanaged_lcrecord (const struct lrecord_implementation *imp); |
| 3017 | 2032 |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
2033 #define old_alloc_lcrecord_type(type, imp) \ |
|
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
2034 ((type *) XPNTR (alloc_automanaged_lcrecord (sizeof (type), imp))) |
| 2720 | 2035 |
| 3024 | 2036 void old_free_lcrecord (Lisp_Object rec); |
| 771 | 2037 |
| 3263 | 2038 #else /* NEW_GC */ |
| 2720 | 2039 |
|
5120
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
2040 MODULE_API Lisp_Object alloc_sized_lrecord (Bytecount size, |
|
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
2041 const struct lrecord_implementation *imp); |
|
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3063
diff
changeset
|
2042 Lisp_Object noseeum_alloc_sized_lrecord (Bytecount size, |
|
5120
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
2043 const struct lrecord_implementation *imp); |
|
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
2044 MODULE_API Lisp_Object alloc_lrecord (const struct lrecord_implementation *imp); |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
2045 Lisp_Object noseeum_alloc_lrecord (const struct lrecord_implementation *imp); |
| 3092 | 2046 |
|
5120
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
2047 MODULE_API Lisp_Object alloc_lrecord_array (int elemcount, |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
2048 const struct lrecord_implementation *imp); |
|
5120
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
2049 MODULE_API Lisp_Object alloc_sized_lrecord_array (Bytecount size, |
|
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
2050 int elemcount, |
|
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
2051 const struct lrecord_implementation *imp); |
| 2720 | 2052 |
| 3263 | 2053 #endif /* NEW_GC */ |
| 3017 | 2054 |
| 1204 | 2055 DECLARE_INLINE_HEADER ( |
| 2056 Bytecount | |
| 2057 detagged_lisp_object_size (const struct lrecord_header *h) | |
| 2058 ) | |
| 2059 { | |
| 2060 const struct lrecord_implementation *imp = LHEADER_IMPLEMENTATION (h); | |
| 2061 | |
| 2062 return (imp->size_in_bytes_method ? | |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
2063 imp->size_in_bytes_method (wrap_pointer_1 (h)) : |
| 1204 | 2064 imp->static_size); |
| 2065 } | |
| 2066 | |
| 2067 DECLARE_INLINE_HEADER ( | |
| 2068 Bytecount | |
| 2069 lisp_object_size (Lisp_Object o) | |
| 2070 ) | |
| 2071 { | |
| 2072 return detagged_lisp_object_size (XRECORD_LHEADER (o)); | |
| 2073 } | |
| 2074 | |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
2075 struct usage_stats; |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
2076 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
2077 MODULE_API void copy_lisp_object (Lisp_Object dst, Lisp_Object src); |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
2078 MODULE_API void zero_sized_lisp_object (Lisp_Object obj, Bytecount size); |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
2079 MODULE_API void zero_nonsized_lisp_object (Lisp_Object obj); |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
2080 Bytecount lisp_object_storage_size (Lisp_Object obj, |
|
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
2081 struct usage_stats *ustats); |
|
5170
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
2082 Bytecount lisp_object_memory_usage_full (Lisp_Object object, |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
2083 Bytecount *storage_size, |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
2084 Bytecount *extra_nonlisp_storage, |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
2085 Bytecount *extra_lisp_storage, |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
2086 struct generic_usage_stats *stats); |
|
5ddbab03b0e6
various fixes to memory-usage stats
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
2087 Bytecount lisp_object_memory_usage (Lisp_Object object); |
|
5179
14fda1dbdb26
add memory usage info for specifiers
Ben Wing <ben@xemacs.org>
parents:
5170
diff
changeset
|
2088 Bytecount tree_memory_usage (Lisp_Object arg, int vectorp); |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
2089 void free_normal_lisp_object (Lisp_Object obj); |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
2090 |
| 1204 | 2091 |
| 2092 /************************************************************************/ | |
| 2093 /* Dumping */ | |
| 2094 /************************************************************************/ | |
| 2095 | |
| 2367 | 2096 /* dump_add_root_block_ptr (&var, &desc) dumps the structure pointed to by |
| 1204 | 2097 `var'. This is for a single relocatable pointer located in the data |
| 2367 | 2098 segment (i.e. the block pointed to is in the heap). |
| 2099 | |
| 2100 If the structure pointed to is not a `struct' but an array, you should | |
| 2101 set the size field of the sized_memory_description to 0, and use | |
| 2102 XD_BLOCK_ARRAY in the inner memory_description. | |
| 2103 | |
| 2104 NOTE that a "root struct pointer" could also be described using | |
| 2105 dump_add_root_block(), with SIZE == sizeof (void *), and a description | |
| 2106 containing a single XD_BLOCK_PTR entry, offset 0, size 1, with a | |
| 2107 structure description the same as the value passed to | |
| 2108 dump_add_root_block_ptr(). That would require an extra level of | |
| 2109 description, though, as compared to using dump_add_root_block_ptr(), | |
| 2110 and thus this function is generally more convenient. | |
| 2111 */ | |
| 1204 | 2112 #ifdef PDUMP |
| 2367 | 2113 void dump_add_root_block_ptr (void *, const struct sized_memory_description *); |
| 1204 | 2114 #else |
| 2367 | 2115 #define dump_add_root_block_ptr(varaddr, descaddr) DO_NOTHING |
| 1204 | 2116 #endif |
| 2117 | |
| 2118 /* dump_add_opaque (&var, size) dumps the opaque static structure `var'. | |
| 2119 This is for a static block of memory (in the data segment, not the | |
| 2120 heap), with no relocatable pointers in it. */ | |
| 2121 #ifdef PDUMP | |
| 2122 #define dump_add_opaque(varaddr,size) dump_add_root_block (varaddr, size, NULL) | |
| 2123 #else | |
| 2124 #define dump_add_opaque(varaddr,size) DO_NOTHING | |
| 2125 #endif | |
| 2126 | |
| 2127 /* dump_add_root_block (ptr, size, desc) dumps the static structure | |
| 2128 located at `var' of size SIZE and described by DESC. This is for a | |
| 2129 static block of memory (in the data segment, not the heap), with | |
| 2130 relocatable pointers in it. */ | |
| 2131 #ifdef PDUMP | |
| 2132 void dump_add_root_block (const void *ptraddress, Bytecount size, | |
| 2133 const struct memory_description *desc); | |
| 2134 #else | |
| 2367 | 2135 #define dump_add_root_block(ptraddress, size, desc) DO_NOTHING |
| 1204 | 2136 #endif |
| 2137 | |
| 2138 /* Call dump_add_opaque_int (&int_var) to dump `int_var', of type `int'. */ | |
| 2139 #ifdef PDUMP | |
| 2140 #define dump_add_opaque_int(int_varaddr) do { \ | |
| 2141 int *dao_ = (int_varaddr); /* type check */ \ | |
| 2142 dump_add_opaque (dao_, sizeof (*dao_)); \ | |
| 2143 } while (0) | |
| 2144 #else | |
| 2145 #define dump_add_opaque_int(int_varaddr) DO_NOTHING | |
| 2146 #endif | |
| 2147 | |
| 2148 /* Call dump_add_opaque_fixnum (&fixnum_var) to dump `fixnum_var', of type | |
| 2149 `Fixnum'. */ | |
| 2150 #ifdef PDUMP | |
| 2151 #define dump_add_opaque_fixnum(fixnum_varaddr) do { \ | |
| 2152 Fixnum *dao_ = (fixnum_varaddr); /* type check */ \ | |
| 2153 dump_add_opaque (dao_, sizeof (*dao_)); \ | |
| 2154 } while (0) | |
| 2155 #else | |
| 2156 #define dump_add_opaque_fixnum(fixnum_varaddr) DO_NOTHING | |
| 2157 #endif | |
| 2158 | |
| 2159 /* Call dump_add_root_lisp_object (&var) to ensure that var is properly | |
| 2160 updated after pdump. */ | |
| 2161 #ifdef PDUMP | |
| 2162 void dump_add_root_lisp_object (Lisp_Object *); | |
| 2163 #else | |
| 2164 #define dump_add_root_lisp_object(varaddr) DO_NOTHING | |
| 2165 #endif | |
| 2166 | |
| 2167 /* Call dump_add_weak_lisp_object (&var) to ensure that var is properly | |
| 2168 updated after pdump. var must point to a linked list of objects out of | |
| 2169 which some may not be dumped */ | |
| 2170 #ifdef PDUMP | |
| 2171 void dump_add_weak_object_chain (Lisp_Object *); | |
| 2172 #else | |
| 2173 #define dump_add_weak_object_chain(varaddr) DO_NOTHING | |
| 2174 #endif | |
| 2175 | |
| 2176 /* Nonzero means Emacs has already been initialized. | |
| 2177 Used during startup to detect startup of dumped Emacs. */ | |
| 1632 | 2178 extern MODULE_API int initialized; |
| 1204 | 2179 |
| 2180 #ifdef PDUMP | |
| 1688 | 2181 #include "dumper.h" |
| 3263 | 2182 #ifdef NEW_GC |
| 2720 | 2183 #define DUMPEDP(adr) 0 |
| 3263 | 2184 #else /* not NEW_GC */ |
| 2367 | 2185 #define DUMPEDP(adr) ((((Rawbyte *) (adr)) < pdump_end) && \ |
| 2186 (((Rawbyte *) (adr)) >= pdump_start)) | |
| 3263 | 2187 #endif /* not NEW_GC */ |
| 1204 | 2188 #else |
| 2189 #define DUMPEDP(adr) 0 | |
| 2190 #endif | |
| 2191 | |
| 1330 | 2192 #define OBJECT_DUMPED_P(obj) DUMPEDP (XPNTR (obj)) |
| 2193 | |
| 1204 | 2194 /***********************************************************************/ |
| 2195 /* data descriptions */ | |
| 2196 /***********************************************************************/ | |
| 2197 | |
| 2198 | |
| 2199 #if defined (USE_KKCC) || defined (PDUMP) | |
| 2200 | |
| 2201 extern int in_pdump; | |
| 2202 | |
| 2203 EMACS_INT lispdesc_indirect_count_1 (EMACS_INT code, | |
| 2204 const struct memory_description *idesc, | |
| 2205 const void *idata); | |
| 2206 const struct sized_memory_description *lispdesc_indirect_description_1 | |
| 2207 (const void *obj, const struct sized_memory_description *sdesc); | |
| 2367 | 2208 Bytecount lispdesc_block_size_1 (const void *obj, Bytecount size, |
| 2209 const struct memory_description *desc); | |
| 2210 | |
| 2211 DECLARE_INLINE_HEADER ( | |
| 2212 Bytecount lispdesc_block_size (const void *obj, | |
| 2213 const struct sized_memory_description *sdesc)) | |
| 2214 { | |
| 2215 return lispdesc_block_size_1 (obj, sdesc->size, sdesc->description); | |
| 2216 } | |
| 1204 | 2217 |
| 2218 DECLARE_INLINE_HEADER ( | |
| 2219 EMACS_INT | |
| 2220 lispdesc_indirect_count (EMACS_INT code, | |
| 2221 const struct memory_description *idesc, | |
| 2222 const void *idata) | |
| 2223 ) | |
| 2224 { | |
| 2225 if (XD_IS_INDIRECT (code)) | |
| 2226 code = lispdesc_indirect_count_1 (code, idesc, idata); | |
| 2227 return code; | |
| 2228 } | |
| 2229 | |
| 2230 DECLARE_INLINE_HEADER ( | |
| 2231 const struct sized_memory_description * | |
| 2232 lispdesc_indirect_description (const void *obj, | |
| 2233 const struct sized_memory_description *sdesc) | |
| 2234 ) | |
| 2235 { | |
| 2236 if (sdesc->description) | |
| 2237 return sdesc; | |
| 2238 else | |
| 2239 return lispdesc_indirect_description_1 (obj, sdesc); | |
| 2240 } | |
| 2241 | |
| 2242 | |
| 2243 /* Do standard XD_UNION processing. DESC1 is an entry in DESC, which | |
| 2244 describes the entire data structure. Returns NULL (do nothing, nothing | |
| 2245 matched), or a new value for DESC1. In the latter case, assign to DESC1 | |
| 2246 in your function and goto union_switcheroo. */ | |
| 2247 | |
| 2248 DECLARE_INLINE_HEADER ( | |
| 2249 const struct memory_description * | |
| 2250 lispdesc_process_xd_union (const struct memory_description *desc1, | |
| 2251 const struct memory_description *desc, | |
| 2252 const void *data) | |
| 2253 ) | |
| 2254 { | |
| 2255 int count = 0; | |
| 2256 EMACS_INT variant = lispdesc_indirect_count (desc1->data1, desc, | |
| 2257 data); | |
| 2258 desc1 = | |
| 2551 | 2259 lispdesc_indirect_description (data, desc1->data2.descr)->description; |
| 1204 | 2260 |
| 2261 for (count = 0; desc1[count].type != XD_END; count++) | |
| 2262 { | |
| 2263 if ((desc1[count].flags & XD_FLAG_UNION_DEFAULT_ENTRY) || | |
| 2264 desc1[count].offset == variant) | |
| 2265 { | |
| 2266 return &desc1[count]; | |
| 2267 } | |
| 2268 } | |
| 2269 | |
| 2270 return NULL; | |
| 2271 } | |
| 2272 | |
| 2273 #endif /* defined (USE_KKCC) || defined (PDUMP) */ | |
| 428 | 2274 |
| 1743 | 2275 END_C_DECLS |
| 1650 | 2276 |
| 440 | 2277 #endif /* INCLUDED_lrecord_h_ */ |