Merge lp:~loic.molinari/ubuntu-ui-toolkit/ubuntu-ui-toolkit-c++-label-conversion into lp:ubuntu-ui-toolkit/staging

[Loïc Molinari]

Coverted Label item from QML to C++ for performance reasons.

Coverted Label item from QML to C++ for performance reasons.

[Zsombor Egri (zsombi)]

You cannot hardcode the color. See old Label "color: Theme.palette.selected.backgroundText" binding is broken now, you got to fix that.

Also would be nice to see some performance measurements to see what is the gain.

Comments inline

review: Needs Fixing

[Loïc Molinari (loic.molinari)]

> You cannot hardcode the color. See old Label "color:
> Theme.palette.selected.backgroundText" binding is broken now, you got to fix
> that.

Any idea on how to do that?

[Loïc Molinari (loic.molinari)]

What about the naming of the new property adaptiveSize, good enough?

Unmerged revisions

1451. By Loïc Molinari on 2015-03-17

Converted Label from QML to C++.

=== modified file 'components.api'
--- components.api	2015-03-10 13:58:52 +0000
+++ components.api	2015-03-17 09:10:46 +0000
@@ -83,9 +83,6 @@
 Icon 1.1
 Icon10
     property url source
-Label 0.1 1.0
-Text
-    property string fontSize
 Base 0.1 1.0
 Empty
     property variant icon
@@ -925,6 +922,13 @@
     name: "UCInverseMouse"
     prototype: "UCMouse"
     exports: ["InverseMouse 0.1", "InverseMouse 1.0"]
+    name: "UCLabel"
+    prototype: "QQuickText"
+    exports: ["Label 0.1", "Label 1.0", "Label 1.2"]
+    name: "AdaptiveSize"
+    Property { name: "adaptiveSize"; revision: 1; type: "AdaptiveSize" }
+    Property { name: "fontSize"; type: "string" }
+    Signal { name: "adaptiveSizeChanged"; revision: 1 }
     name: "UCListItem"
     prototype: "UCStyledItemBase"
     exports: ["ListItem 1.2"]

=== removed file 'modules/Ubuntu/Components/Label.qml'
--- modules/Ubuntu/Components/Label.qml	2015-03-03 13:47:48 +0000
+++ modules/Ubuntu/Components/Label.qml	1970-01-01 00:00:00 +0000
@@ -1,59 +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/>.
- */
-
-import QtQuick 2.4
-
-/*!
-    \qmltype Label
-    \inqmlmodule Ubuntu.Components 1.1
-    \ingroup ubuntu
-    \brief Text with Ubuntu styling.
-
-    Example:
-    \qml
-    Rectangle {
-        color: UbuntuColors.coolGrey
-        width: units.gu(30)
-        height: units.gu(30)
-
-        Label {
-            anchors.centerIn: parent
-            text: "Hello, world!"
-            fontSize: "large"
-        }
-    }
-    \endqml
-*/
-Text {
-    id: label
-
-    /*!
-      The size of the text. One of the following strings (from smallest to largest):
-        \list
-          \li "xx-small"
-          \li "x-small"
-          \li "small"
-          \li "medium"
-          \li "large"
-          \li "x-large"
-        \endlist
-        Default value is "medium".
-      */
-    property string fontSize: "medium"
-
-    font.pixelSize: FontUtils.sizeToPixels(fontSize)
-    color: Theme.palette.selected.backgroundText
-}

=== modified file 'modules/Ubuntu/Components/OptionSelector.qml'
--- modules/Ubuntu/Components/OptionSelector.qml	2015-03-03 13:47:48 +0000
+++ modules/Ubuntu/Components/OptionSelector.qml	2015-03-17 09:10:46 +0000
@@ -202,7 +202,7 @@
             right: parent.right
         }
 
