+/* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
+
+ focus.c for the Openbox window manager
+ Copyright (c) 2006 Mikael Magnusson
+ Copyright (c) 2003-2007 Dana Jansens
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ See the COPYING file for a copy of the GNU General Public License.
+*/
+
+#include "debug.h"
#include "event.h"
#include "openbox.h"
+#include "grab.h"
#include "client.h"
#include "config.h"
-#include "frame.h"
-#include "screen.h"
#include "group.h"
+#include "focus_cycle.h"
+#include "screen.h"
#include "prop.h"
-#include "dispatch.h"
+#include "keyboard.h"
#include "focus.h"
-#include "parse.h"
#include "stacking.h"
#include <X11/Xlib.h>
#include <glib.h>
-Client *focus_client = NULL;
-GList **focus_order = NULL; /* these lists are created when screen_startup
- sets the number of desktops */
+#define FOCUS_INDICATOR_WIDTH 6
-Window focus_backup = None;
+ObClient *focus_client = NULL;
+GList *focus_order = NULL;
-static gboolean noreorder = 0;
-
-void focus_startup()
+void focus_startup(gboolean reconfig)
{
- /* create the window which gets focus when no clients get it. Have to
- make it override-redirect so we don't try manage it, since it is
- mapped. */
- XSetWindowAttributes attrib;
-
- focus_client = NULL;
-
- attrib.override_redirect = TRUE;
- focus_backup = XCreateWindow(ob_display, ob_root,
- -100, -100, 1, 1, 0,
- CopyFromParent, InputOutput, CopyFromParent,
- CWOverrideRedirect, &attrib);
- XMapWindow(ob_display, focus_backup);
- stacking_raise_internal(focus_backup);
+ if (reconfig) return;
/* start with nothing focused */
- focus_set_client(NULL);
+ focus_nothing();
}
-void focus_shutdown()
+void focus_shutdown(gboolean reconfig)
{
- guint i;
-
- for (i = 0; i < screen_num_desktops; ++i)
- g_list_free(focus_order[i]);
- g_free(focus_order);
- focus_order = NULL;
-
- XDestroyWindow(ob_display, focus_backup);
+ if (reconfig) return;
/* reset focus to root */
- XSetInputFocus(ob_display, PointerRoot, RevertToPointerRoot,
- event_lasttime);
+ XSetInputFocus(ob_display, PointerRoot, RevertToNone, CurrentTime);
}
-static void push_to_top(Client *client)
+static void push_to_top(ObClient *client)
{
- guint desktop;
-
- desktop = client->desktop;
- if (desktop == DESKTOP_ALL) desktop = screen_desktop;
- focus_order[desktop] = g_list_remove(focus_order[desktop], client);
- focus_order[desktop] = g_list_prepend(focus_order[desktop], client);
+ focus_order = g_list_remove(focus_order, client);
+ focus_order = g_list_prepend(focus_order, client);
}
-void focus_set_client(Client *client)
+void focus_set_client(ObClient *client)
{
Window active;
- Client *old;
+
+ ob_debug_type(OB_DEBUG_FOCUS,
+ "focus_set_client 0x%lx\n", client ? client->window : 0);
+
+ if (focus_client == client)
+ return;
/* uninstall the old colormap, and install the new one */
screen_install_colormap(focus_client, FALSE);
screen_install_colormap(client, TRUE);
- if (client == NULL) {
- /* when nothing will be focused, send focus to the backup target */
- XSetInputFocus(ob_display, focus_backup, RevertToPointerRoot,
- event_lasttime);
- XSync(ob_display, FALSE);
- }
+ /* in the middle of cycling..? kill it. */
+ focus_cycle_stop(focus_client);
+ focus_cycle_stop(client);
- old = focus_client;
focus_client = client;
- /* move to the top of the list */
- if (noreorder)
- --noreorder;
- else if (client != NULL)
+ if (client != NULL) {
+ /* move to the top of the list */
push_to_top(client);
+ /* remove hiliting from the window when it gets focused */
+ client_hilite(client, FALSE);
+ }
- /* set the NET_ACTIVE_WINDOW hint */
- active = client ? client->window : None;
- PROP_SET32(ob_root, net_active_window, window, active);
-
- if (focus_client != NULL)
- dispatch_client(Event_Client_Focus, focus_client, 0, 0);
- if (old != NULL)
- dispatch_client(Event_Client_Unfocus, old, 0, 0);
+ /* set the NET_ACTIVE_WINDOW hint, but preserve it on shutdown */
+ if (ob_state() != OB_STATE_EXITING) {
+ active = client ? client->window : None;
+ PROP_SET32(RootWindow(ob_display, ob_screen),
+ net_active_window, window, active);
+ }
}
-static gboolean focus_under_pointer()
+static ObClient* focus_fallback_target(gboolean allow_refocus,
+ gboolean allow_pointer,
+ gboolean allow_omnipresent,
+ ObClient *old)
{
- int x, y;
GList *it;
+ ObClient *c;
+
+ ob_debug_type(OB_DEBUG_FOCUS, "trying pointer stuff\n");
+ if (allow_pointer && config_focus_follow)
+ if ((c = client_under_pointer()) &&
+ (allow_refocus || client_focus_target(c) != old) &&
+ (client_normal(c) &&
+ client_focus(c)))
+ {
+ ob_debug_type(OB_DEBUG_FOCUS, "found in pointer stuff\n");
+ return c;
+ }
- if (ob_pointer_pos(&x, &y)) {
- for (it = stacking_list; it != NULL; it = it->next) {
- Client *c = it->data;
- if (c->desktop == screen_desktop &&
- RECT_CONTAINS(c->frame->area, x, y))
- break;
+ ob_debug_type(OB_DEBUG_FOCUS, "trying the focus order\n");
+ for (it = focus_order; it; it = g_list_next(it)) {
+ c = it->data;
+ /* fallback focus to a window if:
+ 1. it is on the current desktop. this ignores omnipresent
+ windows, which are problematic in their own rite, unless they are
+ specifically allowed
+ 2. it is a valid auto-focus target
+ 3. it is not shaded
+ */
+ if ((allow_omnipresent || c->desktop == screen_desktop) &&
+ focus_valid_target(c, TRUE, FALSE, FALSE, FALSE, FALSE) &&
+ !c->shaded &&
+ (allow_refocus || client_focus_target(c) != old) &&
+ client_focus(c))
+ {
+ ob_debug_type(OB_DEBUG_FOCUS, "found in focus order\n");
+ return c;
}
- if (it != NULL)
- return client_normal(it->data) && client_focus(it->data);
}
- return FALSE;
+
+ ob_debug_type(OB_DEBUG_FOCUS, "trying a desktop window\n");
+ for (it = focus_order; it; it = g_list_next(it)) {
+ c = it->data;
+ /* fallback focus to a window if:
+ 1. it is on the current desktop. this ignores omnipresent
+ windows, which are problematic in their own rite.
+ 2. it is a normal type window, don't fall back onto a dock or
+ a splashscreen or a desktop window (save the desktop as a
+ backup fallback though)
+ */
+ if (focus_valid_target(c, TRUE, FALSE, FALSE, FALSE, TRUE) &&
+ (allow_refocus || client_focus_target(c) != old) &&
+ client_focus(c))
+ {
+ ob_debug_type(OB_DEBUG_FOCUS, "found a desktop window\n");
+ return c;
+ }
+ }
+
+ return NULL;
}
-void focus_fallback(FallbackType type)
+ObClient* focus_fallback(gboolean allow_refocus, gboolean allow_pointer,
+ gboolean allow_omnipresent)
{
- GList *it;
- Client *old = NULL;
-
- old = focus_client;
+ ObClient *new;
+ ObClient *old = focus_client;
/* unfocus any focused clients.. they can be focused by Pointer events
- and such, and then when I try focus them, I won't get a FocusIn event
- at all for them.
- */
+ and such, and then when we try focus them, we won't get a FocusIn
+ event at all for them. */
+ focus_nothing();
+
+ new = focus_fallback_target(allow_refocus, allow_pointer,
+ allow_omnipresent, old);
+ /* get what was really focused */
+ if (new) new = client_focus_target(new);
+
+ return new;
+}
+
+void focus_nothing()
+{
+ /* Install our own colormap */
+ if (focus_client != NULL) {
+ screen_install_colormap(focus_client, FALSE);
+ screen_install_colormap(NULL, TRUE);
+ }
+
+ /* nothing is focused, update the colormap and _the root property_ */
focus_set_client(NULL);
- if (!(type == Fallback_Desktop ?
- config_focus_last_on_desktop : config_focus_last)) {
- if (config_focus_follow) focus_under_pointer();
- return;
+ /* if there is a grab going on, then we need to cancel it. if we move
+ focus during the grab, applications will get NotifyWhileGrabbed events
+ and ignore them !
+
+ actions should not rely on being able to move focus during an
+ interactive grab.
+ */
+ event_cancel_all_key_grabs();
+
+ /* when nothing will be focused, send focus to the backup target */
+ XSetInputFocus(ob_display, screen_support_win, RevertToPointerRoot,
+ event_curtime);
+}
+
+void focus_order_add_new(ObClient *c)
+{
+ if (c->iconic)
+ focus_order_to_top(c);
+ else {
+ g_assert(!g_list_find(focus_order, c));
+ /* if there are any iconic windows, put this above them in the order,
+ but if there are not, then put it under the currently focused one */
+ if (focus_order && ((ObClient*)focus_order->data)->iconic)
+ focus_order = g_list_insert(focus_order, c, 0);
+ else
+ focus_order = g_list_insert(focus_order, c, 1);
}
- if (type == Fallback_Unfocusing && old && old->transient_for) {
- if (old->transient_for == TRAN_GROUP) {
- for (it = focus_order[screen_desktop]; it != NULL; it = it->next) {
- GSList *sit;
-
- for (sit = old->group->members; sit; sit = sit->next)
- if (sit->data == it->data && client_focus(sit->data))
- return;
- }
- } else {
- if (client_normal(old->transient_for))
- if (client_focus(old->transient_for))
- return;
- }
+ /* in the middle of cycling..? kill it. */
+ focus_cycle_stop(c);
+}
+
+void focus_order_remove(ObClient *c)
+{
+ focus_order = g_list_remove(focus_order, c);
+
+ /* in the middle of cycling..? kill it. */
+ focus_cycle_stop(c);
+}
+
+void focus_order_to_top(ObClient *c)
+{
+ focus_order = g_list_remove(focus_order, c);
+ if (!c->iconic) {
+ focus_order = g_list_prepend(focus_order, c);
+ } else {
+ GList *it;
+
+ /* insert before first iconic window */
+ for (it = focus_order;
+ it && !((ObClient*)it->data)->iconic; it = g_list_next(it));
+ focus_order = g_list_insert_before(focus_order, it, c);
}
+}
- for (it = focus_order[screen_desktop]; it != NULL; it = it->next)
- if (type != Fallback_Unfocusing || it->data != old)
- if (client_normal(it->data) && client_focus(it->data))
- return;
+void focus_order_to_bottom(ObClient *c)
+{
+ focus_order = g_list_remove(focus_order, c);
+ if (c->iconic) {
+ focus_order = g_list_append(focus_order, c);
+ } else {
+ GList *it;
+
+ /* insert before first iconic window */
+ for (it = focus_order;
+ it && !((ObClient*)it->data)->iconic; it = g_list_next(it));
+ focus_order = g_list_insert_before(focus_order, it, c);
+ }
+}
- /* nothing to focus */
- focus_set_client(NULL);
+ObClient *focus_order_find_first(guint desktop)
+{
+ GList *it;
+ for (it = focus_order; it; it = g_list_next(it)) {
+ ObClient *c = it->data;
+ if (c->desktop == desktop || c->desktop == DESKTOP_ALL)
+ return c;
+ }
+ return NULL;
}
-Client *focus_cycle(gboolean forward, gboolean linear, gboolean done,
- gboolean cancel)
+/*! Returns if a focus target has valid group siblings that can be cycled
+ to in its place */
+static gboolean focus_target_has_siblings(ObClient *ft,
+ gboolean iconic_windows,
+ gboolean all_desktops)
+
{
- static Client *first = NULL;
- static Client *t = NULL;
- static GList *order = NULL;
- GList *it, *start, *list;
- Client *ft;
-
- if (cancel) {
- if (first) client_focus(first);
- goto done_cycle;
- } else if (done) {
- if (focus_client) {
- push_to_top(focus_client); /* move to top of focus_order */
- stacking_raise(focus_client);
+ GSList *it;
+
+ if (!ft->group) return FALSE;
+
+ for (it = ft->group->members; it; it = g_slist_next(it)) {
+ ObClient *c = it->data;
+ /* check that it's not a helper window to avoid infinite recursion */
+ if (c != ft && c->type == OB_CLIENT_TYPE_NORMAL &&
+ focus_valid_target(c, TRUE, iconic_windows, all_desktops,
+ FALSE, FALSE))
+ {
+ return TRUE;
}
- goto done_cycle;
}
- if (!first) first = focus_client;
-
- if (linear) list = client_list;
- else list = focus_order[screen_desktop];
-
- start = it = g_list_find(list, focus_client);
- if (!start) /* switched desktops or something? */
- start = it = forward ? g_list_last(list) : g_list_first(list);
- if (!start) goto done_cycle;
-
- do {
- if (forward) {
- it = it->next;
- if (it == NULL) it = list;
- } else {
- it = it->prev;
- if (it == NULL) it = g_list_last(list);
- }
- ft = client_focus_target(it->data);
- if (ft == it->data && focus_client != ft && client_normal(ft) &&
- client_focus(ft)) {
- noreorder++; /* avoid reordering the focus_order */
- return ft;
- }
- } while (it != start);
- return NULL;
+ return FALSE;
+}
-done_cycle:
- t = NULL;
- first = NULL;
- g_list_free(order);
- order = NULL;
- return NULL;
+gboolean focus_valid_target(ObClient *ft,
+ gboolean helper_windows,
+ gboolean iconic_windows,
+ gboolean all_desktops,
+ gboolean dock_windows,
+ gboolean desktop_windows)
+{
+ gboolean ok = FALSE;
+
+ /* it's on this desktop unless you want all desktops.
+
+ do this check first because it will usually filter out the most
+ windows */
+ ok = (all_desktops || ft->desktop == screen_desktop ||
+ ft->desktop == DESKTOP_ALL);
+
+ /* the window can receive focus somehow */
+ ok = ok && (ft->can_focus || ft->focus_notify);
+
+ /* the window is not iconic, or we're allowed to go to iconic ones */
+ ok = ok && (iconic_windows || !ft->iconic);
+
+ /* it's the right type of window */
+ if (dock_windows || desktop_windows)
+ ok = ok && ((dock_windows && ft->type == OB_CLIENT_TYPE_DOCK) ||
+ (desktop_windows && ft->type == OB_CLIENT_TYPE_DESKTOP));
+ /* modal windows are important and can always get focus if they are
+ visible and stuff, so don't change 'ok' based on their type */
+ else if (!ft->modal)
+ /* normal non-helper windows are valid targets */
+ ok = ok &&
+ ((client_normal(ft) && !client_helper(ft))
+ ||
+ /* helper windows are valid targets if... */
+ (client_helper(ft) &&
+ /* ...a window in its group already has focus and we want to
+ include helper windows ... */
+ ((focus_client && ft->group == focus_client->group &&
+ helper_windows) ||
+ /* ... or if there are no other windows in its group
+ that can be focused instead */
+ !focus_target_has_siblings(ft, iconic_windows, all_desktops))));
+
+ /* it's not set to skip the taskbar (unless it is a type that would be
+ expected to set this hint, or modal) */
+ ok = ok && ((ft->type == OB_CLIENT_TYPE_DOCK ||
+ ft->type == OB_CLIENT_TYPE_DESKTOP ||
+ ft->type == OB_CLIENT_TYPE_TOOLBAR ||
+ ft->type == OB_CLIENT_TYPE_MENU ||
+ ft->type == OB_CLIENT_TYPE_UTILITY) ||
+ ft->modal ||
+ !ft->skip_taskbar);
+
+ /* it's not going to just send focus off somewhere else (modal window),
+ unless that modal window is not one of our valid targets, then let
+ you choose this window and bring the modal one here */
+ {
+ ObClient *cft = client_focus_target(ft);
+ ok = ok && (ft == cft || !focus_valid_target(cft,
+ TRUE,
+ iconic_windows,
+ all_desktops,
+ dock_windows,
+ desktop_windows));
+ }
+
+ return ok;
}
+