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