fl_keyboard_handler.cc File Reference

#include "flutter/shell/platform/linux/fl_keyboard_handler.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_pending_event.h"
#include "flutter/shell/platform/linux/key_mapping.h"
#include "flutter/shell/platform/linux/public/flutter_linux/fl_method_channel.h"
#include "flutter/shell/platform/linux/public/flutter_linux/fl_standard_method_codec.h"

Go to the source code of this file.

Classes
struct	_FlKeyboardHandlerUserData
struct	_FlKeyboardHandler

Macros
#define	DEBUG_PRINT_LAYOUT
#define	FL_TYPE_KEYBOARD_HANDLER_USER_DATA   fl_keyboard_handler_user_data_get_type()

Functions
	G_DECLARE_FINAL_TYPE (FlKeyboardHandlerUserData, fl_keyboard_handler_user_data, FL, KEYBOARD_HANDLER_USER_DATA, GObject)
static uint64_t	get_logical_key_from_layout (FlKeyEvent *event, const DerivedLayout &layout)
	G_DEFINE_TYPE (FlKeyboardHandlerUserData, fl_keyboard_handler_user_data, G_TYPE_OBJECT) static void fl_keyboard_handler_user_data_dispose(GObject *object)
static void	fl_keyboard_handler_user_data_class_init (FlKeyboardHandlerUserDataClass *klass)
static void	fl_keyboard_handler_user_data_init (FlKeyboardHandlerUserData *self)
static FlKeyboardHandlerUserData *	fl_keyboard_handler_user_data_new (FlKeyboardHandler *handler, uint64_t sequence_id)
	G_DEFINE_TYPE (FlKeyboardHandler, fl_keyboard_handler, G_TYPE_OBJECT)
static gboolean	g_ptr_array_find_with_equal_func1 (GPtrArray *haystack, gconstpointer needle, GEqualFunc equal_func, guint *index_)
static gboolean	compare_pending_by_sequence_id (gconstpointer a, gconstpointer b)
static gboolean	compare_pending_by_hash (gconstpointer a, gconstpointer b)
static bool	fl_keyboard_handler_remove_redispatched (FlKeyboardHandler *self, uint64_t hash)
static void	responder_handle_event_callback (bool handled, gpointer user_data_ptr)
static uint16_t	convert_key_to_char (FlKeyboardViewDelegate *view_delegate, guint keycode, gint group, gint level)
static void	guarantee_layout (FlKeyboardHandler *self, FlKeyEvent *event)
static FlMethodResponse *	get_keyboard_state (FlKeyboardHandler *self)
static void	method_call_handler (FlMethodChannel *channel, FlMethodCall *method_call, gpointer user_data)
static void	dispatch_to_responder (gpointer responder_data, gpointer foreach_data_ptr)
static void	fl_keyboard_handler_dispose (GObject *object)
static void	fl_keyboard_handler_class_init (FlKeyboardHandlerClass *klass)
static void	fl_keyboard_handler_init (FlKeyboardHandler *self)
FlKeyboardHandler *	fl_keyboard_handler_new (FlBinaryMessenger *messenger, FlKeyboardViewDelegate *view_delegate)
gboolean	fl_keyboard_handler_handle_event (FlKeyboardHandler *self, FlKeyEvent *event)
gboolean	fl_keyboard_handler_is_state_clear (FlKeyboardHandler *self)
void	fl_keyboard_handler_sync_modifier_if_needed (FlKeyboardHandler *self, guint state, double event_time)
GHashTable *	fl_keyboard_handler_get_pressed_state (FlKeyboardHandler *self)

Variables
static constexpr char	kChannelName [] = "flutter/keyboard"
static constexpr char	kGetKeyboardStateMethod [] = "getKeyboardState"

Macro Definition Documentation

DEBUG_PRINT_LAYOUT

#define DEBUG_PRINT_LAYOUT

Definition at line 21 of file fl_keyboard_handler.cc.

