Add GrabRogueWindows dispatcher (#172)

Add GrabRogueWindows dispatcher to move windows from disconnected monitors to current monitor

Author: zjeffer

README.md

@@ -9,10 +9,6 @@ A small plugin to provide `awesome`/`dwm`-like behavior with workspaces: split t
 - Hyprland >= v0.38.1
 
 # Installing
-Since Hyprland plugins don't have ABI guarantees, you *should* download the Hyprland source and compile it if you plan to use plugins.
-This ensures the compiler version is the same between the Hyprland build you're running, and the plugins you are using.
-
-The guide on compiling and installing Hyprland manually is on the [wiki](http://wiki.hyprland.org/Getting-Started/Installation/#manual-manual-build)
 
 ## Using [hyprpm](https://wiki.hyprland.org/Plugins/Using-Plugins/#hyprpm)
 Hyprpm is a tool integrated with the latest Hyprland version, to use it first you'll need to add the repository and then enable the plugin
@@ -27,7 +23,12 @@ Add the following in your `hyprland.conf` file to automatically load the plugin
 
 ## Manual installation
 
-1. Export the `HYPRLAND_HEADERS` variable to point to the root directory of the Hyprland repo
+Since Hyprland plugins don't have ABI guarantees, you *should* download the Hyprland source and compile it if you plan to install plugins manually.
+This ensures the compiler version is the same between the Hyprland build you're running, and the plugins you are using.
+
+The guide on compiling and installing Hyprland manually is on the [wiki](http://wiki.hyprland.org/Getting-Started/Installation/#manual-manual-build)
+
+1. Export the `HYPRLAND_HEADERS` variable to point to the root directory of the Hyprland repo, for example:
     - `export HYPRLAND_HEADERS="$HOME/repos/Hyprland"`
 2. Compile
     - `make all`
@@ -100,21 +101,22 @@ module will handle the rest.
 
 # Usage
 
-The plugin provides drop-in replacements for workspace-related commands
+The plugin provides drop-in replacements for workspace-related commands, to be able to easily specify the `n`th workspace on the focused monitor:
 
 | Normal                | Replacement                   |
 |-----------------------|-------------------------------|
 | workspace             | split-workspace               |
 | movetoworkspace       | split-movetoworkspace         |
 | movetoworkspacesilent | split-movetoworkspacesilent   |
 
-And two new ones, to move windows between monitors
+And these new commands:
 
-| Normal                    | Arguments         |
-|---------------------------|-------------------|
-| split-cycleworkspaces     | next/prev/+1/-1    |
-| split-changemonitor       | next/prev/+1/-1    |
-| split-changemonitorsilent | next/prev/+1/-1    |
+| Normal                    | Arguments         | Description                                                                               |
+|---------------------------|-------------------|-------------------------------------------------------------------------------------------|
+| split-cycleworkspaces     | next/prev/+1/-1   | Cycle through workspaces on the current monitor                                           |
+| split-changemonitor       | next/prev/+1/-1   | Move a workspace to the next/previous monitor                                             |
+| split-changemonitorsilent | next/prev/+1/-1   | Move a workspace to the next/previous monitor without focus change                        |
+| split-grabroguewindows    |                   | After disconnecting a monitor, call this to move all rogue windows to the current monitor |
 
 It also provides the following config values
 | Name                                                            | Type      | Default   | Description                                           |

src/main.cpp

@@ -216,6 +216,40 @@ SDispatchResult splitChangeMonitor(const std::string& value)
     return changeMonitor(false, value);
 }
 
+SDispatchResult grabRogueWindows(const std::string& /*unused*/)
+{
+    // implementation loosely based on shezdy's hyprsplit: https://github.com/shezdy/hyprsplit
+    Debug::log(INFO, "[split-monitor-workspaces] Grabbing rogue windows");
+    const auto currentMonitor = getCurrentMonitor();
+    if (currentMonitor == nullptr) {
+        Debug::log(ERR, "[split-monitor-workspaces] No active monitor found");
+        return {.success = false, .error = "No active monitor found"};
+    }
+    const auto currentWorkspace = currentMonitor->activeWorkspace;
+    if (currentWorkspace == nullptr) {
+        Debug::log(ERR, "[split-monitor-workspaces] No active workspace found");
+        return {.success = false, .error = "No active workspace found"};
+    }
+
+    for (const auto& window : g_pCompositor->m_vWindows) {
+        // ignore unmapped and special windows
+        if (!window->m_bIsMapped && !window->onSpecialWorkspace())
+            continue;
+
+        auto const workspaceName = window->m_pWorkspace->m_szName;
+        auto const monitorID = window->m_pMonitor->ID;
+
+        bool isInRogueWorkspace = !g_vMonitorWorkspaceMap.contains(monitorID) || // if the monitor is not mapped, the window is rogue
+                                  !std::ranges::any_of(g_vMonitorWorkspaceMap[monitorID], [&workspaceName](const auto& mappedWorkspaceName) { return workspaceName == mappedWorkspaceName; });
+        if (isInRogueWorkspace) {
+            Debug::log(INFO, "[split-monitor-workspaces] Moving rogue window {} from workspace {} to workspace {}", window->m_szTitle.c_str(), workspaceName.c_str(),
+                       currentWorkspace->m_szName.c_str());
+            g_pCompositor->moveWindowToWorkspaceSafe(window, currentWorkspace);
+        }
+    }
+    return {.success = true, .error = ""};
+}
+
 void mapMonitor(const PHLMONITOR& monitor) // NOLINT(readability-convert-member-functions-to-static)
 {
     if (monitor->activeMonitorRule.disabled) {
@@ -228,7 +262,7 @@ void mapMonitor(const PHLMONITOR& monitor) // NOLINT(readability-convert-member-
         return;
     }
 
-    int workspaceIndex = monitor->ID * g_workspaceCount + 1;
+    int workspaceIndex = (monitor->ID * g_workspaceCount) + 1;
 
     Debug::log(INFO, "{}",
                "[split-monitor-workspaces] Mapping workspaces " + std::to_string(workspaceIndex) + "-" + std::to_string(workspaceIndex + g_workspaceCount - 1) + " to monitor " + monitor->szName);
@@ -262,7 +296,7 @@ void mapMonitor(const PHLMONITOR& monitor) // NOLINT(readability-convert-member-
 
 void unmapMonitor(const PHLMONITOR& monitor)
 {
-    int workspaceIndex = monitor->ID * g_workspaceCount + 1;
+    int workspaceIndex = (monitor->ID * g_workspaceCount) + 1;
 
     Debug::log(INFO, "{}",
                "[split-monitor-workspaces] Unmapping workspaces " + std::to_string(workspaceIndex) + "-" + std::to_string(workspaceIndex + g_workspaceCount - 1) + " from monitor " + monitor->szName);
@@ -367,6 +401,7 @@ APICALL EXPORT PLUGIN_DESCRIPTION_INFO PLUGIN_INIT(HANDLE handle)
     HyprlandAPI::addDispatcherV2(PHANDLE, "split-movetoworkspacesilent", splitMoveToWorkspaceSilent);
     HyprlandAPI::addDispatcherV2(PHANDLE, "split-changemonitor", splitChangeMonitor);
     HyprlandAPI::addDispatcherV2(PHANDLE, "split-changemonitorsilent", splitChangeMonitorSilent);
+    HyprlandAPI::addDispatcherV2(PHANDLE, "split-grabroguewindows", grabRogueWindows);
 
     // reload the config before adding the callback, so we can already use the config's values we defined above
     HyprlandAPI::reloadConfig();