-        Label {
+        Toolkit.Label {
             id : label
 
             text: optionSelector.text

=== modified file 'modules/Ubuntu/Components/OptionSelectorDelegate.qml'
--- modules/Ubuntu/Components/OptionSelectorDelegate.qml	2015-03-03 13:47:48 +0000
+++ modules/Ubuntu/Components/OptionSelectorDelegate.qml	2015-03-17 09:10:46 +0000
@@ -318,10 +318,10 @@
             anchors {
                 verticalCenter: parent.verticalCenter
             }
-            Label {
+            Toolkit.Label {
                 text: option.text === "" ? modelData : option.text
             }
-            Label {
+            Toolkit.Label {
                 text: option.subText
                 visible: option.subText !== "" ? true : false
                 fontSize: "small"

=== modified file 'modules/Ubuntu/Components/TextArea.qml'
--- modules/Ubuntu/Components/TextArea.qml	2015-03-10 11:49:27 +0000
+++ modules/Ubuntu/Components/TextArea.qml	2015-03-17 09:10:46 +0000
@@ -792,10 +792,10 @@
     Keys.onReleased: event.accepted = (event.key === Qt.Key_Enter) || (event.key === Qt.Key_Return)
 
     // holding default values
-    Label { id: fontHolder }
+    Ubuntu.Label { id: fontHolder }
 
     //hint
-    Label {
+    Ubuntu.Label {
         id: hint
         anchors {
             fill: parent

=== modified file 'modules/Ubuntu/Components/TextField.qml'
--- modules/Ubuntu/Components/TextField.qml	2015-03-10 11:49:27 +0000
+++ modules/Ubuntu/Components/TextField.qml	2015-03-17 09:10:46 +0000
@@ -936,7 +936,7 @@
     }
 
     // hint text
-    Label {
+    Ubuntu.Label {
         id: hint
         verticalAlignment: Text.AlignVCenter
         horizontalAlignment: editor.horizontalAlignment

=== modified file 'modules/Ubuntu/Components/plugin/plugin.cpp'
--- modules/Ubuntu/Components/plugin/plugin.cpp	2015-03-04 19:07:58 +0000
+++ modules/Ubuntu/Components/plugin/plugin.cpp	2015-03-17 09:10:46 +0000
@@ -58,6 +58,7 @@
 #include "uclistitemactions.h"
 #include "uclistitemstyle.h"
 #include "ucserviceproperties.h"
+#include "uclabel.h"
 #include "ucnamespace.h"
 
 #include <sys/types.h>
@@ -156,6 +157,7 @@
     qmlRegisterSingletonType<UCUriHandler>(uri, major, minor, "UriHandler", registerUriHandler);
     qmlRegisterType<UCMouse>(uri, major, minor, "Mouse");
     qmlRegisterType<UCInverseMouse>(uri, major, minor, "InverseMouse");
+    qmlRegisterType<UCLabel>(uri, major, minor, "Label");
 }
 
 void UbuntuComponentsPlugin::registerTypes(const char *uri)
@@ -189,6 +191,7 @@
     qmlRegisterSingletonType<UCNamespace>(uri, 1, 2, "Ubuntu", registerUbuntuNamespace);
     qmlRegisterType<UCUbuntuShape, 1>(uri, 1, 2, "UbuntuShape");
     qmlRegisterType<UCUbuntuShapeOverlay>(uri, 1, 2, "UbuntuShapeOverlay");
+    qmlRegisterType<UCLabel, 1>(uri, 1, 2, "Label");
 }
 
 void UbuntuComponentsPlugin::initializeEngine(QQmlEngine *engine, const char *uri)

=== modified file 'modules/Ubuntu/Components/plugin/plugin.pro'
--- modules/Ubuntu/Components/plugin/plugin.pro	2015-03-04 19:07:58 +0000
+++ modules/Ubuntu/Components/plugin/plugin.pro	2015-03-17 09:10:46 +0000
@@ -77,6 +77,7 @@
     uclistitemstyle.h \
     ucserviceproperties.h \
     ucserviceproperties_p.h \
+    uclabel.h \
     privates/listitemdragarea.h \
     privates/listitemdraghandler.h \
     ucnamespace.h
@@ -124,6 +125,7 @@
     uclistitemstyle.cpp \
     ucviewitemsattached.cpp \
     ucserviceproperties.cpp \
+    uclabel.cpp \
     privates/listitemdragarea.cpp \
     privates/listitemdraghandler.cpp \
     ucnamespace.cpp

=== modified file 'modules/Ubuntu/Components/plugin/ucfontutils.cpp'
--- modules/Ubuntu/Components/plugin/ucfontutils.cpp	2015-03-03 13:47:48 +0000
+++ modules/Ubuntu/Components/plugin/ucfontutils.cpp	2015-03-17 09:10:46 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013 Canonical Ltd.
+ * Copyright 2013-2015 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
@@ -64,7 +64,7 @@
  */
 qreal UCFontUtils::sizeToPixels(const QString &size)
 {
-    return modularScale(size) * UCUnits::instance().dp(14);
+    return modularScale(size) * UCUnits::instance().dp(fontUnits);
 }
 
 /*!
@@ -82,18 +82,17 @@
  */
 qreal UCFontUtils::modularScale(const QString &size)
 {
-    if (size == "xx-small") {
-        return 0.677;
-    } else if (size == "x-small") {
-        return 0.804;
-    } else if (size == "small") {
-        return 0.931;
-    } else if (size == "medium") {
-        return 1.079;
-    } else if (size == "large") {
-        return 1.291;
-    } else if (size == "x-large") {
-        return 1.714;
-    }
-    return 0.0;
+    if (size.size() < 4) {
+        return 0.0;
+    }
+
+    switch (reinterpret_cast<int*>(size.toLatin1().data())[0]) {
+        case /*"medi"*/0x6964656d: { return mediumScale; }
+        case /*"larg"*/0x6772616c: { return largeScale; }
+        case /*"smal"*/0x6c616d73: { return smallScale; }
+        case /*"x-la"*/0x616c2d78: { return xLargeScale; }
+        case /*"x-sm"*/0x6d732d78: { return xSmallScale; }
+        case /*"xx-s"*/0x732d7878: { return xxSmallScale; }
+        default: { return 0.0; }
+    }
 }

=== modified file 'modules/Ubuntu/Components/plugin/ucfontutils.h'
--- modules/Ubuntu/Components/plugin/ucfontutils.h	2013-05-20 11:38:32 +0000
+++ modules/Ubuntu/Components/plugin/ucfontutils.h	2015-03-17 09:10:46 +0000
@@ -12,7 +12,6 @@
  *
  * 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
@@ -23,7 +22,15 @@
 class UCFontUtils : public QObject
 {
     Q_OBJECT
+
 public:
+    static const float fontUnits = 14.0f;
+    static const float xxSmallScale = 0.677f;
+    static const float xSmallScale = 0.804f;
+    static const float smallScale = 0.931f;
+    static const float mediumScale = 1.079f;
+    static const float largeScale = 1.291f;
+    static const float xLargeScale = 1.714f;
 
     static UCFontUtils& instance()
     {

=== added file 'modules/Ubuntu/Components/plugin/uclabel.cpp'
--- modules/Ubuntu/Components/plugin/uclabel.cpp	1970-01-01 00:00:00 +0000
+++ modules/Ubuntu/Components/plugin/uclabel.cpp	2015-03-17 09:10:46 +0000
@@ -0,0 +1,141 @@
+/*
+ * Copyright 2015 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 "uclabel.h"
+#include "ucfontutils.h"
+#include "ucunits.h"
+
+void UCLabel::updatePixelSize()
+{
+    const float sizes[] = {
+        UCFontUtils::xxSmallScale, UCFontUtils::xSmallScale, UCFontUtils::smallScale,
+        UCFontUtils::mediumScale, UCFontUtils::largeScale, UCFontUtils::xLargeScale
+    };
+    QFont textFont = font();
+    textFont.setPixelSize(
+        qRound(sizes[m_adaptiveSize] * UCUnits::instance().dp(UCFontUtils::fontUnits)));
+    setFont(textFont);
+}
+
+/*! \qmltype Label
+    \instantiates UCLabel
+    \inqmlmodule Ubuntu.Components 1.2
+    \ingroup ubuntu
+    \brief Extended Text item with Ubuntu styling.
+
+    Label is an extended Text item with Ubuntu styling. It exposes an additional property that
+    provides adaptive resizing based on the measurement unit.
+
+    Example:
+    \qml
+    Rectangle {
+        color: UbuntuColors.warmGrey
+        width: units.gu(30)
+        height: units.gu(30)
+
+        Label {
+            anchors.centerIn: parent
+            text: "Hello world!"
+            adaptiveSize: "large"
+        }
+    }
+    \endqml
+*/
+UCLabel::UCLabel(QQuickItem* parent)
+    : QQuickText(parent)
+    , m_adaptiveSize(Medium)
+    , m_flags(0)
+{
+    // FIXME(loicm) Hard-coded selected background text from Ambiance palette.
+    setColor(QColor(qRgb(0x5d, 0x5d, 0x5d)));
+    updatePixelSize();
+}
+
+/*! \qmlproperty enumeration Label::adaptiveSize
+    \since Ubuntu.Components 1.2
+
+    This property holds an abstract size that allows adaptive resizing based on the measurement unit
+    (see Units). The default value is \c Label.Medium.
+
+    \note Setting this disables support for the deprecated \l fontSize property.
+
+    \list
+    \li \b Label.XxSmall - extremely small font size
+    \li \b Label.XSmall - very small font size
+    \li \b Label.Small - small font size
+    \li \b Label.Medium - medium font size
+    \li \b Label.Large - large font size
+    \li \b Label.XLarge - very large font size
+    \endlist
+*/
+void UCLabel::setAdaptiveSize(AdaptiveSize adaptiveSize)
+{
+    if (!(m_flags & AdaptiveSizeSet)) {
+        Q_EMIT fontSizeChanged();
+        m_flags |= AdaptiveSizeSet;
+    }
+
+    if (m_adaptiveSize != adaptiveSize) {
+        m_adaptiveSize = adaptiveSize;
+        updatePixelSize();
+        Q_EMIT adaptiveSizeChanged();
+    }
+}
+
+/*! \qmlproperty string Label::fontSize
+    \deprecated
+
+    This property holds an abstract size represented as a string that allows adaptive resizing based
+    on the measurement unit (see Units). The default value is \c "medium".
+
+    \note Use \l adaptiveSize instead.
+
+    Here is the list of allowed strings from the smallest to the largest:
+    \list
+    \li \b "xx-small" - extremely small font size
+    \li \b "x-small" - very small font size
+    \li \b "small" - small font size
+    \li \b "medium" - medium font size
+    \li \b "large" - large font size
+    \li \b "x-large" - very large font size
+    \endlist
+*/
+void UCLabel::setFontSize(const QString& fontSize)
+{
+    if (m_flags & AdaptiveSizeSet) {
+        return;
+    }
+    if (fontSize.size() < 4) {
+        return;
+    }
+
+    AdaptiveSize adaptiveSize;
+    switch (reinterpret_cast<int*>(fontSize.toLatin1().data())[0]) {
+        case /*"medi"*/0x6964656d: { adaptiveSize = Medium; break; }
+        case /*"larg"*/0x6772616c: { adaptiveSize = Large; break; }
+        case /*"smal"*/0x6c616d73: { adaptiveSize = Small; break; }
+        case /*"x-la"*/0x616c2d78: { adaptiveSize = XLarge; break; }
+        case /*"x-sm"*/0x6d732d78: { adaptiveSize = XSmall; break; }
+        case /*"xx-s"*/0x732d7878: { adaptiveSize = XxSmall; break; }
+        default: { return; }
+    }
+
+    if (m_adaptiveSize != adaptiveSize) {
+        m_adaptiveSize = adaptiveSize;
+        updatePixelSize();
+        Q_EMIT fontSizeChanged();
+    }
+}

=== added file 'modules/Ubuntu/Components/plugin/uclabel.h'
--- modules/Ubuntu/Components/plugin/uclabel.h	1970-01-01 00:00:00 +0000
+++ modules/Ubuntu/Components/plugin/uclabel.h	2015-03-17 09:10:46 +0000
@@ -0,0 +1,69 @@
+/*
+ * Copyright 2015 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 UCLABEL_H
+#define UCLABEL_H
+
+#include <private/qquicktext_p.h>
+
+class UCLabel : public QQuickText
+{
+    Q_OBJECT
+
+    Q_ENUMS(AdaptiveSize)
+    Q_PROPERTY(AdaptiveSize adaptiveSize READ adaptiveSize WRITE setAdaptiveSize
+               NOTIFY adaptiveSizeChanged REVISION 1)
+
+    // Deprecated.
+    Q_PROPERTY(QString fontSize READ fontSize WRITE setFontSize NOTIFY fontSizeChanged)
+
+public:
+    UCLabel(QQuickItem* parent=0);
+
+    enum AdaptiveSize { XxSmall = 0, XSmall = 1, Small = 2, Medium = 3, Large = 4, XLarge = 5 };
+
+    AdaptiveSize adaptiveSize() const { return m_adaptiveSize; }
+    void setAdaptiveSize(AdaptiveSize adaptiveSize);
+
+    // Deprecated.
+    QString fontSize() const {
+        if (m_flags & AdaptiveSizeSet) { return ""; }
+        const char* const sizes[] =
+            { "xx-small", "x-small", "small", "medium", "large", "x-large" };
+        return QString(sizes[m_adaptiveSize]);
+    }
+    void setFontSize(const QString& fontSize);
+
+Q_SIGNALS:
+    Q_REVISION(1) void adaptiveSizeChanged();
+
+    // Deprecated.
+    void fontSizeChanged();
+
+private:
+    void updatePixelSize();
+
+    enum { AdaptiveSizeSet = 1 };
+
+    AdaptiveSize m_adaptiveSize;
+    quint8 m_flags;
+
+    Q_DISABLE_COPY(UCLabel)
+};
+
+QML_DECLARE_TYPE(UCLabel)
+
+#endif  // UCLABEL_H

=== modified file 'modules/Ubuntu/Components/qmldir'
--- modules/Ubuntu/Components/qmldir	2015-03-02 13:39:03 +0000
+++ modules/Ubuntu/Components/qmldir	2015-03-17 09:10:46 +0000
@@ -11,7 +11,6 @@
 Tab 0.1 Tab.qml
 TabBar 0.1 TabBar.qml
 Tabs 0.1 Tabs.qml
-Label 0.1 Label.qml
 AbstractButton 0.1 AbstractButton.qml
 ActivityIndicator 0.1 ActivityIndicator.qml
 ProgressBar 0.1 ProgressBar10.qml
@@ -60,7 +59,6 @@
 Tab 1.0 Tab.qml
 TabBar 1.0 TabBar.qml
 Tabs 1.0 Tabs.qml
-Label 1.0 Label.qml
 AbstractButton 1.0 AbstractButton.qml
 ActivityIndicator 1.0 ActivityIndicator.qml
 ProgressBar 1.0 ProgressBar10.qml