Enhance logging capabilities for wizard classes

* Added QDebug operator<< for the Field classes so that they could be inspected during runtime (i.e. logged)
* Added optional QDebug operator<< overloads for QVariant (wizarddebug.h) - to better visualize the data parsed from the wizard.json files (QVariant objects), by using a format more in the like of json.

Change-Id: I53a729b24e4f2d9c9acf1ed802ac9dc3bb67f373
Reviewed-by: Eike Ziller <eike.ziller@qt.io>

src/libs/utils/wizard.cpp

@@ -583,6 +583,21 @@ public:
     WizardProgressItem *m_startItem = nullptr;
 };
 
+inline QDebug &operator<<(QDebug &debug, const WizardProgressPrivate &progress)
+{
+    debug << "items:" << progress.m_items.size()
+          << "; visited:" << progress.m_visitedItems.size()
+          << "; reachable:" << progress.m_reachableItems.size();
+
+    return debug;
+}
+
+QDebug &operator<<(QDebug &debug, const WizardProgress &progress)
+{
+    debug << "WizardProgress{_: " << *progress.d_ptr << "}";
+    return debug;
+}
+
 class WizardProgressItemPrivate
 {
     WizardProgressItem *q_ptr;
@@ -597,6 +612,22 @@ public:
     WizardProgressItem *m_nextShownItem;
 };
 
+inline QDebug &operator<<(QDebug &debug, const WizardProgressItemPrivate &item)
+{
+    debug << "title:" << item.m_title
+          << "; word wrap:" << item.m_titleWordWrap
+          << "; progress:" << *item.m_wizardProgress
+          << "; pages:" << item.m_pages;
+
+    return debug;
+}
+
+QDebug &operator<<(QDebug &debug, const WizardProgressItem &item)
+{
+    debug << "WizardProgressItem{_: " << *item.d_ptr << "}";
+    return debug;
+}
+
 bool WizardProgressPrivate::isNextItem(WizardProgressItem *item, WizardProgressItem *nextItem)
 {
     QHash<WizardProgressItem *, bool> visitedItems;

src/libs/utils/wizard.h

@@ -133,6 +133,8 @@ private:
     friend class Wizard;
     friend class WizardProgressItem;
 
+    friend QTCREATOR_UTILS_EXPORT QDebug &operator<<(QDebug &debug, const WizardProgress &progress);
+
     Q_DECLARE_PRIVATE(WizardProgress)
 
     class WizardProgressPrivate *d_ptr;
@@ -163,10 +165,15 @@ protected:
 
 private:
     friend class WizardProgress;
+    friend QTCREATOR_UTILS_EXPORT QDebug &operator<<(QDebug &d, const WizardProgressItem &item);
 
     Q_DECLARE_PRIVATE(WizardProgressItem)
 
     class WizardProgressItemPrivate *d_ptr;
 };
 
+QTCREATOR_UTILS_EXPORT QDebug &operator<<(QDebug &debug, const WizardProgress &progress);
+
+QTCREATOR_UTILS_EXPORT QDebug &operator<<(QDebug &debug, const WizardProgressItem &item);
+
 } // namespace Utils

src/plugins/coreplugin/generatedfile.cpp

@@ -64,6 +64,21 @@ public:
     GeneratedFile::Attributes attributes;
 };
 
+inline QDebug &operator<<(QDebug &debug, const Core::GeneratedFilePrivate &file)
+{
+    debug << "path: " << file.path
+          << "; editorId: " << file.editorId.toString()
+          << "; binary: " << file.binary
+          << "; contents: " << file.contents.size();
+    return debug;
+}
+
+QDebug &operator<<(QDebug &debug, const Core::GeneratedFile &file)
+{
+    debug << "GeneratedFile{_: " << *file.m_d << "}";
+    return debug;
+}
+
 GeneratedFilePrivate::GeneratedFilePrivate(const QString &path) : // FIXME Don't use - Remove when possible
     path(FilePath::fromString(path).cleanPath()),
     attributes({})

src/plugins/coreplugin/generatedfile.h

@@ -91,8 +91,12 @@ public:
 
 private:
     QSharedDataPointer<GeneratedFilePrivate> m_d;
+
+    friend CORE_EXPORT QDebug &operator<<(QDebug &debug, const Core::GeneratedFile &file);
 };
 
+CORE_EXPORT QDebug &operator<<(QDebug &debug, const Core::GeneratedFile &file);
+
 using GeneratedFiles = QList<GeneratedFile>;
 
 } // namespace Core

