Mercurial > hg > xemacs-beta

diff src/winslots.h @ 617:af57a77cbc92

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[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 abe6d1db359e
children 8ae895c67ce7
line wrap: on
line diff
--- a/src/winslots.h	Mon Jun 11 07:47:20 2001 +0000
+++ b/src/winslots.h	Mon Jun 18 07:10:32 2001 +0000
@@ -1,7 +1,7 @@
 /* Definitions of marked slots in windows and window configs
    Copyright (C) 1985, 1986, 1992, 1993, 1994, 1995 Free Software Foundation, Inc.
    Copyright (C) 1994, 1995 Board of Trustees, University of Illinois.
-   Copyright (C) 1995, 1996 Ben Wing.
+   Copyright (C) 1995, 1996, 2001 Ben Wing.
    Copyright (C) 1996 Chuck Thompson.
 
 This file is part of XEmacs.
@@ -24,120 +24,221 @@
 /* Split out of window.h and window.c
    by Kirill Katsnelson <kkm@kis.ru>, May 1998 */
 
-#ifdef WINDOW_SLOT_DECLARATION
-#define WINDOW_SLOT_ARRAY(slot, size, compare) WINDOW_SLOT (slot[size], compare)
-#else
-#define WINDOW_SLOT_ARRAY(slot, size, compare) do {	\
-  int wsaidx;						\
-  for (wsaidx = 0; wsaidx < size; wsaidx++)		\
-    {							\
-      WINDOW_SLOT (slot[wsaidx], compare);		\
-    }							\
-} while (0);
+/* Separation into WINDOW_SLOT / WINDOW_SAVED_SLOT by Ben Wing, June 2001.
+
+   NOTE: No semicolons after slot declarations in this file!  The
+   definitions of WINDOW_SLOT (and possibly WINDOW_SAVED_SLOT) need
+   to include a semicolon.
+
+   WINDOW_SLOT declares a Lisp_Object that is not copied into the
+     saved_window struct of a window configuration, or is handled in
+     a special way in window configurations.
+   WINDOW_SLOT_ARRAY is the same for an array of Lisp_Objects.
+   WINDOW_SAVED_SLOT declares a Lisp_Object that is copied with no
+     special handling into the saved_window struct of a window
+     configuration.  You must also declare the comparison function,
+     either EQ or EQUAL_WRAPPED (i.e. Feq() or Fequal()).
+   WINDOW_SAVED_SLOT_ARRAY is the same for an array of Lisp_Objects.
+
+   Callers should define WINDOW_SLOT (with a terminating semicolon if
+   not blank), and WINDOW_SAVED_SLOT if different; otherwise the
+   latter will be defined using WINDOW_SLOT.  Callers do not define
+   the _ARRAY versions.  Instead, they either do or do not define
+   WINDOW_SLOT_DECLARATION.  It should be defined in the definition of
+   a struct and not elsewhere.
+
+   Callers do not need to undefine these definitions; it is done
+   automatically.
+*/
+
+#ifndef WINDOW_SAVED_SLOT
+#define WINDOW_SAVED_SLOT(slot, compare) WINDOW_SLOT (slot)
 #endif
 
+#ifdef WINDOW_SLOT_DECLARATION
+#define WINDOW_SLOT_ARRAY(slot, size) WINDOW_SLOT (slot[size])
+#define WINDOW_SAVED_SLOT_ARRAY(slot, size, compare) \
+  WINDOW_SAVED_SLOT (slot[size], compare)
+#else
+#define WINDOW_SLOT_ARRAY(slot, size) do {	\
+  int wsaidx;					\
+  for (wsaidx = 0; wsaidx < size; wsaidx++)	\
+    {						\
+      WINDOW_SLOT (slot[wsaidx]);		\
+    }						\
+} while (0);
+#define WINDOW_SAVED_SLOT_ARRAY(slot, size, compare) do {	\
+  int wsaidx;							\
+  for (wsaidx = 0; wsaidx < size; wsaidx++)			\
+    {								\
+      WINDOW_SAVED_SLOT (slot[wsaidx], compare);		\
+    }								\
+} while (0);
+#endif /* WINDOW_SLOT_DECLARATION */
+
 #define EQUAL_WRAPPED(x,y) internal_equal ((x), (y), 0)
 
