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 QHELPSEARCHINDEXWRITERDEFAULT_H
41#define QHELPSEARCHINDEXWRITERDEFAULT_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/QMutex>
55#include <QtCore/QThread>
56
57QT_FORWARD_DECLARE_CLASS(QSqlDatabase)
58
59QT_BEGIN_NAMESPACE
60
61namespace fulltextsearch {
62namespace qt {
63
64class Writer
65{
66public:
67 Writer(const QString &path);
68 ~Writer();
69
70 bool tryInit(bool reindex);
71 void flush();
72
73 void removeNamespace(const QString &namespaceName);
74 bool hasNamespace(const QString &namespaceName);
75 void insertDoc(const QString &namespaceName,
76 const QString &attributes,
77 const QString &url,
78 const QString &title,
79 const QString &contents);
80 void startTransaction();
81 void endTransaction();
82private:
83 void init(bool reindex);
84 bool hasDB();
85 void clearLegacyIndex();
86
87 const QString m_dbDir;
88 QString m_uniqueId;
89
90 bool m_needOptimize = false;
91 QSqlDatabase *m_db = nullptr;
92 QVariantList m_namespaces;
93 QVariantList m_attributes;
94 QVariantList m_urls;
95 QVariantList m_titles;
96 QVariantList m_contents;
97};
98
99
100class QHelpSearchIndexWriter : public QThread
101{
102 Q_OBJECT
103
104public:
105 QHelpSearchIndexWriter();
106 ~QHelpSearchIndexWriter() override;
107
108 void cancelIndexing();
109 void updateIndex(const QString &collectionFile,
110 const QString &indexFilesFolder, bool reindex);
111
112signals:
113 void indexingStarted();
114 void indexingFinished();
115
116private:
117 void run() override;
118
119private:
120 QMutex m_mutex;
121
122 bool m_cancel;
123 bool m_reindex;
124 QString m_collectionFile;
125 QString m_indexFilesFolder;
126};
127
128} // namespace std
129} // namespace fulltextsearch
130
131QT_END_NAMESPACE
132
133#endif // QHELPSEARCHINDEXWRITERDEFAULT_H
134

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