Flutter Linux Embedder
fl_engine.cc File Reference

Go to the source code of this file.

Classes

struct  _FlEngine
 

Enumerations

enum  {
  SIGNAL_ON_PRE_ENGINE_RESTART ,
  SIGNAL_UPDATE_SEMANTICS ,
  LAST_SIGNAL
}
 

Functions

static void fl_engine_plugin_registry_iface_init (FlPluginRegistryInterface *iface)
 
 G_DEFINE_TYPE_WITH_CODE (FlEngine, fl_engine, G_TYPE_OBJECT, G_IMPLEMENT_INTERFACE(fl_plugin_registry_get_type(), fl_engine_plugin_registry_iface_init)) enum
 
static void parse_locale (const gchar *locale, gchar **language, gchar **territory, gchar **codeset, gchar **modifier)
 
static void view_added_cb (const FlutterAddViewResult *result)
 
static void view_removed_cb (const FlutterRemoveViewResult *result)
 
static void free_locale (FlutterLocale *locale)
 
static void setup_locales (FlEngine *self)
 
static bool compositor_create_backing_store_callback (const FlutterBackingStoreConfig *config, FlutterBackingStore *backing_store_out, void *user_data)
 
static bool compositor_collect_backing_store_callback (const FlutterBackingStore *backing_store, void *user_data)
 
static bool compositor_present_view_callback (const FlutterPresentViewInfo *info)
 
static void * fl_engine_gl_proc_resolver (void *user_data, const char *name)
 
static bool fl_engine_gl_make_current (void *user_data)
 
static bool fl_engine_gl_clear_current (void *user_data)
 
static uint32_t fl_engine_gl_get_fbo (void *user_data)
 
static bool fl_engine_gl_present (void *user_data)
 
static bool fl_engine_gl_make_resource_current (void *user_data)
 
static bool fl_engine_gl_external_texture_frame_callback (void *user_data, int64_t texture_id, size_t width, size_t height, FlutterOpenGLTexture *opengl_texture)
 
static bool fl_engine_runs_task_on_current_thread (void *user_data)
 
static void fl_engine_post_task (FlutterTask task, uint64_t target_time_nanos, void *user_data)
 
static void fl_engine_platform_message_cb (const FlutterPlatformMessage *message, void *user_data)
 
static void fl_engine_update_semantics_cb (const FlutterSemanticsUpdate2 *update, void *user_data)
 
static void setup_keyboard (FlEngine *self)
 
static void fl_engine_on_pre_engine_restart_cb (void *user_data)
 
static void fl_engine_platform_message_response_cb (const uint8_t *data, size_t data_length, void *user_data)
 
static FlPluginRegistrar * fl_engine_get_registrar_for_plugin (FlPluginRegistry *registry, const gchar *name)
 
static void fl_engine_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
 
static void fl_engine_dispose (GObject *object)
 
static void fl_engine_class_init (FlEngineClass *klass)
 
static void fl_engine_init (FlEngine *self)
 
static FlEngine * fl_engine_new_full (FlDartProject *project, FlBinaryMessenger *binary_messenger)
 
FlEngine * fl_engine_for_id (int64_t id)
 
G_MODULE_EXPORT FlEngine * fl_engine_new (FlDartProject *project)
 
FlEngine * fl_engine_new_with_binary_messenger (FlBinaryMessenger *binary_messenger)
 
G_MODULE_EXPORT FlEngine * fl_engine_new_headless (FlDartProject *project)
 
FlCompositor * fl_engine_get_compositor (FlEngine *self)
 
FlOpenGLManager * fl_engine_get_opengl_manager (FlEngine *self)
 
FlDisplayMonitor * fl_engine_get_display_monitor (FlEngine *self)
 
gboolean fl_engine_start (FlEngine *self, GError **error)
 
FlutterEngineProcTable * fl_engine_get_embedder_api (FlEngine *self)
 
void fl_engine_notify_display_update (FlEngine *self, const FlutterEngineDisplay *displays, size_t displays_length)
 
void fl_engine_set_implicit_view (FlEngine *self, FlRenderable *renderable)
 
FlutterViewId fl_engine_add_view (FlEngine *self, FlRenderable *renderable, size_t width, size_t height, double pixel_ratio, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data)
 
gboolean fl_engine_add_view_finish (FlEngine *self, GAsyncResult *result, GError **error)
 
FlRenderable * fl_engine_get_renderable (FlEngine *self, FlutterViewId view_id)
 
void fl_engine_remove_view (FlEngine *self, FlutterViewId view_id, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data)
 
gboolean fl_engine_remove_view_finish (FlEngine *self, GAsyncResult *result, GError **error)
 
void fl_engine_set_platform_message_handler (FlEngine *self, FlEnginePlatformMessageHandler handler, gpointer user_data, GDestroyNotify destroy_notify)
 
gboolean fl_engine_send_platform_message_response (FlEngine *self, const FlutterPlatformMessageResponseHandle *handle, GBytes *response, GError **error)
 
void fl_engine_send_platform_message (FlEngine *self, const gchar *channel, GBytes *message, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data)
 
GBytes * fl_engine_send_platform_message_finish (FlEngine *self, GAsyncResult *result, GError **error)
 
void fl_engine_send_window_metrics_event (FlEngine *self, FlutterEngineDisplayId display_id, FlutterViewId view_id, size_t width, size_t height, double pixel_ratio)
 
void fl_engine_send_mouse_pointer_event (FlEngine *self, FlutterViewId view_id, FlutterPointerPhase phase, size_t timestamp, double x, double y, FlutterPointerDeviceKind device_kind, double scroll_delta_x, double scroll_delta_y, int64_t buttons)
 
void fl_engine_send_touch_up_event (FlEngine *self, FlutterViewId view_id, size_t timestamp, double x, double y, int32_t device)
 
void fl_engine_send_touch_down_event (FlEngine *self, FlutterViewId view_id, size_t timestamp, double x, double y, int32_t device)
 
void fl_engine_send_touch_move_event (FlEngine *self, FlutterViewId view_id, size_t timestamp, double x, double y, int32_t device)
 
void fl_engine_send_touch_add_event (FlEngine *self, FlutterViewId view_id, size_t timestamp, double x, double y, int32_t device)
 
void fl_engine_send_touch_remove_event (FlEngine *self, FlutterViewId view_id, size_t timestamp, double x, double y, int32_t device)
 
void fl_engine_send_pointer_pan_zoom_event (FlEngine *self, FlutterViewId view_id, size_t timestamp, double x, double y, FlutterPointerPhase phase, double pan_x, double pan_y, double scale, double rotation)
 
static void send_key_event_cb (bool handled, void *user_data)
 
void fl_engine_send_key_event (FlEngine *self, const FlutterKeyEvent *event, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data)
 
gboolean fl_engine_send_key_event_finish (FlEngine *self, GAsyncResult *result, gboolean *handled, GError **error)
 
void fl_engine_dispatch_semantics_action (FlEngine *self, FlutterViewId view_id, uint64_t node_id, FlutterSemanticsAction action, GBytes *data)
 
gboolean fl_engine_mark_texture_frame_available (FlEngine *self, int64_t texture_id)
 
gboolean fl_engine_register_external_texture (FlEngine *self, int64_t texture_id)
 
gboolean fl_engine_unregister_external_texture (FlEngine *self, int64_t texture_id)
 
G_MODULE_EXPORT FlBinaryMessenger * fl_engine_get_binary_messenger (FlEngine *self)
 
FlTaskRunner * fl_engine_get_task_runner (FlEngine *self)
 
void fl_engine_execute_task (FlEngine *self, FlutterTask *task)
 
G_MODULE_EXPORT FlTextureRegistrar * fl_engine_get_texture_registrar (FlEngine *self)
 
void fl_engine_update_accessibility_features (FlEngine *self, int32_t flags)
 
void fl_engine_request_app_exit (FlEngine *self)
 
FlWindowingHandler * fl_engine_get_windowing_handler (FlEngine *self)
 
FlKeyboardManager * fl_engine_get_keyboard_manager (FlEngine *self)
 
FlTextInputHandler * fl_engine_get_text_input_handler (FlEngine *self)
 
FlMouseCursorHandler * fl_engine_get_mouse_cursor_handler (FlEngine *self)
 

Variables

static constexpr size_t kPlatformTaskRunnerIdentifier = 1
 
static constexpr int32_t kMousePointerDeviceId = 0
 
static constexpr int32_t kPointerPanZoomDeviceId = 1
 
static guint fl_engine_signals [LAST_SIGNAL]
 

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
SIGNAL_ON_PRE_ENGINE_RESTART 
SIGNAL_UPDATE_SEMANTICS 
LAST_SIGNAL 

Definition at line 114 of file fl_engine.cc.

@ LAST_SIGNAL
Definition: fl_engine.cc:114
@ SIGNAL_UPDATE_SEMANTICS
Definition: fl_engine.cc:114
@ SIGNAL_ON_PRE_ENGINE_RESTART
Definition: fl_engine.cc:114

Function Documentation

◆ compositor_collect_backing_store_callback()

static bool compositor_collect_backing_store_callback ( const FlutterBackingStore *  backing_store,
void *  user_data 
)
static

Definition at line 261 of file fl_engine.cc.

263  {
264  FlEngine* self = static_cast<FlEngine*>(user_data);
265  return fl_compositor_collect_backing_store(self->compositor, backing_store);
266 }
gboolean fl_compositor_collect_backing_store(FlCompositor *self, const FlutterBackingStore *backing_store)
G_BEGIN_DECLS G_MODULE_EXPORT FlValue gpointer user_data

References fl_compositor_collect_backing_store(), and user_data.

Referenced by fl_engine_start().

◆ compositor_create_backing_store_callback()

static bool compositor_create_backing_store_callback ( const FlutterBackingStoreConfig *  config,
FlutterBackingStore *  backing_store_out,
void *  user_data 
)
static

Definition at line 251 of file fl_engine.cc.

254  {
255  FlEngine* self = static_cast<FlEngine*>(user_data);
256  return fl_compositor_create_backing_store(self->compositor, config,
257  backing_store_out);
258 }
gboolean fl_compositor_create_backing_store(FlCompositor *self, const FlutterBackingStoreConfig *config, FlutterBackingStore *backing_store_out)

References fl_compositor_create_backing_store(), and user_data.

Referenced by fl_engine_start().

◆ compositor_present_view_callback()

static bool compositor_present_view_callback ( const FlutterPresentViewInfo *  info)
static

Definition at line 269 of file fl_engine.cc.

270  {
271  FlEngine* self = static_cast<FlEngine*>(info->user_data);
272  return fl_compositor_present_layers(self->compositor, info->view_id,
273  info->layers, info->layers_count);
274 }
gboolean fl_compositor_present_layers(FlCompositor *self, FlutterViewId view_id, const FlutterLayer **layers, size_t layers_count)

References fl_compositor_present_layers().

Referenced by fl_engine_start().

◆ fl_engine_add_view()

FlutterViewId fl_engine_add_view ( FlEngine *  engine,
FlRenderable *  renderable,
size_t  width,
size_t  height,
double  pixel_ratio,
GCancellable *  cancellable,
GAsyncReadyCallback  callback,
gpointer  user_data 
)

