File: relation.h

package info (click to toggle)
appstream 1.1.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 18,448 kB
  • sloc: ansic: 51,878; xml: 10,459; cpp: 4,721; python: 538; sh: 264; makefile: 24
file content (164 lines) | stat: -rw-r--r-- 4,157 bytes parent folder | download | duplicates (3)
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
/*
 * Copyright (C) 2021-2024 Matthias Klumpp <matthias@tenstral.net>
 *
 * Licensed under the GNU Lesser General Public License Version 2.1
 *
 * This library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 2.1 of the license, or
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include <QSharedDataPointer>
#include <QString>
#include <QObject>

#include "appstreamqt_export.h"
#include "relation-check-result.h"

struct _AsRelation;

namespace AppStream
{

class Pool;
class SystemInfo;
class RelationData;

/**
 * Description of relations a software component has with other components and entities.
 */
class APPSTREAMQT_EXPORT Relation
{
    Q_GADGET

public:
    enum Kind {
        KindUnknown,
        KindRequires,
        KindRecommends,
        KindSupports
    };
    Q_ENUM(Kind)

    enum ItemKind {
        ItemKindUnknown,
        ItemKindId,
        ItemKindModalias,
        ItemKindKernel,
        ItemKindMemory,
        ItemKindFirmware,
        ItemKindControl,
        ItemKindDisplayLength
    };
    Q_ENUM(ItemKind)

    enum Compare {
        CompareUnknown,
        CompareEq,
        CompareNe,
        CompareLt,
        CompareGt,
        CompareLe,
        CompareGe
    };
    Q_ENUM(Compare)

    enum ControlKind {
        ControlKindUnknown,
        ControlKindPointing,
        ControlKindKeyboard,
        ControlKindConsole,
        ControlKindTouch,
        ControlKindGamepad,
        ControlKindVoice,
        ControlKindVision,
        ControlKindTvRemote
    };
    Q_ENUM(ControlKind)

    enum DisplaySideKind {
        DisplaySideKindUnknown,
        DisplaySideKindShortest,
        DisplaySideKindLongest
    };
    Q_ENUM(DisplaySideKind)

    static QString kindToString(Kind kind);
    static Kind stringToKind(const QString &string);

    static QString itemKindToString(ItemKind ikind);
    static ItemKind stringToItemKind(const QString &string);

    static Compare stringToCompare(const QString &string);
    static QString compareToString(Compare cmp);
    static QString compareToSymbolsString(Compare cmp);

    static QString controlKindToString(ControlKind ckind);
    static ControlKind controlKindFromString(const QString &string);

    static QString displaySideKindToString(DisplaySideKind kind);
    static DisplaySideKind stringToDisplaySideKind(const QString &string);

    Relation();
    Relation(_AsRelation *relation);
    Relation(const Relation &relation);
    ~Relation();

    Relation &operator=(const Relation &relation);
    bool operator==(const Relation &r) const;

    /**
     * \returns the internally stored AsRelation
     */
    _AsRelation *cPtr() const;

    Kind kind() const;
    void setKind(Kind kind);

    ItemKind itemKind() const;
    void setItemKind(ItemKind kind);

    Compare compare() const;
    void setCompare(Compare compare);

    QString version() const;
    void setVersion(const QString &version);

    QString valueStr() const;
    void setValueStr(const QString &value);

    int valueInt() const;
    void setValueInt(int value);

    ControlKind valueControlKind() const;
    void setValueControlKind(ControlKind kind);

    DisplaySideKind displaySideKind() const;
    void setDisplaySideKind(DisplaySideKind kind);

    int valuePx() const;
    void setValuePx(int logicalPx);

    bool versionCompare(const QString &version);

    std::optional<RelationCheckResult> isSatisfied(SystemInfo *sysInfo, Pool *pool);

    QString lastError() const;

private:
    QSharedDataPointer<RelationData> d;
};
}

APPSTREAMQT_EXPORT QDebug operator<<(QDebug s, const AppStream::Relation &relation);