Mercurial > hg > xemacs-beta
comparison src/lrecord.h @ 617:af57a77cbc92
[xemacs-hg @ 2001-06-18 07:09:50 by ben]
---------------------------------------------------------------
DOCUMENTATION FIXES:
---------------------------------------------------------------
eval.c: Correct documentation.
elhash.c: Doc correction.
---------------------------------------------------------------
LISP OBJECT CLEANUP:
---------------------------------------------------------------
bytecode.h, buffer.h, casetab.h, chartab.h, console-msw.h, console.h, database.c, device.h, eldap.h, elhash.h, events.h, extents.h, faces.h, file-coding.h, frame.h, glyphs.h, gui-x.h, gui.h, keymap.h, lisp-disunion.h, lisp-union.h, lisp.h, lrecord.h, lstream.h, mule-charset.h, objects.h, opaque.h, postgresql.h, process.h, rangetab.h, specifier.h, toolbar.h, tooltalk.h, ui-gtk.h: Add wrap_* to all objects (it was already there for a few of them)
-- an expression to encapsulate a pointer into a Lisp object,
rather than the inconvenient XSET*. "wrap" was chosen because
"make" as in make_int(), make_char() is not appropriate. (It
implies allocation. The issue does not exist for ints and chars
because they are not allocated.)
Full error checking has been added to these expressions. When
used without error checking, non-union build, use of these
expressions will incur no loss of efficiency. (In fact, XSET* is
now defined in terms of wrap_* in a non-union build.) In a union
build, you will also get no loss of efficiency provided that you
have a decent optimizing compiler, and a compiler that either
understands inlines or automatically inlines those particular
functions. (And since people don't normally do their production
builds on union, it doesn't matter.)
Update the sample Lisp object definition in lrecord.h accordingly.
dumper.c: Fix places in dumper that referenced wrap_object to reference
its new name, wrap_pointer_1.
buffer.c, bufslots.h, conslots.h, console.c, console.h, devslots.h, device.c, device.h, frame.c, frame.h, frameslots.h, window.c, window.h, winslots.h: -- Extract out the Lisp objects of `struct device' into devslots.h,
just like for the other structures.
-- Extract out the remaining (not copied into the window config)
Lisp objects in `struct window' into winslots.h; use different
macros (WINDOW_SLOT vs. WINDOW_SAVED_SLOT) to differentiate them.
-- Eliminate the `dead' flag of `struct frame', since it
duplicates information already available in `framemeths', and fix
FRAME_LIVE_P accordingly. (Devices and consoles already work this
way.)
-- In *slots.h, switch to system where MARKED_SLOT is automatically
undef'd at the end of the file. (Follows what winslots.h already
does.)
-- Update the comments at the beginning of *slots.h to be accurate.
-- When making any of the above objects dead, zero it out entirely
and reset all Lisp object slots to Qnil. (We were already doing
this somewhat, but not consistently.) This (1) Eliminates the
possibility of extra objects hanging around that ought to be
GC'd, (2) Causes an immediate crash if anyone tries to access a
structure in one of these objects, (3) Ensures consistent behavior
wrt dead objects.
dialog-msw.c: Use internal_object_printer, since this object should not escape.
---------------------------------------------------------------
FIXING A CRASH THAT I HIT ONCE (AND A RELATED BAD BEHAVIOR):
---------------------------------------------------------------
eval.c: Fix up some comments about the FSF implementation.
Fix two nasty bugs:
(1) condition_case_unwind frees the conses sitting in the
catch->tag slot too quickly, resulting in a crash that I hit.
(2) catches need to be unwound one at a time when calling
unwind-protect code, rather than all at once at the end; otherwise,
incorrect behavior can result. (A comment shows exactly how.)
backtrace.h: Improve comment about FSF differences in the handler stack.
---------------------------------------------------------------
FIXING A CRASH THAT I REPEATEDLY HIT WHEN USING THE MOUSE WHEEL
UNDER MSWINDOWS:
---------------------------------------------------------------
Basic idea: My crash is due either to a dead, non-marked,
GC-collected frame inside of a window mirror, or a prematurely
freed window mirror. We need to mark the Lisp objects inside of
window mirrors. Tracking the lifespan of window mirrors and
scrollbar instances is extremely hard, and there may well be
lurking bugs where such objects are freed too soon. The only safe
way to fix these problems (and it fixes both problems at once) is
to make both of these structures Lisp objects.
lrecord.h, emacs.c, inline.c, scrollbar-gtk.c, scrollbar-msw.c, scrollbar-x.c, scrollbar.c, scrollbar.h, symsinit.h: Make scrollbar instances actual Lisp objects. Mark the window
mirrors in them. inline.c needs to know about scrollbar.h now.
Record the new type in lrecord.h. Fix up scrollbar-*.c
appropriately. Create a hash table in scrollbar-msw.c so that the
scrollbar instances stored in scrollbar HWND's are properly
GC-protected. Create complex_vars_of_scrollbar_mswindows() to
create the hash table at startup, and call it from emacs.c. Don't
store the scrollbar instance as a property of the GTK scrollbar,
as it's not used and if we did this, we'd have to separately
GC-protect it in a hash table, like in MS Windows.
lrecord.h, frame.h, frame.c, frameslots.h, redisplay.c, window.c, window.h: Move mark_window_mirror from redisplay.c to window.c. Make window
mirrors actual Lisp objects. Tell lrecord.h about them. Change
the window mirror member of struct frame from a pointer to a Lisp
object, and add XWINDOW_MIRROR in appropriate places. Mark the
scrollbar instances in the window mirror.
redisplay.c, redisplay.h, alloc.c: Delete mark_redisplay. Don't call mark_redisplay. We now mark
frame-specific structures in mark_frame.
NOTE: I also deleted an extremely questionable call to
update_frame_window_mirrors(). It was extremely questionable
before, and now totally impossible, since it will create
Lisp objects during redisplay.
frame.c: Mark the scrollbar instances, which are now Lisp objects.
Call mark_gutter() here, not in mark_redisplay().
gutter.c: Update comments about correct marking.
---------------------------------------------------------------
ISSUES BROUGHT UP BY MARTIN:
---------------------------------------------------------------
buffer.h: Put back these macros the way Steve T and I think they ought to be.
I already explained in a previous changelog entry why I think these
macros should be the way I'd defined them. Once again:
We fix these macros so they don't care about the type of their
lvalues. The non-C-string equivalents of these already function
in the same way, and it's correct because it should be OK to pass
in a CBufbyte *, a BufByte *, a Char_Binary *, an UChar_Binary *,
etc. The whole reason for these different types is to work around
errors caused by signed-vs-unsigned non-matching types. Any
possible error that might be caught in a DFC macro would also be
caught wherever the argument is used elsewhere. So creating
multiple macro versions would add no useful error-checking and
just further complicate an already complicated area.
As for Martin's "ANSI aliasing" bug, XEmacs is not ANSI-aliasing
clean and probably never will be. Unless the board agrees to
change XEmacs in this way (and we really don't want to go down
that road), this is not a bug.
sound.h: Undo Martin's type change.
signal.c: Fix problem identified by Martin with Linux and g++ due to
non-standard declaration of setitimer().
systime.h: Update the docs for "qxe_" to point out why making the
encapsulation explicit is always the right way to go. (setitimer()
itself serves as an example.)
For 21.4:
update-elc-2.el: Correct misplaced parentheses, making lisp/mule not get
recompiled.
author | ben |
---|---|
date | Mon, 18 Jun 2001 07:10:32 +0000 |
parents | 0784d089fdc9 |
children | b39c14581166 |
comparison
equal
deleted
inserted
replaced
616:4f1c7a4ac1e6 | 617:af57a77cbc92 |
---|---|
169 lrecord_type_specifier, | 169 lrecord_type_specifier, |
170 lrecord_type_console, | 170 lrecord_type_console, |
171 lrecord_type_device, | 171 lrecord_type_device, |
172 lrecord_type_frame, | 172 lrecord_type_frame, |
173 lrecord_type_window, | 173 lrecord_type_window, |
174 lrecord_type_window_mirror, | |
174 lrecord_type_window_configuration, | 175 lrecord_type_window_configuration, |
175 lrecord_type_gui_item, | 176 lrecord_type_gui_item, |
176 lrecord_type_popup_data, | 177 lrecord_type_popup_data, |
177 lrecord_type_toolbar_button, | 178 lrecord_type_toolbar_button, |
179 lrecord_type_scrollbar_instance, | |
178 lrecord_type_color_instance, | 180 lrecord_type_color_instance, |
179 lrecord_type_font_instance, | 181 lrecord_type_font_instance, |
180 lrecord_type_image_instance, | 182 lrecord_type_image_instance, |
181 lrecord_type_glyph, | 183 lrecord_type_glyph, |
182 lrecord_type_face, | 184 lrecord_type_face, |
266 some consistency checking, and that only when error-checking is | 268 some consistency checking, and that only when error-checking is |
267 enabled. */ | 269 enabled. */ |
268 unsigned int basic_p :1; | 270 unsigned int basic_p :1; |
269 }; | 271 }; |
270 | 272 |
271 /* All the built-in lisp object types are enumerated in `enum record_type'. | 273 /* All the built-in lisp object types are enumerated in `enum lrecord_type'. |
272 Additional ones may be defined by a module (none yet). We leave some | 274 Additional ones may be defined by a module (none yet). We leave some |
273 room in `lrecord_implementations_table' for such new lisp object types. */ | 275 room in `lrecord_implementations_table' for such new lisp object types. */ |
274 #define MODULE_DEFINABLE_TYPE_COUNT 32 | 276 #define MODULE_DEFINABLE_TYPE_COUNT 32 |
275 | 277 |
276 extern const struct lrecord_implementation *lrecord_implementations_table[(unsigned int)lrecord_type_last_built_in_type + MODULE_DEFINABLE_TYPE_COUNT]; | 278 extern const struct lrecord_implementation *lrecord_implementations_table[(unsigned int)lrecord_type_last_built_in_type + MODULE_DEFINABLE_TYPE_COUNT]; |
510 1. Declare the struct for your object in a header file somewhere. | 512 1. Declare the struct for your object in a header file somewhere. |
511 Remember that it must begin with | 513 Remember that it must begin with |
512 | 514 |
513 struct lcrecord_header header; | 515 struct lcrecord_header header; |
514 | 516 |
515 2. Put a DECLARE_LRECORD() for the object below the struct definition, | 517 2. Put the "standard junk" (DECLARE_RECORD()/XFOO/XSETFOO/etc.) below the |
516 along with the standard XFOO/XSETFOO junk. | 518 struct definition -- see below. |
517 | 519 |
518 3. Add this header file to inline.c. | 520 3. Add this header file to inline.c. |
519 | 521 |
520 4. Create the methods for your object. Note that technically you don't | 522 4. Create the methods for your object. Note that technically you don't |
521 need any, but you will almost always want at least a mark method. | 523 need any, but you will almost always want at least a mark method. |
564 int dirty; | 566 int dirty; |
565 int vertical; | 567 int vertical; |
566 int border_width; | 568 int border_width; |
567 }; | 569 }; |
568 | 570 |
571 [[ the standard junk: ]] | |
572 | |
569 DECLARE_LRECORD (toolbar_button, struct toolbar_button); | 573 DECLARE_LRECORD (toolbar_button, struct toolbar_button); |
570 #define XTOOLBAR_BUTTON(x) XRECORD (x, toolbar_button, struct toolbar_button) | 574 #define XTOOLBAR_BUTTON(x) XRECORD (x, toolbar_button, struct toolbar_button) |
571 #define XSETTOOLBAR_BUTTON(x, p) XSETRECORD (x, p, toolbar_button) | 575 #define XSETTOOLBAR_BUTTON(x, p) XSETRECORD (x, p, toolbar_button) |
576 #define wrap_toolbar_button(p) wrap_record (p, toolbar_button) | |
572 #define TOOLBAR_BUTTONP(x) RECORDP (x, toolbar_button) | 577 #define TOOLBAR_BUTTONP(x) RECORDP (x, toolbar_button) |
573 #define CHECK_TOOLBAR_BUTTON(x) CHECK_RECORD (x, toolbar_button) | 578 #define CHECK_TOOLBAR_BUTTON(x) CHECK_RECORD (x, toolbar_button) |
574 #define CONCHECK_TOOLBAR_BUTTON(x) CONCHECK_RECORD (x, toolbar_button) | 579 #define CONCHECK_TOOLBAR_BUTTON(x) CONCHECK_RECORD (x, toolbar_button) |
575 | 580 |
576 ------------------------------ in toolbar.c ----------------------------- | 581 ------------------------------ in toolbar.c ----------------------------- |
594 mark_object (data->callback); | 599 mark_object (data->callback); |
595 mark_object (data->enabled_p); | 600 mark_object (data->enabled_p); |
596 return data->help_string; | 601 return data->help_string; |
597 } | 602 } |
598 | 603 |
604 [[ If your object should never escape to Lisp, declare its print method | |
605 as internal_object_printer instead of 0. ]] | |
606 | |
599 DEFINE_LRECORD_IMPLEMENTATION ("toolbar-button", toolbar_button, | 607 DEFINE_LRECORD_IMPLEMENTATION ("toolbar-button", toolbar_button, |
600 mark_toolbar_button, 0, 0, 0, 0, 0, | 608 mark_toolbar_button, 0, |
601 struct toolbar_button); | 609 0, 0, 0, 0, struct toolbar_button); |
602 | 610 |
603 ... | 611 ... |
604 | 612 |
605 void | 613 void |
606 syms_of_toolbar (void) | 614 syms_of_toolbar (void) |
681 # define XSETRECORD(var, p, c_name) do \ | 689 # define XSETRECORD(var, p, c_name) do \ |
682 { \ | 690 { \ |
683 XSETOBJ (var, p); \ | 691 XSETOBJ (var, p); \ |
684 assert (RECORD_TYPEP (var, lrecord_type_##c_name)); \ | 692 assert (RECORD_TYPEP (var, lrecord_type_##c_name)); \ |
685 } while (0) | 693 } while (0) |
694 | |
695 INLINE_HEADER Lisp_Object wrap_record_1 (void *ptr, enum lrecord_type ty); | |
696 INLINE_HEADER Lisp_Object | |
697 wrap_record_1 (void *ptr, enum lrecord_type ty) | |
698 { | |
699 Lisp_Object obj; | |
700 XSETOBJ (obj, ptr); | |
701 assert (RECORD_TYPEP (obj, ty)); | |
702 return obj; | |
703 } | |
704 | |
705 #define wrap_record(ptr, ty) wrap_record_1 (ptr, lrecord_type_##ty) | |
686 | 706 |
687 #else /* not ERROR_CHECK_TYPECHECK */ | 707 #else /* not ERROR_CHECK_TYPECHECK */ |
688 | 708 |
689 # define DECLARE_LRECORD(c_name, structtype) \ | 709 # define DECLARE_LRECORD(c_name, structtype) \ |
690 extern Lisp_Object Q##c_name##p; \ | 710 extern Lisp_Object Q##c_name##p; \ |
697 extern Lisp_Object Q##c_name##p | 717 extern Lisp_Object Q##c_name##p |
698 # define XRECORD(x, c_name, structtype) ((structtype *) XPNTR (x)) | 718 # define XRECORD(x, c_name, structtype) ((structtype *) XPNTR (x)) |
699 # define XNONRECORD(x, c_name, type_enum, structtype) \ | 719 # define XNONRECORD(x, c_name, type_enum, structtype) \ |
700 ((structtype *) XPNTR (x)) | 720 ((structtype *) XPNTR (x)) |
701 # define XSETRECORD(var, p, c_name) XSETOBJ (var, p) | 721 # define XSETRECORD(var, p, c_name) XSETOBJ (var, p) |
722 /* wrap_pointer_1 is so named as a suggestion not to use it unless you | |
723 know what you're doing. */ | |
724 #define wrap_record(ptr, ty) wrap_pointer_1 (ptr) | |
702 | 725 |
703 #endif /* not ERROR_CHECK_TYPECHECK */ | 726 #endif /* not ERROR_CHECK_TYPECHECK */ |
704 | 727 |
705 #define RECORDP(x, c_name) RECORD_TYPEP (x, lrecord_type_##c_name) | 728 #define RECORDP(x, c_name) RECORD_TYPEP (x, lrecord_type_##c_name) |
706 | 729 |