fl_engine_add_view: @engine: an #FlEngine. @renderable: the object that will render this view. @width: width of view in pixels. @height: height of view in pixels. @pixel_ratio: scale factor for view. @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.

Asynchronously add a new view. The returned view ID should not be used until this function completes.

Returns: the ID for the view.

Definition at line 750 of file fl_engine.cc.

757  {
758  g_return_val_if_fail(FL_IS_ENGINE(self), -1);
759 
760  g_autoptr(GTask) task = g_task_new(self, cancellable, callback, user_data);
761 
762  FlutterViewId view_id = self->next_view_id;
763  self->next_view_id++;
764 
765  GWeakRef* ref = g_new(GWeakRef, 1);
766  g_weak_ref_init(ref, G_OBJECT(renderable));
767  g_hash_table_insert(self->renderables_by_view_id, GINT_TO_POINTER(view_id),
768  ref);
769 
770  // We don't know which display this view will open on, so set to zero and this
771  // will be updated in a following FlutterWindowMetricsEvent
772  FlutterEngineDisplayId display_id = 0;
773 
774  FlutterWindowMetricsEvent metrics;
775  metrics.struct_size = sizeof(FlutterWindowMetricsEvent);
776  metrics.width = width;
777  metrics.height = height;
778  metrics.pixel_ratio = pixel_ratio;
779  metrics.display_id = display_id;
780  metrics.view_id = view_id;
781  FlutterAddViewInfo info;
782  info.struct_size = sizeof(FlutterAddViewInfo);
783  info.view_id = view_id;
784  info.view_metrics = &metrics;
785  info.user_data = g_object_ref(task);
786  info.add_view_callback = view_added_cb;
787  FlutterEngineResult result = self->embedder_api.AddView(self->engine, &info);
788  if (result != kSuccess) {
789  g_task_return_new_error(task, fl_engine_error_quark(),
790  FL_ENGINE_ERROR_FAILED, "AddView returned %d",
791  result);
792  // This would have been done in the callback, but that won't occur now.
793  g_object_unref(task);
794  }
795 
796  return view_id;
797 }
static void view_added_cb(const FlutterAddViewResult *result)
Definition: fl_engine.cc:171
GQuark fl_engine_error_quark(void) G_GNUC_CONST
@ FL_ENGINE_ERROR_FAILED
const uint8_t uint32_t uint32_t * height
const uint8_t uint32_t * width
G_BEGIN_DECLS FlutterViewId view_id

References FL_ENGINE_ERROR_FAILED, fl_engine_error_quark(), height, user_data, view_added_cb(), view_id, and width.

Referenced by fl_view_new_for_engine(), and TEST().

◆ fl_engine_add_view_finish()

gboolean fl_engine_add_view_finish ( FlEngine *  engine,
GAsyncResult *  result,
GError **  error 
)

fl_engine_add_view_finish: @engine: an #FlEngine.

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

Completes request started with fl_engine_add_view().

Returns: TRUE on success.

Definition at line 799 of file fl_engine.cc.

801  {
802  g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
803  return g_task_propagate_boolean(G_TASK(result), error);
804 }
const uint8_t uint32_t uint32_t GError ** error

References error.

Referenced by add_view_cb(), add_view_engine_error_cb(), add_view_error_cb(), and view_added_cb().

◆ fl_engine_class_init()

static void fl_engine_class_init ( FlEngineClass *  klass)
static

Definition at line 510 of file fl_engine.cc.

510  {
511  G_OBJECT_CLASS(klass)->dispose = fl_engine_dispose;
512  G_OBJECT_CLASS(klass)->set_property = fl_engine_set_property;
513 
514  g_object_class_install_property(
515  G_OBJECT_CLASS(klass), PROP_BINARY_MESSENGER,
516  g_param_spec_object(
517  "binary-messenger", "messenger", "Binary messenger",
518  fl_binary_messenger_get_type(),
519  static_cast<GParamFlags>(G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY |
520  G_PARAM_STATIC_STRINGS)));
521 
523  "on-pre-engine-restart", fl_engine_get_type(), G_SIGNAL_RUN_LAST, 0,
524  nullptr, nullptr, nullptr, G_TYPE_NONE, 0);
526  "update-semantics", fl_engine_get_type(), G_SIGNAL_RUN_LAST, 0, nullptr,
527  nullptr, nullptr, G_TYPE_NONE, 1, G_TYPE_POINTER);
528 }
static void fl_engine_dispose(GObject *object)
Definition: fl_engine.cc:468
static guint fl_engine_signals[LAST_SIGNAL]
Definition: fl_engine.cc:116
static void fl_engine_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
Definition: fl_engine.cc:452

References fl_engine_dispose(), fl_engine_set_property(), fl_engine_signals, SIGNAL_ON_PRE_ENGINE_RESTART, and SIGNAL_UPDATE_SEMANTICS.

◆ fl_engine_dispatch_semantics_action()

void fl_engine_dispatch_semantics_action ( FlEngine *  engine,
FlutterViewId  view_id,
uint64_t  node_id,
FlutterSemanticsAction  action,
GBytes *  data 
)

fl_engine_dispatch_semantics_action: @engine: an #FlEngine. @view_id: the view that the event occured on. @node_id: the semantics action identifier. @action: the action being dispatched. @data: (allow-none): data associated with the action.

Definition at line 1232 of file fl_engine.cc.

1236  {
1237  g_return_if_fail(FL_IS_ENGINE(self));
1238 
1239  if (self->engine == nullptr) {
1240  return;
1241  }
1242 
1243  const uint8_t* action_data = nullptr;
1244  size_t action_data_length = 0;
1245  if (data != nullptr) {
1246  action_data = static_cast<const uint8_t*>(
1247  g_bytes_get_data(data, &action_data_length));
1248  }
1249 
1250  FlutterSendSemanticsActionInfo info;
1251  info.struct_size = sizeof(FlutterSendSemanticsActionInfo);
1252  info.view_id = view_id;
1253  info.node_id = node_id;
1254  info.action = action;
1255  info.data = action_data;
1256  info.data_length = action_data_length;
1257  self->embedder_api.SendSemanticsAction(self->engine, &info);
1258 }

References view_id.

Referenced by fl_accessible_node_perform_action_impl(), and TEST().

◆ fl_engine_dispose()

static void fl_engine_dispose ( GObject *  object)
static

Definition at line 468 of file fl_engine.cc.

468  {
469  FlEngine* self = FL_ENGINE(object);
470 
471  if (self->engine != nullptr) {
472  self->embedder_api.Shutdown(self->engine);
473  self->engine = nullptr;
474  }
475 
476  if (self->aot_data != nullptr) {
477  self->embedder_api.CollectAOTData(self->aot_data);
478  self->aot_data = nullptr;
479  }
480 
481  fl_binary_messenger_shutdown(self->binary_messenger);
482  fl_texture_registrar_shutdown(self->texture_registrar);
483 
484  g_clear_object(&self->project);
485  g_clear_object(&self->display_monitor);
486  g_clear_object(&self->compositor);
487  g_clear_object(&self->opengl_manager);
488  g_clear_object(&self->texture_registrar);
489  g_clear_object(&self->binary_messenger);
490  g_clear_object(&self->settings_handler);
491  g_clear_object(&self->platform_handler);
492  g_clear_object(&self->windowing_handler);
493  g_clear_object(&self->keyboard_manager);
494  g_clear_object(&self->text_input_handler);
495  g_clear_object(&self->keyboard_handler);
496  g_clear_object(&self->mouse_cursor_handler);
497  g_clear_object(&self->task_runner);
498  g_clear_pointer(&self->renderables_by_view_id, g_hash_table_unref);
499 
500  if (self->platform_message_handler_destroy_notify) {
501  self->platform_message_handler_destroy_notify(
502  self->platform_message_handler_data);
503  }
504  self->platform_message_handler_data = nullptr;
505  self->platform_message_handler_destroy_notify = nullptr;
506 
507  G_OBJECT_CLASS(fl_engine_parent_class)->dispose(object);
508 }
void fl_binary_messenger_shutdown(FlBinaryMessenger *self)
void fl_texture_registrar_shutdown(FlTextureRegistrar *self)

References fl_binary_messenger_shutdown(), and fl_texture_registrar_shutdown().

Referenced by fl_engine_class_init().

◆ fl_engine_execute_task()

void fl_engine_execute_task ( FlEngine *  engine,
FlutterTask *  task 
)

fl_engine_execute_task: @engine: an #FlEngine. @task: a #FlutterTask to execute.

Executes given Flutter task.

Definition at line 1292 of file fl_engine.cc.

1292  {
1293  g_return_if_fail(FL_IS_ENGINE(self));
1294  self->embedder_api.RunTask(self->engine, task);
1295 }

Referenced by fl_task_runner_process_expired_tasks_locked().

◆ fl_engine_for_id()

FlEngine* fl_engine_for_id ( int64_t  handle)

fl_engine_for_id: @handle: an engine identifier obtained through PlatformDispatcher.instance.engineId.

Returns Flutter engine associated with the identifier. The identifier must be valid and for a running engine otherwise the behavior is undefined. Must be called from the main thread.

Returns: a #FlEngine or NULL.

Definition at line 578 of file fl_engine.cc.

578  {
579  void* engine = reinterpret_cast<void*>(id);
580  g_return_val_if_fail(FL_IS_ENGINE(engine), nullptr);
581  return FL_ENGINE(engine);
582 }
int64_t id

References id.

Referenced by TEST().

◆ fl_engine_get_binary_messenger()

G_MODULE_EXPORT FlBinaryMessenger* fl_engine_get_binary_messenger ( FlEngine *  engine)

fl_engine_get_binary_messenger: @engine: an #FlEngine.

Gets the messenger to communicate with this engine.

Returns: an #FlBinaryMessenger.

Definition at line 1281 of file fl_engine.cc.

1282  {
1283  g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
1284  return self->binary_messenger;
1285 }

Referenced by fl_keyboard_manager_new(), fl_settings_handler_new(), fl_view_get_registrar_for_plugin(), fl_windowing_handler_new(), realize_cb(), and TEST().

◆ fl_engine_get_compositor()

FlCompositor* fl_engine_get_compositor ( FlEngine *  engine)

fl_engine_get_compositor: @engine: an #FlEngine.

Gets the compositor used by this engine.

Returns: an #FlCompositor.

Definition at line 598 of file fl_engine.cc.

598  {
599  g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
600  return self->compositor;
601 }

Referenced by handle_geometry_changed(), realize_cb(), render_cb(), TEST(), and unrealize_cb().

◆ fl_engine_get_display_monitor()

FlDisplayMonitor* fl_engine_get_display_monitor ( FlEngine *  engine)

fl_engine_get_display_monitor: @engine: an #FlEngine.

Gets the display monitor used by this engine.

Returns: an #FlDisplayMonitor.

Definition at line 608 of file fl_engine.cc.

608  {
609  g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
610  return self->display_monitor;
611 }

Referenced by handle_geometry_changed(), and TEST().