FL_TYPE_KEYBOARD_HANDLER_USER_DATA

#define FL_TYPE_KEYBOARD_HANDLER_USER_DATA   fl_keyboard_handler_user_data_get_type()

Definition at line 28 of file fl_keyboard_handler.cc.

Function Documentation

compare_pending_by_hash()

static gboolean compare_pending_by_hash ( gconstpointer  a, gconstpointer  b  )

static

Definition at line 244 of file fl_keyboard_handler.cc.

                                                                          {
  FlKeyboardPendingEvent* pending =
      FL_KEYBOARD_PENDING_EVENT(const_cast<gpointer>(a));
  uint64_t hash = *reinterpret_cast<const uint64_t*>(b);
  return fl_keyboard_pending_event_get_hash(pending) == hash;
}

References fl_keyboard_pending_event_get_hash().

Referenced by fl_keyboard_handler_remove_redispatched().

compare_pending_by_sequence_id()

static gboolean compare_pending_by_sequence_id ( gconstpointer  a, gconstpointer  b  )

static

Definition at line 235 of file fl_keyboard_handler.cc.

                                                                {
  FlKeyboardPendingEvent* pending =
      FL_KEYBOARD_PENDING_EVENT(const_cast<gpointer>(a));
  uint64_t sequence_id = *reinterpret_cast<const uint64_t*>(b);
  return fl_keyboard_pending_event_get_sequence_id(pending) == sequence_id;
}

References fl_keyboard_pending_event_get_sequence_id().

Referenced by responder_handle_event_callback().

convert_key_to_char()

static uint16_t convert_key_to_char ( FlKeyboardViewDelegate *  view_delegate, guint  keycode, gint  group, gint  level  )

static

Definition at line 309 of file fl_keyboard_handler.cc.

                                                {
  GdkKeymapKey key = {keycode, group, level};
  constexpr int kBmpMax = 0xD7FF;
  guint origin = fl_keyboard_view_delegate_lookup_key(view_delegate, &key);
  return origin < kBmpMax ? origin : 0xFFFF;
}

References fl_keyboard_view_delegate_lookup_key().

Referenced by guarantee_layout().

dispatch_to_responder()

static void dispatch_to_responder ( gpointer  responder_data, gpointer  foreach_data_ptr  )

static

Definition at line 439 of file fl_keyboard_handler.cc.

                                                             {
  DispatchToResponderLoopContext* context =
      reinterpret_cast<DispatchToResponderLoopContext*>(foreach_data_ptr);
  FlKeyResponder* responder = FL_KEY_RESPONDER(responder_data);
  fl_key_responder_handle_event(
      responder, context->event, responder_handle_event_callback,
      context->user_data, context->specified_logical_key);
}

References fl_key_responder_handle_event(), and responder_handle_event_callback().

Referenced by fl_keyboard_handler_handle_event().

fl_keyboard_handler_class_init()

static void fl_keyboard_handler_class_init ( FlKeyboardHandlerClass *  klass )

static

Definition at line 473 of file fl_keyboard_handler.cc.

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

References fl_keyboard_handler_dispose().

fl_keyboard_handler_dispose()

static void fl_keyboard_handler_dispose ( GObject *  object )

static

Definition at line 449 of file fl_keyboard_handler.cc.

                                                         {
  FlKeyboardHandler* self = FL_KEYBOARD_HANDLER(object);
 
  if (self->view_delegate != nullptr) {
    fl_keyboard_view_delegate_subscribe_to_layout_change(self->view_delegate,
                                                         nullptr);
    g_object_remove_weak_pointer(
        G_OBJECT(self->view_delegate),
        reinterpret_cast<gpointer*>(&(self->view_delegate)));
    self->view_delegate = nullptr;
  }
 
  self->derived_layout.reset();
  self->keycode_to_goals.reset();
  self->logical_to_mandatory_goals.reset();
 
  g_ptr_array_free(self->responder_list, TRUE);
  g_ptr_array_set_free_func(self->pending_responds, g_object_unref);
  g_ptr_array_free(self->pending_responds, TRUE);
  g_ptr_array_free(self->pending_redispatches, TRUE);
 
  G_OBJECT_CLASS(fl_keyboard_handler_parent_class)->dispose(object);
}

