Flutter Engine Uber Docs
Docs for the entire Flutter Engine repo.
 
Loading...
Searching...
No Matches
Classes | Functions | Variables
fl_pointer_manager.cc File Reference
#include "flutter/shell/platform/linux/fl_pointer_manager.h"
#include "flutter/shell/platform/linux/fl_engine_private.h"

Go to the source code of this file.

Classes

struct  _FlPointerManager
 

Functions

 G_DEFINE_TYPE (FlPointerManager, fl_pointer_manager, G_TYPE_OBJECT)
 
static gboolean get_mouse_button (guint gdk_button, int64_t *button)
 
static gboolean get_button (FlutterPointerDeviceKind device_kind, guint gdk_button, int64_t *button)
 
static void ensure_pointer_added (FlPointerManager *self, guint event_time, FlutterPointerDeviceKind device_kind, gdouble x, gdouble y, gdouble rotation, gdouble pressure)
 
static void fl_pointer_manager_dispose (GObject *object)
 
static void fl_pointer_manager_class_init (FlPointerManagerClass *klass)
 
static void fl_pointer_manager_init (FlPointerManager *self)
 
FlPointerManager * fl_pointer_manager_new (FlutterViewId view_id, FlEngine *engine)
 
gboolean fl_pointer_manager_handle_button_press (FlPointerManager *self, guint event_time, FlutterPointerDeviceKind device_kind, gdouble x, gdouble y, guint gdk_button, gdouble rotation, gdouble pressure)
 
gboolean fl_pointer_manager_handle_button_release (FlPointerManager *self, guint event_time, FlutterPointerDeviceKind device_kind, gdouble x, gdouble y, guint gdk_button, gdouble rotation, gdouble pressure)
 
gboolean fl_pointer_manager_handle_motion (FlPointerManager *self, guint event_time, FlutterPointerDeviceKind device_kind, gdouble x, gdouble y, gdouble rotation, gdouble pressure)
 
gboolean fl_pointer_manager_handle_enter (FlPointerManager *self, guint event_time, FlutterPointerDeviceKind device_kind, gdouble x, gdouble y, gdouble rotation, gdouble pressure)
 
gboolean fl_pointer_manager_handle_leave (FlPointerManager *self, guint event_time, FlutterPointerDeviceKind device_kind, gdouble x, gdouble y, gdouble rotation, gdouble pressure)
 

Variables

static constexpr int kMicrosecondsPerMillisecond = 1000
 
static constexpr guint kMouseButtonBack = 8
 
static constexpr guint kMouseButtonForward = 9
 

Function Documentation

◆ ensure_pointer_added()

static void ensure_pointer_added ( FlPointerManager *  self,
guint  event_time,
FlutterPointerDeviceKind  device_kind,
gdouble  x,
gdouble  y,
gdouble  rotation,
gdouble  pressure 
)
static

Definition at line 86 of file fl_pointer_manager.cc.

92 {
93 if (self->pointer_inside) {
94 return;
95 }
96 self->pointer_inside = TRUE;
97
98 g_autoptr(FlEngine) engine = FL_ENGINE(g_weak_ref_get(&self->engine));
99 if (engine == nullptr) {
100 return;
101 }
102
103 fl_engine_send_mouse_pointer_event(
104 engine, self->view_id, kAdd, event_time * kMicrosecondsPerMillisecond, x,
105 y, device_kind, 0, 0, self->button_state, rotation, pressure);
106}
x
int32_t x
Definition dl_golden_unittests.cc:482
kAdd
@ kAdd
Definition embedder.h:1292
engine
FlutterEngine engine
Definition main.cc:84
g_autoptr
g_autoptr(FlEngine) engine
TRUE
return TRUE
Definition fl_compositor_software.cc:68
fl_engine_send_mouse_pointer_event
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, double rotation, double pressure)
Definition fl_engine.cc:1195
kMicrosecondsPerMillisecond
static constexpr int kMicrosecondsPerMillisecond
Definition fl_pointer_manager.cc:9
y
double y
Definition mouse-input-test.cc:82

References engine, fl_engine_send_mouse_pointer_event(), g_autoptr(), kAdd, kMicrosecondsPerMillisecond, self, TRUE, x, and y.

