Port to GTK4 #105

Ferdi265 · 2024-09-15T19:10:07Z

This PR ports SwayOSD to GTK4. Applies on top of #104. Fixes #75. Fixes #101.

A lot of changes to prepare for this were already done, but GTK4 changes a lot more which had to be worked around. Note that this branch requires gtk4-layer-shell 1.0.4 or later due to an issue causing Wayland protocol errors.

Main changes:

syntax for clone! macro has changed (#[strong] instead of @strong and , instead of =>)
GDK Display no longer has useful monitor added/removed signals
- the alternative is to use the .monitors() ListModel, which is non-generic and has an ugly API. seems to work though.
StyleContext is deprecated and its API changed
- CSSProviders still exist, but the API looks different, I managed to make it compile, but I'm not 100% sure it's correct
Some Widget/Container APIs changed
- Monitor no longer has workarea(), switched to geometry(), hope that's the same.
- Window has set_child() instead of add()
- Box now has append() instead of add()
  - Box no longer has a simple way of iterating through all children, which sucks
  - ~~somehow removing Box children doesn't work~~ you need to be very careful when iterating to make remove work, since it seems to be a linked-list-like structure.
- Image no longer has a size_allocate signal, but realize is hopefully similar
- The logic for updating the layer shell margin was changed to (a) work properly in GTK4 and (b) work properly with output scale changes

TODO

Make it compile
Make it work without crashing
Fix visual changes and bugs

Ferdi265 · 2024-09-15T19:18:55Z

This will probably take a while to be finished, but since there is now at least a compiling gtk4 codebase, hopefully it will be less daunting for other people to help.

Ferdi265 · 2024-09-17T18:42:47Z

I figured out how to make it work (including a bug reproducer for gtk4-layer-shell), will push once it's cleaned up :)

The current version runs, but doesn't correctly handle changes in output size or scale (since connect_map() leads to crashes). I'm also working on a fix for gtk4-layer-shell.

Ferdi265 · 2024-09-20T23:42:21Z

Fix for upstream gtk4-layer-shell issue: wmww/gtk4-layer-shell#49

With that fix it doesn't crash any more. I also changed the margin code so it is always updated when its inputs change, which is more reliable than relying on connect_map() and hoping everything is ready at that point and doesn't change any more. I also worked around a bug with GTK4's output scale sometimes being incorrect (it never goes back to 1.0 scale after being at 2.0 even if I change the output scale back in sway) by manually transforming the output size into window coordinates (this fixes #101).

The main issue remaining is some "Channel Send error: sending into a closed channel" errors printed on stderr, I probably did something wrong while porting the MainContext::channel() usage to async_channel (I should check whether this also happens in #104 and fix both)

- some icons are broken - clearing osd window doesn't work - gtk4_layer_shell crashes more often than not

we need to get the next sibling before we remove it from the box.

some icons (notably volume icons) don't seem to be detected by has_icon properly in all cases, but the icon is drawn correctly. Use gio::ThemedIcon directly and pass "missing-symbolic" as a fallback name through there to avoid checking explicitly.

This ensures the window margin is always correct. This also fixes an annoying issue where the monitor scale factor is not always correct (it never changes back to scale 1 if it was scale 2 at some point) by transforming the monitor height into window coordinates manually. Fixes ErikReider#101.

Ferdi265 · 2024-09-22T12:47:41Z

The main issue remaining is some "Channel Send error: sending into a closed channel" errors printed on stderr, I probably did something wrong while porting the MainContext::channel() usage to async_channel (I should check whether this also happens in #104 and fix both)

Channel issue is now fixed with the latest rebase.

Ferdi265 · 2024-09-22T12:56:08Z

Should be mostly ready for review now. It looks slightly different than the GTK3 version (GTK4 has more default padding), but looks like it works quite well. I've switched to it as my daily driver.

Still depends on the upstream gtk4-layer-shell fix PR

werdahias · 2024-09-22T13:08:10Z

awesome, thanks for your work !

NullVoxPopuli · 2024-10-23T23:13:13Z

excited for this!

Ferdi265 · 2024-10-23T23:17:33Z

I've been running this branch as my daily driver for the last month and haven't seen any crashes, but it seems to hang sometimes, requiring a restart to get responsive again. I'll try to run a debug build for the next week or two to see if I can figure out the issue.

NullVoxPopuli · 2024-10-24T00:59:35Z

This is working great -- I had to install some deps to compile it, but 10/10 would install/compile again

Ferdi265 · 2024-10-26T23:19:02Z

The upstream gtk4-layer-shell fix for the crash issue has just been merged, but hasn't been released yet.

Ferdi265 · 2024-10-27T10:13:48Z

I've been running this branch as my daily driver for the last month and haven't seen any crashes, but it seems to hang sometimes, requiring a restart to get responsive again. I'll try to run a debug build for the next week or two to see if I can figure out the issue.

The libinput dbus signal listener was hanging in Sender::send_blocking(). This seems to happen mostly when SwayOSD is started as a systemd user service on system startup, seems like a timing issue.

I changed the code to spawn an async task on the MainContext and use an async send().await there instead. Let's see if this fixes the issue. If this doesn't occur in the next two weeks or so in my testing I'll consider this fixed.

UPDATE: I haven't seen the issue last week, so I've changed to running a release build instead of a debug build and if it still doesn't appear I consider this fixed.

Ferdi265 · 2024-11-18T20:09:20Z

UPDATE: I haven't seen the issue last week, so I've changed to running a release build instead of a debug build and if it still doesn't appear I consider this fixed.

The issue hasn't reappeared, and I also haven't encountered any other obvious bugs in my usage. Also, gtk4-layer-shell 1.0.4 has been released, which contains the fix for the upstream crash issue.

ErikReider

Thanks a ton for the PR! Sorry for the delay, Uni has me pretty busy 😅

Ferdi265 added 2 commits September 14, 2024 14:33

zbus: move to non-deprecated attribute macros

361ea7c

server: move from MainContext::channel to async_channel

da62b8c

Ferdi265 force-pushed the port-gtk4 branch from b3e6f03 to 7628440 Compare September 15, 2024 19:18

Ferdi265 force-pushed the port-gtk4 branch from 7628440 to e86ea3e Compare September 17, 2024 16:31

Ferdi265 force-pushed the port-gtk4 branch from c0e3e90 to c8c4035 Compare September 20, 2024 23:36

Ferdi265 force-pushed the port-gtk4 branch from c8c4035 to 19b0174 Compare September 20, 2024 23:44

Ferdi265 added 9 commits September 22, 2024 14:41

src/server: fix receiver being closed after ignored libinput event

68ef5d0

server: update gtk to 0.18.1

0fc4949

server: update to gtk-layer-shell 0.8.1

25faeab

initial port to gtk4 (compiles but doesn't work properly)

de8d325

- some icons are broken - clearing osd window doesn't work - gtk4_layer_shell crashes more often than not

rustfmt.toml: fix warning

01abe80

server/osd_window: fix clear_osd() not actually removing things

79a6b74

we need to get the next sibling before we remove it from the box.

server/osd_window: fix gtk4-layer-shell crash

f31c0af

Ferdi265 force-pushed the port-gtk4 branch from 19b0174 to c4c1aee Compare September 22, 2024 12:46

Ferdi265 changed the title ~~[WIP] Port to GTK4~~ Port to GTK4 Sep 22, 2024

Ferdi265 marked this pull request as ready for review September 22, 2024 12:56

Ferdi265 added 2 commits October 27, 2024 10:58

server/application: asynchronously send libinput events

445a95c

server: remove unused imports

da9d6ce

server/application: clean up gtk imports

d9504c3

ErikReider approved these changes Nov 19, 2024

View reviewed changes

ErikReider merged commit bf77623 into ErikReider:main Nov 19, 2024
1 check passed

Ferdi265 deleted the port-gtk4 branch November 21, 2024 19:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Port to GTK4 #105

Port to GTK4 #105

Ferdi265 commented Sep 15, 2024 •

edited

Loading

Ferdi265 commented Sep 15, 2024

Ferdi265 commented Sep 17, 2024 •

edited

Loading

Ferdi265 commented Sep 20, 2024 •

edited

Loading

Ferdi265 commented Sep 22, 2024

Ferdi265 commented Sep 22, 2024

werdahias commented Sep 22, 2024

NullVoxPopuli commented Oct 23, 2024

Ferdi265 commented Oct 23, 2024 •

edited

Loading

NullVoxPopuli commented Oct 24, 2024

Ferdi265 commented Oct 26, 2024 •

edited

Loading

Ferdi265 commented Oct 27, 2024 •

edited

Loading

Ferdi265 commented Nov 18, 2024

ErikReider left a comment

Port to GTK4 #105

Port to GTK4 #105

Conversation

Ferdi265 commented Sep 15, 2024 • edited Loading

TODO

Ferdi265 commented Sep 15, 2024

Ferdi265 commented Sep 17, 2024 • edited Loading

Ferdi265 commented Sep 20, 2024 • edited Loading

Ferdi265 commented Sep 22, 2024

Ferdi265 commented Sep 22, 2024

werdahias commented Sep 22, 2024

NullVoxPopuli commented Oct 23, 2024

Ferdi265 commented Oct 23, 2024 • edited Loading

NullVoxPopuli commented Oct 24, 2024

Ferdi265 commented Oct 26, 2024 • edited Loading

Ferdi265 commented Oct 27, 2024 • edited Loading

Ferdi265 commented Nov 18, 2024

ErikReider left a comment

Choose a reason for hiding this comment

Ferdi265 commented Sep 15, 2024 •

edited

Loading

Ferdi265 commented Sep 17, 2024 •

edited

Loading

Ferdi265 commented Sep 20, 2024 •

edited

Loading

Ferdi265 commented Oct 23, 2024 •

edited

Loading

Ferdi265 commented Oct 26, 2024 •

edited

Loading

Ferdi265 commented Oct 27, 2024 •

edited

Loading