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 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
|
/*
SPDX-FileCopyrightText: 2015 Milian Wolff <mail@milianw.de>
SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
*/
#include "ktexteditorpluginintegration.h"
#include <QWidget>
#include <QVBoxLayout>
#include <QStackedLayout>
#include <KParts/MainWindow>
#include <KTextEditor/View>
#include <KTextEditor/Editor>
#include <KTextEditor/Application>
#include <sublime/area.h>
#include <sublime/container.h>
#include <sublime/view.h>
#include <sublime/viewbarcontainer.h>
#include "core.h"
#include "uicontroller.h"
#include "documentcontroller.h"
#include "plugincontroller.h"
#include "sessioncontroller.h"
#include "mainwindow.h"
#include "textdocument.h"
#include <util/objectlist.h>
using namespace KDevelop;
namespace {
KTextEditor::MainWindow *toKteWrapper(KParts::MainWindow *window)
{
if (auto mainWindow = qobject_cast<KDevelop::MainWindow*>(window)) {
return mainWindow->kateWrapper() ? mainWindow->kateWrapper()->interface() : nullptr;
} else {
return nullptr;
}
}
KTextEditor::View *toKteView(Sublime::View *view)
{
if (auto textView = qobject_cast<KDevelop::TextView*>(view)) {
return textView->textView();
} else {
return nullptr;
}
}
class ToolViewFactory;
/**
* This HACK is required to massage the KTextEditor plugin API into the
* GUI concepts we apply in KDevelop. Kate does not allow the user to
* delete tool views and then readd them. We do. To support our use case
* we prevent the widget we return to KTextEditor plugins from
* MainWindow::createToolView from getting destroyed. This widget class
* unsets the parent of the so called container in its dtor. The
* ToolViewFactory handles the ownership and destroys the kate widget
* as needed.
*/
class KeepAliveWidget : public QWidget
{
Q_OBJECT
public:
explicit KeepAliveWidget(ToolViewFactory *factory, QWidget *parent = nullptr)
: QWidget(parent)
, m_factory(factory)
{
}
~KeepAliveWidget() override;
private:
ToolViewFactory* const m_factory;
};
class ToolViewFactory : public QObject, public KDevelop::IToolViewFactory
{
Q_OBJECT
public:
ToolViewFactory(const QString &text, const QIcon &icon, const QString &identifier,
KTextEditor::MainWindow::ToolViewPosition pos)
: m_text(text)
, m_icon(icon)
, m_identifier(identifier)
, m_container(new QWidget)
, m_pos(pos)
{
m_container->setLayout(new QVBoxLayout);
}
~ToolViewFactory() override
{
delete m_container;
}
QWidget *create(QWidget *parent = nullptr) override
{
auto widget = new KeepAliveWidget(this, parent);
widget->setWindowTitle(m_text);
widget->setWindowIcon(m_icon);
widget->setLayout(new QVBoxLayout);
widget->layout()->addWidget(m_container);
widget->addActions(m_container->actions());
return widget;
}
Qt::DockWidgetArea defaultPosition() const override
{
switch (m_pos) {
case KTextEditor::MainWindow::Left:
return Qt::LeftDockWidgetArea;
case KTextEditor::MainWindow::Right:
return Qt::RightDockWidgetArea;
case KTextEditor::MainWindow::Top:
return Qt::TopDockWidgetArea;
case KTextEditor::MainWindow::Bottom:
return Qt::BottomDockWidgetArea;
}
Q_UNREACHABLE();
}
QString id() const override
{
return m_identifier;
}
QWidget *container() const
{
return m_container;
}
private:
const QString m_text;
const QIcon m_icon;
const QString m_identifier;
QPointer<QWidget> m_container;
const KTextEditor::MainWindow::ToolViewPosition m_pos;
friend class KeepAliveWidget;
};
KeepAliveWidget::~KeepAliveWidget()
{
// if the container is still valid, unparent it to prevent it from getting deleted
// this happens when the user removes a tool view
// on shutdown, the container does get deleted, thus we must guard against that.
if (m_factory->container()) {
Q_ASSERT(m_factory->container()->parentWidget() == this);
m_factory->container()->setParent(nullptr);
}
}
}
namespace KTextEditorIntegration {
Application::Application(QObject *parent)
: QObject(parent)
{
}
Application::~Application()
{
KTextEditor::Editor::instance()->setApplication(nullptr);
}
KTextEditor::MainWindow *Application::activeMainWindow() const
{
return toKteWrapper(Core::self()->uiController()->activeMainWindow());
}
QList<KTextEditor::MainWindow *> Application::mainWindows() const
{
return {activeMainWindow()};
}
bool Application::closeDocument(KTextEditor::Document *document) const
{
const auto& openDocuments = Core::self()->documentControllerInternal()->openDocuments();
for (auto doc : openDocuments) {
if (doc->textDocument() == document) {
return doc->close();
}
}
return false;
}
KTextEditor::Plugin *Application::plugin(const QString &id) const
{
auto kdevPlugin = Core::self()->pluginController()->loadPlugin(id);
const auto plugin = dynamic_cast<Plugin*>(kdevPlugin);
return plugin ? plugin->interface() : nullptr;
}
QList<KTextEditor::Document *> Application::documents()
{
QList<KTextEditor::Document *> l;
const auto openDocuments = Core::self()->documentControllerInternal()->openDocuments();
l.reserve(openDocuments.size());
for (auto* d : openDocuments) {
l << d->textDocument();
}
return l;
}
KTextEditor::Document *Application::openUrl(const QUrl &url, const QString &encoding)
{
Q_UNUSED(encoding);
auto documentController = Core::self()->documentControllerInternal();
auto doc = url.isEmpty() ? documentController->openDocumentFromText(QString()) : documentController->openDocument(url);
return doc->textDocument();
}
KTextEditor::Document *Application::findUrl(const QUrl &url) const
{
auto doc = Core::self()->documentControllerInternal()->documentForUrl(url);
return doc ? doc->textDocument() : nullptr;
}
bool Application::quit() const
{
Core::self()->sessionController()->emitQuitSession();
return true;
}
MainWindow::MainWindow(KDevelop::MainWindow *mainWindow)
: QObject(mainWindow)
, m_mainWindow(mainWindow)
, m_interface(new KTextEditor::MainWindow(this))
{
connect(mainWindow, &Sublime::MainWindow::viewAdded, this, [this] (Sublime::View *view) {
if (auto kteView = toKteView(view)) {
emit m_interface->viewCreated(kteView);
}
});
connect(mainWindow, &Sublime::MainWindow::activeViewChanged, this, [this] (Sublime::View *view) {
auto kteView = toKteView(view);
emit m_interface->viewChanged(kteView);
if (auto viewBar = m_viewBars.value(kteView)) {
m_mainWindow->viewBarContainer()->setCurrentViewBar(viewBar);
}
});
}
MainWindow::~MainWindow() = default;
QWidget *MainWindow::createToolView(KTextEditor::Plugin* plugin, const QString &identifier,
KTextEditor::MainWindow::ToolViewPosition pos,
const QIcon &icon, const QString &text)
{
auto factory = new ToolViewFactory(text, icon, identifier, pos);
Core::self()->uiController()->addToolView(text, factory);
connect(plugin, &QObject::destroyed, this, [=] {
Core::self()->uiController()->removeToolView(factory);
});
return factory->container();
}
KXMLGUIFactory *MainWindow::guiFactory() const
{
return m_mainWindow->guiFactory();
}
QWidget *MainWindow::window() const
{
return m_mainWindow;
}
QList<KTextEditor::View *> MainWindow::views() const
{
QList<KTextEditor::View *> kteViews;
const auto areas = m_mainWindow->areas();
for (auto* area : areas) {
const auto views = area->views();
for (auto* view : views) {
if (auto kteView = toKteView(view)) {
kteViews << kteView;
}
}
}
return kteViews;
}
KTextEditor::View *MainWindow::activeView() const
{
return toKteView(m_mainWindow->activeView());
}
KTextEditor::View *MainWindow::activateView(KTextEditor::Document *doc)
{
const auto areas = m_mainWindow->areas();
for (auto* area : areas) {
const auto views = area->views();
for (auto* view : views) {
if (auto kteView = toKteView(view)) {
if (kteView->document() == doc) {
m_mainWindow->activateView(view);
return kteView;
}
}
}
}
return activeView();
}
bool MainWindow::closeView(KTextEditor::View *kteView)
{
if (!kteView) {
return false;
}
const auto areas = m_mainWindow->areas();
for (auto* area : areas) {
const auto views = area->views();
for (auto* view : views) {
if (toKteView(view) == kteView) {
area->closeView(view);
return true;
}
}
}
return false;
}
bool MainWindow::closeSplitView(KTextEditor::View *kteView)
{
return closeView(kteView);
}
bool MainWindow::viewsInSameSplitView(KTextEditor::View *kteView1, KTextEditor::View *kteView2) const
{
if (!kteView1 || !kteView2) {
return false;
}
if (kteView1 == kteView2) {
return true;
}
bool view1Found = false;
bool view2Found = false;
const auto containers = m_mainWindow->containers();
for (const auto* container : containers) {
const auto views = container->views();
for (auto* view : views) {
const KTextEditor::View *kteView = toKteView(view);
if (kteView == kteView1) {
view1Found = true;
} else if (kteView == kteView2) {
view2Found = true;
}
if (view1Found && view2Found) {
// both views found in the same container
return true;
}
}
if (view1Found != view2Found) {
// only one view being found implies that the other is in a different container
return false;
}
}
return false;
}
QObject *MainWindow::pluginView(const QString &id) const
{
return m_pluginViews.value(id);
}
QWidget *MainWindow::createViewBar(KTextEditor::View *view)
{
Q_UNUSED(view);
// we reuse the central view bar for every view
return m_mainWindow->viewBarContainer();
}
void MainWindow::deleteViewBar(KTextEditor::View *view)
{
auto viewBar = m_viewBars.take(view);
m_mainWindow->viewBarContainer()->removeViewBar(viewBar);
delete viewBar;
}
void MainWindow::showViewBar(KTextEditor::View *view)
{
auto viewBar = m_viewBars.value(view);
Q_ASSERT(viewBar);
m_mainWindow->viewBarContainer()->showViewBar(viewBar);
}
void MainWindow::hideViewBar(KTextEditor::View *view)
{
auto viewBar = m_viewBars.value(view);
Q_ASSERT(viewBar);
m_mainWindow->viewBarContainer()->hideViewBar(viewBar);
}
void MainWindow::addWidgetToViewBar(KTextEditor::View *view, QWidget *widget)
{
Q_ASSERT(widget);
m_viewBars[view] = widget;
m_mainWindow->viewBarContainer()->addViewBar(widget);
}
KTextEditor::View *MainWindow::openUrl(const QUrl &url, const QString &encoding)
{
return activateView(KTextEditor::Editor::instance()->application()->openUrl(url, encoding));
}
bool MainWindow::showToolView(QWidget *widget)
{
if (widget->parentWidget()) {
Core::self()->uiController()->raiseToolView(widget->parentWidget());
return true;
}
return false;
}
KTextEditor::MainWindow *MainWindow::interface() const
{
return m_interface;
}
void MainWindow::addPluginView(const QString &id, QObject *view)
{
m_pluginViews.insert(id, view);
emit m_interface->pluginViewCreated(id, view);
}
void MainWindow::removePluginView(const QString &id)
{
auto view = m_pluginViews.take(id).data();
delete view;
emit m_interface->pluginViewDeleted(id, view);
}
Plugin::Plugin(KTextEditor::Plugin *plugin, QObject *parent)
: IPlugin({}, parent)
, m_plugin(plugin)
, m_tracker(new ObjectListTracker(ObjectListTracker::CleanupWhenDone, this))
{
}
Plugin::~Plugin() = default;
void Plugin::unload()
{
if (auto mainWindow = KTextEditor::Editor::instance()->application()->activeMainWindow()) {
auto integration = qobject_cast<MainWindow*>(mainWindow->parent());
if (integration) {
integration->removePluginView(pluginId());
}
}
m_tracker->deleteAll();
delete m_plugin;
}
KXMLGUIClient *Plugin::createGUIForMainWindow(Sublime::MainWindow* window)
{
auto ret = IPlugin::createGUIForMainWindow(window);
auto mainWindow = qobject_cast<KDevelop::MainWindow*>(window);
Q_ASSERT(mainWindow);
auto wrapper = mainWindow->kateWrapper();
auto view = m_plugin->createView(wrapper->interface());
wrapper->addPluginView(pluginId(), view);
// ensure that unloading the plugin kills all views
m_tracker->append(view);
return ret;
}
KTextEditor::Plugin *Plugin::interface() const
{
return m_plugin.data();
}
QString Plugin::pluginId() const
{
return Core::self()->pluginController()->pluginInfo(this).pluginId();
}
void initialize()
{
auto app = new KTextEditor::Application(new Application(Core::self()));
KTextEditor::Editor::instance()->setApplication(app);
}
void MainWindow::splitView(Qt::Orientation orientation)
{
m_mainWindow->split(orientation);
}
}
#include "ktexteditorpluginintegration.moc"
|