References fl_keyboard_view_delegate_subscribe_to_layout_change(), and TRUE.

Referenced by fl_keyboard_handler_class_init().

fl_keyboard_handler_get_pressed_state()

GHashTable* fl_keyboard_handler_get_pressed_state

(

FlKeyboardHandler *

handler

)

fl_keyboard_handler_get_pressed_state: @handler: the #FlKeyboardHandler 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 590 of file fl_keyboard_handler.cc.

                                                                           {
  g_return_val_if_fail(FL_IS_KEYBOARD_HANDLER(self), nullptr);
 
  // The embedder responder is the first element in
  // FlKeyboardHandler.responder_list.
  FlKeyEmbedderResponder* responder =
      FL_KEY_EMBEDDER_RESPONDER(g_ptr_array_index(self->responder_list, 0));
  return fl_key_embedder_responder_get_pressed_state(responder);
}

References fl_key_embedder_responder_get_pressed_state().

Referenced by fl_view_get_keyboard_state().

fl_keyboard_handler_handle_event()

gboolean fl_keyboard_handler_handle_event	(	FlKeyboardHandler *	handler,
		FlKeyEvent *	event
	)

fl_keyboard_handler_handle_event: @handler: the #FlKeyboardHandler self. @event: the event to be dispatched. It is usually a wrap of a GdkEventKey. This event will be managed and released by #FlKeyboardHandler.

Make the handler 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 541 of file fl_keyboard_handler.cc.

                                                             {
  g_return_val_if_fail(FL_IS_KEYBOARD_HANDLER(self), FALSE);
  g_return_val_if_fail(event != nullptr, FALSE);
  g_return_val_if_fail(self->view_delegate != nullptr, FALSE);
 
  guarantee_layout(self, event);
 
  uint64_t incoming_hash = fl_key_event_hash(event);
  if (fl_keyboard_handler_remove_redispatched(self, incoming_hash)) {
    return FALSE;
  }
 
  FlKeyboardPendingEvent* pending = fl_keyboard_pending_event_new(
      event, ++self->last_sequence_id, self->responder_list->len);
 
  g_ptr_array_add(self->pending_responds, pending);
  FlKeyboardHandlerUserData* user_data = fl_keyboard_handler_user_data_new(
      self, fl_keyboard_pending_event_get_sequence_id(pending));
  DispatchToResponderLoopContext data{
      .event = event,
      .specified_logical_key =
          get_logical_key_from_layout(event, *self->derived_layout),
      .user_data = user_data,
  };
  g_ptr_array_foreach(self->responder_list, dispatch_to_responder, &data);
 
  return TRUE;
}

References dispatch_to_responder(), event, fl_key_event_hash(), fl_keyboard_handler_remove_redispatched(), fl_keyboard_handler_user_data_new(), fl_keyboard_pending_event_get_sequence_id(), fl_keyboard_pending_event_new(), get_logical_key_from_layout(), guarantee_layout(), TRUE, and user_data.

Referenced by fl_view_key_press_event(), and fl_view_key_release_event().

fl_keyboard_handler_init()

static void fl_keyboard_handler_init ( FlKeyboardHandler *  self )

static

Definition at line 477 of file fl_keyboard_handler.cc.

                                                              {
  self->derived_layout = std::make_unique<DerivedLayout>();
 
  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->responder_list = g_ptr_array_new_with_free_func(g_object_unref);
 
  self->pending_responds = g_ptr_array_new();
  self->pending_redispatches = g_ptr_array_new_with_free_func(g_object_unref);
 
  self->last_sequence_id = 1;
}

References if(), and layout_goals.

fl_keyboard_handler_is_state_clear()

gboolean fl_keyboard_handler_is_state_clear

