Merge lp:~aacid/unity-2d/unity-2d_backport_shell_r934 into lp:unity-2d

[Albert Astals Cid]

[launcher] launcher pips indicate whether application windows belongs to current workspace or not

Backport from r934 of unity-2d-shell

[Albert Astals Cid (aacid)]

This was already MR'ed in https://code.launchpad.net/~unity-2d-team/unity-2d/update-launcher-pips-shell/+merge/89679

[Michał Sawicz (saviq)]

We're missing "launcher/artwork/launcher_arrow_outline_ltr.png" here

review: Needs Fixing

[Albert Astals Cid (aacid)]

Added

[Michał Sawicz (saviq)]

Please fix the paths to the images in both LauncherList.qml and the tests, and also please add a FIXME about converting these tests to visual ones.

review: Needs Fixing

[Albert Astals Cid (aacid)]

Done

[Unity Merger (unity-merger)]

There are additional revisions which have not been approved in review. Please seek review and approval of these new revisions.

[Unity Merger (unity-merger)]

Attempt to merge into lp:unity-2d failed due to conflicts:

text conflict in libunity-2d-private/src/unity2ddeclarativeview.h

[lp:~aacid/unity-2d/unity-2d_backport_shell_r934]

890. By Albert Astals Cid on 2012-02-03

merge

=== modified file 'launcher/LauncherItem.qml'
--- launcher/LauncherItem.qml	2011-12-21 09:52:15 +0000
+++ launcher/LauncherItem.qml	2012-02-03 21:02:20 +0000
@@ -156,7 +156,7 @@
         Repeater {
             model: item.pips
             delegate: Image {
-                objectName: "pips"
+                objectName: "pips-" + index
                 /* FIXME: It seems that when the image is created (or re-used) by the Repeater
                    for a moment it doesn't have any parent, and therefore warnings are
                    printed for the following two anchor assignements. This fixes the

=== modified file 'launcher/LauncherList.qml'
--- launcher/LauncherList.qml	2011-12-21 09:52:15 +0000
+++ launcher/LauncherList.qml	2012-02-03 21:02:20 +0000
@@ -89,6 +89,16 @@
             }
         }
 
+        function updatePips() {
+            if (item.belongsToDifferentWorkspace()) {
+                launcherItem.pips = 1
+                launcherItem.pipSource = "artwork/launcher_arrow_outline_ltr.png";
+            } else {
+                launcherItem.pips = Math.min(item.windowCount, 3)
+                launcherItem.pipSource = ("artwork/launcher_" + ((pips <= 1) ? "arrow" : "pip") + "_ltr.png")
+            }
+        }
+
         Accessible.name: accessibleDescription()
         name: item.name
 
@@ -275,7 +285,10 @@
             PropertyAction { target: launcherItem; property: "ListView.delayRemove"; value: false }
         }
 
-        onRunningChanged: setIconGeometry()
+        onRunningChanged: {
+            setIconGeometry()
+            item.connectWindowSignals()
+        }
         /* Note: this doesn’t work as expected for the first favorite
            application in the list if it is already running when the
            launcher is started, because its y property doesn’t change.
@@ -286,6 +299,8 @@
         Connections {
             target: item
             onWindowAdded: item.setIconGeometry(x + panel.x, y + panel.y, width, height, xid)
+            onWindowCountChanged: updatePips()
+            onWindowWorkspaceChanged: updatePips()
             /* Not all items are applications. */
             ignoreUnknownSignals: true
         }
@@ -328,5 +343,11 @@
                 }
             }
         }
+
+        Connections {
+            target: declarativeView
+            onActiveWorkspaceChanged: updatePips()
+        }
+        Component.onCompleted: updatePips()
     }
 }

=== added file 'launcher/artwork/launcher_arrow_outline_ltr.png'
Binary files launcher/artwork/launcher_arrow_outline_ltr.png	1970-01-01 00:00:00 +0000 and launcher/artwork/launcher_arrow_outline_ltr.png	2012-02-03 21:02:20 +0000 differ
=== modified file 'libunity-2d-private/src/launcherapplication.cpp'
--- libunity-2d-private/src/launcherapplication.cpp	2012-02-01 13:13:07 +0000
+++ libunity-2d-private/src/launcherapplication.cpp	2012-02-03 21:02:20 +0000
@@ -507,10 +507,36 @@
 }
 
 void
