Merge lp:~zsombi/ubuntu-ui-toolkit/theme-paths into lp:ubuntu-ui-toolkit

[Zsombor Egri]

Support for taking themes from XDG_DATA_DIRS as well as from ~/.local/share. These paths are also added as import paths. UBUNTU_UI_TOOLKIT_THEMES_PATH overrules these import paths, and can have more than one path specified, each separated with column.

[Zsombor Egri (zsombi)]

I had to resubmit the previous MP as that got completely messed.
Support for XDG_CONFIG_DIRS removed as not being required at all (see Scott Sweeny (ssweeny) wrote on 2013-10-04 on the bug).

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:793
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/951/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-saucy-vm/364
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-touch/2826
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-ci/808
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/808
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/808/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-vm-saucy/269
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-i386/4512
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-i386/4512/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-armhf/2828
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-armhf/2828/artifact/work/output/*zip*/output.zip
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-maguro/2351
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/2391

Click here to trigger a rebuild:
http://10.97.0.26:8080/job/ubuntu-ui-toolkit-ci/951/rebuild

review: Needs Fixing (continuous-integration)

[Cris Dywan (kalikiana)]

Nice stuff.

Seems like the MR is failing on unrelated stuff, also runs fine for me locally.

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-autolanding/375/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-saucy-vm/410
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-touch/3035/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-autolanding/302
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-autolanding/301
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-autolanding/301/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-vm-saucy/307
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-i386/4558
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-i386/4558/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-armhf/3037
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-armhf/3037/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-maguro/2542/console
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/2593
    SUCCESS: http://10.97.0.26:8080/job/touch-flash-device/110
    SUCCESS: http://10.97.0.26:8080/job/touch-flash-device/111

review: Needs Fixing (continuous-integration)

[lp:~zsombi/ubuntu-ui-toolkit/theme-paths]

794. By Zsombor Egri on 2013-10-21

trunk merge

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:794
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/1017/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-saucy-vm/445
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-touch/3085
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-ci/874
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/874
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/874/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-vm-saucy/334
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-i386/4593
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-i386/4593/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-armhf/3087
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-armhf/3087/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-maguro/2580
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/2631
    SUCCESS: http://10.97.0.26:8080/job/touch-flash-device/191
    SUCCESS: http://10.97.0.26:8080/job/touch-flash-device/190

Click here to trigger a rebuild:
http://10.97.0.26:8080/job/ubuntu-ui-toolkit-ci/1017/rebuild

review: Approve (continuous-integration)

=== modified file 'modules/Ubuntu/Components/plugin/uctheme.cpp'
--- modules/Ubuntu/Components/plugin/uctheme.cpp	2013-09-09 08:03:42 +0000
+++ modules/Ubuntu/Components/plugin/uctheme.cpp	2013-10-21 08:57:44 +0000
@@ -20,6 +20,7 @@
 #include "uctheme.h"
 #include "listener.h"
 #include "quickutils.h"
+#include "i18n.h"
 
 #include <QtQml/qqml.h>
 #include <QtQml/QQmlEngine>
@@ -69,11 +70,34 @@
 
 const QString THEME_FOLDER_FORMAT("%1/%2/");
 const QString PARENT_THEME_FILE("parent_theme");
+const char *ENV_PATH = "UBUNTU_UI_TOOLKIT_THEMES_PATH";
+
+QStringList themeSearchPath() {
+    QString envPath = QLatin1String(getenv("UBUNTU_UI_TOOLKIT_THEMES_PATH"));
+    QStringList pathList = envPath.split(':', QString::SkipEmptyParts);
+    if (pathList.isEmpty()) {
+        // get the default path list from generic data location, which contains
+        // ~/.local/share and XDG_DATA_DIRS
+        pathList << QStandardPaths::standardLocations(QStandardPaths::GenericDataLocation);
+    }
+    // fix folders
+    QStringList result;
+    Q_FOREACH(const QString &path, pathList) {
+        if (QDir(path).exists()) {
+            result << path + '/';
+        }
+    }
+    // append standard QML2_IMPORT_PATH value
+    result << QLibraryInfo::location(QLibraryInfo::Qml2ImportsPath);
+    return result;
+}
 
 UCTheme::UCTheme(QObject *parent) :
     QObject(parent),
     m_name(""),
