Flutter Linux Embedder
fl_engine.cc
Go to the documentation of this file.
1 // Copyright 2013 The Flutter Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 
6 
7 #include <epoxy/egl.h>
8 #include <gmodule.h>
9 
10 #include <cstring>
11 
12 #include "flutter/common/constants.h"
14 #include "flutter/shell/platform/embedder/embedder.h"
30 
31 // Unique number associated with platform tasks.
32 static constexpr size_t kPlatformTaskRunnerIdentifier = 1;
33 
34 // Use different device ID for mouse and pan/zoom events, since we can't
35 // differentiate the actual device (mouse v.s. trackpad)
36 static constexpr int32_t kMousePointerDeviceId = 0;
37 static constexpr int32_t kPointerPanZoomDeviceId = 1;
38 
39 struct _FlEngine {
40  GObject parent_instance;
41 
42  // Thread the GLib main loop is running on.
43  GThread* thread;
44 
45  // The project this engine is running.
46  FlDartProject* project;
47 
48  // Watches for monitors changes to update engine.
49  FlDisplayMonitor* display_monitor;
50 
51  // Type of rendering performed.
52  FlutterRendererType renderer_type;
53 
54  // Manages OpenGL contexts.
55  FlOpenGLManager* opengl_manager;
56 
57  // Messenger used to send and receive platform messages.
58  FlBinaryMessenger* binary_messenger;
59 
60  // Implements the flutter/settings channel.
61  FlSettingsHandler* settings_handler;
62 
63  // Implements the flutter/platform channel.
64  FlPlatformHandler* platform_handler;
65 
66  // Implements the flutter/windowing channel.
67  FlWindowingHandler* windowing_handler;
68 
69  // Process keyboard events.
70  FlKeyboardManager* keyboard_manager;
71 
72  // Implements the flutter/textinput channel.
73  FlTextInputHandler* text_input_handler;
74 
75  // Implements the flutter/keyboard channel.
76  FlKeyboardHandler* keyboard_handler;
77 
78  // Implements the flutter/mousecursor channel.
79  FlMouseCursorHandler* mouse_cursor_handler;
80 
81  // Manages textures rendered by native code.
82  FlTextureRegistrar* texture_registrar;
83 
84  // Schedules tasks to be run on the appropriate thread.
85  FlTaskRunner* task_runner;
86 
87  // Ahead of time data used to make engine run faster.
88  FlutterEngineAOTData aot_data;
89 
90  // The Flutter engine.
91  FLUTTER_API_SYMBOL(FlutterEngine) engine;
92 
93  // Function table for engine API, used to intercept engine calls for testing
94  // purposes.
95  FlutterEngineProcTable embedder_api;
96 
97  // Next ID to use for a view.
98  FlutterViewId next_view_id;
99 
100  // Objects rendering the views.
102 
103  // Function to call when a platform message is received.
107 };
108 
109 G_DEFINE_QUARK(fl_engine_error_quark, fl_engine_error)
110 
112  FlPluginRegistryInterface* iface);
113 
115 
117 
119  FlEngine,
120  fl_engine,
121  G_TYPE_OBJECT,
122  G_IMPLEMENT_INTERFACE(fl_plugin_registry_get_type(),
124 
125 enum { PROP_0, PROP_BINARY_MESSENGER, PROP_LAST };
126 
127 // Parse a locale into its components.
128 static void parse_locale(const gchar* locale,
129  gchar** language,
130  gchar** territory,
131  gchar** codeset,
132  gchar** modifier) {
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 }
170 
171 static void view_added_cb(const FlutterAddViewResult* result) {
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 }
181 
182 static void view_removed_cb(const FlutterRemoveViewResult* result) {
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 }
192 
193 static void free_locale(FlutterLocale* locale) {
194  free(const_cast<gchar*>(locale->language_code));
195  free(const_cast<gchar*>(locale->country_code));
196  free(locale);
197 }
198 
199 // Passes locale information to the Flutter engine.
200 static void setup_locales(FlEngine* self) {
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 }
249 
251  FlEngine* self,
252  const FlutterBackingStoreConfig* config,
253  FlutterBackingStore* backing_store_out) {
254  if (!fl_opengl_manager_make_current(self->opengl_manager)) {
255  return false;
256  }
257 
258  GLint sized_format = GL_RGBA8;
259  GLint general_format = GL_RGBA;
260  if (epoxy_has_gl_extension("GL_EXT_texture_format_BGRA8888")) {
261  sized_format = GL_BGRA8_EXT;
262  general_format = GL_BGRA_EXT;
263  }
264 
265  FlFramebuffer* framebuffer = fl_framebuffer_new(
266  general_format, config->size.width, config->size.height, FALSE);
267  if (!framebuffer) {
268  g_warning("Failed to create backing store");
269  return false;
270  }
271 
272  backing_store_out->type = kFlutterBackingStoreTypeOpenGL;
273  backing_store_out->open_gl.type = kFlutterOpenGLTargetTypeFramebuffer;
274  backing_store_out->open_gl.framebuffer.user_data = framebuffer;
275  backing_store_out->open_gl.framebuffer.name =
276  fl_framebuffer_get_id(framebuffer);
277  backing_store_out->open_gl.framebuffer.target = sized_format;
278  backing_store_out->open_gl.framebuffer.destruction_callback = [](void* p) {
279  // Backing store destroyed in fl_compositor_opengl_collect_backing_store(),
280  // set on FlutterCompositor.collect_backing_store_callback during engine
281  // start.
282  };
283 
284  return true;
285 }
286 
288  FlEngine* self,
289  const FlutterBackingStore* backing_store) {
290  if (!fl_opengl_manager_make_current(self->opengl_manager)) {
291  return false;
292  }
293 
294  // OpenGL context is required when destroying #FlFramebuffer.
295  g_object_unref(backing_store->open_gl.framebuffer.user_data);
296  return true;
297 }
298 
300  FlEngine* self,
301  const FlutterBackingStoreConfig* config,
302  FlutterBackingStore* backing_store_out) {
303  size_t allocation_length = config->size.width * config->size.height * 4;
304  uint8_t* allocation = static_cast<uint8_t*>(malloc(allocation_length));
305  if (allocation == nullptr) {
306  return false;
307  }
308 
309  backing_store_out->type = kFlutterBackingStoreTypeSoftware;
310  backing_store_out->software.allocation = allocation;
311  backing_store_out->software.height = config->size.height;
312  backing_store_out->software.row_bytes = config->size.width * 4;
313  backing_store_out->software.user_data = nullptr;
314  backing_store_out->software.destruction_callback = [](void* p) {
315  // Backing store destroyed in
316  // fl_compositor_software_collect_backing_store(), set on
317  // FlutterCompositor.collect_backing_store_callback during engine start.
318  };
319 
320  return true;
321 }
322 
324  FlEngine* self,
325  const FlutterBackingStore* backing_store) {
326  free(const_cast<void*>(backing_store->software.allocation));
327  return true;
328 }
329 
330 // Called when engine needs a backing store for a specific #FlutterLayer.
332  const FlutterBackingStoreConfig* config,
333  FlutterBackingStore* backing_store_out,
334  void* user_data) {
335  FlEngine* self = static_cast<FlEngine*>(user_data);
336  switch (self->renderer_type) {
337  case kOpenGL:
338  return create_opengl_backing_store(self, config, backing_store_out);
339  case kSoftware:
340  return create_software_backing_store(self, config, backing_store_out);
341  default:
342  return false;
343  }
344 }
345 
346 // Called when the backing store is to be released.
348  const FlutterBackingStore* backing_store,
349  void* user_data) {
350  FlEngine* self = static_cast<FlEngine*>(user_data);
351  switch (self->renderer_type) {
352  case kOpenGL:
353  return collect_opengl_backing_store(self, backing_store);
354  case kSoftware:
355  return collect_software_backing_store(self, backing_store);
356  default:
357  return false;
358  }
359 }
360 
361 // Called when embedder should composite contents of each layer onto the screen.
363  const FlutterPresentViewInfo* info) {
364  FlEngine* self = static_cast<FlEngine*>(info->user_data);
365 
366  GWeakRef* ref = static_cast<GWeakRef*>(g_hash_table_lookup(
367  self->renderables_by_view_id, GINT_TO_POINTER(info->view_id)));
368  if (ref == nullptr) {
369  return true;
370  }
371  g_autoptr(FlRenderable) renderable = FL_RENDERABLE(g_weak_ref_get(ref));
372  if (renderable == nullptr) {
373  return true;
374  }
375 
376  fl_renderable_present_layers(renderable, info->layers, info->layers_count);
377  return true;
378 }
379 
380 // Flutter engine rendering callbacks.
381 
382 static void* fl_engine_gl_proc_resolver(void* user_data, const char* name) {
383  return reinterpret_cast<void*>(eglGetProcAddress(name));
384 }
385 
387  FlEngine* self = static_cast<FlEngine*>(user_data);
388  return fl_opengl_manager_make_current(self->opengl_manager);
389 }
390 
392  FlEngine* self = static_cast<FlEngine*>(user_data);
393  return fl_opengl_manager_clear_current(self->opengl_manager);
394 }
395 
396 static uint32_t fl_engine_gl_get_fbo(void* user_data) {
397  // There is only one frame buffer object - always return that.
398  return 0;
399 }
400 
402  FlEngine* self = static_cast<FlEngine*>(user_data);
403  return fl_opengl_manager_make_resource_current(self->opengl_manager);
404 }
405 
406 // Called by the engine to retrieve an external texture.
408  void* user_data,
409  int64_t texture_id,
410  size_t width,
411  size_t height,
412  FlutterOpenGLTexture* opengl_texture) {
413  FlEngine* self = static_cast<FlEngine*>(user_data);
414  if (!self->texture_registrar) {
415  return false;
416  }
417 
418  FlTexture* texture =
419  fl_texture_registrar_lookup_texture(self->texture_registrar, texture_id);
420  if (texture == nullptr) {
421  g_warning("Unable to find texture %" G_GINT64_FORMAT, texture_id);
422  return false;
423  }
424 
425  gboolean result;
426  g_autoptr(GError) error = nullptr;
427  if (FL_IS_TEXTURE_GL(texture)) {
428  result = fl_texture_gl_populate(FL_TEXTURE_GL(texture), width, height,
429  opengl_texture, &error);
430  } else if (FL_IS_PIXEL_BUFFER_TEXTURE(texture)) {
431  result =
432  fl_pixel_buffer_texture_populate(FL_PIXEL_BUFFER_TEXTURE(texture),
433  width, height, opengl_texture, &error);
434  } else {
435  g_warning("Unsupported texture type %" G_GINT64_FORMAT, texture_id);
436  return false;
437  }
438 
439  if (!result) {
440  g_warning("%s", error->message);
441  return false;
442  }
443 
444  return true;
445 }
446 
447 // Called by the engine to determine if it is on the GTK thread.
449  FlEngine* self = static_cast<FlEngine*>(user_data);
450  return self->thread == g_thread_self();
451 }
452 
453 // Called when the engine has a task to perform in the GTK thread.
454 static void fl_engine_post_task(FlutterTask task,
455  uint64_t target_time_nanos,
456  void* user_data) {
457  FlEngine* self = static_cast<FlEngine*>(user_data);
458 
459  fl_task_runner_post_flutter_task(self->task_runner, task, target_time_nanos);
460 }
461 
462 // Called when a platform message is received from the engine.
463 static void fl_engine_platform_message_cb(const FlutterPlatformMessage* message,
464  void* user_data) {
465  FlEngine* self = FL_ENGINE(user_data);
466 
467  gboolean handled = FALSE;
468  if (self->platform_message_handler != nullptr) {
469  g_autoptr(GBytes) data =
470  g_bytes_new(message->message, message->message_size);
471  handled = self->platform_message_handler(
472  self, message->channel, data, message->response_handle,
473  self->platform_message_handler_data);
474  }
475 
476  if (!handled) {
477  fl_engine_send_platform_message_response(self, message->response_handle,
478  nullptr, nullptr);
479  }
480 }
481 
482 // Called when a semantic node update is received from the engine.
483 static void fl_engine_update_semantics_cb(const FlutterSemanticsUpdate2* update,
484  void* user_data) {
485  FlEngine* self = FL_ENGINE(user_data);
486 
488 }
489 
490 static void setup_keyboard(FlEngine* self) {
491  g_clear_object(&self->keyboard_manager);
492  self->keyboard_manager = fl_keyboard_manager_new(self);
493 
494  g_clear_object(&self->keyboard_handler);
495  self->keyboard_handler =
496  fl_keyboard_handler_new(self->binary_messenger, self->keyboard_manager);
497 
498  GtkWidget* widget =
499  self->text_input_handler != nullptr
500  ? fl_text_input_handler_get_widget(self->text_input_handler)
501  : nullptr;
502  g_clear_object(&self->text_input_handler);
503  self->text_input_handler = fl_text_input_handler_new(self->binary_messenger);
504  if (widget != nullptr) {
505  fl_text_input_handler_set_widget(self->text_input_handler, widget);
506  }
507 }
508 
509 // Called right before the engine is restarted.
510 //
511 // This method should reset states to as if the engine has just been started,
512 // which usually indicates the user has requested a hot restart (Shift-R in the
513 // Flutter CLI.)
515  FlEngine* self = FL_ENGINE(user_data);
516 
517  setup_keyboard(self);
518 
520 }
521 
522 // Called when a response to a sent platform message is received from the
523 // engine.
524 static void fl_engine_platform_message_response_cb(const uint8_t* data,
525  size_t data_length,
526  void* user_data) {
527  g_autoptr(GTask) task = G_TASK(user_data);
528  g_task_return_pointer(task, g_bytes_new(data, data_length),
529  reinterpret_cast<GDestroyNotify>(g_bytes_unref));
530 }
531 
532 // Implements FlPluginRegistry::get_registrar_for_plugin.
533 static FlPluginRegistrar* fl_engine_get_registrar_for_plugin(
534  FlPluginRegistry* registry,
535  const gchar* name) {
536  FlEngine* self = FL_ENGINE(registry);
537 
538  return fl_plugin_registrar_new(nullptr, self->binary_messenger,
539  self->texture_registrar);
540 }
541 
543  FlPluginRegistryInterface* iface) {
544  iface->get_registrar_for_plugin = fl_engine_get_registrar_for_plugin;
545 }
546 
547 static void fl_engine_set_property(GObject* object,
548  guint prop_id,
549  const GValue* value,
550  GParamSpec* pspec) {
551  FlEngine* self = FL_ENGINE(object);
552  switch (prop_id) {
553  case PROP_BINARY_MESSENGER:
554  g_set_object(&self->binary_messenger,
555  FL_BINARY_MESSENGER(g_value_get_object(value)));
556  break;
557  default:
558  G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
559  break;
560  }
561 }
562 
563 static void fl_engine_dispose(GObject* object) {
564  FlEngine* self = FL_ENGINE(object);
565 
566  if (self->engine != nullptr) {
567  self->embedder_api.Shutdown(self->engine);
568  self->engine = nullptr;
569  }
570 
571  if (self->aot_data != nullptr) {
572  self->embedder_api.CollectAOTData(self->aot_data);
573  self->aot_data = nullptr;
574  }
575 
576  fl_binary_messenger_shutdown(self->binary_messenger);
577  fl_texture_registrar_shutdown(self->texture_registrar);
578 
579  g_clear_object(&self->project);
580  g_clear_object(&self->display_monitor);
581  g_clear_object(&self->opengl_manager);
582  g_clear_object(&self->texture_registrar);
583  g_clear_object(&self->binary_messenger);
584  g_clear_object(&self->settings_handler);
585  g_clear_object(&self->platform_handler);
586  g_clear_object(&self->windowing_handler);
587  g_clear_object(&self->keyboard_manager);
588  g_clear_object(&self->text_input_handler);
589  g_clear_object(&self->keyboard_handler);
590  g_clear_object(&self->mouse_cursor_handler);
591  g_clear_object(&self->task_runner);
592  g_clear_pointer(&self->renderables_by_view_id, g_hash_table_unref);
593 
594  if (self->platform_message_handler_destroy_notify) {
595  self->platform_message_handler_destroy_notify(
596  self->platform_message_handler_data);
597  }
598  self->platform_message_handler_data = nullptr;
599  self->platform_message_handler_destroy_notify = nullptr;
600 
601  G_OBJECT_CLASS(fl_engine_parent_class)->dispose(object);
602 }
603 
604 static void fl_engine_class_init(FlEngineClass* klass) {
605  G_OBJECT_CLASS(klass)->dispose = fl_engine_dispose;
606  G_OBJECT_CLASS(klass)->set_property = fl_engine_set_property;
607 
608  g_object_class_install_property(
609  G_OBJECT_CLASS(klass), PROP_BINARY_MESSENGER,
610  g_param_spec_object(
611  "binary-messenger", "messenger", "Binary messenger",
612  fl_binary_messenger_get_type(),
613  static_cast<GParamFlags>(G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY |
614  G_PARAM_STATIC_STRINGS)));
615 
617  "on-pre-engine-restart", fl_engine_get_type(), G_SIGNAL_RUN_LAST, 0,
618  nullptr, nullptr, nullptr, G_TYPE_NONE, 0);
620  "update-semantics", fl_engine_get_type(), G_SIGNAL_RUN_LAST, 0, nullptr,
621  nullptr, nullptr, G_TYPE_NONE, 1, G_TYPE_POINTER);
622 }
623 
624 static void fl_engine_init(FlEngine* self) {
625  self->thread = g_thread_self();
626 
627  self->embedder_api.struct_size = sizeof(FlutterEngineProcTable);
628  if (FlutterEngineGetProcAddresses(&self->embedder_api) != kSuccess) {
629  g_warning("Failed get get engine function pointers");
630  }
631 
632  self->opengl_manager = fl_opengl_manager_new();
633 
634  self->display_monitor =
635  fl_display_monitor_new(self, gdk_display_get_default());
636  self->task_runner = fl_task_runner_new(self);
637 
638  // Implicit view is 0, so start at 1.
639  self->next_view_id = 1;
640  self->renderables_by_view_id = g_hash_table_new_full(
641  g_direct_hash, g_direct_equal, nullptr, [](gpointer value) {
642  GWeakRef* ref = static_cast<GWeakRef*>(value);
643  g_weak_ref_clear(ref);
644  free(ref);
645  });
646 
647  self->texture_registrar = fl_texture_registrar_new(self);
648 }
649 
650 static FlEngine* fl_engine_new_full(FlDartProject* project,
651  FlBinaryMessenger* binary_messenger) {
652  g_return_val_if_fail(FL_IS_DART_PROJECT(project), nullptr);
653 
654  FlEngine* self = FL_ENGINE(g_object_new(fl_engine_get_type(), nullptr));
655 
656  self->project = FL_DART_PROJECT(g_object_ref(project));
657  const gchar* renderer = g_getenv("FLUTTER_LINUX_RENDERER");
658  if (g_strcmp0(renderer, "software") == 0) {
659  self->renderer_type = kSoftware;
660  g_warning(
661  "Using the software renderer. Not all features are supported. This is "
662  "not recommended.\n"
663  "\n"
664  "To switch back to the default renderer, unset the "
665  "FLUTTER_LINUX_RENDERER environment variable.");
666  } else {
667  if (renderer != nullptr && strcmp(renderer, "opengl") != 0) {
668  g_warning("Unknown renderer type '%s', defaulting to opengl", renderer);
669  }
670  self->renderer_type = kOpenGL;
671  }
672 
673  if (binary_messenger != nullptr) {
674  self->binary_messenger =
675  FL_BINARY_MESSENGER(g_object_ref(binary_messenger));
676  } else {
677  self->binary_messenger = fl_binary_messenger_new(self);
678  }
679  self->keyboard_manager = fl_keyboard_manager_new(self);
680  self->mouse_cursor_handler =
681  fl_mouse_cursor_handler_new(self->binary_messenger);
682  self->windowing_handler = fl_windowing_handler_new(self);
683 
684  return self;
685 }
686 
687 FlEngine* fl_engine_for_id(int64_t id) {
688  void* engine = reinterpret_cast<void*>(id);
689  g_return_val_if_fail(FL_IS_ENGINE(engine), nullptr);
690  return FL_ENGINE(engine);
691 }
692 
693 G_MODULE_EXPORT FlEngine* fl_engine_new(FlDartProject* project) {
694  return fl_engine_new_full(project, nullptr);
695 }
696 
698  FlBinaryMessenger* binary_messenger) {
699  g_autoptr(FlDartProject) project = fl_dart_project_new();
700  return fl_engine_new_full(project, binary_messenger);
701 }
702 
703 G_MODULE_EXPORT FlEngine* fl_engine_new_headless(FlDartProject* project) {
704  return fl_engine_new(project);
705 }
706 
707 FlutterRendererType fl_engine_get_renderer_type(FlEngine* self) {
708  g_return_val_if_fail(FL_IS_ENGINE(self), static_cast<FlutterRendererType>(0));
709  return self->renderer_type;
710 }
711 
712 FlOpenGLManager* fl_engine_get_opengl_manager(FlEngine* self) {
713  g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
714  return self->opengl_manager;
715 }
716 
717 FlDisplayMonitor* fl_engine_get_display_monitor(FlEngine* self) {
718  g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
719  return self->display_monitor;
720 }
721 
722 gboolean fl_engine_start(FlEngine* self, GError** error) {
723  g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
724 
725  FlutterRendererConfig config = {};
726  config.type = self->renderer_type;
727  switch (config.type) {
728  case kSoftware:
729  config.software.struct_size = sizeof(FlutterSoftwareRendererConfig);
730  // No action required, as this is handled in
731  // compositor_present_view_callback.
732  config.software.surface_present_callback =
733  [](void* user_data, const void* allocation, size_t row_bytes,
734  size_t height) { return true; };
735  break;
736  case kOpenGL:
737  config.open_gl.struct_size = sizeof(FlutterOpenGLRendererConfig);
738  config.open_gl.gl_proc_resolver = fl_engine_gl_proc_resolver;
739  config.open_gl.make_current = fl_engine_gl_make_current;
740  config.open_gl.clear_current = fl_engine_gl_clear_current;
741  config.open_gl.fbo_callback = fl_engine_gl_get_fbo;
742  // No action required, as this is handled in
743  // compositor_present_view_callback.
744  config.open_gl.present = [](void* user_data) { return true; };
745  config.open_gl.make_resource_current = fl_engine_gl_make_resource_current;
746  config.open_gl.gl_external_texture_frame_callback =
748  break;
749  case kMetal:
750  case kVulkan:
751  default:
753  "Unsupported renderer type");
754  return FALSE;
755  }
756 
757  FlutterTaskRunnerDescription platform_task_runner = {};
758  platform_task_runner.struct_size = sizeof(FlutterTaskRunnerDescription);
759  platform_task_runner.user_data = self;
760  platform_task_runner.runs_task_on_current_thread_callback =
762  platform_task_runner.post_task_callback = fl_engine_post_task;
763  platform_task_runner.identifier = kPlatformTaskRunnerIdentifier;
764 
765  FlutterCustomTaskRunners custom_task_runners = {};
766  custom_task_runners.struct_size = sizeof(FlutterCustomTaskRunners);
767  custom_task_runners.platform_task_runner = &platform_task_runner;
768 
769  if (fl_dart_project_get_ui_thread_policy(self->project) ==
771  custom_task_runners.ui_task_runner = &platform_task_runner;
772  }
773 
774  g_autoptr(GPtrArray) command_line_args =
775  g_ptr_array_new_with_free_func(g_free);
776  g_ptr_array_insert(command_line_args, 0, g_strdup("flutter"));
777  for (const auto& env_switch : flutter::GetSwitchesFromEnvironment()) {
778  g_ptr_array_add(command_line_args, g_strdup(env_switch.c_str()));
779  }
780 
781  gchar** dart_entrypoint_args =
783 
784  FlutterProjectArgs args = {};
785  args.struct_size = sizeof(FlutterProjectArgs);
786  args.assets_path = fl_dart_project_get_assets_path(self->project);
787  args.icu_data_path = fl_dart_project_get_icu_data_path(self->project);
788  args.command_line_argc = command_line_args->len;
789  args.command_line_argv =
790  reinterpret_cast<const char* const*>(command_line_args->pdata);
791  args.platform_message_callback = fl_engine_platform_message_cb;
792  args.update_semantics_callback2 = fl_engine_update_semantics_cb;
793  args.custom_task_runners = &custom_task_runners;
794  args.shutdown_dart_vm_when_done = true;
795  args.on_pre_engine_restart_callback = fl_engine_on_pre_engine_restart_cb;
796  args.dart_entrypoint_argc =
797  dart_entrypoint_args != nullptr ? g_strv_length(dart_entrypoint_args) : 0;
798  args.dart_entrypoint_argv =
799  reinterpret_cast<const char* const*>(dart_entrypoint_args);
800  args.engine_id = reinterpret_cast<int64_t>(self);
801 
802  FlutterCompositor compositor = {};
803  compositor.struct_size = sizeof(FlutterCompositor);
804  compositor.user_data = self;
805  compositor.create_backing_store_callback =
807  compositor.collect_backing_store_callback =
809  compositor.present_view_callback = compositor_present_view_callback;
810  args.compositor = &compositor;
811 
812  if (self->embedder_api.RunsAOTCompiledDartCode()) {
813  FlutterEngineAOTDataSource source = {};
814  source.type = kFlutterEngineAOTDataSourceTypeElfPath;
815  source.elf_path = fl_dart_project_get_aot_library_path(self->project);
816  if (self->embedder_api.CreateAOTData(&source, &self->aot_data) !=
817  kSuccess) {
819  "Failed to create AOT data");
820  return FALSE;
821  }
822  args.aot_data = self->aot_data;
823  }
824 
825  FlutterEngineResult result = self->embedder_api.Initialize(
826  FLUTTER_ENGINE_VERSION, &config, &args, self, &self->engine);
827  if (result != kSuccess) {
829  "Failed to initialize Flutter engine");
830  return FALSE;
831  }
832 
833  result = self->embedder_api.RunInitialized(self->engine);
834  if (result != kSuccess) {
836  "Failed to run Flutter engine");
837  return FALSE;
838  }
839 
840  setup_locales(self);
841 
842  g_autoptr(FlSettings) settings = fl_settings_new();
843  self->settings_handler = fl_settings_handler_new(self);
844  fl_settings_handler_start(self->settings_handler, settings);
845 
846  self->platform_handler = fl_platform_handler_new(self->binary_messenger);
847 
848  setup_keyboard(self);
849 
850  result = self->embedder_api.UpdateSemanticsEnabled(self->engine, TRUE);
851  if (result != kSuccess) {
852  g_warning("Failed to enable accessibility features on Flutter engine");
853  }
854 
855  fl_display_monitor_start(self->display_monitor);
856 
857  return TRUE;
858 }
859 
860 FlutterEngineProcTable* fl_engine_get_embedder_api(FlEngine* self) {
861  return &(self->embedder_api);
862 }
863 
865  const FlutterEngineDisplay* displays,
866  size_t displays_length) {
867  g_return_if_fail(FL_IS_ENGINE(self));
868 
869  FlutterEngineResult result = self->embedder_api.NotifyDisplayUpdate(
870  self->engine, kFlutterEngineDisplaysUpdateTypeStartup, displays,
871  displays_length);
872  if (result != kSuccess) {
873  g_warning("Failed to notify display update to Flutter engine: %d", result);
874  }
875 }
876 
877 void fl_engine_set_implicit_view(FlEngine* self, FlRenderable* renderable) {
878  GWeakRef* ref = g_new(GWeakRef, 1);
879  g_weak_ref_init(ref, G_OBJECT(renderable));
880  g_hash_table_insert(self->renderables_by_view_id,
881  GINT_TO_POINTER(flutter::kFlutterImplicitViewId), ref);
882 }
883 
884 FlutterViewId fl_engine_add_view(FlEngine* self,
885  FlRenderable* renderable,
886  size_t width,
887  size_t height,
888  double pixel_ratio,
889  GCancellable* cancellable,
890  GAsyncReadyCallback callback,
891  gpointer user_data) {
892  g_return_val_if_fail(FL_IS_ENGINE(self), -1);
893 
894  g_autoptr(GTask) task = g_task_new(self, cancellable, callback, user_data);
895 
896  FlutterViewId view_id = self->next_view_id;
897  self->next_view_id++;
898 
899  GWeakRef* ref = g_new(GWeakRef, 1);
900  g_weak_ref_init(ref, G_OBJECT(renderable));
901  g_hash_table_insert(self->renderables_by_view_id, GINT_TO_POINTER(view_id),
902  ref);
903 
904  // We don't know which display this view will open on, so set to zero and this
905  // will be updated in a following FlutterWindowMetricsEvent
906  FlutterEngineDisplayId display_id = 0;
907 
908  FlutterWindowMetricsEvent metrics = {};
909  metrics.struct_size = sizeof(FlutterWindowMetricsEvent);
910  metrics.width = width;
911  metrics.height = height;
912  metrics.pixel_ratio = pixel_ratio;
913  metrics.display_id = display_id;
914  metrics.view_id = view_id;
915  FlutterAddViewInfo info;
916  info.struct_size = sizeof(FlutterAddViewInfo);
917  info.view_id = view_id;
918  info.view_metrics = &metrics;
919  info.user_data = g_object_ref(task);
920  info.add_view_callback = view_added_cb;
921  FlutterEngineResult result = self->embedder_api.AddView(self->engine, &info);
922  if (result != kSuccess) {
923  g_task_return_new_error(task, fl_engine_error_quark(),
924  FL_ENGINE_ERROR_FAILED, "AddView returned %d",
925  result);
926  // This would have been done in the callback, but that won't occur now.
927  g_object_unref(task);
928  }
929 
930  return view_id;
931 }
932 
933 gboolean fl_engine_add_view_finish(FlEngine* self,
934  GAsyncResult* result,
935  GError** error) {
936  g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
937  return g_task_propagate_boolean(G_TASK(result), error);
938 }
939 
940 FlRenderable* fl_engine_get_renderable(FlEngine* self, FlutterViewId view_id) {
941  g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
942 
943  GWeakRef* ref = static_cast<GWeakRef*>(g_hash_table_lookup(
944  self->renderables_by_view_id, GINT_TO_POINTER(view_id)));
945  return FL_RENDERABLE(g_weak_ref_get(ref));
946 }
947 
948 void fl_engine_remove_view(FlEngine* self,
949  FlutterViewId view_id,
950  GCancellable* cancellable,
951  GAsyncReadyCallback callback,
952  gpointer user_data) {
953  g_return_if_fail(FL_IS_ENGINE(self));
954 
955  g_hash_table_remove(self->renderables_by_view_id, GINT_TO_POINTER(view_id));
956 
957  g_autoptr(GTask) task = g_task_new(self, cancellable, callback, user_data);
958 
959  FlutterRemoveViewInfo info;
960  info.struct_size = sizeof(FlutterRemoveViewInfo);
961  info.view_id = view_id;
962  info.user_data = g_object_ref(task);
963  info.remove_view_callback = view_removed_cb;
964  FlutterEngineResult result =
965  self->embedder_api.RemoveView(self->engine, &info);
966  if (result != kSuccess) {
967  g_task_return_new_error(task, fl_engine_error_quark(),
968  FL_ENGINE_ERROR_FAILED, "RemoveView returned %d",
969  result);
970  // This would have been done in the callback, but that won't occur now.
971  g_object_unref(task);
972  }
973 }
974 
975 gboolean fl_engine_remove_view_finish(FlEngine* self,
976  GAsyncResult* result,
977  GError** error) {
978  g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
979  return g_task_propagate_boolean(G_TASK(result), error);
980 }
981 
983  FlEngine* self,
985  gpointer user_data,
986  GDestroyNotify destroy_notify) {
987  g_return_if_fail(FL_IS_ENGINE(self));
988  g_return_if_fail(handler != nullptr);
989 
990  if (self->platform_message_handler_destroy_notify) {
991  self->platform_message_handler_destroy_notify(
992  self->platform_message_handler_data);
993  }
994 
995  self->platform_message_handler = handler;
996  self->platform_message_handler_data = user_data;
997  self->platform_message_handler_destroy_notify = destroy_notify;
998 }
999 
1000 // Note: This function can be called from any thread.
1002  FlEngine* self,
1003  const FlutterPlatformMessageResponseHandle* handle,
1004  GBytes* response,
1005  GError** error) {
1006  g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
1007  g_return_val_if_fail(handle != nullptr, FALSE);
1008 
1009  if (self->engine == nullptr) {
1011  "No engine to send response to");
1012  return FALSE;
1013  }
1014 
1015  gsize data_length = 0;
1016  const uint8_t* data = nullptr;
1017  if (response != nullptr) {
1018  data =
1019  static_cast<const uint8_t*>(g_bytes_get_data(response, &data_length));
1020  }
1021  FlutterEngineResult result = self->embedder_api.SendPlatformMessageResponse(
1022  self->engine, handle, data, data_length);
1023 
1024  if (result != kSuccess) {
1026  "Failed to send platform message response");
1027  return FALSE;
1028  }
1029 
1030  return TRUE;
1031 }
1032 
1034  const gchar* channel,
1035  GBytes* message,
1036  GCancellable* cancellable,
1037  GAsyncReadyCallback callback,
1038  gpointer user_data) {
1039  g_return_if_fail(FL_IS_ENGINE(self));
1040 
1041  GTask* task = nullptr;
1042  FlutterPlatformMessageResponseHandle* response_handle = nullptr;
1043  if (callback != nullptr) {
1044  task = g_task_new(self, cancellable, callback, user_data);
1045 
1046  if (self->engine == nullptr) {
1047  g_task_return_new_error(task, fl_engine_error_quark(),
1048  FL_ENGINE_ERROR_FAILED, "No engine to send to");
1049  return;
1050  }
1051 
1052  FlutterEngineResult result =
1053  self->embedder_api.PlatformMessageCreateResponseHandle(
1054  self->engine, fl_engine_platform_message_response_cb, task,
1055  &response_handle);
1056  if (result != kSuccess) {
1057  g_task_return_new_error(task, fl_engine_error_quark(),
1059  "Failed to create response handle");
1060  g_object_unref(task);
1061  return;
1062  }
1063  } else if (self->engine == nullptr) {
1064  return;
1065  }
1066 
1067  FlutterPlatformMessage fl_message = {};
1068  fl_message.struct_size = sizeof(fl_message);
1069  fl_message.channel = channel;
1070  fl_message.message =
1071  message != nullptr
1072  ? static_cast<const uint8_t*>(g_bytes_get_data(message, nullptr))
1073  : nullptr;
1074  fl_message.message_size = message != nullptr ? g_bytes_get_size(message) : 0;
1075  fl_message.response_handle = response_handle;
1076  FlutterEngineResult result =
1077  self->embedder_api.SendPlatformMessage(self->engine, &fl_message);
1078 
1079  if (result != kSuccess && task != nullptr) {
1080  g_task_return_new_error(task, fl_engine_error_quark(),
1082  "Failed to send platform messages");
1083  g_object_unref(task);
1084  }
1085 
1086  if (response_handle != nullptr) {
1087  self->embedder_api.PlatformMessageReleaseResponseHandle(self->engine,
1088  response_handle);
1089  }
1090 }
1091 
1093  GAsyncResult* result,
1094  GError** error) {
1095  g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
1096  g_return_val_if_fail(g_task_is_valid(result, self), FALSE);
1097 
1098  return static_cast<GBytes*>(g_task_propagate_pointer(G_TASK(result), error));
1099 }
1100 
1102  FlutterEngineDisplayId display_id,
1103  FlutterViewId view_id,
1104  size_t width,
1105  size_t height,
1106  double pixel_ratio) {
1107  g_return_if_fail(FL_IS_ENGINE(self));
1108 
1109  if (self->engine == nullptr) {
1110  return;
1111  }
1112 
1113  FlutterWindowMetricsEvent event = {};
1114  event.struct_size = sizeof(FlutterWindowMetricsEvent);
1115  event.width = width;
1116  event.height = height;
1117  event.pixel_ratio = pixel_ratio;
1118  event.display_id = display_id;
1119  event.view_id = view_id;
1120  self->embedder_api.SendWindowMetricsEvent(self->engine, &event);
1121 }
1122 
1124  FlutterViewId view_id,
1125  FlutterPointerPhase phase,
1126  size_t timestamp,
1127  double x,
1128  double y,
1129  FlutterPointerDeviceKind device_kind,
1130  double scroll_delta_x,
1131  double scroll_delta_y,
1132  int64_t buttons) {
1133  g_return_if_fail(FL_IS_ENGINE(self));
1134 
1135  if (self->engine == nullptr) {
1136  return;
1137  }
1138 
1139  FlutterPointerEvent fl_event = {};
1140  fl_event.struct_size = sizeof(fl_event);
1141  fl_event.phase = phase;
1142  fl_event.timestamp = timestamp;
1143  fl_event.x = x;
1144  fl_event.y = y;
1145  if (scroll_delta_x != 0 || scroll_delta_y != 0) {
1146  fl_event.signal_kind = kFlutterPointerSignalKindScroll;
1147  }
1148  fl_event.scroll_delta_x = scroll_delta_x;
1149  fl_event.scroll_delta_y = scroll_delta_y;
1150  fl_event.device_kind = device_kind;
1151  fl_event.buttons = buttons;
1152  fl_event.device = kMousePointerDeviceId;
1153  fl_event.view_id = view_id;
1154  self->embedder_api.SendPointerEvent(self->engine, &fl_event, 1);
1155 }
1156 
1157 void fl_engine_send_touch_up_event(FlEngine* self,
1158  FlutterViewId view_id,
1159  size_t timestamp,
1160  double x,
1161  double y,
1162  int32_t device) {
1163  g_return_if_fail(FL_IS_ENGINE(self));
1164 
1165  if (self->engine == nullptr) {
1166  return;
1167  }
1168 
1169  FlutterPointerEvent event;
1170  event.timestamp = timestamp;
1171  event.x = x;
1172  event.y = y;
1173  event.device_kind = kFlutterPointerDeviceKindTouch;
1174  event.device = device;
1175  event.buttons = 0;
1176  event.view_id = view_id;
1177  event.phase = FlutterPointerPhase::kUp;
1178  event.struct_size = sizeof(event);
1179 
1180  self->embedder_api.SendPointerEvent(self->engine, &event, 1);
1181 }
1182 
1184  FlutterViewId view_id,
1185  size_t timestamp,
1186  double x,
1187  double y,
1188  int32_t device) {
1189  g_return_if_fail(FL_IS_ENGINE(self));
1190 
1191  if (self->engine == nullptr) {
1192  return;
1193  }
1194 
1195  FlutterPointerEvent event;
1196  event.timestamp = timestamp;
1197  event.x = x;
1198  event.y = y;
1199  event.device_kind = kFlutterPointerDeviceKindTouch;
1200  event.device = device;
1201  event.buttons = FlutterPointerMouseButtons::kFlutterPointerButtonMousePrimary;
1202  event.view_id = view_id;
1203  event.phase = FlutterPointerPhase::kDown;
1204  event.struct_size = sizeof(event);
1205 
1206  self->embedder_api.SendPointerEvent(self->engine, &event, 1);
1207 }
1208 
1210  FlutterViewId view_id,
1211  size_t timestamp,
1212  double x,
1213  double y,
1214  int32_t device) {
1215  g_return_if_fail(FL_IS_ENGINE(self));
1216 
1217  if (self->engine == nullptr) {
1218  return;
1219  }
1220 
1221  FlutterPointerEvent event;
1222  event.timestamp = timestamp;
1223  event.x = x;
1224  event.y = y;
1225  event.device_kind = kFlutterPointerDeviceKindTouch;
1226  event.device = device;
1227  event.buttons = FlutterPointerMouseButtons::kFlutterPointerButtonMousePrimary;
1228  event.view_id = view_id;
1229  event.phase = FlutterPointerPhase::kMove;
1230  event.struct_size = sizeof(event);
1231 
1232  self->embedder_api.SendPointerEvent(self->engine, &event, 1);
1233 }
1234 
1236  FlutterViewId view_id,
1237  size_t timestamp,
1238  double x,
1239  double y,
1240  int32_t device) {
1241  g_return_if_fail(FL_IS_ENGINE(self));
1242 
1243  if (self->engine == nullptr) {
1244  return;
1245  }
1246 
1247  FlutterPointerEvent event;
1248  event.timestamp = timestamp;
1249  event.x = x;
1250  event.y = y;
1251  event.device_kind = kFlutterPointerDeviceKindTouch;
1252  event.device = device;
1253  event.buttons = 0;
1254  event.view_id = view_id;
1255  event.phase = FlutterPointerPhase::kAdd;
1256  event.struct_size = sizeof(event);
1257 
1258  self->embedder_api.SendPointerEvent(self->engine, &event, 1);
1259 }
1260 
1262  FlutterViewId view_id,
1263  size_t timestamp,
1264  double x,
1265  double y,
1266  int32_t device) {
1267  g_return_if_fail(FL_IS_ENGINE(self));
1268 
1269  if (self->engine == nullptr) {
1270  return;
1271  }
1272 
1273  FlutterPointerEvent event;
1274  event.timestamp = timestamp;
1275  event.x = x;
1276  event.y = y;
1277  event.device_kind = kFlutterPointerDeviceKindTouch;
1278  event.device = device;
1279  event.buttons = 0;
1280  event.view_id = view_id;
1281  event.phase = FlutterPointerPhase::kRemove;
1282  event.struct_size = sizeof(event);
1283 
1284  self->embedder_api.SendPointerEvent(self->engine, &event, 1);
1285 }
1286 
1288  FlutterViewId view_id,
1289  size_t timestamp,
1290  double x,
1291  double y,
1292  FlutterPointerPhase phase,
1293  double pan_x,
1294  double pan_y,
1295  double scale,
1296  double rotation) {
1297  g_return_if_fail(FL_IS_ENGINE(self));
1298 
1299  if (self->engine == nullptr) {
1300  return;
1301  }
1302 
1303  FlutterPointerEvent fl_event = {};
1304  fl_event.struct_size = sizeof(fl_event);
1305  fl_event.timestamp = timestamp;
1306  fl_event.x = x;
1307  fl_event.y = y;
1308  fl_event.phase = phase;
1309  fl_event.pan_x = pan_x;
1310  fl_event.pan_y = pan_y;
1311  fl_event.scale = scale;
1312  fl_event.rotation = rotation;
1313  fl_event.device = kPointerPanZoomDeviceId;
1314  fl_event.device_kind = kFlutterPointerDeviceKindTrackpad;
1315  fl_event.view_id = view_id;
1316  self->embedder_api.SendPointerEvent(self->engine, &fl_event, 1);
1317 }
1318 
1319 static void send_key_event_cb(bool handled, void* user_data) {
1320  g_autoptr(GTask) task = G_TASK(user_data);
1321  gboolean* return_value = g_new0(gboolean, 1);
1322  *return_value = handled;
1323  g_task_return_pointer(task, return_value, g_free);
1324 }
1325 
1326 void fl_engine_send_key_event(FlEngine* self,
1327  const FlutterKeyEvent* event,
1328  GCancellable* cancellable,
1329  GAsyncReadyCallback callback,
1330  gpointer user_data) {
1331  g_return_if_fail(FL_IS_ENGINE(self));
1332 
1333  g_autoptr(GTask) task = g_task_new(self, cancellable, callback, user_data);
1334 
1335  if (self->engine == nullptr) {
1336  g_task_return_new_error(task, fl_engine_error_quark(),
1337  FL_ENGINE_ERROR_FAILED, "No engine");
1338  return;
1339  }
1340 
1341  if (self->embedder_api.SendKeyEvent(self->engine, event, send_key_event_cb,
1342  g_object_ref(task)) != kSuccess) {
1343  g_task_return_new_error(task, fl_engine_error_quark(),
1344  FL_ENGINE_ERROR_FAILED, "Failed to send key event");
1345  g_object_unref(task);
1346  }
1347 }
1348 
1349 gboolean fl_engine_send_key_event_finish(FlEngine* self,
1350  GAsyncResult* result,
1351  gboolean* handled,
1352  GError** error) {
1353  g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
1354  g_return_val_if_fail(g_task_is_valid(result, self), FALSE);
1355 
1356  g_autofree gboolean* return_value =
1357  static_cast<gboolean*>(g_task_propagate_pointer(G_TASK(result), error));
1358  if (return_value == nullptr) {
1359  return FALSE;
1360  }
1361 
1362  *handled = *return_value;
1363  return TRUE;
1364 }
1365 
1367  FlutterViewId view_id,
1368  uint64_t node_id,
1369  FlutterSemanticsAction action,
1370  GBytes* data) {
1371  g_return_if_fail(FL_IS_ENGINE(self));
1372 
1373  if (self->engine == nullptr) {
1374  return;
1375  }
1376 
1377  const uint8_t* action_data = nullptr;
1378  size_t action_data_length = 0;
1379  if (data != nullptr) {
1380  action_data = static_cast<const uint8_t*>(
1381  g_bytes_get_data(data, &action_data_length));
1382  }
1383 
1384  FlutterSendSemanticsActionInfo info;
1385  info.struct_size = sizeof(FlutterSendSemanticsActionInfo);
1386  info.view_id = view_id;
1387  info.node_id = node_id;
1388  info.action = action;
1389  info.data = action_data;
1390  info.data_length = action_data_length;
1391  self->embedder_api.SendSemanticsAction(self->engine, &info);
1392 }
1393 
1395  int64_t texture_id) {
1396  g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
1397  return self->embedder_api.MarkExternalTextureFrameAvailable(
1398  self->engine, texture_id) == kSuccess;
1399 }
1400 
1401 gboolean fl_engine_register_external_texture(FlEngine* self,
1402  int64_t texture_id) {
1403  g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
1404  return self->embedder_api.RegisterExternalTexture(self->engine, texture_id) ==
1405  kSuccess;
1406 }
1407 
1409  int64_t texture_id) {
1410  g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
1411  return self->embedder_api.UnregisterExternalTexture(self->engine,
1412  texture_id) == kSuccess;
1413 }
1414 
1415 G_MODULE_EXPORT FlBinaryMessenger* fl_engine_get_binary_messenger(
1416  FlEngine* self) {
1417  g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
1418  return self->binary_messenger;
1419 }
1420 
1421 FlTaskRunner* fl_engine_get_task_runner(FlEngine* self) {
1422  g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
1423  return self->task_runner;
1424 }
1425 
1426 void fl_engine_execute_task(FlEngine* self, FlutterTask* task) {
1427  g_return_if_fail(FL_IS_ENGINE(self));
1428  self->embedder_api.RunTask(self->engine, task);
1429 }
1430 
1431 G_MODULE_EXPORT FlTextureRegistrar* fl_engine_get_texture_registrar(
1432  FlEngine* self) {
1433  g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
1434  return self->texture_registrar;
1435 }
1436 
1437 void fl_engine_update_accessibility_features(FlEngine* self, int32_t flags) {
1438  g_return_if_fail(FL_IS_ENGINE(self));
1439 
1440  if (self->engine == nullptr) {
1441  return;
1442  }
1443 
1444  self->embedder_api.UpdateAccessibilityFeatures(
1445  self->engine, static_cast<FlutterAccessibilityFeature>(flags));
1446 }
1447 
1448 void fl_engine_request_app_exit(FlEngine* self) {
1449  g_return_if_fail(FL_IS_ENGINE(self));
1450  fl_platform_handler_request_app_exit(self->platform_handler);
1451 }
1452 
1453 FlWindowingHandler* fl_engine_get_windowing_handler(FlEngine* self) {
1454  g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
1455  return self->windowing_handler;
1456 }
1457 
1458 FlKeyboardManager* fl_engine_get_keyboard_manager(FlEngine* self) {
1459  g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
1460  return self->keyboard_manager;
1461 }
1462 
1463 FlTextInputHandler* fl_engine_get_text_input_handler(FlEngine* self) {
1464  g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
1465  return self->text_input_handler;
1466 }
1467 
1468 FlMouseCursorHandler* fl_engine_get_mouse_cursor_handler(FlEngine* self) {
1469  g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
1470  return self->mouse_cursor_handler;
1471 }
@ PROP_LAST
@ PROP_0
FlutterSemanticsAction action
g_signal_emit(self, fl_application_signals[SIGNAL_CREATE_WINDOW], 0, view, &window)
G_DEFINE_QUARK(fl_binary_messenger_codec_error_quark, fl_binary_messenger_codec_error) G_DECLARE_FINAL_TYPE(FlBinaryMessengerImpl
FlBinaryMessenger * fl_binary_messenger_new(FlEngine *engine)
void fl_binary_messenger_shutdown(FlBinaryMessenger *self)
self height
g_autoptr(GMutexLocker) locker
self width
return TRUE
G_MODULE_EXPORT FlDartProject * fl_dart_project_new()
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)
G_MODULE_EXPORT FlUIThreadPolicy fl_dart_project_get_ui_thread_policy(FlDartProject *project)
@ FL_UI_THREAD_POLICY_RUN_ON_PLATFORM_THREAD
void fl_display_monitor_start(FlDisplayMonitor *self)
FlDisplayMonitor * fl_display_monitor_new(FlEngine *engine, GdkDisplay *display)
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:407
G_MODULE_EXPORT FlTextureRegistrar * fl_engine_get_texture_registrar(FlEngine *self)
Definition: fl_engine.cc:1431
FlMouseCursorHandler * fl_engine_get_mouse_cursor_handler(FlEngine *self)
Definition: fl_engine.cc:1468
static bool fl_engine_runs_task_on_current_thread(void *user_data)
Definition: fl_engine.cc:448
static void fl_engine_on_pre_engine_restart_cb(void *user_data)
Definition: fl_engine.cc:514
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)
Definition: fl_engine.cc:1123
void fl_engine_set_platform_message_handler(FlEngine *self, FlEnginePlatformMessageHandler handler, gpointer user_data, GDestroyNotify destroy_notify)
Definition: fl_engine.cc:982
static FlPluginRegistrar * fl_engine_get_registrar_for_plugin(FlPluginRegistry *registry, const gchar *name)
Definition: fl_engine.cc:533
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
Definition: fl_engine.cc:118
static void view_added_cb(const FlutterAddViewResult *result)
Definition: fl_engine.cc:171
static bool compositor_create_backing_store_callback(const FlutterBackingStoreConfig *config, FlutterBackingStore *backing_store_out, void *user_data)
Definition: fl_engine.cc:331
static bool fl_engine_gl_make_current(void *user_data)
Definition: fl_engine.cc:386
gboolean fl_engine_send_key_event_finish(FlEngine *self, GAsyncResult *result, gboolean *handled, GError **error)
Definition: fl_engine.cc:1349
FlutterEngineProcTable * fl_engine_get_embedder_api(FlEngine *self)
Definition: fl_engine.cc:860
void fl_engine_dispatch_semantics_action(FlEngine *self, FlutterViewId view_id, uint64_t node_id, FlutterSemanticsAction action, GBytes *data)
Definition: fl_engine.cc:1366
static FlEngine * fl_engine_new_full(FlDartProject *project, FlBinaryMessenger *binary_messenger)
Definition: fl_engine.cc:650
static void parse_locale(const gchar *locale, gchar **language, gchar **territory, gchar **codeset, gchar **modifier)
Definition: fl_engine.cc:128
void fl_engine_send_touch_up_event(FlEngine *self, FlutterViewId view_id, size_t timestamp, double x, double y, int32_t device)
Definition: fl_engine.cc:1157
void fl_engine_notify_display_update(FlEngine *self, const FlutterEngineDisplay *displays, size_t displays_length)
Definition: fl_engine.cc:864
static bool collect_opengl_backing_store(FlEngine *self, const FlutterBackingStore *backing_store)
Definition: fl_engine.cc:287
static bool compositor_present_view_callback(const FlutterPresentViewInfo *info)
Definition: fl_engine.cc:362
FlOpenGLManager * fl_engine_get_opengl_manager(FlEngine *self)
Definition: fl_engine.cc:712
void fl_engine_send_window_metrics_event(FlEngine *self, FlutterEngineDisplayId display_id, FlutterViewId view_id, size_t width, size_t height, double pixel_ratio)
Definition: fl_engine.cc:1101
static bool compositor_collect_backing_store_callback(const FlutterBackingStore *backing_store, void *user_data)
Definition: fl_engine.cc:347
FlutterRendererType fl_engine_get_renderer_type(FlEngine *self)
Definition: fl_engine.cc:707
static void fl_engine_dispose(GObject *object)
Definition: fl_engine.cc:563
gboolean fl_engine_mark_texture_frame_available(FlEngine *self, int64_t texture_id)
Definition: fl_engine.cc:1394
FlWindowingHandler * fl_engine_get_windowing_handler(FlEngine *self)
Definition: fl_engine.cc:1453
static bool create_opengl_backing_store(FlEngine *self, const FlutterBackingStoreConfig *config, FlutterBackingStore *backing_store_out)
Definition: fl_engine.cc:250
gboolean fl_engine_remove_view_finish(FlEngine *self, GAsyncResult *result, GError **error)
Definition: fl_engine.cc:975
FlTaskRunner * fl_engine_get_task_runner(FlEngine *self)
Definition: fl_engine.cc:1421
FlKeyboardManager * fl_engine_get_keyboard_manager(FlEngine *self)
Definition: fl_engine.cc:1458
FlDisplayMonitor * fl_engine_get_display_monitor(FlEngine *self)
Definition: fl_engine.cc:717
FlRenderable * fl_engine_get_renderable(FlEngine *self, FlutterViewId view_id)
Definition: fl_engine.cc:940
static guint fl_engine_signals[LAST_SIGNAL]
Definition: fl_engine.cc:116
static void fl_engine_platform_message_response_cb(const uint8_t *data, size_t data_length, void *user_data)
Definition: fl_engine.cc:524
gboolean fl_engine_send_platform_message_response(FlEngine *self, const FlutterPlatformMessageResponseHandle *handle, GBytes *response, GError **error)
Definition: fl_engine.cc:1001
static void fl_engine_init(FlEngine *self)
Definition: fl_engine.cc:624
static void fl_engine_post_task(FlutterTask task, uint64_t target_time_nanos, void *user_data)
Definition: fl_engine.cc:454
FlTextInputHandler * fl_engine_get_text_input_handler(FlEngine *self)
Definition: fl_engine.cc:1463
void fl_engine_set_implicit_view(FlEngine *self, FlRenderable *renderable)
Definition: fl_engine.cc:877
static uint32_t fl_engine_gl_get_fbo(void *user_data)
Definition: fl_engine.cc:396
static void view_removed_cb(const FlutterRemoveViewResult *result)
Definition: fl_engine.cc:182
gboolean fl_engine_unregister_external_texture(FlEngine *self, int64_t texture_id)
Definition: fl_engine.cc:1408
void fl_engine_send_platform_message(FlEngine *self, const gchar *channel, GBytes *message, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data)
Definition: fl_engine.cc:1033
gboolean fl_engine_register_external_texture(FlEngine *self, int64_t texture_id)
Definition: fl_engine.cc:1401
FlEngine * fl_engine_for_id(int64_t id)
Definition: fl_engine.cc:687
static void * fl_engine_gl_proc_resolver(void *user_data, const char *name)
Definition: fl_engine.cc:382
void fl_engine_send_touch_move_event(FlEngine *self, FlutterViewId view_id, size_t timestamp, double x, double y, int32_t device)
Definition: fl_engine.cc:1209
static void fl_engine_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
Definition: fl_engine.cc:547
void fl_engine_send_touch_add_event(FlEngine *self, FlutterViewId view_id, size_t timestamp, double x, double y, int32_t device)
Definition: fl_engine.cc:1235
@ 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
void fl_engine_remove_view(FlEngine *self, FlutterViewId view_id, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data)
Definition: fl_engine.cc:948
G_MODULE_EXPORT FlBinaryMessenger * fl_engine_get_binary_messenger(FlEngine *self)
Definition: fl_engine.cc:1415
gboolean fl_engine_add_view_finish(FlEngine *self, GAsyncResult *result, GError **error)
Definition: fl_engine.cc:933
void fl_engine_send_key_event(FlEngine *self, const FlutterKeyEvent *event, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data)
Definition: fl_engine.cc:1326
static void setup_keyboard(FlEngine *self)
Definition: fl_engine.cc:490
static void free_locale(FlutterLocale *locale)
Definition: fl_engine.cc:193
void fl_engine_request_app_exit(FlEngine *self)
Definition: fl_engine.cc:1448
static void setup_locales(FlEngine *self)
Definition: fl_engine.cc:200
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)
Definition: fl_engine.cc:1287
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)
Definition: fl_engine.cc:884
static void fl_engine_update_semantics_cb(const FlutterSemanticsUpdate2 *update, void *user_data)
Definition: fl_engine.cc:483
static bool fl_engine_gl_make_resource_current(void *user_data)
Definition: fl_engine.cc:401
G_MODULE_EXPORT FlEngine * fl_engine_new_headless(FlDartProject *project)
Definition: fl_engine.cc:703
void fl_engine_update_accessibility_features(FlEngine *self, int32_t flags)
Definition: fl_engine.cc:1437
static void fl_engine_platform_message_cb(const FlutterPlatformMessage *message, void *user_data)
Definition: fl_engine.cc:463
void fl_engine_send_touch_remove_event(FlEngine *self, FlutterViewId view_id, size_t timestamp, double x, double y, int32_t device)
Definition: fl_engine.cc:1261
void fl_engine_execute_task(FlEngine *self, FlutterTask *task)
Definition: fl_engine.cc:1426
void fl_engine_send_touch_down_event(FlEngine *self, FlutterViewId view_id, size_t timestamp, double x, double y, int32_t device)
Definition: fl_engine.cc:1183
gboolean fl_engine_start(FlEngine *self, GError **error)
Definition: fl_engine.cc:722
static void send_key_event_cb(bool handled, void *user_data)
Definition: fl_engine.cc:1319
static bool collect_software_backing_store(FlEngine *self, const FlutterBackingStore *backing_store)
Definition: fl_engine.cc:323
static constexpr size_t kPlatformTaskRunnerIdentifier
Definition: fl_engine.cc:32
FlEngine * fl_engine_new_with_binary_messenger(FlBinaryMessenger *binary_messenger)
Definition: fl_engine.cc:697
static constexpr int32_t kPointerPanZoomDeviceId
Definition: fl_engine.cc:37
G_MODULE_EXPORT FlEngine * fl_engine_new(FlDartProject *project)
Definition: fl_engine.cc:693
static constexpr int32_t kMousePointerDeviceId
Definition: fl_engine.cc:36
static void fl_engine_class_init(FlEngineClass *klass)
Definition: fl_engine.cc:604
static bool fl_engine_gl_clear_current(void *user_data)
Definition: fl_engine.cc:391
GBytes * fl_engine_send_platform_message_finish(FlEngine *self, GAsyncResult *result, GError **error)
Definition: fl_engine.cc:1092
static void fl_engine_plugin_registry_iface_init(FlPluginRegistryInterface *iface)
Definition: fl_engine.cc:542
static bool create_software_backing_store(FlEngine *self, const FlutterBackingStoreConfig *config, FlutterBackingStore *backing_store_out)
Definition: fl_engine.cc:299
GQuark fl_engine_error_quark(void) G_GNUC_CONST
@ FL_ENGINE_ERROR_FAILED
gboolean(* FlEnginePlatformMessageHandler)(FlEngine *engine, const gchar *channel, GBytes *message, const FlutterPlatformMessageResponseHandle *response_handle, gpointer user_data)
G_BEGIN_DECLS G_MODULE_EXPORT FlValue * args
G_BEGIN_DECLS G_MODULE_EXPORT FlValue gpointer user_data
GLuint fl_framebuffer_get_id(FlFramebuffer *self)
FlFramebuffer * fl_framebuffer_new(GLint format, size_t width, size_t height, gboolean shareable)
FlKeyboardHandler * fl_keyboard_handler_new(FlBinaryMessenger *messenger, FlKeyboardManager *keyboard_manager)
FlKeyboardManager * fl_keyboard_manager_new(FlEngine *engine)
FlMouseCursorHandler * fl_mouse_cursor_handler_new(FlBinaryMessenger *messenger)
FlOpenGLManager * fl_opengl_manager_new()
gboolean fl_opengl_manager_make_resource_current(FlOpenGLManager *self)
gboolean fl_opengl_manager_clear_current(FlOpenGLManager *self)
gboolean fl_opengl_manager_make_current(FlOpenGLManager *self)
int64_t id
gboolean fl_pixel_buffer_texture_populate(FlPixelBufferTexture *texture, uint32_t width, uint32_t height, FlutterOpenGLTexture *opengl_texture, GError **error)
const uint8_t uint32_t uint32_t GError ** error
FlPlatformHandler * fl_platform_handler_new(FlBinaryMessenger *messenger)
void fl_platform_handler_request_app_exit(FlPlatformHandler *self)
FlPluginRegistrar * fl_plugin_registrar_new(FlView *view, FlBinaryMessenger *messenger, FlTextureRegistrar *texture_registrar)
void fl_renderable_present_layers(FlRenderable *self, const FlutterLayer **layers, size_t layers_count)
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)
uint8_t value
guint prop_id
guint const GValue GParamSpec * pspec
void fl_task_runner_post_flutter_task(FlTaskRunner *self, FlutterTask task, uint64_t target_time_nanos)
FlTaskRunner * fl_task_runner_new(FlEngine *engine)
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)
gboolean fl_texture_gl_populate(FlTextureGL *self, uint32_t width, uint32_t height, FlutterOpenGLTexture *opengl_texture, GError **error)
void fl_texture_registrar_shutdown(FlTextureRegistrar *self)
FlTextureRegistrar * fl_texture_registrar_new(FlEngine *engine)
FlTexture * fl_texture_registrar_lookup_texture(FlTextureRegistrar *self, int64_t texture_id)
G_BEGIN_DECLS FlutterViewId view_id
FlWindowingHandler * fl_windowing_handler_new(FlEngine *engine)
std::vector< std::string > GetSwitchesFromEnvironment()
FlTaskRunner * task_runner
Definition: fl_engine.cc:85
FlEnginePlatformMessageHandler platform_message_handler
Definition: fl_engine.cc:104
FlMouseCursorHandler * mouse_cursor_handler
Definition: fl_engine.cc:79
GDestroyNotify platform_message_handler_destroy_notify
Definition: fl_engine.cc:106
FlutterViewId next_view_id
Definition: fl_engine.cc:98
FlSettingsHandler * settings_handler
Definition: fl_engine.cc:61
gpointer platform_message_handler_data
Definition: fl_engine.cc:105
FlOpenGLManager * opengl_manager
Definition: fl_engine.cc:55
GThread * thread
Definition: fl_engine.cc:43
FlPlatformHandler * platform_handler
Definition: fl_engine.cc:64
FLUTTER_API_SYMBOL(FlutterEngine) engine
FlutterRendererType renderer_type
Definition: fl_engine.cc:52
FlBinaryMessenger * binary_messenger
Definition: fl_engine.cc:58
FlDisplayMonitor * display_monitor
Definition: fl_engine.cc:49
GHashTable * renderables_by_view_id
Definition: fl_engine.cc:101
FlDartProject * project
Definition: fl_engine.cc:46
FlKeyboardManager * keyboard_manager
Definition: fl_engine.cc:70
FlWindowingHandler * windowing_handler
Definition: fl_engine.cc:67
GObject parent_instance
Definition: fl_engine.cc:40
FlTextureRegistrar * texture_registrar
Definition: fl_engine.cc:82
FlutterEngineAOTData aot_data
Definition: fl_engine.cc:88
FlutterEngineProcTable embedder_api
Definition: fl_engine.cc:95
FlTextInputHandler * text_input_handler
Definition: fl_engine.cc:73
FlKeyboardHandler * keyboard_handler
Definition: fl_engine.cc:76
int64_t texture_id