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
|
/***************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Qt Software Information (qt-info@nokia.com)
**
**
** Non-Open Source Usage
**
** Licensees may use this file in accordance with the Qt Beta Version
** License Agreement, Agreement version 2.2 provided with the Software or,
** alternatively, in accordance with the terms contained in a written
** agreement between you and Nokia.
**
** GNU General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU General
** Public License versions 2.0 or 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the packaging
** of this file. Please review the following information to ensure GNU
** General Public Licensing requirements will be met:
**
** http://www.fsf.org/licensing/licenses/info/GPLv2.html and
** http://www.gnu.org/copyleft/gpl.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt GPL Exception
** version 1.2, included in the file GPL_EXCEPTION.txt in this package.
**
***************************************************************************/
#ifndef HELPENGINE_H
#define HELPENGINE_H
#include <QtCore/QThread>
#include <QtCore/QPair>
#include <QtCore/QMap>
#include <QtCore/QWaitCondition>
#include <QtCore/QMutex>
#include <QtGui/QStringListModel>
#include "docuparser.h"
namespace Help {
namespace Internal {
class HelpEngine;
typedef QList<ContentItem> ContentList;
class IndexListModel: public QStringListModel
{
public:
IndexListModel(QObject *parent = 0)
: QStringListModel(parent) {}
void clear() { contents.clear(); setStringList(QStringList()); }
QString description(int index) const { return stringList().at(index); }
QStringList links(int index) const { return contents.values(stringList().at(index)); }
void addLink(const QString &description, const QString &link) { contents.insert(description, link); }
void publish() { filter(QString(), QString()); }
QModelIndex filter(const QString &s, const QString &real);
virtual Qt::ItemFlags flags(const QModelIndex &index) const
{ return QStringListModel::flags(index) & ~Qt::ItemIsEditable; }
private:
QMultiMap<QString, QString> contents;
};
class TitleMapThread : public QThread
{
Q_OBJECT
public:
TitleMapThread(HelpEngine *he);
~TitleMapThread();
void setup();
QList<QPair<QString, ContentList> > contents() const { return contentList; }
QMap<QString, QString> documentTitleMap() const { return titleMap; }
signals:
void errorOccured(const QString &errMsg);
protected:
void run();
private:
void getAllContents();
void buildContentDict();
QList<QPair<QString, ContentList> > contentList;
QMap<QString, QString> titleMap;
HelpEngine *engine;
bool done;
};
class IndexThread : public QThread
{
Q_OBJECT
public:
IndexThread(HelpEngine *he);
void setup();
IndexListModel *model() const { return indexModel; }
protected:
void run();
signals:
void errorOccured(const QString &errMsg);
private:
void buildKeywordDB();
HelpEngine *engine;
QStringList keywordDocuments;
IndexListModel *indexModel;
bool indexDone;
};
class HelpEngine : public QObject
{
Q_OBJECT
public:
HelpEngine(QObject *parent, const QString& defaultQtVersionPath);
~HelpEngine();
void init();
QList<QPair<QString, ContentList> > contents() const { return contentList; }
IndexListModel *indices();
QString titleOfLink(const QString &link);
static QString removeAnchorFromLink(const QString &link);
QString home() const;
signals:
void indexInitialized();
void contentsInitialized();
void errorOccured(const QString &errMsg);
public slots:
void buildContents();
void buildIndex();
private slots:
void titleMapFinished();
void indexFinished();
private:
friend class TitleMapThread;
friend class IndexThread;
void removeOldCacheFiles(bool onlyFulltextSearchIndex = false);
QString cacheFilePath() const;
quint32 getFileAges();
QList<QPair<QString, ContentList> > contentList;
QMap<QString, QString> titleMap;
QString cacheFilesPath;
IndexListModel *indexModel;
QWaitCondition titleMapDoneCondition;
QMutex mutex;
TitleMapThread *titleMapThread;
IndexThread *indexThread;
bool contentsOnly;
};
} //namespace Internal
} //namespace Help
#endif
|
