Enabled the use of promoted widgets in new form templates.

The form builder used for preview of the templates did not implement
custom widget handling (FormBuilder::createCustomWidgets()).
On encountering a promoted widget, the widget factory
would then create a Widget Database entry specifying QWidget
inheritance (emergency fallback) which could not be overidden later
on.
To fix this, moved the code for handling custom widgets from
QDesignerResource to QSimpleResource and create a new
formbuilder class that handles it especially for the New Form Dialog
preview.

Task-number:  254282

6 files changed, 183 insertions, 124 deletions

diff --git a/tools/designer/src/components/formeditor/qdesigner_resource.cpp b/tools/designer/src/components/formeditor/qdesigner_resource.cpp
index 75a53b7..5f53ae2 100644
--- a/tools/designer/src/components/formeditor/qdesigner_resource.cpp
+++ b/tools/designer/src/components/formeditor/qdesigner_resource.cpp
@@ -743,26 +743,6 @@ void QDesignerResource::setSaveRelative(bool relative)
     m_resourceBuilder->setSaveRelative(relative);
 }
 
-static bool addFakeMethods(const DomSlots *domSlots, QStringList &fakeSlots, QStringList &fakeSignals)
-{
-    if (!domSlots)
-        return false;
-
-    bool rc = false;
-    foreach (const QString &fakeSlot, domSlots->elementSlot())
-        if (fakeSlots.indexOf(fakeSlot) == -1) {
-            fakeSlots += fakeSlot;
-            rc = true;
-        }
-
-    foreach (const QString &fakeSignal, domSlots->elementSignal())
-        if (fakeSignals.indexOf(fakeSignal) == -1) {
-            fakeSignals += fakeSignal;
-            rc = true;
-        }
-    return rc;
-}
-
 QWidget *QDesignerResource::create(DomUI *ui, QWidget *parentWidget)
 {
     // Load extra info extension. This is used by Jambi for preventing
@@ -1425,108 +1405,9 @@ DomLayoutItem *QDesignerResource::createDom(QLayoutItem *item, DomLayout *ui_lay
     return ui_item;
 }
 
-static void addFakeMethodsToWidgetDataBase(const DomCustomWidget *domCustomWidget, WidgetDataBaseItem *item)
-{
-    const DomSlots *domSlots = domCustomWidget->elementSlots();
-    if (!domSlots)
-        return;
-
-    // Merge in new slots, signals
-    QStringList fakeSlots = item->fakeSlots();
-    QStringList fakeSignals = item->fakeSignals();
-    if (addFakeMethods(domSlots, fakeSlots, fakeSignals)) {
-        item->setFakeSlots(fakeSlots);
-        item->setFakeSignals(fakeSignals);
-    }
-}
-
-void QDesignerResource::addCustomWidgetsToWidgetDatabase(DomCustomWidgetList& custom_widget_list)
-{
-    // Perform one iteration of adding the custom widgets to the database,
-    // looking up the base class and inheriting its data.
-    // Remove the succeeded custom widgets from the list.
-    // Classes whose base class could not be found are left in the list.
-    QDesignerWidgetDataBaseInterface *db = m_formWindow->core()->widgetDataBase();
-    for (int i=0; i < custom_widget_list.size(); ) {
-        bool classInserted = false;
-        DomCustomWidget *custom_widget = custom_widget_list[i];
-        const QString customClassName = custom_widget->elementClass();
-        const QString base_class = custom_widget->elementExtends();
-        QString includeFile;
-        IncludeType includeType = IncludeLocal;
-        if (const DomHeader *header = custom_widget->elementHeader()) {
-            includeFile = header->text();
-            if (header->hasAttributeLocation() && header->attributeLocation() == QLatin1String("global"))
-                includeType = IncludeGlobal;
-        }
-        const bool domIsContainer = custom_widget->elementContainer();
-        // Append a new item
-        if (base_class.isEmpty()) {
-            WidgetDataBaseItem *item = new WidgetDataBaseItem(customClassName);
-            item->setPromoted(false);
-            item->setGroup(QApplication::translate("Designer", "Custom Widgets"));
-            item->setIncludeFile(buildIncludeFile(includeFile, includeType));
-            item->setContainer(domIsContainer);
-            item->setCustom(true);
-            addFakeMethodsToWidgetDataBase(custom_widget, item);
-            db->append(item);
-            custom_widget_list.removeAt(i);
-            classInserted = true;
-        } else {
-            // Create a new entry cloned from base class. Note that this will ignore existing
-            // classes, eg, plugin custom widgets.
-            QDesignerWidgetDataBaseItemInterface *item =
-                appendDerived(db, customClassName, QApplication::translate("Designer", "Promoted Widgets"),
-                              base_class,
-                              buildIncludeFile(includeFile, includeType),
-                              true,true);
-            // Ok, base class found.
-            if (item) {
-                // Hack to accommodate for old UI-files in which "contains" is not set properly:
-                // Apply "contains" from DOM only if true (else, eg classes from QFrame might not accept
-                // dropping child widgets on them as container=false). This also allows for
-                // QWidget-derived stacked pages.
-                if (domIsContainer)
-                    item->setContainer(domIsContainer);
-
-                addFakeMethodsToWidgetDataBase(custom_widget, static_cast<WidgetDataBaseItem*>(item));
-                custom_widget_list.removeAt(i);
-                classInserted = true;
-            }
-        }
-        // Skip failed item.
-        if (!classInserted)
-            i++;
-    }
-
-}
 void QDesignerResource::createCustomWidgets(DomCustomWidgets *dom_custom_widgets)
 {
-    if (dom_custom_widgets == 0)
-        return;
-    DomCustomWidgetList custom_widget_list = dom_custom_widgets->elementCustomWidget();
-    // Attempt to insert each item derived from its base class.
-    // This should at most require two iterations in the event that the classes are out of order
-    // (derived first, max depth: promoted custom plugin = 2)
-    for (int iteration = 0;  iteration < 2;  iteration++) {
-        addCustomWidgetsToWidgetDatabase(custom_widget_list);
-        if (custom_widget_list.empty())
-            return;
-    }
-    // Oops, there are classes left whose base class could not be found.
-    // Default them to QWidget with warnings.
-    const QString fallBackBaseClass = QLatin1String("QWidget");
-    for (int i=0; i < custom_widget_list.size(); i++ ) {
-        DomCustomWidget *custom_widget = custom_widget_list[i];
-        const QString customClassName = custom_widget->elementClass();
-        const QString base_class = custom_widget->elementExtends();
-        qDebug() << "** WARNING The base class " << base_class << " of the custom widget class " << customClassName
-            << " could not be found. Defaulting to " << fallBackBaseClass << '.';
-        custom_widget->setElementExtends(fallBackBaseClass);
-    }
-    // One more pass.
-    addCustomWidgetsToWidgetDatabase(custom_widget_list);
-    Q_ASSERT(custom_widget_list.empty());
+    QSimpleResource::handleDomCustomWidgets(core(), dom_custom_widgets);
 }
 
 DomTabStops *QDesignerResource::saveTabStops()
diff --git a/tools/designer/src/lib/shared/newformwidget.cpp b/tools/designer/src/lib/shared/newformwidget.cpp
index d79d77a..503e597 100644
--- a/tools/designer/src/lib/shared/newformwidget.cpp
+++ b/tools/designer/src/lib/shared/newformwidget.cpp
@@ -310,9 +310,8 @@ QImage NewFormWidget::grabForm(QDesignerFormEditorInterface *core,
                          const QString &workingDir,
                          const qdesigner_internal::DeviceProfile &dp)
 {
-    qdesigner_internal::QDesignerFormBuilder formBuilder(core,
-                                                         qdesigner_internal::QDesignerFormBuilder::DisableScripts,
-                                                         dp);
+    qdesigner_internal::NewFormWidgetFormBuilder
+        formBuilder(core, qdesigner_internal::QDesignerFormBuilder::DisableScripts, dp);
     if (!workingDir.isEmpty())
         formBuilder.setWorkingDirectory(workingDir);
 
diff --git a/tools/designer/src/lib/shared/qdesigner_formbuilder.cpp b/tools/designer/src/lib/shared/qdesigner_formbuilder.cpp
index 6394847..b92a48d 100644
--- a/tools/designer/src/lib/shared/qdesigner_formbuilder.cpp
+++ b/tools/designer/src/lib/shared/qdesigner_formbuilder.cpp
@@ -473,6 +473,20 @@ QPixmap QDesignerFormBuilder::createPreviewPixmap(const QDesignerFormWindowInter
     return rc;
 }
 
+// ---------- NewFormWidgetFormBuilder
+
+NewFormWidgetFormBuilder::NewFormWidgetFormBuilder(QDesignerFormEditorInterface *core,
+                             Mode mode,
+                             const DeviceProfile &deviceProfile) :
+    QDesignerFormBuilder(core, mode, deviceProfile)
+{
+}
+
+void NewFormWidgetFormBuilder::createCustomWidgets(DomCustomWidgets *dc)
+{
+    QSimpleResource::handleDomCustomWidgets(core(), dc);
+}
+
 } // namespace qdesigner_internal
 
 QT_END_NAMESPACE
diff --git a/tools/designer/src/lib/shared/qdesigner_formbuilder_p.h b/tools/designer/src/lib/shared/qdesigner_formbuilder_p.h
index b982e1c..ee40085 100644
--- a/tools/designer/src/lib/shared/qdesigner_formbuilder_p.h
+++ b/tools/designer/src/lib/shared/qdesigner_formbuilder_p.h
@@ -75,7 +75,7 @@ namespace qdesigner_internal {
 class DesignerPixmapCache;
 class DesignerIconCache;
 
-/* Form builder used for previewing forms, widget box and new form dialog.
+/* Form builder used for previewing forms and widget box.
  * It applies the system settings to its toplevel window. */
 
 class QDESIGNER_SHARED_EXPORT QDesignerFormBuilder: public QFormBuilder
@@ -159,6 +159,21 @@ private:
     bool m_mainWidget;
 };
 
+// Form builder for a new form widget (preview). To allow for promoted
+// widgets in the template, it implements the handling of custom widgets
+// (adding of them to the widget database).
+
+class QDESIGNER_SHARED_EXPORT NewFormWidgetFormBuilder: public QDesignerFormBuilder {
+public:
+    NewFormWidgetFormBuilder(QDesignerFormEditorInterface *core,
+                             Mode mode,
+                             const DeviceProfile &deviceProfile = DeviceProfile());
+
+protected:
+    virtual void createCustomWidgets(DomCustomWidgets *);
+};
+
+
 } // namespace qdesigner_internal
 
 QT_END_NAMESPACE
