feat: implement special tag overlay workspace (scratchpad)

Author: Ssnibles

.gitignore

@@ -1,6 +1,7 @@
 /.cache
 /.vscode
 /result
+/build
 /mango-wlonly
 config.h
 mango

assets/config.conf

@@ -128,6 +128,11 @@ gappoh=10
 gappov=10
 scratchpad_width_ratio=0.8
 scratchpad_height_ratio=0.9
+special_dim=0.5
+special_gappih=10
+special_gappiv=10
+special_gappoh=20
+special_gappov=20
 borderpx=4
 rootcolor=0x201b14ff
 bordercolor=0x444444ff
@@ -191,6 +196,9 @@ bind=SUPER,i,minimized,
 bind=SUPER,o,toggleoverlay,
 bind=SUPER+SHIFT,I,restore_minimized
 bind=ALT,z,toggle_scratchpad
+bind=SUPER,s,toggle_special_tag
+bind=SUPER+SHIFT,s,tag_special_tag
+bind=SUPER+CTRL,s,tag_special_silent
 
 # scroller layout
 bind=ALT,e,set_proportion,1.0

docs/bindings/keys.md

@@ -105,9 +105,12 @@ bindr=Super,Super_L,spawn,rofi -show run
 | `toggle_render_border` | - | Toggle border rendering. |
 | `centerwin` | - | Center the floating window. |
 | `minimized` | - | Minimize window to scratchpad. |
-| `restore_minimized` | `0/1` | Restore minimized window to its previous state.(`1` means keep previous tags, `0` means restore to current tags.) |
+| `restore_minimized` | - | Restore minimized window to the currently focused tag. |
 | `toggle_scratchpad` | - | Toggle scratchpad. |
 | `toggle_named_scratchpad` | `appid,title,cmd` | Toggle named scratchpad. Launches app if not running, otherwise shows/hides it. |
+| `toggle_special_tag` | - | Toggle special workspace overlay (tiling scratchpad). |
+| `tag_special_tag` | - | Move focused window to/from the special workspace overlay. |
+| `tag_special_silent` | - | Silently move focused window to/from the special workspace overlay. |
 
 ### Focus & Movement
 

docs/window-management/rules.md

