aboutsummaryrefslogtreecommitdiffstats
path: root/src/libs/clangsupport/sourceentry.h
blob: 5e8769d14fd78a69694352bb2981306faf0fb5f1 (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
146
147
148
149
150
151
152
153
154
155
156
/****************************************************************************
**
** 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 {

enum class SourceType : unsigned char {
    TopProjectInclude,
    TopSystemInclude,
    UserInclude,
    ProjectInclude,
    SystemInclude,
    Source
};

enum class HasMissingIncludes : unsigned char { No, Yes };

class TimeStamp
{
    using int64 = long long;
public:
    TimeStamp() = default;
    TimeStamp(int64 value)
        : value(value)
    {}

    operator int64() const
    {
        return value;
    }

    int64 value = -1;
};

class SourceTimeStamp
{
    using int64 = long long;
public:
    SourceTimeStamp(int sourceId, int64 lastModified)
        : timeStamp(lastModified)
        , sourceId(sourceId)
    {}

    SourceTimeStamp(FilePathId sourceId, TimeStamp lastModified)
        : timeStamp(lastModified)
        , sourceId(sourceId)
    {}

    friend bool operator<(SourceTimeStamp first, SourceTimeStamp second)
    {
        return first.sourceId < second.sourceId;
    }

    friend bool operator<(SourceTimeStamp first, FilePathId second)
    {
        return first.sourceId < second;
    }

    friend bool operator<(FilePathId first, SourceTimeStamp second)
    {
        return first < second.sourceId;
    }

    friend bool operator==(SourceTimeStamp first, SourceTimeStamp second)
    {
        return first.sourceId == second.sourceId && first.timeStamp == second.timeStamp;
    }

    friend bool operator!=(SourceTimeStamp first, SourceTimeStamp second)
    {
        return !(first == second);
    }

public:
    TimeStamp timeStamp;
    FilePathId sourceId;
};

using SourceTimeStamps = std::vector<SourceTimeStamp>;

class SourceEntry
{
    using int64 = long long;

public:
    SourceEntry(int sourceId, int64 timeStamp, int sourceType, int hasMissingIncludes)
        : timeStamp(timeStamp)
        , sourceId(sourceId)
        , sourceType(static_cast<SourceType>(sourceType))
        , hasMissingIncludes(static_cast<HasMissingIncludes>(hasMissingIncludes))
    {}

    SourceEntry(FilePathId sourceId,
                SourceType sourceType,
                TimeStamp timeStamp,
                HasMissingIncludes hasMissingIncludes = HasMissingIncludes::No)
        : timeStamp(timeStamp)
        , sourceId(sourceId)
        , sourceType(sourceType)
        , hasMissingIncludes(hasMissingIncludes)
    {}

    friend bool operator<(SourceEntry first, SourceEntry second) {
        return first.sourceId < second.sourceId;
    }

    friend bool operator<(SourceEntry first, FilePathId second) { return first.sourceId < second; }

    friend bool operator<(FilePathId first, SourceEntry second) { return first < second.sourceId; }

    friend bool operator==(SourceEntry first, SourceEntry second)
    {
        return first.sourceId == second.sourceId && first.sourceType == second.sourceType
               && first.timeStamp == second.timeStamp;
    }

    friend bool operator!=(SourceEntry first, SourceEntry second) { return !(first == second); }

public:
    TimeStamp timeStamp;
    FilePathId sourceId;
    SourceType sourceType = SourceType::UserInclude;
    HasMissingIncludes hasMissingIncludes = HasMissingIncludes::No;
};

using SourceEntries = std::vector<SourceEntry>;
using SourceEntryReference = std::reference_wrapper<SourceEntry>;
using SourceEntryReferences = std::vector<SourceEntryReference>;
} // namespace ClangBackEnd