Designer: Fix the mapping between buttons and edit mode

The tool buttons for switching the edit mode e.g. between "edit",
"signals/slots", and "buddy" hardcoded the index of the corresponding
tool in designer. The index in designer depends on the load order of
(static) plugins, that has changed in qtbase
2f226336a2aeb477b7ba339b6c3a63abb69746c3 (Qt 6.5.1 and later).

Instead of relying on the index/plugin load order, try to find the right
tool by class name (still falling back to the index otherwise).

It would be nicer if the tools had actual IDs though, but that change
would need to go into Designer first.

Fixes: QTCREATORBUG-30017
Change-Id: I17caea6289574db2b1c8934e80d865a142b74725
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>

src/plugins/designer/formeditor.cpp

@@ -32,14 +32,15 @@
 #include <utils/stringutils.h>
 #include <utils/theme/theme.h>
 
-#include <QDesignerFormEditorPluginInterface>
-#include <QDesignerFormEditorInterface>
-#include <QDesignerComponents>
-#include <QDesignerFormWindowManagerInterface>
-#include <QDesignerWidgetBoxInterface>
 #include <abstractobjectinspector.h>
-#include <QDesignerPropertyEditorInterface>
 #include <QDesignerActionEditorInterface>
+#include <QDesignerComponents>
+#include <QDesignerFormEditorInterface>
+#include <QDesignerFormEditorPluginInterface>
+#include <QDesignerFormWindowManagerInterface>
+#include <QDesignerFormWindowToolInterface>
+#include <QDesignerPropertyEditorInterface>
+#include <QDesignerWidgetBoxInterface>
 
 #include <QAction>
 #include <QActionGroup>
@@ -128,6 +129,13 @@ public:
     }
 };
 
+class ToolData
+{
+public:
+    int index;
+    QByteArray className;
+};
+
 // FormEditorData
 
 class FormEditorData : public QObject
@@ -136,8 +144,8 @@ public:
     FormEditorData();
     ~FormEditorData();
 
-    void activateEditMode(int id);
+    void activateEditMode(const ToolData &toolData);
-    void toolChanged(int);
+    void toolChanged(QDesignerFormWindowInterface *form, int);
     void print();
     void setPreviewMenuEnabled(bool e);
     void updateShortcut(Command *command);
@@ -165,6 +173,7 @@ public:
                                   const QString &actionName,
                                   Id id,
                                   int toolNumber,
