fl_keyboard_manager.cc File Reference

#include "flutter/shell/platform/linux/fl_keyboard_manager.h"
#include <array>
#include <cinttypes>
#include <memory>
#include <string>
#include "flutter/shell/platform/linux/fl_key_channel_responder.h"
#include "flutter/shell/platform/linux/fl_key_embedder_responder.h"
#include "flutter/shell/platform/linux/fl_keyboard_layout.h"
#include "flutter/shell/platform/linux/key_mapping.h"

Go to the source code of this file.

Classes
struct	HandleEventData
struct	_FlKeyboardManager

Macros
#define	DEBUG_PRINT_LAYOUT

Functions
static HandleEventData *	handle_event_data_new (FlKeyEvent *event)
static void	handle_event_data_free (HandleEventData *data)
	G_DEFINE_TYPE (FlKeyboardManager, fl_keyboard_manager, G_TYPE_OBJECT)
static gboolean	event_is_redispatched (FlKeyboardManager *self, FlKeyEvent *event)
static void	keymap_keys_changed_cb (FlKeyboardManager *self)
static void	complete_handle_event (FlKeyboardManager *self, GTask *task)
static void	responder_handle_embedder_event_cb (GObject *object, GAsyncResult *result, gpointer user_data)
static void	responder_handle_channel_event_cb (GObject *object, GAsyncResult *result, gpointer user_data)
static uint16_t	convert_key_to_char (FlKeyboardManager *self, guint keycode, gint group, gint level)
static void	guarantee_layout (FlKeyboardManager *self, FlKeyEvent *event)
static void	fl_keyboard_manager_dispose (GObject *object)
static void	fl_keyboard_manager_class_init (FlKeyboardManagerClass *klass)
static void	fl_keyboard_manager_init (FlKeyboardManager *self)
FlKeyboardManager *	fl_keyboard_manager_new (FlEngine *engine)
void	fl_keyboard_manager_add_redispatched_event (FlKeyboardManager *self, FlKeyEvent *event)
void	fl_keyboard_manager_handle_event (FlKeyboardManager *self, FlKeyEvent *event, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data)
gboolean	fl_keyboard_manager_handle_event_finish (FlKeyboardManager *self, GAsyncResult *result, FlKeyEvent **redispatched_event, GError **error)
void	fl_keyboard_manager_sync_modifier_if_needed (FlKeyboardManager *self, guint state, double event_time)
GHashTable *	fl_keyboard_manager_get_pressed_state (FlKeyboardManager *self)
void	fl_keyboard_manager_set_lookup_key_handler (FlKeyboardManager *self, FlKeyboardManagerLookupKeyHandler lookup_key_handler, gpointer user_data)

Macro Definition Documentation

DEBUG_PRINT_LAYOUT

#define DEBUG_PRINT_LAYOUT

Definition at line 19 of file fl_keyboard_manager.cc.

Function Documentation

complete_handle_event()

static void complete_handle_event ( FlKeyboardManager *  self, GTask *  task  )

static

Definition at line 147 of file fl_keyboard_manager.cc.

                                                                        {
  HandleEventData* data =
      static_cast<HandleEventData*>(g_task_get_task_data(task));
 
  // Waiting for responses.
  if (!data->embedder_responded || !data->channel_responded) {
    return;
  }
 
  data->redispatch = !data->handled;
  g_task_return_boolean(task, TRUE);
}

References HandleEventData::channel_responded, HandleEventData::embedder_responded, HandleEventData::handled, HandleEventData::redispatch, and TRUE.

Referenced by responder_handle_channel_event_cb(), and responder_handle_embedder_event_cb().

convert_key_to_char()

static uint16_t convert_key_to_char ( FlKeyboardManager *  self, guint  keycode, gint  group, gint  level  )

static

Definition at line 212 of file fl_keyboard_manager.cc.

                                                {
  GdkKeymapKey key = {keycode, group, level};
  constexpr int kBmpMax = 0xD7FF;
  guint origin;
  if (self->lookup_key_handler != nullptr) {
    origin = self->lookup_key_handler(&key, self->lookup_key_handler_user_data);
  } else {
    origin = gdk_keymap_lookup_key(self->keymap, &key);
  }
  return origin < kBmpMax ? origin : 0xFFFF;
}

