summaryrefslogtreecommitdiffstats
path: root/src/libs/installer/componentalias.h
blob: e5f2e0d6134db89ccf0e551028a2ddfe06d97ab3 (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
/**************************************************************************
**
** Copyright (C) 2023 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Installer Framework.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** 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.
**
** $QT_END_LICENSE$
**
**************************************************************************/

#ifndef COMPONENTALIAS_H
#define COMPONENTALIAS_H

#include "installer_global.h"

#include <QHash>
#include <QMetaEnum>
#include <QString>
#include <QSet>

namespace QInstaller {

class Component;
class ComponentAlias;
class PackageManagerCore;

struct INSTALLER_EXPORT AliasSource
{
    enum class SourceFileFormat {
        Unknown = -1,
        Xml = 0
    };

    AliasSource();
    AliasSource(SourceFileFormat aFormat, const QString &aFilename, int aPriority);
    AliasSource(const AliasSource &other);

    SourceFileFormat format;
    QString filename;
    int priority;
};

INSTALLER_EXPORT hashValue qHash(const AliasSource &key, hashValue seed);
INSTALLER_EXPORT bool operator==(const AliasSource &lhs, const AliasSource &rhs);

class INSTALLER_EXPORT AliasFinder
{
public:
    using AliasData = QVariantMap;
    using AliasDataHash = QMultiHash<QString, AliasData>;

    enum struct Resolution {
        AddNew,
        KeepExisting,
        RemoveExisting
    };

    explicit AliasFinder(PackageManagerCore *core);
    ~AliasFinder();

    bool run();
    QList<ComponentAlias *> aliases() const;

    void setAliasSources(const QSet<AliasSource> &sources);

private:
    void clear();
    Resolution checkPriorityAndVersion(const AliasData &data) const;

    bool parseXml(AliasSource source);

private:
    PackageManagerCore *const m_core;

    QSet<AliasSource> m_sources;
    AliasDataHash m_aliasData;
    QHash<QString, ComponentAlias *> m_aliases;
};

class INSTALLER_EXPORT ComponentAlias : public QObject
{
    Q_OBJECT
    Q_DISABLE_COPY_MOVE(ComponentAlias)

public:
    enum UnstableError {
        ReferenceToUnstable = 0,
        MissingComponent,
        UnselectableComponent,
        MissingAlias,
        ComponentNameConfict
    };
    Q_ENUM(UnstableError)

    ComponentAlias(PackageManagerCore *core);
    ~ComponentAlias();

    QString name() const;
    QString displayName() const;
    QString description() const;

    QString version() const;

    bool isVirtual() const;

    bool isSelected() const;
    void setSelected(bool selected);

    QList<Component *> components();
    QList<ComponentAlias *> aliases();

    QString value(const QString &key, const QString &defaultValue = QString()) const;
    void setValue(const QString &key, const QString &value);
    QStringList keys() const;

    bool isUnstable() const;
    void setUnstable(UnstableError error, const QString &message = QString());

private:
    void addRequiredAliases(const QStringList &aliases, const bool optional);
    void addRequiredComponents(const QStringList &components, const bool optional);

private:
    PackageManagerCore *const m_core;

    QHash<QString, QString> m_variables;

    bool m_selected;
    bool m_unstable;

    QList<Component *> m_components;
    QList<ComponentAlias *> m_aliases;
};

} // namespace QInstaller

Q_DECLARE_METATYPE(QInstaller::ComponentAlias *)
Q_DECLARE_METATYPE(QInstaller::AliasSource);

#endif // COMPONENTALIAS_H