Merge lp:~ubuntu-sdk-team/ubuntu-ui-toolkit/optInDeprecationWarnings into lp:ubuntu-ui-toolkit/staging

[Cris Dywan]

Make deprecation warnings from C++ opt-in

Make deprecation warnings from C++ opt-in

[Zoltan Balogh (bzoltan)]

Good for me

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1618
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/2164/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-amd64-ci/892
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/894
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/894/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-i386-ci/891

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/2164/rebuild

review: Approve (continuous-integration)

=== modified file 'src/Ubuntu/Components/plugin/quickutils.cpp'
--- src/Ubuntu/Components/plugin/quickutils.cpp	2015-03-10 11:49:27 +0000
+++ src/Ubuntu/Components/plugin/quickutils.cpp	2015-08-24 11:39:27 +0000
@@ -196,3 +196,12 @@
     delete component;
     return result;
 }
+
+bool QuickUtils::showDeprecationWarnings() {
+    static int showWarnings = 0;
+    if (showWarnings == 0) {
+        QByteArray warningsFlag = qgetenv("SUPPRESS_DEPRECATED_NOTE");
+        showWarnings = (warningsFlag.isEmpty() || warningsFlag == "yes") ? 1 : 2;
+    }
+    return showWarnings == 2;
+}

=== modified file 'src/Ubuntu/Components/plugin/quickutils.h'
--- src/Ubuntu/Components/plugin/quickutils.h	2015-03-10 11:49:27 +0000
+++ src/Ubuntu/Components/plugin/quickutils.h	2015-08-24 11:39:27 +0000
@@ -46,6 +46,7 @@
     Q_INVOKABLE static QString className(QObject *item);
     Q_REVISION(1) Q_INVOKABLE static bool inherits(QObject *object, const QString &fromClass);
     QObject* createQmlObject(const QUrl &url, QQmlEngine *engine);
+    static bool showDeprecationWarnings();
 
 Q_SIGNALS:
     void rootObjectChanged();

=== modified file 'src/Ubuntu/Components/plugin/ucdeprecatedtheme.cpp'
--- src/Ubuntu/Components/plugin/ucdeprecatedtheme.cpp	2015-05-27 18:02:23 +0000
+++ src/Ubuntu/Components/plugin/ucdeprecatedtheme.cpp	2015-08-24 11:39:27 +0000
@@ -19,6 +19,7 @@
 #include "ucnamespace.h"
 #include "ucdeprecatedtheme.h"
 #include "uctheme.h"
+#include "quickutils.h"
 #include "listener.h"
 #include <QtQml/QQmlComponent>
 #include <QtQml/QQmlContext>
