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
)
60 focus_order
= g_list_remove(focus_order
, client
);
61 focus_order
= g_list_prepend(focus_order
, client
);
64 void focus_set_client(ObClient
*client
)
68 ob_debug_type(OB_DEBUG_FOCUS
,
69 "focus_set_client 0x%lx", client
? client
->window
: 0);
71 if (focus_client
== client
)
74 /* uninstall the old colormap, and install the new one */
75 screen_install_colormap(focus_client
, FALSE
);
76 screen_install_colormap(client
, TRUE
);
78 /* in the middle of cycling..? kill it. */
79 focus_cycle_stop(focus_client
);
80 focus_cycle_stop(client
);
82 focus_client
= client
;
85 /* move to the top of the list */
87 /* remove hiliting from the window when it gets focused */
88 client_hilite(client
, FALSE
);
91 /* set the NET_ACTIVE_WINDOW hint, but preserve it on shutdown */
92 if (ob_state() != OB_STATE_EXITING
) {
93 active
= client
? client
->window
: None
;
94 OBT_PROP_SET32(obt_root(ob_screen
), NET_ACTIVE_WINDOW
, WINDOW
, active
);
98 static ObClient
* focus_fallback_target(gboolean allow_refocus
,
99 gboolean allow_pointer
,
100 gboolean allow_omnipresent
,
106 ob_debug_type(OB_DEBUG_FOCUS
, "trying pointer stuff");
107 if (allow_pointer
&& config_focus_follow
)
108 if ((c
= client_under_pointer()) &&
109 (allow_refocus
|| client_focus_target(c
) != old
) &&
113 ob_debug_type(OB_DEBUG_FOCUS
, "found in pointer stuff");
117 ob_debug_type(OB_DEBUG_FOCUS
, "trying the focus order");
118 for (it
= focus_order
; it
; it
= g_list_next(it
)) {
120 /* fallback focus to a window if:
121 1. it is on the current desktop. this ignores omnipresent
122 windows, which are problematic in their own rite, unless they are
124 2. it is a valid auto-focus target
127 if ((allow_omnipresent
|| c
->desktop
== screen_desktop
) &&
128 focus_valid_target(c
, TRUE
, FALSE
, FALSE
, FALSE
, FALSE
) &&
130 (allow_refocus
|| client_focus_target(c
) != old
) &&
133 ob_debug_type(OB_DEBUG_FOCUS
, "found in focus order");
138 ob_debug_type(OB_DEBUG_FOCUS
, "trying a desktop window");
139 for (it
= focus_order
; it
; it
= g_list_next(it
)) {
141 /* fallback focus to a window if:
142 1. it is on the current desktop. this ignores omnipresent
143 windows, which are problematic in their own rite.
144 2. it is a normal type window, don't fall back onto a dock or
145 a splashscreen or a desktop window (save the desktop as a
146 backup fallback though)
148 if (focus_valid_target(c
, TRUE
, FALSE
, FALSE
, FALSE
, TRUE
) &&
149 (allow_refocus
|| client_focus_target(c
) != old
) &&
152 ob_debug_type(OB_DEBUG_FOCUS
, "found a desktop window");
160 ObClient
* focus_fallback(gboolean allow_refocus
, gboolean allow_pointer
,
161 gboolean allow_omnipresent
, gboolean focus_lost
)
164 ObClient
*old
= focus_client
;
166 /* unfocus any focused clients.. they can be focused by Pointer events
167 and such, and then when we try focus them, we won't get a FocusIn
168 event at all for them. */
172 new = focus_fallback_target(allow_refocus
, allow_pointer
,
173 allow_omnipresent
, old
);
174 /* get what was really focused */
175 if (new) new = client_focus_target(new);
180 void focus_nothing(void)
182 /* Install our own colormap */
183 if (focus_client
!= NULL
) {
184 screen_install_colormap(focus_client
, FALSE
);
185 screen_install_colormap(NULL
, TRUE
);
188 /* nothing is focused, update the colormap and _the root property_ */
189 focus_set_client(NULL
);
191 /* if there is a grab going on, then we need to cancel it. if we move
192 focus during the grab, applications will get NotifyWhileGrabbed events
195 actions should not rely on being able to move focus during an
198 event_cancel_all_key_grabs();
200 /* when nothing will be focused, send focus to the backup target */
201 XSetInputFocus(obt_display
, screen_support_win
, RevertToPointerRoot
,
205 void focus_order_add_new(ObClient
*c
)
208 focus_order_to_top(c
);
210 g_assert(!g_list_find(focus_order
, c
));
211 /* if there are any iconic windows, put this above them in the order,
212 but if there are not, then put it under the currently focused one */
213 if (focus_order
&& ((ObClient
*)focus_order
->data
)->iconic
)
214 focus_order
= g_list_insert(focus_order
, c
, 0);
216 focus_order
= g_list_insert(focus_order
, c
, 1);
219 /* in the middle of cycling..? kill it. */
223 void focus_order_remove(ObClient
*c
)
225 focus_order
= g_list_remove(focus_order
, c
);
227 /* in the middle of cycling..? kill it. */
231 void focus_order_to_top(ObClient
*c
)
233 focus_order
= g_list_remove(focus_order
, c
);
235 focus_order
= g_list_prepend(focus_order
, c
);
239 /* insert before first iconic window */
240 for (it
= focus_order
;
241 it
&& !((ObClient
*)it
->data
)->iconic
; it
= g_list_next(it
));
242 focus_order
= g_list_insert_before(focus_order
, it
, c
);
246 void focus_order_to_bottom(ObClient
*c
)
248 focus_order
= g_list_remove(focus_order
, c
);
250 focus_order
= g_list_append(focus_order
, c
);
254 /* insert before first iconic window */
255 for (it
= focus_order
;
256 it
&& !((ObClient
*)it
->data
)->iconic
; it
= g_list_next(it
));
257 focus_order
= g_list_insert_before(focus_order
, it
, c
);
261 ObClient
*focus_order_find_first(guint desktop
)
264 for (it
= focus_order
; it
; it
= g_list_next(it
)) {
265 ObClient
*c
= it
->data
;
266 if (c
->desktop
== desktop
|| c
->desktop
== DESKTOP_ALL
)
272 /*! Returns if a focus target has valid group siblings that can be cycled
274 static gboolean
focus_target_has_siblings(ObClient
*ft
,
275 gboolean iconic_windows
,
276 gboolean all_desktops
)
281 if (!ft
->group
) return FALSE
;
283 for (it
= ft
->group
->members
; it
; it
= g_slist_next(it
)) {
284 ObClient
*c
= it
->data
;
285 /* check that it's not a helper window to avoid infinite recursion */
286 if (c
!= ft
&& c
->type
== OB_CLIENT_TYPE_NORMAL
&&
287 focus_valid_target(c
, TRUE
, iconic_windows
, all_desktops
,
296 gboolean
focus_valid_target(ObClient
*ft
,
297 gboolean helper_windows
,
298 gboolean iconic_windows
,
299 gboolean all_desktops
,
300 gboolean dock_windows
,
301 gboolean desktop_windows
)
305 /* it's on this desktop unless you want all desktops.
307 do this check first because it will usually filter out the most
309 ok
= (all_desktops
|| ft
->desktop
== screen_desktop
||
310 ft
->desktop
== DESKTOP_ALL
);
312 /* the window can receive focus somehow */
313 ok
= ok
&& (ft
->can_focus
|| ft
->focus_notify
);
315 /* the window is not iconic, or we're allowed to go to iconic ones */
316 ok
= ok
&& (iconic_windows
|| !ft
->iconic
);
318 /* it's the right type of window */
319 if (dock_windows
|| desktop_windows
)
320 ok
= ok
&& ((dock_windows
&& ft
->type
== OB_CLIENT_TYPE_DOCK
) ||
321 (desktop_windows
&& ft
->type
== OB_CLIENT_TYPE_DESKTOP
));
322 /* modal windows are important and can always get focus if they are
323 visible and stuff, so don't change 'ok' based on their type */
325 /* normal non-helper windows are valid targets */
327 ((client_normal(ft
) && !client_helper(ft
))
329 /* helper windows are valid targets if... */
330 (client_helper(ft
) &&
331 /* ...a window in its group already has focus and we want to
332 include helper windows ... */
333 ((focus_client
&& ft
->group
== focus_client
->group
&&
335 /* ... or if there are no other windows in its group
336 that can be focused instead */
337 !focus_target_has_siblings(ft
, iconic_windows
, all_desktops
))));
339 /* it's not set to skip the taskbar (but this only applies to normal typed
340 windows, and is overridden if the window is modal) */
341 ok
= ok
&& (ft
->type
!= OB_CLIENT_TYPE_NORMAL
||
345 /* it's not going to just send focus off somewhere else (modal window),
346 unless that modal window is not one of our valid targets, then let
347 you choose this window and bring the modal one here */
349 ObClient
*cft
= client_focus_target(ft
);
350 ok
= ok
&& (ft
== cft
|| !focus_valid_target(cft
,