Allow non-interactive focus cycling.
[mikachu/openbox.git] / openbox / focus_cycle.c
index 47306d5..de17650 100644 (file)
 #include "focus.h"
 #include "screen.h"
 #include "openbox.h"
-#include "popup.h"
 #include "debug.h"
-#include "group.h"
 
 #include <X11/Xlib.h>
 #include <glib.h>
 
-#define FOCUS_CYCLE_ICON_SIZE 48
-
-struct _ObFocusCyclePopup
-{
-    ObWindow obwin;
-    Window bg;
-
-    Window text;
-
-    RrAppearance *a_bg;
-    RrAppearance *a_text;
-    gint textw;
-    gint h;
-    gint minw;
-    gint maxw;
-    gboolean mapped;
-};
-
-ObClient     *focus_cycle_target = NULL;
-
-static ObIconPopup  *focus_cycle_popup;
-
-static void      focus_cycle_destroy_notify (ObClient *client, gpointer data);
-static gboolean  focus_target_valid         (ObClient *ft,
-                                             gboolean all_desktops,
-                                             gboolean dock_windows,
-                                             gboolean desktop_windows);
-static gboolean  focus_target_has_siblings  (ObClient *ft,
-                                             gboolean all_desktops);
-static gchar    *popup_get_name             (ObClient *c,
-                                             ObClient **nametarget);
-static void      popup_cycle                (ObClient *c,
-                                             gboolean show,
-                                             gboolean all_desktops,
-                                             gboolean dock_windows,
-                                             gboolean desktop_windows);
-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)
 {
-    focus_cycle_popup = icon_popup_new(TRUE);
-
-    if (!reconfig)
-        client_add_destroy_notify(focus_cycle_destroy_notify, NULL);
+    if (reconfig) return;
 }
 
 void focus_cycle_shutdown(gboolean reconfig)
 {
-    icon_popup_free(focus_cycle_popup);
-
-    if (!reconfig)
-        client_remove_destroy_notify(focus_cycle_destroy_notify);
+    if (reconfig) return;
 }
 
