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
|
/* This file is part of KDevelop
Copyright 2009 Aleix Pol <aleixpol@kde.org>
Copyright 2009 David Nolden <david.nolden.kdevelop@art-master.de>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library 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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#include "qthelpplugin.h"
#include <QDebug>
#include <QHelpIndexModel>
#include <QTemporaryFile>
#include <QHelpContentModel>
#include <KProcess>
#include <kpluginfactory.h>
#include <kpluginloader.h>
#include <KAboutData>
#include <KStandardDirs>
#include <language/duchain/duchain.h>
#include <language/duchain/declaration.h>
#include <language/duchain/duchainlock.h>
#include <KIcon>
#include "qthelpdocumentation.h"
K_PLUGIN_FACTORY(QtHelpFactory, registerPlugin<QtHelpPlugin>(); )
K_EXPORT_PLUGIN(QtHelpFactory(KAboutData("kdevqthelp","kdevqthelp", ki18n("QtHelp"), "0.1", ki18n("Check Qt Help documentation"), KAboutData::License_GPL)))
QString qtDocsLocation(const QString& qmake)
{
QString ret;
KProcess p;
p.setOutputChannelMode(KProcess::MergedChannels);
p.setProgram(qmake, QStringList("-query") << "QT_INSTALL_DOCS");
p.start();
if(p.waitForFinished(5000))
{
QByteArray b = p.readAllStandardOutput();
ret.prepend(b.trimmed());
}
else
kDebug() << "failed to execute qmake to retrieve the docs";
kDebug() << "qtdoc=" << ret;
Q_ASSERT(qmake.isEmpty() || !ret.isEmpty());
return QDir::fromNativeSeparators(ret);
}
QtHelpPlugin::QtHelpPlugin(QObject* parent, const QVariantList& args)
: KDevelop::IPlugin(QtHelpFactory::componentData(), parent)
, m_engine(KStandardDirs::locateLocal("appdata", QString( "qthelpcollection.qhc" ), true, QtHelpFactory::componentData()))
{
if( !m_engine.setupData() ) {
kWarning() << "Couldn't setup QtHelp Collection file, searching in Qt docs will fail";
}
QtHelpDocumentation::s_provider=this;
Q_UNUSED(args);
QStringList qmakes;
QStringList tmp;
KStandardDirs::findAllExe(tmp, "qmake");
qmakes += tmp;
KStandardDirs::findAllExe(tmp, "qmake-qt4");
qmakes += tmp;
QString dirName;
foreach(const QString& qmake, qmakes) {
/// check both in doc/ and doc/qch/
dirName=qtDocsLocation(qmake)+"/qch/";
QString fileName=dirName+"qt.qch";
if(QFile::exists(fileName)) {
kDebug() << "checking doc: " << fileName;
break;
} else
dirName.clear();
dirName=qtDocsLocation(qmake);
fileName=dirName+"/qt.qch";
if(QFile::exists(fileName)) {
kDebug() << "checking doc: " << fileName;
break;
} else
dirName.clear();
}
if(!dirName.isEmpty()) {
QDir d(dirName);
foreach(const QString& file, d.entryList()) {
QString fileName=dirName+'/'+file;
QString fileNamespace = QHelpEngineCore::namespaceName(fileName);
if (!fileNamespace.isEmpty() && !m_engine.registeredDocumentations().contains(fileNamespace)) {
kDebug() << "loading doc" << fileName << fileNamespace;
if(m_engine.registerDocumentation(fileName))
kDebug() << "documentation added successfully" << fileName;
else
kDebug() << "error >> " << fileName << m_engine.error();
}
}
kDebug() << "registered" << m_engine.error() << m_engine.registeredDocumentations();
}
else
kDebug() << "no QtHelp found at all";
}
KSharedPtr< KDevelop::IDocumentation > QtHelpPlugin::documentationForDeclaration(KDevelop::Declaration* dec) const
{
if(dec) {
QStringList idList;
{
KDevelop::DUChainReadLocker lock(KDevelop::DUChain::lock());
KDevelop::QualifiedIdentifier qid = dec->qualifiedIdentifier();
for(int a = 0; a < qid.count(); ++a)
idList << qid.at(a).identifier().str(); //Copy over the identifier components, without the template-parameters
}
QString id = idList.join("::");
if(!id.isEmpty()) {
QMap<QString, QUrl> links=m_engine.linksForIdentifier(id);
kDebug() << "doc_found" << id << links;
if(!links.isEmpty())
return KSharedPtr<KDevelop::IDocumentation>(new QtHelpDocumentation(id, m_engine.linksForIdentifier(id)));
}
}
return KSharedPtr<KDevelop::IDocumentation>();
}
QAbstractListModel* QtHelpPlugin::indexModel() const
{
return m_engine.indexModel();
}
KSharedPtr< KDevelop::IDocumentation > QtHelpPlugin::documentationForIndex(const QModelIndex& idx) const
{
QString name=idx.data(Qt::DisplayRole).toString();
return KSharedPtr<KDevelop::IDocumentation>(new QtHelpDocumentation(name, m_engine.indexModel()->linksForKeyword(name)));
}
QIcon QtHelpPlugin::icon() const
{
return KIcon("qtlogo");
}
QString QtHelpPlugin::name() const
{
return i18n("QtHelp");
}
void QtHelpPlugin::jumpedTo(const QUrl& newUrl) const
{
QMap<QString, QUrl> info;
info.insert(newUrl.toString(), newUrl);
KSharedPtr<KDevelop::IDocumentation> doc(new QtHelpDocumentation(newUrl.toString(), info));
emit addHistory(doc);
}
KSharedPtr<KDevelop::IDocumentation> QtHelpPlugin::homePage() const
{
return KSharedPtr<KDevelop::IDocumentation>(new HomeDocumentation);
}
|
