Clang: Add GeneratedFiles

To manage generated files it is very useful to have a class which adds,
updates and remove them.

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

src/libs/clangsupport/clangsupport-lib.pri

@@ -89,7 +89,8 @@ SOURCES += \
     $$PWD/filepathid.cpp \
     $$PWD/baseserverproxy.cpp \
     $$PWD/updategeneratedfilesmessage.cpp \
-    $$PWD/removegeneratedfilesmessage.cpp
+    $$PWD/removegeneratedfilesmessage.cpp \
+    $$PWD/generatedfiles.cpp
 
 HEADERS += \
     $$PWD/cancelmessage.h \
@@ -206,6 +207,7 @@ HEADERS += \
     $$PWD/compilermacro.h \
     $$PWD/projectpartpchproviderinterface.h \
     $$PWD/updategeneratedfilesmessage.h \
-    $$PWD/removegeneratedfilesmessage.h
+    $$PWD/removegeneratedfilesmessage.h \
+    $$PWD/generatedfiles.h
 
 contains(QT_CONFIG, reduce_exports):CONFIG += hide_symbols

src/libs/clangsupport/filecontainerv2.h

@@ -40,7 +40,7 @@ public:
 
     FileContainer(FilePath &&filePath,
                   Utils::SmallString &&unsavedFileContent,
-                  Utils::SmallStringVector &&commandLineArguments,
+                  Utils::SmallStringVector &&commandLineArguments = {},
                   quint32 documentRevision = 0)
         : filePath(std::move(filePath)),
           unsavedFileContent(std::move(unsavedFileContent)),

src/libs/clangsupport/generatedfiles.cpp

@@ -0,0 +1,81 @@
+/****************************************************************************
+**
+** 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.
+**
+****************************************************************************/
+
+#include "generatedfiles.h"
+
+namespace ClangBackEnd {
+
+void GeneratedFiles::update(V2::FileContainers &&fileContainers)
+{
+    V2::FileContainers unionFileContainers;
+    unionFileContainers.reserve(m_fileContainers.size() + fileContainers.size());
+
+    auto compare = [] (const V2::FileContainer &first, const V2::FileContainer &second) {
+        return first.filePath < second.filePath;
+    };
+
+    std::set_union(std::make_move_iterator(fileContainers.begin()),
+                   std::make_move_iterator(fileContainers.end()),
+                   std::make_move_iterator(m_fileContainers.begin()),
+                   std::make_move_iterator(m_fileContainers.end()),
+                   std::back_inserter(unionFileContainers),
+                   compare);
+
+    m_fileContainers = std::move(unionFileContainers);
+}
+
+class Compare {
+public:
+    bool operator()(const V2::FileContainer &first, const FilePath &second)
+    {
+        return first.filePath < second;
+    }
+    bool operator()(const FilePath &first, const V2::FileContainer &second)
+    {
+        return second.filePath < first;
+    }
+};
+
+void GeneratedFiles::remove(const FilePaths &filePaths)
+{
+    V2::FileContainers differenceFileContainers;
+    differenceFileContainers.reserve(m_fileContainers.size());
+
+    std::set_difference(std::make_move_iterator(m_fileContainers.begin()),
+                        std::make_move_iterator(m_fileContainers.end()),
+                        filePaths.begin(),
+                        filePaths.end(),
+                        std::back_inserter(differenceFileContainers),
+                        Compare{});
+
+    m_fileContainers = std::move(differenceFileContainers);
+}
+
+const V2::FileContainers &GeneratedFiles::fileContainers() const
+{
+    return m_fileContainers;
+}
+
+} // namespace ClangBackEnd

src/libs/clangsupport/generatedfiles.h

@@ -0,0 +1,43 @@
+/****************************************************************************
+**
+** 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 <filecontainerv2.h>
+
+namespace ClangBackEnd {
+
+class GeneratedFiles
+{
+public:
+    void update(V2::FileContainers &&fileContainers);
+    void remove(const FilePaths &filePaths);
+
+    const V2::FileContainers &fileContainers() const;
+private:
+    V2::FileContainers m_fileContainers;
+};
+
+} // namespace ClangBackEnd

tests/unit/unittest/generatedfiles-test.cpp

@@ -0,0 +1,72 @@
+/****************************************************************************
+**
+** 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.
+**
+****************************************************************************/
+
+#include "googletest.h"
+
+#include <generatedfiles.h>
+
+namespace {
+
+using ClangBackEnd::V2::FileContainer;
+using ClangBackEnd::V2::FileContainers;
+
+class GeneratedFiles : public testing::Test
+{
+protected:
+    FileContainer file1{"/file1", "content1"};
+    FileContainer file1b{"/file1", "content1b"};
+    FileContainer file2{"/file2", "content2"};
+    FileContainer file2b{"/file2", "content2b"};
+    FileContainer file3{"/file3", "content3"};
+    FileContainer file4{"/file4", "content4"};
+    ClangBackEnd::GeneratedFiles generatedFiles;
+};
+
+TEST_F(GeneratedFiles, AddGeneratedFiles)
+{
+    generatedFiles.update({file1, file2});
+
+    ASSERT_THAT(generatedFiles.fileContainers(), ElementsAre(file1, file2));
+}
+
+TEST_F(GeneratedFiles, UpdateGeneratedFiles)
+{
+    generatedFiles.update({{file1, file3}});
+
+    generatedFiles.update({file1b, file2b, file4});
+
+    ASSERT_THAT(generatedFiles.fileContainers(), ElementsAre(file1b, file2b, file3, file4));
+}
+
+TEST_F(GeneratedFiles, RemoveGeneratedFiles)
+{
+    generatedFiles.update({file1, file2, file3, file4});
+
+    generatedFiles.remove({"/file2", "/file4"});
+
+    ASSERT_THAT(generatedFiles.fileContainers(), ElementsAre(file1, file3));
+}
+
+}

tests/unit/unittest/unittest.pro

@@ -93,7 +93,8 @@ SOURCES += \
     filestatuscache-test.cpp \
     highlightingresultreporter-test.cpp \
     precompiledheaderstorage-test.cpp \
-    projectpartqueue-test.cpp
+    projectpartqueue-test.cpp \
+    generatedfiles-test.cpp
 
 !isEmpty(LIBCLANG_LIBS) {
 SOURCES += \