1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
3 focus.c for the Openbox window manager
4 Copyright (c) 2006 Mikael Magnusson
5 Copyright (c) 2003-2007 Dana Jansens
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 See the COPYING file for a copy of the GNU General Public License.
27 #include "focus_cycle.h"
37 #define FOCUS_INDICATOR_WIDTH 6
39 ObClient *focus_client = NULL;
40 GList *focus_order = NULL;
42 void focus_startup(gboolean reconfig)
46 /* start with nothing focused */
50 void focus_shutdown(gboolean reconfig)
54 /* reset focus to root */
55 XSetInputFocus(obt_display, PointerRoot, RevertToNone, CurrentTime);
58 static void push_to_top(ObClient *client)
62 /* if it is modal for a single window, then put that window at the top
63 of the focus order first, so it will be right after ours. the same is
65 if (client->modal && (p = client_direct_parent(client)))
68 focus_order = g_list_remove(focus_order, client);
69 focus_order = g_list_prepend(focus_order, client);
72 void focus_set_client(ObClient *client)
76 ob_debug_type(OB_DEBUG_FOCUS,
77 "focus_set_client 0x%lx", client ? client->window : 0);
79 if (focus_client == client)
82 /* uninstall the old colormap, and install the new one */
83 screen_install_colormap(focus_client, FALSE);
84 screen_install_colormap(client, TRUE);
86 focus_client = client;
89 /* move to the top of the list */
91 /* remove hiliting from the window when it gets focused */
92 client_hilite(client, FALSE);
95 /* set the NET_ACTIVE_WINDOW hint, but preserve it on shutdown */
96 if (ob_state() != OB_STATE_EXITING) {
97 active = client ? client->window : None;
98 OBT_PROP_SET32(obt_root(ob_screen), NET_ACTIVE_WINDOW, WINDOW, active);
102 static ObClient* focus_fallback_target(gboolean allow_refocus,
103 gboolean allow_pointer,
104 gboolean allow_omnipresent,
110 ob_debug_type(OB_DEBUG_FOCUS, "trying pointer stuff");
111 if (allow_pointer && config_focus_follow)
112 if ((c = client_under_pointer()) &&
113 (allow_refocus || client_focus_target(c) != old) &&
117 ob_debug_type(OB_DEBUG_FOCUS, "found in pointer stuff");
121 ob_debug_type(OB_DEBUG_FOCUS, "trying the focus order");
122 for (it = focus_order; it; it = g_list_next(it)) {
124 /* fallback focus to a window if:
125 1. it is on the current desktop. this ignores omnipresent
126 windows, which are problematic in their own rite, unless they are
128 2. it is a valid auto-focus target
131 if ((allow_omnipresent || c->desktop == screen_desktop) &&
132 focus_valid_target(c, screen_desktop,
133 TRUE, FALSE, FALSE, FALSE, FALSE, FALSE) &&
135 (allow_refocus || client_focus_target(c) != old) &&
138 ob_debug_type(OB_DEBUG_FOCUS, "found in focus order");
143 ob_debug_type(OB_DEBUG_FOCUS, "trying a desktop window");
144 for (it = focus_order; it; it = g_list_next(it)) {
146 /* fallback focus to a window if:
147 1. it is on the current desktop. this ignores omnipresent
148 windows, which are problematic in their own rite.
149 2. it is a normal type window, don't fall back onto a dock or
150 a splashscreen or a desktop window (save the desktop as a
151 backup fallback though)
153 if (focus_valid_target(c, screen_desktop,
154 TRUE, FALSE, FALSE, FALSE, TRUE, FALSE) &&
155 (allow_refocus || client_focus_target(c) != old) &&
158 ob_debug_type(OB_DEBUG_FOCUS, "found a desktop window");
166 ObClient* focus_fallback(gboolean allow_refocus, gboolean allow_pointer,
167 gboolean allow_omnipresent, gboolean focus_lost)
170 ObClient *old = focus_client;
172 /* unfocus any focused clients.. they can be focused by Pointer events
173 and such, and then when we try focus them, we won't get a FocusIn
174 event at all for them. */
178 new = focus_fallback_target(allow_refocus, allow_pointer,
179 allow_omnipresent, old);
180 /* get what was really focused */
181 if (new) new = client_focus_target(new);
186 void focus_nothing(void)
188 /* nothing is focused, update the colormap and _the root property_ */
189 focus_set_client(NULL);
191 /* when nothing will be focused, send focus to the backup target */
192 XSetInputFocus(obt_display, screen_support_win, RevertToPointerRoot,
196 void focus_order_add_new(ObClient *c)
199 focus_order_to_top(c);
201 g_assert(!g_list_find(focus_order, c));
202 /* if there are any iconic windows, put this above them in the order,
203 but if there are not, then put it under the currently focused one */
204 if (focus_order && ((ObClient*)focus_order->data)->iconic)
205 focus_order = g_list_insert(focus_order, c, 0);
207 focus_order = g_list_insert(focus_order, c, 1);
210 /* in the middle of cycling..? kill it. */
214 void focus_order_remove(ObClient *c)
216 focus_order = g_list_remove(focus_order, c);
218 /* in the middle of cycling..? kill it. */
222 void focus_order_to_top(ObClient *c)
224 focus_order = g_list_remove(focus_order, c);
226 focus_order = g_list_prepend(focus_order, c);
230 /* insert before first iconic window */
231 for (it = focus_order;
232 it && !((ObClient*)it->data)->iconic; it = g_list_next(it));
233 focus_order = g_list_insert_before(focus_order, it, c);
237 void focus_order_to_bottom(ObClient *c)
239 focus_order = g_list_remove(focus_order, c);
241 focus_order = g_list_append(focus_order, c);
245 /* insert before first iconic window */
246 for (it = focus_order;
247 it && !((ObClient*)it->data)->iconic; it = g_list_next(it));
248 focus_order = g_list_insert_before(focus_order, it, c);
252 ObClient *focus_order_find_first(guint desktop)
255 for (it = focus_order; it; it = g_list_next(it)) {
256 ObClient *c = it->data;
257 if (c->desktop == desktop || c->desktop == DESKTOP_ALL)
263 /*! Returns if a focus target has valid group siblings that can be cycled
265 static gboolean focus_target_has_siblings(ObClient *ft,
266 gboolean iconic_windows,
267 gboolean all_desktops)
272 if (!ft->group) return FALSE;
274 for (it = ft->group->members; it; it = g_slist_next(it)) {
275 ObClient *c = it->data;
276 /* check that it's not a helper window to avoid infinite recursion */
277 if (c != ft && c->type == OB_CLIENT_TYPE_NORMAL &&
278 focus_valid_target(c, screen_desktop,
279 TRUE, iconic_windows, all_desktops,
280 FALSE, FALSE, FALSE))
288 gboolean focus_valid_target(ObClient *ft,
290 gboolean helper_windows,
291 gboolean iconic_windows,
292 gboolean all_desktops,
293 gboolean dock_windows,
294 gboolean desktop_windows,
295 gboolean user_request)
299 /* it's on this desktop unless you want all desktops.
301 do this check first because it will usually filter out the most
303 ok = (all_desktops || ft->desktop == desktop ||
304 ft->desktop == DESKTOP_ALL);
306 /* the window can receive focus somehow */
307 ok = ok && (ft->can_focus || ft->focus_notify);
309 /* the window is not iconic, or we're allowed to go to iconic ones */
310 ok = ok && (iconic_windows || !ft->iconic);
312 /* it's the right type of window */
313 if (dock_windows || desktop_windows)
314 ok = ok && ((dock_windows && ft->type == OB_CLIENT_TYPE_DOCK) ||
315 (desktop_windows && ft->type == OB_CLIENT_TYPE_DESKTOP));
316 /* modal windows are important and can always get focus if they are
317 visible and stuff, so don't change 'ok' based on their type */
319 /* normal non-helper windows are valid targets */
321 ((client_normal(ft) && !client_helper(ft))
323 /* helper windows are valid targets if... */
324 (client_helper(ft) &&
325 /* ...a window in its group already has focus and we want to
326 include helper windows ... */
327 ((focus_client && ft->group == focus_client->group &&
329 /* ... or if there are no other windows in its group
330 that can be focused instead */
331 !focus_target_has_siblings(ft, iconic_windows, all_desktops))));
333 /* it's not set to skip the taskbar (but this only applies to normal typed
334 windows, and is overridden if the window is modal or if the user asked
335 for this window to be focused, or if the window is iconified) */
336 ok = ok && (ft->type != OB_CLIENT_TYPE_NORMAL ||
342 /* it's not going to just send focus off somewhere else (modal window),
343 unless that modal window is not one of our valid targets, then let
344 you choose this window and bring the modal one here */
346 ObClient *cft = client_focus_target(ft);
347 ok = ok && (ft == cft || !focus_valid_target(cft,