1use crate::{Capslock, xcb_flush};
2use anyhow::{Context as _, anyhow};
3use calloop::{
4 EventLoop, LoopHandle, RegistrationToken,
5 generic::{FdWrapper, Generic},
6};
7use collections::HashMap;
8use core::str;
9use http_client::Url;
10use log::Level;
11use smallvec::SmallVec;
12use std::{
13 cell::RefCell,
14 collections::{BTreeMap, HashSet},
15 ops::Deref,
16 path::PathBuf,
17 rc::{Rc, Weak},
18 time::{Duration, Instant},
19};
20use util::ResultExt;
21
22use x11rb::{
23 connection::{Connection, RequestConnection},
24 cursor,
25 errors::ConnectionError,
26 protocol::randr::ConnectionExt as _,
27 protocol::xinput::ConnectionExt,
28 protocol::xkb::ConnectionExt as _,
29 protocol::xproto::{
30 AtomEnum, ChangeWindowAttributesAux, ClientMessageData, ClientMessageEvent,
31 ConnectionExt as _, EventMask, KeyPressEvent, Visibility,
32 },
33 protocol::{Event, randr, render, xinput, xkb, xproto},
34 resource_manager::Database,
35 wrapper::ConnectionExt as _,
36 xcb_ffi::XCBConnection,
37};
38use xim::{AttributeName, Client, InputStyle, x11rb::X11rbClient};
39use xkbc::x11::ffi::{XKB_X11_MIN_MAJOR_XKB_VERSION, XKB_X11_MIN_MINOR_XKB_VERSION};
40use xkbcommon::xkb::{self as xkbc, STATE_LAYOUT_EFFECTIVE};
41
42use super::{
43 ButtonOrScroll, ScrollDirection, X11Display, X11WindowStatePtr, XcbAtoms, XimCallbackEvent,
44 XimHandler, button_or_scroll_from_event_detail, check_reply,
45 clipboard::{self, Clipboard},
46 get_reply, get_valuator_axis_index, handle_connection_error, modifiers_from_state,
47 pressed_button_from_mask,
48};
49
50use crate::platform::{
51 LinuxCommon, PlatformWindow,
52 blade::BladeContext,
53 linux::{
54 DEFAULT_CURSOR_ICON_NAME, LinuxClient, get_xkb_compose_state, is_within_click_distance,
55 log_cursor_icon_warning, open_uri_internal,
56 platform::{DOUBLE_CLICK_INTERVAL, SCROLL_LINES},
57 reveal_path_internal,
58 xdg_desktop_portal::{Event as XDPEvent, XDPEventSource},
59 },
60};
61use crate::{
62 AnyWindowHandle, Bounds, ClipboardItem, CursorStyle, DisplayId, FileDropEvent, Keystroke,
63 LinuxKeyboardLayout, Modifiers, ModifiersChangedEvent, MouseButton, Pixels, Platform,
64 PlatformDisplay, PlatformInput, PlatformKeyboardLayout, Point, RequestFrameOptions,
65 ScaledPixels, ScrollDelta, Size, TouchPhase, WindowParams, X11Window,
66 modifiers_from_xinput_info, point, px,
67};
68
69/// Value for DeviceId parameters which selects all devices.
70pub(crate) const XINPUT_ALL_DEVICES: xinput::DeviceId = 0;
71
72/// Value for DeviceId parameters which selects all device groups. Events that
73/// occur within the group are emitted by the group itself.
74///
75/// In XInput 2's interface, these are referred to as "master devices", but that
76/// terminology is both archaic and unclear.
77pub(crate) const XINPUT_ALL_DEVICE_GROUPS: xinput::DeviceId = 1;
78
79const GPUI_X11_SCALE_FACTOR_ENV: &str = "GPUI_X11_SCALE_FACTOR";
80
81pub(crate) struct WindowRef {
82 window: X11WindowStatePtr,
83 refresh_state: Option<RefreshState>,
84 expose_event_received: bool,
85 last_visibility: Visibility,
86 is_mapped: bool,
87}
88
89impl WindowRef {
90 pub fn handle(&self) -> AnyWindowHandle {
91 self.window.state.borrow().handle
92 }
93}
94
95impl Deref for WindowRef {
96 type Target = X11WindowStatePtr;
97
98 fn deref(&self) -> &Self::Target {
99 &self.window
100 }
101}
102
103enum RefreshState {
104 Hidden {
105 refresh_rate: Duration,
106 },
107 PeriodicRefresh {
108 refresh_rate: Duration,
109 event_loop_token: RegistrationToken,
110 },
111}
112
113#[derive(Debug)]
114#[non_exhaustive]
115pub enum EventHandlerError {
116 XCBConnectionError(ConnectionError),
117 XIMClientError(xim::ClientError),
118}
119
120impl std::error::Error for EventHandlerError {}
121
122impl std::fmt::Display for EventHandlerError {
123 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
124 match self {
125 EventHandlerError::XCBConnectionError(err) => err.fmt(f),
126 EventHandlerError::XIMClientError(err) => err.fmt(f),
127 }
128 }
129}
130
131impl From<ConnectionError> for EventHandlerError {
132 fn from(err: ConnectionError) -> Self {
133 EventHandlerError::XCBConnectionError(err)
134 }
135}
136
137impl From<xim::ClientError> for EventHandlerError {
138 fn from(err: xim::ClientError) -> Self {
139 EventHandlerError::XIMClientError(err)
140 }
141}
142
143#[derive(Debug, Default)]
144pub struct Xdnd {
145 other_window: xproto::Window,
146 drag_type: u32,
147 retrieved: bool,
148 position: Point<Pixels>,
149}
150
151#[derive(Debug)]
152struct PointerDeviceState {
153 horizontal: ScrollAxisState,
154 vertical: ScrollAxisState,
155}
156
157#[derive(Debug, Default)]
158struct ScrollAxisState {
159 /// Valuator number for looking up this axis's scroll value.
160 valuator_number: Option<u16>,
161 /// Conversion factor from scroll units to lines.
162 multiplier: f32,
163 /// Last scroll value for calculating scroll delta.
164 ///
165 /// This gets set to `None` whenever it might be invalid - when devices change or when window focus changes.
166 /// The logic errs on the side of invalidating this, since the consequence is just skipping the delta of one scroll event.
167 /// The consequence of not invalidating it can be large invalid deltas, which are much more user visible.
168 scroll_value: Option<f32>,
169}
170
171pub struct X11ClientState {
172 pub(crate) loop_handle: LoopHandle<'static, X11Client>,
173 pub(crate) event_loop: Option<calloop::EventLoop<'static, X11Client>>,
174
175 pub(crate) last_click: Instant,
176 pub(crate) last_mouse_button: Option<MouseButton>,
177 pub(crate) last_location: Point<Pixels>,
178 pub(crate) current_count: usize,
179
180 gpu_context: BladeContext,
181
182 pub(crate) scale_factor: f32,
183
184 xkb_context: xkbc::Context,
185 pub(crate) xcb_connection: Rc<XCBConnection>,
186 xkb_device_id: i32,
187 client_side_decorations_supported: bool,
188 pub(crate) x_root_index: usize,
189 pub(crate) _resource_database: Database,
190 pub(crate) atoms: XcbAtoms,
191 pub(crate) windows: HashMap<xproto::Window, WindowRef>,
192 pub(crate) mouse_focused_window: Option<xproto::Window>,
193 pub(crate) keyboard_focused_window: Option<xproto::Window>,
194 pub(crate) xkb: xkbc::State,
195 keyboard_layout: LinuxKeyboardLayout,
196 pub(crate) ximc: Option<X11rbClient<Rc<XCBConnection>>>,
197 pub(crate) xim_handler: Option<XimHandler>,
198 pub modifiers: Modifiers,
199 pub capslock: Capslock,
200 // TODO: Can the other updates to `modifiers` be removed so that this is unnecessary?
201 // capslock logic was done analog to modifiers
202 pub last_modifiers_changed_event: Modifiers,
203 pub last_capslock_changed_event: Capslock,
204
205 pub(crate) compose_state: Option<xkbc::compose::State>,
206 pub(crate) pre_edit_text: Option<String>,
207 pub(crate) composing: bool,
208 pub(crate) pre_key_char_down: Option<Keystroke>,
209 pub(crate) cursor_handle: cursor::Handle,
210 pub(crate) cursor_styles: HashMap<xproto::Window, CursorStyle>,
211 pub(crate) cursor_cache: HashMap<CursorStyle, Option<xproto::Cursor>>,
212
213 pointer_device_states: BTreeMap<xinput::DeviceId, PointerDeviceState>,
214
215 pub(crate) common: LinuxCommon,
216 pub(crate) clipboard: Clipboard,
217 pub(crate) clipboard_item: Option<ClipboardItem>,
218 pub(crate) xdnd_state: Xdnd,
219}
220
221#[derive(Clone)]
222pub struct X11ClientStatePtr(pub Weak<RefCell<X11ClientState>>);
223
224impl X11ClientStatePtr {
225 fn get_client(&self) -> Option<X11Client> {
226 self.0.upgrade().map(X11Client)
227 }
228
229 pub fn drop_window(&self, x_window: u32) {
230 let Some(client) = self.get_client() else {
231 return;
232 };
233 let mut state = client.0.borrow_mut();
234
235 if let Some(window_ref) = state.windows.remove(&x_window) {
236 match window_ref.refresh_state {
237 Some(RefreshState::PeriodicRefresh {
238 event_loop_token, ..
239 }) => {
240 state.loop_handle.remove(event_loop_token);
241 }
242 _ => {}
243 }
244 }
245 if state.mouse_focused_window == Some(x_window) {
246 state.mouse_focused_window = None;
247 }
248 if state.keyboard_focused_window == Some(x_window) {
249 state.keyboard_focused_window = None;
250 }
251 state.cursor_styles.remove(&x_window);
252
253 if state.windows.is_empty() {
254 state.common.signal.stop();
255 }
256 }
257
258 pub fn update_ime_position(&self, bounds: Bounds<ScaledPixels>) {
259 let Some(client) = self.get_client() else {
260 return;
261 };
262 let mut state = client.0.borrow_mut();
263 if state.composing || state.ximc.is_none() {
264 return;
265 }
266
267 let Some(mut ximc) = state.ximc.take() else {
268 log::error!("bug: xim connection not set");
269 return;
270 };
271 let Some(xim_handler) = state.xim_handler.take() else {
272 log::error!("bug: xim handler not set");
273 state.ximc = Some(ximc);
274 return;
275 };
276 let ic_attributes = ximc
277 .build_ic_attributes()
278 .push(
279 xim::AttributeName::InputStyle,
280 xim::InputStyle::PREEDIT_CALLBACKS,
281 )
282 .push(xim::AttributeName::ClientWindow, xim_handler.window)
283 .push(xim::AttributeName::FocusWindow, xim_handler.window)
284 .nested_list(xim::AttributeName::PreeditAttributes, |b| {
285 b.push(
286 xim::AttributeName::SpotLocation,
287 xim::Point {
288 x: u32::from(bounds.origin.x + bounds.size.width) as i16,
289 y: u32::from(bounds.origin.y + bounds.size.height) as i16,
290 },
291 );
292 })
293 .build();
294 let _ = ximc
295 .set_ic_values(xim_handler.im_id, xim_handler.ic_id, ic_attributes)
296 .log_err();
297 state.ximc = Some(ximc);
298 state.xim_handler = Some(xim_handler);
299 }
300}
301
302#[derive(Clone)]
303pub(crate) struct X11Client(Rc<RefCell<X11ClientState>>);
304
305impl X11Client {
306 pub(crate) fn new() -> anyhow::Result<Self> {
307 let event_loop = EventLoop::try_new()?;
308
309 let (common, main_receiver) = LinuxCommon::new(event_loop.get_signal());
310
311 let handle = event_loop.handle();
312
313 handle
314 .insert_source(main_receiver, {
315 let handle = handle.clone();
316 move |event, _, _: &mut X11Client| {
317 if let calloop::channel::Event::Msg(runnable) = event {
318 // Insert the runnables as idle callbacks, so we make sure that user-input and X11
319 // events have higher priority and runnables are only worked off after the event
320 // callbacks.
321 handle.insert_idle(|_| {
322 runnable.run();
323 });
324 }
325 }
326 })
327 .map_err(|err| {
328 anyhow!("Failed to initialize event loop handling of foreground tasks: {err:?}")
329 })?;
330
331 let (xcb_connection, x_root_index) = XCBConnection::connect(None)?;
332 xcb_connection.prefetch_extension_information(xkb::X11_EXTENSION_NAME)?;
333 xcb_connection.prefetch_extension_information(randr::X11_EXTENSION_NAME)?;
334 xcb_connection.prefetch_extension_information(render::X11_EXTENSION_NAME)?;
335 xcb_connection.prefetch_extension_information(xinput::X11_EXTENSION_NAME)?;
336
337 // Announce to X server that XInput up to 2.1 is supported. To increase this to 2.2 and
338 // beyond, support for touch events would need to be added.
339 let xinput_version = get_reply(
340 || "XInput XiQueryVersion failed",
341 xcb_connection.xinput_xi_query_version(2, 1),
342 )?;
343 assert!(
344 xinput_version.major_version >= 2,
345 "XInput version >= 2 required."
346 );
347
348 let pointer_device_states =
349 current_pointer_device_states(&xcb_connection, &BTreeMap::new()).unwrap_or_default();
350
351 let atoms = XcbAtoms::new(&xcb_connection)
352 .context("Failed to get XCB atoms")?
353 .reply()
354 .context("Failed to get XCB atoms")?;
355
356 let root = xcb_connection.setup().roots[0].root;
357 let compositor_present = check_compositor_present(&xcb_connection, root);
358 let gtk_frame_extents_supported =
359 check_gtk_frame_extents_supported(&xcb_connection, &atoms, root);
360 let client_side_decorations_supported = compositor_present && gtk_frame_extents_supported;
361 log::info!(
362 "x11: compositor present: {}, gtk_frame_extents_supported: {}",
363 compositor_present,
364 gtk_frame_extents_supported
365 );
366
367 let xkb = get_reply(
368 || "Failed to initialize XKB extension",
369 xcb_connection
370 .xkb_use_extension(XKB_X11_MIN_MAJOR_XKB_VERSION, XKB_X11_MIN_MINOR_XKB_VERSION),
371 )?;
372 assert!(xkb.supported);
373
374 let events = xkb::EventType::STATE_NOTIFY
375 | xkb::EventType::MAP_NOTIFY
376 | xkb::EventType::NEW_KEYBOARD_NOTIFY;
377 let map_notify_parts = xkb::MapPart::KEY_TYPES
378 | xkb::MapPart::KEY_SYMS
379 | xkb::MapPart::MODIFIER_MAP
380 | xkb::MapPart::EXPLICIT_COMPONENTS
381 | xkb::MapPart::KEY_ACTIONS
382 | xkb::MapPart::KEY_BEHAVIORS
383 | xkb::MapPart::VIRTUAL_MODS
384 | xkb::MapPart::VIRTUAL_MOD_MAP;
385 check_reply(
386 || "Failed to select XKB events",
387 xcb_connection.xkb_select_events(
388 xkb::ID::USE_CORE_KBD.into(),
389 0u8.into(),
390 events,
391 map_notify_parts,
392 map_notify_parts,
393 &xkb::SelectEventsAux::new(),
394 ),
395 )?;
396
397 let xkb_context = xkbc::Context::new(xkbc::CONTEXT_NO_FLAGS);
398 let xkb_device_id = xkbc::x11::get_core_keyboard_device_id(&xcb_connection);
399 let xkb_state = {
400 let xkb_keymap = xkbc::x11::keymap_new_from_device(
401 &xkb_context,
402 &xcb_connection,
403 xkb_device_id,
404 xkbc::KEYMAP_COMPILE_NO_FLAGS,
405 );
406 xkbc::x11::state_new_from_device(&xkb_keymap, &xcb_connection, xkb_device_id)
407 };
408 let compose_state = get_xkb_compose_state(&xkb_context);
409 let layout_idx = xkb_state.serialize_layout(STATE_LAYOUT_EFFECTIVE);
410 let layout_name = xkb_state
411 .get_keymap()
412 .layout_get_name(layout_idx)
413 .to_string();
414 let keyboard_layout = LinuxKeyboardLayout::new(layout_name.into());
415
416 let gpu_context = BladeContext::new().context("Unable to init GPU context")?;
417
418 let resource_database = x11rb::resource_manager::new_from_default(&xcb_connection)
419 .context("Failed to create resource database")?;
420 let scale_factor = get_scale_factor(&xcb_connection, &resource_database, x_root_index);
421 let cursor_handle = cursor::Handle::new(&xcb_connection, x_root_index, &resource_database)
422 .context("Failed to initialize cursor theme handler")?
423 .reply()
424 .context("Failed to initialize cursor theme handler")?;
425
426 let clipboard = Clipboard::new().context("Failed to initialize clipboard")?;
427
428 let xcb_connection = Rc::new(xcb_connection);
429
430 let ximc = X11rbClient::init(Rc::clone(&xcb_connection), x_root_index, None).ok();
431 let xim_handler = if ximc.is_some() {
432 Some(XimHandler::new())
433 } else {
434 None
435 };
436
437 // Safety: Safe if xcb::Connection always returns a valid fd
438 let fd = unsafe { FdWrapper::new(Rc::clone(&xcb_connection)) };
439
440 handle
441 .insert_source(
442 Generic::new_with_error::<EventHandlerError>(
443 fd,
444 calloop::Interest::READ,
445 calloop::Mode::Level,
446 ),
447 {
448 let xcb_connection = xcb_connection.clone();
449 move |_readiness, _, client| {
450 client.process_x11_events(&xcb_connection)?;
451 Ok(calloop::PostAction::Continue)
452 }
453 },
454 )
455 .map_err(|err| anyhow!("Failed to initialize X11 event source: {err:?}"))?;
456
457 handle
458 .insert_source(XDPEventSource::new(&common.background_executor), {
459 move |event, _, client| match event {
460 XDPEvent::WindowAppearance(appearance) => {
461 client.with_common(|common| common.appearance = appearance);
462 for (_, window) in &mut client.0.borrow_mut().windows {
463 window.window.set_appearance(appearance);
464 }
465 }
466 XDPEvent::CursorTheme(_) | XDPEvent::CursorSize(_) => {
467 // noop, X11 manages this for us.
468 }
469 }
470 })
471 .map_err(|err| anyhow!("Failed to initialize XDP event source: {err:?}"))?;
472
473 xcb_flush(&xcb_connection);
474
475 Ok(X11Client(Rc::new(RefCell::new(X11ClientState {
476 modifiers: Modifiers::default(),
477 capslock: Capslock::default(),
478 last_modifiers_changed_event: Modifiers::default(),
479 last_capslock_changed_event: Capslock::default(),
480 event_loop: Some(event_loop),
481 loop_handle: handle,
482 common,
483 last_click: Instant::now(),
484 last_mouse_button: None,
485 last_location: Point::new(px(0.0), px(0.0)),
486 current_count: 0,
487 gpu_context,
488 scale_factor,
489
490 xkb_context,
491 xcb_connection,
492 xkb_device_id,
493 client_side_decorations_supported,
494 x_root_index,
495 _resource_database: resource_database,
496 atoms,
497 windows: HashMap::default(),
498 mouse_focused_window: None,
499 keyboard_focused_window: None,
500 xkb: xkb_state,
501 keyboard_layout,
502 ximc,
503 xim_handler,
504
505 compose_state,
506 pre_edit_text: None,
507 pre_key_char_down: None,
508 composing: false,
509
510 cursor_handle,
511 cursor_styles: HashMap::default(),
512 cursor_cache: HashMap::default(),
513
514 pointer_device_states,
515
516 clipboard,
517 clipboard_item: None,
518 xdnd_state: Xdnd::default(),
519 }))))
520 }
521
522 pub fn process_x11_events(
523 &self,
524 xcb_connection: &XCBConnection,
525 ) -> Result<(), EventHandlerError> {
526 loop {
527 let mut events = Vec::new();
528 let mut windows_to_refresh = HashSet::new();
529
530 let mut last_key_release = None;
531 let mut last_key_press: Option<KeyPressEvent> = None;
532
533 // event handlers for new keyboard / remapping refresh the state without using event
534 // details, this deduplicates them.
535 let mut last_keymap_change_event: Option<Event> = None;
536
537 loop {
538 match xcb_connection.poll_for_event() {
539 Ok(Some(event)) => {
540 match event {
541 Event::Expose(expose_event) => {
542 windows_to_refresh.insert(expose_event.window);
543 }
544 Event::KeyRelease(_) => {
545 if let Some(last_keymap_change_event) =
546 last_keymap_change_event.take()
547 {
548 if let Some(last_key_release) = last_key_release.take() {
549 events.push(last_key_release);
550 }
551 last_key_press = None;
552 events.push(last_keymap_change_event);
553 }
554
555 last_key_release = Some(event);
556 }
557 Event::KeyPress(key_press) => {
558 if let Some(last_keymap_change_event) =
559 last_keymap_change_event.take()
560 {
561 if let Some(last_key_release) = last_key_release.take() {
562 events.push(last_key_release);
563 }
564 last_key_press = None;
565 events.push(last_keymap_change_event);
566 }
567
568 if let Some(last_press) = last_key_press.as_ref() {
569 if last_press.detail == key_press.detail {
570 continue;
571 }
572 }
573
574 if let Some(Event::KeyRelease(key_release)) =
575 last_key_release.take()
576 {
577 // We ignore that last KeyRelease if it's too close to this KeyPress,
578 // suggesting that it's auto-generated by X11 as a key-repeat event.
579 if key_release.detail != key_press.detail
580 || key_press.time.saturating_sub(key_release.time) > 20
581 {
582 events.push(Event::KeyRelease(key_release));
583 }
584 }
585 events.push(Event::KeyPress(key_press));
586 last_key_press = Some(key_press);
587 }
588 Event::XkbNewKeyboardNotify(_) | Event::XkbMapNotify(_) => {
589 if let Some(release_event) = last_key_release.take() {
590 events.push(release_event);
591 }
592 last_keymap_change_event = Some(event);
593 }
594 _ => {
595 if let Some(release_event) = last_key_release.take() {
596 events.push(release_event);
597 }
598 events.push(event);
599 }
600 }
601 }
602 Ok(None) => {
603 break;
604 }
605 Err(err) => {
606 let err = handle_connection_error(err);
607 log::warn!("error while polling for X11 events: {err:?}");
608 break;
609 }
610 }
611 }
612
613 if let Some(release_event) = last_key_release.take() {
614 events.push(release_event);
615 }
616 if let Some(keymap_change_event) = last_keymap_change_event.take() {
617 events.push(keymap_change_event);
618 }
619
620 if events.is_empty() && windows_to_refresh.is_empty() {
621 break;
622 }
623
624 for window in windows_to_refresh.into_iter() {
625 let mut state = self.0.borrow_mut();
626 if let Some(window) = state.windows.get_mut(&window) {
627 window.expose_event_received = true;
628 }
629 }
630
631 for event in events.into_iter() {
632 let mut state = self.0.borrow_mut();
633 if !state.has_xim() {
634 dbg!("XIM: no XIM available for key event");
635 drop(state);
636 self.handle_event(event);
637 continue;
638 }
639
640 let Some((mut ximc, mut xim_handler)) = state.take_xim() else {
641 dbg!("XIM: failed to take XIM for key event");
642 continue;
643 };
644 let xim_connected = xim_handler.connected;
645 dbg!("XIM: processing key event", xim_connected);
646 drop(state);
647
648 let xim_filtered = match ximc.filter_event(&event, &mut xim_handler) {
649 Ok(handled) => {
650 dbg!("XIM: filter_event result", handled);
651 handled
652 },
653 Err(err) => {
654 dbg!("XIM: filter_event error", &err);
655 log::error!("XIMClientError: {}", err);
656 false
657 }
658 };
659 let xim_callback_event = xim_handler.last_callback_event.take();
660 dbg!("XIM: callback event present", xim_callback_event.is_some());
661
662 let mut state = self.0.borrow_mut();
663 state.restore_xim(ximc, xim_handler);
664 drop(state);
665
666 if let Some(event) = xim_callback_event {
667 dbg!("XIM: handling callback event");
668 self.handle_xim_callback_event(event);
669 }
670
671 if xim_filtered {
672 dbg!("XIM: event was filtered, not processing further");
673 continue;
674 }
675
676 if xim_connected {
677 dbg!("XIM: forwarding event to XIM");
678 self.xim_handle_event(event);
679 } else {
680 self.handle_event(event);
681 dbg!("XIM: not connected, skipping XIM event handling");
682 }
683 }
684 }
685 Ok(())
686 }
687
688 pub fn enable_ime(&self) {
689 let mut state = self.0.borrow_mut();
690 if !state.has_xim() {
691 return;
692 }
693
694 let Some((mut ximc, mut xim_handler)) = state.take_xim() else {
695 return;
696 };
697 let mut ic_attributes = ximc
698 .build_ic_attributes()
699 .push(AttributeName::InputStyle, InputStyle::PREEDIT_CALLBACKS)
700 .push(AttributeName::ClientWindow, xim_handler.window)
701 .push(AttributeName::FocusWindow, xim_handler.window);
702
703 let window_id = state.keyboard_focused_window;
704 drop(state);
705 if let Some(window_id) = window_id {
706 let Some(window) = self.get_window(window_id) else {
707 log::error!("Failed to get window for IME positioning");
708 let mut state = self.0.borrow_mut();
709 state.ximc = Some(ximc);
710 state.xim_handler = Some(xim_handler);
711 return;
712 };
713 if let Some(area) = window.get_ime_area() {
714 ic_attributes =
715 ic_attributes.nested_list(xim::AttributeName::PreeditAttributes, |b| {
716 b.push(
717 xim::AttributeName::SpotLocation,
718 xim::Point {
719 x: u32::from(area.origin.x + area.size.width) as i16,
720 y: u32::from(area.origin.y + area.size.height) as i16,
721 },
722 );
723 });
724 }
725 }
726 ximc.create_ic(xim_handler.im_id, ic_attributes.build())
727 .ok();
728 let mut state = self.0.borrow_mut();
729 state.restore_xim(ximc, xim_handler);
730 }
731
732 pub fn reset_ime(&self) {
733 let mut state = self.0.borrow_mut();
734 state.composing = false;
735 if let Some(mut ximc) = state.ximc.take() {
736 if let Some(xim_handler) = state.xim_handler.as_ref() {
737 ximc.reset_ic(xim_handler.im_id, xim_handler.ic_id).ok();
738 } else {
739 log::error!("bug: xim handler not set in reset_ime");
740 }
741 state.ximc = Some(ximc);
742 }
743 }
744
745 fn get_window(&self, win: xproto::Window) -> Option<X11WindowStatePtr> {
746 let state = self.0.borrow();
747 state
748 .windows
749 .get(&win)
750 .filter(|window_reference| !window_reference.window.state.borrow().destroyed)
751 .map(|window_reference| window_reference.window.clone())
752 }
753
754 fn handle_event(&self, event: Event) -> Option<()> {
755 match event {
756 Event::UnmapNotify(event) => {
757 let mut state = self.0.borrow_mut();
758 if let Some(window_ref) = state.windows.get_mut(&event.window) {
759 window_ref.is_mapped = false;
760 }
761 state.update_refresh_loop(event.window);
762 }
763 Event::MapNotify(event) => {
764 let mut state = self.0.borrow_mut();
765 if let Some(window_ref) = state.windows.get_mut(&event.window) {
766 window_ref.is_mapped = true;
767 }
768 state.update_refresh_loop(event.window);
769 }
770 Event::VisibilityNotify(event) => {
771 let mut state = self.0.borrow_mut();
772 if let Some(window_ref) = state.windows.get_mut(&event.window) {
773 window_ref.last_visibility = event.state;
774 }
775 state.update_refresh_loop(event.window);
776 }
777 Event::ClientMessage(event) => {
778 let window = self.get_window(event.window)?;
779 let [atom, arg1, arg2, arg3, arg4] = event.data.as_data32();
780 let mut state = self.0.borrow_mut();
781
782 if atom == state.atoms.WM_DELETE_WINDOW {
783 // window "x" button clicked by user
784 if window.should_close() {
785 // Rest of the close logic is handled in drop_window()
786 window.close();
787 }
788 } else if atom == state.atoms._NET_WM_SYNC_REQUEST {
789 window.state.borrow_mut().last_sync_counter =
790 Some(x11rb::protocol::sync::Int64 {
791 lo: arg2,
792 hi: arg3 as i32,
793 })
794 }
795
796 if event.type_ == state.atoms.XdndEnter {
797 state.xdnd_state.other_window = atom;
798 if (arg1 & 0x1) == 0x1 {
799 state.xdnd_state.drag_type = xdnd_get_supported_atom(
800 &state.xcb_connection,
801 &state.atoms,
802 state.xdnd_state.other_window,
803 );
804 } else {
805 if let Some(atom) = [arg2, arg3, arg4]
806 .into_iter()
807 .find(|atom| xdnd_is_atom_supported(*atom, &state.atoms))
808 {
809 state.xdnd_state.drag_type = atom;
810 }
811 }
812 } else if event.type_ == state.atoms.XdndLeave {
813 let position = state.xdnd_state.position;
814 drop(state);
815 window
816 .handle_input(PlatformInput::FileDrop(FileDropEvent::Pending { position }));
817 window.handle_input(PlatformInput::FileDrop(FileDropEvent::Exited {}));
818 self.0.borrow_mut().xdnd_state = Xdnd::default();
819 } else if event.type_ == state.atoms.XdndPosition {
820 if let Ok(pos) = get_reply(
821 || "Failed to query pointer position",
822 state.xcb_connection.query_pointer(event.window),
823 ) {
824 state.xdnd_state.position =
825 Point::new(Pixels(pos.win_x as f32), Pixels(pos.win_y as f32));
826 }
827 if !state.xdnd_state.retrieved {
828 check_reply(
829 || "Failed to convert selection for drag and drop",
830 state.xcb_connection.convert_selection(
831 event.window,
832 state.atoms.XdndSelection,
833 state.xdnd_state.drag_type,
834 state.atoms.XDND_DATA,
835 arg3,
836 ),
837 )
838 .log_err();
839 }
840 xdnd_send_status(
841 &state.xcb_connection,
842 &state.atoms,
843 event.window,
844 state.xdnd_state.other_window,
845 arg4,
846 );
847 let position = state.xdnd_state.position;
848 drop(state);
849 window
850 .handle_input(PlatformInput::FileDrop(FileDropEvent::Pending { position }));
851 } else if event.type_ == state.atoms.XdndDrop {
852 xdnd_send_finished(
853 &state.xcb_connection,
854 &state.atoms,
855 event.window,
856 state.xdnd_state.other_window,
857 );
858 let position = state.xdnd_state.position;
859 drop(state);
860 window
861 .handle_input(PlatformInput::FileDrop(FileDropEvent::Submit { position }));
862 self.0.borrow_mut().xdnd_state = Xdnd::default();
863 }
864 }
865 Event::SelectionNotify(event) => {
866 let window = self.get_window(event.requestor)?;
867 let mut state = self.0.borrow_mut();
868 let reply = get_reply(
869 || "Failed to get XDND_DATA",
870 state.xcb_connection.get_property(
871 false,
872 event.requestor,
873 state.atoms.XDND_DATA,
874 AtomEnum::ANY,
875 0,
876 1024,
877 ),
878 )
879 .log_err();
880 let Some(reply) = reply else {
881 return Some(());
882 };
883 match str::from_utf8(&reply.value) {
884 Ok(file_list) => {
885 let paths: SmallVec<[_; 2]> = file_list
886 .lines()
887 .filter_map(|path| Url::parse(path).log_err())
888 .filter_map(|url| url.to_file_path().log_err())
889 .collect();
890 let input = PlatformInput::FileDrop(FileDropEvent::Entered {
891 position: state.xdnd_state.position,
892 paths: crate::ExternalPaths(paths),
893 });
894 drop(state);
895 window.handle_input(input);
896 self.0.borrow_mut().xdnd_state.retrieved = true;
897 }
898 Err(_) => {}
899 }
900 }
901 Event::ConfigureNotify(event) => {
902 let bounds = Bounds {
903 origin: Point {
904 x: event.x.into(),
905 y: event.y.into(),
906 },
907 size: Size {
908 width: event.width.into(),
909 height: event.height.into(),
910 },
911 };
912 let window = self.get_window(event.window)?;
913 window
914 .set_bounds(bounds)
915 .context("X11: Failed to set window bounds")
916 .log_err();
917 }
918 Event::PropertyNotify(event) => {
919 let window = self.get_window(event.window)?;
920 window
921 .property_notify(event)
922 .context("X11: Failed to handle property notify")
923 .log_err();
924 }
925 Event::FocusIn(event) => {
926 let window = self.get_window(event.event)?;
927 window.set_active(true);
928 let mut state = self.0.borrow_mut();
929 state.keyboard_focused_window = Some(event.event);
930 if let Some(handler) = state.xim_handler.as_mut() {
931 handler.window = event.event;
932 }
933 drop(state);
934 self.enable_ime();
935 }
936 Event::FocusOut(event) => {
937 let window = self.get_window(event.event)?;
938 window.set_active(false);
939 let mut state = self.0.borrow_mut();
940 state.keyboard_focused_window = None;
941 if let Some(compose_state) = state.compose_state.as_mut() {
942 compose_state.reset();
943 }
944 state.pre_edit_text.take();
945 drop(state);
946 self.reset_ime();
947 window.handle_ime_delete();
948 }
949 Event::XkbNewKeyboardNotify(_) | Event::XkbMapNotify(_) => {
950 let mut state = self.0.borrow_mut();
951 let xkb_state = {
952 let xkb_keymap = xkbc::x11::keymap_new_from_device(
953 &state.xkb_context,
954 &state.xcb_connection,
955 state.xkb_device_id,
956 xkbc::KEYMAP_COMPILE_NO_FLAGS,
957 );
958 xkbc::x11::state_new_from_device(
959 &xkb_keymap,
960 &state.xcb_connection,
961 state.xkb_device_id,
962 )
963 };
964 state.xkb = xkb_state;
965 drop(state);
966 self.handle_keyboard_layout_change();
967 }
968 Event::XkbStateNotify(event) => {
969 let mut state = self.0.borrow_mut();
970 let old_layout = state.xkb.serialize_layout(STATE_LAYOUT_EFFECTIVE);
971 let new_layout = u32::from(event.group);
972 state.xkb.update_mask(
973 event.base_mods.into(),
974 event.latched_mods.into(),
975 event.locked_mods.into(),
976 event.base_group as u32,
977 event.latched_group as u32,
978 event.locked_group.into(),
979 );
980 let modifiers = Modifiers::from_xkb(&state.xkb);
981 let capslock = Capslock::from_xkb(&state.xkb);
982 if state.last_modifiers_changed_event == modifiers
983 && state.last_capslock_changed_event == capslock
984 {
985 drop(state);
986 } else {
987 let focused_window_id = state.keyboard_focused_window?;
988 state.modifiers = modifiers;
989 state.last_modifiers_changed_event = modifiers;
990 state.capslock = capslock;
991 state.last_capslock_changed_event = capslock;
992 drop(state);
993
994 let focused_window = self.get_window(focused_window_id)?;
995 focused_window.handle_input(PlatformInput::ModifiersChanged(
996 ModifiersChangedEvent {
997 modifiers,
998 capslock,
999 },
1000 ));
1001 }
1002
1003 if new_layout != old_layout {
1004 self.handle_keyboard_layout_change();
1005 }
1006 }
1007 Event::KeyPress(event) => {
1008 let window = self.get_window(event.event)?;
1009 let mut state = self.0.borrow_mut();
1010
1011 let modifiers = modifiers_from_state(event.state);
1012 state.modifiers = modifiers;
1013 state.pre_key_char_down.take();
1014 let keystroke = {
1015 let code = event.detail.into();
1016 let mut keystroke = crate::Keystroke::from_xkb(&state.xkb, modifiers, code);
1017 let keysym = state.xkb.key_get_one_sym(code);
1018
1019 if keysym.is_modifier_key() {
1020 return Some(());
1021 }
1022
1023 // should be called after key_get_one_sym
1024 state.xkb.update_key(code, xkbc::KeyDirection::Down);
1025
1026 if let Some(mut compose_state) = state.compose_state.take() {
1027 compose_state.feed(keysym);
1028 match compose_state.status() {
1029 xkbc::Status::Composed => {
1030 state.pre_edit_text.take();
1031 keystroke.key_char = compose_state.utf8();
1032 if let Some(keysym) = compose_state.keysym() {
1033 keystroke.key = xkbc::keysym_get_name(keysym);
1034 }
1035 }
1036 xkbc::Status::Composing => {
1037 keystroke.key_char = None;
1038 state.pre_edit_text = compose_state
1039 .utf8()
1040 .or(crate::Keystroke::underlying_dead_key(keysym));
1041 let pre_edit =
1042 state.pre_edit_text.clone().unwrap_or(String::default());
1043 drop(state);
1044 window.handle_ime_preedit(pre_edit);
1045 state = self.0.borrow_mut();
1046 }
1047 xkbc::Status::Cancelled => {
1048 let pre_edit = state.pre_edit_text.take();
1049 drop(state);
1050 if let Some(pre_edit) = pre_edit {
1051 window.handle_ime_commit(pre_edit);
1052 }
1053 if let Some(current_key) = Keystroke::underlying_dead_key(keysym) {
1054 window.handle_ime_preedit(current_key);
1055 }
1056 state = self.0.borrow_mut();
1057 compose_state.feed(keysym);
1058 }
1059 _ => {}
1060 }
1061 state.compose_state = Some(compose_state);
1062 }
1063 keystroke
1064 };
1065 drop(state);
1066 window.handle_input(PlatformInput::KeyDown(crate::KeyDownEvent {
1067 keystroke,
1068 is_held: false,
1069 }));
1070 }
1071 Event::KeyRelease(event) => {
1072 let window = self.get_window(event.event)?;
1073 let mut state = self.0.borrow_mut();
1074
1075 let modifiers = modifiers_from_state(event.state);
1076 state.modifiers = modifiers;
1077
1078 let keystroke = {
1079 let code = event.detail.into();
1080 let keystroke = crate::Keystroke::from_xkb(&state.xkb, modifiers, code);
1081 let keysym = state.xkb.key_get_one_sym(code);
1082
1083 if keysym.is_modifier_key() {
1084 return Some(());
1085 }
1086
1087 // should be called after key_get_one_sym
1088 state.xkb.update_key(code, xkbc::KeyDirection::Up);
1089
1090 keystroke
1091 };
1092 drop(state);
1093 window.handle_input(PlatformInput::KeyUp(crate::KeyUpEvent { keystroke }));
1094 }
1095 Event::XinputButtonPress(event) => {
1096 let window = self.get_window(event.event)?;
1097 let mut state = self.0.borrow_mut();
1098
1099 let modifiers = modifiers_from_xinput_info(event.mods);
1100 state.modifiers = modifiers;
1101
1102 let position = point(
1103 px(event.event_x as f32 / u16::MAX as f32 / state.scale_factor),
1104 px(event.event_y as f32 / u16::MAX as f32 / state.scale_factor),
1105 );
1106
1107 if state.composing && state.ximc.is_some() {
1108 drop(state);
1109 self.reset_ime();
1110 window.handle_ime_unmark();
1111 state = self.0.borrow_mut();
1112 } else if let Some(text) = state.pre_edit_text.take() {
1113 if let Some(compose_state) = state.compose_state.as_mut() {
1114 compose_state.reset();
1115 }
1116 drop(state);
1117 window.handle_ime_commit(text);
1118 state = self.0.borrow_mut();
1119 }
1120 match button_or_scroll_from_event_detail(event.detail) {
1121 Some(ButtonOrScroll::Button(button)) => {
1122 let click_elapsed = state.last_click.elapsed();
1123 if click_elapsed < DOUBLE_CLICK_INTERVAL
1124 && state
1125 .last_mouse_button
1126 .is_some_and(|prev_button| prev_button == button)
1127 && is_within_click_distance(state.last_location, position)
1128 {
1129 state.current_count += 1;
1130 } else {
1131 state.current_count = 1;
1132 }
1133
1134 state.last_click = Instant::now();
1135 state.last_mouse_button = Some(button);
1136 state.last_location = position;
1137 let current_count = state.current_count;
1138
1139 drop(state);
1140 window.handle_input(PlatformInput::MouseDown(crate::MouseDownEvent {
1141 button,
1142 position,
1143 modifiers,
1144 click_count: current_count,
1145 first_mouse: false,
1146 }));
1147 }
1148 Some(ButtonOrScroll::Scroll(direction)) => {
1149 drop(state);
1150 // Emulated scroll button presses are sent simultaneously with smooth scrolling XinputMotion events.
1151 // Since handling those events does the scrolling, they are skipped here.
1152 if !event
1153 .flags
1154 .contains(xinput::PointerEventFlags::POINTER_EMULATED)
1155 {
1156 let scroll_delta = match direction {
1157 ScrollDirection::Up => Point::new(0.0, SCROLL_LINES),
1158 ScrollDirection::Down => Point::new(0.0, -SCROLL_LINES),
1159 ScrollDirection::Left => Point::new(SCROLL_LINES, 0.0),
1160 ScrollDirection::Right => Point::new(-SCROLL_LINES, 0.0),
1161 };
1162 window.handle_input(PlatformInput::ScrollWheel(
1163 make_scroll_wheel_event(position, scroll_delta, modifiers),
1164 ));
1165 }
1166 }
1167 None => {
1168 log::error!("Unknown x11 button: {}", event.detail);
1169 }
1170 }
1171 }
1172 Event::XinputButtonRelease(event) => {
1173 let window = self.get_window(event.event)?;
1174 let mut state = self.0.borrow_mut();
1175 let modifiers = modifiers_from_xinput_info(event.mods);
1176 state.modifiers = modifiers;
1177
1178 let position = point(
1179 px(event.event_x as f32 / u16::MAX as f32 / state.scale_factor),
1180 px(event.event_y as f32 / u16::MAX as f32 / state.scale_factor),
1181 );
1182 match button_or_scroll_from_event_detail(event.detail) {
1183 Some(ButtonOrScroll::Button(button)) => {
1184 let click_count = state.current_count;
1185 drop(state);
1186 window.handle_input(PlatformInput::MouseUp(crate::MouseUpEvent {
1187 button,
1188 position,
1189 modifiers,
1190 click_count,
1191 }));
1192 }
1193 Some(ButtonOrScroll::Scroll(_)) => {}
1194 None => {}
1195 }
1196 }
1197 Event::XinputMotion(event) => {
1198 let window = self.get_window(event.event)?;
1199 let mut state = self.0.borrow_mut();
1200 let pressed_button = pressed_button_from_mask(event.button_mask[0]);
1201 let position = point(
1202 px(event.event_x as f32 / u16::MAX as f32 / state.scale_factor),
1203 px(event.event_y as f32 / u16::MAX as f32 / state.scale_factor),
1204 );
1205 let modifiers = modifiers_from_xinput_info(event.mods);
1206 state.modifiers = modifiers;
1207 drop(state);
1208
1209 if event.valuator_mask[0] & 3 != 0 {
1210 window.handle_input(PlatformInput::MouseMove(crate::MouseMoveEvent {
1211 position,
1212 pressed_button,
1213 modifiers,
1214 }));
1215 }
1216
1217 state = self.0.borrow_mut();
1218 if let Some(mut pointer) = state.pointer_device_states.get_mut(&event.sourceid) {
1219 let scroll_delta = get_scroll_delta_and_update_state(&mut pointer, &event);
1220 drop(state);
1221 if let Some(scroll_delta) = scroll_delta {
1222 window.handle_input(PlatformInput::ScrollWheel(make_scroll_wheel_event(
1223 position,
1224 scroll_delta,
1225 modifiers,
1226 )));
1227 }
1228 }
1229 }
1230 Event::XinputEnter(event) if event.mode == xinput::NotifyMode::NORMAL => {
1231 let window = self.get_window(event.event)?;
1232 window.set_hovered(true);
1233 let mut state = self.0.borrow_mut();
1234 state.mouse_focused_window = Some(event.event);
1235 }
1236 Event::XinputLeave(event) if event.mode == xinput::NotifyMode::NORMAL => {
1237 let mut state = self.0.borrow_mut();
1238
1239 // Set last scroll values to `None` so that a large delta isn't created if scrolling is done outside the window (the valuator is global)
1240 reset_all_pointer_device_scroll_positions(&mut state.pointer_device_states);
1241 state.mouse_focused_window = None;
1242 let pressed_button = pressed_button_from_mask(event.buttons[0]);
1243 let position = point(
1244 px(event.event_x as f32 / u16::MAX as f32 / state.scale_factor),
1245 px(event.event_y as f32 / u16::MAX as f32 / state.scale_factor),
1246 );
1247 let modifiers = modifiers_from_xinput_info(event.mods);
1248 state.modifiers = modifiers;
1249 drop(state);
1250
1251 let window = self.get_window(event.event)?;
1252 window.handle_input(PlatformInput::MouseExited(crate::MouseExitEvent {
1253 pressed_button,
1254 position,
1255 modifiers,
1256 }));
1257 window.set_hovered(false);
1258 }
1259 Event::XinputHierarchy(event) => {
1260 let mut state = self.0.borrow_mut();
1261 // Temporarily use `state.pointer_device_states` to only store pointers that still have valid scroll values.
1262 // Any change to a device invalidates its scroll values.
1263 for info in event.infos {
1264 if is_pointer_device(info.type_) {
1265 state.pointer_device_states.remove(&info.deviceid);
1266 }
1267 }
1268 if let Some(pointer_device_states) = current_pointer_device_states(
1269 &state.xcb_connection,
1270 &state.pointer_device_states,
1271 ) {
1272 state.pointer_device_states = pointer_device_states;
1273 }
1274 }
1275 Event::XinputDeviceChanged(event) => {
1276 let mut state = self.0.borrow_mut();
1277 if let Some(mut pointer) = state.pointer_device_states.get_mut(&event.sourceid) {
1278 reset_pointer_device_scroll_positions(&mut pointer);
1279 }
1280 }
1281 _ => {}
1282 };
1283
1284 Some(())
1285 }
1286
1287 fn handle_xim_callback_event(&self, event: XimCallbackEvent) {
1288 dbg!("XIM: handle_xim_callback_event called");
1289 match event {
1290 XimCallbackEvent::XimXEvent(event) => {
1291 dbg!("XIM: handling forwarded X event");
1292 self.handle_event(event);
1293 }
1294 XimCallbackEvent::XimCommitEvent(window, text) => {
1295 dbg!("XIM: handling commit event", window, &text);
1296 self.xim_handle_commit(window, text);
1297 }
1298 XimCallbackEvent::XimPreeditEvent(window, text) => {
1299 dbg!("XIM: handling preedit event", window, &text);
1300 self.xim_handle_preedit(window, text);
1301 }
1302 };
1303 }
1304
1305 fn xim_handle_event(&self, event: Event) -> Option<()> {
1306 dbg!("XIM: xim_handle_event called");
1307 match event {
1308 Event::KeyPress(event) | Event::KeyRelease(event) => {
1309 dbg!("XIM: handling key press/release event", event.event);
1310 let mut state = self.0.borrow_mut();
1311 state.pre_key_char_down = Some(Keystroke::from_xkb(
1312 &state.xkb,
1313 state.modifiers,
1314 event.detail.into(),
1315 ));
1316 let (mut ximc, mut xim_handler) = state.take_xim()?;
1317 drop(state);
1318 xim_handler.window = event.event;
1319 dbg!("XIM: forwarding event to XIM server", event.event, xim_handler.im_id, xim_handler.ic_id);
1320 let result = ximc.forward_event(
1321 xim_handler.im_id,
1322 xim_handler.ic_id,
1323 xim::ForwardEventFlag::empty(),
1324 &event,
1325 );
1326 if let Err(ref error) = result {
1327 dbg!("XIM: forward_event error", error);
1328 }
1329 result
1330 .context("X11: Failed to forward XIM event")
1331 .log_err();
1332 let mut state = self.0.borrow_mut();
1333 state.restore_xim(ximc, xim_handler);
1334 drop(state);
1335 }
1336 event => {
1337 dbg!("XIM: forwarding non-key event to normal handler");
1338 self.handle_event(event);
1339 }
1340 }
1341 Some(())
1342 }
1343
1344 fn xim_handle_commit(&self, window: xproto::Window, text: String) -> Option<()> {
1345 dbg!("XIM: xim_handle_commit called", window, &text);
1346 let Some(window) = self.get_window(window) else {
1347 dbg!("XIM: bug: Failed to get window for XIM commit", window);
1348 log::error!("bug: Failed to get window for XIM commit");
1349 return None;
1350 };
1351 let mut state = self.0.borrow_mut();
1352 let keystroke = state.pre_key_char_down.take();
1353 state.composing = false;
1354 dbg!("XIM: setting composing to false, keystroke present", keystroke.is_some());
1355 drop(state);
1356 if let Some(mut keystroke) = keystroke {
1357 keystroke.key_char = Some(text.clone());
1358 dbg!("XIM: calling window.handle_input with keystroke");
1359 window.handle_input(PlatformInput::KeyDown(crate::KeyDownEvent {
1360 keystroke,
1361 is_held: false,
1362 }));
1363 } else {
1364 dbg!("XIM: no keystroke available for commit");
1365 }
1366
1367 Some(())
1368 }
1369
1370 fn xim_handle_preedit(&self, window: xproto::Window, text: String) -> Option<()> {
1371 dbg!("XIM: xim_handle_preedit called", window, &text);
1372 let Some(window) = self.get_window(window) else {
1373 dbg!("XIM: bug: Failed to get window for XIM preedit", window);
1374 log::error!("bug: Failed to get window for XIM preedit");
1375 return None;
1376 };
1377
1378 let mut state = self.0.borrow_mut();
1379 let (mut ximc, mut xim_handler) = state.take_xim()?;
1380 state.composing = !text.is_empty();
1381 dbg!("XIM: setting composing state", state.composing);
1382 drop(state);
1383 dbg!("XIM: calling window.handle_ime_preedit");
1384 window.handle_ime_preedit(text);
1385
1386 if let Some(area) = window.get_ime_area() {
1387 dbg!("XIM: got IME area, updating spot location", area);
1388 let ic_attributes = ximc
1389 .build_ic_attributes()
1390 .push(
1391 xim::AttributeName::InputStyle,
1392 xim::InputStyle::PREEDIT_CALLBACKS,
1393 )
1394 .push(xim::AttributeName::ClientWindow, xim_handler.window)
1395 .push(xim::AttributeName::FocusWindow, xim_handler.window)
1396 .nested_list(xim::AttributeName::PreeditAttributes, |b| {
1397 b.push(
1398 xim::AttributeName::SpotLocation,
1399 xim::Point {
1400 x: u32::from(area.origin.x + area.size.width) as i16,
1401 y: u32::from(area.origin.y + area.size.height) as i16,
1402 },
1403 );
1404 })
1405 .build();
1406 let result = ximc.set_ic_values(xim_handler.im_id, xim_handler.ic_id, ic_attributes);
1407 dbg!("XIM: set_ic_values result for preedit", result.is_ok());
1408 } else {
1409 dbg!("XIM: no IME area available");
1410 }
1411 let mut state = self.0.borrow_mut();
1412 state.restore_xim(ximc, xim_handler);
1413 drop(state);
1414 Some(())
1415 }
1416
1417 fn handle_keyboard_layout_change(&self) {
1418 let mut state = self.0.borrow_mut();
1419 let layout_idx = state.xkb.serialize_layout(STATE_LAYOUT_EFFECTIVE);
1420 let keymap = state.xkb.get_keymap();
1421 let layout_name = keymap.layout_get_name(layout_idx);
1422 if layout_name != state.keyboard_layout.name() {
1423 state.keyboard_layout = LinuxKeyboardLayout::new(layout_name.to_string().into());
1424 if let Some(mut callback) = state.common.callbacks.keyboard_layout_change.take() {
1425 drop(state);
1426 callback();
1427 state = self.0.borrow_mut();
1428 state.common.callbacks.keyboard_layout_change = Some(callback);
1429 }
1430 }
1431 }
1432}
1433
1434impl LinuxClient for X11Client {
1435 fn compositor_name(&self) -> &'static str {
1436 "X11"
1437 }
1438
1439 fn with_common<R>(&self, f: impl FnOnce(&mut LinuxCommon) -> R) -> R {
1440 f(&mut self.0.borrow_mut().common)
1441 }
1442
1443 fn keyboard_layout(&self) -> Box<dyn PlatformKeyboardLayout> {
1444 let state = self.0.borrow();
1445 Box::new(state.keyboard_layout.clone())
1446 }
1447
1448 fn displays(&self) -> Vec<Rc<dyn PlatformDisplay>> {
1449 let state = self.0.borrow();
1450 let setup = state.xcb_connection.setup();
1451 setup
1452 .roots
1453 .iter()
1454 .enumerate()
1455 .filter_map(|(root_id, _)| {
1456 Some(Rc::new(
1457 X11Display::new(&state.xcb_connection, state.scale_factor, root_id).ok()?,
1458 ) as Rc<dyn PlatformDisplay>)
1459 })
1460 .collect()
1461 }
1462
1463 fn primary_display(&self) -> Option<Rc<dyn PlatformDisplay>> {
1464 let state = self.0.borrow();
1465 X11Display::new(
1466 &state.xcb_connection,
1467 state.scale_factor,
1468 state.x_root_index,
1469 )
1470 .log_err()
1471 .map(|display| Rc::new(display) as Rc<dyn PlatformDisplay>)
1472 }
1473
1474 fn display(&self, id: DisplayId) -> Option<Rc<dyn PlatformDisplay>> {
1475 let state = self.0.borrow();
1476
1477 Some(Rc::new(
1478 X11Display::new(&state.xcb_connection, state.scale_factor, id.0 as usize).ok()?,
1479 ))
1480 }
1481
1482 #[cfg(feature = "screen-capture")]
1483 fn is_screen_capture_supported(&self) -> bool {
1484 true
1485 }
1486
1487 #[cfg(feature = "screen-capture")]
1488 fn screen_capture_sources(
1489 &self,
1490 ) -> futures::channel::oneshot::Receiver<anyhow::Result<Vec<Rc<dyn crate::ScreenCaptureSource>>>>
1491 {
1492 crate::platform::scap_screen_capture::scap_screen_sources(
1493 &self.0.borrow().common.foreground_executor,
1494 )
1495 }
1496
1497 fn open_window(
1498 &self,
1499 handle: AnyWindowHandle,
1500 params: WindowParams,
1501 ) -> anyhow::Result<Box<dyn PlatformWindow>> {
1502 let mut state = self.0.borrow_mut();
1503 let x_window = state
1504 .xcb_connection
1505 .generate_id()
1506 .context("X11: Failed to generate window ID")?;
1507
1508 let window = X11Window::new(
1509 handle,
1510 X11ClientStatePtr(Rc::downgrade(&self.0)),
1511 state.common.foreground_executor.clone(),
1512 &state.gpu_context,
1513 params,
1514 &state.xcb_connection,
1515 state.client_side_decorations_supported,
1516 state.x_root_index,
1517 x_window,
1518 &state.atoms,
1519 state.scale_factor,
1520 state.common.appearance,
1521 )?;
1522 check_reply(
1523 || "Failed to set XdndAware property",
1524 state.xcb_connection.change_property32(
1525 xproto::PropMode::REPLACE,
1526 x_window,
1527 state.atoms.XdndAware,
1528 state.atoms.XA_ATOM,
1529 &[5],
1530 ),
1531 )
1532 .log_err();
1533 xcb_flush(&state.xcb_connection);
1534
1535 let window_ref = WindowRef {
1536 window: window.0.clone(),
1537 refresh_state: None,
1538 expose_event_received: false,
1539 last_visibility: Visibility::UNOBSCURED,
1540 is_mapped: false,
1541 };
1542
1543 state.windows.insert(x_window, window_ref);
1544 Ok(Box::new(window))
1545 }
1546
1547 fn set_cursor_style(&self, style: CursorStyle) {
1548 let mut state = self.0.borrow_mut();
1549 let Some(focused_window) = state.mouse_focused_window else {
1550 return;
1551 };
1552 let current_style = state
1553 .cursor_styles
1554 .get(&focused_window)
1555 .unwrap_or(&CursorStyle::Arrow);
1556 if *current_style == style {
1557 return;
1558 }
1559
1560 let Some(cursor) = state.get_cursor_icon(style) else {
1561 return;
1562 };
1563
1564 state.cursor_styles.insert(focused_window, style);
1565 check_reply(
1566 || "Failed to set cursor style",
1567 state.xcb_connection.change_window_attributes(
1568 focused_window,
1569 &ChangeWindowAttributesAux {
1570 cursor: Some(cursor),
1571 ..Default::default()
1572 },
1573 ),
1574 )
1575 .log_err();
1576 state.xcb_connection.flush().log_err();
1577 }
1578
1579 fn open_uri(&self, uri: &str) {
1580 #[cfg(any(feature = "wayland", feature = "x11"))]
1581 open_uri_internal(self.background_executor(), uri, None);
1582 }
1583
1584 fn reveal_path(&self, path: PathBuf) {
1585 #[cfg(any(feature = "x11", feature = "wayland"))]
1586 reveal_path_internal(self.background_executor(), path, None);
1587 }
1588
1589 fn write_to_primary(&self, item: crate::ClipboardItem) {
1590 let state = self.0.borrow_mut();
1591 state
1592 .clipboard
1593 .set_text(
1594 std::borrow::Cow::Owned(item.text().unwrap_or_default()),
1595 clipboard::ClipboardKind::Primary,
1596 clipboard::WaitConfig::None,
1597 )
1598 .context("X11 Failed to write to clipboard (primary)")
1599 .log_with_level(log::Level::Debug);
1600 }
1601
1602 fn write_to_clipboard(&self, item: crate::ClipboardItem) {
1603 let mut state = self.0.borrow_mut();
1604 state
1605 .clipboard
1606 .set_text(
1607 std::borrow::Cow::Owned(item.text().unwrap_or_default()),
1608 clipboard::ClipboardKind::Clipboard,
1609 clipboard::WaitConfig::None,
1610 )
1611 .context("X11: Failed to write to clipboard (clipboard)")
1612 .log_with_level(log::Level::Debug);
1613 state.clipboard_item.replace(item);
1614 }
1615
1616 fn read_from_primary(&self) -> Option<crate::ClipboardItem> {
1617 let state = self.0.borrow_mut();
1618 return state
1619 .clipboard
1620 .get_any(clipboard::ClipboardKind::Primary)
1621 .context("X11: Failed to read from clipboard (primary)")
1622 .log_with_level(log::Level::Debug);
1623 }
1624
1625 fn read_from_clipboard(&self) -> Option<crate::ClipboardItem> {
1626 let state = self.0.borrow_mut();
1627 // if the last copy was from this app, return our cached item
1628 // which has metadata attached.
1629 if state
1630 .clipboard
1631 .is_owner(clipboard::ClipboardKind::Clipboard)
1632 {
1633 return state.clipboard_item.clone();
1634 }
1635 return state
1636 .clipboard
1637 .get_any(clipboard::ClipboardKind::Clipboard)
1638 .context("X11: Failed to read from clipboard (clipboard)")
1639 .log_with_level(log::Level::Debug);
1640 }
1641
1642 fn run(&self) {
1643 let Some(mut event_loop) = self
1644 .0
1645 .borrow_mut()
1646 .event_loop
1647 .take()
1648 .context("X11Client::run called but it's already running")
1649 .log_err()
1650 else {
1651 return;
1652 };
1653
1654 event_loop.run(None, &mut self.clone(), |_| {}).log_err();
1655 }
1656
1657 fn active_window(&self) -> Option<AnyWindowHandle> {
1658 let state = self.0.borrow();
1659 state.keyboard_focused_window.and_then(|focused_window| {
1660 state
1661 .windows
1662 .get(&focused_window)
1663 .map(|window| window.handle())
1664 })
1665 }
1666
1667 fn window_stack(&self) -> Option<Vec<AnyWindowHandle>> {
1668 let state = self.0.borrow();
1669 let root = state.xcb_connection.setup().roots[state.x_root_index].root;
1670
1671 let reply = state
1672 .xcb_connection
1673 .get_property(
1674 false,
1675 root,
1676 state.atoms._NET_CLIENT_LIST_STACKING,
1677 xproto::AtomEnum::WINDOW,
1678 0,
1679 u32::MAX,
1680 )
1681 .ok()?
1682 .reply()
1683 .ok()?;
1684
1685 let window_ids = reply
1686 .value
1687 .chunks_exact(4)
1688 .filter_map(|chunk| chunk.try_into().ok().map(u32::from_ne_bytes))
1689 .collect::<Vec<xproto::Window>>();
1690
1691 let mut handles = Vec::new();
1692
1693 // We need to reverse, since _NET_CLIENT_LIST_STACKING has
1694 // a back-to-front order.
1695 // See: https://specifications.freedesktop.org/wm-spec/1.3/ar01s03.html
1696 for window_ref in window_ids
1697 .iter()
1698 .rev()
1699 .filter_map(|&win| state.windows.get(&win))
1700 {
1701 if !window_ref.window.state.borrow().destroyed {
1702 handles.push(window_ref.handle());
1703 }
1704 }
1705
1706 Some(handles)
1707 }
1708}
1709
1710impl X11ClientState {
1711 fn has_xim(&self) -> bool {
1712 self.ximc.is_some() && self.xim_handler.is_some()
1713 }
1714
1715 fn take_xim(&mut self) -> Option<(X11rbClient<Rc<XCBConnection>>, XimHandler)> {
1716 let ximc = self
1717 .ximc
1718 .take()
1719 .ok_or(anyhow!("bug: XIM connection not set"))
1720 .log_err()?;
1721 if let Some(xim_handler) = self.xim_handler.take() {
1722 Some((ximc, xim_handler))
1723 } else {
1724 self.ximc = Some(ximc);
1725 log::error!("bug: XIM handler not set");
1726 None
1727 }
1728 }
1729
1730 fn restore_xim(&mut self, ximc: X11rbClient<Rc<XCBConnection>>, xim_handler: XimHandler) {
1731 self.ximc = Some(ximc);
1732 self.xim_handler = Some(xim_handler);
1733 }
1734
1735 fn update_refresh_loop(&mut self, x_window: xproto::Window) {
1736 let Some(window_ref) = self.windows.get_mut(&x_window) else {
1737 return;
1738 };
1739 let is_visible = window_ref.is_mapped
1740 && !matches!(window_ref.last_visibility, Visibility::FULLY_OBSCURED);
1741 match (is_visible, window_ref.refresh_state.take()) {
1742 (false, refresh_state @ Some(RefreshState::Hidden { .. }))
1743 | (false, refresh_state @ None)
1744 | (true, refresh_state @ Some(RefreshState::PeriodicRefresh { .. })) => {
1745 window_ref.refresh_state = refresh_state;
1746 }
1747 (
1748 false,
1749 Some(RefreshState::PeriodicRefresh {
1750 refresh_rate,
1751 event_loop_token,
1752 }),
1753 ) => {
1754 self.loop_handle.remove(event_loop_token);
1755 window_ref.refresh_state = Some(RefreshState::Hidden { refresh_rate });
1756 }
1757 (true, Some(RefreshState::Hidden { refresh_rate })) => {
1758 let event_loop_token = self.start_refresh_loop(x_window, refresh_rate);
1759 let Some(window_ref) = self.windows.get_mut(&x_window) else {
1760 return;
1761 };
1762 window_ref.refresh_state = Some(RefreshState::PeriodicRefresh {
1763 refresh_rate,
1764 event_loop_token,
1765 });
1766 }
1767 (true, None) => {
1768 let Some(screen_resources) = get_reply(
1769 || "Failed to get screen resources",
1770 self.xcb_connection
1771 .randr_get_screen_resources_current(x_window),
1772 )
1773 .log_err() else {
1774 return;
1775 };
1776
1777 // Ideally this would be re-queried when the window changes screens, but there
1778 // doesn't seem to be an efficient / straightforward way to do this. Should also be
1779 // updated when screen configurations change.
1780 let mode_info = screen_resources.crtcs.iter().find_map(|crtc| {
1781 let crtc_info = self
1782 .xcb_connection
1783 .randr_get_crtc_info(*crtc, x11rb::CURRENT_TIME)
1784 .ok()?
1785 .reply()
1786 .ok()?;
1787
1788 screen_resources
1789 .modes
1790 .iter()
1791 .find(|m| m.id == crtc_info.mode)
1792 });
1793 let refresh_rate = match mode_info {
1794 Some(mode_info) => mode_refresh_rate(mode_info),
1795 None => {
1796 log::error!(
1797 "Failed to get screen mode info from xrandr, \
1798 defaulting to 60hz refresh rate."
1799 );
1800 Duration::from_micros(1_000_000 / 60)
1801 }
1802 };
1803
1804 let event_loop_token = self.start_refresh_loop(x_window, refresh_rate);
1805 let Some(window_ref) = self.windows.get_mut(&x_window) else {
1806 return;
1807 };
1808 window_ref.refresh_state = Some(RefreshState::PeriodicRefresh {
1809 refresh_rate,
1810 event_loop_token,
1811 });
1812 }
1813 }
1814 }
1815
1816 #[must_use]
1817 fn start_refresh_loop(
1818 &self,
1819 x_window: xproto::Window,
1820 refresh_rate: Duration,
1821 ) -> RegistrationToken {
1822 self.loop_handle
1823 .insert_source(calloop::timer::Timer::immediate(), {
1824 move |mut instant, (), client| {
1825 let xcb_connection = {
1826 let mut state = client.0.borrow_mut();
1827 let xcb_connection = state.xcb_connection.clone();
1828 if let Some(window) = state.windows.get_mut(&x_window) {
1829 let expose_event_received = window.expose_event_received;
1830 window.expose_event_received = false;
1831 let window = window.window.clone();
1832 drop(state);
1833 window.refresh(RequestFrameOptions {
1834 require_presentation: expose_event_received,
1835 force_render: false,
1836 });
1837 }
1838 xcb_connection
1839 };
1840 client.process_x11_events(&xcb_connection).log_err();
1841
1842 // Take into account that some frames have been skipped
1843 let now = Instant::now();
1844 while instant < now {
1845 instant += refresh_rate;
1846 }
1847 calloop::timer::TimeoutAction::ToInstant(instant)
1848 }
1849 })
1850 .expect("Failed to initialize window refresh timer")
1851 }
1852
1853 fn get_cursor_icon(&mut self, style: CursorStyle) -> Option<xproto::Cursor> {
1854 if let Some(cursor) = self.cursor_cache.get(&style) {
1855 return *cursor;
1856 }
1857
1858 let mut result;
1859 match style {
1860 CursorStyle::None => match create_invisible_cursor(&self.xcb_connection) {
1861 Ok(loaded_cursor) => result = Ok(loaded_cursor),
1862 Err(err) => result = Err(err.context("X11: error while creating invisible cursor")),
1863 },
1864 _ => 'outer: {
1865 let mut errors = String::new();
1866 let cursor_icon_names = style.to_icon_names();
1867 for cursor_icon_name in cursor_icon_names {
1868 match self
1869 .cursor_handle
1870 .load_cursor(&self.xcb_connection, cursor_icon_name)
1871 {
1872 Ok(loaded_cursor) => {
1873 if loaded_cursor != x11rb::NONE {
1874 result = Ok(loaded_cursor);
1875 break 'outer;
1876 }
1877 }
1878 Err(err) => {
1879 errors.push_str(&err.to_string());
1880 errors.push('\n');
1881 }
1882 }
1883 }
1884 if errors.is_empty() {
1885 result = Err(anyhow!(
1886 "errors while loading cursor icons {:?}:\n{}",
1887 cursor_icon_names,
1888 errors
1889 ));
1890 } else {
1891 result = Err(anyhow!("did not find cursor icons {:?}", cursor_icon_names));
1892 }
1893 }
1894 };
1895
1896 let cursor = match result {
1897 Ok(cursor) => Some(cursor),
1898 Err(err) => {
1899 match self
1900 .cursor_handle
1901 .load_cursor(&self.xcb_connection, DEFAULT_CURSOR_ICON_NAME)
1902 {
1903 Ok(default) => {
1904 log_cursor_icon_warning(err.context(format!(
1905 "X11: error loading cursor icon, falling back on default icon '{}'",
1906 DEFAULT_CURSOR_ICON_NAME
1907 )));
1908 Some(default)
1909 }
1910 Err(default_err) => {
1911 log_cursor_icon_warning(err.context(default_err).context(format!(
1912 "X11: error loading default cursor fallback '{}'",
1913 DEFAULT_CURSOR_ICON_NAME
1914 )));
1915 None
1916 }
1917 }
1918 }
1919 };
1920
1921 self.cursor_cache.insert(style, cursor);
1922 cursor
1923 }
1924}
1925
1926// Adapted from:
1927// https://docs.rs/winit/0.29.11/src/winit/platform_impl/linux/x11/monitor.rs.html#103-111
1928pub fn mode_refresh_rate(mode: &randr::ModeInfo) -> Duration {
1929 if mode.dot_clock == 0 || mode.htotal == 0 || mode.vtotal == 0 {
1930 return Duration::from_millis(16);
1931 }
1932
1933 let millihertz = mode.dot_clock as u64 * 1_000 / (mode.htotal as u64 * mode.vtotal as u64);
1934 let micros = 1_000_000_000 / millihertz;
1935 log::info!("Refreshing every {}ms", micros / 1_000);
1936 Duration::from_micros(micros)
1937}
1938
1939fn fp3232_to_f32(value: xinput::Fp3232) -> f32 {
1940 value.integral as f32 + value.frac as f32 / u32::MAX as f32
1941}
1942
1943fn check_compositor_present(xcb_connection: &XCBConnection, root: u32) -> bool {
1944 // Method 1: Check for _NET_WM_CM_S{root}
1945 let atom_name = format!("_NET_WM_CM_S{}", root);
1946 let atom1 = get_reply(
1947 || format!("Failed to intern {atom_name}"),
1948 xcb_connection.intern_atom(false, atom_name.as_bytes()),
1949 );
1950 let method1 = match atom1.log_with_level(Level::Debug) {
1951 Some(reply) if reply.atom != x11rb::NONE => {
1952 let atom = reply.atom;
1953 get_reply(
1954 || format!("Failed to get {atom_name} owner"),
1955 xcb_connection.get_selection_owner(atom),
1956 )
1957 .map(|reply| reply.owner != 0)
1958 .log_with_level(Level::Debug)
1959 .unwrap_or(false)
1960 }
1961 _ => false,
1962 };
1963
1964 // Method 2: Check for _NET_WM_CM_OWNER
1965 let atom_name = "_NET_WM_CM_OWNER";
1966 let atom2 = get_reply(
1967 || format!("Failed to intern {atom_name}"),
1968 xcb_connection.intern_atom(false, atom_name.as_bytes()),
1969 );
1970 let method2 = match atom2.log_with_level(Level::Debug) {
1971 Some(reply) if reply.atom != x11rb::NONE => {
1972 let atom = reply.atom;
1973 get_reply(
1974 || format!("Failed to get {atom_name}"),
1975 xcb_connection.get_property(false, root, atom, xproto::AtomEnum::WINDOW, 0, 1),
1976 )
1977 .map(|reply| reply.value_len > 0)
1978 .unwrap_or(false)
1979 }
1980 _ => return false,
1981 };
1982
1983 // Method 3: Check for _NET_SUPPORTING_WM_CHECK
1984 let atom_name = "_NET_SUPPORTING_WM_CHECK";
1985 let atom3 = get_reply(
1986 || format!("Failed to intern {atom_name}"),
1987 xcb_connection.intern_atom(false, atom_name.as_bytes()),
1988 );
1989 let method3 = match atom3.log_with_level(Level::Debug) {
1990 Some(reply) if reply.atom != x11rb::NONE => {
1991 let atom = reply.atom;
1992 get_reply(
1993 || format!("Failed to get {atom_name}"),
1994 xcb_connection.get_property(false, root, atom, xproto::AtomEnum::WINDOW, 0, 1),
1995 )
1996 .map(|reply| reply.value_len > 0)
1997 .unwrap_or(false)
1998 }
1999 _ => return false,
2000 };
2001
2002 log::debug!(
2003 "Compositor detection: _NET_WM_CM_S?={}, _NET_WM_CM_OWNER={}, _NET_SUPPORTING_WM_CHECK={}",
2004 method1,
2005 method2,
2006 method3
2007 );
2008
2009 method1 || method2 || method3
2010}
2011
2012fn check_gtk_frame_extents_supported(
2013 xcb_connection: &XCBConnection,
2014 atoms: &XcbAtoms,
2015 root: xproto::Window,
2016) -> bool {
2017 let Some(supported_atoms) = get_reply(
2018 || "Failed to get _NET_SUPPORTED",
2019 xcb_connection.get_property(
2020 false,
2021 root,
2022 atoms._NET_SUPPORTED,
2023 xproto::AtomEnum::ATOM,
2024 0,
2025 1024,
2026 ),
2027 )
2028 .log_with_level(Level::Debug) else {
2029 return false;
2030 };
2031
2032 let supported_atom_ids: Vec<u32> = supported_atoms
2033 .value
2034 .chunks_exact(4)
2035 .filter_map(|chunk| chunk.try_into().ok().map(u32::from_ne_bytes))
2036 .collect();
2037
2038 supported_atom_ids.contains(&atoms._GTK_FRAME_EXTENTS)
2039}
2040
2041fn xdnd_is_atom_supported(atom: u32, atoms: &XcbAtoms) -> bool {
2042 return atom == atoms.TEXT
2043 || atom == atoms.STRING
2044 || atom == atoms.UTF8_STRING
2045 || atom == atoms.TEXT_PLAIN
2046 || atom == atoms.TEXT_PLAIN_UTF8
2047 || atom == atoms.TextUriList;
2048}
2049
2050fn xdnd_get_supported_atom(
2051 xcb_connection: &XCBConnection,
2052 supported_atoms: &XcbAtoms,
2053 target: xproto::Window,
2054) -> u32 {
2055 if let Some(reply) = get_reply(
2056 || "Failed to get XDnD supported atoms",
2057 xcb_connection.get_property(
2058 false,
2059 target,
2060 supported_atoms.XdndTypeList,
2061 AtomEnum::ANY,
2062 0,
2063 1024,
2064 ),
2065 )
2066 .log_with_level(Level::Warn)
2067 {
2068 if let Some(atoms) = reply.value32() {
2069 for atom in atoms {
2070 if xdnd_is_atom_supported(atom, &supported_atoms) {
2071 return atom;
2072 }
2073 }
2074 }
2075 }
2076 return 0;
2077}
2078
2079fn xdnd_send_finished(
2080 xcb_connection: &XCBConnection,
2081 atoms: &XcbAtoms,
2082 source: xproto::Window,
2083 target: xproto::Window,
2084) {
2085 let message = ClientMessageEvent {
2086 format: 32,
2087 window: target,
2088 type_: atoms.XdndFinished,
2089 data: ClientMessageData::from([source, 1, atoms.XdndActionCopy, 0, 0]),
2090 sequence: 0,
2091 response_type: xproto::CLIENT_MESSAGE_EVENT,
2092 };
2093 check_reply(
2094 || "Failed to send XDnD finished event",
2095 xcb_connection.send_event(false, target, EventMask::default(), message),
2096 )
2097 .log_err();
2098 xcb_connection.flush().log_err();
2099}
2100
2101fn xdnd_send_status(
2102 xcb_connection: &XCBConnection,
2103 atoms: &XcbAtoms,
2104 source: xproto::Window,
2105 target: xproto::Window,
2106 action: u32,
2107) {
2108 let message = ClientMessageEvent {
2109 format: 32,
2110 window: target,
2111 type_: atoms.XdndStatus,
2112 data: ClientMessageData::from([source, 1, 0, 0, action]),
2113 sequence: 0,
2114 response_type: xproto::CLIENT_MESSAGE_EVENT,
2115 };
2116 check_reply(
2117 || "Failed to send XDnD status event",
2118 xcb_connection.send_event(false, target, EventMask::default(), message),
2119 )
2120 .log_err();
2121 xcb_connection.flush().log_err();
2122}
2123
2124/// Recomputes `pointer_device_states` by querying all pointer devices.
2125/// When a device is present in `scroll_values_to_preserve`, its value for `ScrollAxisState.scroll_value` is used.
2126fn current_pointer_device_states(
2127 xcb_connection: &XCBConnection,
2128 scroll_values_to_preserve: &BTreeMap<xinput::DeviceId, PointerDeviceState>,
2129) -> Option<BTreeMap<xinput::DeviceId, PointerDeviceState>> {
2130 let devices_query_result = get_reply(
2131 || "Failed to query XInput devices",
2132 xcb_connection.xinput_xi_query_device(XINPUT_ALL_DEVICES),
2133 )
2134 .log_err()?;
2135
2136 let mut pointer_device_states = BTreeMap::new();
2137 pointer_device_states.extend(
2138 devices_query_result
2139 .infos
2140 .iter()
2141 .filter(|info| is_pointer_device(info.type_))
2142 .filter_map(|info| {
2143 let scroll_data = info
2144 .classes
2145 .iter()
2146 .filter_map(|class| class.data.as_scroll())
2147 .map(|class| *class)
2148 .rev()
2149 .collect::<Vec<_>>();
2150 let old_state = scroll_values_to_preserve.get(&info.deviceid);
2151 let old_horizontal = old_state.map(|state| &state.horizontal);
2152 let old_vertical = old_state.map(|state| &state.vertical);
2153 let horizontal = scroll_data
2154 .iter()
2155 .find(|data| data.scroll_type == xinput::ScrollType::HORIZONTAL)
2156 .map(|data| scroll_data_to_axis_state(data, old_horizontal));
2157 let vertical = scroll_data
2158 .iter()
2159 .find(|data| data.scroll_type == xinput::ScrollType::VERTICAL)
2160 .map(|data| scroll_data_to_axis_state(data, old_vertical));
2161 if horizontal.is_none() && vertical.is_none() {
2162 None
2163 } else {
2164 Some((
2165 info.deviceid,
2166 PointerDeviceState {
2167 horizontal: horizontal.unwrap_or_else(Default::default),
2168 vertical: vertical.unwrap_or_else(Default::default),
2169 },
2170 ))
2171 }
2172 }),
2173 );
2174 if pointer_device_states.is_empty() {
2175 log::error!("Found no xinput mouse pointers.");
2176 }
2177 return Some(pointer_device_states);
2178}
2179
2180/// Returns true if the device is a pointer device. Does not include pointer device groups.
2181fn is_pointer_device(type_: xinput::DeviceType) -> bool {
2182 type_ == xinput::DeviceType::SLAVE_POINTER
2183}
2184
2185fn scroll_data_to_axis_state(
2186 data: &xinput::DeviceClassDataScroll,
2187 old_axis_state_with_valid_scroll_value: Option<&ScrollAxisState>,
2188) -> ScrollAxisState {
2189 ScrollAxisState {
2190 valuator_number: Some(data.number),
2191 multiplier: SCROLL_LINES / fp3232_to_f32(data.increment),
2192 scroll_value: old_axis_state_with_valid_scroll_value.and_then(|state| state.scroll_value),
2193 }
2194}
2195
2196fn reset_all_pointer_device_scroll_positions(
2197 pointer_device_states: &mut BTreeMap<xinput::DeviceId, PointerDeviceState>,
2198) {
2199 pointer_device_states
2200 .iter_mut()
2201 .for_each(|(_, device_state)| reset_pointer_device_scroll_positions(device_state));
2202}
2203
2204fn reset_pointer_device_scroll_positions(pointer: &mut PointerDeviceState) {
2205 pointer.horizontal.scroll_value = None;
2206 pointer.vertical.scroll_value = None;
2207}
2208
2209/// Returns the scroll delta for a smooth scrolling motion event, or `None` if no scroll data is present.
2210fn get_scroll_delta_and_update_state(
2211 pointer: &mut PointerDeviceState,
2212 event: &xinput::MotionEvent,
2213) -> Option<Point<f32>> {
2214 let delta_x = get_axis_scroll_delta_and_update_state(event, &mut pointer.horizontal);
2215 let delta_y = get_axis_scroll_delta_and_update_state(event, &mut pointer.vertical);
2216 if delta_x.is_some() || delta_y.is_some() {
2217 Some(Point::new(delta_x.unwrap_or(0.0), delta_y.unwrap_or(0.0)))
2218 } else {
2219 None
2220 }
2221}
2222
2223fn get_axis_scroll_delta_and_update_state(
2224 event: &xinput::MotionEvent,
2225 axis: &mut ScrollAxisState,
2226) -> Option<f32> {
2227 let axis_index = get_valuator_axis_index(&event.valuator_mask, axis.valuator_number?)?;
2228 if let Some(axis_value) = event.axisvalues.get(axis_index) {
2229 let new_scroll = fp3232_to_f32(*axis_value);
2230 let delta_scroll = axis
2231 .scroll_value
2232 .map(|old_scroll| (old_scroll - new_scroll) * axis.multiplier);
2233 axis.scroll_value = Some(new_scroll);
2234 delta_scroll
2235 } else {
2236 log::error!("Encountered invalid XInput valuator_mask, scrolling may not work properly.");
2237 None
2238 }
2239}
2240
2241fn make_scroll_wheel_event(
2242 position: Point<Pixels>,
2243 scroll_delta: Point<f32>,
2244 modifiers: Modifiers,
2245) -> crate::ScrollWheelEvent {
2246 // When shift is held down, vertical scrolling turns into horizontal scrolling.
2247 let delta = if modifiers.shift {
2248 Point {
2249 x: scroll_delta.y,
2250 y: 0.0,
2251 }
2252 } else {
2253 scroll_delta
2254 };
2255 crate::ScrollWheelEvent {
2256 position,
2257 delta: ScrollDelta::Lines(delta),
2258 modifiers,
2259 touch_phase: TouchPhase::default(),
2260 }
2261}
2262
2263fn create_invisible_cursor(
2264 connection: &XCBConnection,
2265) -> anyhow::Result<crate::platform::linux::x11::client::xproto::Cursor> {
2266 let empty_pixmap = connection.generate_id()?;
2267 let root = connection.setup().roots[0].root;
2268 connection.create_pixmap(1, empty_pixmap, root, 1, 1)?;
2269
2270 let cursor = connection.generate_id()?;
2271 connection.create_cursor(cursor, empty_pixmap, empty_pixmap, 0, 0, 0, 0, 0, 0, 0, 0)?;
2272
2273 connection.free_pixmap(empty_pixmap)?;
2274
2275 xcb_flush(connection);
2276 Ok(cursor)
2277}
2278
2279enum DpiMode {
2280 Randr,
2281 Scale(f32),
2282 NotSet,
2283}
2284
2285fn get_scale_factor(
2286 connection: &XCBConnection,
2287 resource_database: &Database,
2288 screen_index: usize,
2289) -> f32 {
2290 let env_dpi = std::env::var(GPUI_X11_SCALE_FACTOR_ENV)
2291 .ok()
2292 .map(|var| {
2293 if var.to_lowercase() == "randr" {
2294 DpiMode::Randr
2295 } else if let Ok(scale) = var.parse::<f32>() {
2296 if valid_scale_factor(scale) {
2297 DpiMode::Scale(scale)
2298 } else {
2299 panic!(
2300 "`{}` must be a positive normal number or `randr`. Got `{}`",
2301 GPUI_X11_SCALE_FACTOR_ENV, var
2302 );
2303 }
2304 } else if var.is_empty() {
2305 DpiMode::NotSet
2306 } else {
2307 panic!(
2308 "`{}` must be a positive number or `randr`. Got `{}`",
2309 GPUI_X11_SCALE_FACTOR_ENV, var
2310 );
2311 }
2312 })
2313 .unwrap_or(DpiMode::NotSet);
2314
2315 match env_dpi {
2316 DpiMode::Scale(scale) => {
2317 log::info!(
2318 "Using scale factor from {}: {}",
2319 GPUI_X11_SCALE_FACTOR_ENV,
2320 scale
2321 );
2322 return scale;
2323 }
2324 DpiMode::Randr => {
2325 if let Some(scale) = get_randr_scale_factor(connection, screen_index) {
2326 log::info!(
2327 "Using RandR scale factor from {}=randr: {}",
2328 GPUI_X11_SCALE_FACTOR_ENV,
2329 scale
2330 );
2331 return scale;
2332 }
2333 log::warn!("Failed to calculate RandR scale factor, falling back to default");
2334 return 1.0;
2335 }
2336 DpiMode::NotSet => {}
2337 }
2338
2339 // TODO: Use scale factor from XSettings here
2340
2341 if let Some(dpi) = resource_database
2342 .get_value::<f32>("Xft.dpi", "Xft.dpi")
2343 .ok()
2344 .flatten()
2345 {
2346 let scale = dpi / 96.0; // base dpi
2347 log::info!("Using scale factor from Xft.dpi: {}", scale);
2348 return scale;
2349 }
2350
2351 if let Some(scale) = get_randr_scale_factor(connection, screen_index) {
2352 log::info!("Using RandR scale factor: {}", scale);
2353 return scale;
2354 }
2355
2356 log::info!("Using default scale factor: 1.0");
2357 1.0
2358}
2359
2360fn get_randr_scale_factor(connection: &XCBConnection, screen_index: usize) -> Option<f32> {
2361 let root = connection.setup().roots.get(screen_index)?.root;
2362
2363 let version_cookie = connection.randr_query_version(1, 6).ok()?;
2364 let version_reply = version_cookie.reply().ok()?;
2365 if version_reply.major_version < 1
2366 || (version_reply.major_version == 1 && version_reply.minor_version < 5)
2367 {
2368 return legacy_get_randr_scale_factor(connection, root); // for randr <1.5
2369 }
2370
2371 let monitors_cookie = connection.randr_get_monitors(root, true).ok()?; // true for active only
2372 let monitors_reply = monitors_cookie.reply().ok()?;
2373
2374 let mut fallback_scale: Option<f32> = None;
2375 for monitor in monitors_reply.monitors {
2376 if monitor.width_in_millimeters == 0 || monitor.height_in_millimeters == 0 {
2377 continue;
2378 }
2379 let scale_factor = get_dpi_factor(
2380 (monitor.width as u32, monitor.height as u32),
2381 (
2382 monitor.width_in_millimeters as u64,
2383 monitor.height_in_millimeters as u64,
2384 ),
2385 );
2386 if monitor.primary {
2387 return Some(scale_factor);
2388 } else if fallback_scale.is_none() {
2389 fallback_scale = Some(scale_factor);
2390 }
2391 }
2392
2393 fallback_scale
2394}
2395
2396fn legacy_get_randr_scale_factor(connection: &XCBConnection, root: u32) -> Option<f32> {
2397 let primary_cookie = connection.randr_get_output_primary(root).ok()?;
2398 let primary_reply = primary_cookie.reply().ok()?;
2399 let primary_output = primary_reply.output;
2400
2401 let primary_output_cookie = connection
2402 .randr_get_output_info(primary_output, x11rb::CURRENT_TIME)
2403 .ok()?;
2404 let primary_output_info = primary_output_cookie.reply().ok()?;
2405
2406 // try primary
2407 if primary_output_info.connection == randr::Connection::CONNECTED
2408 && primary_output_info.mm_width > 0
2409 && primary_output_info.mm_height > 0
2410 && primary_output_info.crtc != 0
2411 {
2412 let crtc_cookie = connection
2413 .randr_get_crtc_info(primary_output_info.crtc, x11rb::CURRENT_TIME)
2414 .ok()?;
2415 let crtc_info = crtc_cookie.reply().ok()?;
2416
2417 if crtc_info.width > 0 && crtc_info.height > 0 {
2418 let scale_factor = get_dpi_factor(
2419 (crtc_info.width as u32, crtc_info.height as u32),
2420 (
2421 primary_output_info.mm_width as u64,
2422 primary_output_info.mm_height as u64,
2423 ),
2424 );
2425 return Some(scale_factor);
2426 }
2427 }
2428
2429 // fallback: full scan
2430 let resources_cookie = connection.randr_get_screen_resources_current(root).ok()?;
2431 let screen_resources = resources_cookie.reply().ok()?;
2432
2433 let mut crtc_cookies = Vec::with_capacity(screen_resources.crtcs.len());
2434 for &crtc in &screen_resources.crtcs {
2435 if let Ok(cookie) = connection.randr_get_crtc_info(crtc, x11rb::CURRENT_TIME) {
2436 crtc_cookies.push((crtc, cookie));
2437 }
2438 }
2439
2440 let mut crtc_infos: HashMap<randr::Crtc, randr::GetCrtcInfoReply> = HashMap::default();
2441 let mut valid_outputs: HashSet<randr::Output> = HashSet::new();
2442 for (crtc, cookie) in crtc_cookies {
2443 if let Ok(reply) = cookie.reply() {
2444 if reply.width > 0 && reply.height > 0 && !reply.outputs.is_empty() {
2445 crtc_infos.insert(crtc, reply.clone());
2446 valid_outputs.extend(&reply.outputs);
2447 }
2448 }
2449 }
2450
2451 if valid_outputs.is_empty() {
2452 return None;
2453 }
2454
2455 let mut output_cookies = Vec::with_capacity(valid_outputs.len());
2456 for &output in &valid_outputs {
2457 if let Ok(cookie) = connection.randr_get_output_info(output, x11rb::CURRENT_TIME) {
2458 output_cookies.push((output, cookie));
2459 }
2460 }
2461 let mut output_infos: HashMap<randr::Output, randr::GetOutputInfoReply> = HashMap::default();
2462 for (output, cookie) in output_cookies {
2463 if let Ok(reply) = cookie.reply() {
2464 output_infos.insert(output, reply);
2465 }
2466 }
2467
2468 let mut fallback_scale: Option<f32> = None;
2469 for crtc_info in crtc_infos.values() {
2470 for &output in &crtc_info.outputs {
2471 if let Some(output_info) = output_infos.get(&output) {
2472 if output_info.connection != randr::Connection::CONNECTED {
2473 continue;
2474 }
2475
2476 if output_info.mm_width == 0 || output_info.mm_height == 0 {
2477 continue;
2478 }
2479
2480 let scale_factor = get_dpi_factor(
2481 (crtc_info.width as u32, crtc_info.height as u32),
2482 (output_info.mm_width as u64, output_info.mm_height as u64),
2483 );
2484
2485 if output != primary_output && fallback_scale.is_none() {
2486 fallback_scale = Some(scale_factor);
2487 }
2488 }
2489 }
2490 }
2491
2492 fallback_scale
2493}
2494
2495fn get_dpi_factor((width_px, height_px): (u32, u32), (width_mm, height_mm): (u64, u64)) -> f32 {
2496 let ppmm = ((width_px as f64 * height_px as f64) / (width_mm as f64 * height_mm as f64)).sqrt(); // pixels per mm
2497
2498 const MM_PER_INCH: f64 = 25.4;
2499 const BASE_DPI: f64 = 96.0;
2500 const QUANTIZE_STEP: f64 = 12.0; // e.g. 1.25 = 15/12, 1.5 = 18/12, 1.75 = 21/12, 2.0 = 24/12
2501 const MIN_SCALE: f64 = 1.0;
2502 const MAX_SCALE: f64 = 20.0;
2503
2504 let dpi_factor =
2505 ((ppmm * (QUANTIZE_STEP * MM_PER_INCH / BASE_DPI)).round() / QUANTIZE_STEP).max(MIN_SCALE);
2506
2507 let validated_factor = if dpi_factor <= MAX_SCALE {
2508 dpi_factor
2509 } else {
2510 MIN_SCALE
2511 };
2512
2513 if valid_scale_factor(validated_factor as f32) {
2514 validated_factor as f32
2515 } else {
2516 log::warn!(
2517 "Calculated DPI factor {} is invalid, using 1.0",
2518 validated_factor
2519 );
2520 1.0
2521 }
2522}
2523
2524#[inline]
2525fn valid_scale_factor(scale_factor: f32) -> bool {
2526 scale_factor.is_sign_positive() && scale_factor.is_normal()
2527}