◆ fl_engine_get_embedder_api()

FlutterEngineProcTable* fl_engine_get_embedder_api ( FlEngine *  engine)

fl_engine_get_embedder_api: @engine: an #FlEngine.

Gets the embedder API proc table, allowing modificiations for unit testing.

Returns: a mutable pointer to the embedder API proc table.

Definition at line 726 of file fl_engine.cc.

726  {
727  return &(self->embedder_api);
728 }

Referenced by TEST().

◆ fl_engine_get_keyboard_manager()

FlKeyboardManager* fl_engine_get_keyboard_manager ( FlEngine *  engine)

fl_engine_get_keyboard_manager: @engine: an #FlEngine.

Gets the keyboard manager used by this engine.

Returns: an #FlKeyboardManager.

Definition at line 1324 of file fl_engine.cc.

1324  {
1325  g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
1326  return self->keyboard_manager;
1327 }

Referenced by handle_key_event(), sync_modifier_if_needed(), and TEST().

◆ fl_engine_get_mouse_cursor_handler()

FlMouseCursorHandler* fl_engine_get_mouse_cursor_handler ( FlEngine *  engine)

fl_engine_get_mouse_cursor_handler: @engine: an #FlEngine.

Gets the mouse cursor handler used by this engine.

Returns: an #FlMouseCursorHandler.

Definition at line 1334 of file fl_engine.cc.

1334  {
1335  g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
1336  return self->mouse_cursor_handler;
1337 }

Referenced by cursor_changed_cb(), fl_view_dispose(), setup_cursor(), and TEST().

◆ fl_engine_get_opengl_manager()

FlOpenGLManager* fl_engine_get_opengl_manager ( FlEngine *  engine)

fl_engine_get_opengl_manager: @engine: an #FlEngine.

Gets the OpenGL manager used by this engine.

Returns: an #FlOpenGLManager.

Definition at line 603 of file fl_engine.cc.

603  {
604  g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
605  return self->opengl_manager;
606 }

Referenced by create_context_cb(), fl_compositor_opengl_new(), realize_cb(), and unrealize_cb().

◆ fl_engine_get_registrar_for_plugin()

static FlPluginRegistrar* fl_engine_get_registrar_for_plugin ( FlPluginRegistry *  registry,
const gchar *  name 
)
static

Definition at line 438 of file fl_engine.cc.

440  {
441  FlEngine* self = FL_ENGINE(registry);
442 
443  return fl_plugin_registrar_new(nullptr, self->binary_messenger,
444  self->texture_registrar);
445 }
FlPluginRegistrar * fl_plugin_registrar_new(FlView *view, FlBinaryMessenger *messenger, FlTextureRegistrar *texture_registrar)

References fl_plugin_registrar_new().

Referenced by fl_engine_plugin_registry_iface_init().

◆ fl_engine_get_renderable()

FlRenderable* fl_engine_get_renderable ( FlEngine *  engine,
FlutterViewId  view_id 
)

fl_engine_get_renderable: @engine: an #FlEngine. @view_id: ID to check.

Gets the renderable associated with the give view ID.

Returns: (transfer full): a reference to an #FlRenderable or NULL if none for this ID.

Definition at line 806 of file fl_engine.cc.

806  {
807  g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
808 
809  GWeakRef* ref = static_cast<GWeakRef*>(g_hash_table_lookup(
810  self->renderables_by_view_id, GINT_TO_POINTER(view_id)));
811  return FL_RENDERABLE(g_weak_ref_get(ref));
812 }

References view_id.

Referenced by present_layers().

◆ fl_engine_get_task_runner()

FlTaskRunner* fl_engine_get_task_runner ( FlEngine *  engine)

fl_engine_get_task_runner: @engine: an #FlEngine.

Returns
: a #FlTaskRunner.

Returns: task runner responsible for scheduling Flutter tasks.

Definition at line 1287 of file fl_engine.cc.

1287  {
1288  g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
1289  return self->task_runner;
1290 }

Referenced by fl_compositor_opengl_present_layers(), fl_compositor_opengl_unblock_main_thread(), fl_compositor_opengl_wait_for_frame(), and TEST().

◆ fl_engine_get_text_input_handler()

FlTextInputHandler* fl_engine_get_text_input_handler ( FlEngine *  engine)

fl_engine_get_text_input_handler: @engine: an #FlEngine.

Gets the text input handler used by this engine.

Returns: an #FlTextInputHandler.

Definition at line 1329 of file fl_engine.cc.

1329  {
1330  g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
1331  return self->text_input_handler;
1332 }

Referenced by fl_view_focus_in_event(), and handle_key_event().

◆ fl_engine_get_texture_registrar()

G_MODULE_EXPORT FlTextureRegistrar* fl_engine_get_texture_registrar ( FlEngine *  engine)

fl_engine_get_texture_registrar: @engine: an #FlEngine.

Gets the texture registrar for registering textures.

Returns: an #FlTextureRegistrar.

Definition at line 1297 of file fl_engine.cc.

1298  {
1299  g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
1300  return self->texture_registrar;
1301 }

Referenced by fl_view_get_registrar_for_plugin().

◆ fl_engine_get_windowing_handler()

FlWindowingHandler* fl_engine_get_windowing_handler ( FlEngine *  engine)

fl_engine_get_windowing_handler: @engine: an #FlEngine.

Gets the windowing handler used by this engine.

Returns: an #FlWindowingHandler.

Definition at line 1319 of file fl_engine.cc.

1319  {
1320  g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
1321  return self->windowing_handler;
1322 }

Referenced by fl_application_activate(), and TEST().

◆ fl_engine_gl_clear_current()

static bool fl_engine_gl_clear_current ( void *  user_data)
static

Definition at line 288 of file fl_engine.cc.

288  {
289  FlEngine* self = static_cast<FlEngine*>(user_data);
290  fl_opengl_manager_clear_current(self->opengl_manager);
291  return true;
292 }
void fl_opengl_manager_clear_current(FlOpenGLManager *self)

References fl_opengl_manager_clear_current(), and user_data.

Referenced by fl_engine_start().

◆ fl_engine_gl_external_texture_frame_callback()

static bool fl_engine_gl_external_texture_frame_callback ( void *  user_data,
int64_t  texture_id,
size_t  width,
size_t  height,
FlutterOpenGLTexture *  opengl_texture 
)
static

Definition at line 312 of file fl_engine.cc.

317  {
318  FlEngine* self = static_cast<FlEngine*>(user_data);
319  if (!self->texture_registrar) {
320  return false;
321  }
322 
323  FlTexture* texture =
324  fl_texture_registrar_lookup_texture(self->texture_registrar, texture_id);
325  if (texture == nullptr) {
326  g_warning("Unable to find texture %" G_GINT64_FORMAT, texture_id);
327  return false;
328  }
329 
330  gboolean result;
331  g_autoptr(GError) error = nullptr;
332  if (FL_IS_TEXTURE_GL(texture)) {
333  result = fl_texture_gl_populate(FL_TEXTURE_GL(texture), width, height,
334  opengl_texture, &error);
335  } else if (FL_IS_PIXEL_BUFFER_TEXTURE(texture)) {
336  result =
337  fl_pixel_buffer_texture_populate(FL_PIXEL_BUFFER_TEXTURE(texture),
338  width, height, opengl_texture, &error);
339  } else {
340  g_warning("Unsupported texture type %" G_GINT64_FORMAT, texture_id);
341  return false;
342  }
343 
344  if (!result) {
345  g_warning("%s", error->message);
346  return false;
347  }
348 
349  return true;
350 }
gboolean fl_pixel_buffer_texture_populate(FlPixelBufferTexture *texture, uint32_t width, uint32_t height, FlutterOpenGLTexture *opengl_texture, GError **error)
gboolean fl_texture_gl_populate(FlTextureGL *self, uint32_t width, uint32_t height, FlutterOpenGLTexture *opengl_texture, GError **error)
FlTexture * fl_texture_registrar_lookup_texture(FlTextureRegistrar *self, int64_t texture_id)
int64_t texture_id

References error, fl_pixel_buffer_texture_populate(), fl_texture_gl_populate(), fl_texture_registrar_lookup_texture(), height, texture_id, user_data, and width.

Referenced by fl_engine_start().

◆ fl_engine_gl_get_fbo()

static uint32_t fl_engine_gl_get_fbo ( void *  user_data)
static

Definition at line 294 of file fl_engine.cc.

294  {
295  // There is only one frame buffer object - always return that.
296  return 0;
297 }

Referenced by fl_engine_start().

◆ fl_engine_gl_make_current()

static bool fl_engine_gl_make_current ( void *  user_data)
static

Definition at line 282 of file fl_engine.cc.

282  {
283  FlEngine* self = static_cast<FlEngine*>(user_data);
284  fl_opengl_manager_make_current(self->opengl_manager);
285  return true;
286 }
void fl_opengl_manager_make_current(FlOpenGLManager *self)

References fl_opengl_manager_make_current(), and user_data.

Referenced by fl_engine_start().

◆ fl_engine_gl_make_resource_current()

static bool fl_engine_gl_make_resource_current ( void *  user_data)
static

Definition at line 305 of file fl_engine.cc.

305  {
306  FlEngine* self = static_cast<FlEngine*>(user_data);
307  fl_opengl_manager_make_resource_current(self->opengl_manager);
308  return true;
309 }
void fl_opengl_manager_make_resource_current(FlOpenGLManager *self)

References fl_opengl_manager_make_resource_current(), and user_data.

Referenced by fl_engine_start().

◆ fl_engine_gl_present()

static bool fl_engine_gl_present ( void *  user_data)
static

Definition at line 299 of file fl_engine.cc.

299  {
300  // No action required, as this is handled in
301  // compositor_present_view_callback.
302  return true;
303 }

Referenced by fl_engine_start().

◆ fl_engine_gl_proc_resolver()

static void* fl_engine_gl_proc_resolver ( void *  user_data,
const char *  name 
)
static

Definition at line 278 of file fl_engine.cc.

278  {
279  return reinterpret_cast<void*>(eglGetProcAddress(name));
280 }

Referenced by fl_engine_start().

◆ fl_engine_init()

static void fl_engine_init ( FlEngine *  self)
static

Definition at line 530 of file fl_engine.cc.

530  {
531  self->thread = g_thread_self();
532 
533  self->embedder_api.struct_size = sizeof(FlutterEngineProcTable);
534  if (FlutterEngineGetProcAddresses(&self->embedder_api) != kSuccess) {
535  g_warning("Failed get get engine function pointers");
536  }
537 
538  self->opengl_manager = fl_opengl_manager_new();
539 
540  self->display_monitor =
541  fl_display_monitor_new(self, gdk_display_get_default());
542  self->task_runner = fl_task_runner_new(self);
543 
544  // Implicit view is 0, so start at 1.
545  self->next_view_id = 1;
546  self->renderables_by_view_id = g_hash_table_new_full(
547  g_direct_hash, g_direct_equal, nullptr, [](gpointer value) {
548  GWeakRef* ref = static_cast<GWeakRef*>(value);
549  g_weak_ref_clear(ref);
550  free(ref);
551  });
552 
553  self->texture_registrar = fl_texture_registrar_new(self);
554 }
FlDisplayMonitor * fl_display_monitor_new(FlEngine *engine, GdkDisplay *display)
FlOpenGLManager * fl_opengl_manager_new()
uint8_t value
FlTaskRunner * fl_task_runner_new(FlEngine *engine)
FlTextureRegistrar * fl_texture_registrar_new(FlEngine *engine)

