aboutsummaryrefslogtreecommitdiff
path: root/libs/installer_fomod_plus/share/xml/ModuleConfiguration.h
blob: a0a017b43174e5001321478b4b89adfcecd7c662 (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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
#pragma once

#include <iostream>
#include <optional>
#include <pugixml.hpp>
#include <qstring.h>
#include <string>
#include <vector>

class XmlDeserializable {
public:
    virtual ~XmlDeserializable() = default;

    virtual bool deserialize(pugi::xml_node& node) = 0;

protected:
    XmlDeserializable() = default;
};

enum GroupTypeEnum {
    SelectAny,
    SelectAll,
    SelectExactlyOne,
    SelectAtMostOne,
    SelectAtLeastOne
};

enum class OperatorTypeEnum {
    AND,
    OR
};

enum class OrderTypeEnum {
    Explicit,
    Ascending,
    Descending
};

enum class FileDependencyTypeEnum {
    Missing,
    Inactive,
    Active,
    UNKNOWN_STATE
};

template <typename T>
class OrderedContents {
public:
    OrderTypeEnum order;

    OrderedContents() : order(OrderTypeEnum::Ascending) {}
    explicit OrderedContents(const OrderTypeEnum orderType): order(orderType) {}

    template <typename Accessor>
    bool compare(const T& a, const T& b, Accessor accessor) const
    {
        switch (order) {
        case OrderTypeEnum::Ascending:
            return accessor(a) < accessor(b);
        case OrderTypeEnum::Descending:
            return accessor(a) > accessor(b);
        case OrderTypeEnum::Explicit:
        default:
            return false; // No sorting for explicit order
        }
    }
};

enum class PluginTypeEnum {
    Recommended,
    Required,
    Optional,
    NotUsable,
    CouldBeUsable,
    UNKNOWN
};


inline std::ostream& operator<<(std::ostream& os, const PluginTypeEnum& type)
{
    switch (type) {
    case PluginTypeEnum::Recommended:
        os << "Recommended";
        break;
    case PluginTypeEnum::Required:
        os << "Required";
        break;
    case PluginTypeEnum::Optional:
        os << "Optional";
        break;
    case PluginTypeEnum::NotUsable:
        os << "NotUsable";
        break;
    case PluginTypeEnum::CouldBeUsable:
        os << "CouldBeUsable";
        break;
    default: ;
    }
    return os;
}

class PluginType final : public XmlDeserializable {
public:
    PluginTypeEnum name = PluginTypeEnum::Optional; // sane default

    bool deserialize(pugi::xml_node& node) override;
};

class FileDependency final : public XmlDeserializable {
public:
    std::string file;
    FileDependencyTypeEnum state = FileDependencyTypeEnum::UNKNOWN_STATE;

    bool deserialize(pugi::xml_node& node) override;
};

class FlagDependency final : public XmlDeserializable {
public:
    std::string flag;
    std::string value;

    bool deserialize(pugi::xml_node& node) override;
};

class GameDependency final : public XmlDeserializable {
public:
    std::string version;

    bool deserialize(pugi::xml_node& node) override;
};

class CompositeDependency final : public XmlDeserializable {
public:
    std::vector<FileDependency> fileDependencies;
    std::vector<FlagDependency> flagDependencies;
    std::vector<GameDependency> gameDependencies;
    std::vector<CompositeDependency> nestedDependencies;
    OperatorTypeEnum operatorType = OperatorTypeEnum::AND; // safest default.

    bool deserialize(pugi::xml_node& node) override;
};

class DependencyPattern final : public XmlDeserializable {
public:
    CompositeDependency dependencies;
    PluginTypeEnum type;

    bool deserialize(pugi::xml_node& node) override;
};


class DependencyPatternList final : public XmlDeserializable {
public:
    std::vector<DependencyPattern> patterns;

    bool deserialize(pugi::xml_node& node) override;
};

class DependencyPluginType final : public XmlDeserializable {
public:
    std::optional<PluginTypeEnum> defaultType;
    DependencyPatternList patterns;

    bool deserialize(pugi::xml_node& node) override;
};

class TypeDescriptor final : public XmlDeserializable {
public:
    DependencyPluginType dependencyType;
    PluginTypeEnum type;

    bool deserialize(pugi::xml_node& node) override;
};

class Image final : public XmlDeserializable {
public:
    std::string path;

    bool deserialize(pugi::xml_node& node) override;
};

class HeaderImage final : public XmlDeserializable {
public:
    std::string path;
    bool showImage;
    bool showFade;
    int height;

    bool deserialize(pugi::xml_node& node) override;
};

class File final : public XmlDeserializable {
public:
    std::string source;
    std::optional<std::string> destination;
    int priority{ 0 };
    bool isFolder;

    bool deserialize(pugi::xml_node& node) override;
};


class FileList final : public XmlDeserializable {
public:
    std::vector<File> files;

    bool deserialize(pugi::xml_node& node) override;
};

class ConditionalFileInstallPattern final : public XmlDeserializable {
public:
    CompositeDependency dependencies;
    FileList files;

    bool deserialize(pugi::xml_node& node) override;
};

// <flag name="2">On</flag>
class ConditionFlag final : public XmlDeserializable {
public:
    std::string name;
    std::string value;

    bool deserialize(pugi::xml_node& node) override;
};

class ConditionFlagList final : public XmlDeserializable {
public:
    std::vector<ConditionFlag> flags;

    bool deserialize(pugi::xml_node& node) override;
};

class Plugin final : public XmlDeserializable {
public:
    std::string description;
    Image image;
    TypeDescriptor typeDescriptor;
    std::string name;
    ConditionFlagList conditionFlags;
    FileList files;

    bool deserialize(pugi::xml_node& node) override;
};

class PluginList final : public XmlDeserializable, public OrderedContents<Plugin> {
public:
    std::vector<Plugin> plugins;
    OrderTypeEnum order;

    bool deserialize(pugi::xml_node& node) override;
};

class Group final : public XmlDeserializable {
public:
    PluginList plugins;
    std::string name;
    GroupTypeEnum type;

    bool deserialize(pugi::xml_node& node) override;
};

class GroupList final : public XmlDeserializable, public OrderedContents<Group> {
public:
    std::vector<Group> groups;
    OrderTypeEnum order;

    bool deserialize(pugi::xml_node& node) override;
};

class InstallStep final : public XmlDeserializable {
public:
    CompositeDependency visible;
    GroupList optionalFileGroups;
    std::string name;

    bool deserialize(pugi::xml_node& node) override;
};

class ConditionalFileInstall final : public XmlDeserializable {
public:
    std::vector<ConditionalFileInstallPattern> patterns;

    bool deserialize(pugi::xml_node& node) override;
};

class StepList final : public XmlDeserializable, public OrderedContents<InstallStep> {
public:
    std::vector<InstallStep> installSteps;
    OrderTypeEnum order;

    bool deserialize(pugi::xml_node& node) override;
};

class ModuleConfiguration {
public:
    std::string moduleName;
    HeaderImage moduleImage;
    CompositeDependency moduleDependencies;
    FileList requiredInstallFiles;
    StepList installSteps;
    ConditionalFileInstall conditionalFileInstalls;

    bool deserialize(const QString& filePath);
};