windowrules: rewrite completely (#12269)

Reworks the window rule syntax completely

---------

Co-authored-by: Mihai Fufezan <[email protected]>

Author: vaxerski

.github/actions/setup_base/action.yml

@@ -45,6 +45,7 @@ runs:
           libxkbfile \
           lld \
           meson \
+          muparser \
           ninja \
           pango \
           pixman \

CMakeLists.txt

@@ -233,7 +233,8 @@ pkg_check_modules(
   libinput>=1.28
   gbm
   gio-2.0
-  re2)
+  re2
+  muparser)
 
 find_package(hyprwayland-scanner 0.3.10 REQUIRED)
 

example/hyprland.conf

@@ -159,10 +159,23 @@ animations {
 # uncomment all if you wish to use that.
 # workspace = w[tv1], gapsout:0, gapsin:0
 # workspace = f[1], gapsout:0, gapsin:0
-# windowrule = bordersize 0, floating:0, onworkspace:w[tv1]
-# windowrule = rounding 0, floating:0, onworkspace:w[tv1]
-# windowrule = bordersize 0, floating:0, onworkspace:f[1]
-# windowrule = rounding 0, floating:0, onworkspace:f[1]
+# windowrule {
+#     name = smart-gaps-1
+#     floating = false
+#     on_workspace = n[s:window] w[tv1]
+# 
+#     border_size = 0
+#     rounding = 0
+# }
+# 
+# windowrule {
+#     name = smart-gaps-2
+#     floating = false
+#     on_workspace = n[s:window] f[1]
+# 
+#     border_size = 0
+#     rounding = 0
+# }
 
 # See https://wiki.hypr.land/Configuring/Dwindle-Layout/ for more
 dwindle {
@@ -294,11 +307,25 @@ bindl = , XF86AudioPrev, exec, playerctl previous
 # See https://wiki.hypr.land/Configuring/Window-Rules/ for more
 # See https://wiki.hypr.land/Configuring/Workspace-Rules/ for workspace rules
 
-# Example windowrule
-# windowrule = float,class:^(kitty)$,title:^(kitty)$
+# Example windowrules that are useful
 
-# Ignore maximize requests from apps. You'll probably like this.
-windowrule = suppressevent maximize, class:.*
+windowrule {
+    # Ignore maximize requests from all apps. You'll probably like this.
+    name = suppress-maximize-events
+    match:class = .*
 
-# Fix some dragging issues with XWayland
-windowrule = nofocus,class:^$,title:^$,xwayland:1,floating:1,fullscreen:0,pinned:0
+    suppress_event = maximize
+}
+
+windowrule {
+    # Fix some dragging issues with XWayland
+    match:name = fix-xwayland-drags
+    match:class = ^$
+    match:title = ^$
+    match:xwayland = true
+    match:float = true
+    match:fullscreen = false
+    match:pin = false
+
+    no_focus = true
+}

hyprtester/plugin/src/main.cpp

@@ -11,6 +11,8 @@
 #include <src/managers/input/InputManager.hpp>
 #include <src/managers/PointerManager.hpp>
 #include <src/managers/input/trackpad/TrackpadGestures.hpp>
+#include <src/desktop/rule/windowRule/WindowRuleEffectContainer.hpp>
+#include <src/desktop/rule/windowRule/WindowRuleApplicator.hpp>
 #include <src/Compositor.hpp>
 #undef private
 
@@ -245,6 +247,30 @@ static SDispatchResult keybind(std::string in) {
     return {};
 }
 
+static Desktop::Rule::CWindowRuleEffectContainer::storageType ruleIDX = 0;
+
+//
+static SDispatchResult addRule(std::string in) {
+    ruleIDX = Desktop::Rule::windowEffects()->registerEffect("plugin_rule");
+
+    if (Desktop::Rule::windowEffects()->registerEffect("plugin_rule") != ruleIDX)
+        return {.success = false, .error = "re-registering returned a different id?"};
+    return {};
+}
+
+static SDispatchResult checkRule(std::string in) {
+    if (!g_pCompositor->m_lastWindow)
+        return {.success = false, .error = "No window"};
+
+    if (!g_pCompositor->m_lastWindow->m_ruleApplicator->m_otherProps.props.contains(ruleIDX))
+        return {.success = false, .error = "No rule"};
+
+    if (g_pCompositor->m_lastWindow->m_ruleApplicator->m_otherProps.props[ruleIDX]->effect != "effect")
+        return {.success = false, .error = "Effect isn't \"effect\""};
+
+    return {};
+}
+
 APICALL EXPORT PLUGIN_DESCRIPTION_INFO PLUGIN_INIT(HANDLE handle) {
     PHANDLE = handle;
 
@@ -255,6 +281,8 @@ APICALL EXPORT PLUGIN_DESCRIPTION_INFO PLUGIN_INIT(HANDLE handle) {
     HyprlandAPI::addDispatcherV2(PHANDLE, "plugin:test:gesture", ::simulateGesture);
     HyprlandAPI::addDispatcherV2(PHANDLE, "plugin:test:scroll", ::scroll);
     HyprlandAPI::addDispatcherV2(PHANDLE, "plugin:test:keybind", ::keybind);
+    HyprlandAPI::addDispatcherV2(PHANDLE, "plugin:test:add_rule", ::addRule);
+    HyprlandAPI::addDispatcherV2(PHANDLE, "plugin:test:check_rule", ::checkRule);
 
     // init mouse
     g_mouse = CTestMouse::create(false);

hyprtester/src/tests/clients/pointer-scroll.cpp

@@ -64,7 +64,7 @@ static bool startClient(SClient& client) {
     // wait for window to appear
     std::this_thread::sleep_for(std::chrono::milliseconds(5000));
 
-    if (getFromSocket(std::format("/dispatch setprop pid:{} noanim 1", client.proc->pid())) != "ok") {
+    if (getFromSocket(std::format("/dispatch setprop pid:{} no_anim 1", client.proc->pid())) != "ok") {
         NLog::log("{}Failed to disable animations for client window", Colors::RED, ret);
         return false;
     }
@@ -130,7 +130,7 @@ static bool test() {
     EXPECT(sendScroll(10), true);
     EXPECT(getLastDelta(client), 30);
 
-    EXPECT(getFromSocket("r/dispatch setprop active scrollmouse 4"), "ok");
+    EXPECT(getFromSocket("r/dispatch setprop active scroll_mouse 4"), "ok");
     EXPECT(sendScroll(10), true);
     EXPECT(getLastDelta(client), 40);
 

hyprtester/src/tests/clients/pointer-warp.cpp

@@ -64,7 +64,7 @@ static bool startClient(SClient& client) {
     // wait for window to appear
     std::this_thread::sleep_for(std::chrono::milliseconds(5000));
 
-    if (getFromSocket(std::format("/dispatch setprop pid:{} noanim 1", client.proc->pid())) != "ok") {
+    if (getFromSocket(std::format("/dispatch setprop pid:{} no_anim 1", client.proc->pid())) != "ok") {
         NLog::log("{}Failed to disable animations for client window", Colors::RED, ret);
         return false;
     }

hyprtester/src/tests/main/hyprctl.cpp

@@ -56,82 +56,82 @@ static bool testGetprop() {
         return false;
     }
 
-    // animationstyle
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty animationstyle"), "(unset)");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty animationstyle -j"), R"({"animationstyle": ""})");
-    getFromSocket("/dispatch setprop class:kitty animationstyle teststyle");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty animationstyle"), "teststyle");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty animationstyle -j"), R"({"animationstyle": "teststyle"})");
-
-    // maxsize
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty maxsize"), "inf inf");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty maxsize -j"), R"({"maxsize": [null,null]})");
-    getFromSocket("/dispatch setprop class:kitty maxsize 200 150");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty maxsize"), "200 150");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty maxsize -j"), R"({"maxsize": [200,150]})");
-
-    // minsize
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty minsize"), "20 20");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty minsize -j"), R"({"minsize": [20,20]})");
-    getFromSocket("/dispatch setprop class:kitty minsize 100 50");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty minsize"), "100 50");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty minsize -j"), R"({"minsize": [100,50]})");
-
-    // alpha
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alpha"), "1");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alpha -j"), R"({"alpha": 1})");
-    getFromSocket("/dispatch setprop class:kitty alpha 0.3");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alpha"), "0.3");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alpha -j"), R"({"alpha": 0.3})");
-
-    // alphainactive
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alphainactive"), "1");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alphainactive -j"), R"({"alphainactive": 1})");
-    getFromSocket("/dispatch setprop class:kitty alphainactive 0.5");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alphainactive"), "0.5");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alphainactive -j"), R"({"alphainactive": 0.5})");
-
-    // alphafullscreen
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alphafullscreen"), "1");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alphafullscreen -j"), R"({"alphafullscreen": 1})");
-    getFromSocket("/dispatch setprop class:kitty alphafullscreen 0.75");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alphafullscreen"), "0.75");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alphafullscreen -j"), R"({"alphafullscreen": 0.75})");
-
-    // alphaoverride
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alphaoverride"), "false");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alphaoverride -j"), R"({"alphaoverride": false})");
-    getFromSocket("/dispatch setprop class:kitty alphaoverride true");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alphaoverride"), "true");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alphaoverride -j"), R"({"alphaoverride": true})");
-
-    // alphainactiveoverride
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alphainactiveoverride"), "false");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alphainactiveoverride -j"), R"({"alphainactiveoverride": false})");
-    getFromSocket("/dispatch setprop class:kitty alphainactiveoverride true");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alphainactiveoverride"), "true");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alphainactiveoverride -j"), R"({"alphainactiveoverride": true})");
-
-    // alphafullscreenoverride
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alphafullscreenoverride"), "false");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alphafullscreenoverride -j"), R"({"alphafullscreenoverride": false})");
-    getFromSocket("/dispatch setprop class:kitty alphafullscreenoverride true");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alphafullscreenoverride"), "true");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty alphafullscreenoverride -j"), R"({"alphafullscreenoverride": true})");
-
-    // activebordercolor
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty activebordercolor"), "ee33ccff ee00ff99 45deg");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty activebordercolor -j"), R"({"activebordercolor": "ee33ccff ee00ff99 45deg"})");
-    getFromSocket("/dispatch setprop class:kitty activebordercolor rgb(abcdef)");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty activebordercolor"), "ffabcdef 0deg");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty activebordercolor -j"), R"({"activebordercolor": "ffabcdef 0deg"})");
+    // animation
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty animation"), "(unset)");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty animation -j"), R"({"animation": ""})");
+    getFromSocket("/dispatch setprop class:kitty animation teststyle");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty animation"), "teststyle");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty animation -j"), R"({"animation": "teststyle"})");
+
+    // max_size
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty max_size"), "inf inf");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty max_size -j"), R"({"max_size": [null,null]})");
+    getFromSocket("/dispatch setprop class:kitty max_size 200 150");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty max_size"), "200 150");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty max_size -j"), R"({"max_size": [200,150]})");
+
+    // min_size
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty min_size"), "20 20");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty min_size -j"), R"({"min_size": [20,20]})");
+    getFromSocket("/dispatch setprop class:kitty min_size 100 50");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty min_size"), "100 50");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty min_size -j"), R"({"min_size": [100,50]})");
+
+    // opacity
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity"), "1");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity -j"), R"({"opacity": 1})");
+    getFromSocket("/dispatch setprop class:kitty opacity 0.3");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity"), "0.3");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity -j"), R"({"opacity": 0.3})");
+
+    // opacity_inactive
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity_inactive"), "1");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity_inactive -j"), R"({"opacity_inactive": 1})");
+    getFromSocket("/dispatch setprop class:kitty opacity_inactive 0.5");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity_inactive"), "0.5");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity_inactive -j"), R"({"opacity_inactive": 0.5})");
+
+    // opacity_fullscreen
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity_fullscreen"), "1");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity_fullscreen -j"), R"({"opacity_fullscreen": 1})");
+    getFromSocket("/dispatch setprop class:kitty opacity_fullscreen 0.75");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity_fullscreen"), "0.75");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity_fullscreen -j"), R"({"opacity_fullscreen": 0.75})");
+
+    // opacity_override
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity_override"), "false");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity_override -j"), R"({"opacity_override": false})");
+    getFromSocket("/dispatch setprop class:kitty opacity_override true");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity_override"), "true");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity_override -j"), R"({"opacity_override": true})");
+
+    // opacity_inactive_override
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity_inactive_override"), "false");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity_inactive_override -j"), R"({"opacity_inactive_override": false})");
+    getFromSocket("/dispatch setprop class:kitty opacity_inactive_override true");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity_inactive_override"), "true");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity_inactive_override -j"), R"({"opacity_inactive_override": true})");
+
+    // opacity_fullscreen_override
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity_fullscreen_override"), "false");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity_fullscreen_override -j"), R"({"opacity_fullscreen_override": false})");
+    getFromSocket("/dispatch setprop class:kitty opacity_fullscreen_override true");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity_fullscreen_override"), "true");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty opacity_fullscreen_override -j"), R"({"opacity_fullscreen_override": true})");
+
+    // active_border_color
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty active_border_color"), "ee33ccff ee00ff99 45deg");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty active_border_color -j"), R"({"active_border_color": "ee33ccff ee00ff99 45deg"})");
+    getFromSocket("/dispatch setprop class:kitty active_border_color rgb(abcdef)");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty active_border_color"), "ffabcdef 0deg");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty active_border_color -j"), R"({"active_border_color": "ffabcdef 0deg"})");
 
     // bool window properties
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty allowsinput"), "false");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty allowsinput -j"), R"({"allowsinput": false})");
-    getFromSocket("/dispatch setprop class:kitty allowsinput true");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty allowsinput"), "true");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty allowsinput -j"), R"({"allowsinput": true})");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty allows_input"), "false");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty allows_input -j"), R"({"allows_input": false})");
+    getFromSocket("/dispatch setprop class:kitty allows_input true");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty allows_input"), "true");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty allows_input -j"), R"({"allows_input": true})");
 
     // int window properties
     EXPECT(getCommandStdOut("hyprctl getprop class:kitty rounding"), "10");
