1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt Assistant of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QHELPDBREADER_H
41#define QHELPDBREADER_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists for the convenience
48// of the help generator tools. This header file may change from version
49// to version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <QtCore/QObject>
55#include <QtCore/QStringList>
56#include <QtCore/QUrl>
57#include <QtCore/QByteArray>
58#include <QtCore/QSet>
59
60QT_BEGIN_NAMESPACE
61
62class QSqlQuery;
63
64class QHelpDBReader : public QObject
65{
66 Q_OBJECT
67
68public:
69 class IndexItem
70 {
71 public:
72 IndexItem() = default;
73 QString name;
74 QString identifier;
75 int fileId = 0;
76 QString anchor;
77 QStringList filterAttributes;
78 };
79
80 class FileItem
81 {
82 public:
83 FileItem() = default;
84 QString name;
85 QString title;
86 QStringList filterAttributes;
87 };
88
89 class ContentsItem
90 {
91 public:
92 ContentsItem() = default;
93 QByteArray data;
94 QStringList filterAttributes;
95 };
96
97 class IndexTable
98 {
99 public:
100 QList<IndexItem> indexItems;
101 QList<FileItem> fileItems;
102 QList<ContentsItem> contentsItems;
103 QStringList usedFilterAttributes;
104 };
105
106 QHelpDBReader(const QString &dbName);
107 QHelpDBReader(const QString &dbName, const QString &uniqueId,
108 QObject *parent);
109 ~QHelpDBReader();
110
111 bool init();
112
113 QString namespaceName() const;
114 QString virtualFolder() const;
115 QString version() const;
116 IndexTable indexTable() const;
117 QList<QStringList> filterAttributeSets() const;
118 QMap<QString, QByteArray> filesData(const QStringList &filterAttributes,
119 const QString &extensionFilter = QString()) const;
120 QByteArray fileData(const QString &virtualFolder,
121 const QString &filePath) const;
122
123 QStringList customFilters() const;
124 QStringList filterAttributes(const QString &filterName = QString()) const;
125
126 QVariant metaData(const QString &name) const;
127
128private:
129 QString quote(const QString &string) const;
130 bool initDB();
131 QString qtVersionHeuristic() const;
132
133 bool m_initDone = false;
134 QString m_dbName;
135 QString m_uniqueId;
136 QString m_error;
137 QSqlQuery *m_query = nullptr;
138 mutable QString m_namespace;
139};
140
141QT_END_NAMESPACE
142
143#endif
144

source code of qttools/src/assistant/help/qhelpdbreader_p.h