master 54876bf498: Reduce complexity of scroll bar window protection code

[Po Lu]

branch: master
commit 54876bf498f5e6b4f7a66a051b105c3ddd308945
Author: Po Lu <luangruo@yahoo.com>
Commit: Po Lu <luangruo@yahoo.com>

    Reduce complexity of scroll bar window protection code
    
    It turns out my previous theories of why ClientMessages were
    generated were wrong, and they are just generated so we can set
    finish to X_EVENT_GOTO_OUT to have them delivered immediately.
    
    This allows for the code to be simplified greatly, by not
    unpacking pointers to the raw window into the client messages.
    
    * src/xterm.c (x_unprotect_window_for_callback): Return the
    window removed from the queue, or nil if none.
    (x_scroll_bar_to_input_event)
    (x_horizontal_scroll_bar_to_input_event): Use window provided by
    x_unprotect_window_for_callback.
    (handle_one_xevent): Pass dpyinfo to functions that need it.
    (x_free_frame_resources): Remove "first scroll bar request"
    code.
    
    * src/xterm.h (struct x_display_info): Likewise.
---
 src/xterm.c | 104 +++++++++++++++++++++++++++++++-----------------------------
 src/xterm.h |   9 ------
 2 files changed, 54 insertions(+), 59 deletions(-)

diff --git a/src/xterm.c b/src/xterm.c
index 2d366e5511..527c26f0da 100644
--- a/src/xterm.c
+++ b/src/xterm.c
@@ -14385,17 +14385,23 @@ x_protect_window_for_callback (struct x_display_info 
*dpyinfo,
   return true;
 }
 
-static void
+static Lisp_Object
 x_unprotect_window_for_callback (struct x_display_info *dpyinfo)
 {
+  Lisp_Object window;
+
   if (!dpyinfo->n_protected_windows)
-    emacs_abort ();
+    return Qnil;
+
+  window = dpyinfo->protected_windows[0];
 
   dpyinfo->n_protected_windows--;
 
   if (dpyinfo->n_protected_windows)
     memmove (dpyinfo->protected_windows, &dpyinfo->protected_windows[1],
             sizeof (Lisp_Object) * dpyinfo->n_protected_windows);
+
+  return window;
 }
 
 /* Send a client message with message type Xatom_Scrollbar for a
@@ -14462,30 +14468,34 @@ x_send_scroll_bar_event (Lisp_Object window, enum 
scroll_bar_part part,
    in *IEVENT.  */
 
 static void