@@ -75,6 +76,9 @@
 
 void UCDeprecatedTheme::showDeprecatedNote(QObject *onItem, const char *note)
 {
+    if (!QuickUtils::showDeprecationWarnings())
+        return;
+
     QQmlContext ctx(QQmlEngine::contextForObject(onItem));
     // No warnings due to deprecated code used in the components themselves
     if (ctx.baseUrl().toString().contains("/Ubuntu/Components/"))
@@ -86,11 +90,8 @@
     QString noteId(QString("%1.%2").arg(note).arg(onItem->metaObject()->className()));
     if (m_notes.contains(noteId))
         return;
-    QByteArray suppressNote = qgetenv("SUPPRESS_DEPRECATED_NOTE");
-    if (suppressNote.isEmpty() || suppressNote != "yes") {
-        qmlInfo(onItem) << note;
-        m_notes.insert(noteId, true);
-    }
+    qmlInfo(onItem) << note;
+    m_notes.insert(noteId, true);
 }
 
 /*!

=== modified file 'src/Ubuntu/Components/plugin/ucubuntushape.cpp'
--- src/Ubuntu/Components/plugin/ucubuntushape.cpp	2015-08-24 09:24:37 +0000
+++ src/Ubuntu/Components/plugin/ucubuntushape.cpp	2015-08-24 11:39:27 +0000
@@ -28,6 +28,7 @@
 #include "ucubuntushape.h"
 #include "ucubuntushapetexture.h"
 #include "ucunits.h"
+#include "quickutils.h"
 #include <QtCore/QPointer>
 #include <QtGui/QGuiApplication>
 #include <QtGui/QScreen>
@@ -790,11 +791,13 @@
 */
 void UCUbuntuShape::setColor(const QColor& color)
 {
-    static bool deprecationNoteShown = false;
-    if (!deprecationNoteShown) {
-        deprecationNoteShown = true;
-        qmlInfo(this) << "'color' is deprecated. Use 'backgroundColor', 'secondaryBackgroundColor' and "
-            "'backgroundMode' instead.";
+    if (QuickUtils::showDeprecationWarnings()) {
+        static bool deprecationNoteShown = false;
+        if (!deprecationNoteShown) {
+            deprecationNoteShown = true;
+            qmlInfo(this) << "'color' is deprecated. Use 'backgroundColor', 'secondaryBackgroundColor' and "
+                "'backgroundMode' instead.";
+        }
     }
 
     if (!(m_flags & BackgroundApiSet)) {
@@ -823,11 +826,13 @@
 */
 void UCUbuntuShape::setGradientColor(const QColor& gradientColor)
 {
-    static bool deprecationNoteShown = false;
-    if (!deprecationNoteShown) {
-        deprecationNoteShown = true;
-        qmlInfo(this) << "'gradientColor' is deprecated. Use 'backgroundColor', "
-            "'secondaryBackgroundColor' and 'backgroundMode' instead.";
+    if (QuickUtils::showDeprecationWarnings()) {
+        static bool deprecationNoteShown = false;
+        if (!deprecationNoteShown) {
+            deprecationNoteShown = true;
+            qmlInfo(this) << "'gradientColor' is deprecated. Use 'backgroundColor', "
+                "'secondaryBackgroundColor' and 'backgroundMode' instead.";
+        }
     }
 
     if (!(m_flags & BackgroundApiSet)) {
@@ -854,10 +859,12 @@
 */
 void UCUbuntuShape::setImage(const QVariant& image)
 {
-    static bool deprecationNoteShown = false;
-    if (!deprecationNoteShown) {
-        deprecationNoteShown = true;
-        qmlInfo(this) << "'image' is deprecated. Use 'source' instead.";
+    if (QuickUtils::showDeprecationWarnings()) {
+        static bool deprecationNoteShown = false;
+        if (!deprecationNoteShown) {
+            deprecationNoteShown = true;
+            qmlInfo(this) << "'image' is deprecated. Use 'source' instead.";
+        }
     }
 
     if (!(m_flags & SourceApiSet)) {
@@ -887,10 +894,12 @@
 // maintain it for a while for compatibility reasons.
 void UCUbuntuShape::setStretched(bool stretched)
 {
-    static bool deprecationNoteShown = false;
-    if (!deprecationNoteShown) {
-        deprecationNoteShown = true;
-        qmlInfo(this) << "'stretched' is deprecated. Use 'sourceFillMode' instead";
+    if (QuickUtils::showDeprecationWarnings()) {
+        static bool deprecationNoteShown = false;
+        if (!deprecationNoteShown) {
+            deprecationNoteShown = true;
+            qmlInfo(this) << "'stretched' is deprecated. Use 'sourceFillMode' instead";
+        }
     }
 
     if (!(m_flags & SourceApiSet)) {
@@ -910,10 +919,12 @@
 // Deprecation layer. Same comment as setStretched().
 void UCUbuntuShape::setHorizontalAlignment(HAlignment horizontalAlignment)
 {
-    static bool deprecationNoteShown = false;
-    if (!deprecationNoteShown) {
-        deprecationNoteShown = true;
-        qmlInfo(this) << "'horizontalAlignment' is deprecated. Use 'sourceHorizontalAlignment' instead";
+    if (QuickUtils::showDeprecationWarnings()) {
+        static bool deprecationNoteShown = false;
+        if (!deprecationNoteShown) {
+            deprecationNoteShown = true;
+            qmlInfo(this) << "'horizontalAlignment' is deprecated. Use 'sourceHorizontalAlignment' instead";
+        }
     }
 
     if (!(m_flags & SourceApiSet)) {