src/plugins/projectexplorer/CMakeLists.txt

@@ -102,6 +102,7 @@ add_qtc_plugin(ProjectExplorer
     jsonwizard/jsonwizardpagefactory.cpp jsonwizard/jsonwizardpagefactory.h
     jsonwizard/jsonwizardpagefactory_p.cpp
     jsonwizard/jsonwizardpagefactory_p.h
+    jsonwizard/wizarddebug.h
     jsonwizard/jsonwizardscannergenerator.cpp jsonwizard/jsonwizardscannergenerator.h
     kit.cpp kit.h
     kitchooser.cpp kitchooser.h

src/plugins/projectexplorer/jsonwizard/jsonfieldpage.cpp

@@ -153,7 +153,7 @@ JsonFieldPage::Field::~Field()
     delete d->m_label;
 }
 
-QString JsonFieldPage::Field::type()
+QString JsonFieldPage::Field::type() const
 {
     return d->m_type;
 }
@@ -301,17 +301,17 @@ QWidget *JsonFieldPage::Field::widget(const QString &displayName, JsonFieldPage
     return d->m_widget;
 }
 
-QString JsonFieldPage::Field::name()
+QString JsonFieldPage::Field::name() const
 {
     return d->m_name;
 }
 
-QString JsonFieldPage::Field::displayName()
+QString JsonFieldPage::Field::displayName() const
 {
     return d->m_displayName;
 }
 
-QString JsonFieldPage::Field::toolTip()
+QString JsonFieldPage::Field::toolTip() const
 {
     return d->m_toolTip;
 }
@@ -321,12 +321,12 @@ QString JsonFieldPage::Field::persistenceKey() const
     return d->m_persistenceKey;
 }
 
-bool JsonFieldPage::Field::isMandatory()
+bool JsonFieldPage::Field::isMandatory() const
 {
     return d->m_isMandatory;
 }
 
-bool JsonFieldPage::Field::hasSpan()
+bool JsonFieldPage::Field::hasSpan() const
 {
     return d->m_hasSpan;
 }
@@ -351,11 +351,11 @@ QWidget *JsonFieldPage::Field::widget() const
     return d->m_widget;
 }
 
-void JsonFieldPage::Field::setTexts(const QString &n, const QString &dn, const QString &tt)
+void JsonFieldPage::Field::setTexts(const QString &name, const QString &displayName, const QString &toolTip)
 {
-    d->m_name = n;
+    d->m_name = name;
-    d->m_displayName = dn;
+    d->m_displayName = displayName;
-    d->m_toolTip = tt;
+    d->m_toolTip = toolTip;
 }
 
 void JsonFieldPage::Field::setIsMandatory(bool b)
@@ -389,6 +389,29 @@ void JsonFieldPage::Field::setPersistenceKey(const QString &key)
     d->m_persistenceKey = key;
 }
 
+inline QDebug &operator<<(QDebug &debug, const JsonFieldPage::Field::FieldPrivate &field)
+{
+    debug << "name:" << field.m_name
+          << "; displayName:" << field.m_displayName
+          << "; type:" << field.m_type
+          << "; mandatory:" << field.m_isMandatory
+          << "; hasUserChanges:" << field.m_hasUserChanges
+          << "; visibleExpression:" << field.m_visibleExpression
+          << "; enabledExpression:" << field.m_enabledExpression
+          << "; isComplete:" << field.m_isCompleteExpando
+          << "; isCompleteMessage:" << field.m_isCompleteExpandoMessage
+          << "; persistenceKey:" << field.m_persistenceKey;
+
+    return debug;
+}
+
+QDebug &operator<<(QDebug &debug, const JsonFieldPage::Field &field)
+{
+    debug << "Field{_: " << *field.d << "; subclass: " << field.toString() << "}";
+
+    return debug;
+}
+
 // --------------------------------------------------------------------
 // LabelFieldData:
 // --------------------------------------------------------------------
@@ -1132,7 +1155,7 @@ void ListField::setSelectionModel(QItemSelectionModel *selectionModel)
     m_selectionModel = selectionModel;
 }
 
-QSize ListField::maxIconSize()
+QSize ListField::maxIconSize() const
 {
     return m_maxIconSize;
 }
@@ -1269,7 +1292,7 @@ void IconListField::initializeData(MacroExpander *expander)
     w->setSpacing(spacing);
     w->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
 
-    // adding a third hight of the icon to see following items if there are some
+    // adding 1/3 height of the icon to see following items if there are some
     w->setMinimumHeight(maxIconSize().height() + maxIconSize().height() / 3);
     w->setIconSize(maxIconSize());
 }