-    m_palette(NULL)
+    m_palette(NULL),
+    m_engine(NULL),
+    m_engineUpdated(false)
 {
     m_name = m_themeSettings.themeName();
     QObject::connect(&m_themeSettings, &UCThemeSettings::themeNameChanged,
@@ -85,6 +109,21 @@
                      this, &UCTheme::loadPalette, Qt::UniqueConnection);
 }
 
+void UCTheme::updateEnginePaths()
+{
+    if (!m_engine || m_engineUpdated) {
+        return;
+    }
+
+    QStringList paths = themeSearchPath();
+    Q_FOREACH(const QString &path, paths) {
+        if (QDir(path).exists()) {
+            m_engine->addImportPath(path);
+        }
+    }
+    m_engineUpdated = true;
+}
+
 void UCTheme::onThemeNameChanged()
 {
     if (m_themeSettings.themeName() != m_name) {
@@ -96,15 +135,17 @@
 
 QUrl UCTheme::pathFromThemeName(QString themeName)
 {
-    QString themesPath = QLatin1String(getenv("UBUNTU_UI_TOOLKIT_THEMES_PATH"));
-    if (themesPath.isEmpty()) {
-        themesPath = QLibraryInfo::location(QLibraryInfo::Qml2ImportsPath);
+    themeName.replace('.', '/');
+    QStringList pathList = themeSearchPath();
+    Q_FOREACH(const QString &path, pathList) {
+        QString themeFolder = THEME_FOLDER_FORMAT.arg(path, themeName);
+        // QUrl needs a trailing slash to understand it's a directory
+        QString absoluteThemeFolder = QDir(themeFolder).absolutePath().append('/');
+        if (QDir(absoluteThemeFolder).exists()) {
+            return QUrl::fromLocalFile(absoluteThemeFolder);
+        }
     }
-
-    QString themeFolder = THEME_FOLDER_FORMAT.arg(themesPath, themeName.replace('.', '/'));
-    QString absoluteThemeFolder = QDir(themeFolder).absolutePath();
-    // QUrl needs a trailing slash to understand it's a directory
-    return QUrl::fromLocalFile(absoluteThemeFolder.append("/"));
+    return QUrl();
 }
 
 void UCTheme::updateThemePaths()
@@ -114,7 +155,9 @@
     QString themeName = m_name;
     while (!themeName.isEmpty()) {
         QUrl themePath = pathFromThemeName(themeName);
-        m_themePaths.append(themePath);
+        if (themePath.isValid()) {
+            m_themePaths.append(themePath);
+        }
         themeName = parentThemeName(themeName);
     }
 }
@@ -152,26 +195,28 @@
 
 QUrl UCTheme::styleUrl(QString styleName)
 {
-    QUrl styleUrl;
-
     Q_FOREACH (QUrl themePath, m_themePaths) {
-        styleUrl = themePath.resolved(styleName);
-        if (QFile::exists(styleUrl.toLocalFile())) {
-            break;
+        QUrl styleUrl = themePath.resolved(styleName);
+        if (styleUrl.isValid() && QFile::exists(styleUrl.toLocalFile())) {
+            return styleUrl;
         }
     }
 
-    return styleUrl;
+    return QUrl();
 }
 
 QString UCTheme::parentThemeName(QString themeName)
 {
     QString parentTheme;
     QUrl themePath = pathFromThemeName(themeName);
-    QFile file(themePath.resolved(PARENT_THEME_FILE).toLocalFile());
-    if (file.open(QIODevice::ReadOnly | QIODevice::Text)) {
-        QTextStream in(&file);
-        parentTheme = in.readLine();
+    if (!themePath.isValid()) {
+        qWarning() << UbuntuI18n::instance().tr("Theme not found: ") << themeName;
+    } else {
+        QFile file(themePath.resolved(PARENT_THEME_FILE).toLocalFile());
+        if (file.open(QIODevice::ReadOnly | QIODevice::Text)) {
+            QTextStream in(&file);
+            parentTheme = in.readLine();
+        }
     }
     return parentTheme;
 }
@@ -187,12 +232,22 @@
 
     if (parent != NULL) {
         QQmlEngine* engine = qmlEngine(parent);
+        if (engine != m_engine && !m_engine) {
+            m_engine = engine;
+            updateEnginePaths();
+        }
+        // make sure we have the paths
         if (engine != NULL) {
             QUrl url = styleUrl(styleName);
-            component = new QQmlComponent(engine, url, QQmlComponent::PreferSynchronous, parent);
-            if (component->isError()) {
-                delete component;
-                component = NULL;
+            if (url.isValid()) {
+                component = new QQmlComponent(engine, url, QQmlComponent::PreferSynchronous, parent);
+                if (component->isError()) {
+                    delete component;
+                    component = NULL;
+                }
+            } else {
+                qmlInfo(parent) <<
+                   UbuntuI18n::instance().tr(QString("Warning: Style %1 not found in theme %2").arg(styleName).arg(m_name));
             }
         }
     }
@@ -202,6 +257,10 @@
 
 void UCTheme::registerToContext(QQmlContext* context)
 {
+    // add paths to engine search folder
+    m_engine = context->engine();
+    updateEnginePaths();
+
     // register Theme
     context->setContextProperty("Theme", this);
 
@@ -209,6 +268,7 @@
         new ContextPropertyChangeListener(context, "Theme");
     QObject::connect(this, SIGNAL(nameChanged()),
                      themeChangeListener, SLOT(updateContextProperty()));
+
 }
 
 void UCTheme::loadPalette()

=== modified file 'modules/Ubuntu/Components/plugin/uctheme.h'
--- modules/Ubuntu/Components/plugin/uctheme.h	2013-07-01 06:32:40 +0000
+++ modules/Ubuntu/Components/plugin/uctheme.h	2013-10-21 08:57:44 +0000
@@ -54,6 +54,7 @@
     void paletteChanged();
 
 private Q_SLOTS:
+    void updateEnginePaths();
     void onThemeNameChanged();
     QUrl pathFromThemeName(QString themeName);
     void updateThemePaths();
@@ -64,8 +65,10 @@
 private:
     QString m_name;
     QObject* m_palette;
+    QQmlEngine *m_engine;
     QList<QUrl> m_themePaths;
     UCThemeSettings m_themeSettings;
+    bool m_engineUpdated;
 };
 
 #endif // UCTHEME_H

=== added directory 'tests/resources/themes'
=== added directory 'tests/resources/themes/CustomTheme'
=== added file 'tests/resources/themes/CustomTheme/TestStyle.qml'
--- tests/resources/themes/CustomTheme/TestStyle.qml	1970-01-01 00:00:00 +0000
+++ tests/resources/themes/CustomTheme/TestStyle.qml	2013-10-21 08:57:44 +0000
@@ -0,0 +1,22 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import QtQuick 2.0
+import TestTheme 1.0 as Parent
+
+Parent.TestStyle {
+    Component.onCompleted: console.log("CUSTOMTHEME")
+}

=== added file 'tests/resources/themes/CustomTheme/parent_theme'
--- tests/resources/themes/CustomTheme/parent_theme	1970-01-01 00:00:00 +0000
+++ tests/resources/themes/CustomTheme/parent_theme	2013-10-21 08:57:44 +0000
@@ -0,0 +1,1 @@
+TestTheme

=== added directory 'tests/resources/themes/TestModule'
=== added directory 'tests/resources/themes/TestModule/TestTheme'
=== added file 'tests/resources/themes/TestModule/TestTheme/TestStyle.qml'
--- tests/resources/themes/TestModule/TestTheme/TestStyle.qml	1970-01-01 00:00:00 +0000
+++ tests/resources/themes/TestModule/TestTheme/TestStyle.qml	2013-10-21 08:57:44 +0000
@@ -0,0 +1,22 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import QtQuick 2.0
+import Ubuntu.Components.Themes.Ambiance 0.1
+
+Item {
+    Component.onCompleted: console.log("PARENT")
+}

=== added file 'tests/resources/themes/TestModule/TestTheme/parent_theme'
--- tests/resources/themes/TestModule/TestTheme/parent_theme	1970-01-01 00:00:00 +0000
+++ tests/resources/themes/TestModule/TestTheme/parent_theme	2013-10-21 08:57:44 +0000
@@ -0,0 +1,1 @@
+Ubuntu.Components.Themes.Ambiance

=== added file 'tests/resources/themes/TestModule/TestTheme/qmldir'
--- tests/resources/themes/TestModule/TestTheme/qmldir	1970-01-01 00:00:00 +0000
+++ tests/resources/themes/TestModule/TestTheme/qmldir	2013-10-21 08:57:44 +0000
@@ -0,0 +1,2 @@
+module TestTheme
+TestStyle 1.0 TestStyle.qml
\ No newline at end of file

=== modified file 'tests/unit/unit.pro'
--- tests/unit/unit.pro	2013-09-23 08:47:39 +0000
+++ tests/unit/unit.pro	2013-10-21 08:57:44 +0000
@@ -10,8 +10,7 @@
 # https://bugs.launchpad.net/qemu-linaro/+bug/1084148
 #######################################
 #!contains(QMAKE_HOST.arch,armv7l) {
-    SUBDIRS += tst_theme_engine \
-        tst_components \
+    SUBDIRS += tst_components \
         tst_components_benchmark
 #}
 

=== renamed directory 'tests/unit/tst_theme_engine' => 'tests/unit_x11/tst_theme_engine'
=== modified file 'tests/unit_x11/tst_theme_engine/tst_theme_enginetest.cpp'
--- tests/unit/tst_theme_engine/tst_theme_enginetest.cpp	2013-07-17 14:17:18 +0000
+++ tests/unit_x11/tst_theme_engine/tst_theme_enginetest.cpp	2013-10-21 08:57:44 +0000
@@ -21,20 +21,37 @@
 #include <QtQml/QQmlComponent>
 #include "uctheme.h"
 
-
 class tst_UCTheme : public QObject
 {
     Q_OBJECT
+private:
+    QString m_xdgDataPath;
 
 private Q_SLOTS:
+    void initTestCase();
+    void cleanupTestCase();
     void testInstance();
     void testNameDefault();
     void testNameSet();
     void testCreateStyleComponent();
     void testCreateStyleComponent_data();
     void testThemesRelativePath();
+    void testThemesRelativePathWithParent();
+    void testThemesRelativePathWithParentXDGDATA();
+    void testThemesRelativePathWithParentNoVariablesSet();
+    void testThemesRelativePathWithParentOneXDGPathSet();
 };
 
+void tst_UCTheme::initTestCase()
+{
+    m_xdgDataPath = QLatin1String(getenv("XDG_DATA_DIRS"));
+}
+
+void tst_UCTheme::cleanupTestCase()
+{
+    qputenv("XDG_DATA_DIRS", m_xdgDataPath.toLocal8Bit());
+}
+
 void tst_UCTheme::testInstance()
 {
     UCTheme& theme = UCTheme::instance();
@@ -92,8 +109,73 @@
     QQmlComponent* component = theme.createStyleComponent("TestStyle.qml", parent);
 
     QCOMPARE(component != NULL, true);
-}
-
+    QCOMPARE(component->status(), QQmlComponent::Ready);
+}
+
+void tst_UCTheme::testThemesRelativePathWithParent()
+{
+    qputenv("UBUNTU_UI_TOOLKIT_THEMES_PATH", "../../resources/themes:../../resources/themes/TestModule");
+
+    UCTheme theme;
+    theme.setName("CustomTheme");
+    QQmlEngine engine;
+    theme.registerToContext(engine.rootContext());
+    QQmlComponent parentComponent(&engine, "Parent.qml");
+    QObject* parent = parentComponent.create();
+    QQmlComponent* component = theme.createStyleComponent("TestStyle.qml", parent);
+
+    QCOMPARE(component != NULL, true);
+    QCOMPARE(component->status(), QQmlComponent::Ready);
+}
+
+void tst_UCTheme::testThemesRelativePathWithParentXDGDATA()
+{
+    qputenv("UBUNTU_UI_TOOLKIT_THEMES_PATH", "");
+    qputenv("XDG_DATA_DIRS", "../../resources/themes:../../resources/themes/TestModule");
+
+    UCTheme theme;
+    theme.setName("CustomTheme");
+    QQmlEngine engine;
+    theme.registerToContext(engine.rootContext());
+    QQmlComponent parentComponent(&engine, "Parent.qml");
+    QObject* parent = parentComponent.create();
+    QQmlComponent* component = theme.createStyleComponent("TestStyle.qml", parent);
+
+    QCOMPARE(component != NULL, true);
+    QCOMPARE(component->status(), QQmlComponent::Ready);
+}
+
+void tst_UCTheme::testThemesRelativePathWithParentNoVariablesSet()
+{
+    qputenv("UBUNTU_UI_TOOLKIT_THEMES_PATH", "");
+    qputenv("XDG_DATA_DIRS", "");
+
+    UCTheme theme;
+    QQmlEngine engine;
+    QSignalSpy spy(&engine, SIGNAL(warnings(QList<QQmlError>)));
+    theme.registerToContext(engine.rootContext());
+    QQmlComponent parentComponent(&engine, "Parent.qml");
+    QObject* parent = parentComponent.create();
+    QQmlComponent* component = theme.createStyleComponent("TestStyle.qml", parent);
+    // warning about TestStyle not defined in Ubuntu.Components.Themes.Ambiance should be shown
+    QCOMPARE(spy.count(), 1);
+    QCOMPARE(component == NULL, true);
+}
+
+void tst_UCTheme::testThemesRelativePathWithParentOneXDGPathSet()
+{
+    qputenv("UBUNTU_UI_TOOLKIT_THEMES_PATH", "");
+    qputenv("XDG_DATA_DIRS", "../tst_theme_engine");
+
+    UCTheme theme;
+    theme.setName("TestModule.TestTheme");
+    QQmlEngine engine;
+    QQmlComponent parentComponent(&engine, "Parent.qml");
+    QObject* parent = parentComponent.create();
+    QQmlComponent* component = theme.createStyleComponent("TestStyle.qml", parent);
+
+    QCOMPARE(component != NULL, true);
+    QCOMPARE(component->status(), QQmlComponent::Ready);}
 
 QTEST_MAIN(tst_UCTheme)
 

=== modified file 'tests/unit_x11/unit_x11.pro'
--- tests/unit_x11/unit_x11.pro	2013-09-24 09:59:29 +0000
+++ tests/unit_x11/unit_x11.pro	2013-10-21 08:57:44 +0000
@@ -1,3 +1,3 @@
 TEMPLATE = subdirs
 
-SUBDIRS += tst_components tst_test tst_inversemousearea tst_recreateview tst_statesaver
+SUBDIRS += tst_components tst_test tst_inversemousearea tst_recreateview tst_statesaver tst_theme_engine