Implement support for reporting device names on PGTK

* lisp/frame.el (device-class): Add new function.
* lisp/term/pgtk-win.el (pgtk-device-class): New function.
* src/pgtkterm.c (pgtk_device_added_or_removal_cb)
(pgtk_seat_added_cb, pgtk_seat_removed_cb)
(pgtk_enumerate_devices)
(pgtk_free_devices, pgtk_regenerate_devices)
(pgtk_get_device_for_event): New functions.
(mark_pgtkterm): Mark device data.
(pgtk_delete_terminal): Delete device data.
(pgtk_handle_event, key_press_event, note_mouse_movement)
(construct_mouse_click, button_event, scroll_event)
(drag_data_received): Set device correctly.
(pgtk_term_init): Initialize device data and seat tracking.
(pgtk_delete_display): Delete device data.
* src/pgtkterm.h (struct pgtk_device_t): New struct.
(struct pgtk_display_info): New field `devices'.  Delete lots of
unused macros and reformat comments.

1 files changed, 212 insertions, 44 deletions

diff --git a/src/pgtkterm.c b/src/pgtkterm.c
index b2816aa04af..d8c6dad2f9d 100644
--- a/src/pgtkterm.c
+++ b/src/pgtkterm.c
@@ -98,15 +98,124 @@ static Time ignore_next_mouse_click_timeout;
 
 static Lisp_Object xg_default_icon_file;
 
-static void pgtk_delete_display (struct pgtk_display_info *dpyinfo);
-static void pgtk_clear_frame_area (struct frame *f, int x, int y, int width,
-                                   int height);
-static void pgtk_fill_rectangle (struct frame *f, unsigned long color, int x,
-                                 int y, int width, int height,
-                                 bool respect_alpha_background);
-static void pgtk_clip_to_row (struct window *w, struct glyph_row *row,
-                              enum glyph_row_area area, cairo_t * cr);
-static struct frame *pgtk_any_window_to_frame (GdkWindow *window);
+static void pgtk_delete_display (struct pgtk_display_info *);
+static void pgtk_clear_frame_area (struct frame *, int, int, int, int);
+static void pgtk_fill_rectangle (struct frame *, unsigned long, int, int,
+                                 int, int, bool);
+static void pgtk_clip_to_row (struct window *, struct glyph_row *,
+                              enum glyph_row_area, cairo_t *);
+static struct frame *pgtk_any_window_to_frame (GdkWindow *);
+static void pgtk_regenerate_devices (struct pgtk_display_info *);
+
+static void
+pgtk_device_added_or_removal_cb (GdkSeat *seat, GdkDevice *device,
+                                 gpointer user_data)
+{
+  pgtk_regenerate_devices (user_data);
+}
+
+static void
+pgtk_seat_added_cb (GdkDisplay *dpy, GdkSeat *seat,
+                    gpointer user_data)
+{
+  pgtk_regenerate_devices (user_data);
+
+  g_signal_connect (G_OBJECT (seat), "device-added",
+                    G_CALLBACK (pgtk_device_added_or_removal_cb),
+                    user_data);
+  g_signal_connect (G_OBJECT (seat), "device-removed",
+                    G_CALLBACK (pgtk_device_added_or_removal_cb),
+                    user_data);
+}
+
+static void
+pgtk_seat_removed_cb (GdkDisplay *dpy, GdkSeat *seat,
+                      gpointer user_data)
+{
+  pgtk_regenerate_devices (user_data);
+
+  g_signal_handlers_disconnect_by_func (G_OBJECT (seat),
+                                        G_CALLBACK (pgtk_device_added_or_removal_cb),
+                                        user_data);
+}
+
+static void
+pgtk_enumerate_devices (struct pgtk_display_info *dpyinfo,
+                        bool initial_p)
+{
+  struct pgtk_device_t *rec;
+  GList *all_seats, *devices_on_seat, *tem, *t1;
+  GdkSeat *seat;
+  char printbuf[1026]; /* Believe it or not, some device names are
+                          actually almost this long.  */
+
+  block_input ();
+  all_seats = gdk_display_list_seats (dpyinfo->gdpy);
+
+  for (tem = all_seats; tem; tem = tem->next)
+    {
+      seat = GDK_SEAT (tem->data);
+
+      if (initial_p)
+        {
+          g_signal_connect (G_OBJECT (seat), "device-added",
+                            G_CALLBACK (pgtk_device_added_or_removal_cb),
+                            dpyinfo);
+          g_signal_connect (G_OBJECT (seat), "device-removed",
+                            G_CALLBACK (pgtk_device_added_or_removal_cb),
+                            dpyinfo);
+        }
+
+      /* We only want slaves, not master devices.  */
+      devices_on_seat = gdk_seat_get_slaves (seat,
+                                             GDK_SEAT_CAPABILITY_ALL);
+
+      for (t1 = devices_on_seat; t1; t1 = t1->next)
+        {
+          rec = xmalloc (sizeof *rec);
+          rec->seat = g_object_ref (seat);
+          rec->device = GDK_DEVICE (t1->data);
+
+          snprintf (printbuf, 1026, "%u:%s",
+                    gdk_device_get_source (rec->device),
+                    gdk_device_get_name (rec->device));
+
+          rec->name = build_string (printbuf);
+          rec->next = dpyinfo->devices;
+          dpyinfo->devices = rec;
+        }
+
+      g_list_free (devices_on_seat);
+    }
+
+  g_list_free (all_seats);
+  unblock_input ();
+}
+
+static void
+pgtk_free_devices (struct pgtk_display_info *dpyinfo)
+{
+  struct pgtk_device_t *last, *tem;
+
+  tem = dpyinfo->devices;
+  while (tem)
+    {
+      last = tem;
+      tem = tem->next;
+
+      g_object_unref (last->seat);
+      xfree (last);
+    }
+
+  dpyinfo->devices = NULL;
+}
+
+static void
+pgtk_regenerate_devices (struct pgtk_display_info *dpyinfo)
+{
+  pgtk_free_devices (dpyinfo);
+  pgtk_enumerate_devices (dpyinfo, false);
+}
 
 static void
 pgtk_toolkit_position (struct frame *f, int x, int y,
@@ -136,6 +245,27 @@ pgtk_toolkit_position (struct frame *f, int x, int y,
     }
 }
 
+static Lisp_Object
+pgtk_get_device_for_event (struct pgtk_display_info *dpyinfo,
+                           GdkEvent *event)
+{
+  struct pgtk_device_t *tem;
+  GdkDevice *device;
+
+  device = gdk_event_get_source_device (event);
+
+  if (!device)
+    return Qt;
+
+  for (tem = dpyinfo->devices; tem; tem = tem->next)
+    {
+      if (tem->device == device)
+        return tem->name;
+    }
+
+  return Qt;
+}
+
 /* This is not a flip context in the same sense as gpu rendering
    scenes, it only occurs when a new context was required due to a
    resize or other fundamental change.  This is called when that
@@ -205,8 +335,11 @@ evq_flush (struct input_event *hold_quit)
 void
 mark_pgtkterm (void)
 {
+  struct pgtk_display_info *dpyinfo;
+  struct pgtk_device_t *device;
   struct event_queue_t *evq = &event_q;
   int i, n = evq->nr;
+
   for (i = 0; i < n; i++)
     {
       union buffered_input_event *ev = &evq->q[i];
@@ -215,6 +348,14 @@ mark_pgtkterm (void)
       mark_object (ev->ie.frame_or_window);
       mark_object (ev->ie.arg);
     }
+
+  for (dpyinfo = x_display_list; dpyinfo;
+       dpyinfo = dpyinfo->next)
+    {
+      for (device = dpyinfo->devices; device;
+           device = device->next)
+        mark_object (device->name);
+    }
 }
 
 char *
@@ -4460,11 +4601,20 @@ pgtk_delete_terminal (struct terminal *terminal)
       g_clear_object (&dpyinfo->vertical_scroll_bar_cursor);
       g_clear_object (&dpyinfo->horizontal_scroll_bar_cursor);
       g_clear_object (&dpyinfo->invisible_cursor);
-      if (dpyinfo->last_click_event != NULL) {
-        gdk_event_free (dpyinfo->last_click_event);
-        dpyinfo->last_click_event = NULL;
-      }
+      if (dpyinfo->last_click_event != NULL)
+        {
+          gdk_event_free (dpyinfo->last_click_event);
+          dpyinfo->last_click_event = NULL;
+        }
 
+      /* Disconnect these handlers before the display closes so
+         useless removal signals don't fire.  */
+      g_signal_handlers_disconnect_by_func (G_OBJECT (dpyinfo->gdpy),
+                                            G_CALLBACK (pgtk_seat_added_cb),
+                                            dpyinfo);
+      g_signal_handlers_disconnect_by_func (G_OBJECT (dpyinfo->gdpy),
+                                            G_CALLBACK (pgtk_seat_removed_cb),
+                                            dpyinfo);
       xg_display_close (dpyinfo->gdpy);
 
       dpyinfo->gdpy = NULL;
@@ -4889,6 +5039,8 @@ pgtk_handle_event (GtkWidget *widget, GdkEvent *event, gpointer *data)
                                make_float (event->touchpad_pinch.angle_delta));
           inev.ie.modifiers = pgtk_gtk_to_emacs_modifiers (FRAME_DISPLAY_INFO (f),
                                                            event->touchpad_pinch.state);
+          inev.ie.device
+            = pgtk_get_device_for_event (FRAME_DISPLAY_INFO (f), event);
           evq_enqueue (&inev);
         }
 
@@ -5227,7 +5379,7 @@ pgtk_enqueue_preedit (struct frame *f, Lisp_Object preedit)
 }
 
 static gboolean
-key_press_event (GtkWidget * widget, GdkEvent * event, gpointer * user_data)
+key_press_event (GtkWidget *widget, GdkEvent *event, gpointer *user_data)
 {
   struct coding_system coding;
   union buffered_input_event inev;
@@ -5237,8 +5389,6 @@ key_press_event (GtkWidget * widget, GdkEvent * event, gpointer * user_data)
   USE_SAFE_ALLOCA;
 
   EVENT_INIT (inev.ie);
-  inev.ie.kind = NO_EVENT;
-  inev.ie.arg = Qnil;
 
   struct frame *f = pgtk_any_window_to_frame (gtk_widget_get_window (widget));
   hlinfo = MOUSE_HL_INFO (f);
@@ -5321,6 +5471,9 @@ key_press_event (GtkWidget * widget, GdkEvent * event, gpointer * user_data)
         {
           inev.ie.kind = ASCII_KEYSTROKE_EVENT;
           inev.ie.code = keysym;
+
+          inev.ie.device
+            = pgtk_get_device_for_event (FRAME_DISPLAY_INFO (f), event);
           goto done;
         }
 
@@ -5332,6 +5485,9 @@ key_press_event (GtkWidget * widget, GdkEvent * event, gpointer * user_data)
           else
             inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
           inev.ie.code = keysym & 0xFFFFFF;
+
+          inev.ie.device
+            = pgtk_get_device_for_event (FRAME_DISPLAY_INFO (f), event);
           goto done;
         }
 
@@ -5344,6 +5500,9 @@ key_press_event (GtkWidget * widget, GdkEvent * event, gpointer * user_data)
                           ? ASCII_KEYSTROKE_EVENT
                           : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
           inev.ie.code = XFIXNAT (c);
+
+          inev.ie.device
+            = pgtk_get_device_for_event (FRAME_DISPLAY_INFO (f), event);
           goto done;
         }
 
@@ -5427,6 +5586,9 @@ key_press_event (GtkWidget * widget, GdkEvent * event, gpointer * user_data)
              key.  */
           inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
           inev.ie.code = keysym;
+
+          inev.ie.device
+            = pgtk_get_device_for_event (FRAME_DISPLAY_INFO (f), event);
           goto done;
         }
 
@@ -5478,6 +5640,8 @@ key_press_event (GtkWidget * widget, GdkEvent * event, gpointer * user_data)
                             ? ASCII_KEYSTROKE_EVENT
                             : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
             inev.ie.code = ch;
+            inev.ie.device
+              = pgtk_get_device_for_event (FRAME_DISPLAY_INFO (f), event);
             evq_enqueue (&inev);
           }
 
@@ -5859,7 +6023,8 @@ focus_out_event (GtkWidget * widget, GdkEvent * event, gpointer * user_data)
    another motion event, so we can check again the next time it moves.  */
 
 static bool
-note_mouse_movement (struct frame *frame, const GdkEventMotion * event)
+note_mouse_movement (struct frame *frame,
+                     const GdkEventMotion *event)
 {
   XRectangle *r;
   struct pgtk_display_info *dpyinfo;
@@ -5879,6 +6044,9 @@ note_mouse_movement (struct frame *frame, const GdkEventMotion * event)
       dpyinfo->last_mouse_scroll_bar = NULL;
       note_mouse_highlight (frame, -1, -1);
       dpyinfo->last_mouse_glyph_frame = NULL;
+      frame->last_mouse_device
+        = pgtk_get_device_for_event (FRAME_DISPLAY_INFO (frame),
+                                     (GdkEvent *) event);
       return true;
     }
 
@@ -5895,6 +6063,9 @@ note_mouse_movement (struct frame *frame, const GdkEventMotion * event)
       /* Remember which glyph we're now on.  */
       remember_mouse_glyph (frame, event->x, event->y, r);
       dpyinfo->last_mouse_glyph_frame = frame;
+      frame->last_mouse_device
+        = pgtk_get_device_for_event (FRAME_DISPLAY_INFO (frame),
+                                     (GdkEvent *) event);
       return true;
     }
 
@@ -6010,26 +6181,6 @@ motion_notify_event (GtkWidget * widget, GdkEvent * event,
   return TRUE;
 }
 
-/* Mouse clicks and mouse movement.  Rah.
-
-   Formerly, we used PointerMotionHintMask (in standard_event_mask)
-   so that we would have to call XQueryPointer after each MotionNotify
-   event to ask for another such event.  However, this made mouse tracking
-   slow, and there was a bug that made it eventually stop.
-
-   Simply asking for MotionNotify all the time seems to work better.
-
-   In order to avoid asking for motion events and then throwing most
-   of them away or busy-polling the server for mouse positions, we ask
-   the server for pointer motion hints.  This means that we get only
-   one event per group of mouse movements.  "Groups" are delimited by
-   other kinds of events (focus changes and button clicks, for
-   example), or by XQueryPointer calls; when one of these happens, we
-   get another MotionNotify event the next time the mouse moves.  This
-   is at least as efficient as getting motion events when mouse
-   tracking is on, and I suspect only negligibly worse when tracking
-   is off.  */
-
 /* Prepare a mouse-event in *RESULT for placement in the input queue.
 
    If the event is a button press, then note that we have grabbed
@@ -6037,7 +6188,8 @@ motion_notify_event (GtkWidget * widget, GdkEvent * event,
 
 static Lisp_Object
 construct_mouse_click (struct input_event *result,
-                       const GdkEventButton * event, struct frame *f)
+                       const GdkEventButton *event,
+                       struct frame *f)
 {
   /* Make the event type NO_EVENT; we'll change that when we decide
      otherwise.  */
@@ -6052,11 +6204,15 @@ construct_mouse_click (struct input_event *result,
   XSETINT (result->y, event->y);
   XSETFRAME (result->frame_or_window, f);
   result->arg = Qnil;
+  result->device = pgtk_get_device_for_event (FRAME_DISPLAY_INFO (f),
+                                              (GdkEvent *) event);
   return Qnil;
 }
 
 static gboolean
-button_event (GtkWidget * widget, GdkEvent * event, gpointer * user_data)
+button_event (GtkWidget *widget,
+              GdkEvent *event,
+              gpointer *user_data)
 {
   union buffered_input_event inev;
   struct frame *f, *frame;
@@ -6175,7 +6331,7 @@ button_event (GtkWidget * widget, GdkEvent * event, gpointer * user_data)
 }
 
 static gboolean
-scroll_event (GtkWidget * widget, GdkEvent * event, gpointer * user_data)
+scroll_event (GtkWidget *widget, GdkEvent *event, gpointer *user_data)
 {
   union buffered_input_event inev;
   struct frame *f, *frame;
@@ -6207,6 +6363,8 @@ scroll_event (GtkWidget * widget, GdkEvent * event, gpointer * user_data)
   if (gdk_event_is_scroll_stop_event (event))
     {
       inev.ie.kind = TOUCH_END_EVENT;
+      inev.ie.device
+        = pgtk_get_device_for_event (FRAME_DISPLAY_INFO (f), event);
       evq_enqueue (&inev);
       return TRUE;
     }
@@ -6300,14 +6458,17 @@ scroll_event (GtkWidget * widget, GdkEvent * event, gpointer * user_data)
     }
 
   if (inev.ie.kind != NO_EVENT)
-    evq_enqueue (&inev);
+    {
+      inev.ie.device
+        = pgtk_get_device_for_event (FRAME_DISPLAY_INFO (f), event);
+      evq_enqueue (&inev);
+    }
   return TRUE;
 }
 
 static void
-drag_data_received (GtkWidget * widget, GdkDragContext * context,
-                    gint x, gint y,
-                    GtkSelectionData * data,
+drag_data_received (GtkWidget *widget, GdkDragContext *context,
+                    gint x, gint y, GtkSelectionData *data,
                     guint info, guint time, gpointer user_data)
 {
   struct frame *f = pgtk_any_window_to_frame (gtk_widget_get_window (widget));
@@ -6716,6 +6877,12 @@ pgtk_term_init (Lisp_Object display_name, char *resource_name)
 
   pgtk_im_init (dpyinfo);
 
+  g_signal_connect (G_OBJECT (dpyinfo->gdpy), "seat-added",
+                    G_CALLBACK (pgtk_seat_added_cb), dpyinfo);
+  g_signal_connect (G_OBJECT (dpyinfo->gdpy), "seat-removed",
+                    G_CALLBACK (pgtk_seat_removed_cb), dpyinfo);
+  pgtk_enumerate_devices (dpyinfo, true);
+
   unblock_input ();
 
   return dpyinfo;
@@ -6749,6 +6916,7 @@ pgtk_delete_display (struct pgtk_display_info *dpyinfo)
           tail->next = tail->next->next;
     }
 
+  pgtk_free_devices (dpyinfo);
   xfree (dpyinfo);
 }