@@ -50,7 +50,7 @@ windowrule=Parameter:Values,Parameter:Values,appid:Values,title:Values
 | `offsetx` | integer | -999-999 | X offset from center (%), 100 is the edge of screen with outer gap |
 | `offsety` | integer | -999-999 | Y offset from center (%), 100 is the edge of screen with outer gap |
 | `monitor` | string | Any | Assign to monitor by [monitor spec](/docs/configuration/monitors#monitor-spec-format) (name, make, model, or serial) |
-| `tags` | mask | `1-9` / `1\|3\|5` | Assign to specific one tag or multiple tags(use `\|` to split multiple tags) |
+| `tags` | mask | `0-9` / `1\|3\|5` | Assign to specific one tag (use `0` for special workspace overlay) or multiple tags (use `\|` to split multiple tags) |
 | `no_force_center` | integer | `0` / `1` | Window does not force center |
 | `isnosizehint` | integer | `0` / `1` | Don't use min size and max size for size hints |
 

docs/window-management/scratchpad.md

@@ -71,3 +71,47 @@ scratchpad_width_ratio=0.8
 scratchpad_height_ratio=0.9
 scratchpadcolor=0x516c93ff
 ```
+
+---
+
+## Special Workspace (Tag 0)
+
+The special workspace (Tag 0) provides an overlay workspace of windows that can be summoned anywhere with full layout support (Scroller, Master/Stack, Dwindle, etc.). When Tag 0 is active, windows from the underlying workspace remain visible in the background, and all windows on the special workspace are displayed above them.
+
+### Keybindings
+
+```ini
+# Toggle the special workspace overlay (Tag 0)
+bind=SUPER,s,toggle_special_tag
+
+# Move focused window to/from the special workspace
+bind=SUPER+SHIFT,s,tag_special_tag
+
+# Silently send active window to the special workspace without switching
+bind=SUPER+CTRL,s,tag_special_silent
+```
+
+### Window Rules for Special Workspace
+
+You can automatically assign applications to launch directly on the special workspace using `tags:0`:
+
+```ini
+# Automatically open Spotify and Discord in the special workspace
+windowrule=tags:0,appid:spotify
+windowrule=tags:0,appid:discord
+```
+
+### Configuration Options
+
+You can configure background dimming and custom layout gaps for the special workspace:
+
+```ini
+# Background dim level when special workspace is active (0.0 to 1.0, default 0.5)
+special_dim=0.5
+
+# Inner and outer gaps for windows on the special workspace
+special_gappih=10
+special_gappiv=10
+special_gappoh=20
+special_gappov=20
+```

nix/default.nix

@@ -28,8 +28,14 @@ stdenv.mkDerivation {
   pname = "mango";
   version = "nightly";
 
-  src = builtins.path {
-    path = ../.;
+  src = lib.cleanSourceWith {
+    src = ../.;
+    filter =
+      path: type:
+      let
+        base = baseNameOf (toString path);
+      in
+      (lib.cleanSourceFilter path type) && base != "build" && base != "result";
     name = "source";
   };
 

src/animation/client.h

@@ -60,18 +60,14 @@ struct fx_corner_radii set_client_corner_location(Client *c) {
 }
 
 bool is_horizontal_stack_layout(Monitor *m) {
-	if (m->pertag->curtag &&
-		(m->pertag->ltidxs[m->pertag->curtag]->id == TILE ||
-		 m->pertag->ltidxs[m->pertag->curtag]->id == DECK))
-		return true;
-	return false;
+	uint32_t tag = get_mon_curtag(m);
+	return m->pertag->ltidxs[tag]->id == TILE ||
+		   m->pertag->ltidxs[tag]->id == DECK;
 }
 
 bool is_horizontal_right_stack_layout(Monitor *m) {
-	if (m->pertag->curtag &&
-		m->pertag->ltidxs[m->pertag->curtag]->id == RIGHT_TILE)
-		return true;
-	return false;
+	uint32_t tag = get_mon_curtag(m);
+	return m->pertag->ltidxs[tag]->id == RIGHT_TILE;
 }
 
 int32_t is_special_animation_rule(Client *c) {
@@ -542,7 +538,8 @@ void client_draw_split_border(Client *c, bool hit_no_border,
 	if (c->iskilling || !c->mon || !client_surface(c)->mapped)
 		return;
 
-	const Layout *layout = c->mon->pertag->ltidxs[c->mon->pertag->curtag];
+	uint32_t tag = get_client_tag_idx(c);
+	const Layout *layout = c->mon->pertag->ltidxs[tag];
 
 	if (hit_no_border || !ISTILED(c) || layout->id != DWINDLE ||
 		!config.dwindle_manual_split || c->isfullscreen) {
@@ -553,7 +550,7 @@ void client_draw_split_border(Client *c, bool hit_no_border,
 		return;
 	}
 
-	DwindleNode **root = &c->mon->pertag->dwindle_root[c->mon->pertag->curtag];
+	DwindleNode **root = &c->mon->pertag->dwindle_root[tag];
 	DwindleNode *dnode = dwindle_find_leaf(*root, c);
 	if (!dnode) {
 		wlr_scene_node_set_enabled(&c->splitindicator[0]->node, false);
@@ -748,7 +745,7 @@ void client_set_drop_area(Client *c) {
 	double rel_y = cursor->y - c->geom.y - bw;
 
 	struct wlr_box drop_box;
-	const Layout *cur_layout = c->mon->pertag->ltidxs[c->mon->pertag->curtag];
+	const Layout *cur_layout = c->mon->pertag->ltidxs[get_client_tag_idx(c)];
 	bool dwindle_familiar =
 		cur_layout->id == DWINDLE && config.dwindle_drop_simple_split;
 

src/animation/tag.h

@@ -49,6 +49,8 @@ void set_arrange_visible(Monitor *m, Client *c, bool want_animation) {
 	if (c->is_logic_hide)
 		return;
 
+	bool was_enabled = c->scene->node.enabled;
+
 	if (!ISTILED(c) || (!c->is_clip_to_hide || !is_scroller_layout(c->mon))) {
 		c->is_clip_to_hide = false;
 		c->is_logic_hide = false;
@@ -58,7 +60,25 @@ void set_arrange_visible(Monitor *m, Client *c, bool want_animation) {
 			wlr_scene_node_set_enabled(&c->scene_surface->node, true);
 	}
 
-	if (!c->animation.tag_from_rule && want_animation &&
+	/* Special workspace clients slide in from above the monitor */
+	if (c->tags & TAG0_MASK) {
+		c->animation.tag_from_rule = false;
+		c->animation.tagouting = false;
+		c->animation.tagouted = false;
+		client_raise_group(c);
+		if (want_animation && config.animations) {
+			c->animation.tagining = true;
+			c->animainit_geom = c->geom;
+			c->animainit_geom.y = c->mon->m.y - c->geom.height;
+		} else {
+			c->animainit_geom.x = c->animation.current.x;
+			c->animainit_geom.y = c->animation.current.y;
+		}
+		resize_apply(c, c->geom, (ResizeOpts){.skip_ov_enter_anim = true});
+		return;
+	}
+
+	if (!was_enabled && !c->animation.tag_from_rule && want_animation &&
 		m->pertag->prevtag != 0 && m->pertag->curtag != 0 &&
 		config.animations) {
 		c->animation.tagining = true;
@@ -132,6 +152,28 @@ void set_arrange_hidden(Monitor *m, Client *c, bool want_animation) {
 		return;
 	}
 
+	/* Special workspace windows should animate out or hide when special
+	 * workspace is not active */
+	if (c->tags & TAG0_MASK) {
+		if (want_animation && config.animations && !c->animation.tagouted &&
+			c->scene->node.enabled) {
+			c->animation.tagouting = true;
+			c->animation.tagining = false;
+			c->pending = c->geom;
+			c->pending.y = c->mon->m.y - c->geom.height;
+			client_raise_group(c);
+			resize(c, c->geom, 0);
+		} else {
+			c->animation.running = false;
+			c->animation.tagouting = false;
+			c->animation.tagining = false;
+			wlr_scene_node_set_enabled(&c->scene->node, false);
+			c->animainit_geom = c->current = c->pending = c->animation.current =
+				c->geom;
+		}
+		return;
+	}
+
 	if ((c->tags & (1 << (m->pertag->prevtag - 1))) &&
 		m->pertag->prevtag != 0 && m->pertag->curtag != 0 &&
 		config.animations) {

src/config/parse_config.h

@@ -437,10 +437,15 @@ typedef struct {
 	uint32_t gappiv;
 	uint32_t gappoh;
 	uint32_t gappov;
+	uint32_t special_gappih;
+	uint32_t special_gappiv;
+	uint32_t special_gappoh;
+	uint32_t special_gappov;
 	uint32_t borderpx;
 	uint32_t group_bar_height;
 	float scratchpad_width_ratio;
 	float scratchpad_height_ratio;
+	float special_dim;
 	float rootcolor[4];
 	float bordercolor[4];
 	float dropcolor[4];
@@ -1177,8 +1182,11 @@ uint32_t parse_tag_mask(char *str) {
 		token = strtok_r(arg_copy, "|", &saveptr);
 
 		while (token != NULL) {
+			trim_whitespace(token);
 			int32_t num = atoi(token);
-			if (num > 0 && num <= tag_num_MAX) {
+			if (num == 0 && strcmp(token, "0") == 0) {
+				mask |= TAG0_MASK;
+			} else if (num > 0 && num <= tag_num_MAX) {
 				mask |= (1 << (num - 1));
 			}
 			token = strtok_r(NULL, "|", &saveptr);
@@ -1187,6 +1195,10 @@ uint32_t parse_tag_mask(char *str) {
 		free(arg_copy);
 	}
 
+	// tag0 and normal tags are exclusive; keep tag0 when mixed
+	if ((mask & TAG0_MASK) && (mask & TAGMASK))
+		mask = TAG0_MASK;
+
 	uint32_t result = 0;
 
 	if (mask) {
@@ -1390,7 +1402,6 @@ FuncType parse_func_name(char *func_name, Arg *arg, char *arg_value,
 		func = minimized;
 	} else if (strcmp(func_name, "restore_minimized") == 0) {
 		func = restore_minimized;
-		(*arg).i = atoi(arg_value);
 	} else if (strcmp(func_name, "toggle_scratchpad") == 0) {
 		func = toggle_scratchpad;
 	} else if (strcmp(func_name, "toggle_render_border") == 0) {
@@ -1504,6 +1515,12 @@ FuncType parse_func_name(char *func_name, Arg *arg, char *arg_value,
 		(*arg).v = strdup(arg_value);
 		(*arg).v2 = strdup(arg_value2);
 		(*arg).v3 = strdup(arg_value3);
+	} else if (strcmp(func_name, "toggle_special_tag") == 0) {
+		func = toggle_special_tag;
+	} else if (strcmp(func_name, "tag_special_tag") == 0) {
+		func = tag_special_tag;
+	} else if (strcmp(func_name, "tag_special_silent") == 0) {
+		func = tag_special_silent;
 	} else if (strcmp(func_name, "disable_monitor") == 0) {
 		func = disable_monitor;
 		(*arg).v = strdup(arg_value);
@@ -2265,6 +2282,16 @@ bool parse_option(Config *config, char *key, char *value, int line_number) {
 		config->scratchpad_width_ratio = atof(value);
 	} else if (strcmp(key, "scratchpad_height_ratio") == 0) {
 		config->scratchpad_height_ratio = atof(value);
+	} else if (strcmp(key, "special_dim") == 0) {
+		config->special_dim = atof(value);
+	} else if (strcmp(key, "special_gappih") == 0) {
+		config->special_gappih = atoi(value);
+	} else if (strcmp(key, "special_gappiv") == 0) {
+		config->special_gappiv = atoi(value);
+	} else if (strcmp(key, "special_gappoh") == 0) {
+		config->special_gappoh = atoi(value);
+	} else if (strcmp(key, "special_gappov") == 0) {
+		config->special_gappov = atoi(value);
 	} else if (strcmp(key, "borderpx") == 0) {
 		config->borderpx = atoi(value);
 	} else if (strcmp(key, "group_bar_height") == 0) {
@@ -4415,6 +4442,11 @@ void override_config(void) {
 		CLAMP_FLOAT(config.scratchpad_width_ratio, 0.1f, 1.0f);
 	config.scratchpad_height_ratio =
 		CLAMP_FLOAT(config.scratchpad_height_ratio, 0.1f, 1.0f);
+	config.special_dim = CLAMP_FLOAT(config.special_dim, 0.0f, 1.0f);
+	config.special_gappih = CLAMP_INT(config.special_gappih, 0, 1000);
+	config.special_gappiv = CLAMP_INT(config.special_gappiv, 0, 1000);
+	config.special_gappoh = CLAMP_INT(config.special_gappoh, 0, 1000);
+	config.special_gappov = CLAMP_INT(config.special_gappov, 0, 1000);
 	config.borderpx = CLAMP_INT(config.borderpx, 0, 200);
 	config.group_bar_height = CLAMP_INT(config.group_bar_height, 0, 500);
 	config.smartgaps = CLAMP_INT(config.smartgaps, 0, 1);
@@ -4515,6 +4547,11 @@ void set_value_default() {
 	config.gappov = 10;
 	config.scratchpad_width_ratio = 0.8f;
 	config.scratchpad_height_ratio = 0.9f;
+	config.special_dim = 0.5f;
+	config.special_gappih = 10;
+	config.special_gappiv = 10;
+	config.special_gappoh = 20;
+	config.special_gappov = 20;
 
 	config.scroller_structs = 20;
 	config.scroller_default_proportion = 0.9f;
@@ -5094,7 +5131,7 @@ void reapply_master(void) {
 
 	int32_t i;
 	Monitor *m = NULL;
-	for (i = 0; i <= config.tag_num; i++) {
+	for (i = 0; i < PERTAG_SLOTS; i++) {
 		wl_list_for_each(m, &mons, link) {
 			if (!m->wlr_output->enabled) {
 				continue;
@@ -5105,6 +5142,10 @@ void reapply_master(void) {
 			m->gappiv = config.gappiv;
 			m->gappoh = config.gappoh;
 			m->gappov = config.gappov;
+			m->special_gappih = config.special_gappih;
+			m->special_gappiv = config.special_gappiv;
+			m->special_gappoh = config.special_gappoh;
+			m->special_gappov = config.special_gappov;
 		}
 	}
 }
@@ -5180,6 +5221,8 @@ void parse_tagrule(Monitor *m) {
 	// Set defaults for every tag.
 	for (i = 0; i <= config.tag_num; i++)
 		tag_slot_set_defaults(m, i);
+	// dedicated state slot for the all-tags view
+	tag_slot_set_defaults(m, PERTAG_ALL_TAGS_IDX);
 
 	for (i = 0; i < config.tag_rules_count; i++) {
 		const ConfigTagRule *tr = &config.tag_rules[i];

src/dispatch/bind_declare.h

@@ -89,3 +89,6 @@ void dwindle_split_horizontal(const Arg *arg);
 void dwindle_split_vertical(const Arg *arg);
 void dwindle_toggle_current_split(const Arg *arg);
 void focusid(const Arg *arg);
+void toggle_special_tag(const Arg *arg);
+void tag_special_tag(const Arg *arg);
+void tag_special_silent(const Arg *arg);