Allow non-interactive focus cycling.
[mikachu/openbox.git] / openbox / focus_cycle.c
index 81557fe..de17650 100644 (file)
 
 #include "focus_cycle.h"
 #include "focus_cycle_indicator.h"
-#include "focus_cycle_popup.h"
 #include "client.h"
 #include "frame.h"
 #include "focus.h"
 #include "screen.h"
 #include "openbox.h"
 #include "debug.h"
-#include "group.h"
 
 #include <X11/Xlib.h>
 #include <glib.h>
 
-ObClient     *focus_cycle_target = NULL;
-
-static void      focus_cycle_destroy_notify (ObClient *client, gpointer data);
-static gboolean  focus_target_has_siblings  (ObClient *ft,
-                                             gboolean iconic_windows,
-                                             gboolean all_desktops);
-static ObClient *focus_find_directional    (ObClient *c,
-                                            ObDirection dir,
-                                            gboolean dock_windows,
-                                            gboolean desktop_windows);
-static ObClient *focus_find_directional    (ObClient *c,
-                                            ObDirection dir,
-                                            gboolean dock_windows,
-                                            gboolean desktop_windows);
+typedef enum {
+    OB_CYCLE_NONE = 0,
+    OB_CYCLE_NORMAL,
+    OB_CYCLE_DIRECTIONAL
+} ObCycleType;
+
+ObClient       *focus_cycle_target = NULL;
+static ObCycleType focus_cycle_type = OB_CYCLE_NONE;
+static gboolean focus_cycle_linear;
+static gboolean focus_cycle_iconic_windows;
+static gboolean focus_cycle_all_desktops;
+static gboolean focus_cycle_nonhilite_windows;
+static gboolean focus_cycle_dock_windows;
+static gboolean focus_cycle_desktop_windows;
+
+static ObClient *focus_find_directional(ObClient *c,
+                                        ObDirection dir,
+                                        gboolean dock_windows,
+                                        gboolean desktop_windows);
 
 void focus_cycle_startup(gboolean reconfig)
 {
     if (reconfig) return;
-
-    client_add_destroy_notify(focus_cycle_destroy_notify, NULL);
 }
 
 void focus_cycle_shutdown(gboolean reconfig)
 {
     if (reconfig) return;
-
-    client_remove_destroy_notify(focus_cycle_destroy_notify);
-}
-
-void focus_cycle_stop()
-{
-    if (focus_cycle_target) {
-        focus_cycle(TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE);
-        focus_directional_cycle(0, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE);
-    }
 }
 
-static void focus_cycle_destroy_notify(ObClient *client, gpointer data)
+void focus_cycle_addremove(ObClient *c, gboolean redraw)
 {
-    /* end cycling if the target disappears. CurrentTime is fine, time won't
-       be used */
-    if (focus_cycle_target == client)
-        focus_cycle_stop();
-}
+    if (!focus_cycle_type)
+        return;
 