References fl_display_monitor_new(), fl_opengl_manager_new(), fl_task_runner_new(), fl_texture_registrar_new(), and value.

◆ fl_engine_mark_texture_frame_available()

gboolean fl_engine_mark_texture_frame_available ( FlEngine *  engine,
int64_t  texture_id 
)

fl_engine_mark_texture_frame_available: @engine: an #FlEngine. @texture_id: the identifier of the texture whose frame has been updated.

Tells the Flutter engine that a new texture frame is available for the given texture.

Returns: TRUE on success.

Definition at line 1260 of file fl_engine.cc.

1261  {
1262  g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
1263  return self->embedder_api.MarkExternalTextureFrameAvailable(
1264  self->engine, texture_id) == kSuccess;
1265 }

References texture_id.

Referenced by mark_texture_frame_available().

◆ fl_engine_new()

G_MODULE_EXPORT FlEngine* fl_engine_new ( FlDartProject *  project)

FlEngine:

#FlEngine is an object that contains a running Flutter engine. fl_engine_new: @project: an #FlDartProject.

Creates new Flutter engine.

Returns: a new #FlEngine.

Definition at line 584 of file fl_engine.cc.

584  {
585  return fl_engine_new_full(project, nullptr);
586 }
static FlEngine * fl_engine_new_full(FlDartProject *project, FlBinaryMessenger *binary_messenger)
Definition: fl_engine.cc:556

References fl_engine_new_full().

Referenced by fl_engine_new_headless(), fl_view_new(), and TEST().

◆ fl_engine_new_full()

static FlEngine* fl_engine_new_full ( FlDartProject *  project,
FlBinaryMessenger *  binary_messenger 
)
static

Definition at line 556 of file fl_engine.cc.

557  {
558  g_return_val_if_fail(FL_IS_DART_PROJECT(project), nullptr);
559 
560  FlEngine* self = FL_ENGINE(g_object_new(fl_engine_get_type(), nullptr));
561 
562  self->project = FL_DART_PROJECT(g_object_ref(project));
563  self->compositor = FL_COMPOSITOR(fl_compositor_opengl_new(self));
564  if (binary_messenger != nullptr) {
565  self->binary_messenger =
566  FL_BINARY_MESSENGER(g_object_ref(binary_messenger));
567  } else {
568  self->binary_messenger = fl_binary_messenger_new(self);
569  }
570  self->keyboard_manager = fl_keyboard_manager_new(self);
571  self->mouse_cursor_handler =
572  fl_mouse_cursor_handler_new(self->binary_messenger);
573  self->windowing_handler = fl_windowing_handler_new(self);
574 
575  return self;
576 }
FlBinaryMessenger * fl_binary_messenger_new(FlEngine *engine)
FlCompositorOpenGL * fl_compositor_opengl_new(FlEngine *engine)
FlKeyboardManager * fl_keyboard_manager_new(FlEngine *engine)
FlMouseCursorHandler * fl_mouse_cursor_handler_new(FlBinaryMessenger *messenger)
FlWindowingHandler * fl_windowing_handler_new(FlEngine *engine)

References fl_binary_messenger_new(), fl_compositor_opengl_new(), fl_keyboard_manager_new(), fl_mouse_cursor_handler_new(), and fl_windowing_handler_new().

Referenced by fl_engine_new(), and fl_engine_new_with_binary_messenger().

◆ fl_engine_new_headless()

G_MODULE_EXPORT FlEngine* fl_engine_new_headless ( FlDartProject *  project)

fl_engine_new_headless: @project: an #FlDartProject.

Creates new Flutter engine running in headless mode.

Returns: a new #FlEngine.

Definition at line 594 of file fl_engine.cc.

594  {
595  return fl_engine_new(project);
596 }
G_MODULE_EXPORT FlEngine * fl_engine_new(FlDartProject *project)
Definition: fl_engine.cc:584

References fl_engine_new().

◆ fl_engine_new_with_binary_messenger()

FlEngine* fl_engine_new_with_binary_messenger ( FlBinaryMessenger *  binary_messenger)

fl_engine_new_with_binary_messenger: @binary_messenger: an #FlBinaryMessenger.

Creates a new engine with a custom binary messenger. Used for testing.

Returns: a new #FlEngine.

Definition at line 588 of file fl_engine.cc.

589  {
590  g_autoptr(FlDartProject) project = fl_dart_project_new();
591  return fl_engine_new_full(project, binary_messenger);
592 }
G_MODULE_EXPORT FlDartProject * fl_dart_project_new()

References fl_dart_project_new(), and fl_engine_new_full().

Referenced by TEST().

◆ fl_engine_notify_display_update()

void fl_engine_notify_display_update ( FlEngine *  engine,
const FlutterEngineDisplay *  displays,
size_t  displays_length 
)

fl_engine_notify_display_update: @engine: an #FlEngine. @displays: displays present on the system. @displays_length: length of @displays.

Notify the current displays that are in the system.

Definition at line 730 of file fl_engine.cc.

732  {
733  g_return_if_fail(FL_IS_ENGINE(self));
734 
735  FlutterEngineResult result = self->embedder_api.NotifyDisplayUpdate(
736  self->engine, kFlutterEngineDisplaysUpdateTypeStartup, displays,
737  displays_length);
738  if (result != kSuccess) {
739  g_warning("Failed to notify display update to Flutter engine: %d", result);
740  }
741 }

Referenced by notify_display_update(), and TEST().

◆ fl_engine_on_pre_engine_restart_cb()

static void fl_engine_on_pre_engine_restart_cb ( void *  user_data)
static

Definition at line 419 of file fl_engine.cc.

419  {
420  FlEngine* self = FL_ENGINE(user_data);
421 
422  setup_keyboard(self);
423 
425 }
g_signal_emit(self, fl_application_signals[SIGNAL_CREATE_WINDOW], 0, view, &window)
static void setup_keyboard(FlEngine *self)
Definition: fl_engine.cc:395

References fl_engine_signals, g_signal_emit(), setup_keyboard(), SIGNAL_ON_PRE_ENGINE_RESTART, and user_data.

Referenced by fl_engine_start().

◆ fl_engine_platform_message_cb()

static void fl_engine_platform_message_cb ( const FlutterPlatformMessage *  message,
void *  user_data 
)
static

Definition at line 368 of file fl_engine.cc.

369  {
370  FlEngine* self = FL_ENGINE(user_data);
371 
372  gboolean handled = FALSE;
373  if (self->platform_message_handler != nullptr) {
374  g_autoptr(GBytes) data =
375  g_bytes_new(message->message, message->message_size);
376  handled = self->platform_message_handler(
377  self, message->channel, data, message->response_handle,
378  self->platform_message_handler_data);
379  }
380 
381  if (!handled) {
382  fl_engine_send_platform_message_response(self, message->response_handle,
383  nullptr, nullptr);
384  }
385 }
gboolean fl_engine_send_platform_message_response(FlEngine *self, const FlutterPlatformMessageResponseHandle *handle, GBytes *response, GError **error)
Definition: fl_engine.cc:867

References fl_engine_send_platform_message_response(), and user_data.

Referenced by fl_engine_start().

◆ fl_engine_platform_message_response_cb()

static void fl_engine_platform_message_response_cb ( const uint8_t *  data,
size_t  data_length,
void *  user_data 
)
static

Definition at line 429 of file fl_engine.cc.

431  {
432  g_autoptr(GTask) task = G_TASK(user_data);
433  g_task_return_pointer(task, g_bytes_new(data, data_length),
434  reinterpret_cast<GDestroyNotify>(g_bytes_unref));
435 }

References user_data.

Referenced by fl_engine_send_platform_message().

◆ fl_engine_plugin_registry_iface_init()

static void fl_engine_plugin_registry_iface_init ( FlPluginRegistryInterface *  iface)
static

Definition at line 447 of file fl_engine.cc.

448  {
449  iface->get_registrar_for_plugin = fl_engine_get_registrar_for_plugin;
450 }
static FlPluginRegistrar * fl_engine_get_registrar_for_plugin(FlPluginRegistry *registry, const gchar *name)
Definition: fl_engine.cc:438

References fl_engine_get_registrar_for_plugin().

◆ fl_engine_post_task()

static void fl_engine_post_task ( FlutterTask  task,
uint64_t  target_time_nanos,
void *  user_data 
)
static

Definition at line 359 of file fl_engine.cc.

361  {
362  FlEngine* self = static_cast<FlEngine*>(user_data);
363 
364  fl_task_runner_post_flutter_task(self->task_runner, task, target_time_nanos);
365 }
void fl_task_runner_post_flutter_task(FlTaskRunner *self, FlutterTask task, uint64_t target_time_nanos)

References fl_task_runner_post_flutter_task(), and user_data.

Referenced by fl_engine_start().

◆ fl_engine_register_external_texture()

gboolean fl_engine_register_external_texture ( FlEngine *  engine,
int64_t  texture_id 
)

fl_engine_register_external_texture: @engine: an #FlEngine. @texture_id: the identifier of the texture that is available.

Tells the Flutter engine that a new external texture is available.

Returns: TRUE on success.

Definition at line 1267 of file fl_engine.cc.

1268  {
1269  g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
1270  return self->embedder_api.RegisterExternalTexture(self->engine, texture_id) ==
1271  kSuccess;
1272 }

References texture_id.

Referenced by register_texture().

◆ fl_engine_remove_view()

void fl_engine_remove_view ( FlEngine *  engine,
FlutterViewId  view_id,
GCancellable *  cancellable,
GAsyncReadyCallback  callback,
gpointer  user_data 
)

fl_engine_remove_view: @engine: an #FlEngine. @view_id: ID to remove. @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.

Removes a view previously added with fl_engine_add_view().

Definition at line 814 of file fl_engine.cc.

818  {
819  g_return_if_fail(FL_IS_ENGINE(self));
820 
821  g_hash_table_remove(self->renderables_by_view_id, GINT_TO_POINTER(view_id));
822 
823  g_autoptr(GTask) task = g_task_new(self, cancellable, callback, user_data);
824 
825  FlutterRemoveViewInfo info;
826  info.struct_size = sizeof(FlutterRemoveViewInfo);
827  info.view_id = view_id;
828  info.user_data = g_object_ref(task);
829  info.remove_view_callback = view_removed_cb;
830  FlutterEngineResult result =
831  self->embedder_api.RemoveView(self->engine, &info);
832  if (result != kSuccess) {
833  g_task_return_new_error(task, fl_engine_error_quark(),
834  FL_ENGINE_ERROR_FAILED, "RemoveView returned %d",
835  result);
836  // This would have been done in the callback, but that won't occur now.
837  g_object_unref(task);
838  }
839 }
static void view_removed_cb(const FlutterRemoveViewResult *result)
Definition: fl_engine.cc:182

