[gtk/keymap-rework-2: 17/19] gdk: Redo key events



commit 7c8c5ca224e7c95b2807fd9612993f732bbcabf7
Author: Matthias Clasen <mclasen redhat com>
Date:   Sun Apr 5 14:40:55 2020 -0400

    gdk: Redo key events
    
    Add all of the keyboard translation results in the key event,
    so we can translate the keyboard state at the time the event
    is created, and avoid doing state translation at match time.
    
    This has one side-effect: we no longer ignore Lock state
    for accelerators, so Control-i will trigger the inspector
    when Caps Lock is on.
    
    At the same time, drop the scancode field - it is only ever
    set on win32, and is basically unused in GTK.
    
    Update all callers.

 docs/reference/gdk/gdk4-sections.txt |  5 ++-
 gdk/gdkevents.c                      | 72 ++++++++++++++++++------------------
 gdk/gdkevents.h                      |  6 ++-
 gdk/gdkeventsprivate.h               | 28 +++++++-------
 gdk/gdksurface.c                     | 15 ++++----
 gdk/wayland/gdkdevice-wayland.c      | 23 +++++++++---
 gdk/wayland/gdkkeys-wayland.c        |  9 +++++
 gdk/wayland/gdkprivate-wayland.h     |  2 +
 gdk/win32/gdkevents-win32.c          |  2 +-
 gdk/x11/gdkdevicemanager-xi2.c       | 12 +++---
 gtk/gtkeventcontrollerkey.c          |  2 +-
 gtk/gtkimcontextsimple.c             |  7 ++--
 12 files changed, 108 insertions(+), 75 deletions(-)
---
diff --git a/docs/reference/gdk/gdk4-sections.txt b/docs/reference/gdk/gdk4-sections.txt
index 553982ca50..a71897f32e 100644
--- a/docs/reference/gdk/gdk4-sections.txt
+++ b/docs/reference/gdk/gdk4-sections.txt
@@ -541,8 +541,9 @@ gdk_scroll_event_get_deltas
 gdk_scroll_event_is_stop
 gdk_key_event_get_keyval
 gdk_key_event_get_keycode
-gdk_key_event_get_scancode
-gdk_key_event_get_group
+gdk_key_event_get_consumed_modifiers
+gdk_key_event_get_layout
+gdk_key_event_get_level
 gdk_key_event_is_modifier
 gdk_focus_event_get_in
 gdk_touch_event_get_emulating_pointer
