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
|
/* This file is part of KDevelop
Copyright 2010 Yannick Motta <yannick.motta@gmail.com>
Copyright 2010 Benjamin Port <port.benjamin@gmail.com>
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 <KPluginFactory>
#include <KPluginLoader>
#include <KAboutData>
#include <KMimeType>
#include <KSettings/Dispatcher>
#include <KUrl>
#include <KIcon>
#include <interfaces/idocumentation.h>
#include <language/duchain/duchain.h>
#include <language/duchain/declaration.h>
#include <language/duchain/duchainlock.h>
#include <language/duchain/indexedstring.h>
#include <language/duchain/parsingenvironment.h>
#include <language/duchain/classdeclaration.h>
#include <language/duchain/functiondeclaration.h>
#include <language/duchain/classmemberdeclaration.h>
#include <language/duchain/classfunctiondeclaration.h>
#include <QtCore/QFile>
#include <interfaces/icore.h>
#include <interfaces/idocumentationcontroller.h>
#include <interfaces/iprojectcontroller.h>
#include <QProgressBar>
#include "manpageplugin.h"
#include "manpagedocumentation.h"
#include "manpagemodel.h"
using namespace KDevelop;
K_PLUGIN_FACTORY(ManPageFactory, registerPlugin<ManPagePlugin>(); )
K_EXPORT_PLUGIN(ManPageFactory(KAboutData("kdevmanpage","kdevmanpage", ki18n("ManPage"),
"1", ki18n("Check Man Page documentation"),
KAboutData::License_GPL)))
ManPagePlugin::ManPagePlugin(QObject* parent, const QVariantList& args)
: IPlugin(ManPageFactory::componentData(), parent)
{
KDEV_USE_EXTENSION_INTERFACE( KDevelop::IDocumentationProvider )
Q_UNUSED(args);
ManPageDocumentation::s_provider = this;
m_model = new ManPageModel(this);
}
ManPagePlugin::~ManPagePlugin()
{
delete m_model;
}
QString ManPagePlugin::name() const
{
return QString(i18n("Man Page"));
}
QIcon ManPagePlugin::icon() const
{
static KIcon icon("x-office-address-book");
return icon;
}
ManPageModel* ManPagePlugin::model() const{
return m_model;
}
KSharedPtr< IDocumentation > ManPagePlugin::documentationForDeclaration( Declaration* dec ) const
{
Q_ASSERT(dec);
Q_ASSERT(dec->topContext());
Q_ASSERT(dec->topContext()->parsingEnvironmentFile());
static const KDevelop::IndexedString cppLanguage("C++");
if (dec->topContext()->parsingEnvironmentFile()->language() != cppLanguage) {
return KSharedPtr<IDocumentation>();
}
// Don't show man-page documentation for files that are part of our project
if(core()->projectController()->findProjectForUrl(dec->topContext()->url().toUrl()))
return KSharedPtr<IDocumentation>();
// Don't show man-page documentation for files that are not in /usr/include, because then we
// most probably will be confusing the global function-name with a local one
if(!dec->topContext()->url().str().startsWith("/usr/"))
return KSharedPtr<IDocumentation>();
///@todo Do more verification to make sure that we're showing the correct documentation for the declaration
QString identifier = dec->identifier().toString();
if(m_model->containsIdentifier(identifier)){
KDevelop::DUChainReadLocker lock;
KDevelop::QualifiedIdentifier qid = dec->qualifiedIdentifier();
if(qid.count() == 1){
if(m_model->identifierInSection(identifier, "3")){
return KSharedPtr<IDocumentation>(new ManPageDocumentation(qMakePair(identifier, KUrl("man:(3)/"+identifier))));
} else if(m_model->identifierInSection(identifier, "2")){
return KSharedPtr<IDocumentation>(new ManPageDocumentation(qMakePair(identifier, KUrl("man:(2)/"+identifier))));
} else {
return KSharedPtr<IDocumentation>(new ManPageDocumentation(qMakePair(identifier, KUrl("man:"+identifier))));
}
}
}
return KSharedPtr<IDocumentation>();
}
QAbstractListModel* ManPagePlugin::indexModel() const
{
return m_model->indexList();
}
KSharedPtr< IDocumentation > ManPagePlugin::documentationForIndex(const QModelIndex& index) const
{
QString name = index.data().toString();
return KSharedPtr<IDocumentation>(new ManPageDocumentation(qMakePair(name, KUrl("man:"+name))));
}
KSharedPtr< IDocumentation > ManPagePlugin::homePage() const
{
return KSharedPtr<KDevelop::IDocumentation>(new ManPageHomeDocumentation);
}
#include "manpageplugin.moc"
|
