Clang: Add source dependency saving to the symbol storage

The source dependencies are simply a table which connects the include file
with the included file.

Change-Id: I5454e81a2b5b98f05c7ff3f6740a6d45e01772c3
Reviewed-by: Ivan Donchevskii <ivan.donchevskii@qt.io>

src/tools/clangrefactoringbackend/source/clangrefactoringbackend-source.pri

@@ -16,7 +16,8 @@ HEADERS += \
     $$PWD/projectpartentry.h \
     $$PWD/symbolsvisitorbase.h \
     $$PWD/usedmacro.h \
-    $$PWD/fileinformation.h
+    $$PWD/fileinformation.h \
+    $$PWD/sourcedependency.h
 
 !isEmpty(LIBTOOLING_LIBS) {
 SOURCES += \

src/tools/clangrefactoringbackend/source/sourcedependency.h

@@ -0,0 +1,56 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 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.
+**
+****************************************************************************/
+
+#pragma once
+
+#include <filepathid.h>
+
+#include <vector>
+
+namespace ClangBackEnd {
+
+class SourceDependency
+{
+public:
+    SourceDependency(FilePathId filePathId,
+                    FilePathId dependencyFilePathId)
+        : filePathId(filePathId),
+          dependencyFilePathId(dependencyFilePathId)
+    {}
+
+    friend
+    bool operator==(SourceDependency first, SourceDependency second)
+    {
+        return first.filePathId == second.filePathId
+            && first.dependencyFilePathId == second.dependencyFilePathId;
+    }
+
+public:
+    FilePathId filePathId;
+    FilePathId dependencyFilePathId;
+};
+
+using SourceDependencies = std::vector<SourceDependency>;
+}

src/tools/clangrefactoringbackend/source/storagesqlitestatementfactory.h

@@ -95,12 +95,27 @@ public:
         return table;
     }
 
+    Sqlite::Table createNewSourceDependenciesTable() const
+    {
+        Sqlite::Table table;
+        table.setName("newSourceDependencies");
+        table.setUseTemporaryTable(true);
+        const Sqlite::Column &sourceIdColumn = table.addColumn("sourceId", Sqlite::ColumnType::Integer);
+        const Sqlite::Column &dependencySourceIdColumn = table.addColumn("dependencySourceId", Sqlite::ColumnType::Text);
+        table.addIndex({sourceIdColumn, dependencySourceIdColumn});
+
+        table.initialize(database);
+
+        return table;
+    }
+
 public:
     Sqlite::ImmediateTransaction transaction;
     Database &database;
     Sqlite::Table newSymbolsTablet{createNewSymbolsTable()};
     Sqlite::Table newLocationsTable{createNewLocationsTable()};
     Sqlite::Table newUsedMacroTable{createNewUsedMacrosTable()};
+    Sqlite::Table newNewSourceDependenciesTable{createNewSourceDependenciesTable()};
     WriteStatement insertSymbolsToNewSymbolsStatement{
         "INSERT INTO newSymbols(temporarySymbolId, usr, symbolName) VALUES(?,?,?)",
         database};
@@ -186,6 +201,22 @@ public:
         "INSERT OR REPLACE INTO fileInformations(sourceId, size, lastModified) VALUES (?,?,?)",
         database
     };
+   WriteStatement insertIntoNewSourceDependenciesStatement{
+       "INSERT INTO newSourceDependencies(sourceId, dependencySourceId) VALUES (?,?)",
+       database
+   };
+   WriteStatement syncNewSourceDependenciesStatement{
+        "INSERT INTO sourceDependencies(sourceId, dependencySourceId) SELECT sourceId, dependencySourceId FROM newSourceDependencies WHERE NOT EXISTS (SELECT sourceId FROM sourceDependencies WHERE sourceDependencies.sourceId == newSourceDependencies.sourceId AND sourceDependencies.dependencySourceId == newSourceDependencies.dependencySourceId)",
+        database
+    };
+   WriteStatement deleteOutdatedSourceDependenciesStatement{
+       "DELETE FROM sourceDependencies WHERE sourceId IN (SELECT sourceId FROM newSourceDependencies) AND NOT EXISTS (SELECT sourceId FROM newSourceDependencies WHERE newSourceDependencies.sourceId == sourceDependencies.sourceId AND newSourceDependencies.dependencySourceId == sourceDependencies.dependencySourceId)",
+       database
+   };
+   WriteStatement deleteNewSourceDependenciesStatement{
+       "DELETE FROM newSourceDependencies",
+       database
+   };
 };
 
 } // namespace ClangBackEnd

src/tools/clangrefactoringbackend/source/symbolstorage.h

@@ -94,6 +94,18 @@ public:
         m_statementFactory.deleteNewUsedMacrosTableStatement.execute();
     }
 
+    void insertOrUpdateSourceDependencies(const SourceDependencies &sourceDependencies) override
+    {
+        WriteStatement &insertStatement = m_statementFactory.insertIntoNewSourceDependenciesStatement;
+        for (SourceDependency sourceDependency : sourceDependencies)
+            insertStatement.write(sourceDependency.filePathId.filePathId,
+                                  sourceDependency.dependencyFilePathId.filePathId);
+
+        m_statementFactory.syncNewSourceDependenciesStatement.execute();
+        m_statementFactory.deleteOutdatedSourceDependenciesStatement.execute();
+        m_statementFactory.deleteNewSourceDependenciesStatement.execute();
+    }
+
     void updateProjectPartSources(Utils::SmallStringView projectPartName,
                                   const FilePathIds &sourceFilePathIds) override
     {

src/tools/clangrefactoringbackend/source/symbolstorageinterface.h

@@ -28,6 +28,7 @@
 #include "fileinformation.h"
 #include "projectpartentry.h"
 #include "sourcelocationentry.h"
+#include "sourcedependency.h"
 #include "symbolentry.h"
 #include "usedmacro.h"
 
@@ -52,6 +53,7 @@ public:
                                           const FilePathIds &sourceFilePathIds) = 0;
     virtual void insertOrUpdateUsedMacros(const UsedMacros &usedMacros) = 0;
     virtual void insertFileInformations(const FileInformations &fileInformations) = 0;
+    virtual void insertOrUpdateSourceDependencies(const SourceDependencies &sourceDependencies) = 0;
 };
 
 } // namespace ClangBackEnd