Merge pull request #3448 from orestisf1993/sticky

Fix sticky focus when switching to workspace on different output

include/output.h

@@ -40,5 +40,12 @@ Output *get_output_for_con(Con *con);
  * Iterates over all outputs and pushes sticky windows to the currently visible
  * workspace on that output.
  *
+ * old_focus is used to determine if a sticky window is going to be focused.
+ * old_focus might be different than the currently focused container because the
+ * caller might need to temporarily change the focus and then call
+ * output_push_sticky_windows. For example, workspace_show needs to set focus to
+ * one of its descendants first, then call output_push_sticky_windows that
+ * should focus a sticky window if it was the focused in the previous workspace.
+ *
  */
-void output_push_sticky_windows(Con *to_focus);
+void output_push_sticky_windows(Con *old_focus);

src/output.c

@@ -72,8 +72,15 @@ Output *get_output_for_con(Con *con) {
  * Iterates over all outputs and pushes sticky windows to the currently visible
  * workspace on that output.
  *
+ * old_focus is used to determine if a sticky window is going to be focused.
+ * old_focus might be different than the currently focused container because the
+ * caller might need to temporarily change the focus and then call
+ * output_push_sticky_windows. For example, workspace_show needs to set focus to
+ * one of its descendants first, then call output_push_sticky_windows that
+ * should focus a sticky window if it was the focused in the previous workspace.
+ *
  */
-void output_push_sticky_windows(Con *to_focus) {
+void output_push_sticky_windows(Con *old_focus) {
     Con *output;
     TAILQ_FOREACH(output, &(croot->focus_head), focused) {
         Con *workspace, *visible_ws = NULL;
@@ -95,18 +102,17 @@ void output_push_sticky_windows(Con *to_focus) {
                  child != TAILQ_END(&(current_ws->focus_head));) {
                 Con *current = child;
                 child = TAILQ_NEXT(child, focused);
-                if (current->type != CT_FLOATING_CON)
+                if (current->type != CT_FLOATING_CON || !con_is_sticky(current)) {
                     continue;
+                }
 
-                if (con_is_sticky(current)) {
+                bool ignore_focus = (old_focus == NULL) || (current != old_focus->parent);
-                    bool ignore_focus = (to_focus == NULL) || (current != to_focus->parent);
+                con_move_to_workspace(current, visible_ws, true, false, ignore_focus);
-                    con_move_to_workspace(current, visible_ws, true, false, ignore_focus);
+                if (!ignore_focus) {
-                    if (!ignore_focus) {
+                    Con *current_ws = con_get_workspace(focused);
-                        Con *current_ws = con_get_workspace(focused);
+                    con_activate(con_descend_focused(current));
-                        con_activate(con_descend_focused(current));
+                    /* Pushing sticky windows shouldn't change the focused workspace. */
-                        /* Pushing sticky windows shouldn't change the focused workspace. */
+                    con_activate(con_descend_focused(current_ws));
-                        con_activate(con_descend_focused(current_ws));
-                    }
                 }
             }
         }

src/workspace.c

@@ -410,7 +410,6 @@ static void workspace_defer_update_urgent_hint_cb(EV_P_ ev_timer *w, int revents
  */
 void workspace_show(Con *workspace) {
     Con *current, *old = NULL;
-    Con *old_focus = focused;
 
     /* safe-guard against showing i3-internal workspaces like __i3_scratch */
     if (con_is_internal(workspace))
@@ -433,6 +432,13 @@ void workspace_show(Con *workspace) {
         return;
     }
 
+    /* Used to correctly update focus when pushing sticky windows. Holds the
+     * previously focused container in the same output as workspace. For
+     * example, if a sticky window is focused and then we switch focus to a
+     * workspace in another output and then switch to a third workspace in the
+     * first output, the sticky window needs to be refocused. */
+    Con *old_focus = old ? con_descend_focused(old) : NULL;
+
     /* Remember currently focused workspace for switching back to it later with
      * the 'workspace back_and_forth' command.
      * NOTE: We have to duplicate the name as the original will be freed when

testcases/t/285-sticky.t

@@ -16,7 +16,14 @@
 #
 # Tests sticky windows.
 # Ticket: #1455
-use i3test;
+use i3test i3_config => <<EOT;
+# i3 config file (v4)
+font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
+
+workspace ws-on-0 output fake-0
+
+fake-outputs 1024x768+0+0,1024x768+1024+0
+EOT
 
 my ($ws, $tmp, $focused);
 
@@ -25,41 +32,41 @@ my ($ws, $tmp, $focused);
 #    nothing happens.
 ###############################################################################
 fresh_workspace;
-open_window(wm_class => 'findme');
+open_window;
 cmd 'sticky enable';
 $ws = fresh_workspace;
 
 is(@{get_ws($ws)->{nodes}}, 0, 'tiling sticky container did not move');
 is(@{get_ws($ws)->{floating_nodes}}, 0, 'tiling sticky container did not move');
-cmd '[class="findme"] kill';
+kill_all_windows;
 
 ###############################################################################
 # 2: Given a sticky floating container, when the workspace is switched, then
 #    the container moves to the new workspace.
 ###############################################################################
 $ws = fresh_workspace;
-open_floating_window(wm_class => 'findme');
+open_floating_window;
 $focused = get_focused($ws);
 cmd 'sticky enable';
 $ws = fresh_workspace;
 
 is(@{get_ws($ws)->{floating_nodes}}, 1, 'floating sticky container moved to new workspace');
 is(get_focused($ws), $focused, 'sticky container has focus');
-cmd '[class="findme"] kill';
+kill_all_windows;
 
 ###############################################################################
 # 3: Given two sticky floating containers, when the workspace is switched,
 #    then both containers move to the new workspace.
 ###############################################################################
 fresh_workspace;
-open_floating_window(wm_class => 'findme');
+open_floating_window;
 cmd 'sticky enable';
-open_floating_window(wm_class => 'findme');
+open_floating_window;
 cmd 'sticky enable';
 $ws = fresh_workspace;
 
 is(@{get_ws($ws)->{floating_nodes}}, 2, 'multiple sticky windows can be used at the same time');
-cmd '[class="findme"] kill';
+kill_all_windows;
 
 ###############################################################################
 # 4: Given an unfocused sticky floating container and a tiling container on the
@@ -70,13 +77,13 @@ $ws = fresh_workspace;
 open_window;
 $focused = get_focused($ws);
 fresh_workspace;
-open_floating_window(wm_class => 'findme');
+open_floating_window;
 cmd 'sticky enable';
 open_window;
 cmd 'workspace ' . $ws;
 
 is(get_focused($ws), $focused, 'the tiling container has focus');
-cmd '[class="findme"] kill';
+kill_all_windows;
 
 ###############################################################################
 # 5: Given a focused sticky floating container and a tiling container on the
@@ -86,13 +93,13 @@ cmd '[class="findme"] kill';
 $ws = fresh_workspace;
 open_window;
 $tmp = fresh_workspace;
-open_floating_window(wm_class => 'findme');
+open_floating_window;
 $focused = get_focused($tmp);
 cmd 'sticky enable';
 cmd 'workspace ' . $ws;
 
 is(get_focused($ws), $focused, 'the sticky container has focus');
-cmd '[class="findme"] kill';
+kill_all_windows;
 
 ###############################################################################
 # 6: Given a floating container on a non-visible workspace, when the window
@@ -100,13 +107,31 @@ cmd '[class="findme"] kill';
 #    visible workspace.
 ###############################################################################
 fresh_workspace;
-open_floating_window(wm_class => 'findme');
+open_floating_window;
 cmd 'mark sticky';
 $ws = fresh_workspace;
 cmd '[con_mark=sticky] sticky enable';
 
 is(@{get_ws($ws)->{floating_nodes}}, 1, 'the sticky window jumps to the front');
-cmd '[class="findme"] kill';
+kill_all_windows;
+
+###############################################################################
+# 7: Given a sticky floating container and a workspace on another output, when
+#    a new workspace assigned to the first output is focused, then the sticky
+#    container should jump to the new workspace and have input focus correctly.
+###############################################################################
+$ws = fresh_workspace(output => 0);
+open_floating_window;
+cmd 'sticky enabled';
+$focused = get_focused($ws);
+$ws = fresh_workspace(output => 1);
+
+is(@{get_ws($ws)->{floating_nodes}}, 0, 'the sticky window didn\'t jump to a workspace on a different output');
+$ws = 'ws-on-0';
+cmd "workspace $ws";
+is(@{get_ws($ws)->{floating_nodes}}, 1, 'the sticky window moved to new workspace on first output');
+is(get_focused($ws), $focused, 'the sticky window has focus');
+kill_all_windows;
 
 ###############################################################################