aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/clangpchmanager/projectupdater.h
blob: 16d662004fbb566af1b3bada61fbb977c94d1f79 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/****************************************************************************
**
** Copyright (C) 2016 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 "clangpchmanager_global.h"

#include <compilermacro.h>
#include <filecontainerv2.h>
#include <filepathcachinginterface.h>
#include <generatedfiles.h>
#include <includesearchpath.h>
#include <projectpartcontainer.h>
#include <projectpartsstorageinterface.h>
#include <projectpartstoragestructs.h>
#include <stringcache.h>

#include <projectexplorer/headerpath.h>

#include <utils/environmentfwd.h>

namespace ProjectExplorer {
class Macro;
using Macros = QVector<Macro>;
}

namespace CppTools {
class ProjectPart;
class ProjectFile;
}

namespace ClangBackEnd {
class ProjectManagementServerInterface;
}

QT_FORWARD_DECLARE_CLASS(QStringList)

#include <vector>

namespace ClangPchManager {

class HeaderAndSources;
class PchManagerClient;
class ClangIndexingSettingsManager;
class ClangIndexingProjectSettings;

class CLANGPCHMANAGER_EXPORT ProjectUpdater
{
    using StringCache = ClangBackEnd::StringCache<Utils::PathString,
                                                  Utils::SmallStringView,
                                                  ClangBackEnd::ProjectPartId,
                                                  ClangBackEnd::NonLockingMutex,
                                                  decltype(&Utils::reverseCompare),
                                                  Utils::reverseCompare,
                                                  ClangBackEnd::Internal::ProjectPartNameId>;

public:
    struct SystemAndProjectIncludeSearchPaths
    {
        ClangBackEnd::IncludeSearchPaths system;
        ClangBackEnd::IncludeSearchPaths project;
    };

    ProjectUpdater(ClangBackEnd::ProjectManagementServerInterface &server,
                   ClangBackEnd::FilePathCachingInterface &filePathCache,
                   ClangBackEnd::ProjectPartsStorageInterface &projectPartsStorage,
                   ClangIndexingSettingsManager &settingsManager)
        : m_filePathCache(filePathCache)
        , m_server(server)
        , m_projectPartsStorage(projectPartsStorage)
        , m_settingsManager(settingsManager)
    {
        m_projectPartIdCache.populate(m_projectPartsStorage.fetchAllProjectPartNamesAndIds());
    }

    void updateProjectParts(const std::vector<CppTools::ProjectPart *> &projectParts,
                            Utils::SmallStringVector &&toolChainArguments);
    void removeProjectParts(ClangBackEnd::ProjectPartIds projectPartIds);

    void updateGeneratedFiles(ClangBackEnd::V2::FileContainers &&generatedFiles);
    void removeGeneratedFiles(ClangBackEnd::FilePaths &&filePaths);

    void setExcludedPaths(ClangBackEnd::FilePaths &&excludedPaths);
    const ClangBackEnd::FilePaths &excludedPaths() const;

    const ClangBackEnd::GeneratedFiles &generatedFiles() const;

    HeaderAndSources headerAndSourcesFromProjectPart(CppTools::ProjectPart *projectPart) const;
    ClangBackEnd::ProjectPartContainer toProjectPartContainer(
            CppTools::ProjectPart *projectPart) const;
    ClangBackEnd::ProjectPartContainers toProjectPartContainers(
            std::vector<CppTools::ProjectPart *> projectParts) const;

    void addToHeaderAndSources(HeaderAndSources &headerAndSources,
                               const CppTools::ProjectFile &projectFile) const;
    static QStringList toolChainArguments(CppTools::ProjectPart *projectPart);
    static ClangBackEnd::CompilerMacros createCompilerMacros(const ProjectExplorer::Macros &projectMacros,
                                                             Utils::NameValueItems &&settingsMacros);
    static SystemAndProjectIncludeSearchPaths createIncludeSearchPaths(
        const CppTools::ProjectPart &projectPart);
    static ClangBackEnd::FilePaths createExcludedPaths(
            const ClangBackEnd::V2::FileContainers &generatedFiles);

    QString fetchProjectPartName(ClangBackEnd::ProjectPartId projectPartId) const;

    ClangBackEnd::ProjectPartIds toProjectPartIds(const QStringList &projectPartNames) const;

    void addProjectFilesToFilePathCache(const std::vector<CppTools::ProjectPart *> &projectParts);
    void fetchProjectPartIds(const std::vector<CppTools::ProjectPart *> &projectParts);

protected:
    ClangBackEnd::FilePathCachingInterface &m_filePathCache;

private:
    ClangBackEnd::GeneratedFiles m_generatedFiles;
    ClangBackEnd::FilePaths m_excludedPaths;
    ClangBackEnd::ProjectManagementServerInterface &m_server;
    ClangBackEnd::ProjectPartsStorageInterface &m_projectPartsStorage;
    ClangIndexingSettingsManager &m_settingsManager;
    mutable StringCache m_projectPartIdCache;
};

} // namespace ClangPchManager