-void focus_cycle_stop()
+void focus_cycle_addremove(ObClient *c, gboolean redraw)
 {
-    if (focus_cycle_target)
-        focus_cycle(TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE);
-}
-
-
-static gchar *popup_get_name(ObClient *c, ObClient **nametarget)
-{
-    ObClient *p;
-    gchar *title = NULL;
-    const gchar *desk = NULL;
-    gchar *ret;
-
-    /* find our highest direct parent, including non-normal windows */
-    for (p = c; p->transient_for && p->transient_for != OB_TRAN_GROUP;
-         p = p->transient_for);
-
-    if (c->desktop != DESKTOP_ALL && c->desktop != screen_desktop)
-        desk = screen_desktop_names[c->desktop];
-
-    /* use the transient's parent's title/icon if we don't have one */
-    if (p != c && !strcmp("", (c->iconic ? c->icon_title : c->title)))
-        title = g_strdup(p->iconic ? p->icon_title : p->title);
-
-    if (title == NULL)
-        title = g_strdup(c->iconic ? c->icon_title : c->title);
-
-    if (desk)
-        ret = g_strdup_printf("%s [%s]", title, desk);
-    else {
-        ret = title;
-        title = NULL;
-    }
-    g_free(title);
-
-    /* set this only if we're returning true and they asked for it */
-    if (ret && nametarget) *nametarget = p;
-    return ret;
-}
-
-static void popup_cycle(ObClient *c, gboolean show,
-                        gboolean all_desktops, gboolean dock_windows,
-                        gboolean desktop_windows)
-{
-    gchar *showtext = NULL;
-    ObClient *showtarget;
-
-    if (!show) {
-        icon_popup_hide(focus_cycle_popup);
+    if (!focus_cycle_type)
         return;
-    }
 
-    /* do this stuff only when the dialog is first showing */
-    if (!focus_cycle_popup->popup->mapped &&
-        !focus_cycle_popup->popup->delay_mapped)
-    {
-        Rect *a;
-        gchar **names;
-        GList *targets = NULL, *it;
-        gint n = 0, i;
-
-        /* position the popup */
-        a = screen_physical_area_monitor(0);
-        icon_popup_position(focus_cycle_popup, CenterGravity,
-                            a->x + a->width / 2, a->y + a->height / 2);
-        icon_popup_height(focus_cycle_popup, POPUP_HEIGHT);
-        icon_popup_min_width(focus_cycle_popup, POPUP_WIDTH);
-        icon_popup_max_width(focus_cycle_popup,
-                             MAX(a->width/3, POPUP_WIDTH));
-
-
-        /* make its width to be the width of all the possible titles */
-
-        /* build a list of all the valid focus targets */
-        for (it = focus_order; it; it = g_list_next(it)) {
-            ObClient *ft = it->data;
-            if (focus_target_valid(ft, all_desktops, dock_windows
-                                   , desktop_windows))
-            {
-                targets = g_list_prepend(targets, ft);
-                ++n;
-            }
-        }
-        /* make it null terminated so we can use g_strfreev */
-        names = g_new(char*, n+1);
-        for (it = targets, i = 0; it; it = g_list_next(it), ++i) {
-            ObClient *ft = it->data, *t;
-            names[i] = popup_get_name(ft, &t);
-
-            /* little optimization.. save this text and client, so we dont
-               have to get it again */
-            if (ft == c) {
-                showtext = g_strdup(names[i]);
-                showtarget = t;
-            }
+    if (focus_cycle_type == OB_CYCLE_DIRECTIONAL) {
+        if (c && focus_cycle_target == c) {
+            focus_directional_cycle(0, TRUE, TRUE, TRUE, TRUE,
+                                    TRUE, TRUE, TRUE);
         }
-        names[n] = NULL;
-
-        icon_popup_text_width_to_strings(focus_cycle_popup, names, n);
-        g_strfreev(names);
     }
+    else if (c && redraw) {
+        gboolean v, s;
 
+        v = focus_cycle_valid(c);
+        s = focus_cycle_popup_is_showing(c) || c == focus_cycle_target;
 
-    if (!showtext) showtext = popup_get_name(c, &showtarget);
-    icon_popup_show(focus_cycle_popup, showtext,
-                    client_icon(showtarget, 48, 48));
-    g_free(showtext);
-}
-
-static void focus_cycle_destroy_notify(ObClient *client, gpointer data)
-{
-    /* end cycling if the target disappears. CurrentTime is fine, time won't
-       be used
-    */
-    if (focus_cycle_target == client)
-        focus_cycle(TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE);
-}
-
-/*! 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 all_desktops)
-                                                         
-{
-    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 && !client_helper(c) &&
-            focus_target_valid(c, all_desktops, FALSE, FALSE))
-        {
-            return TRUE;
-        }
+        if (v != s)
+            focus_cycle_reorder();
+    }
+    else if (redraw) {
+        focus_cycle_reorder();
     }
-    return FALSE;
 }
 
-/*! @param allow_helpers This is used for calling itself recursively while
-                         checking helper windows. */
-static gboolean focus_target_valid(ObClient *ft,
-                                   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);
-
-    /* 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));
-    else
-        /* 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, all_desktops))));
-
-    /* it's not set to skip the taskbar (unless it is a type that would be
-       expected to set this hint */
-    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->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;
@@ -329,48 +146,36 @@ void focus_cycle(gboolean forward, gboolean all_desktops,
             if (it == NULL) it = g_list_last(list);
         }
         ft = it->data;
-        if (focus_target_valid(ft, all_desktops, dock_windows,
-                               desktop_windows))
-        {
-            if (interactive) {
-                if (ft != focus_cycle_target) { /* prevents flicker */
-                    focus_cycle_target = ft;
-                    focus_cycle_draw_indicator(ft);
-                }
-                /* same arguments as focus_target_valid */
-                popup_cycle(ft, dialog, 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);
-        popup_cycle(ft, FALSE, FALSE, FALSE, FALSE);
-    }
+    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;
@@ -379,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 */
@@ -387,31 +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)
-            continue;
-        if (cur->type == OB_CLIENT_TYPE_DOCK && !dock_windows)
-            continue;
-        if (cur->type == OB_CLIENT_TYPE_DESKTOP && !desktop_windows)
-            continue;
-        if (!client_normal(cur) &&
-            cur->type != OB_CLIENT_TYPE_DOCK &&
-            cur->type != OB_CLIENT_TYPE_DESKTOP)
+        if (cur == c)
             continue;
-        /* using c->desktop instead of screen_desktop doesn't work if the
-         * current window was omnipresent, hope this doesn't have any other
-         * side effects */
-        if(screen_desktop != cur->desktop && cur->desktop != DESKTOP_ALL)
-            continue;
-        if(cur->iconic)
-            continue;
-        if(!(client_focus_target(cur) == cur &&
-             client_can_focus(cur)))
+        if (!focus_cycle_valid(it->data))
             continue;
 
         /* find the centre coords of this window, from the
@@ -421,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
@@ -434,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:
@@ -456,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. */
@@ -465,91 +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_target_valid(it->data, 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) {
+    if (focus_cycle_target && dialog)
         /* same arguments as focus_target_valid */
-        popup_cycle(focus_cycle_target, dialog, FALSE, dock_windows,
-                    desktop_windows);
-        if (dialog)
-            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);
-    popup_cycle(ft, FALSE, FALSE, FALSE, FALSE);
+    focus_cycle_popup_single_hide();
 
-    return;
+    return ret;
 }
 
-void focus_order_add_new(ObClient *c)
+gboolean focus_cycle_valid(struct _ObClient *client)
 {
-    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);
-    }
+    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);
 }
-