2 #define I3__FILE__ "scratchpad.c"
4 * vim:ts=4:sw=4:expandtab
6 * i3 - an improved dynamic tiling window manager
7 * © 2009-2013 Michael Stapelberg and contributors (see also: LICENSE)
9 * scratchpad.c: Moving windows to the scratchpad and making them visible again.
15 * Moves the specified window to the __i3_scratch workspace, making it floating
16 * and setting the appropriate scratchpad_state.
18 * Gets called upon the command 'move scratchpad'.
21 void scratchpad_move(Con *con) {
22 if (con->type == CT_WORKSPACE) {
23 LOG("'move scratchpad' used on a workspace \"%s\". Calling it "
24 "recursively on all windows on this workspace.\n",
27 current = TAILQ_FIRST(&(con->focus_head));
29 Con *next = TAILQ_NEXT(current, focused);
30 scratchpad_move(current);
35 DLOG("should move con %p to __i3_scratch\n", con);
37 Con *__i3_scratch = workspace_get("__i3_scratch", NULL);
38 if (con_get_workspace(con) == __i3_scratch) {
39 DLOG("This window is already on __i3_scratch.\n");
43 /* If the current con is in fullscreen mode, we need to disable that,
44 * as a scratchpad window should never be in fullscreen mode */
45 if (focused && focused->type != CT_WORKSPACE && focused->fullscreen_mode != CF_NONE) {
46 con_toggle_fullscreen(focused, CF_OUTPUT);
49 /* 1: Ensure the window or any parent is floating. From now on, we deal
50 * with the CT_FLOATING_CON. We use automatic == false because the user
51 * made the choice that this window should be a scratchpad (and floating).
53 Con *maybe_floating_con = con_inside_floating(con);
54 if (maybe_floating_con == NULL) {
55 floating_enable(con, false);
58 con = maybe_floating_con;
61 /* 2: Send the window to the __i3_scratch workspace, mainting its
62 * coordinates and not warping the pointer. */
63 con_move_to_workspace(con, __i3_scratch, true, true);
65 /* 3: If this is the first time this window is used as a scratchpad, we set
66 * the scratchpad_state to SCRATCHPAD_FRESH. The window will then be
67 * adjusted in size according to what the user specifies. */
68 if (con->scratchpad_state == SCRATCHPAD_NONE) {
69 DLOG("This window was never used as a scratchpad before.\n");
70 if (con == maybe_floating_con) {
71 DLOG("It was in floating mode before, set scratchpad state to changed.\n");
72 con->scratchpad_state = SCRATCHPAD_CHANGED;
74 DLOG("It was in tiling mode before, set scratchpad state to fresh.\n");
75 con->scratchpad_state = SCRATCHPAD_FRESH;
81 * Either shows the top-most scratchpad window (con == NULL) or shows the
82 * specified con (if it is scratchpad window).
84 * When called with con == NULL and the currently focused window is a
85 * scratchpad window, this serves as a shortcut to hide it again (so the user
86 * can press the same key to quickly look something up).
89 void scratchpad_show(Con *con) {
90 DLOG("should show scratchpad window %p\n", con);
91 Con *__i3_scratch = workspace_get("__i3_scratch", NULL);
94 /* If this was 'scratchpad show' without criteria, we check if the
95 * currently focused window is a scratchpad window and should be hidden
98 (floating = con_inside_floating(focused)) &&
99 floating->scratchpad_state != SCRATCHPAD_NONE) {
100 DLOG("Focused window is a scratchpad window, hiding it.\n");
101 scratchpad_move(focused);
105 /* If the current con or any of its parents are in fullscreen mode, we
106 * first need to disable it before showing the scratchpad con. */
108 while (fs && fs->fullscreen_mode == CF_NONE)
111 if (fs && fs->type != CT_WORKSPACE) {
112 con_toggle_fullscreen(fs, CF_OUTPUT);
115 /* If this was 'scratchpad show' without criteria, we check if there is a
116 * unfocused scratchpad on the current workspace and focus it */
118 Con *focused_ws = con_get_workspace(focused);
119 TAILQ_FOREACH(walk_con, &(focused_ws->floating_head), floating_windows) {
120 if (!con && (floating = con_inside_floating(walk_con)) &&
121 floating->scratchpad_state != SCRATCHPAD_NONE &&
122 floating != con_inside_floating(focused)) {
123 DLOG("Found an unfocused scratchpad window on this workspace\n");
124 DLOG("Focusing it: %p\n", walk_con);
125 /* use con_descend_tiling_focused to get the last focused
126 * window inside this scratch container in order to
127 * keep the focus the same within this container */
128 con_focus(con_descend_tiling_focused(walk_con));
133 /* If this was 'scratchpad show' without criteria, we check if there is a
134 * visible scratchpad window on another workspace. In this case we move it
135 * to the current workspace. */
136 focused_ws = con_get_workspace(focused);
137 TAILQ_FOREACH(walk_con, &all_cons, all_cons) {
138 Con *walk_ws = con_get_workspace(walk_con);
139 if (!con && walk_ws &&
140 !con_is_internal(walk_ws) && focused_ws != walk_ws &&
141 (floating = con_inside_floating(walk_con)) &&
142 floating->scratchpad_state != SCRATCHPAD_NONE) {
143 DLOG("Found a visible scratchpad window on another workspace,\n");
144 DLOG("moving it to this workspace: con = %p\n", walk_con);
145 con_move_to_workspace(walk_con, focused_ws, true, false);
150 /* If this was 'scratchpad show' with criteria, we check if the window
151 * is actually in the scratchpad */
152 if (con && con->parent->scratchpad_state == SCRATCHPAD_NONE) {
153 DLOG("Window is not in the scratchpad, doing nothing.\n");
157 /* If this was 'scratchpad show' with criteria, we check if it matches a
158 * currently visible scratchpad window and hide it. */
159 Con *active = con_get_workspace(focused);
160 Con *current = con_get_workspace(con);
162 (floating = con_inside_floating(con)) &&
163 floating->scratchpad_state != SCRATCHPAD_NONE &&
164 current != __i3_scratch) {
165 /* If scratchpad window is on the active workspace, then we should hide
166 * it, otherwise we should move it to the active workspace. */
167 if (current == active) {
168 DLOG("Window is a scratchpad window, hiding it.\n");
169 scratchpad_move(con);
175 /* Use the container on __i3_scratch which is highest in the focus
176 * stack. When moving windows to __i3_scratch, they get inserted at the
177 * bottom of the stack. */
178 con = TAILQ_FIRST(&(__i3_scratch->floating_head));
181 LOG("You don't have any scratchpad windows yet.\n");
182 LOG("Use 'move scratchpad' to move a window to the scratchpad.\n");
186 /* We used a criterion, so we need to do what follows (moving,
187 * resizing) on the floating parent. */
188 con = con_inside_floating(con);
191 /* 1: Move the window from __i3_scratch to the current workspace. */
192 con_move_to_workspace(con, active, true, false);
194 /* 2: Adjust the size if this window was not adjusted yet. */
195 if (con->scratchpad_state == SCRATCHPAD_FRESH) {
196 DLOG("Adjusting size of this window.\n");
197 Con *output = con_get_output(con);
198 con->rect.width = output->rect.width * 0.5;
199 con->rect.height = output->rect.height * 0.75;
200 floating_check_size(con);
201 con->rect.x = output->rect.x +
202 ((output->rect.width / 2.0) - (con->rect.width / 2.0));
203 con->rect.y = output->rect.y +
204 ((output->rect.height / 2.0) - (con->rect.height / 2.0));
207 /* Activate active workspace if window is from another workspace to ensure
209 if (current != active) {
210 workspace_show(active);
213 con_focus(con_descend_focused(con));
217 * Greatest common divisor, implemented only for the least common multiple
221 static int _gcd(const int m, const int n) {
224 return _gcd(n, (m % n));
228 * Least common multiple. We use it to determine the (ideally not too large)
229 * resolution for the __i3 pseudo-output on which the scratchpad is on (see
230 * below). We could just multiply the resolutions, but for some pathetic cases
231 * (many outputs), using the LCM will achieve better results.
233 * Man, when you were learning about these two algorithms for the first time,
234 * did you think you’d ever need them in a real-world software project of
235 * yours? I certainly didn’t until now. :-D
238 static int _lcm(const int m, const int n) {
239 const int o = _gcd(m, n);
240 return ((m * n) / o);
244 * When starting i3 initially (and after each change to the connected outputs),
245 * this function fixes the resolution of the __i3 pseudo-output. When that
246 * resolution is not set to a function which shares a common divisor with every
247 * active output’s resolution, floating point calculation errors will lead to
248 * the scratchpad window moving when shown repeatedly.
251 void scratchpad_fix_resolution(void) {
252 Con *__i3_scratch = workspace_get("__i3_scratch", NULL);
253 Con *__i3_output = con_get_output(__i3_scratch);
254 DLOG("Current resolution: (%d, %d) %d x %d\n",
255 __i3_output->rect.x, __i3_output->rect.y,
256 __i3_output->rect.width, __i3_output->rect.height);
260 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
261 if (output == __i3_output)
263 DLOG("output %s's resolution: (%d, %d) %d x %d\n",
264 output->name, output->rect.x, output->rect.y,
265 output->rect.width, output->rect.height);
266 if (new_width == -1) {
267 new_width = output->rect.width;
268 new_height = output->rect.height;
270 new_width = _lcm(new_width, output->rect.width);
271 new_height = _lcm(new_height, output->rect.height);
275 Rect old_rect = __i3_output->rect;
277 DLOG("new width = %d, new height = %d\n",
278 new_width, new_height);
279 __i3_output->rect.width = new_width;
280 __i3_output->rect.height = new_height;
282 Rect new_rect = __i3_output->rect;
284 if (memcmp(&old_rect, &new_rect, sizeof(Rect)) == 0) {
285 DLOG("Scratchpad size unchanged.\n");
289 DLOG("Fixing coordinates of scratchpad windows\n");
291 TAILQ_FOREACH(con, &(__i3_scratch->floating_head), floating_windows) {
292 floating_fix_coordinates(con, &old_rect, &new_rect);