+
+  /* The frame this window is on.  */
+  WINDOW_SLOT (frame)
+  /* t if this window is a minibuffer window.  */
+  WINDOW_SLOT (mini_p)
+  /* Following child (to right or down) at same level of tree */
+  WINDOW_SLOT (next)
+  /* Preceding child (to left or up) at same level of tree */
+  WINDOW_SLOT (prev)
+  /* First child of this window. */
+  /* vchild is used if this is a vertical combination,
+     hchild if this is a horizontal combination. */
+  WINDOW_SLOT (hchild)
+  WINDOW_SLOT (vchild)
+  /* The window this one is a child of. */
+  WINDOW_SLOT (parent)
+
+  /* The buffer displayed in this window */
+  /* Of the fields vchild, hchild and buffer, only one is non-nil.  */
+  WINDOW_SLOT (buffer)
+  /* A marker pointing to where in the text to start displaying */
+  /* need one for each set of display structures */
+  WINDOW_SLOT_ARRAY (start, 3)
+  /* A marker pointing to where in the text point is in this window,
+     used only when the window is not selected.
+     This exists so that when multiple windows show one buffer
+     each one can have its own value of point.  */
+  /* need one for each set of display structures */
+  WINDOW_SLOT_ARRAY (pointm, 3)
+  /* A marker pointing to where in the text the scrollbar is pointing;
+     #### moved to scrollbar.c? */
+  WINDOW_SLOT (sb_point)
+
+  /* Number saying how recently window was selected */
+  WINDOW_SLOT (use_time)
+  /* text.modified of displayed buffer as of last time display completed */
+  WINDOW_SLOT_ARRAY (last_modified, 3)
+  /* Value of point at that time */
+  WINDOW_SLOT_ARRAY (last_point, 3)
+  /* Value of start at that time */
+  WINDOW_SLOT_ARRAY (last_start, 3)
+  /* buf.face_change as of last time display completed */
+  WINDOW_SLOT_ARRAY (last_facechange, 3)
+
+  /* we cannot have a per-device cache of widgets / subwindows because
+     each visible instance needs to be a separate instance. The lowest
+     level of granularity we can get easily is the window that the
+     subwindow is in. This will fail if we attach the same subwindow
+     twice to a buffer. However, we are quite unlikely to do this,
+     especially with buttons which will need individual callbacks. The
+     proper solution is probably not worth the effort. */
+  WINDOW_SLOT (subwindow_instance_cache)
+
+  WINDOW_SLOT (line_cache_last_updated)
+
+  /* If redisplay in this window goes beyond this buffer position,
+     must run the redisplay-end-trigger-functions.  */
+  WINDOW_SLOT (redisplay_end_trigger)
+
   /*** Non-specifier vars of window and window config ***/
 
   /* Non-nil means window is marked as dedicated.  */
-  WINDOW_SLOT (dedicated, EQ);
+  WINDOW_SAVED_SLOT (dedicated, EQ)
 
   /*** specifier values cached in the struct window ***/
 
   /* Display-table to use for displaying chars in this window. */
-  WINDOW_SLOT (display_table, EQUAL_WRAPPED);
+  WINDOW_SAVED_SLOT (display_table, EQUAL_WRAPPED)
   /* Thickness of modeline shadow, in pixels.  If negative, draw
      as recessed. */
-  WINDOW_SLOT (modeline_shadow_thickness, EQ);
+  WINDOW_SAVED_SLOT (modeline_shadow_thickness, EQ)
   /* Non-nil means to display a modeline for the buffer. */
-  WINDOW_SLOT (has_modeline_p, EQ);
+  WINDOW_SAVED_SLOT (has_modeline_p, EQ)
   /* Thickness of vertical divider shadow, in pixels.  If negative, draw as
      recessed. */
-  WINDOW_SLOT (vertical_divider_shadow_thickness, EQ);
+  WINDOW_SAVED_SLOT (vertical_divider_shadow_thickness, EQ)
   /* Divider surface width (not counting 3-d borders) */
-  WINDOW_SLOT (vertical_divider_line_width, EQ);
+  WINDOW_SAVED_SLOT (vertical_divider_line_width, EQ)
   /* Spacing between outer edge of divider border and window edge */
-  WINDOW_SLOT (vertical_divider_spacing, EQ);
+  WINDOW_SAVED_SLOT (vertical_divider_spacing, EQ)
   /* Whether vertical dividers are always displayed */
