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 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
|
/* This file is part of KDevelop
Copyright 2010 Benjamin Port <port.benjamin@gmail.com>
Copyright 2014 Kevin Funk <kfunk@kde.org>
Copyright 2016 Andreas Cord-Landwehr <cordlandwehr@kde.org>
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 "qthelpconfig.h"
#include <QHelpEngineCore>
#include <QToolButton>
#include <QHeaderView>
#include <QPointer>
#include <KMessageBox>
#include <KLocalizedString>
#include <KNS3/Button>
#include "ui_qthelpconfig.h"
#include "ui_qthelpconfigeditdialog.h"
#include "qthelp_config_shared.h"
#include "debug.h"
#include "qthelpplugin.h"
enum Column
{
NameColumn,
PathColumn,
IconColumn,
GhnsColumn,
ConfigColumn
};
class QtHelpConfigEditDialog : public QDialog, public Ui_QtHelpConfigEditDialog
{
Q_OBJECT
public:
explicit QtHelpConfigEditDialog(QTreeWidgetItem* modifiedItem, QtHelpConfig* parent = nullptr)
: QDialog(parent)
, m_modifiedItem(modifiedItem)
, m_config(parent)
{
setupUi(this);
if (modifiedItem) {
setWindowTitle(i18nc("@title:window", "Modify Entry"));
} else {
setWindowTitle(i18nc("@title:window", "Add New Entry"));
}
qchIcon->setIcon(QStringLiteral("qtlogo"));
}
bool checkQtHelpFile();
void accept() override;
private:
QTreeWidgetItem* m_modifiedItem;
QtHelpConfig* m_config;
};
bool QtHelpConfigEditDialog::checkQtHelpFile()
{
//verify if the file is valid and if there is a name
if(qchName->text().isEmpty()){
KMessageBox::error(this, i18n("Name cannot be empty."));
return false;
}
return m_config->checkNamespace(qchRequester->text(), m_modifiedItem);
}
void QtHelpConfigEditDialog::accept()
{
if (!checkQtHelpFile())
return;
QDialog::accept();
}
QtHelpConfig::QtHelpConfig(QtHelpPlugin* plugin, QWidget *parent)
: KDevelop::ConfigPage(plugin, nullptr, parent)
{
m_configWidget = new Ui::QtHelpConfigUI;
m_configWidget->setupUi(this);
m_configWidget->addButton->setIcon(QIcon::fromTheme(QStringLiteral("list-add")));
connect(m_configWidget->addButton, &QPushButton::clicked, this, &QtHelpConfig::add);
// Table
m_configWidget->qchTable->setColumnHidden(IconColumn, true);
m_configWidget->qchTable->setColumnHidden(GhnsColumn, true);
m_configWidget->qchTable->model()->setHeaderData(ConfigColumn, Qt::Horizontal, QVariant());
m_configWidget->qchTable->header()->setSectionsMovable(false);
m_configWidget->qchTable->header()->setStretchLastSection(false);
m_configWidget->qchTable->header()->setSectionResizeMode(NameColumn, QHeaderView::Stretch);
m_configWidget->qchTable->header()->setSectionResizeMode(PathColumn, QHeaderView::Stretch);
m_configWidget->qchTable->header()->setSectionResizeMode(ConfigColumn, QHeaderView::Fixed);
// Add GHNS button
auto* knsButton = new KNS3::Button(i18nc("@action:button Allow user to get some API documentation with GHNS", "Get New Documentation"), QStringLiteral("kdevelop-qthelp.knsrc"), m_configWidget->boxQchManage);
m_configWidget->tableCtrlLayout->insertWidget(1, knsButton);
connect(knsButton, &KNS3::Button::dialogFinished, this, &QtHelpConfig::knsUpdate);
connect(m_configWidget->loadQtDocsCheckBox, &QCheckBox::toggled,
this, QOverload<>::of(&QtHelpConfig::changed));
m_configWidget->qchSearchDir->setMode(KFile::Directory);
connect(m_configWidget->qchSearchDir, &KUrlRequester::textChanged,
this, &QtHelpConfig::changed);
// Set availability information for QtHelp
m_configWidget->messageAvailabilityQtDocs->setCloseButtonVisible(false);
if(plugin->isQtHelpAvailable()) {
m_configWidget->messageAvailabilityQtDocs->setVisible(false);
} else {
m_configWidget->messageAvailabilityQtDocs->setText(
i18n("The command \"qmake -query\" could not provide a path to a QtHelp file (QCH)."));
m_configWidget->loadQtDocsCheckBox->setVisible(false);
}
reset();
}
QtHelpConfig::~QtHelpConfig()
{
delete m_configWidget;
}
KDevelop::ConfigPage::ConfigPageType QtHelpConfig::configPageType() const
{
return KDevelop::ConfigPage::DocumentationConfigPage;
}
void QtHelpConfig::apply()
{
QStringList iconList, nameList, pathList, ghnsList;
for (int i = 0; i < m_configWidget->qchTable->topLevelItemCount(); i++) {
const QTreeWidgetItem* item = m_configWidget->qchTable->topLevelItem(i);
nameList << item->text(0);
pathList << item->text(1);
iconList << item->text(2);
ghnsList << item->text(3);
}
QString searchDir = m_configWidget->qchSearchDir->text();
bool loadQtDoc = m_configWidget->loadQtDocsCheckBox->isChecked();
qtHelpWriteConfig(iconList, nameList, pathList, ghnsList, searchDir, loadQtDoc);
static_cast<QtHelpPlugin*>(plugin())->readConfig();
}
void QtHelpConfig::reset()
{
m_configWidget->qchTable->clear();
QStringList iconList, nameList, pathList, ghnsList;
QString searchDir;
bool loadQtDoc;
qtHelpReadConfig(iconList, nameList, pathList, ghnsList, searchDir, loadQtDoc);
const int size = qMin(qMin(iconList.size(), nameList.size()), pathList.size());
for(int i = 0; i < size; ++i) {
QString ghnsStatus = ghnsList.size()>i ? ghnsList.at(i) : QStringLiteral("0");
addTableItem(iconList.at(i), nameList.at(i), pathList.at(i), ghnsStatus);
}
m_configWidget->qchSearchDir->setText(searchDir);
m_configWidget->loadQtDocsCheckBox->setChecked(loadQtDoc);
emit changed();
}
void QtHelpConfig::defaults()
{
bool change = false;
if(m_configWidget->qchTable->topLevelItemCount() > 0) {
m_configWidget->qchTable->clear();
change = true;
}
if(!m_configWidget->loadQtDocsCheckBox->isChecked()){
m_configWidget->loadQtDocsCheckBox->setChecked(true);
change = true;
}
if (change) {
emit changed();
}
}
void QtHelpConfig::add()
{
QPointer<QtHelpConfigEditDialog> dialog = new QtHelpConfigEditDialog(nullptr, this);
if (dialog->exec()) {
QTreeWidgetItem* item = addTableItem(dialog->qchIcon->icon(), dialog->qchName->text(), dialog->qchRequester->text(), QStringLiteral("0"));
m_configWidget->qchTable->setCurrentItem(item);
emit changed();
}
delete dialog;
}
void QtHelpConfig::modify(QTreeWidgetItem* item)
{
if (!item)
return;
QPointer<QtHelpConfigEditDialog> dialog = new QtHelpConfigEditDialog(item, this);
if (item->text(GhnsColumn) != QLatin1String("0")) {
dialog->qchRequester->setText(i18n("Documentation provided by GHNS"));
dialog->qchRequester->setEnabled(false);
} else {
dialog->qchRequester->setText(item->text(PathColumn));
dialog->qchRequester->setEnabled(true);
}
dialog->qchName->setText(item->text(NameColumn));
dialog->qchIcon->setIcon(item->text(IconColumn));
if (dialog->exec()) {
item->setIcon(NameColumn, QIcon(dialog->qchIcon->icon()));
item->setText(NameColumn, dialog->qchName->text());
item->setText(IconColumn, dialog->qchIcon->icon());
if(item->text(GhnsColumn) == QLatin1String("0")) {
item->setText(PathColumn, dialog->qchRequester->text());
}
emit changed();
}
delete dialog;
}
bool QtHelpConfig::checkNamespace(const QString& filename, QTreeWidgetItem* modifiedItem)
{
QString qtHelpNamespace = QHelpEngineCore::namespaceName(filename);
if (qtHelpNamespace.isEmpty()) {
// Open error message (not valid Qt Compressed Help file)
KMessageBox::error(this, i18n("Qt Compressed Help file is not valid."));
return false;
}
// verify if it's the namespace it's not already in the list
for(int i=0; i < m_configWidget->qchTable->topLevelItemCount(); i++) {
const QTreeWidgetItem* item = m_configWidget->qchTable->topLevelItem(i);
if (item != modifiedItem){
if (qtHelpNamespace == QHelpEngineCore::namespaceName(item->text(PathColumn))) {
// Open error message, documentation already imported
KMessageBox::error(this, i18n("Documentation already imported"));
return false;
}
}
}
return true;
}
void QtHelpConfig::remove(QTreeWidgetItem* item)
{
if (!item)
return;
delete item;
emit changed();
}
void QtHelpConfig::knsUpdate(const KNS3::Entry::List& list)
{
if (list.isEmpty())
return;
for (const KNS3::Entry& e : list) {
if(e.status() == KNS3::Entry::Installed) {
// For zipped/tarred QCH fules KNewStuff also adds the directory as installed file, first file entry is assumed to be QCH file though
if (e.installedFiles().size() >= 1) {
QString filename = e.installedFiles().at(0);
if(checkNamespace(filename, nullptr)){
QTreeWidgetItem* item = addTableItem(QStringLiteral("documentation"), e.name(), filename, QStringLiteral("1"));
m_configWidget->qchTable->setCurrentItem(item);
} else {
qCDebug(QTHELP) << "namespace error";
}
}
} else if(e.status() == KNS3::Entry::Deleted) {
// cmp. note above for installed files
if (e.uninstalledFiles().size() >= 1) {
for(int i=0; i < m_configWidget->qchTable->topLevelItemCount(); i++) {
QTreeWidgetItem* item = m_configWidget->qchTable->topLevelItem(i);
if (e.uninstalledFiles().at(0) == item->text(PathColumn)) {
delete item;
break;
}
}
}
}
}
emit changed();
}
QString QtHelpConfig::name() const
{
return i18nc("@title:tab", "Qt Help");
}
QString QtHelpConfig::fullName() const
{
return i18nc("@title:tab", "Configure Qt Help Settings");
}
QIcon QtHelpConfig::icon() const
{
return QIcon::fromTheme(QStringLiteral("qtlogo"));
}
QTreeWidgetItem * QtHelpConfig::addTableItem(const QString &icon, const QString &name,
const QString &path, const QString &ghnsStatus)
{
auto *item = new QTreeWidgetItem(m_configWidget->qchTable);
item->setIcon(NameColumn, QIcon::fromTheme(icon));
item->setText(NameColumn, name);
item->setToolTip(NameColumn, name);
item->setText(PathColumn, path);
item->setToolTip(PathColumn, path);
item->setText(IconColumn, icon);
item->setText(GhnsColumn, ghnsStatus);
auto* ctrlWidget = new QWidget(item->treeWidget());
ctrlWidget->setLayout(new QHBoxLayout(ctrlWidget));
auto *modifyBtn = new QToolButton(item->treeWidget());
modifyBtn->setIcon(QIcon::fromTheme(QStringLiteral("document-edit")));
modifyBtn->setToolTip(i18nc("@info:tooltip", "Modify"));
connect(modifyBtn, &QPushButton::clicked, this, [=](){
modify(item);
});
auto *removeBtn = new QToolButton(item->treeWidget());
removeBtn->setIcon(QIcon::fromTheme(QStringLiteral("entry-delete")));
removeBtn->setToolTip(i18nc("@info:tooltip", "Delete"));
if (item->text(GhnsColumn) != QLatin1String("0")) {
// KNS3 currently does not provide API to uninstall entries
// just removing the files results in wrong installed states in the KNS3 dialog
// TODO: add API to KNS to remove files without UI interaction
removeBtn->setEnabled(false);
removeBtn->setToolTip(i18nc("@info:tooltip", "Please uninstall this via GHNS."));
} else {
connect(removeBtn, &QPushButton::clicked, this, [=](){
remove(item);
});
}
ctrlWidget->layout()->addWidget(modifyBtn);
ctrlWidget->layout()->addWidget(removeBtn);
m_configWidget->qchTable->setItemWidget(item, ConfigColumn, ctrlWidget);
return item;
}
#include "qthelpconfig.moc"
|