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", con->name);
26 current = TAILQ_FIRST(&(con->focus_head));
28 Con *next = TAILQ_NEXT(current, focused);
29 scratchpad_move(current);
34 DLOG("should move con %p to __i3_scratch\n", con);
36 Con *__i3_scratch = workspace_get("__i3_scratch", NULL);
37 if (con_get_workspace(con) == __i3_scratch) {
38 DLOG("This window is already on __i3_scratch.\n");
42 /* If the current con is in fullscreen mode, we need to disable that,
43 * as a scratchpad window should never be in fullscreen mode */
44 if (focused && focused->type != CT_WORKSPACE && focused->fullscreen_mode != CF_NONE) {
45 con_toggle_fullscreen(focused, CF_OUTPUT);
48 /* 1: Ensure the window or any parent is floating. From now on, we deal
49 * with the CT_FLOATING_CON. We use automatic == false because the user
50 * made the choice that this window should be a scratchpad (and floating).
52 Con *maybe_floating_con = con_inside_floating(con);
53 if (maybe_floating_con == NULL) {
54 floating_enable(con, false);
57 con = maybe_floating_con;
60 /* 2: Send the window to the __i3_scratch workspace, mainting its
61 * coordinates and not warping the pointer. */
62 con_move_to_workspace(con, __i3_scratch, true, true);
64 /* 3: If this is the first time this window is used as a scratchpad, we set
65 * the scratchpad_state to SCRATCHPAD_FRESH. The window will then be
66 * adjusted in size according to what the user specifies. */
67 if (con->scratchpad_state == SCRATCHPAD_NONE) {
68 DLOG("This window was never used as a scratchpad before.\n");
69 if (con == maybe_floating_con) {
70 DLOG("It was in floating mode before, set scratchpad state to changed.\n");
71 con->scratchpad_state = SCRATCHPAD_CHANGED;
73 DLOG("It was in tiling mode before, set scratchpad state to fresh.\n");
74 con->scratchpad_state = SCRATCHPAD_FRESH;
80 * Either shows the top-most scratchpad window (con == NULL) or shows the
81 * specified con (if it is scratchpad window).
83 * When called with con == NULL and the currently focused window is a
84 * scratchpad window, this serves as a shortcut to hide it again (so the user
85 * can press the same key to quickly look something up).
88 void scratchpad_show(Con *con) {
89 DLOG("should show scratchpad window %p\n", con);
90 Con *__i3_scratch = workspace_get("__i3_scratch", NULL);
93 /* If this was 'scratchpad show' without criteria, we check if the
94 * currently focused window is a scratchpad window and should be hidden
97 (floating = con_inside_floating(focused)) &&
98 floating->scratchpad_state != SCRATCHPAD_NONE) {
99 DLOG("Focused window is a scratchpad window, hiding it.\n");
100 scratchpad_move(focused);
104 /* If the current con or any of its parents are in fullscreen mode, we
105 * first need to disable it before showing the scratchpad con. */
107 while (fs && fs->fullscreen_mode == CF_NONE)
110 if (fs && fs->type != CT_WORKSPACE) {
111 con_toggle_fullscreen(fs, CF_OUTPUT);
114 /* If this was 'scratchpad show' without criteria, we check if there is a
115 * unfocused scratchpad on the current workspace and focus it */
117 Con *focused_ws = con_get_workspace(focused);
118 TAILQ_FOREACH(walk_con, &(focused_ws->floating_head), floating_windows) {
119 if (!con && (floating = con_inside_floating(walk_con)) &&
120 floating->scratchpad_state != SCRATCHPAD_NONE &&
121 floating != con_inside_floating(focused)) {
122 DLOG("Found an unfocused scratchpad window on this workspace\n");
123 DLOG("Focusing it: %p\n", walk_con);
124 /* use con_descend_tiling_focused to get the last focused
125 * window inside this scratch container in order to
126 * keep the focus the same within this container */
127 con_focus(con_descend_tiling_focused(walk_con));
132 /* If this was 'scratchpad show' without criteria, we check if there is a
133 * visible scratchpad window on another workspace. In this case we move it
134 * to the current workspace. */
135 focused_ws = con_get_workspace(focused);
136 TAILQ_FOREACH(walk_con, &all_cons, all_cons) {
137 Con *walk_ws = con_get_workspace(walk_con);
138 if (!con && walk_ws &&
139 !con_is_internal(walk_ws) && focused_ws != walk_ws &&
140 (floating = con_inside_floating(walk_con)) &&
141 floating->scratchpad_state != SCRATCHPAD_NONE) {
142 DLOG("Found a visible scratchpad window on another workspace,\n");
143 DLOG("moving it to this workspace: con = %p\n", walk_con);
144 con_move_to_workspace(walk_con, focused_ws, true, false);
149 /* If this was 'scratchpad show' with criteria, we check if the window
150 * is actually in the scratchpad */
151 if (con && con->parent->scratchpad_state == SCRATCHPAD_NONE) {
152 DLOG("Window is not in the scratchpad, doing nothing.\n");
156 /* If this was 'scratchpad show' with criteria, we check if it matches a
157 * currently visible scratchpad window and hide it. */
158 Con *active = con_get_workspace(focused);
159 Con *current = con_get_workspace(con);
161 (floating = con_inside_floating(con)) &&
162 floating->scratchpad_state != SCRATCHPAD_NONE &&
163 current != __i3_scratch) {
164 /* If scratchpad window is on the active workspace, then we should hide
165 * it, otherwise we should move it to the active workspace. */
166 if (current == active) {
167 DLOG("Window is a scratchpad window, hiding it.\n");
168 scratchpad_move(con);
174 /* Use the container on __i3_scratch which is highest in the focus
175 * stack. When moving windows to __i3_scratch, they get inserted at the
176 * bottom of the stack. */
177 con = TAILQ_FIRST(&(__i3_scratch->floating_head));
180 LOG("You don't have any scratchpad windows yet.\n");
181 LOG("Use 'move scratchpad' to move a window to the scratchpad.\n");
185 /* We used a criterion, so we need to do what follows (moving,
186 * resizing) on the floating parent. */
187 con = con_inside_floating(con);
190 /* 1: Move the window from __i3_scratch to the current workspace. */
191 con_move_to_workspace(con, active, true, false);
193 /* 2: Adjust the size if this window was not adjusted yet. */
194 if (con->scratchpad_state == SCRATCHPAD_FRESH) {
195 DLOG("Adjusting size of this window.\n");
196 Con *output = con_get_output(con);
197 con->rect.width = output->rect.width * 0.5;
198 con->rect.height = output->rect.height * 0.75;
199 floating_check_size(con);
200 con->rect.x = output->rect.x +
201 ((output->rect.width / 2.0) - (con->rect.width / 2.0));
202 con->rect.y = output->rect.y +
203 ((output->rect.height / 2.0) - (con->rect.height / 2.0));
206 /* Activate active workspace if window is from another workspace to ensure
208 if (current != active) {
209 workspace_show(active);
212 con_focus(con_descend_focused(con));
216 * Greatest common divisor, implemented only for the least common multiple
220 static int _gcd(const int m, const int n) {
223 return _gcd(n, (m % n));
227 * Least common multiple. We use it to determine the (ideally not too large)
228 * resolution for the __i3 pseudo-output on which the scratchpad is on (see
229 * below). We could just multiply the resolutions, but for some pathetic cases
230 * (many outputs), using the LCM will achieve better results.
232 * Man, when you were learning about these two algorithms for the first time,
233 * did you think you’d ever need them in a real-world software project of
234 * yours? I certainly didn’t until now. :-D
237 static int _lcm(const int m, const int n) {
238 const int o = _gcd(m, n);
239 return ((m * n) / o);
243 * When starting i3 initially (and after each change to the connected outputs),
244 * this function fixes the resolution of the __i3 pseudo-output. When that
245 * resolution is not set to a function which shares a common divisor with every
246 * active output’s resolution, floating point calculation errors will lead to
247 * the scratchpad window moving when shown repeatedly.
250 void scratchpad_fix_resolution(void) {
251 Con *__i3_scratch = workspace_get("__i3_scratch", NULL);
252 Con *__i3_output = con_get_output(__i3_scratch);
253 DLOG("Current resolution: (%d, %d) %d x %d\n",
254 __i3_output->rect.x, __i3_output->rect.y,
255 __i3_output->rect.width, __i3_output->rect.height);
259 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
260 if (output == __i3_output)
262 DLOG("output %s's resolution: (%d, %d) %d x %d\n",
263 output->name, output->rect.x, output->rect.y,
264 output->rect.width, output->rect.height);
265 if (new_width == -1) {
266 new_width = output->rect.width;
267 new_height = output->rect.height;
269 new_width = _lcm(new_width, output->rect.width);
270 new_height = _lcm(new_height, output->rect.height);
274 Rect old_rect = __i3_output->rect;
276 DLOG("new width = %d, new height = %d\n",
277 new_width, new_height);
278 __i3_output->rect.width = new_width;
279 __i3_output->rect.height = new_height;
281 Rect new_rect = __i3_output->rect;
283 if (memcmp(&old_rect, &new_rect, sizeof(Rect)) == 0) {
284 DLOG("Scratchpad size unchanged.\n");
288 DLOG("Fixing coordinates of scratchpad windows\n");
290 TAILQ_FOREACH(con, &(__i3_scratch->floating_head), floating_windows) {
291 floating_fix_coordinates(con, &old_rect, &new_rect);