Referenced by guarantee_layout().

event_is_redispatched()

static gboolean event_is_redispatched ( FlKeyboardManager *  self, FlKeyEvent *  event  )

static

Definition at line 123 of file fl_keyboard_manager.cc.

                                                         {
  guint32 time = fl_key_event_get_time(event);
  gboolean is_press = !!fl_key_event_get_is_press(event);
  guint16 keycode = fl_key_event_get_keycode(event);
  for (guint i = 0; i < self->redispatched_key_events->len; i++) {
    FlKeyEvent* e =
        FL_KEY_EVENT(g_ptr_array_index(self->redispatched_key_events, i));
    if (fl_key_event_get_time(e) == time &&
        !!fl_key_event_get_is_press(e) == is_press &&
        fl_key_event_get_keycode(e) == keycode) {
      g_ptr_array_remove_index(self->redispatched_key_events, i);
      return TRUE;
    }
  }
 
  return FALSE;
}

References fl_key_event_get_is_press(), fl_key_event_get_keycode(), fl_key_event_get_time(), i, and TRUE.

Referenced by fl_keyboard_manager_handle_event().

fl_keyboard_manager_add_redispatched_event()

void fl_keyboard_manager_add_redispatched_event	(	FlKeyboardManager *	manager,
		FlKeyEvent *	event
	)

fl_keyboard_manager_add_redispatched_event: @manager: an #FlKeyboardManager. @event: an event that will be handled by the manager in the future.

Add an event that will be redispatched and handled by the manager in the future. When that event is received it will be ignored.

Definition at line 367 of file fl_keyboard_manager.cc.

                                                                   {
  g_return_if_fail(FL_IS_KEYBOARD_MANAGER(self));
 
  g_ptr_array_add(self->redispatched_key_events, g_object_ref(event));
}

fl_keyboard_manager_class_init()

static void fl_keyboard_manager_class_init ( FlKeyboardManagerClass *  klass )

static

Definition at line 330 of file fl_keyboard_manager.cc.

                                                                          {
  G_OBJECT_CLASS(klass)->dispose = fl_keyboard_manager_dispose;
}

References fl_keyboard_manager_dispose().

fl_keyboard_manager_dispose()

static void fl_keyboard_manager_dispose ( GObject *  object )

static

Definition at line 309 of file fl_keyboard_manager.cc.

                                                         {
  FlKeyboardManager* self = FL_KEYBOARD_MANAGER(object);
 
  g_cancellable_cancel(self->cancellable);
 
  self->keycode_to_goals.reset();
  self->logical_to_mandatory_goals.reset();
 
  g_clear_pointer(&self->redispatched_key_events, g_ptr_array_unref);
  g_clear_object(&self->key_embedder_responder);
  g_clear_object(&self->key_channel_responder);
  g_clear_object(&self->derived_layout);
  if (self->keymap_keys_changed_cb_id != 0) {
    g_signal_handler_disconnect(self->keymap, self->keymap_keys_changed_cb_id);
    self->keymap_keys_changed_cb_id = 0;
  }
  g_clear_object(&self->cancellable);
 
  G_OBJECT_CLASS(fl_keyboard_manager_parent_class)->dispose(object);
}

Referenced by fl_keyboard_manager_class_init().

fl_keyboard_manager_get_pressed_state()

GHashTable* fl_keyboard_manager_get_pressed_state

(

FlKeyboardManager *

manager

)

fl_keyboard_manager_get_pressed_state: @manager: the #FlKeyboardManager self.

Returns the keyboard pressed state. The hash table contains one entry per pressed keys, mapping from the logical key to the physical key.*

Definition at line 435 of file fl_keyboard_manager.cc.

                                                                           {
  g_return_val_if_fail(FL_IS_KEYBOARD_MANAGER(self), nullptr);
  return fl_key_embedder_responder_get_pressed_state(
      self->key_embedder_responder);
}