Referenced by fl_pointer_manager_handle_button_press(), fl_pointer_manager_handle_enter(), and fl_pointer_manager_handle_motion().

◆ fl_pointer_manager_class_init()

static void fl_pointer_manager_class_init ( FlPointerManagerClass *  klass)
static

Definition at line 116 of file fl_pointer_manager.cc.

116 {
117 G_OBJECT_CLASS(klass)->dispose = fl_pointer_manager_dispose;
118}
fl_pointer_manager_dispose
static void fl_pointer_manager_dispose(GObject *object)
Definition fl_pointer_manager.cc:108

References fl_pointer_manager_dispose().

◆ fl_pointer_manager_dispose()

static void fl_pointer_manager_dispose ( GObject *  object)
static

Definition at line 108 of file fl_pointer_manager.cc.

108 {
109 FlPointerManager* self = FL_POINTER_MANAGER(object);
110
111 g_weak_ref_clear(&self->engine);
112
113 G_OBJECT_CLASS(fl_pointer_manager_parent_class)->dispose(object);
114}

References self.

Referenced by fl_pointer_manager_class_init().

◆ fl_pointer_manager_handle_button_press()

gboolean fl_pointer_manager_handle_button_press ( FlPointerManager *  manager,
guint  event_time,
FlutterPointerDeviceKind  device_kind,
gdouble  x,
gdouble  y,
guint  gdk_button,
gdouble  rotation,
gdouble  pressure 
)

fl_pointer_manager_handle_button_press: @manager: an #FlPointerManager. @event_time: event time in milliseconds. @device_kind: kind of device generating the event. @x: x co-ordinate of event. @y: y co-ordinate of event. @gdk_button: button being pressed. @rotation: rotation of the pointer device in degrees. @pressure: pressure of the pointer device.

Returns TRUE if this event was handled.

Definition at line 133 of file fl_pointer_manager.cc.

141 {
142 g_return_val_if_fail(FL_IS_POINTER_MANAGER(self), FALSE);
143
144 int64_t button;
145 if (!get_button(device_kind, gdk_button, &button)) {
146 return FALSE;
147 }
148
149 ensure_pointer_added(self, event_time, device_kind, x, y, rotation, pressure);
150
151 // Drop the event if Flutter already thinks the button is down.
152 if ((self->button_state & button) != 0) {
153 return FALSE;
154 }
155
156 int old_button_state = self->button_state;
157 FlutterPointerPhase phase = kMove;
158 self->button_state ^= button;
159 phase = old_button_state == 0 ? kDown : kMove;
160
161 g_autoptr(FlEngine) engine = FL_ENGINE(g_weak_ref_get(&self->engine));
162 if (engine == nullptr) {
163 return FALSE;
164 }
165
166 fl_engine_send_mouse_pointer_event(
167 engine, self->view_id, phase, event_time * kMicrosecondsPerMillisecond, x,
168 y, device_kind, 0, 0, self->button_state, rotation, pressure);
169
170 return TRUE;
171}
FlutterPointerPhase
FlutterPointerPhase
The phase of the pointer event.
Definition embedder.h:1267
kDown
@ kDown
Definition embedder.h:1282
kMove
@ kMove
Definition embedder.h:1287
get_button
static gboolean get_button(FlutterPointerDeviceKind device_kind, guint gdk_button, int64_t *button)
Definition fl_pointer_manager.cc:59
ensure_pointer_added
static void ensure_pointer_added(FlPointerManager *self, guint event_time, FlutterPointerDeviceKind device_kind, gdouble x, gdouble y, gdouble rotation, gdouble pressure)
Definition fl_pointer_manager.cc:86

References engine, ensure_pointer_added(), fl_engine_send_mouse_pointer_event(), g_autoptr(), get_button(), kDown, kMicrosecondsPerMillisecond, kMove, self, TRUE, x, and y.

