child/parents don't get included in tests for occluding/occluded windows, because...
[dana/openbox-history.git] / openbox / stacking.c
index bab7b76..4a58d91 100644 (file)
@@ -1,3 +1,22 @@
+/* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
+
+   stacking.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 "openbox.h"
 #include "prop.h"
 #include "screen.h"
@@ -6,6 +25,7 @@
 #include "group.h"
 #include "frame.h"
 #include "window.h"
+#include "debug.h"
 
 GList  *stacking_list = NULL;
 
@@ -23,7 +43,7 @@ void stacking_set_list()
     /* create an array of the window ids (from bottom to top,
        reverse order!) */
     if (stacking_list) {
-       windows = g_new(Window, g_list_length(stacking_list));
+        windows = g_new(Window, g_list_length(stacking_list));
         for (it = g_list_last(stacking_list); it; it = g_list_previous(it)) {
             if (WINDOW_IS_CLIENT(it->data))
                 windows[i++] = WINDOW_AS_CLIENT(it->data)->window;
@@ -31,24 +51,28 @@ void stacking_set_list()
     }
 
     PROP_SETA32(RootWindow(ob_display, ob_screen),
-                net_client_list_stacking, window, (guint32*)windows, i);
+                net_client_list_stacking, window, (gulong*)windows, i);
 
     g_free(windows);
 }
 
 static void do_restack(GList *wins, GList *before)
 {
-    GList *it, *next;
+    GList *it;
     Window *win;
-    int i;
+    gint i;
 
+#ifdef DEBUG
+    GList *next;
     /* pls only restack stuff in the same layer at a time */
     for (it = wins; it; it = next) {
         next = g_list_next(it);
         if (!next) break;
         g_assert (window_layer(it->data) == window_layer(next->data));
     }
-
+    if (before)
+        g_assert(window_layer(it->data) >= window_layer(before->data));
+#endif
 
     win = g_new(Window, g_list_length(wins) + 1);
 
@@ -66,12 +90,14 @@ static void do_restack(GList *wins, GList *before)
         stacking_list = g_list_insert_before(stacking_list, before, it->data);
     }
 
-    /* XXX some debug checking of the stacking list's order */
+#ifdef DEBUG
+    /* some debug checking of the stacking list's order */
     for (it = stacking_list; ; it = next) {
         next = g_list_next(it);
         if (!next) break;
         g_assert(window_layer(it->data) >= window_layer(next->data));
     }
+#endif
 
     XRestackWindows(ob_display, win, i);
     g_free(win);
