Add i3/Sway support

[nydragon]

This pr adds support for retrieving data from Sway's IPC.

Features:

• Get last IPC object
• Dispatch Sway commands
• Workspaces
  • Retrieve all
  • Listen to data changes via signals
  • Force full refresh of workspaces
  • Get active
  • Live update
• Monitors
  • Retrieve all
  • Listen to data changes via signals
  • Force full refresh of monitors
  • Get active
  • Live update

Additional Todo:

• documentation

[outfoxxed]

Looks largely copied from hyprland ipc at this point so I figured I'd mention a few things:

• Make sure you only copy what makes sense to copy, don't keep what doesn't fit.
• If you can leave the dispatch socket open you should. You can't in hyprland, idk about i3/sway
• If you aren't implementing any sway specific features, this should work with i3 and be named as such.

[nydragon]

Thanks for the feedback, I wanted to stay mainly in line with the existing code, but I do have some questions:

1. Sway calls monitors "outputs", should that be reflected in Quickshell or is it better to be have uniform naming across different compositors ? Or "dispatch" is called "run commands"
2. Should I move the x11 and wayland folders into a compositor folder and create a shared folder in there? Or where would I put the sway-i3 code ?
3. We could abstract a part of the logic, namely the workspace/monitors refresh functions, across Hyprland & Sway/i3, does that make sense ?

[outfoxxed]

1. Monitor. Dispatch under hyprland is only for commands with no response as we don't currently have a promise type.
2. For now src/x11/i3/ipc is fine. Hyprland is under the wayland folder because it has to use cmake functions defined in the wayland folder.
3. Yes. This should happen, but not in this PR.

Also make sure you have a way to turn a sway monitor into a qs monitor.

[outfoxxed]

You've force pushed a lot, this ready for review?

[nydragon]

Yep, you could review it,

I would still want to implement more i3/Sway IPC features, but I think that will be for a later PR

[outfoxxed]

Bunch of nitpicks. I assume you've gone through and tested everything manually as well, run the lints, etc. If you have a tester file send that along as well and I'll give it a try before merging.

[nydragon]

I have just noticed a crash related to those changes, don't know how to replicate it yet but I would need to fix that before this PR can progress

edit: fixed, was a lot more straightforward than I thought

[outfoxxed]

Consider using QDataStream transactions instead. As is, if you break halfway through an event then the following event will be invalid and so on. check ipc.cpp for an example

[nydragon]

Consider using QDataStream transactions instead. As is, if you break halfway through an event then the following event will be invalid and so on. check ipc.cpp for an example

I ended up doing that with QByteArrays instead, if I encounter a broken message i try to find the next occurrence of the magic sequence and skip to there. However this is under the assumption that the Sway IPC does not write partial messages to the socket, and it does not seem to do so.

[outfoxxed]

Do we ever encounter broken messages? i3 shouldn't be sending those at all. I think the best solution to read the header would be a QDataStream transaction, which lets you do a partial read pretty easily.

Basically:

stream.startTransaction() stream.startTransaction() stream >> magic >> header bits >> size; if (!stream.commitTransaction()) return; stream >> data; // assuming you need size to find data. nested commitTransaction works as a barrier for the integrity of values read previosuly if (!stream.commitTransaction()) return;

You can nest transactions and it works pretty well. This should be more reliable than skipping events. Failing commits roll back the stream, and if there's enough data on the next readyread it should work.

[nydragon]

Alrighty, that should be implemented now, here is also a file to test the IPC impl:

Details

