aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/pkgconfig/pcpackage.h
blob: 794e2fc40db563410b4a402a5f06e7f6dddcc870 (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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
/****************************************************************************
**
** Copyright (C) 2021 Ivan Komissarov (abbapoh@gmail.com)
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qbs.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** 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-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef PC_PACKAGE_H
#define PC_PACKAGE_H

#include <variant.h>

#include <map>
#include <optional>
#include <stdexcept>
#include <string>
#include <unordered_map>
#include <unordered_set>
#include <utility>
#include <vector>

namespace qbs {

class PcPackage
{
public:
    struct Flag
    {
        enum class Type {
            LibraryName = (1 << 0),
            StaticLibraryName = (1 << 1),
            LibraryPath = (1 << 2),
            Framework = (1 << 3),
            FrameworkPath = (1 << 4),
            LinkerFlag = (1 << 5), // this is a lie, this is DriverLinkerFlags
            IncludePath = (1 << 6),
            SystemIncludePath = (1 << 7),
            DirAfterIncludePath = (1 << 8),
            Define = (1 << 9),
            CompilerFlag = (1 << 10),
        };
        Type type{Type::CompilerFlag};
        std::string value;

        static std::string_view typeToString(Type t);
        static std::optional<Type> typeFromString(std::string_view s);
    };

    struct RequiredVersion
    {
        enum class ComparisonType {
            LessThan,
            GreaterThan,
            LessThanEqual,
            GreaterThanEqual,
            Equal,
            NotEqual,
            AlwaysMatch
        };

        std::string name;
        ComparisonType comparison{ComparisonType::GreaterThanEqual};
        std::string version;

        static std::string_view comparisonToString(ComparisonType t);
        static std::optional<ComparisonType> comparisonFromString(std::string_view s);
    };

    std::string filePath;
    std::string baseFileName;
    std::string name;
    std::string version;
    std::string description;
    std::string url;

    std::vector<Flag> libs;
    std::vector<Flag> libsPrivate;
    std::vector<Flag> cflags;

    std::vector<RequiredVersion> requiresPublic;
    std::vector<RequiredVersion> requiresPrivate;
    std::vector<RequiredVersion> conflicts;
    std::optional<std::string> oldPrefix;

    using VariablesMap = std::map<std::string, std::string, std::less<>>;
    VariablesMap variables;

    bool uninstalled{false};

    static bool shouldRewriteSysroot(std::string_view sysroot, std::string_view value);
    PcPackage prependSysroot(std::string_view sysroot) &&;
    PcPackage removeSystemLibraryPaths(const std::unordered_set<std::string> &libraryPaths) &&;
};

class PcBrokenPackage
{
public:
    std::string filePath;
    std::string baseFileName;
    std::string errorText;
};

class PcPackageVariant: public Variant::variant<PcPackage, PcBrokenPackage>
{
public:
    using Base = Variant::variant<PcPackage, PcBrokenPackage>;
    using Base::Base;

    bool isValid() const noexcept { return index() == 0; }
    bool isBroken() const noexcept { return index() == 1; }

    const PcPackage &asPackage() const { return Variant::get<PcPackage>(*this); }
    PcPackage &asPackage() { return Variant::get<PcPackage>(*this); }

    const PcBrokenPackage &asBrokenPackage() const { return Variant::get<PcBrokenPackage>(*this); }
    PcBrokenPackage &asBrokenPackage() { return Variant::get<PcBrokenPackage>(*this); }

    template<typename F>
    decltype(auto) visit(F &&f) const
    {
         return Variant::visit(std::forward<F>(f), static_cast<const Base &>(*this));
    }

    template<typename F>
    decltype(auto) visit(F &&f)
    {
        return Variant::visit(std::forward<F>(f), static_cast<Base &>(*this));
    }

    const std::string &getBaseFileName() const
    {
        return visit([](auto &&value) noexcept -> const std::string & {
            return value.baseFileName;
        });
    }
};

class PcException: public std::runtime_error
{
public:
    explicit PcException(const std::string &message) : std::runtime_error(message) {}
};

inline bool operator==(const PcPackage::Flag &lhs, const PcPackage::Flag &rhs)
{
    return lhs.type == rhs.type && lhs.value == rhs.value;
}

inline bool operator!=(const PcPackage::Flag &lhs, const PcPackage::Flag &rhs)
{
    return !(lhs == rhs);
}

namespace Internal {

// fast versions (no allocations) of the QFileInfo methods
std::string_view fileName(std::string_view filePath);
std::string_view completeBaseName(std::string_view filePath);
std::string_view parentPath(std::string_view path);

inline bool startsWith(std::string_view haystack, std::string_view needle)
{
    return haystack.size() >= needle.size() && haystack.compare(0, needle.size(), needle) == 0;
}

inline bool endsWith(std::string_view haystack, std::string_view needle)
{
    return haystack.size() >= needle.size()
            && haystack.compare(haystack.size() - needle.size(), needle.size(), needle) == 0;
}

} // Internal

} // namespace qbs

namespace std {
template<> struct hash<qbs::PcPackage::Flag>
{
    size_t operator()(const qbs::PcPackage::Flag &v) const noexcept
    {
        return hash<std::string>()(v.value) + size_t(v.type);
    }
};
} // namespace std

#endif // PC_PACKAGE_H