@@ -141,16 +141,16 @@ static bool testGetprop() {
     EXPECT(getCommandStdOut("hyprctl getprop class:kitty rounding -j"), R"({"rounding": 4})");
 
     // float window properties
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty roundingpower"), "2");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty roundingpower -j"), R"({"roundingpower": 2})");
-    getFromSocket("/dispatch setprop class:kitty roundingpower 1.25");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty roundingpower"), "1.25");
-    EXPECT(getCommandStdOut("hyprctl getprop class:kitty roundingpower -j"), R"({"roundingpower": 1.25})");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty rounding_power"), "2");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty rounding_power -j"), R"({"rounding_power": 2})");
+    getFromSocket("/dispatch setprop class:kitty rounding_power 1.25");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty rounding_power"), "1.25");
+    EXPECT(getCommandStdOut("hyprctl getprop class:kitty rounding_power -j"), R"({"rounding_power": 1.25})");
 
     // errors
     EXPECT(getCommandStdOut("hyprctl getprop"), "not enough args");
     EXPECT(getCommandStdOut("hyprctl getprop class:kitty"), "not enough args");
-    EXPECT(getCommandStdOut("hyprctl getprop class:nonexistantclass animationstyle"), "window not found");
+    EXPECT(getCommandStdOut("hyprctl getprop class:nonexistantclass animation"), "window not found");
     EXPECT(getCommandStdOut("hyprctl getprop class:kitty nonexistantprop"), "prop not found");
 
     // kill all