References fl_key_embedder_responder_get_pressed_state().

Referenced by get_keyboard_state().

fl_keyboard_manager_handle_event()

void fl_keyboard_manager_handle_event	(	FlKeyboardManager *	manager,
		FlKeyEvent *	event,
		GCancellable *	cancellable,
		GAsyncReadyCallback	callback,
		gpointer	user_data
	)

fl_keyboard_manager_handle_event: @manager: an #FlKeyboardManager. @event: the event to be dispatched. It is usually a wrap of a GdkEventKey. This event will be managed and released by #FlKeyboardManager. @cancellable: (allow-none): a #GCancellable or NULL. @callback: (scope async): a #GAsyncReadyCallback to call when the view is added. @user_data: (closure): user data to pass to @callback.

Make the manager process a system key event. This might eventually send messages to the framework, trigger text input effects, or redispatch the event back to the system.

Definition at line 374 of file fl_keyboard_manager.cc.

                                                          {
  g_return_if_fail(FL_IS_KEYBOARD_MANAGER(self));
  g_return_if_fail(event != nullptr);
 
  g_autoptr(GTask) task = g_task_new(self, cancellable, callback, user_data);
 
  guarantee_layout(self, event);
 
  g_task_set_task_data(
      task, handle_event_data_new(event),
      reinterpret_cast<GDestroyNotify>(handle_event_data_free));
 
  if (event_is_redispatched(self, event)) {
    HandleEventData* data =
        static_cast<HandleEventData*>(g_task_get_task_data(task));
    data->handled = TRUE;
    g_task_return_boolean(task, TRUE);
    return;
  }
 
  uint64_t specified_logical_key = fl_keyboard_layout_get_logical_key(
      self->derived_layout, fl_key_event_get_group(event),
      fl_key_event_get_keycode(event));
  fl_key_embedder_responder_handle_event(
      self->key_embedder_responder, event, specified_logical_key,
      self->cancellable, responder_handle_embedder_event_cb,
      g_object_ref(task));
  fl_key_channel_responder_handle_event(
      self->key_channel_responder, event, specified_logical_key,
      self->cancellable, responder_handle_channel_event_cb, g_object_ref(task));
}

References event_is_redispatched(), fl_key_channel_responder_handle_event(), fl_key_embedder_responder_handle_event(), fl_key_event_get_group(), fl_key_event_get_keycode(), fl_keyboard_layout_get_logical_key(), guarantee_layout(), handle_event_data_free(), handle_event_data_new(), HandleEventData::handled, responder_handle_channel_event_cb(), responder_handle_embedder_event_cb(), TRUE, and user_data.

Referenced by handle_key_event(), and TEST().

fl_keyboard_manager_handle_event_finish()

gboolean fl_keyboard_manager_handle_event_finish	(	FlKeyboardManager *	manager,
		GAsyncResult *	result,
		FlKeyEvent **	redispatched_event,
		GError **	error
	)

fl_keyboard_manager_handle_event_finish: @manager: an #FlKeyboardManager.

Returns

: a #GAsyncResult. @redispatched_event: FIXME @error: (allow-none): #GError location to store the error occurring, or NULL to ignore.

Completes request started with fl_keyboard_manager_handle_event().

Returns: TRUE on success.

Definition at line 410 of file fl_keyboard_manager.cc.

                    {
  g_return_val_if_fail(FL_IS_KEYBOARD_MANAGER(self), FALSE);
  g_return_val_if_fail(g_task_is_valid(result, self), FALSE);
 
  HandleEventData* data =
      static_cast<HandleEventData*>(g_task_get_task_data(G_TASK(result)));
  if (redispatched_event != nullptr && data->redispatch) {
    *redispatched_event = FL_KEY_EVENT(g_object_ref(data->event));
  }
 
  return g_task_propagate_boolean(G_TASK(result), error);
}

References error, HandleEventData::event, and HandleEventData::redispatch.

Referenced by TEST().

fl_keyboard_manager_init()