src/plugins/projectexplorer/jsonwizard/jsonfieldpage.h

@@ -80,12 +80,12 @@ public:
 
         QWidget *widget(const QString &displayName, JsonFieldPage *page);
 
-        QString name();
+        QString name() const;
-        QString displayName();
+        QString displayName() const;
-        QString toolTip();
+        QString toolTip() const;
         QString persistenceKey() const;
-        bool isMandatory();
+        bool isMandatory() const;
-        bool hasSpan();
+        bool hasSpan() const;
         bool hasUserChanges() const;
 
     protected:
@@ -96,14 +96,14 @@ public:
         virtual void setup(JsonFieldPage *page, const QString &name)
         { Q_UNUSED(page); Q_UNUSED(name) }
 
-        QString type();
+        QString type() const;
         void setHasUserChanges();
 
     private:
         virtual void fromSettings(const QVariant &value);
         virtual QVariant toSettings() const;
 
-        void setTexts(const QString &n, const QString &dn, const QString &tt);
+        void setTexts(const QString &name, const QString &displayName, const QString &toolTip);
         void setIsMandatory(bool b);
         void setHasSpan(bool b);
 
@@ -111,8 +111,10 @@ public:
         void setEnabledExpression(const QVariant &v);
         void setIsCompleteExpando(const QVariant &v, const QString &m);
         void setPersistenceKey(const QString &key);
+        virtual QString toString() const = 0;
 
         friend class JsonFieldPage;
+        friend PROJECTEXPLORER_EXPORT QDebug &operator<<(QDebug &d, const Field &f);
 
         const std::unique_ptr<FieldPrivate> d;
     };
@@ -153,4 +155,6 @@ private:
     Utils::MacroExpander *m_expander;
 };
 
+PROJECTEXPLORER_EXPORT QDebug &operator<<(QDebug &debug, const JsonFieldPage::Field &field);
+
 } // namespace ProjectExplorer

src/plugins/projectexplorer/jsonwizard/jsonfieldpage_p.h

@@ -32,13 +32,13 @@
 #include <QWidget>
 #include <QString>
 #include <QVariant>
+#include <QStandardItem>
 #include <QDir>
 
 #include <memory>
 #include <vector>
 
 QT_BEGIN_NAMESPACE
-class QStandardItem;
 class QStandardItemModel;
 class QItemSelectionModel;
 QT_END_NAMESPACE
