Merge lp:~zsombi/ubuntu-ui-toolkit/native-fontutils into lp:ubuntu-ui-toolkit

[Zsombor Egri]

[theming] FontUtils converted from stateful JS library to native module due to its dependency to "units" context property.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:498
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/87/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-raring-amd64-ci/87
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-raring-armhf-ci/87

Click here to trigger a rebuild:
http://s-jenkins:8080/job/ubuntu-ui-toolkit-ci/87/rebuild

review: Approve (continuous-integration)

[Florian Boucault (fboucault)]

In ucfontutils.h:

* unnecessary includes:
#include <QtQml/QQmlEngine>
#include <QtQml/QJSEngine>

* copyright year should be 2013

review: Needs Fixing

[Florian Boucault (fboucault)]

In ucfontutils.cpp:

* unnecessary includes:
#include <QtCore/QMetaEnum>
#include <QtQml/QQmlInfo>

* copyright year should be 2013

* documentation generation fails; also I wonder how to document a context property

review: Needs Fixing

[lp:~zsombi/ubuntu-ui-toolkit/native-fontutils]

499. By Zsombor Egri on 2013-05-20

comments applied, more documentation added

500. By Zsombor Egri on 2013-05-20

documentation update

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:499
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/88/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-raring-amd64-ci/88
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-raring-armhf-ci/88

Click here to trigger a rebuild:
http://s-jenkins:8080/job/ubuntu-ui-toolkit-ci/88/rebuild

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:500
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/89/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-raring-amd64-ci/89
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-raring-armhf-ci/89

Click here to trigger a rebuild:
http://s-jenkins:8080/job/ubuntu-ui-toolkit-ci/89/rebuild

review: Approve (continuous-integration)

=== modified file 'modules/Ubuntu/Components/Label.qml'
--- modules/Ubuntu/Components/Label.qml	2013-04-11 18:00:34 +0000
+++ modules/Ubuntu/Components/Label.qml	2013-05-20 12:15:41 +0000
@@ -15,7 +15,6 @@
  */
 
 import QtQuick 2.0
-import "fontUtils.js" as FontUtils
 // FIXME: When a module contains QML, C++ and JavaScript elements exported,
 // we need to use named imports otherwise namespace collision is reported
 // by the QML engine. As workaround, we use Theming named import.

=== modified file 'modules/Ubuntu/Components/TextField.qml'
--- modules/Ubuntu/Components/TextField.qml	2013-05-19 19:23:40 +0000
+++ modules/Ubuntu/Components/TextField.qml	2013-05-20 12:15:41 +0000
@@ -15,7 +15,6 @@
  */
 
 import QtQuick 2.0
-import "fontUtils.js" as FontUtils
 // FIXME: When a module contains QML, C++ and JavaScript elements exported,
 // we need to use named imports otherwise namespace collision is reported
 // by the QML engine. As workaround, we use Theming named import.

=== removed file 'modules/Ubuntu/Components/fontUtils.js'
--- modules/Ubuntu/Components/fontUtils.js	2012-11-01 11:01:28 +0000
+++ modules/Ubuntu/Components/fontUtils.js	1970-01-01 00:00:00 +0000
@@ -1,31 +0,0 @@
-/*
- * Copyright 2012 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/>.
- */
-
-function sizeToPixels(size) {
-    var baseSize = units.dp(14)
-    return Math.round(modularScale(size) * baseSize)
-}
-
-function modularScale(size) {
-    switch (size) {
-        case "xx-small": return 0.606
-        case "x-small": return 0.707
-        case "small": return 0.857
-        case "medium": return 1.0
-        case "large": return 1.414
-        case "x-large": return 2.423
-    }
-}

=== modified file 'modules/Ubuntu/Components/plugin/plugin.cpp'
--- modules/Ubuntu/Components/plugin/plugin.cpp	2013-05-09 19:04:28 +0000
+++ modules/Ubuntu/Components/plugin/plugin.cpp	2013-05-20 12:15:41 +0000
@@ -41,6 +41,7 @@
 #include "bottombarvisibilitycommunicator.h"
 #include "ucstyle.h"
 #include "ucubuntuanimation.h"
+#include "ucfontutils.h"
 
 #include <sys/types.h>
 #include <unistd.h>
@@ -96,12 +97,18 @@
     QObject::connect(&UCUnits::instance(), SIGNAL(gridUnitChanged()),
                      &unitsChangeListener, SLOT(updateContextProperty()));
 