static void fl_keyboard_manager_init ( FlKeyboardManager *  self )

static

Definition at line 334 of file fl_keyboard_manager.cc.

                                                              {
  self->redispatched_key_events =
      g_ptr_array_new_with_free_func(g_object_unref);
  self->derived_layout = fl_keyboard_layout_new();
 
  self->keycode_to_goals =
      std::make_unique<std::map<uint16_t, const LayoutGoal*>>();
  self->logical_to_mandatory_goals =
      std::make_unique<std::map<uint64_t, const LayoutGoal*>>();
  for (const LayoutGoal& goal : layout_goals) {
    (*self->keycode_to_goals)[goal.keycode] = &goal;
    if (goal.mandatory) {
      (*self->logical_to_mandatory_goals)[goal.logical_key] = &goal;
    }
  }
 
  self->keymap = gdk_keymap_get_for_display(gdk_display_get_default());
  self->keymap_keys_changed_cb_id = g_signal_connect_swapped(
      self->keymap, "keys-changed", G_CALLBACK(keymap_keys_changed_cb), self);
  self->cancellable = g_cancellable_new();
}

References fl_keyboard_layout_new(), if(), keymap_keys_changed_cb(), and layout_goals.

fl_keyboard_manager_new()

FlKeyboardManager* fl_keyboard_manager_new

(

FlEngine *

engine

)

FlKeyboardManager:

Processes keyboard events and cooperate with TextInputManager.

A keyboard event goes through a few sections, each can choose to handle the event, and only unhandled events can move to the next section:

• Keyboard: Dispatch to the embedder responder and the channel responder simultaneously. After both responders have responded (asynchronously), the event is considered handled if either responder handles it.
• Text input: Events are sent to IM filter (usually owned by TextInputManager) and are handled synchronously.
• Redispatching: Events are inserted back to the system for redispatching. fl_keyboard_manager_new: @engine: an #FlEngine.

Create a new #FlKeyboardManager.

Returns: a new #FlKeyboardManager.

Definition at line 356 of file fl_keyboard_manager.cc.

                                                             {
  FlKeyboardManager* self = FL_KEYBOARD_MANAGER(
      g_object_new(fl_keyboard_manager_get_type(), nullptr));
 
  self->key_embedder_responder = fl_key_embedder_responder_new(engine);
  self->key_channel_responder =
      fl_key_channel_responder_new(fl_engine_get_binary_messenger(engine));
 
  return self;
}

References fl_engine_get_binary_messenger(), fl_key_channel_responder_new(), and fl_key_embedder_responder_new().

Referenced by fl_engine_new_full(), setup_keyboard(), and TEST().

fl_keyboard_manager_set_lookup_key_handler()

void fl_keyboard_manager_set_lookup_key_handler	(	FlKeyboardManager *	manager,
		FlKeyboardManagerLookupKeyHandler	lookup_key_handler,
		gpointer	user_data
	)

fl_keyboard_manager_set_lookup_key_handler: @manager: the #FlKeyboardManager self.

Set the handler for key lookup, for testing purposes only.

Definition at line 441 of file fl_keyboard_manager.cc.

                        {
  g_return_if_fail(FL_IS_KEYBOARD_MANAGER(self));
  self->lookup_key_handler = lookup_key_handler;
  self->lookup_key_handler_user_data = user_data;
}

References user_data.

fl_keyboard_manager_sync_modifier_if_needed()

void fl_keyboard_manager_sync_modifier_if_needed	(	FlKeyboardManager *	manager,
		guint	state,
		double	event_time
	)

fl_keyboard_manager_sync_modifier_if_needed: @manager: the #FlKeyboardManager self. @state: the state of the modifiers mask. @event_time: the time attribute of the incoming GDK event.

If needed, synthesize modifier keys up and down event by comparing their current pressing states with the given modifiers mask.

Definition at line 427 of file fl_keyboard_manager.cc.

                                                                    {
  g_return_if_fail(FL_IS_KEYBOARD_MANAGER(self));
  fl_key_embedder_responder_sync_modifiers_if_needed(
      self->key_embedder_responder, state, event_time);
}