diff --git a/tools/designer/src/lib/shared/qsimpleresource.cpp b/tools/designer/src/lib/shared/qsimpleresource.cpp
index 8d29002..69d48fd 100644
--- a/tools/designer/src/lib/shared/qsimpleresource.cpp
+++ b/tools/designer/src/lib/shared/qsimpleresource.cpp
@@ -41,6 +41,7 @@
 
 #include "qsimpleresource_p.h"
 #include "widgetfactory_p.h"
+#include "widgetdatabase_p.h"
 
 #include <formscriptrunner_p.h>
 #include <properties_p.h>
@@ -57,6 +58,8 @@
 #include <QtGui/QWidget>
 #include <QtGui/QAction>
 #include <QtCore/QDebug>
+#include <QtCore/QCoreApplication>
+
 
 QT_BEGIN_NAMESPACE
 
@@ -267,6 +270,136 @@ bool QSimpleResource::warningsEnabled()
     return m_warningsEnabled;
 }
 
+// Custom widgets handling helpers
+
+// Add unique fake slots and signals to lists
+bool QSimpleResource::addFakeMethods(const DomSlots *domSlots, QStringList &fakeSlots, QStringList &fakeSignals)
+{
+    if (!domSlots)
+        return false;
+
+    bool rc = false;
+    foreach (const QString &fakeSlot, domSlots->elementSlot())
+        if (fakeSlots.indexOf(fakeSlot) == -1) {
+            fakeSlots += fakeSlot;
+            rc = true;
+        }
+
+    foreach (const QString &fakeSignal, domSlots->elementSignal())
+        if (fakeSignals.indexOf(fakeSignal) == -1) {
+            fakeSignals += fakeSignal;
+            rc = true;
+        }
+    return rc;
+}
+
+void QSimpleResource::addFakeMethodsToWidgetDataBase(const DomCustomWidget *domCustomWidget, WidgetDataBaseItem *item)
+{
+    const DomSlots *domSlots = domCustomWidget->elementSlots();
+    if (!domSlots)
+        return;
+
+    // Merge in new slots, signals
+    QStringList fakeSlots = item->fakeSlots();
+    QStringList fakeSignals = item->fakeSignals();
+    if (addFakeMethods(domSlots, fakeSlots, fakeSignals)) {
+        item->setFakeSlots(fakeSlots);
+        item->setFakeSignals(fakeSignals);
+    }
+}
+
+// Perform one iteration of adding the custom widgets to the database,
+// looking up the base class and inheriting its data.
+// Remove the succeeded custom widgets from the list.
+// Classes whose base class could not be found are left in the list.
+
+void QSimpleResource::addCustomWidgetsToWidgetDatabase(const QDesignerFormEditorInterface *core,
+                                                       QList<DomCustomWidget*>& custom_widget_list)
+{
+    QDesignerWidgetDataBaseInterface *db = core->widgetDataBase();
+    for (int i=0; i < custom_widget_list.size(); ) {
+        bool classInserted = false;
+        DomCustomWidget *custom_widget = custom_widget_list[i];
+        const QString customClassName = custom_widget->elementClass();
+        const QString base_class = custom_widget->elementExtends();
+        QString includeFile;
+        IncludeType includeType = IncludeLocal;
+        if (const DomHeader *header = custom_widget->elementHeader()) {
+            includeFile = header->text();
+            if (header->hasAttributeLocation() && header->attributeLocation() == QLatin1String("global"))
+                includeType = IncludeGlobal;
+        }
+        const bool domIsContainer = custom_widget->elementContainer();
+        // Append a new item
+        if (base_class.isEmpty()) {
+            WidgetDataBaseItem *item = new WidgetDataBaseItem(customClassName);
+            item->setPromoted(false);
+            item->setGroup(QCoreApplication::translate("Designer", "Custom Widgets"));
+            item->setIncludeFile(buildIncludeFile(includeFile, includeType));
+            item->setContainer(domIsContainer);
+            item->setCustom(true);
+            addFakeMethodsToWidgetDataBase(custom_widget, item);
+            db->append(item);
+            custom_widget_list.removeAt(i);
+            classInserted = true;
+        } else {
+            // Create a new entry cloned from base class. Note that this will ignore existing
+            // classes, eg, plugin custom widgets.
+            QDesignerWidgetDataBaseItemInterface *item =
+                appendDerived(db, customClassName, QCoreApplication::translate("Designer", "Promoted Widgets"),
+                              base_class,
+                              buildIncludeFile(includeFile, includeType),
+                              true,true);
+            // Ok, base class found.
+            if (item) {
+                // Hack to accommodate for old UI-files in which "container" is not set properly:
+                // Apply "container" from DOM only if true (else, eg classes from QFrame might not accept
+                // dropping child widgets on them as container=false). This also allows for
+                // QWidget-derived stacked pages.
+                if (domIsContainer)
+                    item->setContainer(domIsContainer);
+
+                addFakeMethodsToWidgetDataBase(custom_widget, static_cast<WidgetDataBaseItem*>(item));
+                custom_widget_list.removeAt(i);
+                classInserted = true;
+            }
+        }
+        // Skip failed item.
+        if (!classInserted)
+            i++;
+    }
+
+}
+
+void QSimpleResource::handleDomCustomWidgets(const QDesignerFormEditorInterface *core,
+                                             const DomCustomWidgets *dom_custom_widgets)
+{
+    if (dom_custom_widgets == 0)
+        return;
+    QList<DomCustomWidget*> custom_widget_list = dom_custom_widgets->elementCustomWidget();
+    // Attempt to insert each item derived from its base class.
+    // This should at most require two iterations in the event that the classes are out of order
+    // (derived first, max depth: promoted custom plugin = 2)
+    for (int iteration = 0;  iteration < 2;  iteration++) {
+        addCustomWidgetsToWidgetDatabase(core, custom_widget_list);
+        if (custom_widget_list.empty())
+            return;
+    }
+    // Oops, there are classes left whose base class could not be found.
+    // Default them to QWidget with warnings.
+    const QString fallBackBaseClass = QLatin1String("QWidget");
+    for (int i=0; i < custom_widget_list.size(); i++ ) {
+        DomCustomWidget *custom_widget = custom_widget_list[i];
+        const QString customClassName = custom_widget->elementClass();
+        const QString base_class = custom_widget->elementExtends();
+        qDebug() << "** WARNING The base class " << base_class << " of the custom widget class " << customClassName
+            << " could not be found. Defaulting to " << fallBackBaseClass << '.';
+        custom_widget->setElementExtends(fallBackBaseClass);
+    }
+    // One more pass.
+    addCustomWidgetsToWidgetDatabase(core, custom_widget_list);
+}
+
 // ------------ FormBuilderClipboard
 
 FormBuilderClipboard::FormBuilderClipboard(QWidget *w)