(

FlKeyboardHandler *

handler

)

fl_keyboard_handler_is_state_clear: @handler: the #FlKeyboardHandler self.

A debug-only method that queries whether the handler's various states are cleared, i.e. no pending events for redispatching or for responding.

Returns: true if the handler's various states are cleared.

Definition at line 571 of file fl_keyboard_handler.cc.

                                                                     {
  g_return_val_if_fail(FL_IS_KEYBOARD_HANDLER(self), FALSE);
  return self->pending_responds->len == 0 &&
         self->pending_redispatches->len == 0;
}

fl_keyboard_handler_new()

FlKeyboardHandler* fl_keyboard_handler_new	(	FlBinaryMessenger *	messenger,
		FlKeyboardViewDelegate *	view_delegate
	)

FlKeyboardHandler:

Processes keyboard events and cooperate with TextInputHandler.

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 TextInputHandler) and are handled synchronously.
• Redispatching: Events are inserted back to the system for redispatching. fl_keyboard_handler_new: @view_delegate: An interface that the handler requires to communicate with the platform. Usually implemented by FlView.

Create a new #FlKeyboardHandler.

Returns: a new #FlKeyboardHandler.

Definition at line 499 of file fl_keyboard_handler.cc.

                                           {
  g_return_val_if_fail(FL_IS_KEYBOARD_VIEW_DELEGATE(view_delegate), nullptr);
 
  FlKeyboardHandler* self = FL_KEYBOARD_HANDLER(
      g_object_new(fl_keyboard_handler_get_type(), nullptr));
 
  self->view_delegate = view_delegate;
  g_object_add_weak_pointer(
      G_OBJECT(view_delegate),
      reinterpret_cast<gpointer*>(&(self->view_delegate)));
 
  // The embedder responder must be added before the channel responder.
  g_ptr_array_add(
      self->responder_list,
      FL_KEY_RESPONDER(fl_key_embedder_responder_new(
          [](const FlutterKeyEvent* event, FlutterKeyEventCallback callback,
             void* callback_user_data, void* send_key_event_user_data) {
            FlKeyboardHandler* self =
                FL_KEYBOARD_HANDLER(send_key_event_user_data);
            g_return_if_fail(self->view_delegate != nullptr);
            fl_keyboard_view_delegate_send_key_event(
                self->view_delegate, event, callback, callback_user_data);
          },
          self)));
  g_ptr_array_add(self->responder_list,
                  FL_KEY_RESPONDER(fl_key_channel_responder_new(
                      fl_keyboard_view_delegate_get_messenger(view_delegate))));
 
  fl_keyboard_view_delegate_subscribe_to_layout_change(
      self->view_delegate, [self]() { self->derived_layout->clear(); });
 
  // Setup the flutter/keyboard channel.
  g_autoptr(FlStandardMethodCodec) codec = fl_standard_method_codec_new();
  self->channel =
      fl_method_channel_new(messenger, kChannelName, FL_METHOD_CODEC(codec));
  fl_method_channel_set_method_call_handler(self->channel, method_call_handler,
                                            self, nullptr);
  return self;
}

References callback, event, fl_key_channel_responder_new(), fl_key_embedder_responder_new(), fl_keyboard_view_delegate_get_messenger(), fl_keyboard_view_delegate_send_key_event(), fl_keyboard_view_delegate_subscribe_to_layout_change(), fl_method_channel_new(), fl_method_channel_set_method_call_handler(), fl_standard_method_codec_new(), kChannelName, and method_call_handler().

Referenced by init_keyboard().

fl_keyboard_handler_remove_redispatched()

static bool fl_keyboard_handler_remove_redispatched ( FlKeyboardHandler *  self, uint64_t  hash  )

static