References FL_ENGINE_ERROR_FAILED, fl_engine_error_quark(), user_data, view_id, and view_removed_cb().

Referenced by fl_view_dispose(), and TEST().

◆ fl_engine_remove_view_finish()

gboolean fl_engine_remove_view_finish ( FlEngine *  engine,
GAsyncResult *  result,
GError **  error 
)

fl_engine_remove_view_finish: @engine: an #FlEngine.

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

Completes request started with fl_engine_remove_view().

Returns: TRUE on succcess.

Definition at line 841 of file fl_engine.cc.

843  {
844  g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
845  return g_task_propagate_boolean(G_TASK(result), error);
846 }

References error.

Referenced by remove_view_cb(), remove_view_engine_error_cb(), and remove_view_error_cb().

◆ fl_engine_request_app_exit()

void fl_engine_request_app_exit ( FlEngine *  engine)

fl_engine_request_app_exit: @engine: an #FlEngine.

Request the application exits.

Definition at line 1314 of file fl_engine.cc.

1314  {
1315  g_return_if_fail(FL_IS_ENGINE(self));
1316  fl_platform_handler_request_app_exit(self->platform_handler);
1317 }
void fl_platform_handler_request_app_exit(FlPlatformHandler *self)

References fl_platform_handler_request_app_exit().

Referenced by window_delete_event_cb().

◆ fl_engine_runs_task_on_current_thread()

static bool fl_engine_runs_task_on_current_thread ( void *  user_data)
static

Definition at line 353 of file fl_engine.cc.

353  {
354  FlEngine* self = static_cast<FlEngine*>(user_data);
355  return self->thread == g_thread_self();
356 }

References user_data.

Referenced by fl_engine_start().

◆ fl_engine_send_key_event()

void fl_engine_send_key_event ( FlEngine *  engine,
const FlutterKeyEvent *  event,
GCancellable *  cancellable,
GAsyncReadyCallback  callback,
gpointer  user_data 
)

fl_engine_send_key_event: @engine: an #FlEngine. @event: key event to send. @cancellable: (allow-none): a #GCancellable or NULL. @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied. @user_data: (closure): user data to pass to @callback.

Send a key event to the engine.

Definition at line 1192 of file fl_engine.cc.

1196  {
1197  g_return_if_fail(FL_IS_ENGINE(self));
1198 
1199  g_autoptr(GTask) task = g_task_new(self, cancellable, callback, user_data);
1200 
1201  if (self->engine == nullptr) {
1202  g_task_return_new_error(task, fl_engine_error_quark(),
1203  FL_ENGINE_ERROR_FAILED, "No engine");
1204  return;
1205  }
1206 
1207  if (self->embedder_api.SendKeyEvent(self->engine, event, send_key_event_cb,
1208  g_object_ref(task)) != kSuccess) {
1209  g_task_return_new_error(task, fl_engine_error_quark(),
1210  FL_ENGINE_ERROR_FAILED, "Failed to send key event");
1211  g_object_unref(task);
1212  }
1213 }
static void send_key_event_cb(bool handled, void *user_data)
Definition: fl_engine.cc:1185

References FL_ENGINE_ERROR_FAILED, fl_engine_error_quark(), send_key_event_cb(), and user_data.

Referenced by fl_key_embedder_responder_handle_event(), fl_key_embedder_responder_handle_event_impl(), synthesize_simple_event(), and TEST().

◆ fl_engine_send_key_event_finish()

gboolean fl_engine_send_key_event_finish ( FlEngine *  engine,
GAsyncResult *  result,
gboolean *  handled,
GError **  error 
)

fl_engine_send_key_event_finish: @engine: an #FlEngine.

Returns
: a #GAsyncResult. @handled: location to write if this event was handled by the engine. @error: (allow-none): #GError location to store the error occurring, or NULL to ignore.

Completes request started with fl_engine_send_key_event().

Returns: TRUE on success.

Definition at line 1215 of file fl_engine.cc.

1218  {
1219  g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
1220  g_return_val_if_fail(g_task_is_valid(result, self), FALSE);
1221 
1222  g_autofree gboolean* return_value =
1223  static_cast<gboolean*>(g_task_propagate_pointer(G_TASK(result), error));
1224  if (return_value == nullptr) {
1225  return FALSE;
1226  }
1227 
1228  *handled = *return_value;
1229  return TRUE;
1230 }

References error, and TRUE.

Referenced by TEST().

◆ fl_engine_send_mouse_pointer_event()

void fl_engine_send_mouse_pointer_event ( FlEngine *  engine,
FlutterViewId  view_id,
FlutterPointerPhase  phase,
size_t  timestamp,
double  x,
double  y,
FlutterPointerDeviceKind  device_kind,
double  scroll_delta_x,
double  scroll_delta_y,
int64_t  buttons 
)

fl_engine_send_mouse_pointer_event: @engine: an #FlEngine. @view_id: the view that the event occured on. @phase: mouse phase. @timestamp: time when event occurred in microseconds. @x: x location of mouse cursor. @y: y location of mouse cursor. @device_kind: kind of pointing device. @scroll_delta_x: x offset of scroll. @scroll_delta_y: y offset of scroll. @buttons: buttons that are pressed.

Sends a mouse pointer event to the engine.

Definition at line 989 of file fl_engine.cc.

998  {
999  g_return_if_fail(FL_IS_ENGINE(self));
1000 
1001  if (self->engine == nullptr) {
1002  return;
1003  }
1004 
1005  FlutterPointerEvent fl_event = {};
1006  fl_event.struct_size = sizeof(fl_event);
1007  fl_event.phase = phase;
1008  fl_event.timestamp = timestamp;
1009  fl_event.x = x;
1010  fl_event.y = y;
1011  if (scroll_delta_x != 0 || scroll_delta_y != 0) {
1012  fl_event.signal_kind = kFlutterPointerSignalKindScroll;
1013  }
1014  fl_event.scroll_delta_x = scroll_delta_x;
1015  fl_event.scroll_delta_y = scroll_delta_y;
1016  fl_event.device_kind = device_kind;
1017  fl_event.buttons = buttons;
1018  fl_event.device = kMousePointerDeviceId;
1019  fl_event.view_id = view_id;
1020  self->embedder_api.SendPointerEvent(self->engine, &fl_event, 1);
1021 }
static constexpr int32_t kMousePointerDeviceId
Definition: fl_engine.cc:36

References kMousePointerDeviceId, and view_id.

Referenced by ensure_pointer_added(), fl_pointer_manager_handle_button_press(), fl_pointer_manager_handle_button_release(), fl_pointer_manager_handle_leave(), fl_pointer_manager_handle_motion(), fl_scrolling_manager_handle_scroll_event(), and TEST().

◆ fl_engine_send_platform_message()

void fl_engine_send_platform_message ( FlEngine *  engine,
const gchar *  channel,
GBytes *  message,
GCancellable *  cancellable,
GAsyncReadyCallback  callback,
gpointer  user_data 
)

fl_engine_send_platform_message: @engine: an #FlEngine. @channel: channel to send to. @message: (allow-none): message buffer to send or NULL for an empty message @cancellable: (allow-none): a #GCancellable or NULL. @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied. @user_data: (closure): user data to pass to @callback.

Asynchronously sends a platform message.

Definition at line 899 of file fl_engine.cc.

904  {
905  g_return_if_fail(FL_IS_ENGINE(self));
906 
907  GTask* task = nullptr;
908  FlutterPlatformMessageResponseHandle* response_handle = nullptr;
909  if (callback != nullptr) {
910  task = g_task_new(self, cancellable, callback, user_data);
911 
912  if (self->engine == nullptr) {
913  g_task_return_new_error(task, fl_engine_error_quark(),
914  FL_ENGINE_ERROR_FAILED, "No engine to send to");
915  return;
916  }
917 
918  FlutterEngineResult result =
919  self->embedder_api.PlatformMessageCreateResponseHandle(
920  self->engine, fl_engine_platform_message_response_cb, task,
921  &response_handle);
922  if (result != kSuccess) {
923  g_task_return_new_error(task, fl_engine_error_quark(),
925  "Failed to create response handle");
926  g_object_unref(task);
927  return;
928  }
929  } else if (self->engine == nullptr) {
930  return;
931  }
932 
933  FlutterPlatformMessage fl_message = {};
934  fl_message.struct_size = sizeof(fl_message);
935  fl_message.channel = channel;
936  fl_message.message =
937  message != nullptr
938  ? static_cast<const uint8_t*>(g_bytes_get_data(message, nullptr))
939  : nullptr;
940  fl_message.message_size = message != nullptr ? g_bytes_get_size(message) : 0;
941  fl_message.response_handle = response_handle;
942  FlutterEngineResult result =
943  self->embedder_api.SendPlatformMessage(self->engine, &fl_message);
944 
945  if (result != kSuccess && task != nullptr) {
946  g_task_return_new_error(task, fl_engine_error_quark(),
948  "Failed to send platform messages");
949  g_object_unref(task);
950  }
951 
952  if (response_handle != nullptr) {
953  self->embedder_api.PlatformMessageReleaseResponseHandle(self->engine,
954  response_handle);
955  }
956 }
static void fl_engine_platform_message_response_cb(const uint8_t *data, size_t data_length, void *user_data)
Definition: fl_engine.cc:429

References FL_ENGINE_ERROR_FAILED, fl_engine_error_quark(), fl_engine_platform_message_response_cb(), and user_data.

Referenced by send_on_channel(), and TEST().

◆ fl_engine_send_platform_message_finish()

GBytes* fl_engine_send_platform_message_finish ( FlEngine *  engine,
GAsyncResult *  result,
GError **  error 
)

fl_engine_send_platform_message_finish: @engine: an #FlEngine.

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

Completes request started with fl_engine_send_platform_message().

Returns: message response on success or NULL on error.

Definition at line 958 of file fl_engine.cc.

960  {
961  g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
962  g_return_val_if_fail(g_task_is_valid(result, self), FALSE);
963 
964  return static_cast<GBytes*>(g_task_propagate_pointer(G_TASK(result), error));
965 }

References error.

Referenced by send_on_channel_finish().

◆ fl_engine_send_platform_message_response()

gboolean fl_engine_send_platform_message_response ( FlEngine *  engine,
const FlutterPlatformMessageResponseHandle *  handle,
GBytes *  response,
GError **  error 
)

fl_engine_send_platform_message_response: @engine: an #FlEngine. @handle: handle that was provided in FlEnginePlatformMessageHandler. @response: (allow-none): response to send or NULL for an empty response. @error: (allow-none): #GError location to store the error occurring, or NULL to ignore.

Responds to a platform message.

Returns: TRUE on success.

Definition at line 867 of file fl_engine.cc.

871  {
872  g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
873  g_return_val_if_fail(handle != nullptr, FALSE);
874 
875  if (self->engine == nullptr) {
877  "No engine to send response to");
878  return FALSE;
879  }
880 
881  gsize data_length = 0;
882  const uint8_t* data = nullptr;
883  if (response != nullptr) {
884  data =
885  static_cast<const uint8_t*>(g_bytes_get_data(response, &data_length));
886  }
887  FlutterEngineResult result = self->embedder_api.SendPlatformMessageResponse(
888  self->engine, handle, data, data_length);
889 
890  if (result != kSuccess) {
892  "Failed to send platform message response");
893  return FALSE;
894  }
895 
896  return TRUE;
897 }