diff --git a/gdk/gdkevents.c b/gdk/gdkevents.c
index 100609f546..4d421a3492 100644
--- a/gdk/gdkevents.c
+++ b/gdk/gdkevents.c
@@ -936,11 +936,12 @@ gdk_event_key_new (GdkEventType     type,
                    GdkDevice       *device,
                    GdkDevice       *source_device,
                    guint32          time,
-                   GdkModifierType  state,
+                   guint            keycode,
                    guint            keyval,
-                   guint16          keycode,
-                   guint16          scancode,
-                   guint8           group,
+                   GdkModifierType  state,
+                   GdkModifierType  consumed,
+                   guint            layout,
+                   guint            level,
                    gboolean         is_modifier)
 {
   GdkEventKey *event;
@@ -956,11 +957,12 @@ gdk_event_key_new (GdkEventType     type,
   event->any.surface = g_object_ref (surface);
   event->any.device = g_object_ref (device);
   event->any.source_device = g_object_ref (source_device);
-  event->state = state;
+  event->keycode = keycode;
   event->keyval = keyval;
-  event->hardware_keycode = keycode;
-  event->key_scancode = scancode;
-  event->group = group;
+  event->state = state;
+  event->consumed = consumed;
+  event->layout = layout;
+  event->level = level;
   event->any.key_is_modifier = is_modifier;
 
   return (GdkEvent *)event;
@@ -1686,41 +1688,50 @@ gdk_key_event_get_keycode (GdkEvent *event)
   g_return_val_if_fail (event->any.type == GDK_KEY_PRESS ||
                         event->any.type == GDK_KEY_RELEASE, 0);
 
-  return event->key.hardware_keycode;
+  return event->key.keycode;
 }
 
 /**
- * gdk_key_event_get_scancode:
+ * gdk_key_event_get_level:
  * @event: a key event
  *
- * Extracts the scancode from a key event.
+ * Extracts the shift level from a key event.
  *
- * Returns: the scancode of @event
+ * Returns: the shift level of @event
  */
 guint
-gdk_key_event_get_scancode (GdkEvent *event)
+gdk_key_event_get_level (GdkEvent *event)
 {
   g_return_val_if_fail (event->any.type == GDK_KEY_PRESS ||
                         event->any.type == GDK_KEY_RELEASE, 0);
 
-  return event->key.key_scancode;
+  return event->key.level;
 }
 
 /**
- * gdk_key_event_get_group:
+ * gdk_key_event_get_layout:
  * @event: a key event
  *
- * Extracts the group from a key event.
+ * Extracts the layout from a key event.
  *
- * Returns: the group of @event
+ * Returns: the layout of @event
  */
 guint
-gdk_key_event_get_group (GdkEvent *event)
+gdk_key_event_get_layout (GdkEvent *event)
+{
+  g_return_val_if_fail (event->any.type == GDK_KEY_PRESS ||
+                        event->any.type == GDK_KEY_RELEASE, 0);
+
+  return event->key.layout;
+}
+
+GdkModifierType
+gdk_key_event_get_consumed_modifiers (GdkEvent *event)
 {
   g_return_val_if_fail (event->any.type == GDK_KEY_PRESS ||
                         event->any.type == GDK_KEY_RELEASE, 0);
 
-  return event->key.group;
+  return event->key.consumed;
 }
 
 /**
@@ -2183,10 +2194,9 @@ gdk_event_matches (GdkEvent        *event,
   guint keycode;
   GdkModifierType state;
   GdkModifierType mask;
-  int group;
   GdkKeymap *keymap;
   guint ev_keyval;
-  int effective_group;
+  int layout;
   int level;
   GdkModifierType consumed_modifiers;
   GdkModifierType shift_group_mask;
@@ -2196,23 +2206,16 @@ gdk_event_matches (GdkEvent        *event,
     return GDK_EVENT_MATCH_NONE;
 
   keycode = gdk_key_event_get_keycode (event);
+  ev_keyval = gdk_key_event_get_keyval (event);
   state = gdk_event_get_modifier_state (event);
-  group = gdk_key_event_get_group (event);
+  layout = gdk_key_event_get_layout (event);
+  level = gdk_key_event_get_level (event);
+  consumed_modifiers = gdk_key_event_get_consumed_modifiers (event);
   keymap = gdk_display_get_keymap (gdk_event_get_display (event));
 
   mask = gdk_keymap_get_modifier_mask (keymap,
                                        GDK_MODIFIER_INTENT_DEFAULT_MOD_MASK);
 
-  /* We don't want Caps_Lock to affect keybinding lookups.
-   */
-  state &= ~GDK_LOCK_MASK;
-
-  translate_keyboard_accel_state (keymap,
-                                  keycode, state, group,
-                                  &ev_keyval,
-                                  &effective_group, &level,
-                                  &consumed_modifiers);
-
   /* if the group-toggling modifier is part of the default accel mod
    * mask, and it is active, disable it for matching
    */
@@ -2253,8 +2256,7 @@ gdk_event_matches (GdkEvent        *event,
           if (keys[i].keycode == keycode &&
               keys[i].level == level &&
               /* Only match for group if it's an accel mod */
-              (!group_mod_is_accel_mod ||
-               keys[i].group == effective_group))
+              (!group_mod_is_accel_mod || keys[i].group == layout))
             {
               /* partial match */
               g_free (keys);
@@ -2304,7 +2306,7 @@ gdk_event_get_match (GdkEvent        *event,
                                        GDK_MODIFIER_INTENT_DEFAULT_MOD_MASK);
 
   keycode = gdk_key_event_get_keycode (event);
-  group = gdk_key_event_get_group (event);
+  group = gdk_key_event_get_layout (event);
   accel_key = gdk_key_event_get_keyval (event);
   accel_mods = gdk_event_get_modifier_state (event);
 
diff --git a/gdk/gdkevents.h b/gdk/gdkevents.h
index 6d5fa26dbf..016186118c 100644
--- a/gdk/gdkevents.h
+++ b/gdk/gdkevents.h
@@ -363,9 +363,11 @@ guint                   gdk_key_event_get_keyval        (GdkEvent *event);
 GDK_AVAILABLE_IN_ALL
 guint                   gdk_key_event_get_keycode       (GdkEvent *event);
 GDK_AVAILABLE_IN_ALL
-guint                   gdk_key_event_get_scancode      (GdkEvent *event);
+GdkModifierType         gdk_key_event_get_consumed_modifiers (GdkEvent *event);
 GDK_AVAILABLE_IN_ALL
-guint                   gdk_key_event_get_group         (GdkEvent *event);
+guint                   gdk_key_event_get_layout        (GdkEvent *event);
+GDK_AVAILABLE_IN_ALL
+guint                   gdk_key_event_get_level         (GdkEvent *event);
 GDK_AVAILABLE_IN_ALL
 gboolean                gdk_key_event_is_modifier       (GdkEvent *event);
 GDK_AVAILABLE_IN_ALL
diff --git a/gdk/gdkeventsprivate.h b/gdk/gdkeventsprivate.h
index 6cc2aadcba..97649a7301 100644
--- a/gdk/gdkeventsprivate.h
+++ b/gdk/gdkeventsprivate.h
@@ -232,13 +232,13 @@ struct _GdkEventScroll
  * @state: (type GdkModifierType): a bit-mask representing the state of
  *   the modifier keys (e.g. Control, Shift and Alt) and the pointer
  *   buttons. See #GdkModifierType.
+ * @keycode: the raw code of the key that was pressed or released.
  * @keyval: the key that was pressed or released. See the
- *   `gdk/gdkkeysyms.h` header file for a
- *   complete list of GDK key codes.
- * @hardware_keycode: the raw code of the key that was pressed or released.
- * @group: the keyboard group.
- * @is_modifier: a flag that indicates if @hardware_keycode is mapped to a
- *   modifier
+ *   `gdk/gdkkeysyms.h` header file for a complete list of GDK key codes.
+ * @consumed_modifiers: Modifiers that were consumed when translating
+ *    @keycode to @keyval
+ * @layout: the effective keyboard layout
+ * @level: the effective shift level
  *
  * Describes a key press or key release event.
  */
@@ -246,10 +246,11 @@ struct _GdkEventKey
 {
   GdkEventAny any;
   GdkModifierType state;
+  guint32 keycode;
   guint keyval;
-  guint16 hardware_keycode;
-  guint16 key_scancode;
-  guint8 group;
+  GdkModifierType consumed;
+  guint layout;
+  guint level;
 };
 
 /*
@@ -599,11 +600,12 @@ GdkEvent * gdk_event_key_new            (GdkEventType     type,
                                          GdkDevice       *device,
                                          GdkDevice       *source_device,
                                          guint32          time,
-                                         GdkModifierType  state,
+                                         guint            keycode,
                                          guint            keyval,
-                                         guint16          keycode,
-                                         guint16          scancode,
-                                         guint8           group,
+                                         GdkModifierType  modifiers,
+                                         GdkModifierType  consumed_modifiers,
+                                         guint            layout,
+                                         guint            shift_level,
                                          gboolean         is_modifier);
 
 GdkEvent * gdk_event_focus_new          (GdkSurface      *surface,
diff --git a/gdk/gdksurface.c b/gdk/gdksurface.c
index 7432a9b348..fe7b99366f 100644
--- a/gdk/gdksurface.c
+++ b/gdk/gdksurface.c
@@ -2820,11 +2820,12 @@ rewrite_event_for_toplevel (GdkEvent *event)
                               gdk_event_get_device (event),
                               gdk_event_get_source_device (event),
                               gdk_event_get_time (event),
-                              gdk_event_get_modifier_state (event),
-                              gdk_key_event_get_keyval (event),
                               gdk_key_event_get_keycode (event),
-                              gdk_key_event_get_scancode (event),
-                              gdk_key_event_get_group (event),
+                              gdk_key_event_get_keyval (event),
+                              gdk_event_get_modifier_state (event),
+                              gdk_key_event_get_consumed_modifiers (event),
+                              gdk_key_event_get_layout (event),
+                              gdk_key_event_get_level (event),
                               gdk_key_event_is_modifier (event));
 }
 
@@ -2874,13 +2875,13 @@ add_event_mark (GdkEvent *event,
     case GDK_KEY_PRESS:
     case GDK_KEY_RELEASE:
       {
-        message = g_strdup_printf ("%s {keyval=%u, state=0x%x, hardware_keycode=%u key_scancode=%u group=%u 
is_modifier=%u}",
+        message = g_strdup_printf ("%s {keyval=%u, state=0x%x, keycode=%u layout=%u level=%u 
is_modifier=%u}",
                                    kind,
                                    gdk_key_event_get_keyval (event),
                                    gdk_event_get_modifier_state (event),
                                    gdk_key_event_get_keycode (event),
-                                   gdk_key_event_get_scancode (event),
-                                   gdk_key_event_get_group (event),
+                                   gdk_key_event_get_layout (event),
+                                   gdk_key_event_get_level (event),
                                    gdk_key_event_is_modifier (event));
         break;
       }
diff --git a/gdk/wayland/gdkdevice-wayland.c b/gdk/wayland/gdkdevice-wayland.c
index 18824309fe..c2c12b35b1 100644
--- a/gdk/wayland/gdkdevice-wayland.c
+++ b/gdk/wayland/gdkdevice-wayland.c
@@ -2023,6 +2023,9 @@ deliver_key_event (GdkWaylandSeat *seat,
   xkb_keysym_t sym;
   guint delay, interval, timeout;
   gint64 begin_time, now;
+  xkb_mod_mask_t consumed;
+  xkb_layout_index_t layout;
+  xkb_level_index_t level;
 
   begin_time = g_get_monotonic_time ();
 
@@ -2033,6 +2036,10 @@ deliver_key_event (GdkWaylandSeat *seat,
   xkb_keymap = _gdk_wayland_keymap_get_xkb_keymap (keymap);
 
   sym = xkb_state_key_get_one_sym (xkb_state, key);
+  consumed = xkb_state_key_get_consumed_mods2 (xkb_state, key, XKB_CONSUMED_MODE_GTK);
+  layout = xkb_state_key_get_layout (xkb_state, key);
+  level = xkb_state_key_get_level (xkb_state, key, layout);
+
   if (sym == XKB_KEY_NoSymbol)
     return;
 
@@ -2044,24 +2051,28 @@ deliver_key_event (GdkWaylandSeat *seat,
                              seat->master_keyboard,
                              seat->keyboard,
                              time_,
-                             device_get_modifiers (seat->master_pointer),
-                             sym,
-                             key,
                              key,
-                             0,
+                             sym,
+                             device_get_modifiers (seat->master_pointer),
+                             gdk_wayland_keymap_get_gdk_modifiers (keymap, consumed),
+                             layout,
+                             level,
                              _gdk_wayland_keymap_key_is_modifier (keymap, key));
 
   _gdk_wayland_display_deliver_event (seat->display, event);
 
   GDK_SEAT_NOTE (seat, EVENTS,
             g_message ("keyboard %s event%s, surface %p, code %d, sym %d, "
-                       "mods 0x%x",
+                       "mods 0x%x, consumed 0x%x, layout %d level %d",
                        (state ? "press" : "release"),
                        (from_key_repeat ? " (repeat)" : ""),
                        gdk_event_get_surface (event),
                        gdk_key_event_get_keycode (event),
                        gdk_key_event_get_keyval (event),
-                       gdk_event_get_modifier_state (event)));
+                       gdk_event_get_modifier_state (event),
+                       gdk_key_event_get_consumed_modifiers (event),
+                       gdk_key_event_get_layout (event),
+                       gdk_key_event_get_level (event)));
 
   if (!xkb_keymap_key_repeats (xkb_keymap, key))
     return;
diff --git a/gdk/wayland/gdkkeys-wayland.c b/gdk/wayland/gdkkeys-wayland.c
index ae5108c5dc..203e656750 100644
--- a/gdk/wayland/gdkkeys-wayland.c
+++ b/gdk/wayland/gdkkeys-wayland.c
@@ -300,6 +300,15 @@ get_gdk_modifiers (struct xkb_keymap *xkb_keymap,
   return state;
 }
 
+GdkModifierType
+gdk_wayland_keymap_get_gdk_modifiers (GdkKeymap *keymap,
+                                      guint32    mods)
+{
+  struct xkb_keymap *xkb_keymap = GDK_WAYLAND_KEYMAP (keymap)->xkb_keymap;
+
+  return get_gdk_modifiers (xkb_keymap, mods);
+}
+
 static gboolean
 gdk_wayland_keymap_translate_keyboard_state (GdkKeymap       *keymap,
                                             guint            hardware_keycode,
diff --git a/gdk/wayland/gdkprivate-wayland.h b/gdk/wayland/gdkprivate-wayland.h
index 6ea1a1ae6e..13dbd221e0 100644
--- a/gdk/wayland/gdkprivate-wayland.h
+++ b/gdk/wayland/gdkprivate-wayland.h
@@ -201,5 +201,7 @@ void gdk_wayland_surface_update_scale (GdkSurface *surface);
 
 GdkSurface * create_dnd_surface (GdkDisplay *display);
 
+GdkModifierType gdk_wayland_keymap_get_gdk_modifiers (GdkKeymap *keymap,
+                                                      guint32    mods);
 
 #endif /* __GDK_PRIVATE_WAYLAND_H__ */
diff --git a/gdk/win32/gdkevents-win32.c b/gdk/win32/gdkevents-win32.c
index 3daa4b86bf..cb67162587 100644
--- a/gdk/win32/gdkevents-win32.c
+++ b/gdk/win32/gdkevents-win32.c
@@ -806,7 +806,7 @@ _gdk_win32_print_event (GdkEvent *event)
       kvname = gdk_keyval_name (gdk_key_event_get_keyval (event));
       g_print ("%#.02x group:%d %s",
                gdk_key_event_get_keycode (event),
-               gdk_key_event_get_group (event),
+               gdk_key_event_get_layout (event),
               (kvname ? kvname : "??"));
       print_event_state (gdk_event_get_modifier_state (event));
       break;
diff --git a/gdk/x11/gdkdevicemanager-xi2.c b/gdk/x11/gdkdevicemanager-xi2.c
index 6e6ba54c93..5368093bf9 100644
--- a/gdk/x11/gdkdevicemanager-xi2.c
+++ b/gdk/x11/gdkdevicemanager-xi2.c
@@ -1521,6 +1521,7 @@ gdk_x11_device_manager_xi2_translate_event (GdkEventTranslator *translator,
         XIDeviceEvent *xev = (XIDeviceEvent *) ev;
         GdkKeymap *keymap = gdk_display_get_keymap (display);
         GdkModifierType consumed, state, orig_state;
+        int layout, level;
         guint keyval;
 
         GDK_DISPLAY_NOTE (display, EVENTS,
@@ -1549,7 +1550,7 @@ gdk_x11_device_manager_xi2_translate_event (GdkEventTranslator *translator,
                                              state,
                                              xev->group.effective,
                                              &keyval,
-                                             NULL, NULL, &consumed);
+                                             &layout, &level, &consumed);
         orig_state = state;
         state &= ~consumed;
         _gdk_x11_keymap_add_virt_mods (keymap, &state);
@@ -1562,11 +1563,12 @@ gdk_x11_device_manager_xi2_translate_event (GdkEventTranslator *translator,
                                    device,
                                    source_device,
                                    xev->time,
-                                   state,
-                                   keyval,
-                                   xev->detail,
                                    xev->detail,
-                                   xev->group.effective,
+                                   keyval,
+                                   state,
+                                   consumed,
+                                   layout,
+                                   level,
                                    gdk_x11_keymap_key_is_modifier (keymap, xev->detail));
 
         if (ev->evtype == XI_KeyPress)
diff --git a/gtk/gtkeventcontrollerkey.c b/gtk/gtkeventcontrollerkey.c
index 62614dbf79..ae7c11a8b0 100644
--- a/gtk/gtkeventcontrollerkey.c
+++ b/gtk/gtkeventcontrollerkey.c
@@ -385,5 +385,5 @@ gtk_event_controller_key_get_group (GtkEventControllerKey *controller)
   g_return_val_if_fail (GTK_IS_EVENT_CONTROLLER_KEY (controller), FALSE);
   g_return_val_if_fail (controller->current_event != NULL, FALSE);
 
-  return gdk_key_event_get_group (controller->current_event);
+  return gdk_key_event_get_layout (controller->current_event);
 }
diff --git a/gtk/gtkimcontextsimple.c b/gtk/gtkimcontextsimple.c
index b5b868c7c0..4d12c8b7cc 100644
--- a/gtk/gtkimcontextsimple.c
+++ b/gtk/gtkimcontextsimple.c
@@ -935,10 +935,11 @@ no_sequence_matches (GtkIMContextSimple *context_simple,
                                                    gdk_event_get_device (event),
                                                    gdk_event_get_source_device (event),
                                                    gdk_event_get_time (event),
-                                                   gdk_event_get_modifier_state (event),
-                                                   tmp_keyval,
                                                    tmp_keyval,
                                                    tmp_keyval,
+                                                   gdk_event_get_modifier_state (event),
+                                                   0,
+                                                   0,
                                                    0,
                                                    0);
          
@@ -997,7 +998,7 @@ canonical_hex_keyval (GdkEvent *event)
    * any other state, and return that hex keyval if so
    */
   gdk_display_map_keycode (gdk_event_get_display (event),
-                           gdk_key_event_get_scancode (event),
+                           gdk_key_event_get_keycode (event),
                            NULL,
                            &keyvals, &n_vals);
 


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]