Definition at line 255 of file fl_keyboard_handler.cc.

                                                                   {
  guint result_index;
  gboolean found = g_ptr_array_find_with_equal_func1(
      self->pending_redispatches, static_cast<const uint64_t*>(&hash),
      compare_pending_by_hash, &result_index);
  if (found) {
    // The removed object is freed due to `pending_redispatches`'s free_func.
    g_ptr_array_remove_index_fast(self->pending_redispatches, result_index);
    return TRUE;
  } else {
    return FALSE;
  }
}

References compare_pending_by_hash(), g_ptr_array_find_with_equal_func1(), and TRUE.

Referenced by fl_keyboard_handler_handle_event().

fl_keyboard_handler_sync_modifier_if_needed()

void fl_keyboard_handler_sync_modifier_if_needed	(	FlKeyboardHandler *	handler,
		guint	state,
		double	event_time
	)

fl_keyboard_handler_sync_modifier_if_needed: @handler: the #FlKeyboardHandler 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 577 of file fl_keyboard_handler.cc.

                                                                    {
  g_return_if_fail(FL_IS_KEYBOARD_HANDLER(self));
 
  // The embedder responder is the first element in
  // FlKeyboardHandler.responder_list.
  FlKeyEmbedderResponder* responder =
      FL_KEY_EMBEDDER_RESPONDER(g_ptr_array_index(self->responder_list, 0));
  fl_key_embedder_responder_sync_modifiers_if_needed(responder, state,
                                                     event_time);
}

References fl_key_embedder_responder_sync_modifiers_if_needed(), and state.

Referenced by motion_notify_event_cb(), and send_pointer_button_event().

fl_keyboard_handler_user_data_class_init()

static void fl_keyboard_handler_user_data_class_init ( FlKeyboardHandlerUserDataClass *  klass )

static

Definition at line 137 of file fl_keyboard_handler.cc.

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

fl_keyboard_handler_user_data_init()

static void fl_keyboard_handler_user_data_init ( FlKeyboardHandlerUserData *  self )

static

Definition at line 142 of file fl_keyboard_handler.cc.

                                     {}

fl_keyboard_handler_user_data_new()

static FlKeyboardHandlerUserData* fl_keyboard_handler_user_data_new ( FlKeyboardHandler *  handler, uint64_t  sequence_id  )

static

Definition at line 146 of file fl_keyboard_handler.cc.

                          {
  FlKeyboardHandlerUserData* self = FL_KEYBOARD_HANDLER_USER_DATA(
      g_object_new(fl_keyboard_handler_user_data_get_type(), nullptr));
 
  self->handler = handler;
  // Add a weak pointer so we can know if the key event responder disappeared
  // while the framework was responding.
  g_object_add_weak_pointer(G_OBJECT(handler),
                            reinterpret_cast<gpointer*>(&(self->handler)));
  self->sequence_id = sequence_id;
  return self;
}

Referenced by fl_keyboard_handler_handle_event().

G_DECLARE_FINAL_TYPE()

G_DECLARE_FINAL_TYPE	(	FlKeyboardHandlerUserData	,
		fl_keyboard_handler_user_data	,
		FL	,
		KEYBOARD_HANDLER_USER_DATA	,
		GObject
	)

G_DEFINE_TYPE() [1/2]

G_DEFINE_TYPE	(	FlKeyboardHandler	,
		fl_keyboard_handler	,
		G_TYPE_OBJECT
	)

G_DEFINE_TYPE() [2/2]

G_DEFINE_TYPE	(	FlKeyboardHandlerUserData	,
		fl_keyboard_handler_user_data	,
		G_TYPE_OBJECT
	)

Definition at line 123 of file fl_keyboard_handler.cc.

                                                                   {
  g_return_if_fail(FL_IS_KEYBOARD_HANDLER_USER_DATA(object));
  FlKeyboardHandlerUserData* self = FL_KEYBOARD_HANDLER_USER_DATA(object);
  if (self->handler != nullptr) {
    g_object_remove_weak_pointer(G_OBJECT(self->handler),
                                 reinterpret_cast<gpointer*>(&(self->handler)));
    self->handler = nullptr;
  }
}

g_ptr_array_find_with_equal_func1()