-x_scroll_bar_to_input_event (const XEvent *event,
+x_scroll_bar_to_input_event (struct x_display_info *dpyinfo,
+                            const XEvent *event,
                             struct input_event *ievent)
 {
-  const XClientMessageEvent *ev = &event->xclient;
   Lisp_Object window;
-  struct window *w;
 
-  /* See the comment in the function above.  */
-  intptr_t iw0 = ev->data.l[0];
-  intptr_t iw1 = ev->data.l[1];
-  intptr_t iw = (iw0 << 31 << 1) + (iw1 & 0xffffffffu);
-  w = (struct window *) iw;
+  /* Every time a scroll bar ClientMessage event is sent, the window
+     is pushed onto a queue that is traced for garbage collection.
+     Every time we need a window for a read scroll bar event, we
+     simply read from the other side of the queue.  */
+  window = x_unprotect_window_for_callback (dpyinfo);
 
-  XSETWINDOW (window, w);
+  if (NILP (window))
+    {
+      /* This means we are getting extra scroll bar events for some
+        reason, and shouldn't be possible in practice.  */
+      EVENT_INIT (*ievent);
+      return;
+    }
 
   ievent->kind = SCROLL_BAR_CLICK_EVENT;
   ievent->frame_or_window = window;
   ievent->arg = Qnil;
-  ievent->timestamp
-    = x_get_last_toolkit_time (FRAME_DISPLAY_INFO (XFRAME (w->frame)));
+  ievent->timestamp = x_get_last_toolkit_time (dpyinfo);
   ievent->code = 0;
-  ievent->part = ev->data.l[2];
-  ievent->x = make_fixnum (ev->data.l[3]);
-  ievent->y = make_fixnum (ev->data.l[4]);
+  ievent->part = event->xclient.data.l[2];
+  ievent->x = make_fixnum (event->xclient.data.l[3]);
+  ievent->y = make_fixnum (event->xclient.data.l[4]);
   ievent->modifiers = 0;
 }
 
@@ -14493,30 +14503,34 @@ x_scroll_bar_to_input_event (const XEvent *event,
    input event in *IEVENT.  */
 
 static void
-x_horizontal_scroll_bar_to_input_event (const XEvent *event,
+x_horizontal_scroll_bar_to_input_event (struct x_display_info *dpyinfo,
+                                       const XEvent *event,
                                        struct input_event *ievent)
 {
-  const XClientMessageEvent *ev = &event->xclient;
   Lisp_Object window;
-  struct window *w;
 
-  /* See the comment in the function above.  */
-  intptr_t iw0 = ev->data.l[0];
-  intptr_t iw1 = ev->data.l[1];
-  intptr_t iw = (iw0 << 31 << 1) + (iw1 & 0xffffffffu);
-  w = (struct window *) iw;
+  /* Every time a scroll bar ClientMessage event is sent, the window
+     is pushed onto a queue that is traced for garbage collection.
+     Every time we need a window for a read scroll bar event, we
+     simply read from the other side of the queue.  */
+  window = x_unprotect_window_for_callback (dpyinfo);
 
-  XSETWINDOW (window, w);
+  if (NILP (window))
+    {
+      /* This means we are getting extra scroll bar events for some
+        reason, and shouldn't be possible in practice.  */
+      EVENT_INIT (*ievent);
+      return;
+    }
 
   ievent->kind = HORIZONTAL_SCROLL_BAR_CLICK_EVENT;
   ievent->frame_or_window = window;
   ievent->arg = Qnil;
-  ievent->timestamp
-    = x_get_last_toolkit_time (FRAME_DISPLAY_INFO (XFRAME (w->frame)));
+  ievent->timestamp = x_get_last_toolkit_time (dpyinfo);
   ievent->code = 0;
-  ievent->part = ev->data.l[2];
-  ievent->x = make_fixnum (ev->data.l[3]);
-  ievent->y = make_fixnum (ev->data.l[4]);
+  ievent->part = event->xclient.data.l[2];
+  ievent->x = make_fixnum (event->xclient.data.l[3]);
+  ievent->y = make_fixnum (event->xclient.data.l[4]);
   ievent->modifiers = 0;
 }
 
@@ -18104,28 +18118,21 @@ handle_one_xevent (struct x_display_info *dpyinfo,
            we construct an input_event.  */
         if (event->xclient.message_type == dpyinfo->Xatom_Scrollbar)
           {
-            x_scroll_bar_to_input_event (event, &inev.ie);
-
-           /* Unprotect the first window to be sent in a
-              ClientMessage event, since it is now on the stack and
-              thereby subject to garbage collection.  */
-           if (event->xclient.serial
-               >= dpyinfo->first_valid_scroll_bar_req)
-             x_unprotect_window_for_callback (dpyinfo);
+           /* Convert the scroll bar event to an input event using
+              the first window entered into the scroll bar event
+              queue. */
+            x_scroll_bar_to_input_event (dpyinfo, event, &inev.ie);
 
            *finish = X_EVENT_GOTO_OUT;
             goto done;
           }
         else if (event->xclient.message_type == 
dpyinfo->Xatom_Horizontal_Scrollbar)
           {
-            x_horizontal_scroll_bar_to_input_event (event, &inev.ie);
-
-           /* Unprotect the first window to be sent in a
-              ClientMessage event, since it is now on the stack and
-              thereby subject to garbage collection.  */
-           if (event->xclient.serial
-               >= dpyinfo->first_valid_scroll_bar_req)
-             x_unprotect_window_for_callback (dpyinfo);
+           /* Convert the horizontal scroll bar event to an input
+              event using the first window entered into the scroll
+              bar event queue. */
+            x_horizontal_scroll_bar_to_input_event (dpyinfo, event,
+                                                   &inev.ie);
 
            *finish = X_EVENT_GOTO_OUT;
             goto done;
@@ -27347,11 +27354,8 @@ x_free_frame_resources (struct frame *f)
 #ifdef USE_TOOLKIT_SCROLL_BARS
       /* Since the frame was destroyed, we can no longer guarantee
         that scroll bar events will be received.  Clear
-        protected_windows, and ignore any preceding scroll bar events
-        that happen to still be deliverable.  */
+        protected_windows.  */
       dpyinfo->n_protected_windows = 0;
-      dpyinfo->first_valid_scroll_bar_req
-       = XNextRequest (dpyinfo->display);
 #endif
     }
 
diff --git a/src/xterm.h b/src/xterm.h
index d1671621c7..d6ff15e40f 100644
--- a/src/xterm.h
+++ b/src/xterm.h
@@ -839,15 +839,6 @@ struct x_display_info
      server_time_monotonic_p will be true).  */
   int_fast64_t server_time_offset;
 #endif
-
-#if defined USE_TOOLKIT_SCROLL_BARS
-  /* Serial number of the first scroll bar event to start listening
-     to.  This is necessary because protected_windows is display
-     local, but the destruction of a frame's edit window may cause
-     event windows to vanish before they are delivered, leading to
-     windows remaining protected indefinitely.  */
-  unsigned long first_valid_scroll_bar_req;
-#endif
 };
 
 #ifdef HAVE_X_I18N