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"
38 #define FOCUS_INDICATOR_WIDTH 6
40 ObClient
*focus_client
= NULL
;
41 GList
*focus_order
= NULL
;
43 void focus_startup(gboolean reconfig
)
47 /* start with nothing focused */
51 void focus_shutdown(gboolean reconfig
)
55 /* reset focus to root */
56 XSetInputFocus(obt_display
, PointerRoot
, RevertToNone
, CurrentTime
);
59 static void push_to_top(ObClient
*client
)
63 /* if it is modal for a single window, then put that window at the top
64 of the focus order first, so it will be right after ours. the same is
66 if (client
->modal
&& (p
= client_direct_parent(client
)))
69 focus_order
= g_list_remove(focus_order
, client
);
70 focus_order
= g_list_prepend(focus_order
, client
);
73 void focus_set_client(ObClient
*client
)
78 ob_debug_type(OB_DEBUG_FOCUS
,
79 "focus_set_client 0x%lx", client
? client
->window
: 0);
81 if (focus_client
== client
)
84 /* uninstall the old colormap, and install the new one */
85 screen_install_colormap(focus_client
, FALSE
);
86 screen_install_colormap(client
, TRUE
);
88 /* in the middle of cycling..? kill it. */
89 focus_cycle_stop(focus_client
);
90 focus_cycle_stop(client
);
93 focus_client
= client
;
96 /* move to the top of the list */
98 /* remove hiliting from the window when it gets focused */
99 client_hilite(client
, FALSE
);
102 /* set the NET_ACTIVE_WINDOW hint, but preserve it on shutdown */
103 if (ob_state() != OB_STATE_EXITING
) {
104 active
= client
? client
->window
: None
;
105 OBT_PROP_SET32(obt_root(ob_screen
), NET_ACTIVE_WINDOW
, WINDOW
, active
);
108 hooks_run(OB_HOOK_WIN_UNFOCUS
, old
);
109 hooks_run(OB_HOOK_WIN_FOCUS
, client
);
112 static ObClient
* focus_fallback_target(gboolean allow_refocus
,
113 gboolean allow_pointer
,
114 gboolean allow_omnipresent
,
120 ob_debug_type(OB_DEBUG_FOCUS
, "trying pointer stuff");
121 if (allow_pointer
&& config_focus_follow
)
122 if ((c
= client_under_pointer()) &&
123 (allow_refocus
|| client_focus_target(c
) != old
) &&
127 ob_debug_type(OB_DEBUG_FOCUS
, "found in pointer stuff");
131 ob_debug_type(OB_DEBUG_FOCUS
, "trying the focus order");
132 for (it
= focus_order
; it
; it
= g_list_next(it
)) {
134 /* fallback focus to a window if:
135 1. it is on the current desktop. this ignores omnipresent
136 windows, which are problematic in their own rite, unless they are
138 2. it is a valid auto-focus target
141 if ((allow_omnipresent
|| c
->desktop
== screen_desktop
) &&
142 focus_valid_target(c
, TRUE
, FALSE
, FALSE
, FALSE
, FALSE
) &&
144 (allow_refocus
|| client_focus_target(c
) != old
) &&
147 ob_debug_type(OB_DEBUG_FOCUS
, "found in focus order");
152 ob_debug_type(OB_DEBUG_FOCUS
, "trying a desktop window");
153 for (it
= focus_order
; it
; it
= g_list_next(it
)) {
155 /* fallback focus to a window if:
156 1. it is on the current desktop. this ignores omnipresent
157 windows, which are problematic in their own rite.
158 2. it is a normal type window, don't fall back onto a dock or
159 a splashscreen or a desktop window (save the desktop as a
160 backup fallback though)
162 if (focus_valid_target(c
, TRUE
, FALSE
, FALSE
, FALSE
, TRUE
) &&
163 (allow_refocus
|| client_focus_target(c
) != old
) &&
166 ob_debug_type(OB_DEBUG_FOCUS
, "found a desktop window");
174 ObClient
* focus_fallback(gboolean allow_refocus
, gboolean allow_pointer
,
175 gboolean allow_omnipresent
, gboolean focus_lost
)
178 ObClient
*old
= focus_client
;
180 /* unfocus any focused clients.. they can be focused by Pointer events
181 and such, and then when we try focus them, we won't get a FocusIn
182 event at all for them. */
186 new = focus_fallback_target(allow_refocus
, allow_pointer
,
187 allow_omnipresent
, old
);
188 /* get what was really focused */
189 if (new) new = client_focus_target(new);
194 void focus_nothing(void)
196 /* Install our own colormap */
197 if (focus_client
!= NULL
) {
198 screen_install_colormap(focus_client
, FALSE
);
199 screen_install_colormap(NULL
, TRUE
);
202 /* nothing is focused, update the colormap and _the root property_ */
203 focus_set_client(NULL
);
205 event_cancel_all_key_grabs();
207 /* when nothing will be focused, send focus to the backup target */
208 XSetInputFocus(obt_display
, screen_support_win
, RevertToPointerRoot
,
212 void focus_order_add_new(ObClient
*c
)
215 focus_order_to_top(c
);
217 g_assert(!g_list_find(focus_order
, c
));
218 /* if there are any iconic windows, put this above them in the order,
219 but if there are not, then put it under the currently focused one */
220 if (focus_order
&& ((ObClient
*)focus_order
->data
)->iconic
)
221 focus_order
= g_list_insert(focus_order
, c
, 0);
223 focus_order
= g_list_insert(focus_order
, c
, 1);
226 /* in the middle of cycling..? kill it. */
230 void focus_order_remove(ObClient
*c
)
232 focus_order
= g_list_remove(focus_order
, c
);
234 /* in the middle of cycling..? kill it. */
238 void focus_order_to_top(ObClient
*c
)
240 focus_order
= g_list_remove(focus_order
, c
);
242 focus_order
= g_list_prepend(focus_order
, c
);
246 /* insert before first iconic window */
247 for (it
= focus_order
;
248 it
&& !((ObClient
*)it
->data
)->iconic
; it
= g_list_next(it
));
249 focus_order
= g_list_insert_before(focus_order
, it
, c
);
253 void focus_order_to_bottom(ObClient
*c
)
255 focus_order
= g_list_remove(focus_order
, c
);
257 focus_order
= g_list_append(focus_order
, c
);
261 /* insert before first iconic window */
262 for (it
= focus_order
;
263 it
&& !((ObClient
*)it
->data
)->iconic
; it
= g_list_next(it
));
264 focus_order
= g_list_insert_before(focus_order
, it
, c
);
268 ObClient
*focus_order_find_first(guint desktop
)
271 for (it
= focus_order
; it
; it
= g_list_next(it
)) {
272 ObClient
*c
= it
->data
;
273 if (c
->desktop
== desktop
|| c
->desktop
== DESKTOP_ALL
)
279 /*! Returns if a focus target has valid group siblings that can be cycled
281 static gboolean
focus_target_has_siblings(ObClient
*ft
,
282 gboolean iconic_windows
,
283 gboolean all_desktops
)
288 if (!ft
->group
) return FALSE
;
290 for (it
= ft
->group
->members
; it
; it
= g_slist_next(it
)) {
291 ObClient
*c
= it
->data
;
292 /* check that it's not a helper window to avoid infinite recursion */
293 if (c
!= ft
&& c
->type
== OB_CLIENT_TYPE_NORMAL
&&
294 focus_valid_target(c
, TRUE
, iconic_windows
, all_desktops
,
303 gboolean
focus_valid_target(ObClient
*ft
,
304 gboolean helper_windows
,
305 gboolean iconic_windows
,
306 gboolean all_desktops
,
307 gboolean dock_windows
,
308 gboolean desktop_windows
)
312 /* it's on this desktop unless you want all desktops.
314 do this check first because it will usually filter out the most
316 ok
= (all_desktops
|| ft
->desktop
== screen_desktop
||
317 ft
->desktop
== DESKTOP_ALL
);
319 /* the window can receive focus somehow */
320 ok
= ok
&& (ft
->can_focus
|| ft
->focus_notify
);
322 /* the window is not iconic, or we're allowed to go to iconic ones */
323 ok
= ok
&& (iconic_windows
|| !ft
->iconic
);
325 /* it's the right type of window */
326 if (dock_windows
|| desktop_windows
)
327 ok
= ok
&& ((dock_windows
&& ft
->type
== OB_CLIENT_TYPE_DOCK
) ||
328 (desktop_windows
&& ft
->type
== OB_CLIENT_TYPE_DESKTOP
));
329 /* modal windows are important and can always get focus if they are
330 visible and stuff, so don't change 'ok' based on their type */
332 /* normal non-helper windows are valid targets */
334 ((client_normal(ft
) && !client_helper(ft
))
336 /* helper windows are valid targets if... */
337 (client_helper(ft
) &&
338 /* ...a window in its group already has focus and we want to
339 include helper windows ... */
340 ((focus_client
&& ft
->group
== focus_client
->group
&&
342 /* ... or if there are no other windows in its group
343 that can be focused instead */
344 !focus_target_has_siblings(ft
, iconic_windows
, all_desktops
))));
346 /* it's not set to skip the taskbar (but this only applies to normal typed
347 windows, and is overridden if the window is modal) */
348 ok
= ok
&& (ft
->type
!= OB_CLIENT_TYPE_NORMAL
||
352 /* it's not going to just send focus off somewhere else (modal window),
353 unless that modal window is not one of our valid targets, then let
354 you choose this window and bring the modal one here */
356 ObClient
*cft
= client_focus_target(ft
);
357 ok
= ok
&& (ft
== cft
|| !focus_valid_target(cft
,