static gboolean g_ptr_array_find_with_equal_func1 ( GPtrArray *  haystack, gconstpointer  needle, GEqualFunc  equal_func, guint *  index_  )

static

Definition at line 213 of file fl_keyboard_handler.cc.

                                                                 {
  guint i;
  g_return_val_if_fail(haystack != NULL, FALSE);
  if (equal_func == NULL) {
    equal_func = g_direct_equal;
  }
  for (i = 0; i < haystack->len; i++) {
    if (equal_func(g_ptr_array_index(haystack, i), needle)) {
      if (index_ != NULL) {
        *index_ = i;
      }
      return TRUE;
    }
  }
 
  return FALSE;
}

References i, and TRUE.

Referenced by fl_keyboard_handler_remove_redispatched(), and responder_handle_event_callback().

get_keyboard_state()

static FlMethodResponse* get_keyboard_state ( FlKeyboardHandler *  self )

static

Definition at line 397 of file fl_keyboard_handler.cc.

                                                                     {
  g_autoptr(FlValue) result = fl_value_new_map();
 
  GHashTable* pressing_records =
      fl_keyboard_view_delegate_get_keyboard_state(self->view_delegate);
 
  g_hash_table_foreach(
      pressing_records,
      [](gpointer key, gpointer value, gpointer user_data) {
        int64_t physical_key = reinterpret_cast<int64_t>(key);
        int64_t logical_key = reinterpret_cast<int64_t>(value);
        FlValue* fl_value_map = reinterpret_cast<FlValue*>(user_data);
 
        fl_value_set_take(fl_value_map, fl_value_new_int(physical_key),
                          fl_value_new_int(logical_key));
      },
      result);
  return FL_METHOD_RESPONSE(fl_method_success_response_new(result));
}

References fl_keyboard_view_delegate_get_keyboard_state(), fl_method_success_response_new(), fl_value_new_int(), fl_value_new_map(), fl_value_set_take(), result, user_data, and value.

Referenced by method_call_handler().

get_logical_key_from_layout()

static uint64_t get_logical_key_from_layout ( FlKeyEvent *  event, const DerivedLayout &  layout  )

static

Definition at line 92 of file fl_keyboard_handler.cc.

                                                                         {
  guint8 group = fl_key_event_get_group(event);
  guint16 keycode = fl_key_event_get_keycode(event);
  if (keycode >= kLayoutSize) {
    return 0;
  }
 
  auto found_group_layout = layout.find(group);
  if (found_group_layout != layout.end()) {
    return found_group_layout->second[keycode];
  }
  return 0;
}

References event, fl_key_event_get_group(), and fl_key_event_get_keycode().

Referenced by fl_keyboard_handler_handle_event().

guarantee_layout()

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

static