Referenced by button_press_event_cb(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

◆ fl_pointer_manager_handle_button_release()

gboolean fl_pointer_manager_handle_button_release ( FlPointerManager *  manager,
guint  event_time,
FlutterPointerDeviceKind  device_kind,
gdouble  x,
gdouble  y,
guint  gdk_button,
gdouble  rotation,
gdouble  pressure 
)

fl_pointer_manager_handle_button_release: @manager: an #FlPointerManager. @event_time: event time in milliseconds. @device_kind: kind of device generating the event. @x: x co-ordinate of event. @y: y co-ordinate of event. @gdk_button: button being released. @rotation: rotation of the pointer device in degrees. @pressure: pressure of the pointer device.

Returns TRUE if this event was handled.

Definition at line 173 of file fl_pointer_manager.cc.

181 {
182 g_return_val_if_fail(FL_IS_POINTER_MANAGER(self), FALSE);
183
184 int64_t button;
185 if (!get_button(device_kind, gdk_button, &button)) {
186 return FALSE;
187 }
188
189 // Drop the event if Flutter already thinks the button is up.
190 if ((self->button_state & button) == 0) {
191 return FALSE;
192 }
193
194 FlutterPointerPhase phase = kMove;
195 self->button_state ^= button;
196
197 phase = self->button_state == 0 ? kUp : kMove;
198
199 g_autoptr(FlEngine) engine = FL_ENGINE(g_weak_ref_get(&self->engine));
200 if (engine == nullptr) {
201 return FALSE;
202 }
203
204 fl_engine_send_mouse_pointer_event(
205 engine, self->view_id, phase, event_time * kMicrosecondsPerMillisecond, x,
206 y, device_kind, 0, 0, self->button_state, rotation, pressure);
207
208 return TRUE;
209}
kUp
@ kUp
Definition embedder.h:1275

References engine, fl_engine_send_mouse_pointer_event(), g_autoptr(), get_button(), kMicrosecondsPerMillisecond, kMove, kUp, self, TRUE, x, and y.

Referenced by button_release_event_cb(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

◆ fl_pointer_manager_handle_enter()

gboolean fl_pointer_manager_handle_enter ( FlPointerManager *  manager,
guint  event_time,
FlutterPointerDeviceKind  device_kind,
gdouble  x,
gdouble  y,
gdouble  rotation,
gdouble  pressure 
)

fl_pointer_manager_handle_enter: @manager: an #FlPointerManager. @event_time: event time in milliseconds. @device_kind: kind of device generating the event. @x: x co-ordinate of event. @y: y co-ordinate of event. @rotation: rotation of the pointer device in degrees. @pressure: pressure of the pointer device.

Returns TRUE if this event was handled.

Definition at line 235 of file fl_pointer_manager.cc.

241 {
242 g_return_val_if_fail(FL_IS_POINTER_MANAGER(self), FALSE);
243
244 g_autoptr(FlEngine) engine = FL_ENGINE(g_weak_ref_get(&self->engine));
245 if (engine == nullptr) {
246 return FALSE;
247 }
248
249 ensure_pointer_added(self, event_time, device_kind, x, y, rotation, pressure);
250
251 return TRUE;
252}

References engine, ensure_pointer_added(), g_autoptr(), self, TRUE, x, and y.

Referenced by enter_notify_event_cb(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

◆ fl_pointer_manager_handle_leave()

gboolean fl_pointer_manager_handle_leave ( FlPointerManager *  manager,
guint  event_time,
FlutterPointerDeviceKind  device_kind,
gdouble  x,
gdouble  y,
gdouble  rotation,
gdouble  pressure 
)

fl_pointer_manager_handle_leave: @manager: an #FlPointerManager. @event_time: event time in milliseconds. @device_kind: kind of device generating the event. @x: x co-ordinate of event. @y: y co-ordinate of event. @rotation: rotation of the pointer device in degrees. @pressure: pressure of the pointer device.

Returns TRUE if this event was handled.

Definition at line 254 of file fl_pointer_manager.cc.

260 {
261 g_return_val_if_fail(FL_IS_POINTER_MANAGER(self), FALSE);
262
263 g_autoptr(FlEngine) engine = FL_ENGINE(g_weak_ref_get(&self->engine));
264 if (engine == nullptr) {
265 return FALSE;
266 }
267
268 // Don't remove pointer while button is down; In case of dragging outside of
269 // window with mouse grab active Gtk will send another leave notify on
270 // release.
271 if (self->pointer_inside && self->button_state == 0) {
272 fl_engine_send_mouse_pointer_event(engine, self->view_id, kRemove,
273 event_time * kMicrosecondsPerMillisecond,
274 x, y, device_kind, 0, 0,
275 self->button_state, rotation, pressure);
276 self->pointer_inside = FALSE;
277 }
278
279 return TRUE;
280}
kRemove
@ kRemove
Definition embedder.h:1297

References engine, fl_engine_send_mouse_pointer_event(), g_autoptr(), kMicrosecondsPerMillisecond, kRemove, self, TRUE, x, and y.

Referenced by leave_notify_event_cb(), TEST_F(), TEST_F(), and TEST_F().

◆ fl_pointer_manager_handle_motion()

gboolean fl_pointer_manager_handle_motion ( FlPointerManager *  manager,
guint  event_time,
FlutterPointerDeviceKind  device_kind,
gdouble  x,
gdouble  y,
gdouble  rotation,
gdouble  pressure 
)

fl_pointer_manager_handle_motion: @manager: an #FlPointerManager. @event_time: event time in milliseconds. @device_kind: kind of device generating the event. @x: x co-ordinate of event. @y: y co-ordinate of event. @rotation: rotation of the pointer device in degrees. @pressure: pressure of the pointer device.

Returns TRUE if this event was handled.

Definition at line 211 of file fl_pointer_manager.cc.

217 {
218 g_return_val_if_fail(FL_IS_POINTER_MANAGER(self), FALSE);
219
220 g_autoptr(FlEngine) engine = FL_ENGINE(g_weak_ref_get(&self->engine));
221 if (engine == nullptr) {
222 return FALSE;
223 }
224
225 ensure_pointer_added(self, event_time, device_kind, x, y, rotation, pressure);
226
227 fl_engine_send_mouse_pointer_event(
228 engine, self->view_id, self->button_state != 0 ? kMove : kHover,
229 event_time * kMicrosecondsPerMillisecond, x, y, device_kind, 0, 0,
230 self->button_state, rotation, pressure);
231
232 return TRUE;
233}
kHover
@ kHover
The pointer moved while up.
Definition embedder.h:1299

References engine, ensure_pointer_added(), fl_engine_send_mouse_pointer_event(), g_autoptr(), kHover, kMicrosecondsPerMillisecond, kMove, self, TRUE, x, and y.

Referenced by motion_notify_event_cb(), TEST_F(), TEST_F(), and TEST_F().

◆ fl_pointer_manager_init()

static void fl_pointer_manager_init ( FlPointerManager *  self)
static

Definition at line 120 of file fl_pointer_manager.cc.

120{}

◆ fl_pointer_manager_new()

FlPointerManager * fl_pointer_manager_new ( FlutterViewId  view_id,
FlEngine *  engine 
)

fl_pointer_manager_new: @view_id: view ID to report events for. @engine: an #FlEngine.

Create a new #FlPointerManager.

Returns: a new #FlPointerManager.

Definition at line 122 of file fl_pointer_manager.cc.

123 {
124 FlPointerManager* self =
125 FL_POINTER_MANAGER(g_object_new(fl_pointer_manager_get_type(), nullptr));
126
127 self->view_id = view_id;
128 g_weak_ref_init(&self->engine, engine);
129
130 return self;
131}
view_id
G_BEGIN_DECLS FlutterViewId view_id
Definition fl_view_accessible.h:49

References engine, self, and view_id.

Referenced by setup_engine(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

◆ G_DEFINE_TYPE()

G_DEFINE_TYPE ( FlPointerManager  ,
fl_pointer_manager  ,
G_TYPE_OBJECT   
)

◆ get_button()

static gboolean get_button ( FlutterPointerDeviceKind  device_kind,
guint  gdk_button,
int64_t *  button 
)
static

Definition at line 59 of file fl_pointer_manager.cc.

61 {
62 if (device_kind == kFlutterPointerDeviceKindStylus ||
63 device_kind == kFlutterPointerDeviceKindInvertedStylus) {
64 // GDK button names describe the physical button action, where "primary"
65 // is the stylus tip contact. Flutter stylus button names reserve "primary"
66 // for the first barrel button, so the GDK secondary button maps there.
67 switch (gdk_button) {
68 case GDK_BUTTON_PRIMARY:
69 *button = kFlutterPointerButtonStylusContact;
70 return TRUE;
71 case GDK_BUTTON_SECONDARY:
72 *button = kFlutterPointerButtonStylusPrimary;
73 return TRUE;
74 case GDK_BUTTON_MIDDLE:
75 *button = kFlutterPointerButtonStylusSecondary;
76 return TRUE;
77 default:
78 return FALSE;
79 }
80 }
81
82 return get_mouse_button(gdk_button, button);
83}
kFlutterPointerButtonStylusSecondary
@ kFlutterPointerButtonStylusSecondary
Definition embedder.h:1341
kFlutterPointerButtonStylusPrimary
@ kFlutterPointerButtonStylusPrimary
Definition embedder.h:1338
kFlutterPointerButtonStylusContact
@ kFlutterPointerButtonStylusContact
Definition embedder.h:1335
kFlutterPointerDeviceKindInvertedStylus
@ kFlutterPointerDeviceKindInvertedStylus
Definition embedder.h:1314
kFlutterPointerDeviceKindStylus
@ kFlutterPointerDeviceKindStylus
Definition embedder.h:1312
get_mouse_button
static gboolean get_mouse_button(guint gdk_button, int64_t *button)
Definition fl_pointer_manager.cc:37

References get_mouse_button(), kFlutterPointerButtonStylusContact, kFlutterPointerButtonStylusPrimary, kFlutterPointerButtonStylusSecondary, kFlutterPointerDeviceKindInvertedStylus, kFlutterPointerDeviceKindStylus, and TRUE.

Referenced by fl_pointer_manager_handle_button_press(), and fl_pointer_manager_handle_button_release().

◆ get_mouse_button()

static gboolean get_mouse_button ( guint  gdk_button,
int64_t *  button 
)
static

Definition at line 37 of file fl_pointer_manager.cc.

37 {
38 switch (gdk_button) {
39 case GDK_BUTTON_PRIMARY:
40 *button = kFlutterPointerButtonMousePrimary;
41 return TRUE;
42 case GDK_BUTTON_MIDDLE:
43 *button = kFlutterPointerButtonMouseMiddle;
44 return TRUE;
45 case GDK_BUTTON_SECONDARY:
46 *button = kFlutterPointerButtonMouseSecondary;
47 return TRUE;
48 case kMouseButtonBack:
49 *button = kFlutterPointerButtonMouseBack;
50 return TRUE;
51 case kMouseButtonForward:
52 *button = kFlutterPointerButtonMouseForward;
53 return TRUE;
54 default:
55 return FALSE;
56 }
57}
kFlutterPointerButtonMousePrimary
@ kFlutterPointerButtonMousePrimary
Definition embedder.h:1320
kFlutterPointerButtonMouseMiddle
@ kFlutterPointerButtonMouseMiddle
Definition embedder.h:1322
kFlutterPointerButtonMouseForward
@ kFlutterPointerButtonMouseForward
Definition embedder.h:1324
kFlutterPointerButtonMouseBack
@ kFlutterPointerButtonMouseBack
Definition embedder.h:1323
kFlutterPointerButtonMouseSecondary
@ kFlutterPointerButtonMouseSecondary
Definition embedder.h:1321
kMouseButtonForward
static constexpr guint kMouseButtonForward
Definition fl_pointer_manager.cc:34
kMouseButtonBack
static constexpr guint kMouseButtonBack
Definition fl_pointer_manager.cc:31

References kFlutterPointerButtonMouseBack, kFlutterPointerButtonMouseForward, kFlutterPointerButtonMouseMiddle, kFlutterPointerButtonMousePrimary, kFlutterPointerButtonMouseSecondary, kMouseButtonBack, kMouseButtonForward, and TRUE.

Referenced by get_button().

Variable Documentation

◆ kMicrosecondsPerMillisecond

constexpr int kMicrosecondsPerMillisecond = 1000
staticconstexpr

Definition at line 9 of file fl_pointer_manager.cc.

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

◆ kMouseButtonBack

constexpr guint kMouseButtonBack = 8
staticconstexpr

Definition at line 31 of file fl_pointer_manager.cc.

Referenced by get_mouse_button().

◆ kMouseButtonForward

constexpr guint kMouseButtonForward = 9
staticconstexpr

Definition at line 34 of file fl_pointer_manager.cc.

Referenced by get_mouse_button().