References error, FL_ENGINE_ERROR_FAILED, fl_engine_error_quark(), and TRUE.

Referenced by fl_engine_platform_message_cb(), send_response(), and TEST().

◆ fl_engine_send_pointer_pan_zoom_event()

void fl_engine_send_pointer_pan_zoom_event ( FlEngine *  engine,
FlutterViewId  view_id,
size_t  timestamp,
double  x,
double  y,
FlutterPointerPhase  phase,
double  pan_x,
double  pan_y,
double  scale,
double  rotation 
)

fl_engine_send_pointer_pan_zoom_event: @engine: an #FlEngine. @view_id: the view that the event occured on. @timestamp: time when event occurred in microseconds. @x: x location of mouse cursor. @y: y location of mouse cursor. @phase: mouse phase. @pan_x: x offset of the pan/zoom in pixels. @pan_y: y offset of the pan/zoom in pixels. @scale: scale of the pan/zoom. @rotation: rotation of the pan/zoom in radians.

Sends a pan/zoom pointer event to the engine.

Definition at line 1153 of file fl_engine.cc.

1162  {
1163  g_return_if_fail(FL_IS_ENGINE(self));
1164 
1165  if (self->engine == nullptr) {
1166  return;
1167  }
1168 
1169  FlutterPointerEvent fl_event = {};
1170  fl_event.struct_size = sizeof(fl_event);
1171  fl_event.timestamp = timestamp;
1172  fl_event.x = x;
1173  fl_event.y = y;
1174  fl_event.phase = phase;
1175  fl_event.pan_x = pan_x;
1176  fl_event.pan_y = pan_y;
1177  fl_event.scale = scale;
1178  fl_event.rotation = rotation;
1179  fl_event.device = kPointerPanZoomDeviceId;
1180  fl_event.device_kind = kFlutterPointerDeviceKindTrackpad;
1181  fl_event.view_id = view_id;
1182  self->embedder_api.SendPointerEvent(self->engine, &fl_event, 1);
1183 }
static constexpr int32_t kPointerPanZoomDeviceId
Definition: fl_engine.cc:37

References kPointerPanZoomDeviceId, and view_id.

Referenced by fl_scrolling_manager_handle_rotation_begin(), fl_scrolling_manager_handle_rotation_end(), fl_scrolling_manager_handle_rotation_update(), fl_scrolling_manager_handle_scroll_event(), fl_scrolling_manager_handle_zoom_begin(), fl_scrolling_manager_handle_zoom_end(), fl_scrolling_manager_handle_zoom_update(), and TEST().

◆ fl_engine_send_touch_add_event()

void fl_engine_send_touch_add_event ( FlEngine *  engine,
FlutterViewId  view_id,
size_t  timestamp,
double  x,
double  y,
int32_t  device 
)

fl_engine_send_touch_add_event: @engine: an #FlEngine. @view_id: the view that the event occured on. @timestamp: time when event occurred in microseconds. @x: x location of mouse cursor. @y: y location of mouse cursor. @device: device id.

Sends a touch add event to the engine.

Definition at line 1101 of file fl_engine.cc.

1106  {
1107  g_return_if_fail(FL_IS_ENGINE(self));
1108 
1109  if (self->engine == nullptr) {
1110  return;
1111  }
1112 
1113  FlutterPointerEvent event;
1114  event.timestamp = timestamp;
1115  event.x = x;
1116  event.y = y;
1117  event.device_kind = kFlutterPointerDeviceKindTouch;
1118  event.device = device;
1119  event.buttons = 0;
1120  event.view_id = view_id;
1121  event.phase = FlutterPointerPhase::kAdd;
1122  event.struct_size = sizeof(event);
1123 
1124  self->embedder_api.SendPointerEvent(self->engine, &event, 1);
1125 }

References view_id.

Referenced by ensure_touch_added().

◆ fl_engine_send_touch_down_event()

void fl_engine_send_touch_down_event ( FlEngine *  engine,
FlutterViewId  view_id,
size_t  timestamp,
double  x,
double  y,
int32_t  device 
)

fl_engine_send_touch_down_event: @engine: an #FlEngine. @view_id: the view that the event occured on. @timestamp: time when event occurred in microseconds. @x: x location of mouse cursor. @y: y location of mouse cursor. @device: device id.

Sends a touch down event to the engine.

Definition at line 1049 of file fl_engine.cc.

1054  {
1055  g_return_if_fail(FL_IS_ENGINE(self));
1056 
1057  if (self->engine == nullptr) {
1058  return;
1059  }
1060 
1061  FlutterPointerEvent event;
1062  event.timestamp = timestamp;
1063  event.x = x;
1064  event.y = y;
1065  event.device_kind = kFlutterPointerDeviceKindTouch;
1066  event.device = device;
1067  event.buttons = FlutterPointerMouseButtons::kFlutterPointerButtonMousePrimary;
1068  event.view_id = view_id;
1069  event.phase = FlutterPointerPhase::kDown;
1070  event.struct_size = sizeof(event);
1071 
1072  self->embedder_api.SendPointerEvent(self->engine, &event, 1);
1073 }

References view_id.

Referenced by fl_touch_manager_handle_touch_event().

◆ fl_engine_send_touch_move_event()

void fl_engine_send_touch_move_event ( FlEngine *  engine,
FlutterViewId  view_id,
size_t  timestamp,
double  x,
double  y,
int32_t  device 
)

fl_engine_send_touch_move_event: @engine: an #FlEngine. @view_id: the view that the event occured on. @timestamp: time when event occurred in microseconds. @x: x location of mouse cursor. @y: y location of mouse cursor. @device: device id.

Sends a touch move event to the engine.

Definition at line 1075 of file fl_engine.cc.

1080  {
1081  g_return_if_fail(FL_IS_ENGINE(self));
1082 
1083  if (self->engine == nullptr) {
1084  return;
1085  }
1086 
1087  FlutterPointerEvent event;
1088  event.timestamp = timestamp;
1089  event.x = x;
1090  event.y = y;
1091  event.device_kind = kFlutterPointerDeviceKindTouch;
1092  event.device = device;
1093  event.buttons = FlutterPointerMouseButtons::kFlutterPointerButtonMousePrimary;
1094  event.view_id = view_id;
1095  event.phase = FlutterPointerPhase::kMove;
1096  event.struct_size = sizeof(event);
1097 
1098  self->embedder_api.SendPointerEvent(self->engine, &event, 1);
1099 }

References view_id.

Referenced by fl_touch_manager_handle_touch_event().

◆ fl_engine_send_touch_remove_event()

void fl_engine_send_touch_remove_event ( FlEngine *  engine,
FlutterViewId  view_id,
size_t  timestamp,
double  x,
double  y,
int32_t  device 
)

fl_engine_send_touch_remove_event: @engine: an #FlEngine. @view_id: the view that the event occured on. @timestamp: time when event occurred in microseconds. @x: x location of mouse cursor. @y: y location of mouse cursor. @device: device id.

Sends a touch remove event to the engine.

Definition at line 1127 of file fl_engine.cc.

1132  {
1133  g_return_if_fail(FL_IS_ENGINE(self));
1134 
1135  if (self->engine == nullptr) {
1136  return;
1137  }
1138 
1139  FlutterPointerEvent event;
1140  event.timestamp = timestamp;
1141  event.x = x;
1142  event.y = y;
1143  event.device_kind = kFlutterPointerDeviceKindTouch;
1144  event.device = device;
1145  event.buttons = 0;
1146  event.view_id = view_id;
1147  event.phase = FlutterPointerPhase::kRemove;
1148  event.struct_size = sizeof(event);
1149 
1150  self->embedder_api.SendPointerEvent(self->engine, &event, 1);
1151 }

References view_id.

Referenced by fl_touch_manager_handle_touch_event().

◆ fl_engine_send_touch_up_event()

void fl_engine_send_touch_up_event ( FlEngine *  engine,
FlutterViewId  view_id,
size_t  timestamp,
double  x,
double  y,
int32_t  device 
)

fl_engine_send_touch_up_event: @engine: an #FlEngine. @view_id: the view that the event occured on. @timestamp: time when event occurred in microseconds. @x: x location of mouse cursor. @y: y location of mouse cursor. @device: device id.

Sends a touch up event to the engine.

Definition at line 1023 of file fl_engine.cc.

1028  {
1029  g_return_if_fail(FL_IS_ENGINE(self));
1030 
1031  if (self->engine == nullptr) {
1032  return;
1033  }
1034 
1035  FlutterPointerEvent event;
1036  event.timestamp = timestamp;
1037  event.x = x;
1038  event.y = y;
1039  event.device_kind = kFlutterPointerDeviceKindTouch;
1040  event.device = device;
1041  event.buttons = 0;
1042  event.view_id = view_id;
1043  event.phase = FlutterPointerPhase::kUp;
1044  event.struct_size = sizeof(event);
1045 
1046  self->embedder_api.SendPointerEvent(self->engine, &event, 1);
1047 }

References view_id.

Referenced by fl_touch_manager_handle_touch_event().

◆ fl_engine_send_window_metrics_event()

void fl_engine_send_window_metrics_event ( FlEngine *  engine,
FlutterEngineDisplayId  display_id,
FlutterViewId  view_id,
size_t  width,
size_t  height,
double  pixel_ratio 
)

fl_engine_send_window_metrics_event: @engine: an #FlEngine. @display_id: the display this view is rendering on. @view_id: the view that the event occured on. @width: width of the window in pixels. @height: height of the window in pixels. @pixel_ratio: scale factor for window.

Sends a window metrics event to the engine.

Definition at line 967 of file fl_engine.cc.

972  {
973  g_return_if_fail(FL_IS_ENGINE(self));
974 
975  if (self->engine == nullptr) {
976  return;
977  }
978 
979  FlutterWindowMetricsEvent event = {};
980  event.struct_size = sizeof(FlutterWindowMetricsEvent);
981  event.width = width;
982  event.height = height;
983  event.pixel_ratio = pixel_ratio;
984  event.display_id = display_id;
985  event.view_id = view_id;
986  self->embedder_api.SendWindowMetricsEvent(self->engine, &event);
987 }

References height, view_id, and width.

Referenced by handle_geometry_changed(), and TEST().

◆ fl_engine_set_implicit_view()

void fl_engine_set_implicit_view ( FlEngine *  engine,
FlRenderable *  renderable 
)

fl_engine_set_implicit_view: @engine: an #FlEngine. @renderable: the object that will render the implicit view.

Sets the object to render the implicit view.

Definition at line 743 of file fl_engine.cc.

743  {
744  GWeakRef* ref = g_new(GWeakRef, 1);
745  g_weak_ref_init(ref, G_OBJECT(renderable));
746  g_hash_table_insert(self->renderables_by_view_id,
747  GINT_TO_POINTER(flutter::kFlutterImplicitViewId), ref);
748 }