-  WINDOW_SLOT (vertical_divider_always_visible_p, EQ);
+  WINDOW_SAVED_SLOT (vertical_divider_always_visible_p, EQ)
 
 #ifdef HAVE_SCROLLBARS
   /* Width of vertical scrollbars. */
-  WINDOW_SLOT (scrollbar_width, EQ);
+  WINDOW_SAVED_SLOT (scrollbar_width, EQ)
   /* Height of horizontal scrollbars. */
-  WINDOW_SLOT (scrollbar_height, EQ);
+  WINDOW_SAVED_SLOT (scrollbar_height, EQ)
   /* Whether the scrollbars are visible */
-  WINDOW_SLOT (horizontal_scrollbar_visible_p, EQ);
-  WINDOW_SLOT (vertical_scrollbar_visible_p, EQ);
+  WINDOW_SAVED_SLOT (horizontal_scrollbar_visible_p, EQ)
+  WINDOW_SAVED_SLOT (vertical_scrollbar_visible_p, EQ)
   /* Scrollbar positions */
-  WINDOW_SLOT (scrollbar_on_left_p, EQ);
-  WINDOW_SLOT (scrollbar_on_top_p, EQ);
+  WINDOW_SAVED_SLOT (scrollbar_on_left_p, EQ)
+  WINDOW_SAVED_SLOT (scrollbar_on_top_p, EQ)
   /* Pointer to use for vertical and horizontal scrollbars. */
-  WINDOW_SLOT (scrollbar_pointer, EQ);
+  WINDOW_SAVED_SLOT (scrollbar_pointer, EQ)
 #endif /* HAVE_SCROLLBARS */
 #ifdef HAVE_TOOLBARS
   /* Toolbar specification for each of the four positions.
      This is not a size hog because the value here is not copied,
      and will be shared with the specs in the specifier. */
-  WINDOW_SLOT_ARRAY (toolbar, 4, EQUAL_WRAPPED);
+  WINDOW_SAVED_SLOT_ARRAY (toolbar, 4, EQUAL_WRAPPED)
   /* Toolbar size for each of the four positions. */
-  WINDOW_SLOT_ARRAY (toolbar_size, 4, EQUAL_WRAPPED);
+  WINDOW_SAVED_SLOT_ARRAY (toolbar_size, 4, EQUAL_WRAPPED)
   /* Toolbar border width for each of the four positions. */
-  WINDOW_SLOT_ARRAY (toolbar_border_width, 4, EQUAL_WRAPPED);
+  WINDOW_SAVED_SLOT_ARRAY (toolbar_border_width, 4, EQUAL_WRAPPED)
   /* Toolbar visibility status for each of the four positions. */
-  WINDOW_SLOT_ARRAY (toolbar_visible_p, 4, EQUAL_WRAPPED);
+  WINDOW_SAVED_SLOT_ARRAY (toolbar_visible_p, 4, EQUAL_WRAPPED)
   /* Caption status of toolbar. */
-  WINDOW_SLOT (toolbar_buttons_captioned_p, EQ);
+  WINDOW_SAVED_SLOT (toolbar_buttons_captioned_p, EQ)
   /* The following five don't really need to be cached except
      that we need to know when they've changed. */
-  WINDOW_SLOT (default_toolbar, EQUAL_WRAPPED);
-  WINDOW_SLOT (default_toolbar_width, EQ);
-  WINDOW_SLOT (default_toolbar_height, EQ);
-  WINDOW_SLOT (default_toolbar_visible_p, EQ);
-  WINDOW_SLOT (default_toolbar_border_width, EQ);
+  WINDOW_SAVED_SLOT (default_toolbar, EQUAL_WRAPPED)
+  WINDOW_SAVED_SLOT (default_toolbar_width, EQ)
+  WINDOW_SAVED_SLOT (default_toolbar_height, EQ)
+  WINDOW_SAVED_SLOT (default_toolbar_visible_p, EQ)
+  WINDOW_SAVED_SLOT (default_toolbar_border_width, EQ)
 #endif /* HAVE_TOOLBARS */
 
   /* Gutter specification for each of the four positions.
      This is not a size hog because the value here is not copied,
      and will be shared with the specs in the specifier. */