+    // register FontUtils
+    context->setContextProperty("FontUtils", &UCFontUtils::instance());
+    static ContextPropertyChangeListener fontUtilsListener(context, "FontUtils");
+    QObject::connect(&UCUnits::instance(), SIGNAL(gridUnitChanged()),
+                     &fontUtilsListener, SLOT(updateContextProperty()));
+
     context->setContextProperty("bottomBarVisibilityCommunicator", &BottomBarVisibilityCommunicator::instance());
 
     engine->addImageProvider(QLatin1String("scaling"), new UCScalingImageProvider);
 
     // register gicon provider
-     engine->addImageProvider(QLatin1String("gicon"), new GIconProvider);
+    engine->addImageProvider(QLatin1String("gicon"), new GIconProvider);
 
     // Necessary for Screen.orientation (from import QtQuick.Window 2.0) to work
     QGuiApplication::primaryScreen()->setOrientationUpdateMask(

=== modified file 'modules/Ubuntu/Components/plugin/plugin.pro'
--- modules/Ubuntu/Components/plugin/plugin.pro	2013-05-09 19:04:28 +0000
+++ modules/Ubuntu/Components/plugin/plugin.pro	2013-05-20 12:15:41 +0000
@@ -44,7 +44,8 @@
     qquickclipboard_p.h \
     selector_p.h \
     ucstyle.h \
-    ucubuntuanimation.h
+    ucubuntuanimation.h \
+    ucfontutils.h
 
 SOURCES += plugin.cpp \
     themeengine.cpp \
@@ -66,7 +67,8 @@
     qquickmimedata.cpp \
     selector.cpp \
     ucstyle.cpp \
-    ucubuntuanimation.cpp
+    ucubuntuanimation.cpp \
+    ucfontutils.cpp
 
 # deployment rules for the plugin
 installPath = $$[QT_INSTALL_QML]/$$replace(uri, \\., /)

=== added file 'modules/Ubuntu/Components/plugin/ucfontutils.cpp'
--- modules/Ubuntu/Components/plugin/ucfontutils.cpp	1970-01-01 00:00:00 +0000
+++ modules/Ubuntu/Components/plugin/ucfontutils.cpp	2013-05-20 12:15:41 +0000
@@ -0,0 +1,99 @@
+/*
+ * 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/>.
+ *
+ */
+
+#include "ucfontutils.h"
+#include "ucunits.h"
+
+/*!
+ * \qmltype FontUtils
+ * \instantiates UCFontUtils
+ * \inqmlmodule Ubuntu.Components 0.1
+ * \ingroup ubuntu
+ * \brief FontUtils is a \l {http://qt-project.org/doc/qt-5.0/qtqml/qqmlcontext.html#details} {context property},
+ * which provides utility functions for font manipulations.
+ *
+ * FontUtils cannot be instantiated and it is already available as a context
+ * property, i.e. 'FontUtils'  is an instance  that can be used from anywhere in
+ * the code.
+ *
+ * Example of a Label implementation which uses the default base scale for the font
+ * size:
+ * \qml
+ * import QtQuick 2.0
+ * import Ubuntu.Components 0.1
+ *
+ * Text {
+ *     property string fontSize: "medium"
+ *     font.pixelSize: FontUtils.sizeToPixels(fontSize)
+ * }
+ * \endqml
+ *
+ * Another example of a custom text input component exposing a fontSize property and a base
+ * font unit size to scale its font:
+ * \qml
+ * import QtQuick 2.0
+ * import Ubuntu.Components 0.1
+ *
+ * TextInput {
+ *     property string fontSize: "small"
+ *     property int baseFontUnits: units.dp(20)
+ *     font.pixelSize: FontUtils.modularScale(fontSize) * units.dp(baseFontUnits)
+ * }
+ * \endqml
+ *
+ */
+
+/*!
+ * \qmlmethod real FontUtils::sizeToPixels(string size)
+ * The function calculates the pixel size of a given scale. The size scale can be
+ * one of the strings specified at modularScale function. On failure returns 0.
+ */
+qreal UCFontUtils::sizeToPixels(const QString &size)
+{
+    return modularScale(size) * UCUnits::instance().dp(14);
+}
+
+/*!
+ * \qmlmethod real FontUtils::modularScale(string size)
+ * The function returns the number interpretation of a given font scale. The scale
+ * can have one of the following values:
+ * \list
+ * \li \b{xx-small}
+ * \li \b{x-small}
+ * \li \b{small}
+ * \li \b{medium}
+ * \li \b{large}
+ * \li \b{x-large}
+ * \endlist
+ */
+qreal UCFontUtils::modularScale(const QString &size)
+{
+    if (size == "xx-small") {
+        return 0.606;
+    } else if (size == "x-small") {
+        return 0.707;
+    } else if (size == "small") {
+        return 0.857;
+    } else if (size == "medium") {
+        return 1.0;
+    } else if (size == "large") {
+        return 1.414;
+    } else if (size == "x-large") {
+        return 2.423;
+    }
+    return 0.0;
+}

=== added file 'modules/Ubuntu/Components/plugin/ucfontutils.h'
--- modules/Ubuntu/Components/plugin/ucfontutils.h	1970-01-01 00:00:00 +0000
+++ modules/Ubuntu/Components/plugin/ucfontutils.h	2013-05-20 12:15:41 +0000
@@ -0,0 +1,40 @@
+/*
+ * 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/>.
+ *
+ */
+
+#ifndef UCFONTUTILS_H
+#define UCFONTUTILS_H
+
+#include <QtCore/QObject>
+
+class UCFontUtils : public QObject
+{
+    Q_OBJECT
+public:
+
+    static UCFontUtils& instance()
+    {
+        static UCFontUtils instance;
+        return instance;
+    }
+
+    explicit UCFontUtils(QObject *parent = 0) : QObject(parent) {}
+
+    Q_INVOKABLE qreal sizeToPixels(const QString &size);
+    Q_INVOKABLE qreal modularScale(const QString &size);
+};
+
+#endif // UCFONTUTILS_H

=== modified file 'modules/Ubuntu/Components/qmldir'
--- modules/Ubuntu/Components/qmldir	2013-05-20 09:06:47 +0000
+++ modules/Ubuntu/Components/qmldir	2013-05-20 12:15:41 +0000
@@ -33,7 +33,6 @@
 UbuntuShape 0.1 UbuntuShape.qml
 Icon 0.1 Icon.qml
 OrientationHelper 0.1 OrientationHelper.qml
-FontUtils 0.1 fontUtils.js
 MathUtils 0.1 mathUtils.js
 SliderUtils 0.1 sliderUtils.js
 ScrollbarUtils 0.1 scrollbarUtils.js

=== added file 'tests/unit/tst_components/tst_fontutils.qml'
--- tests/unit/tst_components/tst_fontutils.qml	1970-01-01 00:00:00 +0000
+++ tests/unit/tst_components/tst_fontutils.qml	2013-05-20 12:15:41 +0000
@@ -0,0 +1,52 @@
+/*
+ * Copyright 2012 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 QtTest 1.0
+import Ubuntu.Components 0.1
+
+TestCase {
+    name: "FontUtilsAPI"
+
+    function test_modularScale() {
+        compare(FontUtils.modularScale("xx-small"), 0.606, "xx-small scale");
+        compare(FontUtils.modularScale("x-small"), 0.707, "x-small scale");
+        compare(FontUtils.modularScale("small"), 0.857, "small scale");
+        compare(FontUtils.modularScale("medium"), 1.0, "medium scale");
+        compare(FontUtils.modularScale("large"), 1.414, "large scale");
+        compare(FontUtils.modularScale("x-large"), 2.423, "x-large scale");
+    }
+
+    function test_modularScale_failures() {
+        compare(FontUtils.modularScale("xxsmall"), 0.0, "xxsmall not defined");
+        compare(FontUtils.modularScale("undefined"), 0.0, "undefined scale");
+    }
+
+    function test_sizeToPixels() {
+        compare(FontUtils.sizeToPixels("xx-small"), 0.606 * units.dp(14), "xx-small scale");
+        compare(FontUtils.sizeToPixels("x-small"), 0.707 * units.dp(14), "x-small scale");
+        compare(FontUtils.sizeToPixels("small"), 0.857 * units.dp(14), "small scale");
+        compare(FontUtils.sizeToPixels("medium"), 1.0 * units.dp(14), "medium scale");
+        compare(FontUtils.sizeToPixels("large"), 1.414 * units.dp(14), "large scale");
+        compare(FontUtils.sizeToPixels("x-large"), 2.423 * units.dp(14), "x-large scale");
+    }
+
+    function test_sizeToPixels_failures() {
+        compare(FontUtils.sizeToPixels("xxsmall"), 0.0, "xxsmall not defined");
+        compare(FontUtils.sizeToPixels("undefined"), 0.0, "undefined scale");
+    }
+
+}