i3
scratchpad.c
Go to the documentation of this file.
1 #undef I3__FILE__
2 #define I3__FILE__ "scratchpad.c"
3 /*
4  * vim:ts=4:sw=4:expandtab
5  *
6  * i3 - an improved dynamic tiling window manager
7  * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
8  *
9  * scratchpad.c: Moving windows to the scratchpad and making them visible again.
10  *
11  */
12 #include "all.h"
13 
14 /*
15  * Moves the specified window to the __i3_scratch workspace, making it floating
16  * and setting the appropriate scratchpad_state.
17  *
18  * Gets called upon the command 'move scratchpad'.
19  *
20  */
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);
25  Con *current;
26  current = TAILQ_FIRST(&(con->focus_head));
27  while (current) {
28  Con *next = TAILQ_NEXT(current, focused);
29  scratchpad_move(current);
30  current = next;
31  }
32  return;
33  }
34  DLOG("should move con %p to __i3_scratch\n", con);
35 
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");
39  return;
40  }
41 
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).
45  */
46  Con *maybe_floating_con = con_inside_floating(con);
47  if (maybe_floating_con == NULL) {
48  floating_enable(con, false);
49  con = con->parent;
50  } else {
51  con = maybe_floating_con;
52  }
53 
54  /* 2: Send the window to the __i3_scratch workspace, mainting its
55  * coordinates and not warping the pointer. */
56  Con *focus_next = con_next_focused(con);
57  con_move_to_workspace(con, __i3_scratch, true, true);
58 
59  /* 3: If this is the first time this window is used as a scratchpad, we set
60  * the scratchpad_state to SCRATCHPAD_FRESH. The window will then be
61  * adjusted in size according to what the user specifies. */
62  if (con->scratchpad_state == SCRATCHPAD_NONE) {
63  DLOG("This window was never used as a scratchpad before.\n");
64  con->scratchpad_state = SCRATCHPAD_FRESH;
65  }
66 
67  /* 4: Fix focus. Normally, when moving a window to a different output, the
68  * destination output gets focused. In this case, we don’t want that. */
69  if (con_get_workspace(focus_next) == con_get_workspace(focused))
70  con_focus(focus_next);
71 }
72 
73 /*
74  * Either shows the top-most scratchpad window (con == NULL) or shows the
75  * specified con (if it is scratchpad window).
76  *
77  * When called with con == NULL and the currently focused window is a
78  * scratchpad window, this serves as a shortcut to hide it again (so the user
79  * can press the same key to quickly look something up).
80  *
81  */
82 void scratchpad_show(Con *con) {
83  DLOG("should show scratchpad window %p\n", con);
84  Con *__i3_scratch = workspace_get("__i3_scratch", NULL);
85  Con *floating;
86 
87  /* If the current con or any of its parents are in fullscreen mode, we
88  * first need to disable it before showing the scratchpad con. */
89  Con *fs = focused;
90  while (fs && fs->fullscreen_mode == CF_NONE)
91  fs = fs->parent;
92 
93  if (fs->type != CT_WORKSPACE) {
94  con_toggle_fullscreen(focused, CF_OUTPUT);
95  }
96 
97  /* If this was 'scratchpad show' without criteria, we check if the
98  * currently focused window is a scratchpad window and should be hidden
99  * again. */
100  if (!con &&
101  (floating = con_inside_floating(focused)) &&
102  floating->scratchpad_state != SCRATCHPAD_NONE) {
103  DLOG("Focused window is a scratchpad window, hiding it.\n");
105  return;
106  }
107 
108  /* If this was 'scratchpad show' with criteria, we check if it matches a
109  * currently visible scratchpad window and hide it. */
110  Con *active = con_get_workspace(focused);
111  Con *current = con_get_workspace(con);
112  if (con &&
113  (floating = con_inside_floating(con)) &&
114  floating->scratchpad_state != SCRATCHPAD_NONE &&
115  current != __i3_scratch) {
116  /* If scratchpad window is on the active workspace, then we should hide
117  * it, otherwise we should move it to the active workspace. */
118  if (current == active) {
119  DLOG("Window is a scratchpad window, hiding it.\n");
120  scratchpad_move(con);
121  return;
122  }
123  }
124 
125  if (con == NULL) {
126  /* Use the container on __i3_scratch which is highest in the focus
127  * stack. When moving windows to __i3_scratch, they get inserted at the
128  * bottom of the stack. */
129  con = TAILQ_FIRST(&(__i3_scratch->floating_head));
130 
131  if (!con) {
132  LOG("You don't have any scratchpad windows yet.\n");
133  LOG("Use 'move scratchpad' to move a window to the scratchpad.\n");
134  return;
135  }
136  }
137 
138  /* 1: Move the window from __i3_scratch to the current workspace. */
139  con_move_to_workspace(con, active, true, false);
140 
141  /* 2: Adjust the size if this window was not adjusted yet. */
142  if (con->scratchpad_state == SCRATCHPAD_FRESH) {
143  DLOG("Adjusting size of this window.\n");
144  Con *output = con_get_output(con);
145  con->rect.width = output->rect.width * 0.5;
146  con->rect.height = output->rect.height * 0.75;
147  con->rect.x = output->rect.x +
148  ((output->rect.width / 2.0) - (con->rect.width / 2.0));
149  con->rect.y = output->rect.y +
150  ((output->rect.height / 2.0) - (con->rect.height / 2.0));
151  con->scratchpad_state = SCRATCHPAD_CHANGED;
152  }
153 
154  /* Activate active workspace if window is from another workspace to ensure
155  * proper focus. */
156  if (current != active) {
157  workspace_show(active);
158  }
159 
161 }
162 
163 /*
164  * Greatest common divisor, implemented only for the least common multiple
165  * below.
166  *
167  */
168 static int _gcd(const int m, const int n) {
169  if (n == 0)
170  return m;
171  return _gcd(n, (m % n));
172 }
173 
174 /*
175  * Least common multiple. We use it to determine the (ideally not too large)
176  * resolution for the __i3 pseudo-output on which the scratchpad is on (see
177  * below). We could just multiply the resolutions, but for some pathetic cases
178  * (many outputs), using the LCM will achieve better results.
179  *
180  * Man, when you were learning about these two algorithms for the first time,
181  * did you think you’d ever need them in a real-world software project of
182  * yours? I certainly didn’t until now. :-D
183  *
184  */
185 static int _lcm(const int m, const int n) {
186  const int o = _gcd(m, n);
187  return ((m * n) / o);
188 }
189 
190 /*
191  * When starting i3 initially (and after each change to the connected outputs),
192  * this function fixes the resolution of the __i3 pseudo-output. When that
193  * resolution is not set to a function which shares a common divisor with every
194  * active output’s resolution, floating point calculation errors will lead to
195  * the scratchpad window moving when shown repeatedly.
196  *
197  */
199  Con *__i3_scratch = workspace_get("__i3_scratch", NULL);
200  Con *__i3_output = con_get_output(__i3_scratch);
201  DLOG("Current resolution: (%d, %d) %d x %d\n",
202  __i3_output->rect.x, __i3_output->rect.y,
203  __i3_output->rect.width, __i3_output->rect.height);
204  Con *output;
205  int new_width = -1,
206  new_height = -1;
207  TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
208  if (output == __i3_output)
209  continue;
210  DLOG("output %s's resolution: (%d, %d) %d x %d\n",
211  output->name, output->rect.x, output->rect.y,
212  output->rect.width, output->rect.height);
213  if (new_width == -1) {
214  new_width = output->rect.width;
215  new_height = output->rect.height;
216  } else {
217  new_width = _lcm(new_width, output->rect.width);
218  new_height = _lcm(new_height, output->rect.height);
219  }
220  }
221  DLOG("new width = %d, new height = %d\n",
222  new_width, new_height);
223  __i3_output->rect.width = new_width;
224  __i3_output->rect.height = new_height;
225 }