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
|
/*
SPDX-FileCopyrightText: 2018 Amish K. Naidu <amhndu@gmail.com>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#include "scratchpad.h"
#include "scratchpadview.h"
#include "scratchpadjob.h"
#include <debug.h>
#include <interfaces/icore.h>
#include <interfaces/iuicontroller.h>
#include <interfaces/idocumentcontroller.h>
#include <interfaces/iruncontroller.h>
#include <KPluginFactory>
#include <KLocalizedString>
#include <KSharedConfig>
#include <KConfigGroup>
#include <KActionCollection>
#include <QStandardItemModel>
#include <QStandardPaths>
#include <QDir>
#include <QFileIconProvider>
#include <QHash>
#include <algorithm>
K_PLUGIN_FACTORY_WITH_JSON(ScratchpadFactory, "scratchpad.json", registerPlugin<Scratchpad>(); )
class ScratchpadToolViewFactory
: public KDevelop::IToolViewFactory
{
public:
explicit ScratchpadToolViewFactory(Scratchpad* plugin)
: m_plugin(plugin)
{}
QWidget* create(QWidget* parent = nullptr) override
{
return new ScratchpadView(parent, m_plugin);
}
Qt::DockWidgetArea defaultPosition() const override
{
return Qt::LeftDockWidgetArea;
}
QString id() const override
{
return QStringLiteral("org.kdevelop.ScratchpadView");
}
private:
Scratchpad* const m_plugin;
};
namespace {
KConfigGroup scratchCommands()
{
return KSharedConfig::openConfig()->group(QStringLiteral("Scratchpad")).group(QStringLiteral("Commands"));
}
KConfigGroup mimeCommands()
{
return KSharedConfig::openConfig()->group(QStringLiteral("Scratchpad")).group(QStringLiteral("Mime Commands"));
}
QString commandForScratch(const QFileInfo& file)
{
if (scratchCommands().hasKey(file.fileName())) {
return scratchCommands().readEntry(file.fileName());
}
const auto suffix = file.suffix();
if (mimeCommands().hasKey(suffix)) {
return mimeCommands().readEntry(suffix);
}
const static QHash<QString, QString> defaultCommands = {
{QStringLiteral("cpp"), QStringLiteral("g++ -std=c++11 -o /tmp/a.out $f && /tmp/a.out")},
{QStringLiteral("py"), QStringLiteral("python $f")},
{QStringLiteral("js"), QStringLiteral("node $f")},
{QStringLiteral("c"), QStringLiteral("gcc -o /tmp/a.out $f && /tmp/a.out")},
};
return defaultCommands.value(suffix);
}
}
Scratchpad::Scratchpad(QObject* parent, const KPluginMetaData& metaData, const QVariantList& args)
: KDevelop::IPlugin(QStringLiteral("scratchpad"), parent, metaData)
, m_factory(new ScratchpadToolViewFactory(this))
, m_model(new QStandardItemModel(this))
, m_runAction(new QAction(this))
{
Q_UNUSED(args);
qCDebug(PLUGIN_SCRATCHPAD) << "Scratchpad plugin is loaded!";
core()->uiController()->addToolView(i18nc("@title:window", "Scratchpad"), m_factory);
const QDir dataDir(dataDirectory());
if (!dataDir.exists()) {
qCDebug(PLUGIN_SCRATCHPAD) << "Creating directory" << dataDir;
dataDir.mkpath(QStringLiteral("."));
}
const QFileInfoList scratches = dataDir.entryInfoList(QDir::Files | QDir::NoDotAndDotDot);
for (const auto& fileInfo : scratches) {
addFileToModel(fileInfo);
// TODO if scratch is open (happens when restarting), set pretty name, below code doesn't work
// auto* document = core()->documentController()->documentForUrl(QUrl::fromLocalFile(fileInfo.absoluteFilePath()));
// if (document) {
// document->setPrettyName(i18n("scratch:%1", fileInfo.fileName()));
// }
}
}
QStandardItemModel* Scratchpad::model() const
{
return m_model;
}
QString Scratchpad::dataDirectory()
{
const static QString dir = QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation)
+ QLatin1String("/kdevscratchpad/scratches/");
return dir;
}
void Scratchpad::openScratch(const QModelIndex& index)
{
const QUrl scratchUrl = QUrl::fromLocalFile(index.data(FullPathRole).toString());
auto* const document = core()->documentController()->openDocument(scratchUrl);
document->setPrettyName(i18nc("prefix to distinguish scratch tabs", "scratch:%1", index.data().toString()));
}
void Scratchpad::runScratch(const QModelIndex& index)
{
qCDebug(PLUGIN_SCRATCHPAD) << "run" << index.data().toString();
auto command = index.data(RunCommandRole).toString();
command.replace(QLatin1String("$f"), index.data(FullPathRole).toString());
if (!command.isEmpty()) {
auto* job = new ScratchpadJob(command, index.data().toString(), this);
core()->runController()->registerJob(job);
}
}
void Scratchpad::removeScratch(const QModelIndex& index)
{
const QString path = index.data(FullPathRole).toString();
if (auto* document = core()->documentController()->documentForUrl(QUrl::fromLocalFile(path))) {
document->close();
}
if (QFile::remove(path)) {
qCDebug(PLUGIN_SCRATCHPAD) << "removed" << index.data(FullPathRole);
scratchCommands().deleteEntry(index.data().toString());
m_model->removeRow(index.row());
} else {
emit actionFailed(i18n("Failed to remove scratch: %1", index.data().toString()));
}
}
void Scratchpad::createScratch(const QString& name)
{
if (!m_model->findItems(name).isEmpty()) {
emit actionFailed(i18n("Failed to create scratch: Name already in use"));
return;
}
QFile file(dataDirectory() + name);
if (!file.exists() && file.open(QIODevice::WriteOnly)) { // create a new file if it doesn't exist
file.close();
}
if (file.exists()) {
addFileToModel(QFileInfo(file));
} else {
emit actionFailed(i18n("Failed to create new scratch"));
}
}
void Scratchpad::renameScratch(const QModelIndex& index, const QString& previousName)
{
const QString newName = index.data().toString();
if (newName.contains(QDir::separator())) {
m_model->setData(index, previousName); // undo
emit actionFailed(i18n("Failed to rename scratch: Names must not include path separator"));
return;
}
const QString previousPath = dataDirectory() + previousName;
const QString newPath = dataDirectory() + index.data().toString();
if (previousPath == newPath) {
return;
}
if (QFile::rename(previousPath, newPath)) {
qCDebug(PLUGIN_SCRATCHPAD) << "renamed" << previousPath << "to" << newPath;
m_model->setData(index, newPath, Scratchpad::FullPathRole);
m_model->itemFromIndex(index)->setIcon(m_iconProvider.icon(QFileInfo(newPath)));
auto config = scratchCommands();
config.deleteEntry(previousName);
config.writeEntry(newName, index.data(Scratchpad::RunCommandRole));
// close old and re-open the closed document
if (auto* document = core()->documentController()->documentForUrl(QUrl::fromLocalFile(previousPath))) {
// FIXME is there a better way ? this feels hacky
document->close();
document = core()->documentController()->openDocument(QUrl::fromLocalFile(newPath));
document->setPrettyName(i18nc("prefix to distinguish scratch tabs", "scratch:%1", index.data().toString()));
}
} else {
qCWarning(PLUGIN_SCRATCHPAD) << "failed renaming" << previousPath << "to" << newPath;
// rollback
m_model->setData(index, previousName);
emit actionFailed(i18n("Failed renaming scratch."));
}
}
void Scratchpad::addFileToModel(const QFileInfo& fileInfo)
{
auto* const item = new QStandardItem(m_iconProvider.icon(fileInfo), fileInfo.fileName());
item->setData(fileInfo.absoluteFilePath(), FullPathRole);
const auto command = commandForScratch(fileInfo);
item->setData(command, RunCommandRole);
scratchCommands().writeEntry(item->text(), item->data(RunCommandRole));
m_model->appendRow(item);
}
void Scratchpad::setCommand(const QModelIndex& index, const QString& command)
{
qCDebug(PLUGIN_SCRATCHPAD) << "set command" << index.data();
m_model->setData(index, command, RunCommandRole);
scratchCommands().writeEntry(index.data().toString(), command);
mimeCommands().writeEntry(QFileInfo(index.data().toString()).suffix(), command);
}
QAction* Scratchpad::runAction() const
{
return m_runAction;
}
void Scratchpad::createActionsForMainWindow(Sublime::MainWindow* window, QString& xmlFile, KActionCollection& actions)
{
Q_UNUSED(window);
xmlFile = QStringLiteral("kdevscratchpad.rc");
// add to gui action collection, so that the shorcut is easily configurable
// action setup done in ScratchpadView
actions.addAction(QStringLiteral("run_scratch"), m_runAction);
}
#include "scratchpad.moc"
#include "moc_scratchpad.cpp"
|