Referenced by fl_view_new(), and TEST().

◆ fl_engine_set_platform_message_handler()

void fl_engine_set_platform_message_handler ( FlEngine *  engine,
FlEnginePlatformMessageHandler  handler,
gpointer  user_data,
GDestroyNotify  destroy_notify 
)

fl_engine_set_platform_message_handler: @engine: an #FlEngine. @handler: function to call when a platform message is received. @user_data: (closure): user data to pass to @handler. @destroy_notify: (allow-none): a function which gets called to free @user_data, or NULL.

Registers the function called when a platform message is received. Call fl_engine_send_platform_message_response() with the response to this message. Ownership of #FlutterPlatformMessageResponseHandle is transferred to the caller, and the message must be responded to avoid memory leaks.

Definition at line 848 of file fl_engine.cc.

852  {
853  g_return_if_fail(FL_IS_ENGINE(self));
854  g_return_if_fail(handler != nullptr);
855 
856  if (self->platform_message_handler_destroy_notify) {
857  self->platform_message_handler_destroy_notify(
858  self->platform_message_handler_data);
859  }
860 
861  self->platform_message_handler = handler;
862  self->platform_message_handler_data = user_data;
863  self->platform_message_handler_destroy_notify = destroy_notify;
864 }

References user_data.

Referenced by fl_binary_messenger_new().

◆ fl_engine_set_property()

static void fl_engine_set_property ( GObject *  object,
guint  prop_id,
const GValue *  value,
GParamSpec *  pspec 
)
static

Definition at line 452 of file fl_engine.cc.

455  {
456  FlEngine* self = FL_ENGINE(object);
457  switch (prop_id) {
458  case PROP_BINARY_MESSENGER:
459  g_set_object(&self->binary_messenger,
460  FL_BINARY_MESSENGER(g_value_get_object(value)));
461  break;
462  default:
463  G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
464  break;
465  }
466 }
guint prop_id
guint const GValue GParamSpec * pspec

References prop_id, pspec, and value.

Referenced by fl_engine_class_init().

◆ fl_engine_start()

gboolean fl_engine_start ( FlEngine *  engine,
GError **  error 
)

fl_engine_start: @engine: an #FlEngine. @error: (allow-none): #GError location to store the error occurring, or NULL to ignore.

Starts the Flutter engine.

Returns: TRUE on success.

Definition at line 613 of file fl_engine.cc.

613  {
614  g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
615 
616  FlutterRendererConfig config = {};
617  config.type = kOpenGL;
618  config.open_gl.struct_size = sizeof(FlutterOpenGLRendererConfig);
619  config.open_gl.gl_proc_resolver = fl_engine_gl_proc_resolver;
620  config.open_gl.make_current = fl_engine_gl_make_current;
621  config.open_gl.clear_current = fl_engine_gl_clear_current;
622  config.open_gl.fbo_callback = fl_engine_gl_get_fbo;
623  config.open_gl.present = fl_engine_gl_present;
624  config.open_gl.make_resource_current = fl_engine_gl_make_resource_current;
625  config.open_gl.gl_external_texture_frame_callback =
627 
628  FlutterTaskRunnerDescription platform_task_runner = {};
629  platform_task_runner.struct_size = sizeof(FlutterTaskRunnerDescription);
630  platform_task_runner.user_data = self;
631  platform_task_runner.runs_task_on_current_thread_callback =
633  platform_task_runner.post_task_callback = fl_engine_post_task;
634  platform_task_runner.identifier = kPlatformTaskRunnerIdentifier;
635 
636  FlutterCustomTaskRunners custom_task_runners = {};
637  custom_task_runners.struct_size = sizeof(FlutterCustomTaskRunners);
638  custom_task_runners.platform_task_runner = &platform_task_runner;
639 
640  g_autoptr(GPtrArray) command_line_args =
641  g_ptr_array_new_with_free_func(g_free);
642  g_ptr_array_insert(command_line_args, 0, g_strdup("flutter"));
643  for (const auto& env_switch : flutter::GetSwitchesFromEnvironment()) {
644  g_ptr_array_add(command_line_args, g_strdup(env_switch.c_str()));
645  }
646 
647  gchar** dart_entrypoint_args =
649 
650  FlutterProjectArgs args = {};
651  args.struct_size = sizeof(FlutterProjectArgs);
652  args.assets_path = fl_dart_project_get_assets_path(self->project);
653  args.icu_data_path = fl_dart_project_get_icu_data_path(self->project);
654  args.command_line_argc = command_line_args->len;
655  args.command_line_argv =
656  reinterpret_cast<const char* const*>(command_line_args->pdata);
657  args.platform_message_callback = fl_engine_platform_message_cb;
658  args.update_semantics_callback2 = fl_engine_update_semantics_cb;
659  args.custom_task_runners = &custom_task_runners;
660  args.shutdown_dart_vm_when_done = true;
661  args.on_pre_engine_restart_callback = fl_engine_on_pre_engine_restart_cb;
662  args.dart_entrypoint_argc =
663  dart_entrypoint_args != nullptr ? g_strv_length(dart_entrypoint_args) : 0;
664  args.dart_entrypoint_argv =
665  reinterpret_cast<const char* const*>(dart_entrypoint_args);
666  args.engine_id = reinterpret_cast<int64_t>(self);
667 
668  FlutterCompositor compositor = {};
669  compositor.struct_size = sizeof(FlutterCompositor);
670  compositor.user_data = self;
671  compositor.create_backing_store_callback =
673  compositor.collect_backing_store_callback =
675  compositor.present_view_callback = compositor_present_view_callback;
676  args.compositor = &compositor;
677 
678  if (self->embedder_api.RunsAOTCompiledDartCode()) {
679  FlutterEngineAOTDataSource source = {};
680  source.type = kFlutterEngineAOTDataSourceTypeElfPath;
681  source.elf_path = fl_dart_project_get_aot_library_path(self->project);
682  if (self->embedder_api.CreateAOTData(&source, &self->aot_data) !=
683  kSuccess) {
685  "Failed to create AOT data");
686  return FALSE;
687  }
688  args.aot_data = self->aot_data;
689  }
690 
691  FlutterEngineResult result = self->embedder_api.Initialize(
692  FLUTTER_ENGINE_VERSION, &config, &args, self, &self->engine);
693  if (result != kSuccess) {
695  "Failed to initialize Flutter engine");
696  return FALSE;
697  }
698 
699  result = self->embedder_api.RunInitialized(self->engine);
700  if (result != kSuccess) {
702  "Failed to run Flutter engine");
703  return FALSE;
704  }
705 
706  setup_locales(self);
707 
708  g_autoptr(FlSettings) settings = fl_settings_new();
709  self->settings_handler = fl_settings_handler_new(self);
710  fl_settings_handler_start(self->settings_handler, settings);
711 
712  self->platform_handler = fl_platform_handler_new(self->binary_messenger);
713 
714  setup_keyboard(self);
715 
716  result = self->embedder_api.UpdateSemanticsEnabled(self->engine, TRUE);
717  if (result != kSuccess) {
718  g_warning("Failed to enable accessibility features on Flutter engine");
719  }
720 
721  fl_display_monitor_start(self->display_monitor);
722 
723  return TRUE;
724 }
G_MODULE_EXPORT const gchar * fl_dart_project_get_aot_library_path(FlDartProject *self)
G_MODULE_EXPORT gchar ** fl_dart_project_get_dart_entrypoint_arguments(FlDartProject *self)
G_MODULE_EXPORT const gchar * fl_dart_project_get_icu_data_path(FlDartProject *self)
G_MODULE_EXPORT const gchar * fl_dart_project_get_assets_path(FlDartProject *self)
void fl_display_monitor_start(FlDisplayMonitor *self)
static bool fl_engine_gl_external_texture_frame_callback(void *user_data, int64_t texture_id, size_t width, size_t height, FlutterOpenGLTexture *opengl_texture)
Definition: fl_engine.cc:312
static bool fl_engine_runs_task_on_current_thread(void *user_data)
Definition: fl_engine.cc:353
static void fl_engine_on_pre_engine_restart_cb(void *user_data)
Definition: fl_engine.cc:419
static bool compositor_create_backing_store_callback(const FlutterBackingStoreConfig *config, FlutterBackingStore *backing_store_out, void *user_data)
Definition: fl_engine.cc:251
static bool fl_engine_gl_make_current(void *user_data)
Definition: fl_engine.cc:282
static bool compositor_present_view_callback(const FlutterPresentViewInfo *info)
Definition: fl_engine.cc:269
static bool compositor_collect_backing_store_callback(const FlutterBackingStore *backing_store, void *user_data)
Definition: fl_engine.cc:261
static void fl_engine_post_task(FlutterTask task, uint64_t target_time_nanos, void *user_data)
Definition: fl_engine.cc:359
static uint32_t fl_engine_gl_get_fbo(void *user_data)
Definition: fl_engine.cc:294
static void * fl_engine_gl_proc_resolver(void *user_data, const char *name)
Definition: fl_engine.cc:278
static bool fl_engine_gl_present(void *user_data)
Definition: fl_engine.cc:299
static void setup_locales(FlEngine *self)
Definition: fl_engine.cc:200
static void fl_engine_update_semantics_cb(const FlutterSemanticsUpdate2 *update, void *user_data)
Definition: fl_engine.cc:388
static bool fl_engine_gl_make_resource_current(void *user_data)
Definition: fl_engine.cc:305
static void fl_engine_platform_message_cb(const FlutterPlatformMessage *message, void *user_data)
Definition: fl_engine.cc:368
static constexpr size_t kPlatformTaskRunnerIdentifier
Definition: fl_engine.cc:32
static bool fl_engine_gl_clear_current(void *user_data)
Definition: fl_engine.cc:288
G_BEGIN_DECLS G_MODULE_EXPORT FlValue * args
FlPlatformHandler * fl_platform_handler_new(FlBinaryMessenger *messenger)
FlSettings * fl_settings_new()
Definition: fl_settings.cc:55
void fl_settings_handler_start(FlSettingsHandler *self, FlSettings *settings)
FlSettingsHandler * fl_settings_handler_new(FlEngine *engine)
std::vector< std::string > GetSwitchesFromEnvironment()

References args, compositor_collect_backing_store_callback(), compositor_create_backing_store_callback(), compositor_present_view_callback(), error, fl_dart_project_get_aot_library_path(), fl_dart_project_get_assets_path(), fl_dart_project_get_dart_entrypoint_arguments(), fl_dart_project_get_icu_data_path(), fl_display_monitor_start(), FL_ENGINE_ERROR_FAILED, fl_engine_error_quark(), fl_engine_gl_clear_current(), fl_engine_gl_external_texture_frame_callback(), fl_engine_gl_get_fbo(), fl_engine_gl_make_current(), fl_engine_gl_make_resource_current(), fl_engine_gl_present(), fl_engine_gl_proc_resolver(), fl_engine_on_pre_engine_restart_cb(), fl_engine_platform_message_cb(), fl_engine_post_task(), fl_engine_runs_task_on_current_thread(), fl_engine_update_semantics_cb(), fl_platform_handler_new(), fl_settings_handler_new(), fl_settings_handler_start(), fl_settings_new(), flutter::GetSwitchesFromEnvironment(), kPlatformTaskRunnerIdentifier, setup_keyboard(), setup_locales(), and TRUE.