@@ -83,7 +109,7 @@ static void do_raise(GList *wins)
 {
     GList *it;
     GList *layer[OB_NUM_STACKING_LAYERS] = {NULL};
-    int i;
+    gint i;
 
     for (it = wins; it; it = g_list_next(it)) {
         ObStackingLayer l;
@@ -110,7 +136,7 @@ static void do_lower(GList *wins)
 {
     GList *it;
     GList *layer[OB_NUM_STACKING_LAYERS] = {NULL};
-    int i;
+    gint i;
 
     for (it = wins; it; it = g_list_next(it)) {
         ObStackingLayer l;
@@ -133,155 +159,258 @@ static void do_lower(GList *wins)
     }
 }
 
-static GList *pick_windows(ObClient *top, ObClient *selected, gboolean raise)
+static void restack_windows(ObClient *selected, gboolean raise)
 {
-    GList *ret = NULL;
-    GList *it, *next, *prev;
-    GSList *sit;
-    int i, n;
+    GList *it, *last, *below, *above, *next;
+    GList *wins = NULL;
+
+    GList *group_modals = NULL;
+    GList *group_trans = NULL;
     GList *modals = NULL;
     GList *trans = NULL;
-    GList *modal_sel_it = NULL; /* the selected guy if modal */
-    GList *trans_sel_it = NULL; /* the selected guy if not */
 
     /* remove first so we can't run into ourself */
-    stacking_list = g_list_remove(stacking_list, top);
+    it = g_list_find(stacking_list, selected);
+    g_assert(it);
+    stacking_list = g_list_delete_link(stacking_list, it);
+
+    /* go from the bottom of the stacking list up. don't move any other windows
+       when lowering, we call this for each window independently */
+    if (raise) {
+        for (it = g_list_last(stacking_list); it; it = next) {
+            next = g_list_previous(it);
+
+            if (WINDOW_IS_CLIENT(it->data)) {
+                ObClient *ch = it->data;
+
+                /* only move windows in the same stacking layer */
+                if (ch->layer == selected->layer &&
+                    client_search_transient(selected, ch))
+                {
+                    if (client_is_direct_child(selected, ch)) {
+                        if (ch->modal)
+                            modals = g_list_prepend(modals, ch);
+                        else
+                            trans = g_list_prepend(trans, ch);
+                    }
+                    else {
+                        if (ch->modal)
+                            group_modals = g_list_prepend(group_modals, ch);
+                        else
+                            group_trans = g_list_prepend(group_trans, ch);
+                    }
+                    stacking_list = g_list_delete_link(stacking_list, it);
+                }
+            }
+        }
+    }
 
-    i = 0;
-    n = g_slist_length(top->transients);
-    for (it = stacking_list; i < n && it; it = next) {
-        prev = g_list_previous(it);
-        next = g_list_next(it);
+    /* put transients of the selected window right above it */
+    wins = g_list_concat(modals, trans);
+    wins = g_list_append(wins, selected);
 
-        if ((sit = g_slist_find(top->transients, it->data))) {
-            ObClient *c = sit->data;
+    /* if selected window is transient for group then raise it above others */
+    if (selected->transient_for_group) {
+        /* if it's modal, raise it above those also */
+        if (selected->modal) {
+            wins = g_list_concat(wins, group_modals);
+            group_modals = NULL;
+        }
+        wins = g_list_concat(wins, group_trans);
+        group_trans = NULL;
+    }
 
-            ++i;
+    /* find where to put the selected window, start from bottom of list,
+       this is the window below everything we are re-adding to the list */
+    last = NULL;
+    for (it = g_list_last(stacking_list); it; it = g_list_previous(it))
+    {
+        if (window_layer(it->data) < selected->layer) {
+            last = it;
+            continue;
+        }
+        /* if lowering, stop at the beginning of the layer */
+        if (!raise)
+            break;
+        /* if raising, stop at the end of the layer */
+        if (window_layer(it->data) > selected->layer)
+            break;
+
+        last = it;
+    }
 
-            if (!c->modal) {
-                if (c != selected) {
-                    trans = g_list_concat(trans,
-                                           pick_windows(c, selected, raise));
-                } else {
-                    g_assert(modal_sel_it == NULL);
-                    g_assert(trans_sel_it == NULL);
-                    trans_sel_it = pick_windows(c, selected, raise);
-                }
-            } else {
-                if (c != selected) {
-                    modals = g_list_concat(modals,
-                                           pick_windows(c, selected, raise));
-                } else {
-                    g_assert(modal_sel_it == NULL);
-                    g_assert(trans_sel_it == NULL);
-                    modal_sel_it = pick_windows(c, selected, raise);
-                }
-            }
-            /* if we dont have a prev then start back at the beginning,
-               otherwise skip back to the prev's next */
-            next = prev ? g_list_next(prev) : stacking_list;
+    /* save this position in the stacking list */
+    below = last;
+
+    /* find where to put the group transients, start from the top of list */
+    for (it = stacking_list; it; it = g_list_next(it)) {
+        /* skip past higher layers */
+        if (window_layer(it->data) > selected->layer)
+            continue;
+        /* if we reach the end of the layer (how?) then don't go further */
+        if (window_layer(it->data) < selected->layer)
+            break;
+        /* stop when we reach the first window in the group */
+        if (WINDOW_IS_CLIENT(it->data)) {
+            ObClient *c = it->data;
+            if (c->group == selected->group)
+                break;
         }
+        /* if we don't hit any other group members, stop here because this
+           is where we are putting the selected window (and its children) */
+        if (it == below)
+            break;
     }
 
-    ret = g_list_concat((raise ? modal_sel_it : modals),
-                        (raise ? modals : modal_sel_it));
+    /* save this position, this is the top of the group of windows between the
+       group transient ones we're restacking and the others up above that we're
+       restacking
 
-    ret = g_list_concat(ret, (raise ? trans_sel_it : trans));
-    ret = g_list_concat(ret, (raise ? trans : trans_sel_it));
+       we actually want to save 1 position _above_ that, for for loops to work
+       nicely, so move back one position in the list while saving it
+    */
+    above = it ? g_list_previous(it) : g_list_last(stacking_list);
+
+    /* put the windows inside the gap to the other windows we're stacking
+       into the restacking list, go from the bottom up so that we can use
+       g_list_prepend */
+    if (below) it = g_list_previous(below);
+    else       it = g_list_last(stacking_list);
+    for (; it != above; it = next) {
+        next = g_list_previous(it);
+        wins = g_list_prepend(wins, it->data);
+        stacking_list = g_list_delete_link(stacking_list, it);
+    }
 
+    /* group transients go above the rest of the stuff acquired to now */
+    wins = g_list_concat(group_trans, wins);
+    /* group modals go on the very top */
+    wins = g_list_concat(group_modals, wins);
 
-    /* add itself */
-    ret = g_list_append(ret, top);
+    do_restack(wins, below);
+    g_list_free(wins);
 
-    return ret;
-}
+    /* lower our parents after us, so they go below us */
+    if (!raise && selected->parents) {
+        GSList *parents_copy, *sit;
+        GSList *reorder = NULL;
 
-static GList *pick_group_windows(ObClient *top, ObClient *selected, gboolean raise)
-{
-    GList *ret = NULL;
-    GList *it, *next, *prev;
-    GSList *sit;
-    int i, n;
-
-    /* add group members in their stacking order */
-    if (top->group) {
-        i = 0;
-        n = g_slist_length(top->group->members) - 1;
-        for (it = stacking_list; i < n && it; it = next) {
-            prev = g_list_previous(it);
-            next = g_list_next(it);
-
-            if ((sit = g_slist_find(top->group->members, it->data))) {
-                ++i;
-                ret = g_list_concat(ret,
-                                    pick_windows(sit->data, selected, raise)); 
-                /* if we dont have a prev then start back at the beginning,
-                   otherwise skip back to the prev's next */
-                next = prev ? g_list_next(prev) : stacking_list;
+        parents_copy = g_slist_copy(selected->parents);
+
+        /* go thru stacking list backwards so we can use g_slist_prepend */
+        for (it = g_list_last(stacking_list); it && parents_copy;
+             it = g_list_previous(it))
+            if ((sit = g_slist_find(parents_copy, it->data))) {
+                reorder = g_slist_prepend(reorder, sit->data);
+                parents_copy = g_slist_delete_link(parents_copy, sit);
             }
-        }
+        g_assert(parents_copy == NULL);
+
+        /* call restack for each of these to lower them */
+        for (sit = reorder; sit; sit = g_slist_next(sit))
+            restack_windows(sit->data, raise);
     }
-    return ret;
 }
 
 void stacking_raise(ObWindow *window)
 {
-    GList *wins;
-
     if (WINDOW_IS_CLIENT(window)) {
-        ObClient *c;
         ObClient *selected;
         selected = WINDOW_AS_CLIENT(window);
-        c = client_search_top_transient(selected);
-        wins = pick_windows(c, selected, TRUE);
-        wins = g_list_concat(wins, pick_group_windows(c, selected, TRUE));
+        restack_windows(selected, TRUE);
     } else {
+        GList *wins;
         wins = g_list_append(NULL, window);
         stacking_list = g_list_remove(stacking_list, window);
+        do_raise(wins);
+        g_list_free(wins);
     }
-    do_raise(wins);
-    g_list_free(wins);
 }
 
 void stacking_lower(ObWindow *window)
 {
-    GList *wins;
-
     if (WINDOW_IS_CLIENT(window)) {
-        ObClient *c;
         ObClient *selected;
         selected = WINDOW_AS_CLIENT(window);
-        c = client_search_top_transient(selected);
-        wins = pick_windows(c, selected, FALSE);
-        wins = g_list_concat(pick_group_windows(c, selected, FALSE), wins);
+        restack_windows(selected, FALSE);
     } else {
+        GList *wins;
         wins = g_list_append(NULL, window);
         stacking_list = g_list_remove(stacking_list, window);
+        do_lower(wins);
+        g_list_free(wins);
     }
-    do_lower(wins);
+}
+
+void stacking_below(ObWindow *window, ObWindow *below)
+{
+    GList *wins, *before;
+
+    if (window_layer(window) != window_layer(below))
+        return;
+
+    wins = g_list_append(NULL, window);
+    stacking_list = g_list_remove(stacking_list, window);
+    before = g_list_next(g_list_find(stacking_list, below));
+    do_restack(wins, before);
     g_list_free(wins);
 }
 
 void stacking_add(ObWindow *win)
 {
-    ObStackingLayer l;
-    GList *wins;
-
     g_assert(screen_support_win != None); /* make sure I dont break this in the
-                                       future */
-
-    l = window_layer(win);
-    wins = g_list_append(NULL, win); /* list of 1 element */
+                                             future */
 
     stacking_list = g_list_append(stacking_list, win);
     stacking_raise(win);
 }
 
+static GList *find_highest_relative(ObClient *client)
+{    
+    GList *ret = NULL;
+
+    if (client->parents) {
+        GList *it;
+        GSList *top;
+
+        /* get all top level relatives of this client */
+        top = client_search_all_top_parents_layer(client);
+
+        /* go from the top of the stacking order down */
+        for (it = stacking_list; !ret && it; it = g_list_next(it)) {
+            if (WINDOW_IS_CLIENT(it->data)) {
+                ObClient *c = it->data;
+                /* only look at windows in the same layer and that are
+                   visible */
+                if (c->layer == client->layer &&
+                    !c->iconic && 
+                    (c->desktop == client->desktop ||
+                     c->desktop == DESKTOP_ALL ||
+                     client->desktop == DESKTOP_ALL))
+                {
+                    GSList *sit;
+
+                    /* go through each top level parent and see it this window
+                       is related to them */
+                    for (sit = top; !ret && sit; sit = g_slist_next(sit)) {
+                        ObClient *topc = sit->data;
+
+                        /* are they related ? */
+                        if (topc == c || client_search_transient(topc, c))
+                            ret = it;
+                    }
+                }
+            }
+        }
+    }
+    return ret;
+}
+
 void stacking_add_nonintrusive(ObWindow *win)
 {
     ObClient *client;
-    ObClient *parent = NULL;
-    GList *it_before = NULL;
+    GList *it_below = NULL; /* this client will be below us */
+    GList *it_above;
 
     if (!WINDOW_IS_CLIENT(win)) {
         stacking_add(win); /* no special rules for others */
@@ -290,42 +419,208 @@ void stacking_add_nonintrusive(ObWindow *win)
 
     client = WINDOW_AS_CLIENT(win);
 
-    /* insert above its highest parent */
-    if (client->transient_for) {
-        if (client->transient_for != OB_TRAN_GROUP) {
-            parent = client->transient_for;
-        } else {
-            GSList *sit;
-            GList *it;
-
-            if (client->group)
-                for (it = stacking_list; !parent && it; it = it->next) {
-                    if ((sit = g_slist_find(client->group->members, it->data)))
-                for (sit = client->group->members; !parent && sit;
-                     sit = sit->next) {
-                    ObClient *c = sit->data;
-                    /* checking transient_for prevents infinate loops! */
-                    if (sit->data == it->data && !c->transient_for)
-                        parent = it->data;
+    /* insert above its highest parent (or its highest child !) */
+    it_below = find_highest_relative(client);
+
+    if (!it_below) {
+        /* nothing to put it directly above, so try find the focused client
+           to put it underneath it */
+        if (focus_client && client != focus_client &&
+            focus_client->layer == client->layer)
+        {
+            it_below = g_list_find(stacking_list, focus_client);
+            /* this can give NULL, but it means the focused window is on the
+               bottom of the stacking order, so go to the bottom in that case,
+               below it */
+            it_below = g_list_next(it_below);
+        }
+        else {
+            /* There is no window to put this directly above, so put it at the
+               top, so you know it is there.
+
+               It used to do this only if the window was focused and lower
+               it otherwise.
+
+               We also put it at the top not the bottom to fix a bug with
+               fullscreen windows. When focusLast is off and followsMouse is
+               on, when you switch desktops, the fullscreen window loses
+               focus and goes into its lower layer. If this puts it at the
+               bottom then when you come back to the desktop, the window is
+               at the bottom and won't get focus back.
+            */
+            it_below = stacking_list;
+        }
+    }
+
+    /* make sure it's not in the wrong layer though ! */
+    for (; it_below; it_below = g_list_next(it_below)) {
+        /* stop when the window is not in a higher layer than the window
+           it is going above (it_below) */
+        if (client->layer >= window_layer(it_below->data))
+            break;
+    }
+    for (; it_below != stacking_list; it_below = it_above) {
+        /* stop when the window is not in a lower layer than the
+           window it is going under (it_above) */
+        it_above = it_below ?
+            g_list_previous(it_below) : g_list_last(stacking_list);
+        if (client->layer <= window_layer(it_above->data))
+            break;
+    }
+
+    GList *wins = g_list_append(NULL, win);
+    do_restack(wins, it_below);
+    g_list_free(wins);
+}
+
+/*! Returns TRUE if client is occluded by the sibling. If sibling is NULL it
+  tries against all other clients.
+*/
+static gboolean stacking_occluded(ObClient *client, ObClient *sibling)
+{
+    GList *it;
+    gboolean occluded = FALSE;
+    gboolean found = FALSE;
+
+    /* no need for any looping in this case */
+    if (sibling && client->layer != sibling->layer)
+        return occluded;
+
+    for (it = stacking_list; it;
+         it = (found ? g_list_previous(it) :g_list_next(it)))
+        if (WINDOW_IS_CLIENT(it->data)) {
+            ObClient *c = it->data;
+            if (found && !c->iconic &&
+                (c->desktop == DESKTOP_ALL || client->desktop == DESKTOP_ALL ||
+                 c->desktop == client->desktop) &&
+                !client_search_transient(client, c))
+            {
+                if (RECT_INTERSECTS_RECT(c->frame->area, client->frame->area))
+                {
+                    if (sibling != NULL) {
+                        if (c == sibling) {
+                            occluded = TRUE;
+                            break;
+                        }
+                    }
+                    else if (c->layer == client->layer) {
+                        occluded = TRUE;
+                        break;
+                    }
+                    else if (c->layer > client->layer)
+                        break; /* we past its layer */
                 }
             }
+            else if (c == client)
+                found = TRUE;
         }
-    }
+    return occluded;
+}
 
-    if (!(it_before = g_list_find(stacking_list, parent))) {
-        /* no parent to put above, try find the focused client to go
-           under */
-        if (focus_client && focus_client->layer == client->layer) {
-            if ((it_before = g_list_find(stacking_list, focus_client)))
-                it_before = it_before->next;
+/*! Returns TRUE if client occludes the sibling. If sibling is NULL it tries
+  against all other clients.
+*/
+static gboolean stacking_occludes(ObClient *client, ObClient *sibling)
+{
+    GList *it;
+    gboolean occludes = FALSE;
+    gboolean found = FALSE;
+
+    /* no need for any looping in this case */
+    if (sibling && client->layer != sibling->layer)
+        return occludes;
+
+    for (it = stacking_list; it; it = g_list_next(it))
+        if (WINDOW_IS_CLIENT(it->data)) {
+            ObClient *c = it->data;
+            if (found && !c->iconic &&
+                (c->desktop == DESKTOP_ALL || client->desktop == DESKTOP_ALL ||
+                 c->desktop == client->desktop) &&
+                !client_search_transient(c, client))
+            {
+                if (RECT_INTERSECTS_RECT(c->frame->area, client->frame->area))
+                {
+                    if (sibling != NULL) {
+                        if (c == sibling) {
+                            occludes = TRUE;
+                            break;
+                        }
+                    }
+                    else if (c->layer == client->layer) {
+                        occludes = TRUE;
+                        break;
+                    }
+                    else if (c->layer < client->layer)
+                        break; /* we past its layer */
+                }
+            }
+            else if (c == client)
+                found = TRUE;
         }
+    return occludes;
+}
+
+gboolean stacking_restack_request(ObClient *client, ObClient *sibling,
+                                  gint detail)
+{
+    gboolean ret = FALSE;
+
+    if (sibling && ((client->desktop != sibling->desktop &&
+                     client->desktop != DESKTOP_ALL &&
+                     sibling->desktop != DESKTOP_ALL) ||
+                    sibling->iconic))
+    {
+        ob_debug("Setting restack sibling to NULL, they are not on the same "
+                 "desktop or it is iconified\n");
+        sibling = NULL;
     }
-    if (!it_before) {
-        /* out of ideas, just add it normally... */
-        stacking_add(win);
-    } else {
-        GList *wins = g_list_append(NULL, win);
-        do_restack(wins, it_before);
-        g_list_free(wins);
+
+    switch (detail) {
+    case Below:
+        ob_debug("Restack request Below for client %s sibling %s\n",
+                 client->title, sibling ? sibling->title : "(all)");
+        /* just lower it */
+        stacking_lower(CLIENT_AS_WINDOW(client));
+        ret = TRUE;
+        break;
+    case BottomIf:
+        ob_debug("Restack request BottomIf for client %s sibling "
+                 "%s\n",
+                 client->title, sibling ? sibling->title : "(all)");
+        /* if this client occludes sibling (or anything if NULL), then
+           lower it to the bottom */
+        if (stacking_occludes(client, sibling)) {
+            stacking_lower(CLIENT_AS_WINDOW(client));
+            ret = TRUE;
+        }
+        break;
+    case Above:
+        ob_debug("Restack request Above for client %s sibling %s\n",
+                 client->title, sibling ? sibling->title : "(all)");
+        stacking_raise(CLIENT_AS_WINDOW(client));
+        ret = TRUE;
+        break;
+    case TopIf:
+        ob_debug("Restack request TopIf for client %s sibling %s\n",
+                 client->title, sibling ? sibling->title : "(all)");
+        if (stacking_occluded(client, sibling)) {
+            stacking_raise(CLIENT_AS_WINDOW(client));
+            ret = TRUE;
+        }
+        break;
+    case Opposite:
+        ob_debug("Restack request Opposite for client %s sibling "
+                 "%s\n",
+                 client->title, sibling ? sibling->title : "(all)");
+        if (stacking_occluded(client, sibling)) {
+            stacking_raise(CLIENT_AS_WINDOW(client));
+            ret = TRUE;
+        }
+        else if (stacking_occludes(client, sibling)) {
+            stacking_lower(CLIENT_AS_WINDOW(client));
+            ret = TRUE;
+        }
+        break;
     }
+    return ret;
 }