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