Flutter Linux Embedder
fl_view.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 <atk/atk.h>
8 #include <gdk/gdkwayland.h>
9 #include <gtk/gtk-a11y.h>
10 
11 #include <cstring>
12 
13 #include "flutter/common/constants.h"
30 
31 struct _FlView {
33 
34  // Event box the render area goes inside.
35  GtkWidget* event_box;
36 
37  // The widget rendering the Flutter view.
38  GtkDrawingArea* render_area;
39 
40  // Rendering context when using OpenGL.
41  GdkGLContext* render_context;
42 
43  // Engine this view is showing.
44  FlEngine* engine;
45 
46  // Combines layers into frame.
47  FlCompositor* compositor;
48 
49  // Signal subscription for engine restart signal.
51 
52  // Signal subscription for updating semantics signal.
54 
55  // ID for this view.
56  FlutterViewId view_id;
57 
58  // Background color.
59  GdkRGBA* background_color;
60 
61  // TRUE if have got the first frame to render.
62  gboolean have_first_frame;
63 
64  // Monitor to track window state.
65  FlWindowStateMonitor* window_state_monitor;
66 
67  // Manages scrolling events.
68  FlScrollingManager* scrolling_manager;
69 
70  // Manages pointer events.
71  FlPointerManager* pointer_manager;
72 
73  // Manages touch events.
74  FlTouchManager* touch_manager;
75 
76  // Accessible tree from Flutter, exposed as an AtkPlug.
77  FlViewAccessible* view_accessible;
78 
79  // Signal subscripton for cursor changes.
81 
82  // TRUE if the view size should be controlled by Flutter.
83  gboolean sized_to_content;
84 
85  GCancellable* cancellable;
86 };
87 
89 
91 
92 static void fl_renderable_iface_init(FlRenderableInterface* iface);
93 
95  FlPluginRegistryInterface* iface);
96 
98  FlView,
99  fl_view,
100  GTK_TYPE_BOX,
101  G_IMPLEMENT_INTERFACE(fl_renderable_get_type(), fl_renderable_iface_init)
102  G_IMPLEMENT_INTERFACE(fl_plugin_registry_get_type(),
104 
105 // Redraw the view from the GTK thread.
106 static gboolean redraw_cb(gpointer user_data) {
107  FlView* self = FL_VIEW(user_data);
108 
109  if (!self->have_first_frame) {
110  self->have_first_frame = TRUE;
111  g_signal_emit(self, fl_view_signals[SIGNAL_FIRST_FRAME], 0);
112  }
113 
114  // If Flutter is controlling the window size, then resize the view if
115  // necessary.
116  GtkAllocation allocation;
117  gtk_widget_get_allocation(GTK_WIDGET(self->render_area), &allocation);
118  gint scale_factor =
119  gtk_widget_get_scale_factor(GTK_WIDGET(self->render_area));
120  size_t width = allocation.width * scale_factor;
121  size_t height = allocation.height * scale_factor;
122  size_t frame_width, frame_height;
123  fl_compositor_get_frame_size(self->compositor, &frame_width, &frame_height);
124  gboolean frame_size_matches = width == frame_width && height == frame_height;
125  if (self->sized_to_content && !frame_size_matches) {
126  gtk_widget_set_size_request(GTK_WIDGET(self->render_area),
127  frame_width / scale_factor,
128  frame_height / scale_factor);
129  GtkWidget* toplevel =
130  gtk_widget_get_toplevel(GTK_WIDGET(self->render_area));
131  if (GTK_IS_WINDOW(toplevel)) {
132  // Resize to smallest size, so that the window will shrink to fit the new
133  // size of the render area.
134  gtk_window_resize(GTK_WINDOW(toplevel), 1, 1);
135  }
136  return G_SOURCE_REMOVE;
137  }
138 
139  gtk_widget_queue_draw(GTK_WIDGET(self->render_area));
140 
141  return G_SOURCE_REMOVE;
142 }
143 
144 // Signal handler for GtkWidget::delete-event
145 static gboolean window_delete_event_cb(FlView* self) {
146  fl_engine_request_app_exit(self->engine);
147  // Stop the event from propagating.
148  return TRUE;
149 }
150 
151 static void init_scrolling(FlView* self) {
152  g_clear_object(&self->scrolling_manager);
153  self->scrolling_manager =
154  fl_scrolling_manager_new(self->engine, self->view_id);
155 }
156 
157 static void init_touch(FlView* self) {
158  g_clear_object(&self->touch_manager);
159  self->touch_manager = fl_touch_manager_new(self->engine, self->view_id);
160 }
161 
162 static FlutterPointerDeviceKind get_pointer_device_kind(GdkEvent* event) {
163  GdkDevice* device = gdk_event_get_source_device(event);
164  if (device == nullptr) {
165  return kFlutterPointerDeviceKindMouse;
166  }
167 
168  GdkInputSource source = gdk_device_get_source(device);
169  switch (source) {
170  case GDK_SOURCE_PEN:
171  case GDK_SOURCE_ERASER:
172  case GDK_SOURCE_CURSOR:
173  case GDK_SOURCE_TABLET_PAD:
174  return kFlutterPointerDeviceKindStylus;
175  case GDK_SOURCE_TOUCHSCREEN:
176  return kFlutterPointerDeviceKindTouch;
177  case GDK_SOURCE_TOUCHPAD: // trackpad device type is reserved for gestures
178  case GDK_SOURCE_TRACKPOINT:
179  case GDK_SOURCE_KEYBOARD:
180  case GDK_SOURCE_MOUSE:
181  return kFlutterPointerDeviceKindMouse;
182  }
183 }
184 
185 // Called when the mouse cursor changes.
186 static void cursor_changed_cb(FlView* self) {
187  FlMouseCursorHandler* handler =
189  const gchar* cursor_name = fl_mouse_cursor_handler_get_cursor_name(handler);
190  GdkWindow* window =
191  gtk_widget_get_window(gtk_widget_get_toplevel(GTK_WIDGET(self)));
192  g_autoptr(GdkCursor) cursor =
193  gdk_cursor_new_from_name(gdk_window_get_display(window), cursor_name);
194  gdk_window_set_cursor(window, cursor);
195 }
196 
197 // Set the mouse cursor.
198 static void setup_cursor(FlView* self) {
199  FlMouseCursorHandler* handler =
201 
202  self->cursor_changed_cb_id = g_signal_connect_swapped(
203  handler, "cursor-changed", G_CALLBACK(cursor_changed_cb), self);
204  cursor_changed_cb(self);
205 }
206 
207 // Updates the engine with the current window metrics.
208 static void handle_geometry_changed(FlView* self) {
209  // No updates required when size controlled by Flutter.
210  if (self->sized_to_content) {
211  return;
212  }
213 
214  GtkAllocation allocation;
215  gtk_widget_get_allocation(GTK_WIDGET(self), &allocation);
216  gint scale_factor = gtk_widget_get_scale_factor(GTK_WIDGET(self));
217 
218  // Note we can't detect if a window is moved between monitors - this
219  // information is provided by Wayland but GTK only notifies us if the scale
220  // has changed, so moving between two monitors of the same scale doesn't
221  // provide any information.
222 
223  GdkWindow* window =
224  gtk_widget_get_window(gtk_widget_get_toplevel(GTK_WIDGET(self)));
225  // NOTE(robert-ancell) If we haven't got a window we default to display 0.
226  // This is probably indicating a problem with this code in that we
227  // shouldn't be generating anything until the window is created.
228  // Another event with the correct display ID is generated soon after.
229  // I haven't changed this code in case there are side-effects but we
230  // probably shouldn't call handle_geometry_changed after the view is
231  // added but only when the window is realized.
232  FlutterEngineDisplayId display_id = 0;
233  if (window != nullptr) {
234  GdkMonitor* monitor = gdk_display_get_monitor_at_window(
235  gtk_widget_get_display(GTK_WIDGET(self)), window);
237  fl_engine_get_display_monitor(self->engine), monitor);
238  }
239  size_t width = allocation.width, height = allocation.height;
240  size_t min_width = width, min_height = height;
241  size_t max_width = width, max_height = height;
243  self->engine, display_id, self->view_id, min_width * scale_factor,
244  min_height * scale_factor, max_width * scale_factor,
245  max_height * scale_factor, scale_factor);
246 }
247 
248 static void view_added_cb(GObject* object,
249  GAsyncResult* result,
250  gpointer user_data) {
251  g_autoptr(GError) error = nullptr;
252  if (!fl_engine_add_view_finish(FL_ENGINE(object), result, &error)) {
253  if (g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED)) {
254  return;
255  }
256 
257  g_warning("Failed to add view: %s", error->message);
258  // FIXME: Show on the GLArea
259  return;
260  }
261 }
262 
263 // Called when the engine updates accessibility.
264 static void update_semantics_cb(FlView* self,
265  const FlutterSemanticsUpdate2* update) {
266  // A semantics update is routed to a particular view.
267  if (update->view_id != self->view_id) {
268  return;
269  }
270 
271  fl_view_accessible_handle_update_semantics(self->view_accessible, update);
272 }
273 
274 // Invoked by the engine right before the engine is restarted.
275 //
276 // This method should reset states to be as if the engine had just been started,
277 // which usually indicates the user has requested a hot restart (Shift-R in the
278 // Flutter CLI.)
279 static void on_pre_engine_restart_cb(FlView* self) {
280  init_scrolling(self);
281  init_touch(self);
282 }
283 
284 // Implements FlRenderable::present_layers
285 static void fl_view_present_layers(FlRenderable* renderable,
286  const FlutterLayer** layers,
287  size_t layers_count) {
288  FlView* self = FL_VIEW(renderable);
289 
291 
292  // Perform the redraw in the GTK thead.
293  g_idle_add(redraw_cb, self);
294 }
295 
296 // Implements FlPluginRegistry::get_registrar_for_plugin.
297 static FlPluginRegistrar* fl_view_get_registrar_for_plugin(
298  FlPluginRegistry* registry,
299  const gchar* name) {
300  FlView* self = FL_VIEW(registry);
301 
302  return fl_plugin_registrar_new(self,
303  fl_engine_get_binary_messenger(self->engine),
304  fl_engine_get_texture_registrar(self->engine));
305 }
306 
307 static void fl_renderable_iface_init(FlRenderableInterface* iface) {
308  iface->present_layers = fl_view_present_layers;
309 }
310 
312  FlPluginRegistryInterface* iface) {
313  iface->get_registrar_for_plugin = fl_view_get_registrar_for_plugin;
314 }
315 
316 static void sync_modifier_if_needed(FlView* self, GdkEvent* event) {
317  guint event_time = gdk_event_get_time(event);
318  GdkModifierType event_state = static_cast<GdkModifierType>(0);
319  gdk_event_get_state(event, &event_state);
321  fl_engine_get_keyboard_manager(self->engine), event_state, event_time);
322 }
323 
324 static void set_scrolling_position(FlView* self, gdouble x, gdouble y) {
325  gint scale_factor = gtk_widget_get_scale_factor(GTK_WIDGET(self));
327  self->scrolling_manager, x * scale_factor, y * scale_factor);
328 }
329 
330 // Signal handler for GtkWidget::button-press-event
331 static gboolean button_press_event_cb(FlView* self,
332  GdkEventButton* button_event) {
333  GdkEvent* event = reinterpret_cast<GdkEvent*>(button_event);
334 
335  // Flutter doesn't handle double and triple click events.
336  GdkEventType event_type = gdk_event_get_event_type(event);
337  if (event_type == GDK_DOUBLE_BUTTON_PRESS ||
338  event_type == GDK_TRIPLE_BUTTON_PRESS) {
339  return FALSE;
340  }
341 
342  guint button = 0;
343  gdk_event_get_button(event, &button);
344 
345  gdouble x = 0.0, y = 0.0;
346  gdk_event_get_coords(event, &x, &y);
347 
348  set_scrolling_position(self, x, y);
349  sync_modifier_if_needed(self, event);
350 
351  gint scale_factor = gtk_widget_get_scale_factor(GTK_WIDGET(self));
353  self->pointer_manager, gdk_event_get_time(event),
354  get_pointer_device_kind(event), x * scale_factor, y * scale_factor,
355  button);
356 }
357 
358 // Signal handler for GtkWidget::button-release-event
359 static gboolean button_release_event_cb(FlView* self,
360  GdkEventButton* button_event) {
361  GdkEvent* event = reinterpret_cast<GdkEvent*>(button_event);
362 
363  guint button = 0;
364  gdk_event_get_button(event, &button);
365 
366  gdouble x = 0.0, y = 0.0;
367  gdk_event_get_coords(event, &x, &y);
368 
369  set_scrolling_position(self, x, y);
370  sync_modifier_if_needed(self, event);
371 
372  gint scale_factor = gtk_widget_get_scale_factor(GTK_WIDGET(self));
374  self->pointer_manager, gdk_event_get_time(event),
375  get_pointer_device_kind(event), x * scale_factor, y * scale_factor,
376  button);
377 }
378 
379 // Signal handler for GtkWidget::scroll-event
380 static gboolean scroll_event_cb(FlView* self, GdkEventScroll* event) {
381  // TODO(robert-ancell): Update to use GtkEventControllerScroll when we can
382  // depend on GTK 3.24.
383 
385  self->scrolling_manager, event,
386  gtk_widget_get_scale_factor(GTK_WIDGET(self)));
387  return TRUE;
388 }
389 
390 static gboolean touch_event_cb(FlView* self, GdkEventTouch* event) {
392  self->touch_manager, event,
393  gtk_widget_get_scale_factor(GTK_WIDGET(self)));
394  return TRUE;
395 }
396 
397 // Signal handler for GtkWidget::motion-notify-event
398 static gboolean motion_notify_event_cb(FlView* self,
399  GdkEventMotion* motion_event) {
400  GdkEvent* event = reinterpret_cast<GdkEvent*>(motion_event);
401  sync_modifier_if_needed(self, event);
402 
403  // return if touch event
404  auto event_type = gdk_event_get_event_type(event);
405  if (event_type == GDK_TOUCH_BEGIN || event_type == GDK_TOUCH_UPDATE ||
406  event_type == GDK_TOUCH_END || event_type == GDK_TOUCH_CANCEL) {
407  return FALSE;
408  }
409 
410  gdouble x = 0.0, y = 0.0;
411  gdk_event_get_coords(event, &x, &y);
412  gint scale_factor = gtk_widget_get_scale_factor(GTK_WIDGET(self));
414  self->pointer_manager, gdk_event_get_time(event),
415  get_pointer_device_kind(event), x * scale_factor, y * scale_factor);
416 }
417 
418 // Signal handler for GtkWidget::enter-notify-event
419 static gboolean enter_notify_event_cb(FlView* self,
420  GdkEventCrossing* crossing_event) {
421  GdkEvent* event = reinterpret_cast<GdkEvent*>(crossing_event);
422  gdouble x = 0.0, y = 0.0;
423  gdk_event_get_coords(event, &x, &y);
424  gint scale_factor = gtk_widget_get_scale_factor(GTK_WIDGET(self));
426  self->pointer_manager, gdk_event_get_time(event),
427  get_pointer_device_kind(event), x * scale_factor, y * scale_factor);
428 }
429 
430 // Signal handler for GtkWidget::leave-notify-event
431 static gboolean leave_notify_event_cb(FlView* self,
432  GdkEventCrossing* crossing_event) {
433  if (crossing_event->mode != GDK_CROSSING_NORMAL) {
434  return FALSE;
435  }
436 
437  GdkEvent* event = reinterpret_cast<GdkEvent*>(crossing_event);
438  gdouble x = 0.0, y = 0.0;
439  gdk_event_get_coords(event, &x, &y);
440  gint scale_factor = gtk_widget_get_scale_factor(GTK_WIDGET(self));
442  self->pointer_manager, gdk_event_get_time(event),
443  get_pointer_device_kind(event), x * scale_factor, y * scale_factor);
444 }
445 
446 static void gesture_rotation_begin_cb(FlView* self) {
447  fl_scrolling_manager_handle_rotation_begin(self->scrolling_manager);
448 }
449 
450 static void gesture_rotation_update_cb(FlView* self,
451  gdouble rotation,
452  gdouble delta) {
453  fl_scrolling_manager_handle_rotation_update(self->scrolling_manager,
454  rotation);
455 }
456 
457 static void gesture_rotation_end_cb(FlView* self) {
458  fl_scrolling_manager_handle_rotation_end(self->scrolling_manager);
459 }
460 
461 static void gesture_zoom_begin_cb(FlView* self) {
462  fl_scrolling_manager_handle_zoom_begin(self->scrolling_manager);
463 }
464 
465 static void gesture_zoom_update_cb(FlView* self, gdouble scale) {
466  fl_scrolling_manager_handle_zoom_update(self->scrolling_manager, scale);
467 }
468 
469 static void gesture_zoom_end_cb(FlView* self) {
470  fl_scrolling_manager_handle_zoom_end(self->scrolling_manager);
471 }
472 
473 static void setup_opengl(FlView* self) {
474  g_autoptr(GError) error = nullptr;
475 
476  self->render_context = gdk_window_create_gl_context(
477  gtk_widget_get_window(GTK_WIDGET(self->render_area)), &error);
478  if (self->render_context == nullptr) {
479  g_warning("Failed to create OpenGL context: %s", error->message);
480  return;
481  }
482 
483  if (!gdk_gl_context_realize(self->render_context, &error)) {
484  g_warning("Failed to realize OpenGL context: %s", error->message);
485  return;
486  }
487 
488  // If using Wayland, then EGL is in use and we can access the frame
489  // from the Flutter context using EGLImage. If not (i.e. X11 using GLX)
490  // then we have to copy the texture via the CPU.
491  gboolean shareable =
492  GDK_IS_WAYLAND_DISPLAY(gtk_widget_get_display(GTK_WIDGET(self)));
493  self->compositor = FL_COMPOSITOR(fl_compositor_opengl_new(
494  fl_engine_get_task_runner(self->engine),
495  fl_engine_get_opengl_manager(self->engine), shareable));
496 }
497 
498 static void setup_software(FlView* self) {
499  self->compositor = FL_COMPOSITOR(
501 }
502 
503 static void realize_cb(FlView* self) {
504  switch (fl_engine_get_renderer_type(self->engine)) {
505  case kOpenGL:
506  setup_opengl(self);
507  break;
508  case kSoftware:
509  setup_software(self);
510  break;
511  default:
512  break;
513  }
514 
515  if (self->view_id != flutter::kFlutterImplicitViewId) {
516  setup_cursor(self);
517  return;
518  }
519 
520  GtkWidget* toplevel_window = gtk_widget_get_toplevel(GTK_WIDGET(self));
521 
522  self->window_state_monitor =
524  GTK_WINDOW(toplevel_window));
525 
526  // Handle requests by the user to close the application.
527  g_signal_connect_swapped(toplevel_window, "delete-event",
528  G_CALLBACK(window_delete_event_cb), self);
529 
530  // Flutter engine will need to make the context current from raster thread
531  // during initialization.
533 
534  g_autoptr(GError) error = nullptr;
535  if (!fl_engine_start(self->engine, &error)) {
536  g_warning("Failed to start Flutter engine: %s", error->message);
537  return;
538  }
539 
540  setup_cursor(self);
541 
543 }
544 
545 static void size_allocate_cb(FlView* self) {
547 }
548 
549 static void paint_background(FlView* self, cairo_t* cr) {
550  // Don't bother drawing if fully transparent - the widget above this will
551  // already be drawn by GTK.
552  if (self->background_color->red == 0 && self->background_color->green == 0 &&
553  self->background_color->blue == 0 && self->background_color->alpha == 0) {
554  return;
555  }
556 
557  gdk_cairo_set_source_rgba(cr, self->background_color);
558  cairo_paint(cr);
559 }
560 
561 static gboolean draw_cb(FlView* self, cairo_t* cr) {
562  paint_background(self, cr);
563 
564  if (self->render_context) {
565  gdk_gl_context_make_current(self->render_context);
566  }
567 
568  gboolean wait_for_frame = !self->sized_to_content;
569  gboolean result = fl_compositor_render(
570  self->compositor, cr,
571  gtk_widget_get_window(GTK_WIDGET(self->render_area)), wait_for_frame);
572 
573  if (self->render_context) {
574  gdk_gl_context_clear_current();
575  }
576 
577  return result;
578 }
579 
580 static void fl_view_notify(GObject* object, GParamSpec* pspec) {
581  FlView* self = FL_VIEW(object);
582 
583  if (strcmp(pspec->name, "scale-factor") == 0) {
585  }
586 
587  if (G_OBJECT_CLASS(fl_view_parent_class)->notify != nullptr) {
588  G_OBJECT_CLASS(fl_view_parent_class)->notify(object, pspec);
589  }
590 }
591 
592 static void fl_view_dispose(GObject* object) {
593  FlView* self = FL_VIEW(object);
594 
595  g_cancellable_cancel(self->cancellable);
596 
597  if (self->engine != nullptr) {
598  FlMouseCursorHandler* handler =
600  if (self->cursor_changed_cb_id != 0) {
601  g_signal_handler_disconnect(handler, self->cursor_changed_cb_id);
602  self->cursor_changed_cb_id = 0;
603  }
604 
605  // Release the view ID from the engine.
606  fl_engine_remove_view(self->engine, self->view_id, nullptr, nullptr,
607  nullptr);
608  }
609 
610  if (self->on_pre_engine_restart_cb_id != 0) {
611  g_signal_handler_disconnect(self->engine,
612  self->on_pre_engine_restart_cb_id);
613  self->on_pre_engine_restart_cb_id = 0;
614  }
615 
616  if (self->update_semantics_cb_id != 0) {
617  g_signal_handler_disconnect(self->engine, self->update_semantics_cb_id);
618  self->update_semantics_cb_id = 0;
619  }
620 
621  g_clear_object(&self->render_context);
622  g_clear_object(&self->engine);
623  g_clear_object(&self->compositor);
624  g_clear_pointer(&self->background_color, gdk_rgba_free);
625  g_clear_object(&self->window_state_monitor);
626  g_clear_object(&self->scrolling_manager);
627  g_clear_object(&self->pointer_manager);
628  g_clear_object(&self->touch_manager);
629  g_clear_object(&self->view_accessible);
630  g_clear_object(&self->cancellable);
631 
632  G_OBJECT_CLASS(fl_view_parent_class)->dispose(object);
633 }
634 
635 // Implements GtkWidget::realize.
636 static void fl_view_realize(GtkWidget* widget) {
637  FlView* self = FL_VIEW(widget);
638 
639  GTK_WIDGET_CLASS(fl_view_parent_class)->realize(widget);
640 
641  // Realize the child widgets.
642  gtk_widget_realize(GTK_WIDGET(self->render_area));
643 }
644 
645 static gboolean handle_key_event(FlView* self, GdkEventKey* key_event) {
646  g_autoptr(FlKeyEvent) event = fl_key_event_new_from_gdk_event(
647  gdk_event_copy(reinterpret_cast<GdkEvent*>(key_event)));
648 
650  fl_engine_get_keyboard_manager(self->engine), event, self->cancellable,
651  [](GObject* object, GAsyncResult* result, gpointer user_data) {
652  FlView* self = FL_VIEW(user_data);
653 
654  g_autoptr(FlKeyEvent) redispatch_event = nullptr;
655  g_autoptr(GError) error = nullptr;
656  if (!fl_keyboard_manager_handle_event_finish(
657  FL_KEYBOARD_MANAGER(object), result, &redispatch_event,
658  &error)) {
659  if (g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED)) {
660  return;
661  }
662 
663  g_warning("Failed to handle key event: %s", error->message);
664  }
665 
666  if (redispatch_event != nullptr) {
668  fl_engine_get_text_input_handler(self->engine),
669  redispatch_event)) {
670  fl_keyboard_manager_add_redispatched_event(
671  fl_engine_get_keyboard_manager(self->engine), redispatch_event);
672  gdk_event_put(fl_key_event_get_origin(redispatch_event));
673  }
674  }
675  },
676  self);
677 
678  return TRUE;
679 }
680 
681 // Implements GtkWidget::key_press_event.
682 static gboolean fl_view_focus_in_event(GtkWidget* widget,
683  GdkEventFocus* event) {
684  FlView* self = FL_VIEW(widget);
686  fl_engine_get_text_input_handler(self->engine), widget);
687  return FALSE;
688 }
689 
690 // Implements GtkWidget::key_press_event.
691 static gboolean fl_view_key_press_event(GtkWidget* widget,
692  GdkEventKey* key_event) {
693  FlView* self = FL_VIEW(widget);
694  return handle_key_event(self, key_event);
695 }
696 
697 // Implements GtkWidget::key_release_event.
698 static gboolean fl_view_key_release_event(GtkWidget* widget,
699  GdkEventKey* key_event) {
700  FlView* self = FL_VIEW(widget);
701  return handle_key_event(self, key_event);
702 }
703 
704 static void fl_view_class_init(FlViewClass* klass) {
705  GObjectClass* object_class = G_OBJECT_CLASS(klass);
706  object_class->notify = fl_view_notify;
707  object_class->dispose = fl_view_dispose;
708 
709  GtkWidgetClass* widget_class = GTK_WIDGET_CLASS(klass);
710  widget_class->realize = fl_view_realize;
711  widget_class->focus_in_event = fl_view_focus_in_event;
712  widget_class->key_press_event = fl_view_key_press_event;
713  widget_class->key_release_event = fl_view_key_release_event;
714 
716  g_signal_new("first-frame", fl_view_get_type(), G_SIGNAL_RUN_LAST, 0,
717  NULL, NULL, NULL, G_TYPE_NONE, 0);
718 
719  gtk_widget_class_set_accessible_type(GTK_WIDGET_CLASS(klass),
720  fl_socket_accessible_get_type());
721 }
722 
723 // Engine related construction.
724 static void setup_engine(FlView* self) {
725  self->view_accessible = fl_view_accessible_new(self->engine, self->view_id);
727  FL_SOCKET_ACCESSIBLE(gtk_widget_get_accessible(GTK_WIDGET(self))),
728  atk_plug_get_id(ATK_PLUG(self->view_accessible)));
729 
730  self->pointer_manager = fl_pointer_manager_new(self->view_id, self->engine);
731 
732  init_scrolling(self);
733  init_touch(self);
734 
735  self->on_pre_engine_restart_cb_id =
736  g_signal_connect_swapped(self->engine, "on-pre-engine-restart",
737  G_CALLBACK(on_pre_engine_restart_cb), self);
738  self->update_semantics_cb_id = g_signal_connect_swapped(
739  self->engine, "update-semantics", G_CALLBACK(update_semantics_cb), self);
740 }
741 
742 static void fl_view_init(FlView* self) {
743  self->cancellable = g_cancellable_new();
744 
745  gtk_widget_set_can_focus(GTK_WIDGET(self), TRUE);
746 
747  self->view_id = -1;
748 
749  GdkRGBA default_background = {
750  .red = 0.0, .green = 0.0, .blue = 0.0, .alpha = 1.0};
751  self->background_color = gdk_rgba_copy(&default_background);
752 
753  self->event_box = gtk_event_box_new();
754  gtk_widget_set_hexpand(self->event_box, TRUE);
755  gtk_widget_set_vexpand(self->event_box, TRUE);
756  gtk_container_add(GTK_CONTAINER(self), self->event_box);
757  gtk_widget_show(self->event_box);
758  gtk_widget_add_events(self->event_box,
759  GDK_POINTER_MOTION_MASK | GDK_BUTTON_PRESS_MASK |
760  GDK_BUTTON_RELEASE_MASK | GDK_SCROLL_MASK |
761  GDK_SMOOTH_SCROLL_MASK | GDK_TOUCH_MASK);
762 
763  g_signal_connect_swapped(self->event_box, "button-press-event",
764  G_CALLBACK(button_press_event_cb), self);
765  g_signal_connect_swapped(self->event_box, "button-release-event",
766  G_CALLBACK(button_release_event_cb), self);
767  g_signal_connect_swapped(self->event_box, "scroll-event",
768  G_CALLBACK(scroll_event_cb), self);
769  g_signal_connect_swapped(self->event_box, "motion-notify-event",
770  G_CALLBACK(motion_notify_event_cb), self);
771  g_signal_connect_swapped(self->event_box, "enter-notify-event",
772  G_CALLBACK(enter_notify_event_cb), self);
773  g_signal_connect_swapped(self->event_box, "leave-notify-event",
774  G_CALLBACK(leave_notify_event_cb), self);
775  GtkGesture* zoom = gtk_gesture_zoom_new(self->event_box);
776  g_signal_connect_swapped(zoom, "begin", G_CALLBACK(gesture_zoom_begin_cb),
777  self);
778  g_signal_connect_swapped(zoom, "scale-changed",
779  G_CALLBACK(gesture_zoom_update_cb), self);
780  g_signal_connect_swapped(zoom, "end", G_CALLBACK(gesture_zoom_end_cb), self);
781  GtkGesture* rotate = gtk_gesture_rotate_new(self->event_box);
782  g_signal_connect_swapped(rotate, "begin",
783  G_CALLBACK(gesture_rotation_begin_cb), self);
784  g_signal_connect_swapped(rotate, "angle-changed",
785  G_CALLBACK(gesture_rotation_update_cb), self);
786  g_signal_connect_swapped(rotate, "end", G_CALLBACK(gesture_rotation_end_cb),
787  self);
788  g_signal_connect_swapped(self->event_box, "touch-event",
789  G_CALLBACK(touch_event_cb), self);
790 
791  self->render_area = GTK_DRAWING_AREA(gtk_drawing_area_new());
792  gtk_widget_show(GTK_WIDGET(self->render_area));
793  gtk_container_add(GTK_CONTAINER(self->event_box),
794  GTK_WIDGET(self->render_area));
795  g_signal_connect_swapped(self->render_area, "realize", G_CALLBACK(realize_cb),
796  self);
797  g_signal_connect_swapped(self->render_area, "size-allocate",
798  G_CALLBACK(size_allocate_cb), self);
799  g_signal_connect_swapped(self->render_area, "draw", G_CALLBACK(draw_cb),
800  self);
801 }
802 
803 G_MODULE_EXPORT FlView* fl_view_new(FlDartProject* project) {
804  g_autoptr(FlEngine) engine = fl_engine_new(project);
805  FlView* self = FL_VIEW(g_object_new(fl_view_get_type(), nullptr));
806 
807  self->view_id = flutter::kFlutterImplicitViewId;
808  self->engine = FL_ENGINE(g_object_ref(engine));
809 
810  setup_engine(self);
811 
812  fl_engine_set_implicit_view(engine, FL_RENDERABLE(self));
813 
814  return self;
815 }
816 
817 G_MODULE_EXPORT FlView* fl_view_new_for_engine(FlEngine* engine) {
818  FlView* self = FL_VIEW(g_object_new(fl_view_get_type(), nullptr));
819 
820  self->engine = FL_ENGINE(g_object_ref(engine));
821 
822  size_t min_width = 1, min_height = 1, max_width = 1, max_height = 1;
823  gint scale_factor = gtk_widget_get_scale_factor(GTK_WIDGET(self));
824  self->view_id = fl_engine_add_view(
825  engine, FL_RENDERABLE(self), min_width, min_height, max_width, max_height,
826  scale_factor, self->cancellable, view_added_cb, self);
827 
828  setup_engine(self);
829 
830  return self;
831 }
832 
833 G_MODULE_EXPORT FlView* fl_view_new_sized_to_content(FlEngine* engine) {
834  FlView* self = FL_VIEW(g_object_new(fl_view_get_type(), nullptr));
835 
836  self->engine = FL_ENGINE(g_object_ref(engine));
837 
838  self->sized_to_content = TRUE;
839  size_t min_width = 1, min_height = 1, max_width = G_MAXSIZE,
840  max_height = G_MAXSIZE;
841  gint scale_factor = gtk_widget_get_scale_factor(GTK_WIDGET(self));
842  self->view_id = fl_engine_add_view(
843  engine, FL_RENDERABLE(self), min_width, min_height, max_width, max_height,
844  scale_factor, self->cancellable, view_added_cb, self);
845 
846  setup_engine(self);
847 
848  return self;
849 }
850 
851 G_MODULE_EXPORT FlEngine* fl_view_get_engine(FlView* self) {
852  g_return_val_if_fail(FL_IS_VIEW(self), nullptr);
853  return self->engine;
854 }
855 
856 G_MODULE_EXPORT
857 int64_t fl_view_get_id(FlView* self) {
858  g_return_val_if_fail(FL_IS_VIEW(self), -1);
859  return self->view_id;
860 }
861 
862 G_MODULE_EXPORT void fl_view_set_background_color(FlView* self,
863  const GdkRGBA* color) {
864  g_return_if_fail(FL_IS_VIEW(self));
865  gdk_rgba_free(self->background_color);
866  self->background_color = gdk_rgba_copy(color);
867 }
868 
869 FlViewAccessible* fl_view_get_accessible(FlView* self) {
870  g_return_val_if_fail(FL_IS_VIEW(self), nullptr);
871  return self->view_accessible;
872 }
g_autoptr(FlEngine) engine
if(engine==nullptr)
FlRenderable * renderable
const char FlTextDirection FlAssertiveness gpointer user_data
gboolean fl_compositor_render(FlCompositor *self, cairo_t *cr, GdkWindow *window, gboolean wait_for_frame)
void fl_compositor_get_frame_size(FlCompositor *self, size_t *width, size_t *height)
gboolean fl_compositor_present_layers(FlCompositor *self, const FlutterLayer **layers, size_t layers_count)
FlCompositorOpenGL * fl_compositor_opengl_new(FlTaskRunner *task_runner, FlOpenGLManager *opengl_manager, gboolean shareable)
G_BEGIN_DECLS FlOpenGLManager gboolean shareable
const FlutterLayer size_t layers_count
const FlutterLayer ** layers
self height
self width
return TRUE
FlCompositorSoftware * fl_compositor_software_new(FlTaskRunner *task_runner)
FlutterEngineDisplayId fl_display_monitor_get_display_id(FlDisplayMonitor *self, GdkMonitor *monitor)
G_MODULE_EXPORT FlTextureRegistrar * fl_engine_get_texture_registrar(FlEngine *self)
Definition: fl_engine.cc:1509
FlMouseCursorHandler * fl_engine_get_mouse_cursor_handler(FlEngine *self)
Definition: fl_engine.cc:1544
void fl_engine_send_window_metrics_event(FlEngine *self, FlutterEngineDisplayId display_id, FlutterViewId view_id, size_t min_width, size_t min_height, size_t max_width, size_t max_height, double pixel_ratio)
Definition: fl_engine.cc:1144
FlOpenGLManager * fl_engine_get_opengl_manager(FlEngine *self)
Definition: fl_engine.cc:750
FlutterRendererType fl_engine_get_renderer_type(FlEngine *self)
Definition: fl_engine.cc:745
FlTaskRunner * fl_engine_get_task_runner(FlEngine *self)
Definition: fl_engine.cc:1497
FlKeyboardManager * fl_engine_get_keyboard_manager(FlEngine *self)
Definition: fl_engine.cc:1534
FlDisplayMonitor * fl_engine_get_display_monitor(FlEngine *self)
Definition: fl_engine.cc:755
FlTextInputHandler * fl_engine_get_text_input_handler(FlEngine *self)
Definition: fl_engine.cc:1539
void fl_engine_set_implicit_view(FlEngine *self, FlRenderable *renderable)
Definition: fl_engine.cc:919
FlutterViewId fl_engine_add_view(FlEngine *self, FlRenderable *renderable, size_t min_width, size_t min_height, size_t max_width, size_t max_height, double pixel_ratio, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data)
Definition: fl_engine.cc:923
void fl_engine_remove_view(FlEngine *self, FlutterViewId view_id, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data)
Definition: fl_engine.cc:989
G_MODULE_EXPORT FlBinaryMessenger * fl_engine_get_binary_messenger(FlEngine *self)
Definition: fl_engine.cc:1491
gboolean fl_engine_add_view_finish(FlEngine *self, GAsyncResult *result, GError **error)
Definition: fl_engine.cc:976
void fl_engine_request_app_exit(FlEngine *self)
Definition: fl_engine.cc:1529
gboolean fl_engine_start(FlEngine *self, GError **error)
Definition: fl_engine.cc:760
G_MODULE_EXPORT FlEngine * fl_engine_new(FlDartProject *project)
Definition: fl_engine.cc:731
FlKeyEvent * fl_key_event_new_from_gdk_event(GdkEvent *event)
Definition: fl_key_event.cc:53
void fl_keyboard_manager_handle_event(FlKeyboardManager *self, FlKeyEvent *event, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data)
void fl_keyboard_manager_sync_modifier_if_needed(FlKeyboardManager *self, guint state, double event_time)
const gchar * fl_mouse_cursor_handler_get_cursor_name(FlMouseCursorHandler *self)
gboolean fl_opengl_manager_clear_current(FlOpenGLManager *self)
const uint8_t uint32_t uint32_t GError ** error
FlPluginRegistrar * fl_plugin_registrar_new(FlView *view, FlBinaryMessenger *messenger, FlTextureRegistrar *texture_registrar)
gboolean fl_pointer_manager_handle_button_press(FlPointerManager *self, guint event_time, FlutterPointerDeviceKind device_kind, gdouble x, gdouble y, guint gdk_button)
FlPointerManager * fl_pointer_manager_new(FlutterViewId view_id, FlEngine *engine)
gboolean fl_pointer_manager_handle_motion(FlPointerManager *self, guint event_time, FlutterPointerDeviceKind device_kind, gdouble x, gdouble y)
gboolean fl_pointer_manager_handle_enter(FlPointerManager *self, guint event_time, FlutterPointerDeviceKind device_kind, gdouble x, gdouble y)
gboolean fl_pointer_manager_handle_leave(FlPointerManager *self, guint event_time, FlutterPointerDeviceKind device_kind, gdouble x, gdouble y)
gboolean fl_pointer_manager_handle_button_release(FlPointerManager *self, guint event_time, FlutterPointerDeviceKind device_kind, gdouble x, gdouble y, guint gdk_button)
void fl_scrolling_manager_handle_rotation_begin(FlScrollingManager *self)
void fl_scrolling_manager_set_last_mouse_position(FlScrollingManager *self, gdouble x, gdouble y)
void fl_scrolling_manager_handle_rotation_end(FlScrollingManager *self)
void fl_scrolling_manager_handle_scroll_event(FlScrollingManager *self, GdkEventScroll *scroll_event, gint scale_factor)
FlScrollingManager * fl_scrolling_manager_new(FlEngine *engine, FlutterViewId view_id)
void fl_scrolling_manager_handle_zoom_update(FlScrollingManager *self, gdouble scale)
void fl_scrolling_manager_handle_rotation_update(FlScrollingManager *self, gdouble rotation)
void fl_scrolling_manager_handle_zoom_begin(FlScrollingManager *self)
void fl_scrolling_manager_handle_zoom_end(FlScrollingManager *self)
void fl_socket_accessible_embed(FlSocketAccessible *self, gchar *id)
guint const GValue GParamSpec * pspec
gboolean fl_text_input_handler_filter_keypress(FlTextInputHandler *self, FlKeyEvent *event)
void fl_text_input_handler_set_widget(FlTextInputHandler *self, GtkWidget *widget)
void fl_touch_manager_handle_touch_event(FlTouchManager *self, GdkEventTouch *touch_event, gint scale_factor)
FlTouchManager * fl_touch_manager_new(FlEngine *engine, FlutterViewId view_id)
@ LAST_SIGNAL
Definition: fl_view.cc:88
@ SIGNAL_FIRST_FRAME
Definition: fl_view.cc:88
static void gesture_zoom_begin_cb(FlView *self)
Definition: fl_view.cc:461
static void fl_view_realize(GtkWidget *widget)
Definition: fl_view.cc:636
static void init_scrolling(FlView *self)
Definition: fl_view.cc:151
static gboolean button_release_event_cb(FlView *self, GdkEventButton *button_event)
Definition: fl_view.cc:359
static void handle_geometry_changed(FlView *self)
Definition: fl_view.cc:208
static void gesture_rotation_end_cb(FlView *self)
Definition: fl_view.cc:457
static void gesture_rotation_update_cb(FlView *self, gdouble rotation, gdouble delta)
Definition: fl_view.cc:450
static gboolean button_press_event_cb(FlView *self, GdkEventButton *button_event)
Definition: fl_view.cc:331
static gboolean fl_view_key_release_event(GtkWidget *widget, GdkEventKey *key_event)
Definition: fl_view.cc:698
static void setup_opengl(FlView *self)
Definition: fl_view.cc:473
static void gesture_zoom_end_cb(FlView *self)
Definition: fl_view.cc:469
static void fl_view_dispose(GObject *object)
Definition: fl_view.cc:592
static void on_pre_engine_restart_cb(FlView *self)
Definition: fl_view.cc:279
FlViewAccessible * fl_view_get_accessible(FlView *self)
Definition: fl_view.cc:869
static gboolean fl_view_key_press_event(GtkWidget *widget, GdkEventKey *key_event)
Definition: fl_view.cc:691
G_MODULE_EXPORT FlView * fl_view_new(FlDartProject *project)
Definition: fl_view.cc:803
static void size_allocate_cb(FlView *self)
Definition: fl_view.cc:545
static void fl_view_notify(GObject *object, GParamSpec *pspec)
Definition: fl_view.cc:580
static gboolean motion_notify_event_cb(FlView *self, GdkEventMotion *motion_event)
Definition: fl_view.cc:398
static void setup_software(FlView *self)
Definition: fl_view.cc:498
static void fl_view_present_layers(FlRenderable *renderable, const FlutterLayer **layers, size_t layers_count)
Definition: fl_view.cc:285
static void fl_view_init(FlView *self)
Definition: fl_view.cc:742
G_DEFINE_TYPE_WITH_CODE(FlView, fl_view, GTK_TYPE_BOX, G_IMPLEMENT_INTERFACE(fl_plugin_registry_get_type(), fl_view_plugin_registry_iface_init)) static gboolean redraw_cb(gpointer user_data)
Definition: fl_view.cc:97
static gboolean enter_notify_event_cb(FlView *self, GdkEventCrossing *crossing_event)
Definition: fl_view.cc:419
static void gesture_rotation_begin_cb(FlView *self)
Definition: fl_view.cc:446
static void set_scrolling_position(FlView *self, gdouble x, gdouble y)
Definition: fl_view.cc:324
static guint fl_view_signals[LAST_SIGNAL]
Definition: fl_view.cc:90
static void paint_background(FlView *self, cairo_t *cr)
Definition: fl_view.cc:549
G_MODULE_EXPORT FlView * fl_view_new_sized_to_content(FlEngine *engine)
Definition: fl_view.cc:833
G_MODULE_EXPORT FlView * fl_view_new_for_engine(FlEngine *engine)
Definition: fl_view.cc:817
static void fl_view_class_init(FlViewClass *klass)
Definition: fl_view.cc:704
static void setup_cursor(FlView *self)
Definition: fl_view.cc:198
static void fl_renderable_iface_init(FlRenderableInterface *iface)
Definition: fl_view.cc:307
static gboolean fl_view_focus_in_event(GtkWidget *widget, GdkEventFocus *event)
Definition: fl_view.cc:682
G_MODULE_EXPORT void fl_view_set_background_color(FlView *self, const GdkRGBA *color)
Definition: fl_view.cc:862
G_MODULE_EXPORT FlEngine * fl_view_get_engine(FlView *self)
Definition: fl_view.cc:851
static void setup_engine(FlView *self)
Definition: fl_view.cc:724
static void sync_modifier_if_needed(FlView *self, GdkEvent *event)
Definition: fl_view.cc:316
static gboolean handle_key_event(FlView *self, GdkEventKey *key_event)
Definition: fl_view.cc:645
static FlutterPointerDeviceKind get_pointer_device_kind(GdkEvent *event)
Definition: fl_view.cc:162
static void view_added_cb(GObject *object, GAsyncResult *result, gpointer user_data)
Definition: fl_view.cc:248
static gboolean window_delete_event_cb(FlView *self)
Definition: fl_view.cc:145
G_MODULE_EXPORT int64_t fl_view_get_id(FlView *self)
Definition: fl_view.cc:857
static gboolean scroll_event_cb(FlView *self, GdkEventScroll *event)
Definition: fl_view.cc:380
static void fl_view_plugin_registry_iface_init(FlPluginRegistryInterface *iface)
Definition: fl_view.cc:311
static void gesture_zoom_update_cb(FlView *self, gdouble scale)
Definition: fl_view.cc:465
static void init_touch(FlView *self)
Definition: fl_view.cc:157
static void realize_cb(FlView *self)
Definition: fl_view.cc:503
static gboolean draw_cb(FlView *self, cairo_t *cr)
Definition: fl_view.cc:561
static FlPluginRegistrar * fl_view_get_registrar_for_plugin(FlPluginRegistry *registry, const gchar *name)
Definition: fl_view.cc:297
static void update_semantics_cb(FlView *self, const FlutterSemanticsUpdate2 *update)
Definition: fl_view.cc:264
static gboolean leave_notify_event_cb(FlView *self, GdkEventCrossing *crossing_event)
Definition: fl_view.cc:431
static void cursor_changed_cb(FlView *self)
Definition: fl_view.cc:186
static gboolean touch_event_cb(FlView *self, GdkEventTouch *event)
Definition: fl_view.cc:390
FlViewAccessible * fl_view_accessible_new(FlEngine *engine, FlutterViewId view_id)
void fl_view_accessible_handle_update_semantics(FlViewAccessible *self, const FlutterSemanticsUpdate2 *update)
FlWindowStateMonitor * fl_window_state_monitor_new(FlBinaryMessenger *messenger, GtkWindow *window)
FlEngine * engine
Definition: fl_view.cc:44
guint on_pre_engine_restart_cb_id
Definition: fl_view.cc:50
FlCompositor * compositor
Definition: fl_view.cc:47
FlScrollingManager * scrolling_manager
Definition: fl_view.cc:68
gboolean sized_to_content
Definition: fl_view.cc:83
guint update_semantics_cb_id
Definition: fl_view.cc:53
FlTouchManager * touch_manager
Definition: fl_view.cc:74
FlPointerManager * pointer_manager
Definition: fl_view.cc:71
FlWindowStateMonitor * window_state_monitor
Definition: fl_view.cc:65
GCancellable * cancellable
Definition: fl_view.cc:85
GtkBox parent_instance
Definition: fl_view.cc:32
gboolean have_first_frame
Definition: fl_view.cc:62
guint cursor_changed_cb_id
Definition: fl_view.cc:80
GtkDrawingArea * render_area
Definition: fl_view.cc:38
GdkGLContext * render_context
Definition: fl_view.cc:41
FlutterViewId view_id
Definition: fl_view.cc:56
GtkWidget * event_box
Definition: fl_view.cc:35
GdkRGBA * background_color
Definition: fl_view.cc:59
FlViewAccessible * view_accessible
Definition: fl_view.cc:77