Split out platform-independent types into a new winit-core crate #3455

notgull · 2024-02-05T00:02:29Z

This PR implements the first item of #3433 by splitting the platform-independent types from winit into a new crate: winit-core. It contains mostly types, traits and structures from winit that are platform independent. As part of this commit, I made a handful of changes to certain types (most notably Event) to make them more platform-independent.

A brief summary of the changes made:

dpi and keyboard modules are copied over wholesale.
The errors in the error module that don't involve OsError are copied as well.
Some types from the window module are copied verbatim. WindowId is now a newtype over u64 instead of a platform-specific value. ActivationToken is copied and given methods to make it useful.
Event is given a new generic parameter to describe platform-specific key information. InnerSizeWriter is given methods to allow for instantiation. Aside from this, most things from the event module are copied verbatim.
AsyncRequestSerial and ControlFlow are copied from event_loop. AsyncRequestSerial::get is made public.

Aside from this, the biggest changes are just moving everything to winit-core and then re-exporting it.

I've formatted this PR as a series of changes in order to make reviewing easier. @rust-windowing/winit Please review this PR quickly. It will be difficult to rebase on top of new changes and it'll take me the whole day to remake it.

Closes #2759

Tested on all platforms changed
- Ran cargo check on all platforms to make sure it builds there.
- Did not actually run example programs on all platforms.
Added an entry to CHANGELOG.md if knowledge of this change could be valuable to users
Updated documentation to reflect any user-facing changes, including notes of platform-specific behavior
Created or updated an example program if it would help users understand this functionality
Updated feature matrix, if new features were added or implemented

notgull · 2024-02-05T00:19:09Z

@jackpot51 Any insight into why the Redox CI is failing with __errno not found errors?

jackpot51 · 2024-02-05T00:25:34Z

@notgull not sure, it may be trying to compile with the host compiler instead of a cross compiler?

notgull · 2024-02-05T00:33:44Z

It appears that the only failures are the Redox failure (is that new?) and ~~what appears to be a bug in cargo-apk~~ me forgetting to pass -p to cargo-apk. Both of which are unrelated to this PR.

notgull · 2024-02-05T04:20:29Z

No, the Redox failure is new. It looks like Redox can't compile run-wasm.

kchibisov · 2024-02-05T04:25:47Z

Why it compiles it in the first place?

notgull · 2024-02-05T05:05:59Z

Why it compiles it in the first place?

Because with the new workspace layout it tries to compile everything instead of just winit

This will allow us to split off crates from the main winit crate. Signed-off-by: John Nunley <[email protected]>

Signed-off-by: John Nunley <[email protected]>

As winit no longer owns some of the types this requires some adjustments in the Wayland backend. Signed-off-by: John Nunley <[email protected]>

Signed-off-by: John Nunley <[email protected]>

This commit moves WindowId to winit-core and replaces its inner type with a platform-agnostic `u64`. This required some changes to many of the backend in order to accommodate this new system. Signed-off-by: John Nunley <[email protected]>

This requires a similar restructuring as with WindowId. Signed-off-by: John Nunley <[email protected]>

This requires a lot of restructuring on the backend side, as we need to accommodate for backends not being able to construct these types implicitly. In addition, we also need to expose some new APIs on these types to make them usable. Several breaking changes occurred in this commit. Signed-off-by: John Nunley <[email protected]>

Signed-off-by: John Nunley <[email protected]>

- Update CHANGELOG - Add documentation to items I forgot to document - Trait implementations Signed-off-by: John Nunley <[email protected]>

Signed-off-by: John Nunley <[email protected]>

madsmtm · 2024-02-12T17:29:03Z

winit/src/platform_impl/ios/mod.rs

-/// There is no way to detect which device that performed a certain event in
-/// UIKit (i.e. you can't differentiate between different external keyboards,
-/// or wether it was the main touchscreen, assistive technologies, or some
-/// other pointer device that caused a touch event).


I'd like to retain this comment in some shape or form, it is nice to know that device IDs will never be supported on iOS.

madsmtm · 2024-02-12T17:36:13Z

winit-core/src/event.rs