+                                  const QByteArray &toolClassName,
                                   const QString &iconName = QString(),
                                   const QString &keySequence = QString());
     Command *addToolAction(QAction *a,
@@ -531,30 +540,53 @@ void FormEditorData::setupActions()
 
     m_actionGroupEditMode = new QActionGroup(this);
     m_actionGroupEditMode->setExclusive(true);
-    QObject::connect(m_actionGroupEditMode, &QActionGroup::triggered, this,
+    QObject::connect(m_actionGroupEditMode, &QActionGroup::triggered, this, [this](QAction *a) {
-            [this](QAction *a) { activateEditMode(a->data().toInt()); });
+        activateEditMode(a->data().value<ToolData>());
+    });
 
     medit->addSeparator(m_contexts, Core::Constants::G_EDIT_OTHER);
 
     m_toolActionIds.push_back("FormEditor.WidgetEditor");
-    createEditModeAction(m_actionGroupEditMode, m_contexts, medit,
+    createEditModeAction(m_actionGroupEditMode,
-                         Tr::tr("Edit Widgets"), m_toolActionIds.back(),
+                         m_contexts,
-                         EditModeWidgetEditor, "widgettool.png", Tr::tr("F3"));
+                         medit,
+                         Tr::tr("Edit Widgets"),
+                         m_toolActionIds.back(),
+                         EditModeWidgetEditor,
+                         "qdesigner_internal::WidgetEditorTool",
+                         "widgettool.png",
+                         Tr::tr("F3"));
 
     m_toolActionIds.push_back("FormEditor.SignalsSlotsEditor");
-    createEditModeAction(m_actionGroupEditMode, m_contexts, medit,
+    createEditModeAction(m_actionGroupEditMode,
-                         Tr::tr("Edit Signals/Slots"), m_toolActionIds.back(),
+                         m_contexts,
-                         EditModeSignalsSlotEditor, "signalslottool.png", Tr::tr("F4"));
+                         medit,
+                         Tr::tr("Edit Signals/Slots"),
+                         m_toolActionIds.back(),
+                         EditModeSignalsSlotEditor,
+                         "qdesigner_internal::SignalSlotEditorTool",
+                         "signalslottool.png",
+                         Tr::tr("F4"));
 
     m_toolActionIds.push_back("FormEditor.BuddyEditor");
-    createEditModeAction(m_actionGroupEditMode, m_contexts, medit,
+    createEditModeAction(m_actionGroupEditMode,
-                         Tr::tr("Edit Buddies"), m_toolActionIds.back(),
+                         m_contexts,
-                         EditModeBuddyEditor, "buddytool.png");
+                         medit,
+                         Tr::tr("Edit Buddies"),
+                         m_toolActionIds.back(),
+                         EditModeBuddyEditor,
+                         "qdesigner_internal::BuddyEditorTool",
+                         "buddytool.png");
 
     m_toolActionIds.push_back("FormEditor.TabOrderEditor");
-    createEditModeAction(m_actionGroupEditMode, m_contexts, medit,
+    createEditModeAction(m_actionGroupEditMode,
-                         Tr::tr("Edit Tab Order"),  m_toolActionIds.back(),
+                         m_contexts,
-                         EditModeTabOrderEditor, "tabordertool.png");
+                         medit,
+                         Tr::tr("Edit Tab Order"),
+                         m_toolActionIds.back(),
+                         EditModeTabOrderEditor,
+                         "qdesigner_internal::TabOrderEditorTool",
+                         "tabordertool.png");
 
     //tool actions
     m_toolActionIds.push_back("FormEditor.LayoutHorizontally");
@@ -729,6 +761,7 @@ QAction *FormEditorData::createEditModeAction(QActionGroup *ag,
                                               const QString &actionName,
                                               Id id,
                                               int toolNumber,
+                                              const QByteArray &toolClassName,
                                               const QString &iconName,
                                               const QString &keySequence)
 {
@@ -742,7 +775,7 @@ QAction *FormEditorData::createEditModeAction(QActionGroup *ag,
         command->setDefaultKeySequence(QKeySequence(keySequence));
     bindShortcut(command, rc);
     medit->addAction(command, Core::Constants::G_EDIT_OTHER);
-    rc->setData(toolNumber);
+    rc->setData(QVariant::fromValue(ToolData{toolNumber, toolClassName}));
     ag->addAction(rc);
     return rc;
 }
@@ -770,8 +803,9 @@ IEditor *FormEditorData::createEditor()
     QDesignerFormWindowInterface *form = m_fwm->createFormWindow(nullptr);
     QTC_ASSERT(form, return nullptr);
     form->setPalette(Theme::initialPalette());
-    connect(form, &QDesignerFormWindowInterface::toolChanged,
+    connect(form, &QDesignerFormWindowInterface::toolChanged, this, [this, form](int index) {
-            this, &FormEditorData::toolChanged);
+        toolChanged(form, index);
+    });
 
     auto widgetHost = new SharedTools::WidgetHost( /* parent */ nullptr, form);
     FormWindowEditor *formWindowEditor = m_xmlEditorFactory->create(form);
@@ -824,28 +858,50 @@ void FormEditorData::updateShortcut(Command *command)
         a->setShortcut(command->action()->shortcut());
 }
 
-void FormEditorData::activateEditMode(int id)
+static void setTool(QDesignerFormWindowInterface *formWindow, const ToolData &toolData)
 {
-    if (const int count = m_fwm->formWindowCount())
+    // check for tool action with correct object name,
-        for (int i = 0; i <  count; i++)
+    // otherwise fall back to index
-             m_fwm->formWindow(i)->setCurrentTool(id);
+    if (!toolData.className.isEmpty()) {
+        const int toolCount = formWindow->toolCount();
+        for (int tool = 0; tool < toolCount; ++tool) {
+            if (formWindow->tool(tool)->metaObject()->className() == toolData.className) {
+                formWindow->setCurrentTool(tool);
+                return;
+            }
+        }
+    }
+    formWindow->setCurrentTool(toolData.index);
 }
 
-void FormEditorData::toolChanged(int t)
+void FormEditorData::activateEditMode(const ToolData &toolData)
 {
-    typedef QList<QAction *> ActionList;
+    if (const int count = m_fwm->formWindowCount()) {
-    if (const QAction *currentAction = m_actionGroupEditMode->checkedAction())
+        for (int i = 0; i < count; i++)
-        if (currentAction->data().toInt() == t)
+            setTool(m_fwm->formWindow(i), toolData);
-            return;
-    const ActionList actions = m_actionGroupEditMode->actions();
-    const ActionList::const_iterator cend = actions.constEnd();
-    for (ActionList::const_iterator it = actions.constBegin(); it != cend; ++it)
-        if ( (*it)->data().toInt() == t) {
-            (*it)->setChecked(true);
-            break;
     }
 }
 
+void FormEditorData::toolChanged(QDesignerFormWindowInterface *form, int t)
+{
+    // check for action with correct object name,
+    // otherwise fall back to index
+    QDesignerFormWindowToolInterface *tool = form->tool(t);
+    const QList<QAction *> actions = m_actionGroupEditMode->actions();
+    QAction *candidateByIndex = nullptr;
+    for (QAction *action : actions) {
+        const auto toolData = action->data().value<ToolData>();
+        if (!toolData.className.isEmpty() && toolData.className == tool->metaObject()->className()) {
+            action->setChecked(true);
+            return;
+        }
+        if (toolData.index == t)
+            candidateByIndex = action;
+    }
+    if (candidateByIndex)
+        candidateByIndex->setChecked(true);
+}
+
 void FormEditorData::print()
 {
     // Printing code courtesy of designer_actions.cpp
@@ -933,3 +989,5 @@ void addPluginPath(const QString &pluginPath)
 
 } // namespace Internal
 } // namespace Designer
+
+Q_DECLARE_METATYPE(Designer::Internal::ToolData)