/
bundles.h
103 lines (86 loc) · 3.08 KB
/
bundles.h
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
/** @file bundles.h Data bundle indexing.
*
* @authors Copyright (c) 2016 Jaakko Keränen <jaakko.keranen@iki.fi>
*
* @par License
* GPL: http://www.gnu.org/licenses/gpl.html
*
* <small>This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. This program 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 General
* Public License for more details. You should have received a copy of the GNU
* General Public License along with this program; if not, see:
* http://www.gnu.org/licenses</small>
*/
#ifndef LIBDOOMSDAY_RESOURCE_BUNDLES_H
#define LIBDOOMSDAY_RESOURCE_BUNDLES_H
#include "databundle.h"
#include <de/Info>
#include <de/Version>
namespace res {
/**
* Index for data bundles.
*
* Parses the "databundles.dei" Info file that specifies identification
* criteria for known data files. The res::Bundles::match() method can can
* called on an arbitary data bundle to try finding a matching record in the
* registry of known data files.
*
* @see res::DataBundle
*/
class LIBDOOMSDAY_PUBLIC Bundles
{
public:
typedef QList<de::Info::BlockElement const *> BlockElements;
/// Notified when a data bundle refresh/identification has been made.
DENG2_DEFINE_AUDIENCE2(Refresh, void dataBundlesRefreshed())
DENG2_ERROR(InvalidError);
struct LIBDOOMSDAY_PUBLIC MatchResult
{
de::Info::BlockElement const *bestMatch = nullptr;
de::dint bestScore = 0;
de::String packageId;
de::Version packageVersion = de::Version("");
operator bool() const { return bestMatch != nullptr; }
};
public:
Bundles();
/**
* Returns the collection of information for identifying known data files.
* @return Info document.
*/
de::Info const &identityRegistry() const;
BlockElements formatEntries(DataBundle::Format format) const;
/**
* Tries to identify of the data files that have been indexed since the
* previous call of this method. Recognized data files are linked as
* packages under the /sys/bundles folder.
*
* @see res::DataBundle::identifyPackages()
*
* @return @c true, if one or more bundles were identified.
*/
bool identify();
/**
* Finds a matching entry in the registry for a given data bundle.
* @param bundle Data bundle whose information to look for.
*
* @return Best match.
*/
MatchResult match(DataBundle const &bundle) const;
/**
* Compiles a list of all data bundles that have been loaded via
* PackageLoader. The order of the list reflects the order in which
* PackageLoader::load() was called on the packges.
*
* @return List of bundles.
*/
QList<DataBundle const *> loaded() const;
private:
DENG2_PRIVATE(d)
};
} // namespace res
#endif // LIBDOOMSDAY_RESOURCE_BUNDLES_H