@@ -683,7 +665,7 @@ pub struct RawKeyEvent {

 /// Describes a keyboard input targeting a window.
 #[derive(Debug, Clone, Eq, PartialEq, Hash)]
-pub struct KeyEvent {
+pub struct KeyEvent<Extra> {


I dislike this design, and think we need to discuss further how to do this sort of thing. See also #3064.

So maybe refrain from moving the event structures in this PR?

madsmtm · 2024-02-12T17:40:09Z

Cargo.toml

+[workspace]
+members = [
+    "run-wasm",
+    "winit",


I think it's a mistake to move winit to a subdirectory, at least yet, and it also complicates this PR unnecessarily. There is especially value in having the top-level examples directory.

~~Let's use the include field instead to specify which files should be included in the winit package.~~ The include field isn't needed, Cargo automatically doesn't include subcrates.

notgull requested review from jackpot51, msiglreith, daxpedda, madsmtm, kchibisov and MarijnS95 as code owners February 5, 2024 00:02

notgull requested a review from a team February 5, 2024 00:02

notgull added 17 commits February 6, 2024 18:58

chore: Move winit files to winit subfolder

3a81764

This will allow us to split off crates from the main winit crate. Signed-off-by: John Nunley <[email protected]>

chore: Bring up winit-core crate

a97255e

Signed-off-by: John Nunley <[email protected]>

chore: Move part of error.rs to winit-core

623b3e5

Signed-off-by: John Nunley <[email protected]>

chore: Move dpi.rs to winit-core wholesale

5574644

Signed-off-by: John Nunley <[email protected]>

chore: Move most of keyboard.rs to winit-core

2f19731

Signed-off-by: John Nunley <[email protected]>

chore: Move parts of window.rs to winit-core

114e699

As winit no longer owns some of the types this requires some adjustments in the Wayland backend. Signed-off-by: John Nunley <[email protected]>

feat: Re-export cursor types in winit-core/window

48831f7

Signed-off-by: John Nunley <[email protected]>

feat: Move WindowId to winit-core

a232f7b

This commit moves WindowId to winit-core and replaces its inner type with a platform-agnostic `u64`. This required some changes to many of the backend in order to accommodate this new system. Signed-off-by: John Nunley <[email protected]>

feat: Move DeviceId to winit-core

859a6f1

This requires a similar restructuring as with WindowId. Signed-off-by: John Nunley <[email protected]>

chore: Move over ControlFlow

c6e5743

Signed-off-by: John Nunley <[email protected]>

chore: Housekeeping

daf1304

- Update CHANGELOG - Add documentation to items I forgot to document - Trait implementations Signed-off-by: John Nunley <[email protected]>

chore: fmt and doc fixes

4b28f10

Signed-off-by: John Nunley <[email protected]>

chore: Fix failing CI

52532d2

Signed-off-by: John Nunley <[email protected]>

ci: Use -p option in CI

1b9c576

Signed-off-by: John Nunley <[email protected]>

ci: Missed a spot

cfd35d2

Signed-off-by: John Nunley <[email protected]>

chore: Rebase on latest master

d28c867

Signed-off-by: John Nunley <[email protected]>

notgull force-pushed the notgull/split branch from c3ec89a to d28c867 Compare February 7, 2024 03:02

madsmtm requested changes Feb 12, 2024

View reviewed changes

madsmtm mentioned this pull request Feb 23, 2024

Split Winit up into multiple crates #3433

Open

5 tasks

notgull closed this Feb 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Split out platform-independent types into a new winit-core crate #3455

Split out platform-independent types into a new winit-core crate #3455

notgull commented Feb 5, 2024

notgull commented Feb 5, 2024

jackpot51 commented Feb 5, 2024

notgull commented Feb 5, 2024 •

edited

Loading

notgull commented Feb 5, 2024

kchibisov commented Feb 5, 2024

notgull commented Feb 5, 2024

madsmtm Feb 12, 2024

madsmtm Feb 12, 2024 •

edited

Loading

madsmtm Feb 12, 2024 •

edited

Loading

Split out platform-independent types into a new winit-core crate #3455

Split out platform-independent types into a new winit-core crate #3455

Conversation

notgull commented Feb 5, 2024

notgull commented Feb 5, 2024

jackpot51 commented Feb 5, 2024

notgull commented Feb 5, 2024 • edited Loading

notgull commented Feb 5, 2024

kchibisov commented Feb 5, 2024

notgull commented Feb 5, 2024

madsmtm Feb 12, 2024

Choose a reason for hiding this comment

madsmtm Feb 12, 2024 • edited Loading

Choose a reason for hiding this comment

madsmtm Feb 12, 2024 • edited Loading

Choose a reason for hiding this comment

notgull commented Feb 5, 2024 •

edited

Loading

madsmtm Feb 12, 2024 •

edited

Loading

madsmtm Feb 12, 2024 •

edited

Loading