References fl_key_embedder_responder_sync_modifiers_if_needed(), and state.

Referenced by sync_modifier_if_needed().

G_DEFINE_TYPE()

G_DEFINE_TYPE	(	FlKeyboardManager	,
		fl_keyboard_manager	,
		G_TYPE_OBJECT
	)

guarantee_layout()

static void guarantee_layout ( FlKeyboardManager *  self, FlKeyEvent *  event  )

static

Definition at line 229 of file fl_keyboard_manager.cc.

                                                                         {
  guint8 group = fl_key_event_get_group(event);
  if (fl_keyboard_layout_has_group(self->derived_layout, group)) {
    return;
  }
  if (self->keycode_to_goals->find(fl_key_event_get_keycode(event)) ==
      self->keycode_to_goals->end()) {
    return;
  }
 
  // Clone all mandatory goals. Each goal is removed from this cloned map when
  // fulfilled, and the remaining ones will be assigned to a default position.
  std::map<uint64_t, const LayoutGoal*> remaining_mandatory_goals =
      *self->logical_to_mandatory_goals;
 
#ifdef DEBUG_PRINT_LAYOUT
  std::string debug_layout_data;
  for (uint16_t keycode = 0; keycode < 128; keycode += 1) {
    std::vector<uint16_t> this_key_clues = {
        convert_key_to_char(self, keycode, group, 0),
        convert_key_to_char(self, keycode, group, 1),  // Shift
    };
    debug_format_layout_data(debug_layout_data, keycode, this_key_clues[0],
                             this_key_clues[1]);
  }
#endif
 
  // It's important to only traverse layout goals instead of all keycodes.
  // Some key codes outside of the standard keyboard also gives alpha-numeric
  // letters, and will therefore take over mandatory goals from standard
  // keyboard keys if they come first. Example: French keyboard digit 1.
  for (const LayoutGoal& keycode_goal : layout_goals) {
    uint16_t keycode = keycode_goal.keycode;
    std::vector<uint16_t> this_key_clues = {
        convert_key_to_char(self, keycode, group, 0),
        convert_key_to_char(self, keycode, group, 1),  // Shift
    };
 
    // The logical key should be the first available clue from below:
    //
    //  - Mandatory goal, if it matches any clue. This ensures that all alnum
    //    keys can be found somewhere.
    //  - US layout, if neither clue of the key is EASCII. This ensures that
    //    there are no non-latin logical keys.
    //  - A value derived on the fly from keycode & keyval.
    for (uint16_t clue : this_key_clues) {
      auto matching_goal = remaining_mandatory_goals.find(clue);
      if (matching_goal != remaining_mandatory_goals.end()) {
        // Found a key that produces a mandatory char. Use it.
        g_return_if_fail(fl_keyboard_layout_get_logical_key(
                             self->derived_layout, group, keycode) == 0);
        fl_keyboard_layout_set_logical_key(self->derived_layout, group, keycode,
                                           clue);
        remaining_mandatory_goals.erase(matching_goal);
        break;
      }
    }
    bool has_any_eascii =
        is_eascii(this_key_clues[0]) || is_eascii(this_key_clues[1]);
    // See if any produced char meets the requirement as a logical key.
    if (fl_keyboard_layout_get_logical_key(self->derived_layout, group,
                                           keycode) == 0 &&
        !has_any_eascii) {
      auto found_us_layout = self->keycode_to_goals->find(keycode);
      if (found_us_layout != self->keycode_to_goals->end()) {
        fl_keyboard_layout_set_logical_key(
            self->derived_layout, group, keycode,
            found_us_layout->second->logical_key);
      }
    }
  }
 
  // Ensure all mandatory goals are assigned.
  for (const auto mandatory_goal_iter : remaining_mandatory_goals) {
    const LayoutGoal* goal = mandatory_goal_iter.second;
    fl_keyboard_layout_set_logical_key(self->derived_layout, group,
                                       goal->keycode, goal->logical_key);
  }
}

