i3
window.c
Go to the documentation of this file.
1 #undef I3__FILE__
2 #define I3__FILE__ "window.c"
3 /*
4  * vim:ts=4:sw=4:expandtab
5  *
6  * i3 - an improved dynamic tiling window manager
7  * © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE)
8  *
9  * window.c: Updates window attributes (X11 hints/properties).
10  *
11  */
12 #include "all.h"
13 
14 /*
15  * Updates the WM_CLASS (consisting of the class and instance) for the
16  * given window.
17  *
18  */
19 void window_update_class(i3Window *win, xcb_get_property_reply_t *prop, bool before_mgmt) {
20  if (prop == NULL || xcb_get_property_value_length(prop) == 0) {
21  DLOG("WM_CLASS not set.\n");
22  FREE(prop);
23  return;
24  }
25 
26  /* We cannot use asprintf here since this property contains two
27  * null-terminated strings (for compatibility reasons). Instead, we
28  * use strdup() on both strings */
29  char *new_class = xcb_get_property_value(prop);
30 
31  FREE(win->class_instance);
32  FREE(win->class_class);
33 
34  win->class_instance = sstrdup(new_class);
35  if ((strlen(new_class) + 1) < (size_t)xcb_get_property_value_length(prop))
36  win->class_class = sstrdup(new_class + strlen(new_class) + 1);
37  else
38  win->class_class = NULL;
39  LOG("WM_CLASS changed to %s (instance), %s (class)\n",
40  win->class_instance, win->class_class);
41 
42  if (before_mgmt) {
43  free(prop);
44  return;
45  }
46 
47  run_assignments(win);
48 
49  free(prop);
50 }
51 
52 /*
53  * Updates the name by using _NET_WM_NAME (encoded in UTF-8) for the given
54  * window. Further updates using window_update_name_legacy will be ignored.
55  *
56  */
57 void window_update_name(i3Window *win, xcb_get_property_reply_t *prop, bool before_mgmt) {
58  if (prop == NULL || xcb_get_property_value_length(prop) == 0) {
59  DLOG("_NET_WM_NAME not specified, not changing\n");
60  FREE(prop);
61  return;
62  }
63 
64  i3string_free(win->name);
65  win->name = i3string_from_utf8_with_length(xcb_get_property_value(prop),
66  xcb_get_property_value_length(prop));
67  win->name_x_changed = true;
68  LOG("_NET_WM_NAME changed to \"%s\"\n", i3string_as_utf8(win->name));
69 
70  win->uses_net_wm_name = true;
71 
72  if (before_mgmt) {
73  free(prop);
74  return;
75  }
76 
77  run_assignments(win);
78 
79  free(prop);
80 }
81 
82 /*
83  * Updates the name by using WM_NAME (encoded in COMPOUND_TEXT). We do not
84  * touch what the client sends us but pass it to xcb_image_text_8. To get
85  * proper unicode rendering, the application has to use _NET_WM_NAME (see
86  * window_update_name()).
87  *
88  */
89 void window_update_name_legacy(i3Window *win, xcb_get_property_reply_t *prop, bool before_mgmt) {
90  if (prop == NULL || xcb_get_property_value_length(prop) == 0) {
91  DLOG("WM_NAME not set (_NET_WM_NAME is what you want anyways).\n");
92  FREE(prop);
93  return;
94  }
95 
96  /* ignore update when the window is known to already have a UTF-8 name */
97  if (win->uses_net_wm_name) {
98  free(prop);
99  return;
100  }
101 
102  i3string_free(win->name);
103  win->name = i3string_from_utf8_with_length(xcb_get_property_value(prop),
104  xcb_get_property_value_length(prop));
105 
106  LOG("WM_NAME changed to \"%s\"\n", i3string_as_utf8(win->name));
107  LOG("Using legacy window title. Note that in order to get Unicode window "
108  "titles in i3, the application has to set _NET_WM_NAME (UTF-8)\n");
109 
110  win->name_x_changed = true;
111 
112  if (before_mgmt) {
113  free(prop);
114  return;
115  }
116 
117  run_assignments(win);
118 
119  free(prop);
120 }
121 
122 /*
123  * Updates the CLIENT_LEADER (logical parent window).
124  *
125  */
126 void window_update_leader(i3Window *win, xcb_get_property_reply_t *prop) {
127  if (prop == NULL || xcb_get_property_value_length(prop) == 0) {
128  DLOG("CLIENT_LEADER not set.\n");
129  FREE(prop);
130  return;
131  }
132 
133  xcb_window_t *leader = xcb_get_property_value(prop);
134  if (leader == NULL) {
135  free(prop);
136  return;
137  }
138 
139  DLOG("Client leader changed to %08x\n", *leader);
140 
141  win->leader = *leader;
142 
143  free(prop);
144 }
145 
146 /*
147  * Updates the TRANSIENT_FOR (logical parent window).
148  *
149  */
150 void window_update_transient_for(i3Window *win, xcb_get_property_reply_t *prop) {
151  if (prop == NULL || xcb_get_property_value_length(prop) == 0) {
152  DLOG("TRANSIENT_FOR not set.\n");
153  FREE(prop);
154  return;
155  }
156 
157  xcb_window_t transient_for;
158  if (!xcb_icccm_get_wm_transient_for_from_reply(&transient_for, prop)) {
159  free(prop);
160  return;
161  }
162 
163  DLOG("Transient for changed to %08x\n", transient_for);
164 
165  win->transient_for = transient_for;
166 
167  free(prop);
168 }
169 
170 /*
171  * Updates the _NET_WM_STRUT_PARTIAL (reserved pixels at the screen edges)
172  *
173  */
174 void window_update_strut_partial(i3Window *win, xcb_get_property_reply_t *prop) {
175  if (prop == NULL || xcb_get_property_value_length(prop) == 0) {
176  DLOG("_NET_WM_STRUT_PARTIAL not set.\n");
177  FREE(prop);
178  return;
179  }
180 
181  uint32_t *strut;
182  if (!(strut = xcb_get_property_value(prop))) {
183  free(prop);
184  return;
185  }
186 
187  DLOG("Reserved pixels changed to: left = %d, right = %d, top = %d, bottom = %d\n",
188  strut[0], strut[1], strut[2], strut[3]);
189 
190  win->reserved = (struct reservedpx) {strut[0], strut[1], strut[2], strut[3]};
191 
192  free(prop);
193 }
194 
195 /*
196  * Updates the WM_WINDOW_ROLE
197  *
198  */
199 void window_update_role(i3Window *win, xcb_get_property_reply_t *prop, bool before_mgmt) {
200  if (prop == NULL || xcb_get_property_value_length(prop) == 0) {
201  DLOG("WM_WINDOW_ROLE not set.\n");
202  FREE(prop);
203  return;
204  }
205 
206  char *new_role;
207  if (asprintf(&new_role, "%.*s", xcb_get_property_value_length(prop),
208  (char *)xcb_get_property_value(prop)) == -1) {
209  perror("asprintf()");
210  DLOG("Could not get WM_WINDOW_ROLE\n");
211  free(prop);
212  return;
213  }
214  FREE(win->role);
215  win->role = new_role;
216  LOG("WM_WINDOW_ROLE changed to \"%s\"\n", win->role);
217 
218  if (before_mgmt) {
219  free(prop);
220  return;
221  }
222 
223  run_assignments(win);
224 
225  free(prop);
226 }
227 
228 /*
229  * Updates the WM_HINTS (we only care about the input focus handling part).
230  *
231  */
232 void window_update_hints(i3Window *win, xcb_get_property_reply_t *prop, bool *urgency_hint) {
233  if (urgency_hint != NULL)
234  *urgency_hint = false;
235 
236  if (prop == NULL || xcb_get_property_value_length(prop) == 0) {
237  DLOG("WM_HINTS not set.\n");
238  FREE(prop);
239  return;
240  }
241 
242  xcb_icccm_wm_hints_t hints;
243 
244  if (!xcb_icccm_get_wm_hints_from_reply(&hints, prop)) {
245  DLOG("Could not get WM_HINTS\n");
246  free(prop);
247  return;
248  }
249 
250  win->doesnt_accept_focus = !hints.input;
251  LOG("WM_HINTS.input changed to \"%d\"\n", hints.input);
252 
253  if (urgency_hint != NULL)
254  *urgency_hint = (xcb_icccm_wm_hints_get_urgency(&hints) != 0);
255 
256  free(prop);
257 }
258 
259 /*
260  * Updates the MOTIF_WM_HINTS. The container's border style should be set to
261  * `motif_border_style' if border style is not BS_NORMAL.
262  *
263  * i3 only uses this hint when it specifies a window should have no
264  * title bar, or no decorations at all, which is how most window managers
265  * handle it.
266  *
267  * The EWMH spec intended to replace Motif hints with _NET_WM_WINDOW_TYPE, but
268  * it is still in use by popular widget toolkits such as GTK+ and Java AWT.
269  *
270  */
271 void window_update_motif_hints(i3Window *win, xcb_get_property_reply_t *prop, border_style_t *motif_border_style) {
272 /* This implementation simply mirrors Gnome's Metacity. Official
273  * documentation of this hint is nowhere to be found.
274  * For more information see:
275  * https://people.gnome.org/~tthurman/docs/metacity/xprops_8h-source.html
276  * http://stackoverflow.com/questions/13787553/detect-if-a-x11-window-has-decorations
277  */
278 #define MWM_HINTS_DECORATIONS (1 << 1)
279 #define MWM_DECOR_ALL (1 << 0)
280 #define MWM_DECOR_BORDER (1 << 1)
281 #define MWM_DECOR_TITLE (1 << 3)
282 
283  if (motif_border_style != NULL)
284  *motif_border_style = BS_NORMAL;
285 
286  if (prop == NULL || xcb_get_property_value_length(prop) == 0) {
287  FREE(prop);
288  return;
289  }
290 
291  /* The property consists of an array of 5 uint64_t's. The first value is a bit
292  * mask of what properties the hint will specify. We are only interested in
293  * MWM_HINTS_DECORATIONS because it indicates that the second value of the
294  * array tells us which decorations the window should have, each flag being
295  * a particular decoration. */
296  uint64_t *motif_hints = (uint64_t *)xcb_get_property_value(prop);
297 
298  if (motif_border_style != NULL && motif_hints[0] & MWM_HINTS_DECORATIONS) {
299  if (motif_hints[1] & MWM_DECOR_ALL || motif_hints[1] & MWM_DECOR_TITLE)
300  *motif_border_style = BS_NORMAL;
301  else if (motif_hints[1] & MWM_DECOR_BORDER)
302  *motif_border_style = BS_PIXEL;
303  else
304  *motif_border_style = BS_NONE;
305  }
306 
307  FREE(prop);
308 
309 #undef MWM_HINTS_DECORATIONS
310 #undef MWM_DECOR_ALL
311 #undef MWM_DECOR_BORDER
312 #undef MWM_DECOR_TITLE
313 }
const char * i3string_as_utf8(i3String *str)
Returns the UTF-8 encoded version of the i3String.
char * sstrdup(const char *str)
Safe-wrapper around strdup which exits if malloc returns NULL (meaning that there is no more memory a...
Definition: data.h:56
#define MWM_DECOR_BORDER
border_style_t
Definition: data.h:56
bool uses_net_wm_name
Whether the application used _NET_WM_NAME.
Definition: data.h:360
#define LOG(fmt,...)
Definition: libi3.h:76
Definition: data.h:56
void window_update_transient_for(i3Window *win, xcb_get_property_reply_t *prop)
Updates the TRANSIENT_FOR (logical parent window).
Definition: window.c:150
#define xcb_icccm_wm_hints_get_urgency
Definition: xcb_compat.h:36
struct reservedpx reserved
Pixels the window reserves.
Definition: data.h:376
void window_update_leader(i3Window *win, xcb_get_property_reply_t *prop)
Updates the CLIENT_LEADER (logical parent window).
Definition: window.c:126
char * class_instance
Definition: data.h:346
bool name_x_changed
Flag to force re-rendering the decoration upon changes.
Definition: data.h:357
A &#39;Window&#39; is a type which contains an xcb_window_t and all the related information (hints like _NET_...
Definition: data.h:332
#define DLOG(fmt,...)
Definition: libi3.h:86
xcb_window_t transient_for
Definition: data.h:338
void window_update_strut_partial(i3Window *win, xcb_get_property_reply_t *prop)
Updates the _NET_WM_STRUT_PARTIAL (reserved pixels at the screen edges)
Definition: window.c:174
void window_update_name_legacy(i3Window *win, xcb_get_property_reply_t *prop, bool before_mgmt)
Updates the name by using WM_NAME (encoded in COMPOUND_TEXT).
Definition: window.c:89
i3String * i3string_from_utf8_with_length(const char *from_utf8, size_t num_bytes)
Build an i3String from an UTF-8 encoded string with fixed length.
#define xcb_icccm_get_wm_transient_for_from_reply
Definition: xcb_compat.h:37
void run_assignments(i3Window *window)
Checks the list of assignments for the given window and runs all matching ones (unless they have alre...
Definition: assignments.c:19
Stores the reserved pixels on each screen edge read from a _NET_WM_STRUT_PARTIAL. ...
Definition: data.h:134
#define xcb_icccm_wm_hints_t
Definition: xcb_compat.h:31
void window_update_motif_hints(i3Window *win, xcb_get_property_reply_t *prop, border_style_t *motif_border_style)
Updates the MOTIF_WM_HINTS.
Definition: window.c:271
void i3string_free(i3String *str)
Free an i3String.
#define MWM_DECOR_TITLE
char * role
The WM_WINDOW_ROLE of this window (for example, the pidgin buddy window sets &quot;buddy list&quot;)...
Definition: data.h:354
void window_update_class(i3Window *win, xcb_get_property_reply_t *prop, bool before_mgmt)
Updates the WM_CLASS (consisting of the class and instance) for the given window. ...
Definition: window.c:19
void window_update_hints(i3Window *win, xcb_get_property_reply_t *prop, bool *urgency_hint)
Updates the WM_HINTS (we only care about the input focus handling part).
Definition: window.c:232
void window_update_name(i3Window *win, xcb_get_property_reply_t *prop, bool before_mgmt)
Updates the name by using _NET_WM_NAME (encoded in UTF-8) for the given window.
Definition: window.c:57
#define MWM_HINTS_DECORATIONS
#define xcb_icccm_get_wm_hints_from_reply
Definition: xcb_compat.h:33
i3String * name
The name of the window.
Definition: data.h:349
char * class_class
Definition: data.h:345
bool doesnt_accept_focus
Whether this window accepts focus.
Definition: data.h:367
void window_update_role(i3Window *win, xcb_get_property_reply_t *prop, bool before_mgmt)
Updates the WM_WINDOW_ROLE.
Definition: window.c:199
xcb_window_t leader
Holds the xcb_window_t (just an ID) for the leader window (logical parent for toolwindows and similar...
Definition: data.h:337
#define MWM_DECOR_ALL
#define FREE(pointer)
Definition: util.h:46
Definition: data.h:56