import QtQuick import Quickshell import Quickshell.I3 ShellRoot { PanelWindow { id: panel Timer { id: timer } Component.onCompleted: { const program = "foot"; // change to an installed program const longLog = false; // toggle logging of workspace & monitor objects const stringify = v => JSON.stringify(v, null, 2); console.log("Connecting to", I3.socketPath); I3.rawEvent.connect(e => { console.log("Event:", e.type); }); I3.focusedWorkspaceChanged.connect(() => { console.log("Changed to workspace", I3.focusedWorkspace.name, I3.focusedMonitor.focusedWorkspace.name); console.log("Focused monitor's focused workspace and actual focused workspace should be the same:"); console.log(`${I3.focusedMonitor.focusedWorkspace.name} and ${I3.focusedWorkspace.name}`); }); I3.focusedMonitorChanged.connect(() => { console.log("Changed to monitor", I3.focusedMonitor.name); }); for (const monitor of I3.monitors.values) { console.log("Monitor:", monitor.name); longLog && console.log(stringify(monitor)); } for (const workspace of I3.workspaces.values) { console.log("Workspace:", workspace.name); longLog && console.log(stringify(workspace)); I3.dispatch(`workspace ${workspace.num}`); } I3.dispatch(`workspace 13`); console.log(`Changing workspace response: ${stringify(I3.dispatch(`exec ${program}`))}`); console.log(`Bad request response: ${stringify(I3.dispatch(`quickshell`))}`); I3.dispatch(`workspace 1`); I3.refreshWorkspaces(); I3.refreshMonitors(); console.log(stringify(I3.monitorFor(panel.screen))); } } }

[outfoxxed]

Until you commit the transaction you shouldn't access data that is part of it, as it might not have been read. Also, rolling back the transaction to read again when you hit something invalid will just hang. On my phone rn, will do a proper code review again later.

[outfoxxed]

While reviewing, I was going to test it and it crashed instantly under hyprland. It shouldn't work but it shouldn't crash either.

[outfoxxed]

Might've missed things again, but this is what I saw this time. Apologies for the repeated re-reviews but I want to be sure quickshell's integrations are stable.

[nydragon]

Should be all fixed now

[outfoxxed]

Didn't see anything else at a glance, will give it a more thorough lookover again shortly.

[outfoxxed]

We shouldn't be trying to write to the socket unless we're actually connected. I think hyprland IPC also does this though, now that I think about it. Will fix that later.

build/src/quickshell -p testi3.qml INFO: Launching config: "/home/admin/programming/outfoxxed/quickshell/i3/testi3.qml" INFO: Shell ID: "c4c77744f223921c7870881fbb46b0a8" Path ID "c4c77744f223921c7870881fbb46b0a8" INFO: Saving logs to "/run/user/1000/quickshell/by-id/jij3guvdns/log.log" WARN quickshell.I3.ipc: $I3SOCK is unset. Trying $SWAYSOCK. WARN quickshell.I3.ipc: $SWAYSOCK and I3SOCK are unset. Cannot connect to socket. DEBUG qml: Connecting to WARN: QIODevice::write (QLocalSocket): device not open WARN: QIODevice::write (QLocalSocket): device not open DEBUG qml: Changing workspace response: undefined WARN: QIODevice::write (QLocalSocket): device not open DEBUG qml: Bad request response: undefined WARN: QIODevice::write (QLocalSocket): device not open WARN: QIODevice::write (QLocalSocket): device not open WARN: QIODevice::write (QLocalSocket): device not open DEBUG qml: null INFO: Configuration Loaded 

[outfoxxed]

Failing lints

/home/admin/programming/outfoxxed/quickshell/i3/src/x11/i3/ipc/qml.cpp:3:1: error: included header qjsonarray.h is not used directly [misc-include-cleaner,-warnings-as-errors] 3 | #include <qjsonarray.h> | ^~~~~~~~~~~~~~~~~~~~~~~ 4 | #include <qobject.h> 

/home/admin/programming/outfoxxed/quickshell/i3/src/x11/i3/ipc/connection.cpp:96:34: error: class member accesses must explicitly use thisptr [tidyfox-explicit-thisptr,-warnings-as-errors] 96 | for (auto& [type, data]: I3Ipc::parseResponse()) { | ^ | this-> /home/admin/programming/outfoxxed/quickshell/i3/src/x11/i3/ipc/connection.cpp:135:7: error: no header providing "strncmp" is directly included [misc-include-cleaner,-warnings-as-errors] 3 | if (strncmp(buffer.data(), MAGIC.data(), 6) != 0) { | ^ /home/admin/programming/outfoxxed/quickshell/i3/src/x11/i3/ipc/connection.cpp:377:13: error: method 'handleRunCommand' can be made static [readability-convert-member-functions-to-static,-warnings-as-errors] 377 | void I3Ipc::handleRunCommand(I3IpcEvent* event) { | ^ /home/admin/programming/outfoxxed/quickshell/i3/src/x11/i3/ipc/connection.cpp:380:3: error: variable 'success' of type 'bool' can be declared 'const' [misc-const-correctness,-warnings-as-errors] 380 | bool success = obj["success"].toBool(); | ^ | const /home/admin/programming/outfoxxed/quickshell/i3/src/x11/i3/ipc/connection.cpp:383:4: error: variable 'error' of type 'QString' can be declared 'const' [misc-const-correctness,-warnings-as-errors] 383 | QString error = obj["error"].toString(); | ^ | const 

[nydragon]

Fixed

[outfoxxed]

Thanks!