-/*! 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)
-                                                         
-{
-    GSList *it;
+    if (focus_cycle_type == OB_CYCLE_DIRECTIONAL) {
+        if (c && focus_cycle_target == c) {
+            focus_directional_cycle(0, TRUE, TRUE, TRUE, TRUE,
+                                    TRUE, TRUE, TRUE);
+        }
+    }
+    else if (c && redraw) {
+        gboolean v, s;
 
-    if (!ft->group) return FALSE;
+        v = focus_cycle_valid(c);
+        s = focus_cycle_popup_is_showing(c) || c == focus_cycle_target;
 
-    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 && !client_helper(c) &&
-            focus_cycle_target_valid(c, iconic_windows, all_desktops, FALSE,
-                                     FALSE))
-        {
-            return TRUE;
-        }
+        if (v != s)
+            focus_cycle_reorder();
+    }
+    else if (redraw) {
+        focus_cycle_reorder();
     }
-    return FALSE;
 }
 
-gboolean focus_cycle_target_valid(ObClient *ft,
-                                  gboolean iconic_windows,
-                                  gboolean all_desktops,
-                                  gboolean dock_windows,
-                                  gboolean desktop_windows)
+void focus_cycle_reorder()
 {
-    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 it... */
-             (client_helper(ft) &&
-              /* ...a window in its group already has focus ... */
-              ((focus_client && ft->group == focus_client->group) ||
-               /* ... or if there are no other windows in its group 
-                  that can be cycled to 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 fous off somewhere else (modal window) */
-    ok = ok && ft == client_focus_target(ft);
-
-    return ok;
+    if (focus_cycle_type == OB_CYCLE_NORMAL) {
+        focus_cycle_target = focus_cycle_popup_refresh(focus_cycle_target,
+                                                       TRUE,
+                                                       focus_cycle_linear);
+        focus_cycle_update_indicator(focus_cycle_target);
+        if (!focus_cycle_target)
+            focus_cycle(TRUE, TRUE, TRUE, TRUE, TRUE, TRUE,
+                        TRUE, OB_FOCUS_CYCLE_POPUP_MODE_NONE,
+                        TRUE, TRUE);
+    }
 }
 
-void focus_cycle(gboolean forward, gboolean all_desktops,
-                 gboolean dock_windows, gboolean desktop_windows,
-                 gboolean linear, gboolean interactive,
-                 gboolean dialog, gboolean done, gboolean cancel)
+ObClient* focus_cycle(gboolean forward, gboolean all_desktops,
+                      gboolean nonhilite_windows,
+                      gboolean dock_windows, gboolean desktop_windows,
+                      gboolean linear, gboolean showbar,
+                      ObFocusCyclePopupMode mode,
+                      gboolean done, gboolean cancel)
 {
-    static ObClient *first = NULL;
-    static ObClient *t = NULL;
     static GList *order = NULL;
     GList *it, *start, *list;
     ObClient *ft = NULL;
+    ObClient *ret = NULL;
 
-    if (interactive) {
-        if (cancel) {
-            focus_cycle_target = NULL;
-            goto done_cycle;
-        } else if (done)
-            goto done_cycle;
+    if (cancel) {
+        focus_cycle_target = NULL;
+        goto done_cycle;
+    } else if (done)
+        goto done_cycle;
 
-        if (!focus_order)
-            goto done_cycle;
+    if (!focus_order)
+        goto done_cycle;
 
-        if (!first) first = focus_client;
+    if (linear) list = client_list;
+    else        list = focus_order;
 
-        if (linear) list = client_list;
-        else        list = focus_order;
-    } else {
-        if (!focus_order)
-            goto done_cycle;
-        list = client_list;
-    }
-    if (!focus_cycle_target) focus_cycle_target = focus_client;
+    if (focus_cycle_target == NULL) {
+        focus_cycle_linear = linear;
+        focus_cycle_iconic_windows = TRUE;
+        focus_cycle_all_desktops = all_desktops;
+        focus_cycle_nonhilite_windows = nonhilite_windows;
+        focus_cycle_dock_windows = dock_windows;
+        focus_cycle_desktop_windows = desktop_windows;
+        start = it = g_list_find(list, focus_client);
+    } else
+        start = it = g_list_find(list, focus_cycle_target);
 
-    start = it = g_list_find(list, focus_cycle_target);
     if (!start) /* switched desktops or something? */
         start = it = forward ? g_list_last(list) : g_list_first(list);
     if (!start) goto done_cycle;
@@ -202,51 +146,36 @@ void focus_cycle(gboolean forward, gboolean all_desktops,
             if (it == NULL) it = g_list_last(list);
         }
         ft = it->data;
-        if (focus_cycle_target_valid(ft, TRUE,
-                                     all_desktops, dock_windows,
-                                     desktop_windows))
-        {
-            if (interactive) {
-                if (ft != focus_cycle_target) { /* prevents flicker */
-                    focus_cycle_target = ft;
-                    focus_cycle_draw_indicator(ft);
-                }
-                if (dialog)
-                    /* same arguments as focus_target_valid */
-                    focus_cycle_popup_show(ft, TRUE,
-                                           all_desktops, dock_windows,
-                                           desktop_windows);
-                return;
-            } else if (ft != focus_cycle_target) {
+        if (focus_cycle_valid(ft)) {
+            if (ft != focus_cycle_target) { /* prevents flicker */
                 focus_cycle_target = ft;
-                done = TRUE;
-                break;
+                focus_cycle_type = OB_CYCLE_NORMAL;
+                focus_cycle_draw_indicator(showbar ? ft : NULL);
             }
+            /* same arguments as focus_target_valid */
+            focus_cycle_popup_show(ft, mode, focus_cycle_linear);
+            return focus_cycle_target;
         }
     } while (it != start);
 
 done_cycle:
-    if (done && focus_cycle_target)
-        client_activate(focus_cycle_target, FALSE, TRUE);
+    if (done && !cancel) ret = focus_cycle_target;
 
-    t = NULL;
-    first = NULL;
     focus_cycle_target = NULL;
+    focus_cycle_type = OB_CYCLE_NONE;
     g_list_free(order);
     order = NULL;
 
-    if (interactive) {
-        focus_cycle_draw_indicator(NULL);
-        focus_cycle_popup_hide();
-    }
+    focus_cycle_draw_indicator(NULL);
+    focus_cycle_popup_hide();
 
-    return;
+    return ret;
 }
 
 /* this be mostly ripped from fvwm */
 static ObClient *focus_find_directional(ObClient *c, ObDirection dir,
                                         gboolean dock_windows,
-                                        gboolean desktop_windows) 
+                                        gboolean desktop_windows)
 {
     gint my_cx, my_cy, his_cx, his_cy;
     gint offset = 0;
@@ -255,7 +184,7 @@ static ObClient *focus_find_directional(ObClient *c, ObDirection dir,
     ObClient *best_client, *cur;
     GList *it;
 
-    if(!client_list)
+    if (!client_list)
         return NULL;
 
     /* first, find the centre coords of the currently focused window */
@@ -263,16 +192,15 @@ static ObClient *focus_find_directional(ObClient *c, ObDirection dir,
     my_cy = c->frame->area.y + c->frame->area.height / 2;
 
     best_score = -1;
-    best_client = NULL;
+    best_client = c;
 
-    for(it = g_list_first(client_list); it; it = g_list_next(it)) {
+    for (it = g_list_first(client_list); it; it = g_list_next(it)) {
         cur = it->data;
 
         /* the currently selected window isn't interesting */
-        if(cur == c)
+        if (cur == c)
             continue;
-        if (!focus_cycle_target_valid(it->data, FALSE, FALSE, dock_windows,
-                                      desktop_windows))
+        if (!focus_cycle_valid(it->data))
             continue;
 
         /* find the centre coords of this window, from the
@@ -282,8 +210,9 @@ static ObClient *focus_find_directional(ObClient *c, ObDirection dir,
         his_cy = (cur->frame->area.y - my_cy)
             + cur->frame->area.height / 2;
 
-        if(dir == OB_DIRECTION_NORTHEAST || dir == OB_DIRECTION_SOUTHEAST ||
-           dir == OB_DIRECTION_SOUTHWEST || dir == OB_DIRECTION_NORTHWEST) {
+        if (dir == OB_DIRECTION_NORTHEAST || dir == OB_DIRECTION_SOUTHEAST ||
+            dir == OB_DIRECTION_SOUTHWEST || dir == OB_DIRECTION_NORTHWEST)
+        {
             gint tx;
             /* Rotate the diagonals 45 degrees counterclockwise.
              * To do this, multiply the matrix /+h +h\ with the
@@ -295,7 +224,7 @@ static ObClient *focus_find_directional(ObClient *c, ObDirection dir,
             his_cx = tx;
         }
 
-        switch(dir) {
+        switch (dir) {
         case OB_DIRECTION_NORTH:
         case OB_DIRECTION_SOUTH:
         case OB_DIRECTION_NORTHEAST:
@@ -317,7 +246,7 @@ static ObClient *focus_find_directional(ObClient *c, ObDirection dir,
         }
 
         /* the target must be in the requested direction */
-        if(distance <= 0)
+        if (distance <= 0)
             continue;
 
         /* Calculate score for this window.  The smaller the better. */
@@ -326,74 +255,95 @@ static ObClient *focus_find_directional(ObClient *c, ObDirection dir,
         /* windows more than 45 degrees off the direction are
          * heavily penalized and will only be chosen if nothing
          * else within a million pixels */
-        if(offset > distance)
+        if (offset > distance)
             score += 1000000;
 
-        if(best_score == -1 || score < best_score)
-            best_client = cur,
-                best_score = score;
+        if (best_score == -1 || score < best_score) {
+            best_client = cur;
+            best_score = score;
+        }
     }
 
     return best_client;
 }
 
-void focus_directional_cycle(ObDirection dir, gboolean dock_windows,
-                             gboolean desktop_windows, gboolean interactive,
-                             gboolean dialog, gboolean done, gboolean cancel)
+ObClient* focus_directional_cycle(ObDirection dir, gboolean dock_windows,
+                                  gboolean desktop_windows,
+                                  gboolean interactive,
+                                  gboolean showbar, gboolean dialog,
+                                  gboolean done, gboolean cancel)
 {
     static ObClient *first = NULL;
     ObClient *ft = NULL;
-
-    if (!interactive)
-        return;
+    ObClient *ret = NULL;
 
     if (cancel) {
         focus_cycle_target = NULL;
         goto done_cycle;
-    } else if (done)
+    } else if (done && interactive)
         goto done_cycle;
 
     if (!focus_order)
         goto done_cycle;
 
+    if (focus_cycle_target == NULL) {
+        focus_cycle_linear = FALSE;
+        focus_cycle_iconic_windows = FALSE;
+        focus_cycle_all_desktops = FALSE;
+        focus_cycle_nonhilite_windows = TRUE;
+        focus_cycle_dock_windows = dock_windows;
+        focus_cycle_desktop_windows = desktop_windows;
+    }
+
     if (!first) first = focus_client;
-    if (!focus_cycle_target) focus_cycle_target = focus_client;
 
     if (focus_cycle_target)
         ft = focus_find_directional(focus_cycle_target, dir, dock_windows,
                                     desktop_windows);
+    else if (first)
+        ft = focus_find_directional(first, dir, dock_windows, desktop_windows);
     else {
         GList *it;
 
         for (it = focus_order; it; it = g_list_next(it))
-            if (focus_cycle_target_valid(it->data, FALSE, FALSE, dock_windows,
-                                         desktop_windows))
+            if (focus_cycle_valid(it->data)) {
                 ft = it->data;
+                break;
+            }
     }
-        
-    if (ft) {
-        if (ft != focus_cycle_target) {/* prevents flicker */
-            focus_cycle_target = ft;
-            focus_cycle_draw_indicator(ft);
-        }
+
+    if (ft && ft != focus_cycle_target) {/* prevents flicker */
+        focus_cycle_target = ft;
+        focus_cycle_type = OB_CYCLE_DIRECTIONAL;
+        if (!interactive)
+            goto done_cycle;
+        focus_cycle_draw_indicator(showbar ? ft : NULL);
     }
-    if (focus_cycle_target && dialog) {
+    if (focus_cycle_target && dialog)
         /* same arguments as focus_target_valid */
-        focus_cycle_popup_single_show(focus_cycle_target,
-                                      FALSE, FALSE, dock_windows,
-                                      desktop_windows);
-        return;
-    }
+        focus_cycle_popup_single_show(focus_cycle_target);
+    return focus_cycle_target;
 
 done_cycle:
-    if (done && focus_cycle_target)
-        client_activate(focus_cycle_target, FALSE, TRUE);
+    if (done && !cancel) ret = focus_cycle_target;
 
     first = NULL;
     focus_cycle_target = NULL;
+    focus_cycle_type = OB_CYCLE_NONE;
 
     focus_cycle_draw_indicator(NULL);
     focus_cycle_popup_single_hide();
 
-    return;
+    return ret;
+}
+
+gboolean focus_cycle_valid(struct _ObClient *client)
+{
+    return focus_valid_target(client, screen_desktop, TRUE,
+                              focus_cycle_iconic_windows,
+                              focus_cycle_all_desktops,
+                              focus_cycle_nonhilite_windows,
+                              focus_cycle_dock_windows,
+                              focus_cycle_desktop_windows,
+                              FALSE);
 }