Referenced by realize_cb(), and TEST().

◆ fl_engine_unregister_external_texture()

gboolean fl_engine_unregister_external_texture ( FlEngine *  engine,
int64_t  texture_id 
)

fl_engine_unregister_external_texture: @engine: an #FlEngine. @texture_id: the identifier of the texture that is not available anymore.

Tells the Flutter engine that an existing external texture is not available anymore.

Returns: TRUE on success.

Definition at line 1274 of file fl_engine.cc.

1275  {
1276  g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
1277  return self->embedder_api.UnregisterExternalTexture(self->engine,
1278  texture_id) == kSuccess;
1279 }

References texture_id.

Referenced by unregister_texture().

◆ fl_engine_update_accessibility_features()

void fl_engine_update_accessibility_features ( FlEngine *  engine,
int32_t  flags 
)

fl_engine_update_accessibility_features: @engine: an #FlEngine. @flags: the features to enable in the accessibility tree.

Tells the Flutter engine to update the flags on the accessibility tree.

Definition at line 1303 of file fl_engine.cc.

1303  {
1304  g_return_if_fail(FL_IS_ENGINE(self));
1305 
1306  if (self->engine == nullptr) {
1307  return;
1308  }
1309 
1310  self->embedder_api.UpdateAccessibilityFeatures(
1311  self->engine, static_cast<FlutterAccessibilityFeature>(flags));
1312 }
FlutterSemanticsFlag flags

References flags.

Referenced by update_settings().

◆ fl_engine_update_semantics_cb()

static void fl_engine_update_semantics_cb ( const FlutterSemanticsUpdate2 *  update,
void *  user_data 
)
static

Definition at line 388 of file fl_engine.cc.

389  {
390  FlEngine* self = FL_ENGINE(user_data);
391 
393 }

References fl_engine_signals, g_signal_emit(), SIGNAL_UPDATE_SEMANTICS, and user_data.

Referenced by fl_engine_start().

◆ free_locale()

static void free_locale ( FlutterLocale *  locale)
static

Definition at line 193 of file fl_engine.cc.

193  {
194  free(const_cast<gchar*>(locale->language_code));
195  free(const_cast<gchar*>(locale->country_code));
196  free(locale);
197 }

Referenced by setup_locales().

◆ G_DEFINE_TYPE_WITH_CODE()

G_DEFINE_TYPE_WITH_CODE ( FlEngine  ,
fl_engine  ,
G_TYPE_OBJECT  ,
G_IMPLEMENT_INTERFACE(fl_plugin_registry_get_type(), fl_engine_plugin_registry_iface_init  
)

Definition at line 118 of file fl_engine.cc.

125  { PROP_0, PROP_BINARY_MESSENGER, PROP_LAST };
@ PROP_LAST
@ PROP_0

References PROP_0, and PROP_LAST.

◆ parse_locale()

static void parse_locale ( const gchar *  locale,
gchar **  language,
gchar **  territory,
gchar **  codeset,
gchar **  modifier 
)
static

Definition at line 128 of file fl_engine.cc.

132  {
133  gchar* l = g_strdup(locale);
134 
135  // Locales are in the form "language[_territory][.codeset][@modifier]"
136  gchar* match = strrchr(l, '@');
137  if (match != nullptr) {
138  if (modifier != nullptr) {
139  *modifier = g_strdup(match + 1);
140  }
141  *match = '\0';
142  } else if (modifier != nullptr) {
143  *modifier = nullptr;
144  }
145 
146  match = strrchr(l, '.');
147  if (match != nullptr) {
148  if (codeset != nullptr) {
149  *codeset = g_strdup(match + 1);
150  }
151  *match = '\0';
152  } else if (codeset != nullptr) {
153  *codeset = nullptr;
154  }
155 
156  match = strrchr(l, '_');
157  if (match != nullptr) {
158  if (territory != nullptr) {
159  *territory = g_strdup(match + 1);
160  }
161  *match = '\0';
162  } else if (territory != nullptr) {
163  *territory = nullptr;
164  }
165 
166  if (language != nullptr) {
167  *language = l;
168  }
169 }

Referenced by setup_locales().

◆ send_key_event_cb()

static void send_key_event_cb ( bool  handled,
void *  user_data 
)
static

Definition at line 1185 of file fl_engine.cc.

1185  {
1186  g_autoptr(GTask) task = G_TASK(user_data);
1187  gboolean* return_value = g_new0(gboolean, 1);
1188  *return_value = handled;
1189  g_task_return_pointer(task, return_value, g_free);
1190 }

References user_data.

Referenced by fl_engine_send_key_event().

◆ setup_keyboard()

static void setup_keyboard ( FlEngine *  self)
static

Definition at line 395 of file fl_engine.cc.

395  {
396  g_clear_object(&self->keyboard_manager);
397  self->keyboard_manager = fl_keyboard_manager_new(self);
398 
399  g_clear_object(&self->keyboard_handler);
400  self->keyboard_handler =
401  fl_keyboard_handler_new(self->binary_messenger, self->keyboard_manager);
402 
403  GtkWidget* widget =
404  self->text_input_handler != nullptr
405  ? fl_text_input_handler_get_widget(self->text_input_handler)
406  : nullptr;
407  g_clear_object(&self->text_input_handler);
408  self->text_input_handler = fl_text_input_handler_new(self->binary_messenger);
409  if (widget != nullptr) {
410  fl_text_input_handler_set_widget(self->text_input_handler, widget);
411  }
412 }
FlKeyboardHandler * fl_keyboard_handler_new(FlBinaryMessenger *messenger, FlKeyboardManager *keyboard_manager)
FlTextInputHandler * fl_text_input_handler_new(FlBinaryMessenger *messenger)
void fl_text_input_handler_set_widget(FlTextInputHandler *self, GtkWidget *widget)
GtkWidget * fl_text_input_handler_get_widget(FlTextInputHandler *self)

References fl_keyboard_handler_new(), fl_keyboard_manager_new(), fl_text_input_handler_get_widget(), fl_text_input_handler_new(), and fl_text_input_handler_set_widget().

Referenced by fl_engine_on_pre_engine_restart_cb(), and fl_engine_start().

◆ setup_locales()

static void setup_locales ( FlEngine *  self)
static

Definition at line 200 of file fl_engine.cc.

200  {
201  const gchar* const* languages = g_get_language_names();
202  g_autoptr(GPtrArray) locales_array = g_ptr_array_new_with_free_func(
203  reinterpret_cast<GDestroyNotify>(free_locale));
204  for (int i = 0; languages[i] != nullptr; i++) {
205  g_autofree gchar* locale_string = g_strstrip(g_strdup(languages[i]));
206 
207  // Ignore empty locales, caused by settings like `LANGUAGE=pt_BR:`
208  if (strcmp(locale_string, "") == 0) {
209  continue;
210  }
211 
212  g_autofree gchar* language = nullptr;
213  g_autofree gchar* territory = nullptr;
214  parse_locale(locale_string, &language, &territory, nullptr, nullptr);
215 
216  // Ignore duplicate locales, caused by settings like `LANGUAGE=C` (returns
217  // two "C") or `LANGUAGE=en:en`
218  gboolean has_locale = FALSE;
219  for (guint j = 0; !has_locale && j < locales_array->len; j++) {
220  FlutterLocale* locale =
221  reinterpret_cast<FlutterLocale*>(g_ptr_array_index(locales_array, j));
222  has_locale = g_strcmp0(locale->language_code, language) == 0 &&
223  g_strcmp0(locale->country_code, territory) == 0;
224  }
225  if (has_locale) {
226  continue;
227  }
228 
229  FlutterLocale* locale =
230  static_cast<FlutterLocale*>(g_malloc0(sizeof(FlutterLocale)));
231  g_ptr_array_add(locales_array, locale);
232  locale->struct_size = sizeof(FlutterLocale);
233  locale->language_code =
234  reinterpret_cast<const gchar*>(g_steal_pointer(&language));
235  locale->country_code =
236  reinterpret_cast<const gchar*>(g_steal_pointer(&territory));
237  locale->script_code = nullptr;
238  locale->variant_code = nullptr;
239  }
240  FlutterLocale** locales =
241  reinterpret_cast<FlutterLocale**>(locales_array->pdata);
242  FlutterEngineResult result = self->embedder_api.UpdateLocales(
243  self->engine, const_cast<const FlutterLocale**>(locales),
244  locales_array->len);
245  if (result != kSuccess) {
246  g_warning("Failed to set up Flutter locales");
247  }
248 }
static void parse_locale(const gchar *locale, gchar **language, gchar **territory, gchar **codeset, gchar **modifier)
Definition: fl_engine.cc:128
static void free_locale(FlutterLocale *locale)
Definition: fl_engine.cc:193

References free_locale(), i, and parse_locale().

Referenced by fl_engine_start().

◆ view_added_cb()

static void view_added_cb ( const FlutterAddViewResult *  result)
static

Definition at line 171 of file fl_engine.cc.

171  {
172  g_autoptr(GTask) task = G_TASK(result->user_data);
173 
174  if (result->added) {
175  g_task_return_boolean(task, TRUE);
176  } else {
177  g_task_return_new_error(task, fl_engine_error_quark(),
178  FL_ENGINE_ERROR_FAILED, "Failed to add view");
179  }
180 }

References FL_ENGINE_ERROR_FAILED, fl_engine_error_quark(), and TRUE.

Referenced by fl_engine_add_view().

◆ view_removed_cb()

static void view_removed_cb ( const FlutterRemoveViewResult *  result)
static

Definition at line 182 of file fl_engine.cc.

182  {
183  g_autoptr(GTask) task = G_TASK(result->user_data);
184 
185  if (result->removed) {
186  g_task_return_boolean(task, TRUE);
187  } else {
188  g_task_return_new_error(task, fl_engine_error_quark(),
189  FL_ENGINE_ERROR_FAILED, "Failed to remove view");
190  }
191 }

References FL_ENGINE_ERROR_FAILED, fl_engine_error_quark(), and TRUE.

Referenced by fl_engine_remove_view().

Variable Documentation

◆ fl_engine_signals

guint fl_engine_signals[LAST_SIGNAL]
static

◆ kMousePointerDeviceId

constexpr int32_t kMousePointerDeviceId = 0
staticconstexpr

Definition at line 36 of file fl_engine.cc.

Referenced by fl_engine_send_mouse_pointer_event().

◆ kPlatformTaskRunnerIdentifier

constexpr size_t kPlatformTaskRunnerIdentifier = 1
staticconstexpr

Definition at line 32 of file fl_engine.cc.

Referenced by fl_engine_start().

◆ kPointerPanZoomDeviceId

constexpr int32_t kPointerPanZoomDeviceId = 1
staticconstexpr

Definition at line 37 of file fl_engine.cc.

Referenced by fl_engine_send_pointer_pan_zoom_event().