From ddd2931a5689f905eed600f366ec248fc5045250 Mon Sep 17 00:00:00 2001
From: koekeishiya <aasvi93@hotmail.com>
Date: Wed, 3 Apr 2024 22:35:39 +0200
Subject: [PATCH] #2203 implement window scratchpad

---
 CHANGELOG.md         |   2 +
 doc/yabai.1          |  42 +++++++++++++-
 doc/yabai.asciidoc   |  31 +++++++++--
 src/event_loop.c     |  14 ++++-
 src/message.c        | 130 ++++++++++++++++++++++++++++++++++---------
 src/rule.c           |   7 +++
 src/rule.h           |   1 +
 src/window_manager.c | 102 +++++++++++++++++++++++++++++++++
 src/window_manager.h |  11 ++++
 9 files changed, 302 insertions(+), 38 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 49510f5a..33c4e295 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,8 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 ## [Unreleased]
 ### Added
 - Added window commands `--raise ['<WINDOW_SEL>']` and `--lower ['<WINDOW_SEL>']` [#2198](https://github.com/koekeishiya/yabai/issues/2198)
+- Added window commands `--scratchpad ['<LABEL>']` and `--toggle <LABEL>` [#2203](https://github.com/koekeishiya/yabai/issues/2203)
+- Added rule property `scratchpad='<LABEL>'` to automatically assign a window to a scratchpad [#2203](https://github.com/koekeishiya/yabai/issues/2203)
 
 ### Changed
 - Config *global setting* `auto_balance` is now categorized as a *space setting* instead [#2200](https://github.com/koekeishiya/yabai/issues/2200)
diff --git a/doc/yabai.1 b/doc/yabai.1
index 06aa2f26..a70dcd99 100644
--- a/doc/yabai.1
+++ b/doc/yabai.1
@@ -618,11 +618,11 @@ If type is \fIrel\fP the split ratio of the selected window is changed by \fIdr\
 A positive/negative delta will increase/decrease the size of the left\-child.
 .RE
 .sp
-\fB\-\-toggle\fP \fIfloat|sticky|pip|shadow|split|zoom\-parent|zoom\-fullscreen|native\-fullscreen|expose\fP
+\fB\-\-toggle\fP \fIfloat|sticky|pip|shadow|split|zoom\-parent|zoom\-fullscreen|native\-fullscreen|expose|<LABEL>\fP
 .RS 4
 Toggle the given property of the selected window.
 .br
-The following properties require System Integrity Protection to be partially disabled: sticky, pip, shadow.
+The following properties require System Integrity Protection to be partially disabled: sticky, pip, shadow, LABEL (scratchpad identifier) .
 .RE
 .sp
 \fB\-\-sub\-layer\fP \fI<LAYER>\fP
@@ -660,6 +660,23 @@ Orders the selected window below the given window, or to the back within its lay
 .br
 System Integrity Protection must be partially disabled.
 .RE
+.sp
+\fB\-\-scratchpad\fP [\fI<LABEL>\fP]
+.RS 4
+Unique identifier used to identify a window scratchpad.
+.br
+An identifier may only be assigned to a single window at any given time.
+.br
+A scratchpad window will automatically be treated as a (manage=off) floating window.
+.br
+If the scratchpad is already taken by another window, this assignment will fail.
+.br
+If the scratchpad is re\-assigned, the previous identifier will become available.
+.br
+If no value is given, the window will seize to be a scratchpad window.
+.br
+System Integrity Protection must be partially disabled.
+.RE
 .SS "Query"
 .SS "General Syntax"
 .sp
@@ -835,7 +852,7 @@ If multiple rules specify a value for the same property, the latter rule will en
 .br
 If the display and space properties are both set, the space property will take precedence.
 .br
-The following properties require System Integrity Protection to be partially disabled: sticky, sub\-layer, opacity.
+The following properties require System Integrity Protection to be partially disabled: sticky, sub\-layer, opacity, scratchpad.
 .SS "General Syntax"
 .sp
 yabai \-m rule \fI<COMMAND>\fP
@@ -919,6 +936,8 @@ Most windows will be managed automatically, so this should mainly be used to mak
 \fBsticky=\fI<BOOL_SEL>\fP\fP
 .RS 4
 Window appears on all spaces.
+.br
+System Integrity Protection must be partially disabled.
 .RE
 .sp
 \fBmouse_follows_focus=\fI<BOOL_SEL>\fP\fP
@@ -933,6 +952,8 @@ Window is ordered within the given stacking sub\-layer.
 The window will no longer be eligible for automatic change in sub\-layer when managed/unmanaged.
 .br
 Specify the value \fIauto\fP to reset back to normal and make it become automatically managed.
+.br
+System Integrity Protection must be partially disabled.
 .RE
 .sp
 \fBopacity=\fI<FLOAT_SEL>\fP\fP
@@ -942,6 +963,8 @@ Set window opacity.
 The window will no longer be eligible for automatic change in opacity upon focus change.
 .br
 Specify the value \fI0.0\fP to reset back to full opacity and make it become automatically managed.
+.br
+System Integrity Protection must be partially disabled.
 .RE
 .sp
 \fBnative\-fullscreen=\fI<BOOL_SEL>\fP\fP
@@ -953,6 +976,19 @@ Window should enter native macOS fullscreen mode.
 .RS 4
 Set window frame based on a self\-defined grid.
 .RE
+.sp
+\fBscratchpad=\fI<LABEL>\fP\fP
+.RS 4
+Unique identifier used to identify a window scratchpad.
+.br
+An identifier may only be assigned to a single window at any given time.
+.br
+A scratchpad window will automatically be treated as a (manage=off) floating window.
+.br
+If this rule matches multiple windows, only the first window that matched will be assigned this scratchpad identifier.
+.br
+System Integrity Protection must be partially disabled.
+.RE
 .SS "DATAFORMAT"
 .sp
 .if n .RS 4
diff --git a/doc/yabai.asciidoc b/doc/yabai.asciidoc
index 1d81f381..94826524 100644
--- a/doc/yabai.asciidoc
+++ b/doc/yabai.asciidoc
@@ -416,9 +416,9 @@ COMMAND
     If type is 'rel' the split ratio of the selected window is changed by 'dr', otherwise 'dr' will become the new split ratio. +
     A positive/negative delta will increase/decrease the size of the left-child.
 
-*--toggle* 'float|sticky|pip|shadow|split|zoom-parent|zoom-fullscreen|native-fullscreen|expose'::
+*--toggle* 'float|sticky|pip|shadow|split|zoom-parent|zoom-fullscreen|native-fullscreen|expose|<LABEL>'::
     Toggle the given property of the selected window. +
-    The following properties require System Integrity Protection to be partially disabled: sticky, pip, shadow.
+    The following properties require System Integrity Protection to be partially disabled: sticky, pip, shadow, LABEL (scratchpad identifier) .
 
 *--sub-layer* '<LAYER>'::
     Set the stacking sub-layer of the selected window. +
@@ -440,6 +440,15 @@ COMMAND
     Orders the selected window below the given window, or to the back within its layer. +
     System Integrity Protection must be partially disabled.
 
+*--scratchpad* ['<LABEL>']::
+    Unique identifier used to identify a window scratchpad. +
+    An identifier may only be assigned to a single window at any given time. +
+    A scratchpad window will automatically be treated as a (manage=off) floating window. +
+    If the scratchpad is already taken by another window, this assignment will fail. +
+    If the scratchpad is re-assigned, the previous identifier will become available. +
+    If no value is given, the window will seize to be a scratchpad window. +
+    System Integrity Protection must be partially disabled.
+
 Query
 ~~~~~~
 
@@ -588,7 +597,7 @@ Rule
 All rules that match the given filter will be applied in the order they were registered. +
 If multiple rules specify a value for the same property, the latter rule will end up overriding that value. +
 If the display and space properties are both set, the space property will take precedence. +
-The following properties require System Integrity Protection to be partially disabled: sticky, sub-layer, opacity.
+The following properties require System Integrity Protection to be partially disabled: sticky, sub-layer, opacity, scratchpad.
 
 General Syntax
 ^^^^^^^^^^^^^^
@@ -644,7 +653,8 @@ ARGUMENT
     Most windows will be managed automatically, so this should mainly be used to make a window float.
 
 *sticky='<BOOL_SEL>'*::
-    Window appears on all spaces.
+    Window appears on all spaces. +
+    System Integrity Protection must be partially disabled.
 
 *mouse_follows_focus='<BOOL_SEL>'*::
     When focusing the window, put the mouse at its center. Overrides the global *mouse_follows_focus* setting.
@@ -652,12 +662,14 @@ ARGUMENT
 *sub-layer='<LAYER>'*::
     Window is ordered within the given stacking sub-layer. +
     The window will no longer be eligible for automatic change in sub-layer when managed/unmanaged. +
-    Specify the value 'auto' to reset back to normal and make it become automatically managed.
+    Specify the value 'auto' to reset back to normal and make it become automatically managed. +
+    System Integrity Protection must be partially disabled.
 
 *opacity='<FLOAT_SEL>'*::
     Set window opacity. +
     The window will no longer be eligible for automatic change in opacity upon focus change. +
-    Specify the value '0.0' to reset back to full opacity and make it become automatically managed.
+    Specify the value '0.0' to reset back to full opacity and make it become automatically managed. +
+    System Integrity Protection must be partially disabled.
 
 *native-fullscreen='<BOOL_SEL>'*::
     Window should enter native macOS fullscreen mode.
@@ -665,6 +677,13 @@ ARGUMENT
 *grid='<rows>:<cols>:<start-x>:<start-y>:<width>:<height>'*::
     Set window frame based on a self-defined grid.
 
+*scratchpad='<LABEL>'*::
+    Unique identifier used to identify a window scratchpad. +
+    An identifier may only be assigned to a single window at any given time. +
+    A scratchpad window will automatically be treated as a (manage=off) floating window. +
+    If this rule matches multiple windows, only the first window that matched will be assigned this scratchpad identifier. +
+    System Integrity Protection must be partially disabled.
+
 DATAFORMAT
 ^^^^^^^^^^
 
diff --git a/src/event_loop.c b/src/event_loop.c
index cf028469..514745bb 100644
--- a/src/event_loop.c
+++ b/src/event_loop.c
@@ -223,7 +223,7 @@ static EVENT_HANDLER(APPLICATION_TERMINATED)
 
     for (int i = 0; i < window_count; ++i) {
         struct window *window = window_list[i];
-        __atomic_store_n(&window->id_ptr, NULL, __ATOMIC_RELEASE);
+        if (!__sync_bool_compare_and_swap(&window->id_ptr, &window->id, NULL)) continue;
 
         struct view *view = window_manager_find_managed_window(&g_window_manager, window);
         if (view) {
@@ -251,6 +251,7 @@ static EVENT_HANDLER(APPLICATION_TERMINATED)
             event_signal_push(SIGNAL_WINDOW_DESTROYED, window);
         }
 
+        window_manager_remove_scratchpad_for_window(&g_window_manager, window, false);
         window_manager_remove_window(&g_window_manager, window->id);
         window_unobserve(window);
         window_destroy(window);
@@ -528,6 +529,7 @@ static EVENT_HANDLER(WINDOW_DESTROYED)
         event_signal_push(SIGNAL_WINDOW_DESTROYED, window);
     }
 
+    window_manager_remove_scratchpad_for_window(&g_window_manager, window, false);
     window_manager_remove_window(&g_window_manager, window->id);
     window_destroy(window);
 }
@@ -1342,8 +1344,9 @@ static int is_menu_open = 0;
 static EVENT_HANDLER(MENU_OPENED)
 {
     debug("%s\n", __FUNCTION__);
+    ++is_menu_open;
 
-    if (++is_menu_open == 1) {
+    if (is_menu_open == 1) {
         ffm_value = g_window_manager.ffm_mode;
         g_window_manager.ffm_mode = FFM_DISABLED;
     }
@@ -1352,8 +1355,13 @@ static EVENT_HANDLER(MENU_OPENED)
 static EVENT_HANDLER(MENU_CLOSED)
 {
     debug("%s\n", __FUNCTION__);
+    --is_menu_open;
 
-    if (--is_menu_open == 0) {
+    if (is_menu_open < 0) {
+        is_menu_open = 0;
+    }
+
+    if (is_menu_open == 0) {
         g_window_manager.ffm_mode = ffm_value;
     }
 }
diff --git a/src/message.c b/src/message.c
index 3136cce4..4165dbe3 100644
--- a/src/message.c
+++ b/src/message.c
@@ -144,6 +144,7 @@ extern bool g_verbose;
 #define COMMAND_WINDOW_RAISE      "--raise"
 #define COMMAND_WINDOW_LOWER      "--lower"
 #define COMMAND_WINDOW_TOGGLE     "--toggle"
+#define COMMAND_WINDOW_SCRATCHPAD "--scratchpad"
 
 #define ARGUMENT_WINDOW_SEL_LARGEST   "largest"
 #define ARGUMENT_WINDOW_SEL_SMALLEST  "smallest"
@@ -188,21 +189,22 @@ extern bool g_verbose;
 #define COMMAND_RULE_APPLY   "--apply"
 #define COMMAND_RULE_LS      "--list"
 
-#define ARGUMENT_RULE_ONE_SHOT      "--one-shot"
-#define ARGUMENT_RULE_KEY_APP       "app"
-#define ARGUMENT_RULE_KEY_TITLE     "title"
-#define ARGUMENT_RULE_KEY_ROLE      "role"
-#define ARGUMENT_RULE_KEY_SUBROLE   "subrole"
-#define ARGUMENT_RULE_KEY_DISPLAY   "display"
-#define ARGUMENT_RULE_KEY_SPACE     "space"
-#define ARGUMENT_RULE_KEY_OPACITY   "opacity"
-#define ARGUMENT_RULE_KEY_MANAGE    "manage"
-#define ARGUMENT_RULE_KEY_STICKY    "sticky"
-#define ARGUMENT_RULE_KEY_MFF       "mouse_follows_focus"
-#define ARGUMENT_RULE_KEY_SUB_LAYER "sub-layer"
-#define ARGUMENT_RULE_KEY_FULLSCR   "native-fullscreen"
-#define ARGUMENT_RULE_KEY_GRID      "grid"
-#define ARGUMENT_RULE_KEY_LABEL     "label"
+#define ARGUMENT_RULE_ONE_SHOT       "--one-shot"
+#define ARGUMENT_RULE_KEY_APP        "app"
+#define ARGUMENT_RULE_KEY_TITLE      "title"
+#define ARGUMENT_RULE_KEY_ROLE       "role"
+#define ARGUMENT_RULE_KEY_SUBROLE    "subrole"
+#define ARGUMENT_RULE_KEY_DISPLAY    "display"
+#define ARGUMENT_RULE_KEY_SPACE      "space"
+#define ARGUMENT_RULE_KEY_OPACITY    "opacity"
+#define ARGUMENT_RULE_KEY_MANAGE     "manage"
+#define ARGUMENT_RULE_KEY_STICKY     "sticky"
+#define ARGUMENT_RULE_KEY_MFF        "mouse_follows_focus"
+#define ARGUMENT_RULE_KEY_SUB_LAYER  "sub-layer"
+#define ARGUMENT_RULE_KEY_FULLSCR    "native-fullscreen"
+#define ARGUMENT_RULE_KEY_GRID       "grid"
+#define ARGUMENT_RULE_KEY_LABEL      "label"
+#define ARGUMENT_RULE_KEY_SCRATCHPAD "scratchpad"
 
 #define ARGUMENT_RULE_VALUE_SPACE '^'
 #define ARGUMENT_RULE_VALUE_GRID  "%d:%d:%d:%d:%d:%d"
@@ -503,6 +505,7 @@ enum label_type
 {
     LABEL_DISPLAY,
     LABEL_SPACE,
+    LABEL_WINDOW
 };
 
 static char *reserved_display_identifiers[] =
@@ -529,6 +532,19 @@ static char *reserved_space_identifiers[] =
     ARGUMENT_COMMON_SEL_MOUSE
 };
 
+static char *reserved_window_identifiers[] =
+{
+    ARGUMENT_WINDOW_TOGGLE_FLOAT,
+    ARGUMENT_WINDOW_TOGGLE_STICKY,
+    ARGUMENT_WINDOW_TOGGLE_SHADOW,
+    ARGUMENT_WINDOW_TOGGLE_SPLIT,
+    ARGUMENT_WINDOW_TOGGLE_PARENT,
+    ARGUMENT_WINDOW_TOGGLE_FULLSC,
+    ARGUMENT_WINDOW_TOGGLE_NATIVE,
+    ARGUMENT_WINDOW_TOGGLE_EXPOSE,
+    ARGUMENT_WINDOW_TOGGLE_PIP
+};
+
 static bool parse_label(FILE *rsp, char **message, enum label_type type, char **label)
 {
     struct token token = get_token(message);
@@ -562,6 +578,14 @@ static bool parse_label(FILE *rsp, char **message, enum label_type type, char **
             }
         }
     } break;
+    case LABEL_WINDOW: {
+        for (int i = 0; i < array_count(reserved_window_identifiers); ++i) {
+            if (token_equals(token, reserved_window_identifiers[i])) {
+                daemon_fail(rsp, "'%.*s' is a reserved keyword and cannot be used as a scratchpad.\n", token.length, token.text);
+                return false;
+            }
+        }
+    } break;
     }
 
     *label = malloc(token.length + 1);
@@ -1984,7 +2008,8 @@ static void handle_domain_window(FILE *rsp, struct token domain, char *message)
         !token_equals(command, COMMAND_WINDOW_FOCUS) &&
         !token_equals(command, COMMAND_WINDOW_CLOSE) &&
         !token_equals(command, COMMAND_WINDOW_MINIMIZE) &&
-        !token_equals(command, COMMAND_WINDOW_DEMINIMIZE)) {
+        !token_equals(command, COMMAND_WINDOW_DEMINIMIZE) &&
+        !token_equals(command, COMMAND_WINDOW_TOGGLE)) {
         daemon_fail(rsp, "could not locate the window to act on!\n");
         return;
     }
@@ -2190,24 +2215,60 @@ static void handle_domain_window(FILE *rsp, struct token domain, char *message)
         } else if (token_equals(command, COMMAND_WINDOW_TOGGLE)) {
             struct token value = get_token(&message);
             if (token_equals(value, ARGUMENT_WINDOW_TOGGLE_FLOAT)) {
-                window_manager_make_window_floating(&g_space_manager, &g_window_manager, acting_window, !window_check_flag(acting_window, WINDOW_FLOAT), false);
+                if (acting_window) {
+                    window_manager_make_window_floating(&g_space_manager, &g_window_manager, acting_window, !window_check_flag(acting_window, WINDOW_FLOAT), false);
+                } else {
+                    daemon_fail(rsp, "could not locate the window to act on!\n");
+                }
             } else if (token_equals(value, ARGUMENT_WINDOW_TOGGLE_STICKY)) {
-                window_manager_make_window_sticky(&g_space_manager, &g_window_manager, acting_window, !window_check_flag(acting_window, WINDOW_STICKY));
+                if (acting_window) {
+                    window_manager_make_window_sticky(&g_space_manager, &g_window_manager, acting_window, !window_check_flag(acting_window, WINDOW_STICKY));
+                } else {
+                    daemon_fail(rsp, "could not locate the window to act on!\n");
+                }
             } else if (token_equals(value, ARGUMENT_WINDOW_TOGGLE_SHADOW)) {
-                window_manager_toggle_window_shadow(&g_space_manager, &g_window_manager, acting_window);
+                if (acting_window) {
+                    window_manager_toggle_window_shadow(&g_space_manager, &g_window_manager, acting_window);
+                } else {
+                    daemon_fail(rsp, "could not locate the window to act on!\n");
+                }
             } else if (token_equals(value, ARGUMENT_WINDOW_TOGGLE_SPLIT)) {
-                space_manager_toggle_window_split(&g_space_manager, acting_window);
+                if (acting_window) {
+                    space_manager_toggle_window_split(&g_space_manager, acting_window);
+                } else {
+                    daemon_fail(rsp, "could not locate the window to act on!\n");
+                }
             } else if (token_equals(value, ARGUMENT_WINDOW_TOGGLE_PARENT)) {
-                window_manager_toggle_window_parent(&g_space_manager, &g_window_manager, acting_window);
+                if (acting_window) {
+                    window_manager_toggle_window_parent(&g_space_manager, &g_window_manager, acting_window);
+                } else {
+                    daemon_fail(rsp, "could not locate the window to act on!\n");
+                }
             } else if (token_equals(value, ARGUMENT_WINDOW_TOGGLE_FULLSC)) {
-                window_manager_toggle_window_fullscreen(&g_space_manager, &g_window_manager, acting_window);
+                if (acting_window) {
+                    window_manager_toggle_window_fullscreen(&g_space_manager, &g_window_manager, acting_window);
+                } else {
+                    daemon_fail(rsp, "could not locate the window to act on!\n");
+                }
             } else if (token_equals(value, ARGUMENT_WINDOW_TOGGLE_NATIVE)) {
-                window_manager_toggle_window_native_fullscreen(&g_space_manager, &g_window_manager, acting_window);
+                if (acting_window) {
+                    window_manager_toggle_window_native_fullscreen(&g_space_manager, &g_window_manager, acting_window);
+                } else {
+                    daemon_fail(rsp, "could not locate the window to act on!\n");
+                }
             } else if (token_equals(value, ARGUMENT_WINDOW_TOGGLE_EXPOSE)) {
-                window_manager_toggle_window_expose(&g_window_manager, acting_window);
+                if (acting_window) {
+                    window_manager_toggle_window_expose(&g_window_manager, acting_window);
+                } else {
+                    daemon_fail(rsp, "could not locate the window to act on!\n");
+                }
             } else if (token_equals(value, ARGUMENT_WINDOW_TOGGLE_PIP)) {
-                window_manager_toggle_window_pip(&g_space_manager, &g_window_manager, acting_window);
-            } else {
+                if (acting_window) {
+                    window_manager_toggle_window_pip(&g_space_manager, &g_window_manager, acting_window);
+                } else {
+                    daemon_fail(rsp, "could not locate the window to act on!\n");
+                }
+            } else if (!window_manager_toggle_scratchpad_window_by_label(&g_window_manager, value.text)) {
                 daemon_fail(rsp, "unknown value '%.*s' given to command '%.*s' for domain '%.*s'\n", value.length, value.text, command.length, command.text, domain.length, domain.text);
             }
         } else if (token_equals(command, COMMAND_WINDOW_SUB_LAYER)) {
@@ -2272,6 +2333,19 @@ static void handle_domain_window(FILE *rsp, struct token domain, char *message)
             if (!scripting_addition_order_window(acting_window->id, -1, selector_wid)) {
                 daemon_fail(rsp, "could not lower window with id '%d' due to an error with the scripting-addition.\n", acting_window->id);
             }
+        } else if (token_equals(command, COMMAND_WINDOW_SCRATCHPAD)) {
+            char *label;
+            if (parse_label(rsp, &message, LABEL_WINDOW, &label)) {
+                if (label) {
+                    if (!window_manager_set_scratchpad_for_window(&g_window_manager, acting_window, label)) {
+                        daemon_fail(rsp, "the given scratchpad is already assigned to a different window!\n");
+                    }
+                } else {
+                    if (!window_manager_remove_scratchpad_for_window(&g_window_manager, acting_window, true)) {
+                        daemon_fail(rsp, "the selected window was not assigned to a scratchpad!\n");
+                    }
+                }
+            }
         } else {
             daemon_fail(rsp, "unknown command '%.*s' for domain '%.*s'\n", command.length, command.text, domain.length, domain.text);
         }
@@ -2480,6 +2554,10 @@ static bool parse_rule(FILE *rsp, char **message, struct rule *rule, struct toke
         if (string_equals(key, ARGUMENT_RULE_KEY_LABEL)) {
             if (exclusion) unsupported_exclusion = key;
             rule->label = string_copy(value);
+        } else if (string_equals(key, ARGUMENT_RULE_KEY_SCRATCHPAD)) {
+            if (exclusion) unsupported_exclusion = key;
+            rule->effects.scratchpad = string_copy(value);
+            rule->effects.manage = RULE_PROP_OFF;
         } else if (string_equals(key, ARGUMENT_RULE_KEY_APP)) {
             has_filter = true;
             rule->app = string_copy(value);
diff --git a/src/rule.c b/src/rule.c
index c3fed47e..b6c7c12b 100644
--- a/src/rule.c
+++ b/src/rule.c
@@ -88,6 +88,11 @@ void rule_combine_effects(struct rule_effects *effects, struct rule_effects *res
         rule_effects_set_flag(result, RULE_LAYER);
     }
 
+    if (effects->scratchpad) {
+        if (result->scratchpad) free(result->scratchpad);
+        result->scratchpad = string_copy(effects->scratchpad);
+    }
+
     if (effects->manage     != RULE_PROP_UD) result->manage     = effects->manage;
     if (effects->sticky     != RULE_PROP_UD) result->sticky     = effects->sticky;
     if (effects->mff        != RULE_PROP_UD) result->mff        = effects->mff;
@@ -229,4 +234,6 @@ void rule_destroy(struct rule *rule)
     if (rule->title)   free(rule->title);
     if (rule->role)    free(rule->role);
     if (rule->subrole) free(rule->subrole);
+
+    if (rule->effects.scratchpad) free(rule->effects.scratchpad);
 }
diff --git a/src/rule.h b/src/rule.h
index a153450c..787298ff 100644
--- a/src/rule.h
+++ b/src/rule.h
@@ -37,6 +37,7 @@ struct rule_effects
     int layer;
     int fullscreen;
     unsigned grid[6];
+    char *scratchpad;
     uint16_t flags;
 };
 
diff --git a/src/window_manager.c b/src/window_manager.c
index 8fe17ec3..e6475bca 100644
--- a/src/window_manager.c
+++ b/src/window_manager.c
@@ -156,6 +156,15 @@ void window_manager_apply_rule_effects_to_window(struct space_manager *sm, struc
         window_set_rule_flag(window, WINDOW_RULE_FULLSCREEN);
     }
 
+    if (effects->scratchpad) {
+        char *scratchpad = string_copy(effects->scratchpad);
+        if (window_manager_set_scratchpad_for_window(wm, window, scratchpad)) {
+            window_manager_toggle_scratchpad_window(wm, window, 1);
+        } else {
+            free(scratchpad);
+        }
+    }
+
     if (effects->grid[0] != 0 && effects->grid[1] != 0) {
         window_manager_apply_grid(sm, wm, window, effects->grid[0], effects->grid[1], effects->grid[2], effects->grid[3], effects->grid[4], effects->grid[5]);
     }
@@ -2322,6 +2331,99 @@ void window_manager_toggle_window_pip(struct space_manager *sm, struct window_ma
     scripting_addition_scale_window(window->id, bounds.origin.x, bounds.origin.y, bounds.size.width, bounds.size.height);
 }
 
+static inline struct window *window_manager_find_scratchpad_window(struct window_manager *wm, char *label)
+{
+    for (int i = 0; i < buf_len(wm->scratchpad_window); ++i) {
+        if (string_equals(wm->scratchpad_window[i].label, label)) {
+            return wm->scratchpad_window[i].window;
+        }
+    }
+
+    return NULL;
+}
+
+bool window_manager_toggle_scratchpad_window_by_label(struct window_manager *wm, char *label)
+{
+    struct window *window = window_manager_find_scratchpad_window(wm, label);
+    return window ? window_manager_toggle_scratchpad_window(wm, window, 0) : false;
+}
+
+bool window_manager_toggle_scratchpad_window(struct window_manager *wm, struct window *window, int forced_mode)
+{
+    TIME_FUNCTION;
+
+    uint64_t sid = space_manager_active_space();
+    if (!sid) return false;
+
+    uint8_t visible = 0;
+    uint64_t wid_sid = window_space(window->id);
+    SLSWindowIsOrderedIn(g_connection, window->id, &visible);
+
+    switch (forced_mode) {
+    case 0: goto mode_0;
+    case 1: goto mode_1;
+    case 2: goto mode_2;
+    case 3: goto mode_3;
+    }
+
+mode_0:;
+    if (sid == wid_sid && visible) {
+mode_1:;
+        struct window *next = window_manager_find_window_on_space_by_rank_filtering_window(wm, sid, 1, window->id);
+        if (next) {
+            window_manager_focus_window_with_raise(&next->application->psn, next->id, next->ref);
+        } else {
+            _SLPSSetFrontProcessWithOptions(&g_process_manager.finder_psn, 0, kCPSNoWindows);
+        }
+        scripting_addition_order_window(window->id, 0, 0);
+    } else if (sid == wid_sid && !visible) {
+mode_2:;
+        scripting_addition_order_window(window->id, 1, 0);
+        window_manager_focus_window_with_raise(&window->application->psn, window->id, window->ref);
+    } else {
+mode_3:;
+        space_manager_move_window_to_space(sid, window);
+        scripting_addition_order_window(window->id, 1, 0);
+        window_manager_focus_window_with_raise(&window->application->psn, window->id, window->ref);
+    }
+
+    return true;
+}
+
+bool window_manager_set_scratchpad_for_window(struct window_manager *wm, struct window *window, char *label)
+{
+    struct window *existing_window = window_manager_find_scratchpad_window(wm, label);
+    if (existing_window) return false;
+
+    window_manager_remove_scratchpad_for_window(wm, window, false);
+    buf_push(wm->scratchpad_window, ((struct scratchpad) {
+        .label = label,
+        .window = window
+    }));
+    window_manager_make_window_floating(&g_space_manager, wm, window, true, false);
+
+    return true;
+}
+
+bool window_manager_remove_scratchpad_for_window(struct window_manager *wm, struct window *window, bool unfloat)
+{
+    for (int i = 0; i < buf_len(wm->scratchpad_window); ++i) {
+        if (wm->scratchpad_window[i].window == window) {
+            free(wm->scratchpad_window[i].label);
+            buf_del(wm->scratchpad_window, i);
+
+            if (unfloat) {
+                window_manager_toggle_scratchpad_window(wm, window, 3);
+                window_manager_make_window_floating(&g_space_manager, wm, window, false, false);
+            }
+
+            return true;
+        }
+    }
+
+    return false;
+}
+
 static void window_manager_validate_windows_on_space(struct space_manager *sm, struct window_manager *wm, struct view *view, uint32_t *window_list, int window_count)
 {
     int view_window_count;
diff --git a/src/window_manager.h b/src/window_manager.h
index 9b457767..c3d60296 100644
--- a/src/window_manager.h
+++ b/src/window_manager.h
@@ -65,6 +65,12 @@ static const char *window_origin_mode_str[] =
     "cursor"
 };
 
+struct scratchpad
+{
+    char *label;
+    struct window *window;
+};
+
 struct window_manager
 {
     AXUIElementRef system_element;
@@ -93,6 +99,7 @@ struct window_manager
     float window_animation_duration;
     int window_animation_easing;
     struct rgba_color insert_feedback_color;
+    struct scratchpad *scratchpad_window;
 };
 
 void window_manager_query_window_rules(FILE *rsp);
@@ -192,6 +199,10 @@ void window_manager_toggle_window_fullscreen(struct space_manager *sm, struct wi
 void window_manager_toggle_window_native_fullscreen(struct space_manager *sm, struct window_manager *wm, struct window *window);
 void window_manager_toggle_window_expose(struct window_manager *wm, struct window *window);
 void window_manager_toggle_window_pip(struct space_manager *sm, struct window_manager *wm, struct window *window);
+bool window_manager_toggle_scratchpad_window_by_label(struct window_manager *wm, char *label);
+bool window_manager_toggle_scratchpad_window(struct window_manager *wm, struct window *window, int forced_mode);
+bool window_manager_set_scratchpad_for_window(struct window_manager *wm, struct window *window, char *label);
+bool window_manager_remove_scratchpad_for_window(struct window_manager *wm, struct window *window, bool unfloat);
 void window_manager_wait_for_native_fullscreen_transition(struct window *window);
 void window_manager_validate_and_check_for_windows_on_space(struct space_manager *sm, struct window_manager *wm, uint64_t sid);
 void window_manager_correct_for_mission_control_changes(struct space_manager *sm, struct window_manager *wm);