1use std::{
2 env,
3 path::{Path, PathBuf},
4 process::Command,
5 rc::Rc,
6 sync::Arc,
7};
8#[cfg(any(feature = "wayland", feature = "x11"))]
9use std::{
10 ffi::OsString,
11 fs::File,
12 io::Read as _,
13 os::fd::{AsFd, AsRawFd, FromRawFd},
14 time::Duration,
15};
16
17use anyhow::{Context as _, anyhow};
18use async_task::Runnable;
19use calloop::{LoopSignal, channel::Channel};
20use futures::channel::oneshot;
21use util::ResultExt as _;
22#[cfg(any(feature = "wayland", feature = "x11"))]
23use xkbcommon::xkb::{self, Keycode, Keysym, State};
24
25use crate::{
26 Action, AnyWindowHandle, BackgroundExecutor, ClipboardItem, CursorStyle, DisplayId,
27 ForegroundExecutor, Keymap, LinuxDispatcher, Menu, MenuItem, OwnedMenu, PathPromptOptions,
28 Pixels, Platform, PlatformDisplay, PlatformKeyboardLayout, PlatformTextSystem, PlatformWindow,
29 Point, Result, Task, WindowAppearance, WindowParams, px,
30};
31
32#[cfg(any(feature = "wayland", feature = "x11"))]
33pub(crate) const SCROLL_LINES: f32 = 3.0;
34
35// Values match the defaults on GTK.
36// Taken from https://github.com/GNOME/gtk/blob/main/gtk/gtksettings.c#L320
37#[cfg(any(feature = "wayland", feature = "x11"))]
38pub(crate) const DOUBLE_CLICK_INTERVAL: Duration = Duration::from_millis(400);
39pub(crate) const DOUBLE_CLICK_DISTANCE: Pixels = px(5.0);
40pub(crate) const KEYRING_LABEL: &str = "zed-github-account";
41
42#[cfg(any(feature = "wayland", feature = "x11"))]
43const FILE_PICKER_PORTAL_MISSING: &str =
44 "Couldn't open file picker due to missing xdg-desktop-portal implementation.";
45
46pub trait LinuxClient {
47 fn compositor_name(&self) -> &'static str;
48 fn with_common<R>(&self, f: impl FnOnce(&mut LinuxCommon) -> R) -> R;
49 fn keyboard_layout(&self) -> Box<dyn PlatformKeyboardLayout>;
50 fn displays(&self) -> Vec<Rc<dyn PlatformDisplay>>;
51 #[allow(unused)]
52 fn display(&self, id: DisplayId) -> Option<Rc<dyn PlatformDisplay>>;
53 fn primary_display(&self) -> Option<Rc<dyn PlatformDisplay>>;
54 #[cfg(feature = "screen-capture")]
55 fn is_screen_capture_supported(&self) -> bool;
56 #[cfg(feature = "screen-capture")]
57 fn screen_capture_sources(
58 &self,
59 ) -> oneshot::Receiver<Result<Vec<Rc<dyn crate::ScreenCaptureSource>>>>;
60
61 fn open_window(
62 &self,
63 handle: AnyWindowHandle,
64 options: WindowParams,
65 ) -> anyhow::Result<Box<dyn PlatformWindow>>;
66 fn set_cursor_style(&self, style: CursorStyle);
67 fn open_uri(&self, uri: &str);
68 fn reveal_path(&self, path: PathBuf);
69 fn write_to_primary(&self, item: ClipboardItem);
70 fn write_to_clipboard(&self, item: ClipboardItem);
71 fn read_from_primary(&self) -> Option<ClipboardItem>;
72 fn read_from_clipboard(&self) -> Option<ClipboardItem>;
73 fn active_window(&self) -> Option<AnyWindowHandle>;
74 fn window_stack(&self) -> Option<Vec<AnyWindowHandle>>;
75 fn run(&self);
76}
77
78#[derive(Default)]
79pub(crate) struct PlatformHandlers {
80 pub(crate) open_urls: Option<Box<dyn FnMut(Vec<String>)>>,
81 pub(crate) quit: Option<Box<dyn FnMut()>>,
82 pub(crate) reopen: Option<Box<dyn FnMut()>>,
83 pub(crate) app_menu_action: Option<Box<dyn FnMut(&dyn Action)>>,
84 pub(crate) will_open_app_menu: Option<Box<dyn FnMut()>>,
85 pub(crate) validate_app_menu_command: Option<Box<dyn FnMut(&dyn Action) -> bool>>,
86 pub(crate) keyboard_layout_change: Option<Box<dyn FnMut()>>,
87}
88
89pub(crate) struct LinuxCommon {
90 pub(crate) background_executor: BackgroundExecutor,
91 pub(crate) foreground_executor: ForegroundExecutor,
92 pub(crate) text_system: Arc<dyn PlatformTextSystem>,
93 pub(crate) appearance: WindowAppearance,
94 pub(crate) auto_hide_scrollbars: bool,
95 pub(crate) callbacks: PlatformHandlers,
96 pub(crate) signal: LoopSignal,
97 pub(crate) menus: Vec<OwnedMenu>,
98}
99
100impl LinuxCommon {
101 pub fn new(signal: LoopSignal) -> (Self, Channel<Runnable>) {
102 let (main_sender, main_receiver) = calloop::channel::channel::<Runnable>();
103
104 #[cfg(any(feature = "wayland", feature = "x11"))]
105 let text_system = Arc::new(crate::CosmicTextSystem::new());
106 #[cfg(not(any(feature = "wayland", feature = "x11")))]
107 let text_system = Arc::new(crate::NoopTextSystem::new());
108
109 let callbacks = PlatformHandlers::default();
110
111 let dispatcher = Arc::new(LinuxDispatcher::new(main_sender.clone()));
112
113 let background_executor = BackgroundExecutor::new(dispatcher.clone());
114
115 let common = LinuxCommon {
116 background_executor,
117 foreground_executor: ForegroundExecutor::new(dispatcher.clone()),
118 text_system,
119 appearance: WindowAppearance::Light,
120 auto_hide_scrollbars: false,
121 callbacks,
122 signal,
123 menus: Vec::new(),
124 };
125
126 (common, main_receiver)
127 }
128}
129
130impl<P: LinuxClient + 'static> Platform for P {
131 fn background_executor(&self) -> BackgroundExecutor {
132 self.with_common(|common| common.background_executor.clone())
133 }
134
135 fn foreground_executor(&self) -> ForegroundExecutor {
136 self.with_common(|common| common.foreground_executor.clone())
137 }
138
139 fn text_system(&self) -> Arc<dyn PlatformTextSystem> {
140 self.with_common(|common| common.text_system.clone())
141 }
142
143 fn keyboard_layout(&self) -> Box<dyn PlatformKeyboardLayout> {
144 self.keyboard_layout()
145 }
146
147 fn on_keyboard_layout_change(&self, callback: Box<dyn FnMut()>) {
148 self.with_common(|common| common.callbacks.keyboard_layout_change = Some(callback));
149 }
150
151 fn run(&self, on_finish_launching: Box<dyn FnOnce()>) {
152 on_finish_launching();
153
154 LinuxClient::run(self);
155
156 let quit = self.with_common(|common| common.callbacks.quit.take());
157 if let Some(mut fun) = quit {
158 fun();
159 }
160 }
161
162 fn quit(&self) {
163 self.with_common(|common| common.signal.stop());
164 }
165
166 fn compositor_name(&self) -> &'static str {
167 self.compositor_name()
168 }
169
170 fn restart(&self, binary_path: Option<PathBuf>) {
171 use std::os::unix::process::CommandExt as _;
172
173 // get the process id of the current process
174 let app_pid = std::process::id().to_string();
175 // get the path to the executable
176 let app_path = if let Some(path) = binary_path {
177 path
178 } else {
179 match self.app_path() {
180 Ok(path) => path,
181 Err(err) => {
182 log::error!("Failed to get app path: {:?}", err);
183 return;
184 }
185 }
186 };
187
188 log::info!("Restarting process, using app path: {:?}", app_path);
189
190 // Script to wait for the current process to exit and then restart the app.
191 let script = format!(
192 r#"
193 while kill -0 {pid} 2>/dev/null; do
194 sleep 0.1
195 done
196
197 {app_path}
198 "#,
199 pid = app_pid,
200 app_path = app_path.display()
201 );
202
203 let restart_process = Command::new("/usr/bin/env")
204 .arg("bash")
205 .arg("-c")
206 .arg(script)
207 .process_group(0)
208 .spawn();
209
210 match restart_process {
211 Ok(_) => self.quit(),
212 Err(e) => log::error!("failed to spawn restart script: {:?}", e),
213 }
214 }
215
216 fn activate(&self, _ignoring_other_apps: bool) {
217 log::info!("activate is not implemented on Linux, ignoring the call")
218 }
219
220 fn hide(&self) {
221 log::info!("hide is not implemented on Linux, ignoring the call")
222 }
223
224 fn hide_other_apps(&self) {
225 log::info!("hide_other_apps is not implemented on Linux, ignoring the call")
226 }
227
228 fn unhide_other_apps(&self) {
229 log::info!("unhide_other_apps is not implemented on Linux, ignoring the call")
230 }
231
232 fn primary_display(&self) -> Option<Rc<dyn PlatformDisplay>> {
233 self.primary_display()
234 }
235
236 fn displays(&self) -> Vec<Rc<dyn PlatformDisplay>> {
237 self.displays()
238 }
239
240 #[cfg(feature = "screen-capture")]
241 fn is_screen_capture_supported(&self) -> bool {
242 self.is_screen_capture_supported()
243 }
244
245 #[cfg(feature = "screen-capture")]
246 fn screen_capture_sources(
247 &self,
248 ) -> oneshot::Receiver<Result<Vec<Rc<dyn crate::ScreenCaptureSource>>>> {
249 self.screen_capture_sources()
250 }
251
252 fn active_window(&self) -> Option<AnyWindowHandle> {
253 self.active_window()
254 }
255
256 fn window_stack(&self) -> Option<Vec<AnyWindowHandle>> {
257 self.window_stack()
258 }
259
260 fn open_window(
261 &self,
262 handle: AnyWindowHandle,
263 options: WindowParams,
264 ) -> anyhow::Result<Box<dyn PlatformWindow>> {
265 self.open_window(handle, options)
266 }
267
268 fn open_url(&self, url: &str) {
269 self.open_uri(url);
270 }
271
272 fn on_open_urls(&self, callback: Box<dyn FnMut(Vec<String>)>) {
273 self.with_common(|common| common.callbacks.open_urls = Some(callback));
274 }
275
276 fn prompt_for_paths(
277 &self,
278 options: PathPromptOptions,
279 ) -> oneshot::Receiver<Result<Option<Vec<PathBuf>>>> {
280 let (done_tx, done_rx) = oneshot::channel();
281
282 #[cfg(not(any(feature = "wayland", feature = "x11")))]
283 let _ = (done_tx.send(Ok(None)), options);
284
285 #[cfg(any(feature = "wayland", feature = "x11"))]
286 self.foreground_executor()
287 .spawn(async move {
288 let title = if options.directories {
289 "Open Folder"
290 } else {
291 "Open File"
292 };
293
294 let request = match ashpd::desktop::file_chooser::OpenFileRequest::default()
295 .modal(true)
296 .title(title)
297 .multiple(options.multiple)
298 .directory(options.directories)
299 .send()
300 .await
301 {
302 Ok(request) => request,
303 Err(err) => {
304 let result = match err {
305 ashpd::Error::PortalNotFound(_) => anyhow!(FILE_PICKER_PORTAL_MISSING),
306 err => err.into(),
307 };
308 let _ = done_tx.send(Err(result));
309 return;
310 }
311 };
312
313 let result = match request.response() {
314 Ok(response) => Ok(Some(
315 response
316 .uris()
317 .iter()
318 .filter_map(|uri| uri.to_file_path().ok())
319 .collect::<Vec<_>>(),
320 )),
321 Err(ashpd::Error::Response(_)) => Ok(None),
322 Err(e) => Err(e.into()),
323 };
324 let _ = done_tx.send(result);
325 })
326 .detach();
327 done_rx
328 }
329
330 fn prompt_for_new_path(
331 &self,
332 directory: &Path,
333 suggested_name: Option<&str>,
334 ) -> oneshot::Receiver<Result<Option<PathBuf>>> {
335 let (done_tx, done_rx) = oneshot::channel();
336
337 #[cfg(not(any(feature = "wayland", feature = "x11")))]
338 let _ = (done_tx.send(Ok(None)), directory, suggested_name);
339
340 #[cfg(any(feature = "wayland", feature = "x11"))]
341 self.foreground_executor()
342 .spawn({
343 let directory = directory.to_owned();
344 let suggested_name = suggested_name.map(|s| s.to_owned());
345
346 async move {
347 let mut request_builder =
348 ashpd::desktop::file_chooser::SaveFileRequest::default()
349 .modal(true)
350 .title("Save File")
351 .current_folder(directory)
352 .expect("pathbuf should not be nul terminated");
353
354 if let Some(suggested_name) = suggested_name {
355 request_builder = request_builder.current_name(suggested_name.as_str());
356 }
357
358 let request = match request_builder.send().await {
359 Ok(request) => request,
360 Err(err) => {
361 let result = match err {
362 ashpd::Error::PortalNotFound(_) => {
363 anyhow!(FILE_PICKER_PORTAL_MISSING)
364 }
365 err => err.into(),
366 };
367 let _ = done_tx.send(Err(result));
368 return;
369 }
370 };
371
372 let result = match request.response() {
373 Ok(response) => Ok(response
374 .uris()
375 .first()
376 .and_then(|uri| uri.to_file_path().ok())),
377 Err(ashpd::Error::Response(_)) => Ok(None),
378 Err(e) => Err(e.into()),
379 };
380 let _ = done_tx.send(result);
381 }
382 })
383 .detach();
384
385 done_rx
386 }
387
388 fn can_select_mixed_files_and_dirs(&self) -> bool {
389 // org.freedesktop.portal.FileChooser only supports "pick files" and "pick directories".
390 false
391 }
392
393 fn reveal_path(&self, path: &Path) {
394 self.reveal_path(path.to_owned());
395 }
396
397 fn open_with_system(&self, path: &Path) {
398 let path = path.to_owned();
399 self.background_executor()
400 .spawn(async move {
401 let _ = std::process::Command::new("xdg-open")
402 .arg(path)
403 .spawn()
404 .context("invoking xdg-open")
405 .log_err();
406 })
407 .detach();
408 }
409
410 fn on_quit(&self, callback: Box<dyn FnMut()>) {
411 self.with_common(|common| {
412 common.callbacks.quit = Some(callback);
413 });
414 }
415
416 fn on_reopen(&self, callback: Box<dyn FnMut()>) {
417 self.with_common(|common| {
418 common.callbacks.reopen = Some(callback);
419 });
420 }
421
422 fn on_app_menu_action(&self, callback: Box<dyn FnMut(&dyn Action)>) {
423 self.with_common(|common| {
424 common.callbacks.app_menu_action = Some(callback);
425 });
426 }
427
428 fn on_will_open_app_menu(&self, callback: Box<dyn FnMut()>) {
429 self.with_common(|common| {
430 common.callbacks.will_open_app_menu = Some(callback);
431 });
432 }
433
434 fn on_validate_app_menu_command(&self, callback: Box<dyn FnMut(&dyn Action) -> bool>) {
435 self.with_common(|common| {
436 common.callbacks.validate_app_menu_command = Some(callback);
437 });
438 }
439
440 fn app_path(&self) -> Result<PathBuf> {
441 // get the path of the executable of the current process
442 let app_path = env::current_exe()?;
443 return Ok(app_path);
444 }
445
446 fn set_menus(&self, menus: Vec<Menu>, _keymap: &Keymap) {
447 self.with_common(|common| {
448 common.menus = menus.into_iter().map(|menu| menu.owned()).collect();
449 })
450 }
451
452 fn get_menus(&self) -> Option<Vec<OwnedMenu>> {
453 self.with_common(|common| Some(common.menus.clone()))
454 }
455
456 fn set_dock_menu(&self, _menu: Vec<MenuItem>, _keymap: &Keymap) {
457 // todo(linux)
458 }
459
460 fn path_for_auxiliary_executable(&self, _name: &str) -> Result<PathBuf> {
461 Err(anyhow::Error::msg(
462 "Platform<LinuxPlatform>::path_for_auxiliary_executable is not implemented yet",
463 ))
464 }
465
466 fn set_cursor_style(&self, style: CursorStyle) {
467 self.set_cursor_style(style)
468 }
469
470 fn should_auto_hide_scrollbars(&self) -> bool {
471 self.with_common(|common| common.auto_hide_scrollbars)
472 }
473
474 fn write_credentials(&self, url: &str, username: &str, password: &[u8]) -> Task<Result<()>> {
475 let url = url.to_string();
476 let username = username.to_string();
477 let password = password.to_vec();
478 self.background_executor().spawn(async move {
479 let keyring = oo7::Keyring::new().await?;
480 keyring.unlock().await?;
481 keyring
482 .create_item(
483 KEYRING_LABEL,
484 &vec![("url", &url), ("username", &username)],
485 password,
486 true,
487 )
488 .await?;
489 Ok(())
490 })
491 }
492
493 fn read_credentials(&self, url: &str) -> Task<Result<Option<(String, Vec<u8>)>>> {
494 let url = url.to_string();
495 self.background_executor().spawn(async move {
496 let keyring = oo7::Keyring::new().await?;
497 keyring.unlock().await?;
498
499 let items = keyring.search_items(&vec![("url", &url)]).await?;
500
501 for item in items.into_iter() {
502 if item.label().await.is_ok_and(|label| label == KEYRING_LABEL) {
503 let attributes = item.attributes().await?;
504 let username = attributes
505 .get("username")
506 .context("Cannot find username in stored credentials")?;
507 item.unlock().await?;
508 let secret = item.secret().await?;
509
510 // we lose the zeroizing capabilities at this boundary,
511 // a current limitation GPUI's credentials api
512 return Ok(Some((username.to_string(), secret.to_vec())));
513 } else {
514 continue;
515 }
516 }
517 Ok(None)
518 })
519 }
520
521 fn delete_credentials(&self, url: &str) -> Task<Result<()>> {
522 let url = url.to_string();
523 self.background_executor().spawn(async move {
524 let keyring = oo7::Keyring::new().await?;
525 keyring.unlock().await?;
526
527 let items = keyring.search_items(&vec![("url", &url)]).await?;
528
529 for item in items.into_iter() {
530 if item.label().await.is_ok_and(|label| label == KEYRING_LABEL) {
531 item.delete().await?;
532 return Ok(());
533 }
534 }
535
536 Ok(())
537 })
538 }
539
540 fn window_appearance(&self) -> WindowAppearance {
541 self.with_common(|common| common.appearance)
542 }
543
544 fn register_url_scheme(&self, _: &str) -> Task<anyhow::Result<()>> {
545 Task::ready(Err(anyhow!("register_url_scheme unimplemented")))
546 }
547
548 fn write_to_primary(&self, item: ClipboardItem) {
549 self.write_to_primary(item)
550 }
551
552 fn write_to_clipboard(&self, item: ClipboardItem) {
553 self.write_to_clipboard(item)
554 }
555
556 fn read_from_primary(&self) -> Option<ClipboardItem> {
557 self.read_from_primary()
558 }
559
560 fn read_from_clipboard(&self) -> Option<ClipboardItem> {
561 self.read_from_clipboard()
562 }
563
564 fn add_recent_document(&self, _path: &Path) {}
565}
566
567#[cfg(any(feature = "wayland", feature = "x11"))]
568pub(super) fn open_uri_internal(
569 executor: BackgroundExecutor,
570 uri: &str,
571 activation_token: Option<String>,
572) {
573 if let Some(uri) = ashpd::url::Url::parse(uri).log_err() {
574 executor
575 .spawn(async move {
576 match ashpd::desktop::open_uri::OpenFileRequest::default()
577 .activation_token(activation_token.clone().map(ashpd::ActivationToken::from))
578 .send_uri(&uri)
579 .await
580 {
581 Ok(_) => return,
582 Err(e) => log::error!("Failed to open with dbus: {}", e),
583 }
584
585 for mut command in open::commands(uri.to_string()) {
586 if let Some(token) = activation_token.as_ref() {
587 command.env("XDG_ACTIVATION_TOKEN", token);
588 }
589 match command.spawn() {
590 Ok(_) => return,
591 Err(e) => {
592 log::error!("Failed to open with {:?}: {}", command.get_program(), e)
593 }
594 }
595 }
596 })
597 .detach();
598 }
599}
600
601#[cfg(any(feature = "x11", feature = "wayland"))]
602pub(super) fn reveal_path_internal(
603 executor: BackgroundExecutor,
604 path: PathBuf,
605 activation_token: Option<String>,
606) {
607 executor
608 .spawn(async move {
609 if let Some(dir) = File::open(path.clone()).log_err() {
610 match ashpd::desktop::open_uri::OpenDirectoryRequest::default()
611 .activation_token(activation_token.map(ashpd::ActivationToken::from))
612 .send(&dir.as_fd())
613 .await
614 {
615 Ok(_) => return,
616 Err(e) => log::error!("Failed to open with dbus: {}", e),
617 }
618 if path.is_dir() {
619 open::that_detached(path).log_err();
620 } else {
621 open::that_detached(path.parent().unwrap_or(Path::new(""))).log_err();
622 }
623 }
624 })
625 .detach();
626}
627
628#[allow(unused)]
629pub(super) fn is_within_click_distance(a: Point<Pixels>, b: Point<Pixels>) -> bool {
630 let diff = a - b;
631 diff.x.abs() <= DOUBLE_CLICK_DISTANCE && diff.y.abs() <= DOUBLE_CLICK_DISTANCE
632}
633
634#[cfg(any(feature = "wayland", feature = "x11"))]
635pub(super) fn get_xkb_compose_state(cx: &xkb::Context) -> Option<xkb::compose::State> {
636 let mut locales = Vec::default();
637 if let Some(locale) = env::var_os("LC_CTYPE") {
638 locales.push(locale);
639 }
640 locales.push(OsString::from("C"));
641 let mut state: Option<xkb::compose::State> = None;
642 for locale in locales {
643 if let Ok(table) =
644 xkb::compose::Table::new_from_locale(&cx, &locale, xkb::compose::COMPILE_NO_FLAGS)
645 {
646 state = Some(xkb::compose::State::new(
647 &table,
648 xkb::compose::STATE_NO_FLAGS,
649 ));
650 break;
651 }
652 }
653 state
654}
655
656#[cfg(any(feature = "wayland", feature = "x11"))]
657pub(super) unsafe fn read_fd(mut fd: filedescriptor::FileDescriptor) -> Result<Vec<u8>> {
658 let mut file = unsafe { File::from_raw_fd(fd.as_raw_fd()) };
659 let mut buffer = Vec::new();
660 file.read_to_end(&mut buffer)?;
661 Ok(buffer)
662}
663
664#[cfg(any(feature = "wayland", feature = "x11"))]
665pub(super) const DEFAULT_CURSOR_ICON_NAME: &str = "left_ptr";
666
667impl CursorStyle {
668 #[cfg(any(feature = "wayland", feature = "x11"))]
669 pub(super) fn to_icon_names(&self) -> &'static [&'static str] {
670 // Based on cursor names from chromium:
671 // https://github.com/chromium/chromium/blob/d3069cf9c973dc3627fa75f64085c6a86c8f41bf/ui/base/cursor/cursor_factory.cc#L113
672 match self {
673 CursorStyle::Arrow => &[DEFAULT_CURSOR_ICON_NAME],
674 CursorStyle::IBeam => &["text", "xterm"],
675 CursorStyle::Crosshair => &["crosshair", "cross"],
676 CursorStyle::ClosedHand => &["closedhand", "grabbing", "hand2"],
677 CursorStyle::OpenHand => &["openhand", "grab", "hand1"],
678 CursorStyle::PointingHand => &["pointer", "hand", "hand2"],
679 CursorStyle::ResizeLeft => &["w-resize", "left_side"],
680 CursorStyle::ResizeRight => &["e-resize", "right_side"],
681 CursorStyle::ResizeLeftRight => &["ew-resize", "sb_h_double_arrow"],
682 CursorStyle::ResizeUp => &["n-resize", "top_side"],
683 CursorStyle::ResizeDown => &["s-resize", "bottom_side"],
684 CursorStyle::ResizeUpDown => &["sb_v_double_arrow", "ns-resize"],
685 CursorStyle::ResizeUpLeftDownRight => &["size_fdiag", "bd_double_arrow", "nwse-resize"],
686 CursorStyle::ResizeUpRightDownLeft => &["size_bdiag", "nesw-resize", "fd_double_arrow"],
687 CursorStyle::ResizeColumn => &["col-resize", "sb_h_double_arrow"],
688 CursorStyle::ResizeRow => &["row-resize", "sb_v_double_arrow"],
689 CursorStyle::IBeamCursorForVerticalLayout => &["vertical-text"],
690 CursorStyle::OperationNotAllowed => &["not-allowed", "crossed_circle"],
691 CursorStyle::DragLink => &["alias"],
692 CursorStyle::DragCopy => &["copy"],
693 CursorStyle::ContextualMenu => &["context-menu"],
694 CursorStyle::None => {
695 #[cfg(debug_assertions)]
696 panic!("CursorStyle::None should be handled separately in the client");
697 #[cfg(not(debug_assertions))]
698 &[DEFAULT_CURSOR_ICON_NAME]
699 }
700 }
701 }
702}
703
704#[cfg(any(feature = "wayland", feature = "x11"))]
705pub(super) fn log_cursor_icon_warning(message: impl std::fmt::Display) {
706 if let Ok(xcursor_path) = env::var("XCURSOR_PATH") {
707 log::warn!(
708 "{:#}\ncursor icon loading may be failing if XCURSOR_PATH environment variable is invalid. \
709 XCURSOR_PATH overrides the default icon search. Its current value is '{}'",
710 message,
711 xcursor_path
712 );
713 } else {
714 log::warn!("{:#}", message);
715 }
716}
717
718#[cfg(any(feature = "wayland", feature = "x11"))]
719fn guess_ascii(keycode: Keycode, shift: bool) -> Option<char> {
720 let c = match (keycode.raw(), shift) {
721 (24, _) => 'q',
722 (25, _) => 'w',
723 (26, _) => 'e',
724 (27, _) => 'r',
725 (28, _) => 't',
726 (29, _) => 'y',
727 (30, _) => 'u',
728 (31, _) => 'i',
729 (32, _) => 'o',
730 (33, _) => 'p',
731 (34, false) => '[',
732 (34, true) => '{',
733 (35, false) => ']',
734 (35, true) => '}',
735 (38, _) => 'a',
736 (39, _) => 's',
737 (40, _) => 'd',
738 (41, _) => 'f',
739 (42, _) => 'g',
740 (43, _) => 'h',
741 (44, _) => 'j',
742 (45, _) => 'k',
743 (46, _) => 'l',
744 (47, false) => ';',
745 (47, true) => ':',
746 (48, false) => '\'',
747 (48, true) => '"',
748 (49, false) => '`',
749 (49, true) => '~',
750 (51, false) => '\\',
751 (51, true) => '|',
752 (52, _) => 'z',
753 (53, _) => 'x',
754 (54, _) => 'c',
755 (55, _) => 'v',
756 (56, _) => 'b',
757 (57, _) => 'n',
758 (58, _) => 'm',
759 (59, false) => ',',
760 (59, true) => '>',
761 (60, false) => '.',
762 (60, true) => '<',
763 (61, false) => '/',
764 (61, true) => '?',
765
766 _ => return None,
767 };
768
769 Some(c)
770}
771
772#[cfg(any(feature = "wayland", feature = "x11"))]
773impl crate::Keystroke {
774 pub(super) fn from_xkb(
775 state: &State,
776 mut modifiers: crate::Modifiers,
777 keycode: Keycode,
778 ) -> Self {
779 let key_utf32 = state.key_get_utf32(keycode);
780 let key_utf8 = state.key_get_utf8(keycode);
781 let key_sym = state.key_get_one_sym(keycode);
782
783 let key = match key_sym {
784 Keysym::Return => "enter".to_owned(),
785 Keysym::Prior => "pageup".to_owned(),
786 Keysym::Next => "pagedown".to_owned(),
787 Keysym::ISO_Left_Tab => "tab".to_owned(),
788 Keysym::KP_Prior => "pageup".to_owned(),
789 Keysym::KP_Next => "pagedown".to_owned(),
790 Keysym::XF86_Back => "back".to_owned(),
791 Keysym::XF86_Forward => "forward".to_owned(),
792 Keysym::XF86_Cut => "cut".to_owned(),
793 Keysym::XF86_Copy => "copy".to_owned(),
794 Keysym::XF86_Paste => "paste".to_owned(),
795 Keysym::XF86_New => "new".to_owned(),
796 Keysym::XF86_Open => "open".to_owned(),
797 Keysym::XF86_Save => "save".to_owned(),
798
799 Keysym::comma => ",".to_owned(),
800 Keysym::period => ".".to_owned(),
801 Keysym::less => "<".to_owned(),
802 Keysym::greater => ">".to_owned(),
803 Keysym::slash => "/".to_owned(),
804 Keysym::question => "?".to_owned(),
805
806 Keysym::semicolon => ";".to_owned(),
807 Keysym::colon => ":".to_owned(),
808 Keysym::apostrophe => "'".to_owned(),
809 Keysym::quotedbl => "\"".to_owned(),
810
811 Keysym::bracketleft => "[".to_owned(),
812 Keysym::braceleft => "{".to_owned(),
813 Keysym::bracketright => "]".to_owned(),
814 Keysym::braceright => "}".to_owned(),
815 Keysym::backslash => "\\".to_owned(),
816 Keysym::bar => "|".to_owned(),
817
818 Keysym::grave => "`".to_owned(),
819 Keysym::asciitilde => "~".to_owned(),
820 Keysym::exclam => "!".to_owned(),
821 Keysym::at => "@".to_owned(),
822 Keysym::numbersign => "#".to_owned(),
823 Keysym::dollar => "$".to_owned(),
824 Keysym::percent => "%".to_owned(),
825 Keysym::asciicircum => "^".to_owned(),
826 Keysym::ampersand => "&".to_owned(),
827 Keysym::asterisk => "*".to_owned(),
828 Keysym::parenleft => "(".to_owned(),
829 Keysym::parenright => ")".to_owned(),
830 Keysym::minus => "-".to_owned(),
831 Keysym::underscore => "_".to_owned(),
832 Keysym::equal => "=".to_owned(),
833 Keysym::plus => "+".to_owned(),
834 Keysym::space => "space".to_owned(),
835 Keysym::BackSpace => "backspace".to_owned(),
836 Keysym::Tab => "tab".to_owned(),
837 Keysym::Delete => "delete".to_owned(),
838 Keysym::Escape => "escape".to_owned(),
839
840 Keysym::Left => "left".to_owned(),
841 Keysym::Right => "right".to_owned(),
842 Keysym::Up => "up".to_owned(),
843 Keysym::Down => "down".to_owned(),
844 Keysym::Home => "home".to_owned(),
845 Keysym::End => "end".to_owned(),
846
847 _ => {
848 let name = xkb::keysym_get_name(key_sym).to_lowercase();
849 if key_sym.is_keypad_key() {
850 name.replace("kp_", "")
851 } else if let Some(key) = key_utf8.chars().next()
852 && key_utf8.len() == 1
853 && key.is_ascii()
854 {
855 if key.is_ascii_graphic() {
856 key_utf8.to_lowercase()
857 // map ctrl-a to `a`
858 // ctrl-0..9 may emit control codes like ctrl-[, but
859 // we don't want to map them to `[`
860 } else if key_utf32 <= 0x1f
861 && !name.chars().next().is_some_and(|c| c.is_ascii_digit())
862 {
863 ((key_utf32 as u8 + 0x40) as char)
864 .to_ascii_lowercase()
865 .to_string()
866 } else {
867 name
868 }
869 } else if let Some(key_en) = guess_ascii(keycode, modifiers.shift) {
870 String::from(key_en)
871 } else {
872 name
873 }
874 }
875 };
876
877 if modifiers.shift {
878 // we only include the shift for upper-case letters by convention,
879 // so don't include for numbers and symbols, but do include for
880 // tab/enter, etc.
881 if key.chars().count() == 1 && key.to_lowercase() == key.to_uppercase() {
882 modifiers.shift = false;
883 }
884 }
885
886 // Ignore control characters (and DEL) for the purposes of key_char
887 let key_char =
888 (key_utf32 >= 32 && key_utf32 != 127 && !key_utf8.is_empty()).then_some(key_utf8);
889
890 Self {
891 modifiers,
892 key,
893 key_char,
894 }
895 }
896
897 /**
898 * Returns which symbol the dead key represents
899 * <https://developer.mozilla.org/en-US/docs/Web/API/UI_Events/Keyboard_event_key_values#dead_keycodes_for_linux>
900 */
901 pub fn underlying_dead_key(keysym: Keysym) -> Option<String> {
902 match keysym {
903 Keysym::dead_grave => Some("`".to_owned()),
904 Keysym::dead_acute => Some("´".to_owned()),
905 Keysym::dead_circumflex => Some("^".to_owned()),
906 Keysym::dead_tilde => Some("~".to_owned()),
907 Keysym::dead_macron => Some("¯".to_owned()),
908 Keysym::dead_breve => Some("˘".to_owned()),
909 Keysym::dead_abovedot => Some("˙".to_owned()),
910 Keysym::dead_diaeresis => Some("¨".to_owned()),
911 Keysym::dead_abovering => Some("˚".to_owned()),
912 Keysym::dead_doubleacute => Some("˝".to_owned()),
913 Keysym::dead_caron => Some("ˇ".to_owned()),
914 Keysym::dead_cedilla => Some("¸".to_owned()),
915 Keysym::dead_ogonek => Some("˛".to_owned()),
916 Keysym::dead_iota => Some("ͅ".to_owned()),
917 Keysym::dead_voiced_sound => Some("゙".to_owned()),
918 Keysym::dead_semivoiced_sound => Some("゚".to_owned()),
919 Keysym::dead_belowdot => Some("̣̣".to_owned()),
920 Keysym::dead_hook => Some("̡".to_owned()),
921 Keysym::dead_horn => Some("̛".to_owned()),
922 Keysym::dead_stroke => Some("̶̶".to_owned()),
923 Keysym::dead_abovecomma => Some("̓̓".to_owned()),
924 Keysym::dead_abovereversedcomma => Some("ʽ".to_owned()),
925 Keysym::dead_doublegrave => Some("̏".to_owned()),
926 Keysym::dead_belowring => Some("˳".to_owned()),
927 Keysym::dead_belowmacron => Some("̱".to_owned()),
928 Keysym::dead_belowcircumflex => Some("ꞈ".to_owned()),
929 Keysym::dead_belowtilde => Some("̰".to_owned()),
930 Keysym::dead_belowbreve => Some("̮".to_owned()),
931 Keysym::dead_belowdiaeresis => Some("̤".to_owned()),
932 Keysym::dead_invertedbreve => Some("̯".to_owned()),
933 Keysym::dead_belowcomma => Some("̦".to_owned()),
934 Keysym::dead_currency => None,
935 Keysym::dead_lowline => None,
936 Keysym::dead_aboveverticalline => None,
937 Keysym::dead_belowverticalline => None,
938 Keysym::dead_longsolidusoverlay => None,
939 Keysym::dead_a => None,
940 Keysym::dead_A => None,
941 Keysym::dead_e => None,
942 Keysym::dead_E => None,
943 Keysym::dead_i => None,
944 Keysym::dead_I => None,
945 Keysym::dead_o => None,
946 Keysym::dead_O => None,
947 Keysym::dead_u => None,
948 Keysym::dead_U => None,
949 Keysym::dead_small_schwa => Some("ə".to_owned()),
950 Keysym::dead_capital_schwa => Some("Ə".to_owned()),
951 Keysym::dead_greek => None,
952 _ => None,
953 }
954 }
955}
956
957#[cfg(any(feature = "wayland", feature = "x11"))]
958impl crate::Modifiers {
959 pub(super) fn from_xkb(keymap_state: &State) -> Self {
960 let shift = keymap_state.mod_name_is_active(xkb::MOD_NAME_SHIFT, xkb::STATE_MODS_EFFECTIVE);
961 let alt = keymap_state.mod_name_is_active(xkb::MOD_NAME_ALT, xkb::STATE_MODS_EFFECTIVE);
962 let control =
963 keymap_state.mod_name_is_active(xkb::MOD_NAME_CTRL, xkb::STATE_MODS_EFFECTIVE);
964 let platform =
965 keymap_state.mod_name_is_active(xkb::MOD_NAME_LOGO, xkb::STATE_MODS_EFFECTIVE);
966 Self {
967 shift,
968 alt,
969 control,
970 platform,
971 function: false,
972 }
973 }
974}
975
976#[cfg(any(feature = "wayland", feature = "x11"))]
977impl crate::Capslock {
978 pub(super) fn from_xkb(keymap_state: &State) -> Self {
979 let on = keymap_state.mod_name_is_active(xkb::MOD_NAME_CAPS, xkb::STATE_MODS_EFFECTIVE);
980 Self { on }
981 }
982}
983
984#[cfg(test)]
985mod tests {
986 use super::*;
987 use crate::{Point, px};
988
989 #[test]
990 fn test_is_within_click_distance() {
991 let zero = Point::new(px(0.0), px(0.0));
992 assert_eq!(
993 is_within_click_distance(zero, Point::new(px(5.0), px(5.0))),
994 true
995 );
996 assert_eq!(
997 is_within_click_distance(zero, Point::new(px(-4.9), px(5.0))),
998 true
999 );
1000 assert_eq!(
1001 is_within_click_distance(Point::new(px(3.0), px(2.0)), Point::new(px(-2.0), px(-2.0))),
1002 true
1003 );
1004 assert_eq!(
1005 is_within_click_distance(zero, Point::new(px(5.0), px(5.1))),
1006 false
1007 );
1008 }
1009}