Definition at line 321 of file fl_keyboard_handler.cc.

                                                                         {
  guint8 group = fl_key_event_get_group(event);
  if (self->derived_layout->find(group) != self->derived_layout->end()) {
    return;
  }
  if (self->keycode_to_goals->find(fl_key_event_get_keycode(event)) ==
      self->keycode_to_goals->end()) {
    return;
  }
 
  DerivedGroupLayout& layout = (*self->derived_layout)[group];
 
  // 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->view_delegate, keycode, group, 0),
        convert_key_to_char(self->view_delegate, 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->view_delegate, keycode, group, 0),
        convert_key_to_char(self->view_delegate, 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(layout[keycode] == 0);
        layout[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 (layout[keycode] == 0 && !has_any_eascii) {
      auto found_us_layout = self->keycode_to_goals->find(keycode);
      if (found_us_layout != self->keycode_to_goals->end()) {
        layout[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;
    layout[goal->keycode] = goal->logical_key;
  }
}

References convert_key_to_char(), event, fl_key_event_get_group(), fl_key_event_get_keycode(), LayoutGoal::keycode, layout_goals, and LayoutGoal::logical_key.

Referenced by fl_keyboard_handler_handle_event().

method_call_handler()

static void method_call_handler ( FlMethodChannel *  channel, FlMethodCall *  method_call, gpointer  user_data  )

static

Definition at line 418 of file fl_keyboard_handler.cc.

                                                    {
  FlKeyboardHandler* self = FL_KEYBOARD_HANDLER(user_data);
 
  const gchar* method = fl_method_call_get_name(method_call);
 
  g_autoptr(FlMethodResponse) response = nullptr;
  if (strcmp(method, kGetKeyboardStateMethod) == 0) {
    response = get_keyboard_state(self);
  } else {
    response = FL_METHOD_RESPONSE(fl_method_not_implemented_response_new());
  }
 
  g_autoptr(GError) error = nullptr;
  if (!fl_method_call_respond(method_call, response, &error)) {
    g_warning("Failed to send method call response: %s", error->message);
  }
}

References error, fl_method_call_get_name(), fl_method_call_respond(), fl_method_not_implemented_response_new(), get_keyboard_state(), kGetKeyboardStateMethod, method_call, and user_data.

Referenced by fl_keyboard_handler_new().

responder_handle_event_callback()

static void responder_handle_event_callback ( bool  handled, gpointer  user_data_ptr  )

static

Definition at line 271 of file fl_keyboard_handler.cc.

                                                                    {
  g_return_if_fail(FL_IS_KEYBOARD_HANDLER_USER_DATA(user_data_ptr));
  FlKeyboardHandlerUserData* user_data =
      FL_KEYBOARD_HANDLER_USER_DATA(user_data_ptr);
  FlKeyboardHandler* self = user_data->handler;
  g_return_if_fail(self->view_delegate != nullptr);
 
  guint result_index = -1;
  gboolean found = g_ptr_array_find_with_equal_func1(
      self->pending_responds, &user_data->sequence_id,
      compare_pending_by_sequence_id, &result_index);
  g_return_if_fail(found);
  FlKeyboardPendingEvent* pending = FL_KEYBOARD_PENDING_EVENT(
      g_ptr_array_index(self->pending_responds, result_index));
  g_return_if_fail(pending != nullptr);
  fl_keyboard_pending_event_mark_replied(pending, handled);
  // All responders have replied.
  if (fl_keyboard_pending_event_is_complete(pending)) {
    g_object_unref(user_data_ptr);
    gpointer removed =
        g_ptr_array_remove_index_fast(self->pending_responds, result_index);
    g_return_if_fail(removed == pending);
    bool should_redispatch =
        !fl_keyboard_pending_event_get_any_handled(pending) &&
        !fl_keyboard_view_delegate_text_filter_key_press(
            self->view_delegate, fl_keyboard_pending_event_get_event(pending));
    if (should_redispatch) {
      g_ptr_array_add(self->pending_redispatches, pending);
      fl_keyboard_view_delegate_redispatch_event(
          self->view_delegate,
          FL_KEY_EVENT(fl_keyboard_pending_event_get_event(pending)));
    } else {
      g_object_unref(pending);
    }
  }
}

References compare_pending_by_sequence_id(), fl_keyboard_pending_event_get_any_handled(), fl_keyboard_pending_event_get_event(), fl_keyboard_pending_event_is_complete(), fl_keyboard_pending_event_mark_replied(), fl_keyboard_view_delegate_redispatch_event(), fl_keyboard_view_delegate_text_filter_key_press(), g_ptr_array_find_with_equal_func1(), and user_data.

Referenced by dispatch_to_responder().

Variable Documentation

kChannelName

constexpr char kChannelName[] = "flutter/keyboard"

staticconstexpr

Definition at line 23 of file fl_keyboard_handler.cc.

Referenced by fl_keyboard_handler_new().

kGetKeyboardStateMethod

constexpr char kGetKeyboardStateMethod[] = "getKeyboardState"

staticconstexpr

Definition at line 24 of file fl_keyboard_handler.cc.

Referenced by method_call_handler().