+LauncherApplication::connectWindowSignals()
+{
+    if (m_application == NULL || m_application->running() == false) {
+        return;
+    }
+
+    QScopedPointer<BamfUintList> xids(m_application->xids());
+    int size = xids->size();
+    if (size < 1) {
+        return;
+    }
+
+    WnckScreen* screen = wnck_screen_get_default();
+    wnck_screen_force_update(screen);
+
+    for (int i = 0; i < size; ++i) {
+        WnckWindow* window = wnck_window_get(xids->at(i));
+        g_signal_connect(G_OBJECT(window), "workspace-changed",
+            G_CALLBACK(LauncherApplication::onWindowWorkspaceChanged), this);
+    }
+}
+
+void
 LauncherApplication::onWindowAdded(BamfWindow* window)
 {
     if (window != NULL) {
         windowAdded(window->xid());
+        WnckWindow* wnck_window = wnck_window_get(window->xid());
+        g_signal_connect(G_OBJECT(wnck_window), "workspace-changed",
+             G_CALLBACK(LauncherApplication::onWindowWorkspaceChanged), this);
     }
 }
 
@@ -601,6 +627,11 @@
 LauncherApplication::windowCountOnCurrentWorkspace()
 {
     int windowCount = 0;
+
+    if (!m_application) {
+        return windowCount;
+    }
+
     WnckWorkspace *current = wnck_screen_get_active_workspace(wnck_screen_get_default());
 
     QScopedPointer<BamfWindowList> windows(m_application->windows());
@@ -622,9 +653,13 @@
             }
         }
 
-        WnckWorkspace *workspace = wnck_window_get_workspace(wnck_window);
-        if (workspace == current) {
+        if (wnck_window_is_pinned(wnck_window)) {
             windowCount++;
+        } else {
+            WnckWorkspace *workspace = wnck_window_get_workspace(wnck_window);
+            if (workspace == current) {
+                windowCount++;
+            }
         }
     }
     return windowCount;
@@ -939,6 +974,18 @@
     } 
 }
 
+bool
+LauncherApplication::belongsToDifferentWorkspace()
+{
+    int totalWindows = windowCount();
+    int windowsInCurrentWorkspace = windowCountOnCurrentWorkspace();
+    if (totalWindows > 0 && windowsInCurrentWorkspace == 0) {
+        return true;
+    }
+
+    return false;
+}
+
 void
 LauncherApplication::onIndicatorMenuUpdated()
 {
@@ -1056,6 +1103,13 @@
 }
 
 void
+LauncherApplication::onWindowWorkspaceChanged(WnckWindow *window, gpointer user_data)
+{
+    Q_UNUSED(window);
+    ((LauncherApplication*)user_data)->windowWorkspaceChanged();
+}
+
+void
 LauncherApplication::onDragEnter(DeclarativeDragDropEvent* event)
 {
     QList<QUrl> urls = validateUrisForLaunch(event->mimeData());

=== modified file 'libunity-2d-private/src/launcherapplication.h'
--- libunity-2d-private/src/launcherapplication.h	2012-01-27 06:26:14 +0000
+++ libunity-2d-private/src/launcherapplication.h	2012-02-03 21:02:20 +0000
@@ -104,6 +104,8 @@
     Q_INVOKABLE virtual void launchNewInstance();
 
     Q_INVOKABLE virtual void createMenuActions();
+    Q_INVOKABLE virtual bool belongsToDifferentWorkspace();
+    Q_INVOKABLE void connectWindowSignals();
 
     void updateOverlaysState(const QString& sender, const QMap<QString, QVariant>& properties);
 
@@ -179,6 +181,8 @@
     QList<QUrl> validateUrisForLaunch(DeclarativeMimeData* mimedata);
     QStringList supportedTypes();
 
+    static void onWindowWorkspaceChanged(WnckWindow *window, gpointer user_data);
+
     QString m_dynamicQuicklistPath;
     QScopedPointer<DBusMenuImporter> m_dynamicQuicklistImporter;
     QDBusServiceWatcher* m_dynamicQuicklistServiceWatcher;

=== modified file 'libunity-2d-private/src/launcheritem.cpp'
--- libunity-2d-private/src/launcheritem.cpp	2011-07-29 13:49:34 +0000
+++ libunity-2d-private/src/launcheritem.cpp	2012-02-03 21:02:20 +0000
@@ -87,6 +87,12 @@
 }
 
 bool
