CppTools: Check if project has changed before reparsing

This introduces an API change for the project managers. Those are not
expected to call updateSourceFiles() anymore.

Task-number: QTCREATORBUG-9581
Change-Id: I77befd29fb851c9acf87204d571da00183c9cd05
Reviewed-by: Erik Verbruggen <[email protected]>

5 files changed, 75 insertions, 14 deletions

diff --git a/src/plugins/cpptools/cppmodelmanager.cpp b/src/plugins/cpptools/cppmodelmanager.cpp
index 76b8c4e0e50..d6c718af65c 100644
--- a/src/plugins/cpptools/cppmodelmanager.cpp
+++ b/src/plugins/cpptools/cppmodelmanager.cpp
@@ -547,17 +547,24 @@ CppModelManager::ProjectInfo CppModelManager::projectInfo(ProjectExplorer::Proje
     return m_projects.value(project, ProjectInfo(project));
 }
 
-void CppModelManager::updateProjectInfo(const ProjectInfo &pinfo)
+QFuture<void> CppModelManager::updateProjectInfo(const ProjectInfo &pinfo)
 {
     { // only hold the mutex for a limited scope, so the dumping afterwards can aquire it without deadlocking.
         QMutexLocker locker(&m_projectMutex);
 
         if (! pinfo.isValid())
-            return;
+            return QFuture<void>();
 
         ProjectExplorer::Project *project = pinfo.project().data();
         ProjectInfo oldProjectInfo = m_projects.value(project);
         if (oldProjectInfo.isValid()) {
+            if (pinfo.defines() == oldProjectInfo.defines()
+                    && pinfo.includePaths() == oldProjectInfo.includePaths()
+                    && pinfo.frameworkPaths() == oldProjectInfo.frameworkPaths()
+                    && pinfo.sourceFiles() == oldProjectInfo.sourceFiles()) {
+                return QFuture<void>();
+            }
+
             foreach (const ProjectPart::Ptr &projectPart, oldProjectInfo.projectParts()) {
                 foreach (const ProjectFile &cxxFile, projectPart->files) {
                     foreach (const QString &fileName,
@@ -587,6 +594,8 @@ void CppModelManager::updateProjectInfo(const ProjectInfo &pinfo)
         dumpModelManagerConfiguration();
 
     emit projectPartsUpdated(pinfo.project().data());
+
+    return updateSourceFiles(pinfo.sourceFiles(), ForcedProgressNotification);
 }
 
 QList<ProjectPart::Ptr> CppModelManager::projectPart(const QString &fileName) const
diff --git a/src/plugins/cpptools/cppmodelmanager.h b/src/plugins/cpptools/cppmodelmanager.h
index 8e51b5e373d..5758cdb4b3f 100644
--- a/src/plugins/cpptools/cppmodelmanager.h
+++ b/src/plugins/cpptools/cppmodelmanager.h
@@ -73,7 +73,7 @@ public:
 
     virtual QList<ProjectInfo> projectInfos() const;
     virtual ProjectInfo projectInfo(ProjectExplorer::Project *project) const;
-    virtual void updateProjectInfo(const ProjectInfo &pinfo);
+    virtual QFuture<void> updateProjectInfo(const ProjectInfo &pinfo);
     virtual QList<CppTools::ProjectPart::Ptr> projectPart(const QString &fileName) const;
 
     virtual CPlusPlus::Snapshot snapshot() const;
diff --git a/src/plugins/cpptools/cppmodelmanager_test.cpp b/src/plugins/cpptools/cppmodelmanager_test.cpp
index ce47b5425bb..4971974a251 100644
--- a/src/plugins/cpptools/cppmodelmanager_test.cpp
+++ b/src/plugins/cpptools/cppmodelmanager_test.cpp
@@ -281,7 +281,6 @@ void CppToolsPlugin::test_modelmanager_refresh_also_includes_of_project_files()
     pi.appendProjectPart(part);
 
     mm->updateProjectInfo(pi);
-    mm->updateSourceFiles(QStringList() << testCpp);
 
     QStringList refreshedFiles = helper.waitForRefreshedSourceFiles();
 
@@ -291,13 +290,16 @@ void CppToolsPlugin::test_modelmanager_refresh_also_includes_of_project_files()
     QVERIFY(snapshot.contains(testHeader));
     QVERIFY(snapshot.contains(testCpp));
 
-    part->defines = QByteArray();
-    mm->updateProjectInfo(pi);
-    snapshot = mm->snapshot();
-    QVERIFY(!snapshot.contains(testHeader));
-    QVERIFY(!snapshot.contains(testCpp));
+    Document::Ptr headerDocumentBefore = snapshot.document(testHeader);
+    const QList<CPlusPlus::Macro> macrosInHeaderBefore = headerDocumentBefore->definedMacros();
+    QCOMPARE(macrosInHeaderBefore.size(), 1);
+    QVERIFY(macrosInHeaderBefore.first().name() == "test_modelmanager_refresh_h");
 
-    mm->updateSourceFiles(QStringList() << testCpp);
+    // Introduce a define that will enable another define once the document is reparsed.
+    part->defines = QByteArray("#define TEST_DEFINE 1\n");
+    pi.clearProjectParts();
+    pi.appendProjectPart(part);
+    mm->updateProjectInfo(pi);
     refreshedFiles = helper.waitForRefreshedSourceFiles();
 
     QCOMPARE(refreshedFiles.size(), 1);
@@ -305,6 +307,12 @@ void CppToolsPlugin::test_modelmanager_refresh_also_includes_of_project_files()
     snapshot = mm->snapshot();
     QVERIFY(snapshot.contains(testHeader));
     QVERIFY(snapshot.contains(testCpp));
+
+    Document::Ptr headerDocumentAfter = snapshot.document(testHeader);
+    const QList<CPlusPlus::Macro> macrosInHeaderAfter = headerDocumentAfter->definedMacros();
+    QCOMPARE(macrosInHeaderAfter.size(), 2);
+    QVERIFY(macrosInHeaderAfter.at(0).name() == "test_modelmanager_refresh_h");
+    QVERIFY(macrosInHeaderAfter.at(1).name() == "TEST_DEFINE_DEFINED");
 }
 
 /// QTCREATORBUG-9205
@@ -340,8 +348,21 @@ void CppToolsPlugin::test_modelmanager_refresh_several_times()
     QStringList refreshedFiles;
     CPlusPlus::Document::Ptr document;
 
+    QByteArray defines = "#define FIRST_DEFINE";
     for (int i = 0; i < 2; ++i) {
-        mm->updateSourceFiles(QStringList() << testHeader1 << testHeader2 << testCpp);
+        pi.clearProjectParts();
+        ProjectPart::Ptr part(new ProjectPart);
+        // Simulate project configuration change by having different defines each time.
+        defines += "\n#define ANOTHER_DEFINE";
+        part->defines = defines;
+        part->cxxVersion = ProjectPart::CXX98;
+        part->qtVersion = ProjectPart::Qt5;
+        part->files.append(ProjectFile(testHeader1, ProjectFile::CXXHeader));
+        part->files.append(ProjectFile(testHeader2, ProjectFile::CXXHeader));
+        part->files.append(ProjectFile(testCpp, ProjectFile::CXXSource));
+        pi.appendProjectPart(part);
+
+        mm->updateProjectInfo(pi);
         refreshedFiles = helper.waitForRefreshedSourceFiles();
 
         QCOMPARE(refreshedFiles.size(), 3);
@@ -366,6 +387,38 @@ void CppToolsPlugin::test_modelmanager_refresh_several_times()
     }
 }
 
+/// QTCREATORBUG-9581
+/// Check: If nothing has changes, nothing should be reindexed.
+void CppToolsPlugin::test_modelmanager_refresh_test_for_changes()
+{
+    ModelManagerTestHelper helper;
+    CppModelManager *mm = CppModelManager::instance();
+
+    const TestDataDirectory testDataDir(QLatin1String("testdata_refresh"));
+    const QString testCpp(testDataDir.file(QLatin1String("source.cpp")));
+
+    Project *project = helper.createProject(QLatin1String("test_modelmanager_refresh_2"));
+    ProjectInfo pi = mm->projectInfo(project);
+    QCOMPARE(pi.project().data(), project);
+
+    ProjectPart::Ptr part(new ProjectPart);
+    part->cxxVersion = ProjectPart::CXX98;
+    part->qtVersion = ProjectPart::Qt5;
+    part->files.append(ProjectFile(testCpp, ProjectFile::CXXSource));
+    pi.appendProjectPart(part);
+
+    // Reindexing triggers a reparsing thread
+    QFuture<void> firstFuture = mm->updateProjectInfo(pi);
+    QVERIFY(firstFuture.isStarted() || firstFuture.isRunning());
+    const QStringList refreshedFiles = helper.waitForRefreshedSourceFiles();
+    QCOMPARE(refreshedFiles.size(), 1);
+    QVERIFY(refreshedFiles.contains(testCpp));
+
+    // No reindexing since nothing has changed
+    QFuture<void> subsequentFuture = mm->updateProjectInfo(pi);
+    QVERIFY(subsequentFuture.isCanceled() && subsequentFuture.isFinished());
+}
+
 /// Check: If a second project is opened, the code model is still aware of
 ///        files of the first project.
 void CppToolsPlugin::test_modelmanager_snapshot_after_two_projects()
@@ -384,7 +437,6 @@ void CppToolsPlugin::test_modelmanager_snapshot_after_two_projects()
                                   << QLatin1String("main.cpp"));
 
     mm->updateProjectInfo(project1.projectInfo);
-    mm->updateSourceFiles(project1.projectFiles);
     refreshedFiles = helper.waitForRefreshedSourceFiles();
     QCOMPARE(refreshedFiles.toSet(), project1.projectFiles.toSet());
     const int snapshotSizeAfterProject1 = mm->snapshot().size();
@@ -400,7 +452,6 @@ void CppToolsPlugin::test_modelmanager_snapshot_after_two_projects()
                                   << QLatin1String("main.cpp"));
 
     mm->updateProjectInfo(project2.projectInfo);
-    mm->updateSourceFiles(project2.projectFiles);
     refreshedFiles = helper.waitForRefreshedSourceFiles();
     QCOMPARE(refreshedFiles.toSet(), project2.projectFiles.toSet());
 
diff --git a/src/plugins/cpptools/cppmodelmanagerinterface.h b/src/plugins/cpptools/cppmodelmanagerinterface.h
index f9d299b9377..ac1bcf9a3d4 100644
--- a/src/plugins/cpptools/cppmodelmanagerinterface.h
+++ b/src/plugins/cpptools/cppmodelmanagerinterface.h
@@ -215,7 +215,7 @@ public:
 
     virtual QList<ProjectInfo> projectInfos() const = 0;
     virtual ProjectInfo projectInfo(ProjectExplorer::Project *project) const = 0;
-    virtual void updateProjectInfo(const ProjectInfo &pinfo) = 0;
+    virtual QFuture<void> updateProjectInfo(const ProjectInfo &pinfo) = 0;
     virtual QList<ProjectPart::Ptr> projectPart(const QString &fileName) const = 0;
 
     virtual QStringList includePaths() = 0;
diff --git a/src/plugins/cpptools/cpptoolsplugin.h b/src/plugins/cpptools/cpptoolsplugin.h
index 902b5908fb0..5283c1dd83a 100644
--- a/src/plugins/cpptools/cpptoolsplugin.h
+++ b/src/plugins/cpptools/cpptoolsplugin.h
@@ -163,6 +163,7 @@ private slots:
     void test_modelmanager_framework_headers();
     void test_modelmanager_refresh_also_includes_of_project_files();
     void test_modelmanager_refresh_several_times();
+    void test_modelmanager_refresh_test_for_changes();
     void test_modelmanager_snapshot_after_two_projects();
     void test_modelmanager_extraeditorsupport_uiFiles();