Differential D16484 Diff 47355 plugins/scratchpad/scratchpadview.cpp

Changeset View

Standalone View

View Options

plugins/scratchpad/scratchpadview.cpp

  • This file was added.
1​/* This file is part of KDevelop
2​ *
3​ * Copyright 2018 Amish K. Naidu <amhndu@gmail.com>
4​ *
5​ * This program is free software; you can redistribute it and/or
6​ * modify it under the terms of the GNU General Public License
7​ * as published by the Free Software Foundation; either version 2
8​ * of the License, or (at your option) any later version.
9​ *
10​ * This program is distributed in the hope that it will be useful,
11​ * but WITHOUT ANY WARRANTY; without even the implied warranty of
12​ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13​ * GNU General Public License for more details.
14​ *
15​ * You should have received a copy of the GNU General Public License
16​ * along with this program; if not, write to the Free Software
17​ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
18​ * 02110-1301, USA.
19​ */
20​
21​#include "scratchpadview.h"
22​#include "scratchpad.h"
23​
24​#include <debug.h>
25​
26​#include <interfaces/icore.h>
27​#include <interfaces/idocumentcontroller.h>
28​#include <interfaces/idocument.h>
29​
30​#include <KLocalizedString>
31​#include <KMessageBox>
32​
33​#include <QAction>
34​#include <QStandardItemModel>
35​#include <QSortFilterProxyModel>
36​#include <QStyledItemDelegate>
37​#include <QWidgetAction>
38​#include <QLineEdit>
39​#include <QInputDialog>
40​#include <QPainter>
41​
42​// Use a delegate because the dataChanged signal doesn't tell us the previous name
43​class FileRenameDelegate
44​ : public QStyledItemDelegate
45​{
46​public:
47​ FileRenameDelegate(QObject* parent, Scratchpad* scratchpad)
48​ : QStyledItemDelegate(parent)
49​ , m_scratchpad(scratchpad)
50​ {
51​ }
52​
53​ void setModelData(QWidget* editor, QAbstractItemModel* model, const QModelIndex& index) const override
54​ {
55​ const QString previousName = index.data().toString();
56​ QStyledItemDelegate::setModelData(editor, model, index);
57​ const auto* proxyModel = static_cast<QAbstractProxyModel*>(model);
58​ m_scratchpad->renameScratch(proxyModel->mapToSource(index), previousName);
59​ }
60​
61​private:
62​ Scratchpad* m_scratchpad;
63​};
64​
65​EmptyMessageListView::EmptyMessageListView(QWidget* parent)
66​ : QListView(parent)
67​{
68​}
69​
70​void EmptyMessageListView::paintEvent(QPaintEvent* event)
71​{
72​ if (model() && model()->rowCount(rootIndex()) > 0) {
73​ QListView::paintEvent(event);
74​ } else {
75​ QPainter painter(viewport());
76​ const auto margin =
77​ QMargins(parentWidget()->style()->pixelMetric(QStyle::PM_LayoutLeftMargin), 0,
78​ parentWidget()->style()->pixelMetric(QStyle::PM_LayoutRightMargin), 0);
79​ painter.drawText(rect() - margin, Qt::AlignCenter | Qt::TextWordWrap, m_message);
80​ }
81​}
82​
83​void EmptyMessageListView::setEmptyMessage(const QString& message)
84​{
85​ m_message = message;
86​}
87​
88​
89​ScratchpadView::ScratchpadView(QWidget* parent, Scratchpad* scratchpad)
90​ : QWidget(parent)
91​ , m_scratchpad(scratchpad)
92​{
93​ setupUi(this);
94​
95​ setupActions();
96​
97​ setWindowTitle(i18n("Scratchpad"));
98​ setWindowIcon(QIcon::fromTheme(QStringLiteral("note")));
99​
100​ auto* const modelProxy = new QSortFilterProxyModel(this);
101​ modelProxy->setSourceModel(m_scratchpad->model());
102​ modelProxy->setFilterCaseSensitivity(Qt::CaseInsensitive);
103​ modelProxy->setSortCaseSensitivity(Qt::CaseInsensitive);
104​ modelProxy->setSortRole(Qt::DisplayRole);
105​ connect(m_filter, &QLineEdit::textEdited,
106​ modelProxy, &QSortFilterProxyModel::setFilterWildcard);
107​
108​ scratchView->setModel(modelProxy);
109​ scratchView->setItemDelegate(new FileRenameDelegate(this, m_scratchpad));
110​ scratchView->setEmptyMessage(i18n("Scratchpad lets you quickly run and experiment with code without a full project, and even store todos. Create a new scratch to start."));
111​
112​ connect(scratchView, &QListView::activated, this, &ScratchpadView::scratchActivated);
113​
114​ connect(m_scratchpad, &Scratchpad::actionFailed, [this](const QString& message) {
115​ KMessageBox::sorry(this, message);
116​ });
117​
118​ connect(commandWidget, &QLineEdit::returnPressed, this, &ScratchpadView::runSelectedScratch);
119​ connect(commandWidget, &QLineEdit::returnPressed, [this] {
120​ m_scratchpad->setCommand(proxyModel()->mapToSource(currentIndex()), commandWidget->text());
121​ });
122​ commandWidget->setToolTip(i18n("Command to run this scratch. $f will expand to the scratch path"));
123​ commandWidget->setPlaceholderText(commandWidget->toolTip());
124​
125​ // change active scratch when changing document
126​ connect(KDevelop::ICore::self()->documentController(), &KDevelop::IDocumentController::documentActivated,
127​ [this](const KDevelop::IDocument* document) {
128​ if (document->url().isLocalFile()) {
129​ const auto* model = scratchView->model();
130​ const auto index = model->match(model->index(0, 0), Scratchpad::FullPathRole,
131​ document->url().toLocalFile()).value({});
132​ if (index.isValid()) {
133​ scratchView->setCurrentIndex(index);
134​ }
135​ }
136​ });
137​
138​ validateItemActions();
139​}
140​
141​void ScratchpadView::setupActions()
142​{
143​ QAction* action = new QAction(QIcon::fromTheme(QStringLiteral("list-add")), i18n("New Scratch"), this);
144​ connect(action, &QAction::triggered, this, &ScratchpadView::createScratch);
145​ addAction(action);
146​
147​ action = new QAction(QIcon::fromTheme(QStringLiteral("list-remove")), i18n("Remove Scratch"), this);
148​ connect(action, &QAction::triggered, [this] {
149​ m_scratchpad->removeScratch(proxyModel()->mapToSource(currentIndex()));
150​ validateItemActions();
151​ });
152​ addAction(action);
153​ m_itemActions.push_back(action);
154​
155​ action = new QAction(QIcon::fromTheme(QStringLiteral("edit-rename")), i18n("Rename Scratch"), this);
brauchUnsubmitted
Done

You can omit the arguments of slots if you do not need them.

brauch: You can omit the arguments of slots if you do not need them.
156​ connect(action, &QAction::triggered, [this] {
157​ scratchView->edit(scratchView->currentIndex());
158​ });
159​ addAction(action);
160​ m_itemActions.push_back(action);
brauchUnsubmitted
Done

"auto" is sufficient, you do not need "auto*"

brauch: "auto" is sufficient, you do not need "auto*"
161​
162​ action = new QAction(QIcon::fromTheme(QStringLiteral("media-playback-start")), i18n("Run Scratch"), this);
163​ connect(action, &QAction::triggered, this, &ScratchpadView::runSelectedScratch);
164​ addAction(action);
165​ m_itemActions.push_back(action);
166​
167​ m_filter = new QLineEdit(this);
168​ m_filter->setPlaceholderText(i18n("Filter..."));
169​ auto filterAction = new QWidgetAction(this);
170​ filterAction->setDefaultWidget(m_filter);
171​ addAction(filterAction);
172​}
173​
174​void ScratchpadView::validateItemActions()
175​{
176​ bool enable = currentIndex().isValid();
177​
brauchUnsubmitted
Done

probably the command should be per scratch ...?

brauch: probably the command should be per scratch ...?
178​ for (auto* action : m_itemActions) {
179​ action->setEnabled(enable);
180​ }
181​
182​ commandWidget->setReadOnly(!enable);
183​ if (!enable) {
184​ commandWidget->clear();
185​ }
186​}
187​
188​void ScratchpadView::runSelectedScratch()
189​{
190​ const auto sourceIndex = proxyModel()->mapToSource(currentIndex());
191​ if (auto* document = KDevelop::ICore::self()->documentController()->documentForUrl(
192​ QUrl::fromLocalFile(sourceIndex.data(Scratchpad::FullPathRole).toString()))) {
193​ document->save();
194​ }
195​ m_scratchpad->setCommand(sourceIndex, commandWidget->text());
196​ m_scratchpad->runScratch(sourceIndex);
197​}
198​
199​void ScratchpadView::scratchActivated(const QModelIndex& index)
200​{
201​ validateItemActions();
202​ m_scratchpad->openScratch(proxyModel()->mapToSource(index));
203​ commandWidget->setText(index.data(Scratchpad::RunCommandRole).toString());
204​}
205​
206​void ScratchpadView::createScratch()
207​{
208​ QString name = QInputDialog::getText(this, i18n("Create New Scratch"),
209​ i18n("Enter name for scratch file:"),
210​ QLineEdit::Normal,
211​ QStringLiteral("example.cpp"));
212​ if (!name.isEmpty()) {
213​ m_scratchpad->createScratch(name);
214​ }
215​}
216​
217​QAbstractProxyModel* ScratchpadView::proxyModel() const
218​{
219​ return static_cast<QAbstractProxyModel*>(scratchView->model());
220​}
221​
222​QModelIndex ScratchpadView::currentIndex() const
223​{
224​ return scratchView->currentIndex();
225​}