-  WINDOW_SLOT_ARRAY (gutter, 4, EQUAL_WRAPPED);
+  WINDOW_SAVED_SLOT_ARRAY (gutter, 4, EQUAL_WRAPPED)
   /* Real (pre-calculated) gutter specification for each of the four positions.
      This is not a specifier, it is calculated by the specifier change
      functions. */
-  WINDOW_SLOT_ARRAY (real_gutter, 4, EQUAL_WRAPPED);
+  WINDOW_SAVED_SLOT_ARRAY (real_gutter, 4, EQUAL_WRAPPED)
   /* Gutter size for each of the four positions. */
-  WINDOW_SLOT_ARRAY (gutter_size, 4, EQUAL_WRAPPED);
+  WINDOW_SAVED_SLOT_ARRAY (gutter_size, 4, EQUAL_WRAPPED)
   /* Real (pre-calculated) gutter size for each of the four positions.
      This is not a specifier, it is calculated by the specifier change
      functions. */
-  WINDOW_SLOT_ARRAY (real_gutter_size, 4, EQUAL_WRAPPED);
+  WINDOW_SAVED_SLOT_ARRAY (real_gutter_size, 4, EQUAL_WRAPPED)
   /* Gutter border width for each of the four positions. */
-  WINDOW_SLOT_ARRAY (gutter_border_width, 4, EQUAL_WRAPPED);
+  WINDOW_SAVED_SLOT_ARRAY (gutter_border_width, 4, EQUAL_WRAPPED)
   /* Gutter visibility status for each of the four positions. */
-  WINDOW_SLOT_ARRAY (gutter_visible_p, 4, EQUAL_WRAPPED);
+  WINDOW_SAVED_SLOT_ARRAY (gutter_visible_p, 4, EQUAL_WRAPPED)
   /* The following five don't really need to be cached except
      that we need to know when they've changed. */
-  WINDOW_SLOT (default_gutter, EQUAL_WRAPPED);
-  WINDOW_SLOT (default_gutter_width, EQ);
-  WINDOW_SLOT (default_gutter_height, EQ);
-  WINDOW_SLOT (default_gutter_visible_p, EQ);
-  WINDOW_SLOT (default_gutter_border_width, EQ);
+  WINDOW_SAVED_SLOT (default_gutter, EQUAL_WRAPPED)
+  WINDOW_SAVED_SLOT (default_gutter_width, EQ)
+  WINDOW_SAVED_SLOT (default_gutter_height, EQ)
+  WINDOW_SAVED_SLOT (default_gutter_visible_p, EQ)
+  WINDOW_SAVED_SLOT (default_gutter_border_width, EQ)
 /* margins */
-  WINDOW_SLOT (left_margin_width, EQ);
-  WINDOW_SLOT (right_margin_width, EQ);
-  WINDOW_SLOT (minimum_line_ascent, EQ);
-  WINDOW_SLOT (minimum_line_descent, EQ);
-  WINDOW_SLOT (use_left_overflow, EQ);
-  WINDOW_SLOT (use_right_overflow, EQ);
+  WINDOW_SAVED_SLOT (left_margin_width, EQ)
+  WINDOW_SAVED_SLOT (right_margin_width, EQ)
+  WINDOW_SAVED_SLOT (minimum_line_ascent, EQ)
+  WINDOW_SAVED_SLOT (minimum_line_descent, EQ)
+  WINDOW_SAVED_SLOT (use_left_overflow, EQ)
+  WINDOW_SAVED_SLOT (use_right_overflow, EQ)
 #ifdef HAVE_MENUBARS
   /* Visibility of menubar. */
-  WINDOW_SLOT (menubar_visible_p, EQ);
+  WINDOW_SAVED_SLOT (menubar_visible_p, EQ)
 #endif /* HAVE_MENUBARS */
-  WINDOW_SLOT (text_cursor_visible_p, EQ);
+  WINDOW_SAVED_SLOT (text_cursor_visible_p, EQ)
 
   /* Hara-kiri */
 #undef EQUAL_WRAPPED
 #undef WINDOW_SLOT_DECLARATION
 #undef WINDOW_SLOT
 #undef WINDOW_SLOT_ARRAY
+#undef WINDOW_SAVED_SLOT
+#undef WINDOW_SAVED_SLOT_ARRAY