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 /* 1: Ensure the window or any parent is floating. From now on, we deal
43 * with the CT_FLOATING_CON. We use automatic == false because the user
44 * made the choice that this window should be a scratchpad (and floating).
46 Con *maybe_floating_con = con_inside_floating(con);
47 if (maybe_floating_con == NULL) {
48 floating_enable(con, false);
51 con = maybe_floating_con;
54 /* 2: Send the window to the __i3_scratch workspace, mainting its
55 * coordinates and not warping the pointer. */
56 con_move_to_workspace(con, __i3_scratch, true, true);
58 /* 3: If this is the first time this window is used as a scratchpad, we set
59 * the scratchpad_state to SCRATCHPAD_FRESH. The window will then be
60 * adjusted in size according to what the user specifies. */
61 if (con->scratchpad_state == SCRATCHPAD_NONE) {
62 DLOG("This window was never used as a scratchpad before.\n");
63 con->scratchpad_state = SCRATCHPAD_FRESH;
68 * Either shows the top-most scratchpad window (con == NULL) or shows the
69 * specified con (if it is scratchpad window).
71 * When called with con == NULL and the currently focused window is a
72 * scratchpad window, this serves as a shortcut to hide it again (so the user
73 * can press the same key to quickly look something up).
76 void scratchpad_show(Con *con) {
77 DLOG("should show scratchpad window %p\n", con);
78 Con *__i3_scratch = workspace_get("__i3_scratch", NULL);
81 /* If the current con or any of its parents are in fullscreen mode, we
82 * first need to disable it before showing the scratchpad con. */
84 while (fs && fs->fullscreen_mode == CF_NONE)
87 if (fs->type != CT_WORKSPACE) {
88 con_toggle_fullscreen(focused, CF_OUTPUT);
91 /* If this was 'scratchpad show' without criteria, we check if the
92 * currently focused window is a scratchpad window and should be hidden
95 (floating = con_inside_floating(focused)) &&
96 floating->scratchpad_state != SCRATCHPAD_NONE) {
97 DLOG("Focused window is a scratchpad window, hiding it.\n");
98 scratchpad_move(focused);
102 /* If this was 'scratchpad show' without criteria, we check if there is a
103 * unfocused scratchpad on the current workspace and focus it */
105 Con *focused_ws = con_get_workspace(focused);
106 TAILQ_FOREACH(walk_con, &(focused_ws->floating_head), floating_windows) {
107 if (!con && (floating = con_inside_floating(walk_con)) &&
108 floating->scratchpad_state != SCRATCHPAD_NONE &&
109 floating != con_inside_floating(focused)) {
110 DLOG("Found an unfocused scratchpad window on this workspace\n");
111 DLOG("Focusing it: %p\n", walk_con);
112 /* use con_descend_tiling_focused to get the last focused
113 * window inside this scratch container in order to
114 * keep the focus the same within this container */
115 con_focus(con_descend_tiling_focused(walk_con));
120 /* If this was 'scratchpad show' without criteria, we check if there is a
121 * visible scratchpad window on another workspace. In this case we move it
122 * to the current workspace. */
123 focused_ws = con_get_workspace(focused);
124 TAILQ_FOREACH(walk_con, &all_cons, all_cons) {
125 Con *walk_ws = con_get_workspace(walk_con);
126 if (!con && walk_ws &&
127 !con_is_internal(walk_ws) && focused_ws != walk_ws &&
128 (floating = con_inside_floating(walk_con)) &&
129 floating->scratchpad_state != SCRATCHPAD_NONE) {
130 DLOG("Found a visible scratchpad window on another workspace,\n");
131 DLOG("moving it to this workspace: con = %p\n", walk_con);
132 con_move_to_workspace(walk_con, focused_ws, true, false);
137 /* If this was 'scratchpad show' with criteria, we check if the window
138 * is actually in the scratchpad */
139 if (con && con->parent->scratchpad_state == SCRATCHPAD_NONE) {
140 DLOG("Window is not in the scratchpad, doing nothing.\n");
144 /* If this was 'scratchpad show' with criteria, we check if it matches a
145 * currently visible scratchpad window and hide it. */
146 Con *active = con_get_workspace(focused);
147 Con *current = con_get_workspace(con);
149 (floating = con_inside_floating(con)) &&
150 floating->scratchpad_state != SCRATCHPAD_NONE &&
151 current != __i3_scratch) {
152 /* If scratchpad window is on the active workspace, then we should hide
153 * it, otherwise we should move it to the active workspace. */
154 if (current == active) {
155 DLOG("Window is a scratchpad window, hiding it.\n");
156 scratchpad_move(con);
162 /* Use the container on __i3_scratch which is highest in the focus
163 * stack. When moving windows to __i3_scratch, they get inserted at the
164 * bottom of the stack. */
165 con = TAILQ_FIRST(&(__i3_scratch->floating_head));
168 LOG("You don't have any scratchpad windows yet.\n");
169 LOG("Use 'move scratchpad' to move a window to the scratchpad.\n");
174 /* 1: Move the window from __i3_scratch to the current workspace. */
175 con_move_to_workspace(con, active, true, false);
177 /* 2: Adjust the size if this window was not adjusted yet. */
178 if (con->scratchpad_state == SCRATCHPAD_FRESH) {
179 DLOG("Adjusting size of this window.\n");
180 Con *output = con_get_output(con);
181 con->rect.width = output->rect.width * 0.5;
182 con->rect.height = output->rect.height * 0.75;
183 floating_check_size(con);
184 con->rect.x = output->rect.x +
185 ((output->rect.width / 2.0) - (con->rect.width / 2.0));
186 con->rect.y = output->rect.y +
187 ((output->rect.height / 2.0) - (con->rect.height / 2.0));
190 /* Activate active workspace if window is from another workspace to ensure
192 if (current != active) {
193 workspace_show(active);
196 con_focus(con_descend_focused(con));
200 * Greatest common divisor, implemented only for the least common multiple
204 static int _gcd(const int m, const int n) {
207 return _gcd(n, (m % n));
211 * Least common multiple. We use it to determine the (ideally not too large)
212 * resolution for the __i3 pseudo-output on which the scratchpad is on (see
213 * below). We could just multiply the resolutions, but for some pathetic cases
214 * (many outputs), using the LCM will achieve better results.
216 * Man, when you were learning about these two algorithms for the first time,
217 * did you think you’d ever need them in a real-world software project of
218 * yours? I certainly didn’t until now. :-D
221 static int _lcm(const int m, const int n) {
222 const int o = _gcd(m, n);
223 return ((m * n) / o);
227 * When starting i3 initially (and after each change to the connected outputs),
228 * this function fixes the resolution of the __i3 pseudo-output. When that
229 * resolution is not set to a function which shares a common divisor with every
230 * active output’s resolution, floating point calculation errors will lead to
231 * the scratchpad window moving when shown repeatedly.
234 void scratchpad_fix_resolution(void) {
235 Con *__i3_scratch = workspace_get("__i3_scratch", NULL);
236 Con *__i3_output = con_get_output(__i3_scratch);
237 DLOG("Current resolution: (%d, %d) %d x %d\n",
238 __i3_output->rect.x, __i3_output->rect.y,
239 __i3_output->rect.width, __i3_output->rect.height);
243 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
244 if (output == __i3_output)
246 DLOG("output %s's resolution: (%d, %d) %d x %d\n",
247 output->name, output->rect.x, output->rect.y,
248 output->rect.width, output->rect.height);
249 if (new_width == -1) {
250 new_width = output->rect.width;
251 new_height = output->rect.height;
253 new_width = _lcm(new_width, output->rect.width);
254 new_height = _lcm(new_height, output->rect.height);
258 Rect old_rect = __i3_output->rect;
260 DLOG("new width = %d, new height = %d\n",
261 new_width, new_height);
262 __i3_output->rect.width = new_width;
263 __i3_output->rect.height = new_height;
265 Rect new_rect = __i3_output->rect;
267 if (memcmp(&old_rect, &new_rect, sizeof(Rect)) == 0) {
268 DLOG("Scratchpad size unchanged.\n");
272 DLOG("Fixing coordinates of scratchpad windows\n");
274 TAILQ_FOREACH(con, &(__i3_scratch->floating_head), floating_windows) {
275 floating_fix_coordinates(con, &old_rect, &new_rect);