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