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(ob_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\n", 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 PROP_SET32(RootWindow(ob_display
, ob_screen
),
99 net_active_window
, window
, active
);
103 static ObClient
* focus_fallback_target(gboolean allow_refocus
,
104 gboolean allow_pointer
,
105 gboolean allow_omnipresent
,
111 ob_debug_type(OB_DEBUG_FOCUS
, "trying pointer stuff\n");
112 if (allow_pointer
&& config_focus_follow
)
113 if ((c
= client_under_pointer()) &&
114 (allow_refocus
|| client_focus_target(c
) != old
) &&
118 ob_debug_type(OB_DEBUG_FOCUS
, "found in pointer stuff\n");
122 ob_debug_type(OB_DEBUG_FOCUS
, "trying the focus order\n");
123 for (it
= focus_order
; it
; it
= g_list_next(it
)) {
125 /* fallback focus to a window if:
126 1. it is on the current desktop. this ignores omnipresent
127 windows, which are problematic in their own rite, unless they are
129 2. it is a valid auto-focus target
132 if ((allow_omnipresent
|| c
->desktop
== screen_desktop
) &&
133 focus_valid_target(c
, 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\n");
143 ob_debug_type(OB_DEBUG_FOCUS
, "trying a desktop window\n");
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
, TRUE
, FALSE
, FALSE
, FALSE
, TRUE
, FALSE
) &&
154 (allow_refocus
|| client_focus_target(c
) != old
) &&
157 ob_debug_type(OB_DEBUG_FOCUS
, "found a desktop window\n");
165 ObClient
* focus_fallback(gboolean allow_refocus
, gboolean allow_pointer
,
166 gboolean allow_omnipresent
, gboolean focus_lost
)
169 ObClient
*old
= focus_client
;
171 /* unfocus any focused clients.. they can be focused by Pointer events
172 and such, and then when we try focus them, we won't get a FocusIn
173 event at all for them. */
177 new = focus_fallback_target(allow_refocus
, allow_pointer
,
178 allow_omnipresent
, old
);
179 /* get what was really focused */
180 if (new) new = client_focus_target(new);
185 void focus_nothing(void)
187 /* nothing is focused, update the colormap and _the root property_ */
188 focus_set_client(NULL
);
190 /* when nothing will be focused, send focus to the backup target */
191 XSetInputFocus(ob_display
, screen_support_win
, RevertToPointerRoot
,
195 void focus_order_add_new(ObClient
*c
)
198 focus_order_to_top(c
);
200 g_assert(!g_list_find(focus_order
, c
));
201 /* if there are any iconic windows, put this above them in the order,
202 but if there are not, then put it under the currently focused one */
203 if (focus_order
&& ((ObClient
*)focus_order
->data
)->iconic
)
204 focus_order
= g_list_insert(focus_order
, c
, 0);
206 focus_order
= g_list_insert(focus_order
, c
, 1);
209 /* in the middle of cycling..? kill it. */
213 void focus_order_remove(ObClient
*c
)
215 focus_order
= g_list_remove(focus_order
, c
);
217 /* in the middle of cycling..? kill it. */
221 void focus_order_to_top(ObClient
*c
)
223 focus_order
= g_list_remove(focus_order
, c
);
225 focus_order
= g_list_prepend(focus_order
, c
);
229 /* insert before first iconic window */
230 for (it
= focus_order
;
231 it
&& !((ObClient
*)it
->data
)->iconic
; it
= g_list_next(it
));
232 focus_order
= g_list_insert_before(focus_order
, it
, c
);
236 void focus_order_to_bottom(ObClient
*c
)
238 focus_order
= g_list_remove(focus_order
, c
);
240 focus_order
= g_list_append(focus_order
, c
);
244 /* insert before first iconic window */
245 for (it
= focus_order
;
246 it
&& !((ObClient
*)it
->data
)->iconic
; it
= g_list_next(it
));
247 focus_order
= g_list_insert_before(focus_order
, it
, c
);
251 ObClient
*focus_order_find_first(guint desktop
)
254 for (it
= focus_order
; it
; it
= g_list_next(it
)) {
255 ObClient
*c
= it
->data
;
256 if (c
->desktop
== desktop
|| c
->desktop
== DESKTOP_ALL
)
262 /*! Returns if a focus target has valid group siblings that can be cycled
264 static gboolean
focus_target_has_siblings(ObClient
*ft
,
265 gboolean iconic_windows
,
266 gboolean all_desktops
)
271 if (!ft
->group
) return FALSE
;
273 for (it
= ft
->group
->members
; it
; it
= g_slist_next(it
)) {
274 ObClient
*c
= it
->data
;
275 /* check that it's not a helper window to avoid infinite recursion */
276 if (c
!= ft
&& c
->type
== OB_CLIENT_TYPE_NORMAL
&&
277 focus_valid_target(c
, TRUE
, iconic_windows
, all_desktops
,
278 FALSE
, FALSE
, FALSE
))
286 gboolean
focus_valid_target(ObClient
*ft
,
287 gboolean helper_windows
,
288 gboolean iconic_windows
,
289 gboolean all_desktops
,
290 gboolean dock_windows
,
291 gboolean desktop_windows
,
292 gboolean user_request
)
296 /* it's on this desktop unless you want all desktops.
298 do this check first because it will usually filter out the most
300 ok
= (all_desktops
|| ft
->desktop
== screen_desktop
||
301 ft
->desktop
== DESKTOP_ALL
);
303 /* the window can receive focus somehow */
304 ok
= ok
&& (ft
->can_focus
|| ft
->focus_notify
);
306 /* the window is not iconic, or we're allowed to go to iconic ones */
307 ok
= ok
&& (iconic_windows
|| !ft
->iconic
);
309 /* it's the right type of window */
310 if (dock_windows
|| desktop_windows
)
311 ok
= ok
&& ((dock_windows
&& ft
->type
== OB_CLIENT_TYPE_DOCK
) ||
312 (desktop_windows
&& ft
->type
== OB_CLIENT_TYPE_DESKTOP
));
313 /* modal windows are important and can always get focus if they are
314 visible and stuff, so don't change 'ok' based on their type */
316 /* normal non-helper windows are valid targets */
318 ((client_normal(ft
) && !client_helper(ft
))
320 /* helper windows are valid targets if... */
321 (client_helper(ft
) &&
322 /* ...a window in its group already has focus and we want to
323 include helper windows ... */
324 ((focus_client
&& ft
->group
== focus_client
->group
&&
326 /* ... or if there are no other windows in its group
327 that can be focused instead */
328 !focus_target_has_siblings(ft
, iconic_windows
, all_desktops
))));
330 /* it's not set to skip the taskbar (but this only applies to normal typed
331 windows, and is overridden if the window is modal or if the user asked
332 for this window to be focused) */
333 ok
= ok
&& (ft
->type
!= OB_CLIENT_TYPE_NORMAL
||
338 /* it's not going to just send focus off somewhere else (modal window),
339 unless that modal window is not one of our valid targets, then let
340 you choose this window and bring the modal one here */
342 ObClient
*cft
= client_focus_target(ft
);
343 ok
= ok
&& (ft
== cft
|| !focus_valid_target(cft
,