rust-windowing / xkeysym

X11 keyboard symbol utilities for Rust

xkeysyms

This crate provides constants representing all of the X11 keyboard symbols. It also provides utility functions for working with those symbols, and for converting between keyboard codes and keyboard symbols. This crate does not depend on a particular implementation of the X11 protocol and can therefore be used in any context where X11 keyboard symbols are needed.

In addition, this crate contains no unsafe code and is fully compatible with no_std environments.

MSRV Policy

The Minimum Safe Rust Version for this crate is 1.58.1.

Updating Headers

To update the automatically generated keyboard symbols in the automatically_generated.rs file, install Just and run just. The process creates a Debian Docker container in order to keep the files consistent, so make sure Docker is installed first.

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
• Zlib license (LICENSE-ZLIB or https://opensource.org/licenses/Zlib)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be triple licensed as above, without any additional terms or conditions.

xkeysym's Issues

Use NonZeroU32 as the backing type for Keysym

X11 generally uses the NO_KEYSYM value, as alias for zero, to denote that a keysym is not present. Therefore it would make sense to use a NonZeroU32 as the backing type for the Keysym type instead of u32. This way, for Option<Keysym> there is no ambiguity between None and Some(NO_KEYSYM).

Cons:

• There may be a necessary difference between None and Some(NO_KEYSYM).
• Requires raising the MSRV to 1.57 (although most of the windowing ecosystem is past that already so I wouldn't mind).

xkeysym::NO_SYMBOL not part of xkeysym::key

NO_SYMBOL is not part of the xkeysym::key module. This is a little unfortunate, because I need to use it and so far only have xkbcommon as an explicit dependency. xkbcommon does not export the NO_SYMBOL, so I would have to add xkeysym explicitly, or use Keysym(0). It would be more convenient, if I could use it just like all the other KeySym.

Match output of Keysym::name() with xdotools names

I am writing a library that uses xdotools to enter keys. In the documentation of the Keysym::name() fn it says:

Get a string corresponding to the name of this keyboard symbol.
The output of this function is **not stable** and is **intended for debugging purposes**.

Are there any thoughts to change this policy? It would be nice if I could use it. In order for the names to match, the "XK_" part would have to be removed.

Sync with xkbcommon 1.6

https://github.com/xkbcommon/libxkbcommon/releases/tag/xkbcommon-1.6.0

Tracking issue for making xkeysym the source of truth for X11 keyboard symbols

It was suggested to make this crate serve as a "source of truth" for keyboard symbols across the Rust GUI ecosystem (between X11 and Wayland). This issue serves as a tracking issue for all PRs/issues I file to do this.

Repositories to file PRs against

• xkbcommon (cc @rtbo), see rust-x-bindings/xkbcommon-rs#43
• smithay-client-toolkit (cc @i509VCB), see Smithay/client-toolkit#378
• xkbcommon-dl (cc @kchibisov), rust-windowing/xkbcommon-dl#8
• rust-xkb (cc @meh), PR not filed yet

I'll file draft PRs at first to make sure the interface checks out in all cases. Once I'm sure that we have the API that we want, I'll release xkeysym version 1.0.0 and mark all of these as ready.

Other matters

It was discussed that this repository should be moved to be under either @Smithay or @rust-windowing. Not sure what the organization admins' thoughts on that are. Done! It's been moved to @rust-windowing

I'll also ping @psychon and @eduardosm, since you've both expressed interest in unifying the X11 ecosystem (re as-raw-xcb-connection).

Make names to follow rust naming schema

We have weird names like XF86_ and SUN_, while they should be Xf86 and Sun respectively. Maybe some other names should be changed as well.