Migrate Hyprland workspace events to v2 by shivros · Pull Request #3878 · Alexays/Waybar

shivros · 2025-01-10T18:36:04Z

The Hyprland v2 workspace events add the workspace ID to the event payload.

Currently Waybar relies on workspace names because that was the best the old events provided. By transitioning to IDs instead of names, Waybar can provide a more robust experience, avoid hairy issues like #3830.

At some point I'd like to follow up with a similar change in special workspaces, but activespecialv2 doesn't exist yet in Hyprland.

zjeffer

mostly nitpicking ;)

zjeffer · 2025-02-20T22:42:53Z

+  // TODO this will be in the payload when we upgrade to focusedmonv2
+  for (auto &workspace : m_workspaces) {
+    if (workspace->name() == workspaceName) {
+      m_activeWorkspaceId = workspace->id();
+      break;
+    }
+  }


focusedmonv2 has been added in hyprwm/Hyprland#8921, perhaps we can already upgrade to it?

Sure. I migrated all the v2 events that were in the hyprland docs.

zjeffer · 2025-02-20T23:02:32Z

+  if (eventName == "workspacev2") {
    onWorkspaceActivated(payload);
  } else if (eventName == "activespecial") {
    onSpecialWorkspaceActivated(payload);
-  } else if (eventName == "destroyworkspace") {
+  } else if (eventName == "destroyworkspacev2") {
    onWorkspaceDestroyed(payload);
-  } else if (eventName == "createworkspace") {
+  } else if (eventName == "createworkspacev2") {
    onWorkspaceCreated(payload);
  } else if (eventName == "focusedmon") {
    onMonitorFocused(payload);


According to the wiki, focusedmonv2, moveworkspacev2 and movewindowv2 are available. Perhaps you can upgrade those as well?

zjeffer · 2025-02-20T23:04:26Z

general comment: can you add try/catches around the std::stoi calls? If those throw, they would kill the module (or the whole bar? not sure), and the exception messages for failing stoi calls are always very unclear.

and maybe add const to the temporary variables you create if you don't modify or move them

No problem.

Added const to the appropriate variables.

put all the stoi calls in a parseWorkspaceId function that catches and logs the exception

zjeffer · 2025-02-20T23:16:58Z

+  int id;
+  std::string name;
+
+  try {
+    // If this succeeds, we have a workspace ID.
+    id = std::stoi(workspaceString);
+  } catch (const std::exception &e) {
+    // TODO: At some point we want to support all workspace selectors
+    // This is just a subset.
+    // https://wiki.hyprland.org/Configuring/Workspace-Rules/#workspace-selectors
+    if (workspaceString.starts_with("special:")) {
+      name = workspaceString.substr(8);
+    } else if (workspaceString.starts_with("name:")) {
+      name = workspaceString.substr(5);
+    } else {
+      name = workspaceString;
+    }
+  }
+
  auto workspace =
      std::find_if(m_workspaces.begin(), m_workspaces.end(), [&](std::unique_ptr<Workspace> &x) {
-        return (name.starts_with("special:") && name.substr(8) == x->name()) || name == x->name();
+        if (name.empty()) {
+          return id == x->id();
+        }
+        return name == x->name();


Possible small improvement: make the id on line 711 an std::optional, and then check in find_if if that optional has value, instead of checking if the name is empty. I feel like that makes the intent clearer that the name is used as a kind of 'fallback' if the stoi fails. (but I might be nitpicking here)

Some refactoring changed this a bit, but I think it's still aligned with making the intent clearer.

zjeffer · 2025-02-27T20:01:52Z

+    return workspaceIdStr == "special" ? -99 : std::stoi(workspaceIdStr);
+  } catch (std::exception const &e) {
+    spdlog::error("Failed to parse workspace ID: {}", e.what());
+    return INVALID_WORKSPACE_ID;


Not a big fan of this INVALID_WORKSPACE_ID. If at any point Hyprland starts allowing negative workspaces, we'll have to change this.

If you make parseWorkspaceId return an std::optional<int>, and return std::nullopt, this implementation would be independant from any potential change from Hyprland. Then you also don't need to add the extra variable. Instead of checking whether the parsed workspace ID is equal to the INVALID_WORKSPACE_ID, you can simply use if (id.has_value()) { ... }.

If at any point Hyprland starts allowing negative workspaces, we'll have to change this.

Good point. Right now workspaces only go down to -99, but optional is better. Updated.

Thanks for the suggestion.

zjeffer · 2025-02-28T11:43:29Z

Looks great! I fixed some clang-tidy hints (mostly replacing std::find_if with std::ranges::find_if), and formatted it, here's a patch:
patch.txt

@Alexays can you approve the workflow?

shivros · 2025-03-11T21:24:42Z

@Alexays When you get the chance, could you approve the workflow or let me know if there's something I need to address? Thanks!

Alexays · 2025-03-28T08:45:50Z

LGTM, thanks!

shivros force-pushed the mw/hyprland-events-workspaces-v2 branch 10 times, most recently from 3e92344 to 24d391b Compare January 27, 2025 00:22

shivros marked this pull request as ready for review January 27, 2025 00:36

zjeffer reviewed Feb 20, 2025

View reviewed changes

shivros force-pushed the mw/hyprland-events-workspaces-v2 branch from f4255c0 to 65a97fc Compare February 27, 2025 01:44

Matt White added 3 commits February 26, 2025 18:56

feat(hyprland): support createworkspacev2

26a344b

feat(hyprland): support destroyworkspacev2

0c6ca83

feat(hyprland): support workspacev2

17cee0d

shivros force-pushed the mw/hyprland-events-workspaces-v2 branch 5 times, most recently from bb6b639 to 0a04d6e Compare February 27, 2025 03:44

zjeffer reviewed Feb 27, 2025

View reviewed changes

shivros force-pushed the mw/hyprland-events-workspaces-v2 branch 4 times, most recently from ad54a8d to 41054e5 Compare February 28, 2025 02:17

shivros force-pushed the mw/hyprland-events-workspaces-v2 branch from 41054e5 to 0cc77a4 Compare February 28, 2025 16:58

shivros mentioned this pull request Mar 4, 2025

feat(ipc): add activespecialv2 hyprwm/Hyprland#9530

Merged

shivros force-pushed the mw/hyprland-events-workspaces-v2 branch from 0cc77a4 to 74f4808 Compare March 4, 2025 16:22

fix(hyprland): support additional v2 events

f7b4451

shivros force-pushed the mw/hyprland-events-workspaces-v2 branch from 74f4808 to f7b4451 Compare March 4, 2025 17:23

ykelvis mentioned this pull request Mar 6, 2025

hyprland/workspaces: fix duplicate persistent workspaces entries #3934

Closed

Alexays merged commit fda7abb into Alexays:master Mar 28, 2025
8 of 9 checks passed

shivros deleted the mw/hyprland-events-workspaces-v2 branch March 30, 2025 16:47

acarl005 mentioned this pull request Jun 10, 2025

[hyprland/workspaces] duplicate workspace buttons/labes #3912

Closed

Sytoplis mentioned this pull request Aug 19, 2025

Active Workspace Highlight in Multiple Monitors #4288

Open

Uh oh!

Conversation

shivros commented Jan 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zjeffer left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zjeffer commented Feb 28, 2025

Uh oh!

shivros commented Mar 11, 2025

Uh oh!

Uh oh!

Alexays commented Mar 28, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

shivros commented Jan 10, 2025 •

edited

Loading