1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
3 focus_cycle.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.
20 #include "focus_cycle.h"
21 #include "focus_cycle_indicator.h"
22 #include "focus_cycle_popup.h"
34 ObClient *focus_cycle_target = NULL;
35 static gboolean focus_cycle_iconic_windows;
36 static gboolean focus_cycle_all_desktops;
37 static gboolean focus_cycle_dock_windows;
38 static gboolean focus_cycle_desktop_windows;
40 static gboolean focus_target_has_siblings (ObClient *ft,
41 gboolean iconic_windows,
42 gboolean all_desktops);
43 static ObClient *focus_find_directional (ObClient *c,
45 gboolean dock_windows,
46 gboolean desktop_windows);
47 static ObClient *focus_find_directional (ObClient *c,
49 gboolean dock_windows,
50 gboolean desktop_windows);
52 void focus_cycle_startup(gboolean reconfig)
57 void focus_cycle_shutdown(gboolean reconfig)
62 void focus_cycle_stop(ObClient *ifclient)
64 /* stop focus cycling if the given client is a valid focus target,
65 and so the cycling is being disrupted */
66 if (focus_cycle_target && ifclient &&
67 focus_cycle_target_valid(ifclient,
68 focus_cycle_iconic_windows,
69 focus_cycle_all_desktops,
70 focus_cycle_dock_windows,
71 focus_cycle_desktop_windows))
73 focus_cycle(TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE);
74 focus_directional_cycle(0, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE);
78 /*! Returns if a focus target has valid group siblings that can be cycled
80 static gboolean focus_target_has_siblings(ObClient *ft,
81 gboolean iconic_windows,
82 gboolean all_desktops)
87 if (!ft->group) return FALSE;
89 for (it = ft->group->members; it; it = g_slist_next(it)) {
90 ObClient *c = it->data;
91 /* check that it's not a helper window to avoid infinite recursion */
92 if (c != ft && !client_helper(c) &&
93 focus_cycle_target_valid(c, iconic_windows, all_desktops, FALSE,
102 gboolean focus_cycle_target_valid(ObClient *ft,
103 gboolean iconic_windows,
104 gboolean all_desktops,
105 gboolean dock_windows,
106 gboolean desktop_windows)
110 /* it's on this desktop unless you want all desktops.
112 do this check first because it will usually filter out the most
114 ok = (all_desktops || ft->desktop == screen_desktop ||
115 ft->desktop == DESKTOP_ALL);
117 /* the window can receive focus somehow */
118 ok = ok && (ft->can_focus || ft->focus_notify);
120 /* the window is not iconic, or we're allowed to go to iconic ones */
121 ok = ok && (iconic_windows || !ft->iconic);
123 /* it's the right type of window */
124 if (dock_windows || desktop_windows)
125 ok = ok && ((dock_windows && ft->type == OB_CLIENT_TYPE_DOCK) ||
126 (desktop_windows && ft->type == OB_CLIENT_TYPE_DESKTOP));
127 /* modal windows are important and can always get focus if they are
128 visible and stuff, so don't change 'ok' based on their type */
130 /* normal non-helper windows are valid targets */
132 ((client_normal(ft) && !client_helper(ft))
134 /* helper windows are valid targets it... */
135 (client_helper(ft) &&
136 /* ...a window in its group already has focus ... */
137 ((focus_client && ft->group == focus_client->group) ||
138 /* ... or if there are no other windows in its group
139 that can be cycled to instead */
140 !focus_target_has_siblings(ft, iconic_windows, all_desktops))));
142 /* it's not set to skip the taskbar (unless it is a type that would be
143 expected to set this hint, or modal) */
144 ok = ok && ((ft->type == OB_CLIENT_TYPE_DOCK ||
145 ft->type == OB_CLIENT_TYPE_DESKTOP ||
146 ft->type == OB_CLIENT_TYPE_TOOLBAR ||
147 ft->type == OB_CLIENT_TYPE_MENU ||
148 ft->type == OB_CLIENT_TYPE_UTILITY) ||
152 /* it's not going to just send fous off somewhere else (modal window) */
153 ok = ok && ft == client_focus_target(ft);
158 void focus_cycle(gboolean forward, gboolean all_desktops,
159 gboolean dock_windows, gboolean desktop_windows,
160 gboolean linear, gboolean interactive,
161 gboolean dialog, gboolean done, gboolean cancel)
163 static ObClient *first = NULL;
164 static ObClient *t = NULL;
165 static GList *order = NULL;
166 GList *it, *start, *list;
171 focus_cycle_target = NULL;
179 if (!first) first = focus_client;
181 if (linear) list = client_list;
182 else list = focus_order;
190 if (focus_cycle_target == NULL) {
191 focus_cycle_iconic_windows = TRUE;
192 focus_cycle_all_desktops = all_desktops;
193 focus_cycle_dock_windows = dock_windows;
194 focus_cycle_desktop_windows = desktop_windows;
195 focus_cycle_target = focus_client;
198 start = it = g_list_find(list, focus_cycle_target);
199 if (!start) /* switched desktops or something? */
200 start = it = forward ? g_list_last(list) : g_list_first(list);
201 if (!start) goto done_cycle;
206 if (it == NULL) it = g_list_first(list);
209 if (it == NULL) it = g_list_last(list);
212 if (focus_cycle_target_valid(ft,
213 focus_cycle_iconic_windows,
214 focus_cycle_all_desktops,
215 focus_cycle_dock_windows,
216 focus_cycle_desktop_windows))
219 if (ft != focus_cycle_target) { /* prevents flicker */
220 focus_cycle_target = ft;
221 focus_cycle_draw_indicator(ft);
224 /* same arguments as focus_target_valid */
225 focus_cycle_popup_show(ft,
226 focus_cycle_iconic_windows,
227 focus_cycle_all_desktops,
228 focus_cycle_dock_windows,
229 focus_cycle_desktop_windows);
231 } else if (ft != focus_cycle_target) {
232 focus_cycle_target = ft;
237 } while (it != start);
240 if (done && focus_cycle_target)
241 client_activate(focus_cycle_target, FALSE, TRUE);
245 focus_cycle_target = NULL;
250 focus_cycle_draw_indicator(NULL);
251 focus_cycle_popup_hide();
257 /* this be mostly ripped from fvwm */
258 static ObClient *focus_find_directional(ObClient *c, ObDirection dir,
259 gboolean dock_windows,
260 gboolean desktop_windows)
262 gint my_cx, my_cy, his_cx, his_cy;
265 gint score, best_score;
266 ObClient *best_client, *cur;
272 /* first, find the centre coords of the currently focused window */
273 my_cx = c->frame->area.x + c->frame->area.width / 2;
274 my_cy = c->frame->area.y + c->frame->area.height / 2;
279 for(it = g_list_first(client_list); it; it = g_list_next(it)) {
282 /* the currently selected window isn't interesting */
285 if (!focus_cycle_target_valid(it->data, FALSE, FALSE, dock_windows,
289 /* find the centre coords of this window, from the
290 * currently focused window's point of view */
291 his_cx = (cur->frame->area.x - my_cx)
292 + cur->frame->area.width / 2;
293 his_cy = (cur->frame->area.y - my_cy)
294 + cur->frame->area.height / 2;
296 if(dir == OB_DIRECTION_NORTHEAST || dir == OB_DIRECTION_SOUTHEAST ||
297 dir == OB_DIRECTION_SOUTHWEST || dir == OB_DIRECTION_NORTHWEST) {
299 /* Rotate the diagonals 45 degrees counterclockwise.
300 * To do this, multiply the matrix /+h +h\ with the
301 * vector (x y). \-h +h/
302 * h = sqrt(0.5). We can set h := 1 since absolute
303 * distance doesn't matter here. */
304 tx = his_cx + his_cy;
305 his_cy = -his_cx + his_cy;
310 case OB_DIRECTION_NORTH:
311 case OB_DIRECTION_SOUTH:
312 case OB_DIRECTION_NORTHEAST:
313 case OB_DIRECTION_SOUTHWEST:
314 offset = (his_cx < 0) ? -his_cx : his_cx;
315 distance = ((dir == OB_DIRECTION_NORTH ||
316 dir == OB_DIRECTION_NORTHEAST) ?
319 case OB_DIRECTION_EAST:
320 case OB_DIRECTION_WEST:
321 case OB_DIRECTION_SOUTHEAST:
322 case OB_DIRECTION_NORTHWEST:
323 offset = (his_cy < 0) ? -his_cy : his_cy;
324 distance = ((dir == OB_DIRECTION_WEST ||
325 dir == OB_DIRECTION_NORTHWEST) ?
330 /* the target must be in the requested direction */
334 /* Calculate score for this window. The smaller the better. */
335 score = distance + offset;
337 /* windows more than 45 degrees off the direction are
338 * heavily penalized and will only be chosen if nothing
339 * else within a million pixels */
340 if(offset > distance)
343 if(best_score == -1 || score < best_score)
351 void focus_directional_cycle(ObDirection dir, gboolean dock_windows,
352 gboolean desktop_windows, gboolean interactive,
353 gboolean dialog, gboolean done, gboolean cancel)
355 static ObClient *first = NULL;
362 focus_cycle_target = NULL;
370 if (focus_cycle_target == NULL) {
371 focus_cycle_iconic_windows = FALSE;
372 focus_cycle_all_desktops = FALSE;
373 focus_cycle_dock_windows = dock_windows;
374 focus_cycle_desktop_windows = desktop_windows;
375 focus_cycle_target = focus_client;
378 if (!first) first = focus_client;
380 if (focus_cycle_target)
381 ft = focus_find_directional(focus_cycle_target, dir, dock_windows,
386 for (it = focus_order; it; it = g_list_next(it))
387 if (focus_cycle_target_valid(it->data,
388 focus_cycle_iconic_windows,
389 focus_cycle_all_desktops,
390 focus_cycle_dock_windows,
391 focus_cycle_desktop_windows))
396 if (ft != focus_cycle_target) {/* prevents flicker */
397 focus_cycle_target = ft;
398 focus_cycle_draw_indicator(ft);
401 if (focus_cycle_target && dialog) {
402 /* same arguments as focus_target_valid */
403 focus_cycle_popup_single_show(focus_cycle_target,
404 focus_cycle_iconic_windows,
405 focus_cycle_all_desktops,
406 focus_cycle_dock_windows,
407 focus_cycle_desktop_windows);
412 if (done && focus_cycle_target)
413 client_activate(focus_cycle_target, FALSE, TRUE);
416 focus_cycle_target = NULL;
418 focus_cycle_draw_indicator(NULL);
419 focus_cycle_popup_single_hide();