@@ -78,6 +78,14 @@ public:
 class LabelField : public JsonFieldPage::Field
 {
 private:
+    QString toString() const override
+    {
+        QString result;
+        QTextStream out(&result);
+        out << "LabelField{text:" << m_text << "}";
+        return result;
+    }
+
     QWidget *createWidget(const QString &displayName, JsonFieldPage *page) override;
     bool parseData(const QVariant &data, QString *errorMessage) override;
 
@@ -91,6 +99,14 @@ public:
     bool suppressName() const override { return true; }
 
 private:
+    QString toString() const override
+    {
+        QString result;
+        QTextStream out(&result);
+        out << "SpacerField{factor:" << m_factor << "}";
+        return result;
+    }
+
     bool parseData(const QVariant &data, QString *errorMessage) override;
     QWidget *createWidget(const QString &displayName, JsonFieldPage *page) override;
 
@@ -113,6 +129,22 @@ private:
 
     void setupCompletion(Utils::FancyLineEdit *lineEdit);
 
+    QString toString() const override
+    {
+        QString result;
+        QTextStream out(&result);
+        out << "LineEditField{currentText:" << m_currentText
+            << "; default:" << m_defaultText
+            << "; placeholder:" << m_placeholderText
+            << "; history id:" << m_historyId
+            << "; validator: " << m_validatorRegExp.pattern()
+            << "; fixupExpando: " << m_fixupExpando
+            << "; completion: " << QString::number((int)m_completion)
+            << "}";
+        return result;
+
+    }
+
     bool m_isModified = false;
     bool m_isValidating = false;
     bool m_restoreLastHistoryItem = false;
@@ -143,6 +175,17 @@ private:
     void fromSettings(const QVariant &value) override;
     QVariant toSettings() const override;
 
+    QString toString() const override
+    {
+        QString result;
+        QTextStream out(&result);
+        out << "TextEditField{default:" << m_defaultText
+            << "; rich:" << m_acceptRichText
+            << "; disabled: " << m_disabledText
+            << "}";
+        return result;
+    }
+
     QString m_defaultText;
     bool m_acceptRichText = false;
     QString m_disabledText;
@@ -166,6 +209,19 @@ private:
     void fromSettings(const QVariant &value) override;
     QVariant toSettings() const override;
 
+    QString toString() const override
+    {
+        QString result;
+        QTextStream out(&result);
+        out << "PathChooser{path:" << m_path
+            << "; base:" << m_basePath
+            << "; historyId:" << m_historyId
+            << "; kind:" << (int)Utils::PathChooser::ExistingDirectory
+            << "; currentPath:" << m_currentPath
+            << "}";
+        return result;
+    }
+
     QString m_path;
     QString m_basePath;
     QString m_historyId;
@@ -191,6 +247,20 @@ private:
     void fromSettings(const QVariant &value) override;
     QVariant toSettings() const override;
 
+    QString toString() const override
+    {
+        QString result;
+        QTextStream out(&result);
+        out << "CheckBoxField{checked:" << m_checkedValue
+            << "; unchecked: " + m_uncheckedValue
+            << "; checkedExpression: QVariant("
+            << m_checkedExpression.typeName() << ":" << m_checkedExpression.toString()
+            <<  ")"
+            << "; isModified:" << m_isModified
+            << "}";
+        return result;
+    }
+
     QString m_checkedValue;
     QString m_uncheckedValue;
     QVariant m_checkedExpression;
@@ -220,7 +290,27 @@ public:
     QStandardItemModel *itemModel();
     QItemSelectionModel *selectionModel() const;
     void setSelectionModel(QItemSelectionModel *selectionModel);
-    QSize maxIconSize();
+    QSize maxIconSize() const;
+
+    QString toString() const override
+    {
+        QString result;
+        QTextStream out(&result);
+        out << "ListField{index:" << m_index
+            << "; disabledIndex:" << m_disabledIndex
+            << "; savedIndex: " << m_savedIndex
+            << "; items Count: " << m_itemList.size()
+            << "; items:";
+
+        if (m_itemList.empty())
+            out << "(empty)";
+        else
+            out << m_itemList.front()->text() << ", ...";
+
+        out << "}";
+
+        return result;
+    }
 
 private:
     void addPossibleIconSize(const QIcon &icon);
@@ -246,6 +336,14 @@ private:
     QWidget *createWidget(const QString &displayName, JsonFieldPage *page) override;
     void initializeData(Utils::MacroExpander *expander) override;
     QVariant toSettings() const override;
+
+    QString toString() const override
+    {
+        QString result;
+        QTextStream out(&result);
+        out << "ComboBox{" << ListField::toString() << "}";
+        return result;
+    }
 };
 
 class IconListField : public ListField
@@ -254,6 +352,14 @@ public:
     void setup(JsonFieldPage *page, const QString &name) override;
     QWidget *createWidget(const QString &displayName, JsonFieldPage *page) override;
     void initializeData(Utils::MacroExpander *expander) override;
+
+    QString toString() const override
+    {
+        QString result;
+        QTextStream out(&result);
+        out << "IconList{" << ListField::toString()<< "}";
+        return result;
+    }
 };
 
 } // namespace ProjectExplorer

src/plugins/projectexplorer/jsonwizard/jsonwizard.h

@@ -105,6 +105,8 @@ public:
         QVariant m_condition;
         QVariant m_evaluate;
 
+        friend QDebug &operator<<(QDebug &debug, const OptionDefinition &option);
+
         friend class JsonWizard;
     };
     static QList<OptionDefinition> parseOptions(const QVariant &v, QString *errorMessage);
@@ -147,4 +149,22 @@ private:
     Core::JsExpander m_jsExpander;
 };
 
+inline QDebug &operator<<(QDebug &debug, const JsonWizard::GeneratorFile &file)
+{
+    debug << "GeneratorFile{file: " << file.file << "}";
+
+    return debug;
+}
+
+inline QDebug &operator<<(QDebug &debug, const JsonWizard::OptionDefinition &option)
+{
+    debug << "Option{"
+      << "key:" << option.m_key
+      << "; value:" << option.m_value
+      << "; evaluate:" << option.m_evaluate
+      << "; condition:" << option.m_condition
+      << "}";
+    return debug;
+}
+
 } // namespace ProjectExplorer

src/plugins/projectexplorer/jsonwizard/jsonwizard.pri

@@ -10,7 +10,8 @@ HEADERS += $$PWD/jsonfieldpage.h \
     $$PWD/jsonwizardgeneratorfactory.h \
     $$PWD/jsonwizardpagefactory.h \
     $$PWD/jsonwizardpagefactory_p.h \
