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
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Assistant of the Qt Toolkit.
**
** $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 QHELPCOLLECTIONHANDLER_H
#define QHELPCOLLECTIONHANDLER_H
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists for the convenience
// of the help generator tools. This header file may change from version
// to version without notice, or even be removed.
//
// We mean it.
//
#include <QtCore/QList>
#include <QtCore/QString>
#include <QtCore/QObject>
#include <QtCore/QVariant>
#include <QtCore/QStringList>
#include <QtSql/QSqlQuery>
#include "qhelpdbreader_p.h"
#include "qhelplink.h"
QT_BEGIN_NAMESPACE
class QVersionNumber;
class QHelpFilterData;
class QHelpCollectionHandler : public QObject
{
Q_OBJECT
public:
struct FileInfo
{
QString fileName;
QString folderName;
QString namespaceName;
};
typedef QList<FileInfo> FileInfoList;
struct TimeStamp
{
int namespaceId = -1;
int folderId = -1;
QString fileName;
int size = 0;
QString timeStamp;
};
struct ContentsData
{
QString namespaceName;
QString folderName;
QList<QByteArray> contentsList;
};
explicit QHelpCollectionHandler(const QString &collectionFile,
QObject *parent = nullptr);
~QHelpCollectionHandler();
QString collectionFile() const;
bool openCollectionFile();
bool copyCollectionFile(const QString &fileName);
// *** Legacy block start ***
// legacy API since Qt 5.13
// use filters() instead
QStringList customFilters() const;
// use QHelpFilterEngine::removeFilter() instead
bool removeCustomFilter(const QString &filterName);
// use QHelpFilterEngine::setFilterData() instead
bool addCustomFilter(const QString &filterName,
const QStringList &attributes);
// use files(const QString &, const QString &, const QString &) instead
QStringList files(const QString &namespaceName,
const QStringList &filterAttributes,
const QString &extensionFilter) const;
// use namespaceForFile(const QUrl &, const QString &) instead
QString namespaceForFile(const QUrl &url,
const QStringList &filterAttributes) const;
// use findFile(const QUrl &, const QString &) instead
QUrl findFile(const QUrl &url,
const QStringList &filterAttributes) const;
// use indicesForFilter(const QString &) instead
QStringList indicesForFilter(const QStringList &filterAttributes) const;
// use contentsForFilter(const QString &) instead
QList<ContentsData> contentsForFilter(const QStringList &filterAttributes) const;
// use QHelpFilterEngine::activeFilter() and filterData(const QString &) instead;
QStringList filterAttributes() const;
// use filterData(const QString &) instead
QStringList filterAttributes(const QString &filterName) const;
// use filterData(const QString &) instead
QList<QStringList> filterAttributeSets(const QString &namespaceName) const;
// use linksForIdentifier(const QString &, const QString &) instead
QMultiMap<QString, QUrl> linksForIdentifier(const QString &id,
const QStringList &filterAttributes) const;
// use linksForKeyword(const QString &, const QString &) instead
QMultiMap<QString, QUrl> linksForKeyword(const QString &keyword,
const QStringList &filterAttributes) const;
// use documentsForIdentifier instead
QMultiMap<QString, QUrl> linksForIdentifier(const QString &id, const QString &filterName) const;
// use documentsForKeyword instead
QMultiMap<QString, QUrl> linksForKeyword(const QString &keyword,
const QString &filterName) const;
// *** Legacy block end ***
QStringList filters() const;
QStringList availableComponents() const;
QList<QVersionNumber> availableVersions() const;
QMap<QString, QString> namespaceToComponent() const;
QMap<QString, QVersionNumber> namespaceToVersion() const;
QHelpFilterData filterData(const QString &filterName) const;
bool setFilterData(const QString &filterName, const QHelpFilterData &filterData);
bool removeFilter(const QString &filterName);
FileInfo registeredDocumentation(const QString &namespaceName) const;
FileInfoList registeredDocumentations() const;
bool registerDocumentation(const QString &fileName);
bool unregisterDocumentation(const QString &namespaceName);
bool fileExists(const QUrl &url) const;
QStringList files(const QString &namespaceName,
const QString &filterName,
const QString &extensionFilter) const;
QString namespaceForFile(const QUrl &url,
const QString &filterName) const;
QUrl findFile(const QUrl &url,
const QString &filterName) const;
QByteArray fileData(const QUrl &url) const;
QStringList indicesForFilter(const QString &filterName) const;
QList<ContentsData> contentsForFilter(const QString &filterName) const;
bool removeCustomValue(const QString &key);
QVariant customValue(const QString &key, const QVariant &defaultValue) const;
bool setCustomValue(const QString &key, const QVariant &value);
int registerNamespace(const QString &nspace, const QString &fileName);
int registerVirtualFolder(const QString &folderName, int namespaceId);
int registerComponent(const QString &componentName, int namespaceId);
bool registerVersion(const QString &version, int namespaceId);
QList<QHelpLink> documentsForIdentifier(const QString &id,
const QString &filterName) const;
QList<QHelpLink> documentsForKeyword(const QString &keyword,
const QString &filterName) const;
QList<QHelpLink> documentsForIdentifier(const QString &id,
const QStringList &filterAttributes) const;
QList<QHelpLink> documentsForKeyword(const QString &keyword,
const QStringList &filterAttributes) const;
QStringList namespacesForFilter(const QString &filterName) const;
void setReadOnly(bool readOnly);
signals:
void error(const QString &msg) const;
private:
// legacy stuff
QMultiMap<QString, QUrl> linksForField(const QString &fieldName,
const QString &fieldValue,
const QStringList &filterAttributes) const;
QList<QHelpLink> documentsForField(const QString &fieldName,
const QString &fieldValue,
const QStringList &filterAttributes) const;
QString namespaceVersion(const QString &namespaceName) const;
QMultiMap<QString, QUrl> linksForField(const QString &fieldName, const QString &fieldValue,
const QString &filterName) const;
QList<QHelpLink> documentsForField(const QString &fieldName,
const QString &fieldValue,
const QString &filterName) const;
bool isDBOpened() const;
bool createTables(QSqlQuery *query);
void closeDB();
bool recreateIndexAndNamespaceFilterTables(QSqlQuery *query);
bool registerIndexAndNamespaceFilterTables(const QString &nameSpace,
bool createDefaultVersionFilter = false);
void createVersionFilter(const QString &version);
bool registerFilterAttributes(const QList<QStringList> &attributeSets, int nsId);
bool registerFileAttributeSets(const QList<QStringList> &attributeSets, int nsId);
bool registerIndexTable(const QHelpDBReader::IndexTable &indexTable,
int nsId, int vfId, const QString &fileName);
bool unregisterIndexTable(int nsId, int vfId);
QString absoluteDocPath(const QString &fileName) const;
bool isTimeStampCorrect(const TimeStamp &timeStamp) const;
bool hasTimeStampInfo(const QString &nameSpace) const;
void scheduleVacuum();
void execVacuum();
QString m_collectionFile;
QString m_connectionName;
QSqlQuery *m_query = nullptr;
bool m_vacuumScheduled = false;
bool m_readOnly = true;
};
QT_END_NAMESPACE
#endif //QHELPCOLLECTIONHANDLER_H
|