diff --git a/tools/designer/src/lib/shared/qsimpleresource_p.h b/tools/designer/src/lib/shared/qsimpleresource_p.h
index 8d45c3c..a25cb88 100644
--- a/tools/designer/src/lib/shared/qsimpleresource_p.h
+++ b/tools/designer/src/lib/shared/qsimpleresource_p.h
@@ -55,15 +55,21 @@
 
 #include "shared_global_p.h"
 #include "abstractformbuilder.h"
+#include <QtCore/QStringList>
 
 QT_BEGIN_NAMESPACE
 
 class DomScript;
+class DomCustomWidgets;
+class DomCustomWidget;
+class DomSlots;
 
 class QDesignerFormEditorInterface;
 
 namespace qdesigner_internal {
 
+class WidgetDataBaseItem;
+
 class QDESIGNER_SHARED_EXPORT QSimpleResource : public QAbstractFormBuilder
 {
 public:
@@ -92,6 +98,11 @@ public:
     static QString customWidgetScript(QDesignerFormEditorInterface *core, const QString &className);
     static bool hasCustomWidgetScript(QDesignerFormEditorInterface *core, QObject *object);
 
+    // Implementation for FormBuilder::createDomCustomWidgets() that adds
+    // the custom widgets to the widget database
+    static void handleDomCustomWidgets(const QDesignerFormEditorInterface *core,
+                                       const DomCustomWidgets *dom_custom_widgets);
+
 protected:
     virtual QIcon nameToIcon(const QString &filePath, const QString &qrcPath);
     virtual QString iconToFilePath(const QIcon &pm) const;
@@ -105,7 +116,13 @@ protected:
     typedef QList<DomScript*> DomScripts;
     static void addScript(const QString &script, ScriptSource source, DomScripts &domScripts);
 
+    static bool addFakeMethods(const DomSlots *domSlots, QStringList &fakeSlots, QStringList &fakeSignals);
+
 private:
+    static void addCustomWidgetsToWidgetDatabase(const QDesignerFormEditorInterface *core,
+                                                 QList<DomCustomWidget*>& custom_widget_list);
+    static void addFakeMethodsToWidgetDataBase(const DomCustomWidget *domCustomWidget, WidgetDataBaseItem *item);
+
     static bool m_warningsEnabled;
     QDesignerFormEditorInterface *m_core;
 };