CppTools/ProjectManagers: Reduce ui blocking when loading projects

${AnyProject}::updateCppCodeModel() did two potentially not that cheap
operations in the ui thread:
 (1) Querying the MimeDatabase for the mime type for the source files of
     the project. In 99.9% of the cases no files need to be read for
     this as the file extension will resolve the type. The expensiveness
     comes from the sheer number of files that can occur.
 (2) Calling compilers with the "(sub)project's compiler command line"
     to determine the macros. While the caches avoid redundant calls,
     the number of the unique compiler calls makes this still a
     ui-freezing experience.

These two operations are moved into a worker thread. For this, the
expensive compiler calls are encapsulated in thread safe lambdas
("runners") in order to keep the "mutexed" data minimal. The original
API calls of the toolchains are implemented in terms of the runners.

While adapting the project managers, remove also the calls to
setProjectLanguage(). These are redundant because all of the project
managers already set a proper value in the constructor. Also, currently
there is no need (client) to report back detection of C sources in
project parts. This also keeps CppProjectUpdater simple.

There is still room for improvement:
 * Run the compiler calls in parallel instead of sequence.
 * Ensure that the mime type for a file is determined exactly once.

Change-Id: I2efc4e132ee88e3c8f264012ec8fafe3d86c404f
Reviewed-by: Tobias Hunger <tobias.hunger@qt.io>

1 files changed, 111 insertions, 0 deletions

diff --git a/src/plugins/cpptools/cppprojectupdater.cpp b/src/plugins/cpptools/cppprojectupdater.cpp
new file mode 100644
index 0000000000..33a2b1df58
--- /dev/null
+++ b/src/plugins/cpptools/cppprojectupdater.cpp
@@ -0,0 +1,111 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 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.
+**
+****************************************************************************/
+
+#include "cppprojectupdater.h"
+
+#include "cppmodelmanager.h"
+#include "cppprojectinfogenerator.h"
+
+#include <projectexplorer/toolchainmanager.h>
+
+#include <utils/qtcassert.h>
+#include <utils/runextensions.h>
+
+namespace CppTools {
+
+CppProjectUpdater::CppProjectUpdater(ProjectExplorer::Project *project)
+    : m_project(project)
+{
+    connect(&m_generateFutureWatcher, &QFutureWatcher<void>::finished,
+            this, &CppProjectUpdater::onProjectInfoGenerated);
+}
+
+CppProjectUpdater::~CppProjectUpdater()
+{
+    cancelAndWaitForFinished();
+}
+
+void CppProjectUpdater::update(const ProjectUpdateInfo &projectUpdateInfo)
+{
+    // Stop previous update.
+    cancel();
+    m_futureInterface.waitForFinished();
+    m_futureInterface = QFutureInterface<void>();
+
+    m_projectUpdateInfo = projectUpdateInfo;
+
+    // Ensure that we do not operate on a deleted toolchain.
+    using namespace ProjectExplorer;
+    connect(ToolChainManager::instance(), &ToolChainManager::toolChainRemoved,
+            this, &CppProjectUpdater::onToolChainRemoved);
+
+    // Run the project info generator in a worker thread and continue if that one is finished.
+    const QFutureInterface<void> &futureInterface = m_futureInterface;
+    const QFuture<ProjectInfo> future = Utils::runAsync([=]() {
+        Internal::ProjectInfoGenerator generator(futureInterface, projectUpdateInfo);
+        return generator.generate();
+    });
+    m_generateFutureWatcher.setFuture(future);
+}
+
+void CppProjectUpdater::cancel()
+{
+    disconnect(&m_generateFutureWatcher);
+    m_futureInterface.cancel();
+}
+
+void CppProjectUpdater::cancelAndWaitForFinished()
+{
+    cancel();
+    m_futureInterface.waitForFinished();
+}
+
+void CppProjectUpdater::onToolChainRemoved(ProjectExplorer::ToolChain *t)
+{
+    QTC_ASSERT(t, return);
+    if (t == m_projectUpdateInfo.cToolChain || t == m_projectUpdateInfo.cxxToolChain)
+        cancelAndWaitForFinished();
+}
+
+void CppProjectUpdater::onProjectInfoGenerated()
+{
+    // From now on we do not access the toolchain anymore, so disconnect.
+    using namespace ProjectExplorer;
+    disconnect(ToolChainManager::instance(), &ToolChainManager::toolChainRemoved,
+               this, &CppProjectUpdater::onToolChainRemoved);
+
+    if (m_futureInterface.isCanceled())
+        return;
+
+    QFuture<void> future = CppModelManager::instance()
+            ->updateProjectInfo(m_futureInterface, m_generateFutureWatcher.result());
+    QTC_CHECK(future != QFuture<void>());
+
+    const ProjectInfo projectInfo = CppModelManager::instance()->projectInfo(m_project);
+    QTC_CHECK(projectInfo.isValid());
+    emit projectInfoUpdated(projectInfo);
+}
+
+} // namespace CppTools