Project Tree: Delay syncing with editor when using the context menu

When "Synchronize with Editor" is enabled, every focus change in the
application causes the current node in the project tree to be reset to
the one corresponding to the current document. In order to still be able
to use the context menu, there is a flag in the project tree suppressing
this behavior for as long as the context menu is open. However, some
actions offered by the context menu open an additional dialog, and it is
confusing to users if the current node changes at this point.
We therefore extend abovementioned hack so that the suppression of
automatic syncing is extended for the lifetime of the function called
from the context menu.

Fixes: QTCREATORBUG-24699
Change-Id: I209150aee76e534a966efc4d0afe5261d6dcd521
Reviewed-by: hjk <hjk@qt.io>

src/plugins/projectexplorer/projectexplorer.cpp

@@ -1712,6 +1712,7 @@ bool ProjectExplorerPlugin::initialize(const QStringList &arguments, QString *er
     connect(dd->m_filePropertiesAction, &QAction::triggered, this, []() {
                 const Node *currentNode = ProjectTree::currentNode();
                 QTC_ASSERT(currentNode && currentNode->asFileNode(), return);
+                ProjectTree::CurrentNodeKeeper nodeKeeper;
                 DocumentManager::showFilePropertiesDialog(currentNode->filePath());
             });
     connect(dd->m_removeFileAction, &QAction::triggered,
@@ -3618,6 +3619,8 @@ void ProjectExplorerPluginPrivate::removeFile()
     const Node *currentNode = ProjectTree::currentNode();
     QTC_ASSERT(currentNode && currentNode->asFileNode(), return);
 
+    ProjectTree::CurrentNodeKeeper nodeKeeper;
+
     const Utils::FilePath filePath = currentNode->filePath();
     using NodeAndPath = QPair<const Node *, Utils::FilePath>;
     QList<NodeAndPath> filesToRemove{qMakePair(currentNode, currentNode->filePath())};
@@ -3685,6 +3688,8 @@ void ProjectExplorerPluginPrivate::duplicateFile()
     Node *currentNode = ProjectTree::currentNode();
     QTC_ASSERT(currentNode && currentNode->asFileNode(), return);
 
+    ProjectTree::CurrentNodeKeeper nodeKeeper;
+
     FileNode *fileNode = currentNode->asFileNode();
     QString filePath = currentNode->filePath().toString();
     QFileInfo sourceFileInfo(filePath);
@@ -3725,6 +3730,8 @@ void ProjectExplorerPluginPrivate::deleteFile()
     Node *currentNode = ProjectTree::currentNode();
     QTC_ASSERT(currentNode && currentNode->asFileNode(), return);
 
+    ProjectTree::CurrentNodeKeeper nodeKeeper;
+
     FileNode *fileNode = currentNode->asFileNode();
 
     QString filePath = currentNode->filePath().toString();

src/plugins/projectexplorer/projecttree.cpp

@@ -490,7 +490,23 @@ const QList<Node *> ProjectTree::siblingsWithSameBaseName(const Node *fileNode)
 
 void ProjectTree::hideContextMenu()
 {
+    if (m_keepCurrentNodeRequests == 0)
         m_focusForContextMenu = nullptr;
 }
 
+ProjectTree::CurrentNodeKeeper::CurrentNodeKeeper()
+    : m_active(ProjectTree::instance()->m_focusForContextMenu)
+{
+    if (m_active)
+        ++ProjectTree::instance()->m_keepCurrentNodeRequests;
+}
+
+ProjectTree::CurrentNodeKeeper::~CurrentNodeKeeper()
+{
+    if (m_active && --ProjectTree::instance()->m_keepCurrentNodeRequests == 0) {
+        ProjectTree::instance()->m_focusForContextMenu = nullptr;
+        ProjectTree::instance()->update();
+    }
+}
+
 } // namespace ProjectExplorer

src/plugins/projectexplorer/projecttree.h

@@ -60,6 +60,14 @@ public:
     static Node *currentNode();
     static Utils::FilePath currentFilePath();
 
+    class CurrentNodeKeeper {
+    public:
+        CurrentNodeKeeper();
+        ~CurrentNodeKeeper();
+    private:
+        const bool m_active = false;
+    };
+
     // Integration with ProjectTreeWidget
     static void registerWidget(Internal::ProjectTreeWidget *widget);
     static void unregisterWidget(Internal::ProjectTreeWidget *widget);
@@ -131,6 +139,7 @@ private:
     Node *m_currentNode = nullptr;
     Project *m_currentProject = nullptr;
     Internal::ProjectTreeWidget *m_focusForContextMenu = nullptr;
+    int m_keepCurrentNodeRequests = 0;
     Core::Context m_lastProjectContext;
 };