References convert_key_to_char(), fl_key_event_get_group(), fl_key_event_get_keycode(), fl_keyboard_layout_get_logical_key(), fl_keyboard_layout_has_group(), fl_keyboard_layout_set_logical_key(), LayoutGoal::keycode, layout_goals, and LayoutGoal::logical_key.

Referenced by fl_keyboard_manager_handle_event().

handle_event_data_free()

static void handle_event_data_free ( HandleEventData *  data )

static

Definition at line 78 of file fl_keyboard_manager.cc.

                                                          {
  g_object_unref(data->event);
  g_free(data);
}

References HandleEventData::event.

Referenced by fl_keyboard_manager_handle_event().

handle_event_data_new()

static HandleEventData* handle_event_data_new ( FlKeyEvent *  event )

static

Definition at line 71 of file fl_keyboard_manager.cc.

                                                                 {
  HandleEventData* data =
      static_cast<HandleEventData*>(g_new0(HandleEventData, 1));
  data->event = FL_KEY_EVENT(g_object_ref(event));
  return data;
}

References HandleEventData::event.

Referenced by fl_keyboard_manager_handle_event().

keymap_keys_changed_cb()

static void keymap_keys_changed_cb ( FlKeyboardManager *  self )

static

Definition at line 142 of file fl_keyboard_manager.cc.

                                                            {
  g_clear_object(&self->derived_layout);
  self->derived_layout = fl_keyboard_layout_new();
}

References fl_keyboard_layout_new().

Referenced by fl_keyboard_manager_init().

responder_handle_channel_event_cb()

static void responder_handle_channel_event_cb ( GObject *  object, GAsyncResult *  result, gpointer  user_data  )

static

Definition at line 186 of file fl_keyboard_manager.cc.

                                                                  {
  g_autoptr(GTask) task = G_TASK(user_data);
  FlKeyboardManager* self = FL_KEYBOARD_MANAGER(g_task_get_source_object(task));
 
  HandleEventData* data =
      static_cast<HandleEventData*>(g_task_get_task_data(G_TASK(task)));
  data->channel_responded = TRUE;
 
  g_autoptr(GError) error = nullptr;
  gboolean handled;
  if (!fl_key_channel_responder_handle_event_finish(
          FL_KEY_CHANNEL_RESPONDER(object), result, &handled, &error)) {
    if (!g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED)) {
      g_warning("Failed to handle key event in platform: %s", error->message);
    }
    handled = FALSE;
  }
  if (handled) {
    data->handled = TRUE;
  }
 
  complete_handle_event(self, task);
}

References HandleEventData::channel_responded, complete_handle_event(), error, fl_key_channel_responder_handle_event_finish(), HandleEventData::handled, TRUE, and user_data.

Referenced by fl_keyboard_manager_handle_event().

responder_handle_embedder_event_cb()

static void responder_handle_embedder_event_cb ( GObject *  object, GAsyncResult *  result, gpointer  user_data  )

static

Definition at line 160 of file fl_keyboard_manager.cc.

                                                                   {
  g_autoptr(GTask) task = G_TASK(user_data);
  FlKeyboardManager* self = FL_KEYBOARD_MANAGER(g_task_get_source_object(task));
 
  HandleEventData* data =
      static_cast<HandleEventData*>(g_task_get_task_data(G_TASK(task)));
  data->embedder_responded = TRUE;
 
  g_autoptr(GError) error = nullptr;
  gboolean handled;
  if (!fl_key_embedder_responder_handle_event_finish(
          FL_KEY_EMBEDDER_RESPONDER(object), result, &handled, &error)) {
    if (!g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED)) {
      g_warning("Failed to handle key event in embedder: %s", error->message);
    }
    handled = FALSE;
  }
  if (handled) {
    data->handled = TRUE;
  }
 
  complete_handle_event(self, task);
}

References complete_handle_event(), HandleEventData::embedder_responded, error, fl_key_embedder_responder_handle_event_finish(), HandleEventData::handled, TRUE, and user_data.

Referenced by fl_keyboard_manager_handle_event().