+LauncherItem::belongsToDifferentWorkspace()
+{
+    return false;
+}
+
+bool
 LauncherItem::progressBarVisible() const
 {
     return false;

=== modified file 'libunity-2d-private/src/launcheritem.h'
--- libunity-2d-private/src/launcheritem.h	2011-07-29 13:49:34 +0000
+++ libunity-2d-private/src/launcheritem.h	2012-02-03 21:02:20 +0000
@@ -79,6 +79,7 @@
     Q_INVOKABLE virtual void activate() = 0;
     Q_INVOKABLE virtual void createMenuActions() = 0;
     Q_INVOKABLE virtual void launchNewInstance();
+    Q_INVOKABLE virtual bool belongsToDifferentWorkspace();
 
 protected:
     LauncherContextualMenu* m_menu;
@@ -100,6 +101,7 @@
     void counterChanged(int);
     void emblemVisibleChanged(bool);
     void emblemChanged(QString);
+    void windowWorkspaceChanged();
 
 public Q_SLOTS:
     /* Default implementation of drag’n’drop handling, should be overridden in

=== modified file 'libunity-2d-private/src/unity2ddeclarativeview.cpp'
--- libunity-2d-private/src/unity2ddeclarativeview.cpp	2012-02-03 12:09:19 +0000
+++ libunity-2d-private/src/unity2ddeclarativeview.cpp	2012-02-03 21:02:20 +0000
@@ -275,6 +275,7 @@
 void Unity2DDeclarativeView::onActiveWorkspaceChanged() 
 {
     m_last_focused_window = None;
+    Q_EMIT activeWorkspaceChanged();
 }
 
 #include <unity2ddeclarativeview.moc>

=== modified file 'libunity-2d-private/src/unity2ddeclarativeview.h'
--- libunity-2d-private/src/unity2ddeclarativeview.h	2012-02-03 12:09:19 +0000
+++ libunity-2d-private/src/unity2ddeclarativeview.h	2012-02-03 21:02:20 +0000
@@ -46,6 +46,7 @@
     void transparentBackgroundChanged(bool);
     void globalPositionChanged(QPoint);
     void visibleChanged(bool);
+    void activeWorkspaceChanged();
 
 protected:
     void setupViewport();

=== added file 'tests/launcher/update_pips_tests.rb'
--- tests/launcher/update_pips_tests.rb	1970-01-01 00:00:00 +0000
+++ tests/launcher/update_pips_tests.rb	2012-02-03 21:02:20 +0000
@@ -0,0 +1,316 @@
+#!/usr/bin/env ruby1.8
+=begin
+/*
+ * This file is part of unity-2d
+ *
+ * Copyright 2011 Canonical Ltd.
+ *
+ * Authors:
+ * - Lohith DS <[e-mail]>
+ *
+ * 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; version 3.
+ *
+ * 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.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+=end
+
+require '../run-tests.rb' unless $INIT_COMPLETED
+require 'xdo/xwindow'
+require 'xdo/keyboard'
+require 'xdo/mouse'
+require 'timeout'
+require 'tmpdir'
+
+def open_window()
+    # FIXME : Need to choose a better test application in future?
+    window_id = -1
+    o =  [('a'..'z'),('A'..'Z')].map{|i| i.to_a}.flatten;
+    title_string  =  (0..50).map{ o[rand(o.length)]  }.join;
+    if (@@title_string.empty?)
+        @@title_string = title_string
+    end
+    # Open xman with random title
+    $SUT.execute_shell_command("xman -geometry 300x90+100+100 -title #{title_string}", :detached => true)
+    Timeout.timeout(30){ window_id = XDo::XWindow.wait_for_window(title_string)}
+    Kernel.raise(SystemCallError, "Unable to open xman") if window_id == -1
+    return XDo::XWindow.new(window_id)
+end
+
+def change_window_workspace(xid)
+    new_workspace = 0
+    if xid.desktop > 0
+        new_workspace=0
+    else
+        new_workspace=1
+    end
+
+    xid.desktop=new_workspace
+    verify_true(3, 'Change window workspace failed') {
+        xid.desktop==new_workspace
+    }
+end
+
+def reset_current_workspace
+    XDo::XWindow.desktop=@@current_workspace
+    verify_true(TIMEOUT, 'Reset active workspace failed') {
+        XDo::XWindow.desktop==@@current_workspace
+    }
+end
+
+def change_user_workspace
+    new_workspace = 0
+    if @@current_workspace > 0
+        new_workspace = 0
+    else
+        new_workspace = 1
+    end
+
+    XDo::XWindow.desktop=new_workspace
+    verify_true(TIMEOUT, 'Change user workspace failed') {
+        XDo::XWindow.desktop==new_workspace
+    }
+end
+
+def close_all_test_windows
+    @@xid_list.each {
+        |xid|
+        if (xid.exists?)
+            xid.close!
+        end
+    }
+end
+
+############################# Test Suite #############################
+context "Launcher pips tests" do
+  # Run once at the beginning of this test suite
+  startup do
+    $SUT.execute_shell_command 'killall unity-2d-launcher'
+    $SUT.execute_shell_command 'killall unity-2d-launcher'
+
+    # Minimize all windows
+    XDo::XWindow.toggle_minimize_all
+
+    @number_of_workspaces = XDo::XWindow.desktop_num
+    @reset_num_workspaces = false
+    if @number_of_workspaces < 2
+        # Setting number of workspaces to minimum(two) to enable the test suite
+        XDo::XWindow.desktop_num = 2
+        @reset_num_workspaces = true
+    end
+
+    $SUT.execute_shell_command 'killall xman'
+    @@current_workspace = XDo::XWindow.desktop
+    @@xid_list=Array.new
+
+  end
+  
+  # Run once at the end of this test suite
+  shutdown do
+    if @reset_num_workspaces == true
+        # Resetting number of workspaces to " + @number_of_workspaces.to_s
+        XDo::XWindow.desktop_num=@number_of_workspaces
+    end
+  end
+
+  # Run before each test case begins
+  setup do
+    # Execute the application 
+    @app = $SUT.run( :name => UNITY_2D_LAUNCHER,
+    		         :arguments => "-testability", 
+    		         :sleeptime => 2 )
+    @@title_string = ""
+  end
+
+  # Run after each test case completes
+  teardown do
+    close_all_test_windows
+    reset_current_workspace
+    system "pkill -nf unity-2d-launcher"
+  end
+
+    #####################################################################################
+    # Test cases
+
+    # FIXME We need some visual tests for this too
+
+    # Test case objectives:
+    #   * Check pips are updated properly when the app is in current workspace
+    # Pre-conditions
+    #   * This test case assumes that the test app will have only one window
+    #   * For eg, xman is choosen
+    #   * To ensure there is no xman windows running, kill all the xman windows if any
+    # Test steps
+    #   * Open a xman window
+    #   * Verify the launcher tile pip image matches with the expected one
+    # Post-conditions
+    #   * None
+    # References
+    #   * lp:#883172
+    test "Check pips are updated properly when the app is in current workspace" do
+        xid = open_window()
+        @@xid_list << xid
+
+        expected_pip_image = 'image://blended/artwork/launcher_arrow_ltr.pngcolor=lightgreyalpha=1'
+
+        verify_equal(expected_pip_image, TIMEOUT, 'pip not matching with launcher_arrow_ltr.png'){
+             @app.Unity2dPanel() \
+            .LauncherList( :name => 'main' ) \
+            .QDeclarativeItem( :name => @@title_string ) \
+            .QDeclarativeImage( :name => 'pips-0')['source']
+        }
+    end
+
+
+    # Test case objectives:
+    #   * Check pips are updated properly when the app is moved to different workspace
+    # Pre-conditions
+    #   * None
+    # Test steps
+    #   * Move the window to a different workspace
+    #   * Verify the launcher tile pip image matches with the expected one
+    # Post-conditions
+    #   * None
+    # References
+    #   * lp:#883172
+    test "Check pips are updated properly when the app is moved to different workspace" do
+        xid = open_window()
+        @@xid_list << xid
+
+        change_window_workspace(xid)
+
+        expected_pip_image = 'image://blended/artwork/launcher_arrow_outline_ltr.pngcolor=lightgreyalpha=1'
+
+        verify_equal(expected_pip_image, TIMEOUT, 'pip not matching with launcher_arrow_outline_ltr.png'){
+             @app.Unity2dPanel() \
+            .LauncherList( :name => 'main' ) \
+            .QDeclarativeItem( :name => @@title_string ) \
+            .QDeclarativeImage( :name => 'pips-0')['source']
+        }
+    end
+
+
+    # Test case objectives:
+    #   * Check launcher pips to indicate an app with two windows each on two different workspaces
+    # Pre-conditions
+    #   * None
+    # Test steps
+    #   * Open another window along with first window from the first testcase.
+    #   * Verify the launcher tile pip images matches with the expected one
+    # Post-conditions
+    #   * None
+    # References
+    #   * lp:#883172
+    test "Check launcher pips to indicate an app with two windows each on two different workspaces" do
+        xid = open_window()
+        @@xid_list << xid
+        xid = open_window()
+        @@xid_list << xid
+
+        expected_pip_image = 'image://blended/artwork/launcher_pip_ltr.pngcolor=lightgreyalpha=1'
+
+        verify_equal(expected_pip_image, TIMEOUT, 'Pip not matching expected image launcher_pip_ltr.png'){
+             @app.Unity2dPanel() \
+            .LauncherList( :name => 'main' ) \
+            .QDeclarativeItem( :name => @@title_string ) \
+            .QDeclarativeImage( :name => 'pips-0')['source']
+        }
+    end
+
+
+    # Test case objectives:
+    #   * Check launcher pips to indicate an app completely belonging to different workspace
+    # Pre-conditions
+    #   * None
+    # Test steps
+    #   * Move the second window too to a different workspace
+    #   * Verify the launcher tile pip image matches with the expected one
+    # Post-conditions
+    #   * None
+    # References
+    #   * lp:#883172
+    test "Check launcher pips to indicate an app completely belonging to different workspace" do
+        xid = open_window()
+        @@xid_list << xid
+        change_window_workspace(xid)
+
+        xid = open_window()
+        @@xid_list << xid
+        change_window_workspace(xid)
+
+        expected_pip_image = 'image://blended/artwork/launcher_arrow_outline_ltr.pngcolor=lightgreyalpha=1'
+
+        verify_equal(expected_pip_image, TIMEOUT, 'pip not matching expected image launcher_arrow_outline_ltr.png'){
+             @app.Unity2dPanel() \
+            .LauncherList( :name => 'main' ) \
+            .QDeclarativeItem( :name => @@title_string ) \
+            .QDeclarativeImage( :name => 'pips-0')['source']
+        }
+    end
+
+
+    # Test case objectives:
+    #   * Check launcher pips when an app window is closed.
+    # Pre-conditions
+    #   * None
+    # Test steps
+    #   * Close one of the app windows and move the last window back to its original workspace
+    #   * Verify the launcher tile pip image matches with the expected one
+    # Post-conditions
+    #   * None
+    # References
+    #   * lp:#883172
+    test "Check launcher pips when an app window is closed" do
+        xid = open_window()
+        @@xid_list << xid
+        xid = open_window()
+        @@xid_list << xid
+
+        xid.close!
+        change_window_workspace(@@xid_list[0])
+
+        expected_pip_image = 'image://blended/artwork/launcher_arrow_outline_ltr.pngcolor=lightgreyalpha=1'
+
+        verify_equal(expected_pip_image, TIMEOUT, 'pip not matching expected image launcher_arrow_outline_ltr.png'){
+             @app.Unity2dPanel() \
+            .LauncherList( :name => 'main' ) \
+            .QDeclarativeItem( :name => @@title_string ) \
+            .QDeclarativeImage( :name => 'pips-0')['source']
+        }
+    end
+
+
+    # Test case objectives:
+    #   * Check launcher pips to indicate when the user workspace changed
+    # Pre-conditions
+    #   * None
+    # Test steps
+    #   * Change the user workspace to other than app workspace
+    #   * Verify that the pips are updated properly
+    # Post-conditions
+    #   * None
+    # References
+    #   * lp:#883172
+    test "Check launcher pips to indicate when the user workspace changed" do
+        xid = open_window()
+        @@xid_list << xid
+
+        change_user_workspace
+
+        expected_pip_image = 'image://blended/artwork/launcher_arrow_outline_ltr.pngcolor=lightgreyalpha=1'
+
+        verify_equal(expected_pip_image, TIMEOUT, 'pip not matching expected image launcher_arrow_outline_ltr.png'){
+             @app.Unity2dPanel() \
+            .LauncherList( :name => 'main' ) \
+            .QDeclarativeItem( :name => @@title_string ) \
+            .QDeclarativeImage( :name => 'pips-0')['source']
+        }
+    end
+end