-    $$PWD/jsonwizardscannergenerator.h
+    $$PWD/jsonwizardscannergenerator.h \
+    $$PWD/wizarddebug.h
 
 SOURCES += $$PWD/jsonfieldpage.cpp \
     $$PWD/jsonfilepage.cpp \

src/plugins/projectexplorer/jsonwizard/jsonwizardfilegenerator.h

@@ -64,7 +64,19 @@ private:
                                      QString *errorMessage);
 
     QList<File> m_fileList;
+    friend QDebug &operator<<(QDebug &debug, const File &file);
 };
 
+inline QDebug &operator<<(QDebug &debug, const JsonWizardFileGenerator::File &file)
+{
+    debug << "WizardFile{"
+          << "source:" << file.source
+          << "; target:" << file.target
+          << "; condition:" << file.condition
+          << "; options:" << file.options
+          << "}";
+    return debug;
+}
+
 } // namespace Internal
 } // namespace ProjectExplorer

src/plugins/projectexplorer/jsonwizard/wizarddebug.h

@@ -0,0 +1,117 @@
+/****************************************************************************
+**
+** Copyright (C) 2021 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt Creator.
+**
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 as published by the Free Software
+** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+****************************************************************************/
+
+#pragma once
+
+#include <algorithm>
+
+#include <QString>
+#include <QDebug>
+#include <QVariant>
+
+namespace ProjectExplorer {
+QDebug &operator<<(QDebug &debug, const QList<QVariant> &container);
+QDebug &operator<<(QDebug &debug, const QMap<QString, QVariant> &container);
+QDebug &debugString(QDebug &debug, const QString &value);
+
+inline QDebug &operator<<(QDebug &dbg, const QVariant &var)
+{
+    switch (var.typeId()) {
+    case QMetaType::UnknownType:
+        dbg << "(invalid)";
+        break;
+    case QMetaType::QString:
+        debugString(dbg, var.toString());
+        break;
+    case QMetaType::QStringList:
+        dbg << var.toList();
+        break;
+    case QVariant::List:
+        dbg << var.toList();
+        break;
+    case QVariant::Map:
+        dbg << var.toMap();
+        break;
+    default: {
+        QMetaType metaType(var.typeId());
+        bool streamed = metaType.debugStream(dbg, var.data());
+        if (!streamed && var.canConvert<QString>())
+            dbg << var.toString();
+    } break;
+    }
+
+    return dbg;
+}
+
+inline QDebug &operator<<(QDebug &dbg, const QList<QVariant> &c)
+{
+    QDebugStateSaver saver(dbg);
+    dbg.nospace();
+
+    dbg << "[";
+    if (!c.empty()) {
+        std::for_each(std::cbegin(c), std::cend(c) - 1, [&dbg](auto item) {
+            dbg << item << ", ";
+        });
+        dbg << c.back();
+    }
+
+    dbg << "] ";
+
+    return dbg;
+}
+
+inline QDebug &operator<<(QDebug &dbg, const QMap<QString, QVariant> &m)
+{
+    QDebugStateSaver saver(dbg);
+
+    dbg.nospace();
+
+    dbg << "{";
+    if (!m.empty()) {
+        auto keys = m.keys();
+        std::for_each(std::cbegin(keys), std::cend(keys) - 1, [&dbg, &m](const QString &k) {
+            dbg << k << ":" << m[k] << ",";
+        });
+        auto lastKey = keys.back();
+        dbg << lastKey << ":" << m[lastKey];
+    }
+
+    dbg << "}";
+
+    return dbg;
+}
+
+inline QDebug &debugString(QDebug &dbg, const QString &value)
+{
+    QDebugStateSaver saver(dbg);
+
+    dbg.noquote();
+    dbg << value;
+
+    return dbg;
+}
+
+} // ProjectExplorer

src/plugins/projectexplorer/projectexplorer.qbs

@@ -186,7 +186,8 @@ Project {
                 "jsonwizardgeneratorfactory.cpp", "jsonwizardgeneratorfactory.h",
                 "jsonwizardpagefactory.cpp", "jsonwizardpagefactory.h",
                 "jsonwizardpagefactory_p.cpp", "jsonwizardpagefactory_p.h",
-                "jsonwizardscannergenerator.cpp", "jsonwizardscannergenerator.h"
+                "jsonwizardscannergenerator.cpp", "jsonwizardscannergenerator.h",
+                "wizarddebug.h"
             ]
         }