hyprtester/src/tests/main/tags.cpp

@@ -21,21 +21,24 @@ static bool testTags() {
 
     NLog::log("{}Testing testTag tags", Colors::YELLOW);
 
-    OK(getFromSocket("/keyword windowrule tag +testTag, class:tagged"));
-    OK(getFromSocket("/keyword windowrule noshadow, tag:negative:testTag"));
-    OK(getFromSocket("/keyword windowrule noborder, tag:testTag"));
+    OK(getFromSocket("/keyword windowrule[tag-test-1]:tag +testTag"));
+    OK(getFromSocket("/keyword windowrule[tag-test-1]:match:class tagged"));
+    OK(getFromSocket("/keyword windowrule[tag-test-2]:match:tag negative:testTag"));
+    OK(getFromSocket("/keyword windowrule[tag-test-2]:no_shadow true"));
+    OK(getFromSocket("/keyword windowrule[tag-test-3]:match:tag testTag"));
+    OK(getFromSocket("/keyword windowrule[tag-test-3]:no_dim true"));
 
     EXPECT(Tests::windowCount(), 2);
     OK(getFromSocket("/dispatch focuswindow class:tagged"));
-    NLog::log("{}Testing tagged window for noborder & noshadow", Colors::YELLOW);
+    NLog::log("{}Testing tagged window for no_dim 0 & no_shadow", Colors::YELLOW);
     EXPECT_CONTAINS(getFromSocket("/activewindow"), "testTag");
-    EXPECT_CONTAINS(getFromSocket("/getprop activewindow noborder"), "true");
-    EXPECT_CONTAINS(getFromSocket("/getprop activewindow noshadow"), "false");
-    NLog::log("{}Testing untagged window for noborder & noshadow", Colors::YELLOW);
+    EXPECT_CONTAINS(getFromSocket("/getprop activewindow no_dim"), "true");
+    EXPECT_CONTAINS(getFromSocket("/getprop activewindow no_shadow"), "false");
+    NLog::log("{}Testing untagged window for no_dim & no_shadow", Colors::YELLOW);
     OK(getFromSocket("/dispatch focuswindow class:untagged"));
     EXPECT_NOT_CONTAINS(getFromSocket("/activewindow"), "testTag");
-    EXPECT_CONTAINS(getFromSocket("/getprop activewindow noborder"), "false");
-    EXPECT_CONTAINS(getFromSocket("/getprop activewindow noshadow"), "true");
+    EXPECT_CONTAINS(getFromSocket("/getprop activewindow no_shadow"), "true");
+    EXPECT_CONTAINS(getFromSocket("/getprop activewindow no_dim"), "false");
 
     Tests::killAllWindows();
     EXPECT(Tests::windowCount(), 0);