Files
konsole/src/ViewManager.cpp
Ahmad Samir e693f2d7f1 The default navigation method should be TabbedNavigation
TabbedNavigation is when we have a MainWindow, i.e. the typical use case;
whereas NoNavigation is when using Konsole Part. The code in Part calls
setNavigationMethod(NoNavigation), so things should work as before.

I made a wrong assumption that TabbedNavigation was already the default.

CCBUG: 432077
2021-09-01 11:38:29 +02:00

1250 lines
43 KiB
C++

/*
SPDX-FileCopyrightText: 2006-2008 Robert Knight <robertknight@gmail.com>
SPDX-License-Identifier: GPL-2.0-or-later
*/
// Own
#include "ViewManager.h"
#include "config-konsole.h"
// Qt
#include <QStringList>
#include <QTabBar>
#include <QStandardPaths>
#include <QFile>
#include <QFileDialog>
#include <QJsonArray>
#include <QJsonDocument>
// KDE
#include <KLocalizedString>
#include <KMessageBox>
#include <KActionCollection>
#include <KConfigGroup>
// Konsole
#include <windowadaptor.h>
#include "colorscheme/ColorScheme.h"
#include "colorscheme/ColorSchemeManager.h"
#include "profile/ProfileManager.h"
#include "session/Session.h"
#include "session/SessionController.h"
#include "session/SessionManager.h"
#include "terminalDisplay/TerminalDisplay.h"
#include "widgets/ViewContainer.h"
#include "widgets/ViewSplitter.h"
using namespace Konsole;
int ViewManager::lastManagerId = 0;
ViewManager::ViewManager(QObject *parent, KActionCollection *collection) :
QObject(parent),
_viewContainer(nullptr),
_pluggedController(nullptr),
_sessionMap(QHash<TerminalDisplay *, Session *>()),
_actionCollection(collection),
_navigationMethod(TabbedNavigation),
_navigationVisibility(NavigationNotSet),
_managerId(0),
_terminalDisplayHistoryIndex(-1)
{
_viewContainer = createContainer();
// setup actions which are related to the views
setupActions();
/* TODO: Reconnect
// emit a signal when all of the views held by this view manager are destroyed
*/
connect(_viewContainer.data(), &Konsole::TabbedViewContainer::empty,
this, &Konsole::ViewManager::empty);
// listen for profile changes
connect(ProfileManager::instance(), &Konsole::ProfileManager::profileChanged,
this, &Konsole::ViewManager::profileChanged);
connect(SessionManager::instance(), &Konsole::SessionManager::sessionUpdated,
this, &Konsole::ViewManager::updateViewsForSession);
//prepare DBus communication
new WindowAdaptor(this);
_managerId = ++lastManagerId;
QDBusConnection::sessionBus().registerObject(QLatin1String("/Windows/")
+ QString::number(_managerId), this);
}
ViewManager::~ViewManager() = default;
int ViewManager::managerId() const
{
return _managerId;
}
QWidget *ViewManager::activeView() const
{
return _viewContainer->currentWidget();
}
QWidget *ViewManager::widget() const
{
return _viewContainer;
}
void ViewManager::setupActions()
{
Q_ASSERT(_actionCollection);
if (_actionCollection == nullptr) {
return;
}
KActionCollection *collection = _actionCollection;
// Let's reuse the pointer, no need not to.
auto *action = new QAction(this);
action->setIcon(QIcon::fromTheme(QStringLiteral("view-split-left-right")));
action->setText(i18nc("@action:inmenu", "Split View Left/Right"));
connect(action, &QAction::triggered, this, &ViewManager::splitLeftRight);
collection->addAction(QStringLiteral("split-view-left-right"), action);
collection->setDefaultShortcut(action, Konsole::ACCEL | Qt::Key_ParenLeft);
action = new QAction(this);
action->setIcon(QIcon::fromTheme(QStringLiteral("view-split-top-bottom")));
action->setText(i18nc("@action:inmenu", "Split View Top/Bottom"));
connect(action, &QAction::triggered, this, &ViewManager::splitTopBottom);
collection->setDefaultShortcut(action, Konsole::ACCEL | Qt::Key_ParenRight);
collection->addAction(QStringLiteral("split-view-top-bottom"), action);
action = new QAction(this);
action->setIcon(QIcon::fromTheme(QStringLiteral("view-split-top-bottom")));
action->setText(i18nc("@action:inmenu", "Load a new tab with layout 2x2 terminals"));
connect(action, &QAction::triggered,
this, [this](){
this->loadLayout(QStandardPaths::locate(QStandardPaths::GenericDataLocation, QStringLiteral("konsole/2x2-terminals.json"))); });
collection->addAction(QStringLiteral("load-terminals-layout-2x2"), action);
action = new QAction(this);
action->setIcon(QIcon::fromTheme(QStringLiteral("view-split-left-right")));
action->setText(i18nc("@action:inmenu", "Load a new tab with layout 2x1 terminals"));
connect(action, &QAction::triggered,
this, [this](){
this->loadLayout(QStandardPaths::locate(QStandardPaths::GenericDataLocation, QStringLiteral("konsole/2x1-terminals.json"))); });
collection->addAction(QStringLiteral("load-terminals-layout-2x1"), action);
action = new QAction(this);
action->setIcon(QIcon::fromTheme(QStringLiteral("view-split-top-bottom")));
action->setText(i18nc("@action:inmenu", "Load a new tab with layout 2x1 terminals"));
connect(action, &QAction::triggered,
this, [this](){
this->loadLayout(QStandardPaths::locate(QStandardPaths::GenericDataLocation, QStringLiteral("konsole/1x2-terminals.json"))); });
collection->addAction(QStringLiteral("load-terminals-layout-1x2"), action);
action = new QAction(this);
action->setText(i18nc("@action:inmenu", "Expand View"));
action->setEnabled(false);
connect(action, &QAction::triggered, this, &ViewManager::expandActiveContainer);
collection->setDefaultShortcut(action, Konsole::ACCEL | Qt::SHIFT | Qt::Key_BracketRight);
collection->addAction(QStringLiteral("expand-active-view"), action);
_multiSplitterOnlyActions << action;
action = new QAction(this);
action->setText(i18nc("@action:inmenu", "Shrink View"));
collection->setDefaultShortcut(action, Konsole::ACCEL | Qt::SHIFT | Qt::Key_BracketLeft);
action->setEnabled(false);
collection->addAction(QStringLiteral("shrink-active-view"), action);
connect(action, &QAction::triggered, this, &ViewManager::shrinkActiveContainer);
_multiSplitterOnlyActions << action;
action = collection->addAction(QStringLiteral("detach-view"));
action->setEnabled(true);
action->setIcon(QIcon::fromTheme(QStringLiteral("tab-detach")));
action->setText(i18nc("@action:inmenu", "Detach Current &View"));
connect(action, &QAction::triggered, this, &ViewManager::detachActiveView);
_multiSplitterOnlyActions << action;
// Ctrl+Shift+D is not used as a shortcut by default because it is too close
// to Ctrl+D - which will terminate the session in many cases
collection->setDefaultShortcut(action, Konsole::ACCEL | Qt::SHIFT | Qt::Key_H);
action = collection->addAction(QStringLiteral("detach-tab"));
action->setEnabled(true);
action->setIcon(QIcon::fromTheme(QStringLiteral("tab-detach")));
action->setText(i18nc("@action:inmenu", "Detach Current &Tab"));
connect(action, &QAction::triggered, this, &ViewManager::detachActiveTab);
_multiTabOnlyActions << action;
// keyboard shortcut only actions
action = new QAction(i18nc("@action Shortcut entry", "Next Tab"), this);
const QList<QKeySequence> nextViewActionKeys{Qt::SHIFT | Qt::Key_Right, Qt::CTRL | Qt::Key_PageDown};
collection->setDefaultShortcuts(action, nextViewActionKeys);
collection->addAction(QStringLiteral("next-tab"), action);
connect(action, &QAction::triggered, this, &ViewManager::nextView);
_multiTabOnlyActions << action;
// _viewSplitter->addAction(nextViewAction);
action = new QAction(i18nc("@action Shortcut entry", "Previous Tab"), this);
const QList<QKeySequence> previousViewActionKeys{Qt::SHIFT | Qt::Key_Left, Qt::CTRL | Qt::Key_PageUp};
collection->setDefaultShortcuts(action, previousViewActionKeys);
collection->addAction(QStringLiteral("previous-tab"), action);
connect(action, &QAction::triggered, this, &ViewManager::previousView);
_multiTabOnlyActions << action;
// _viewSplitter->addAction(previousViewAction);
action = new QAction(i18nc("@action Shortcut entry", "Focus Above Terminal"), this);
connect(action, &QAction::triggered, this, &ViewManager::focusUp);
collection->addAction(QStringLiteral("focus-view-above"), action);
collection->setDefaultShortcut(action, Qt::SHIFT | Qt::CTRL | Qt::Key_Up);
_viewContainer->addAction(action);
_multiSplitterOnlyActions << action;
action = new QAction(i18nc("@action Shortcut entry", "Focus Below Terminal"), this);
collection->setDefaultShortcut(action, Qt::SHIFT | Qt::CTRL | Qt::Key_Down);
collection->addAction(QStringLiteral("focus-view-below"), action);
connect(action, &QAction::triggered, this, &ViewManager::focusDown);
_multiSplitterOnlyActions << action;
_viewContainer->addAction(action);
action = new QAction(i18nc("@action Shortcut entry", "Focus Left Terminal"), this);
collection->setDefaultShortcut(action, Konsole::ACCEL | Qt::SHIFT | Konsole::LEFT);
connect(action, &QAction::triggered, this, &ViewManager::focusLeft);
collection->addAction(QStringLiteral("focus-view-left"), action);
_multiSplitterOnlyActions << action;
action = new QAction(i18nc("@action Shortcut entry", "Focus Right Terminal"), this);
collection->setDefaultShortcut(action, Konsole::ACCEL | Qt::SHIFT | Konsole::RIGHT);
connect(action, &QAction::triggered, this, &ViewManager::focusRight);
collection->addAction(QStringLiteral("focus-view-right"), action);
_multiSplitterOnlyActions << action;
action = new QAction(i18nc("@action Shortcut entry", "Switch to Last Tab"), this);
connect(action, &QAction::triggered, this, &ViewManager::lastView);
collection->addAction(QStringLiteral("last-tab"), action);
_multiTabOnlyActions << action;
action = new QAction(i18nc("@action Shortcut entry", "Last Used Tabs"), this);
connect(action, &QAction::triggered, this, &ViewManager::lastUsedView);
collection->setDefaultShortcut(action, Qt::CTRL | Qt::Key_Tab);
collection->addAction(QStringLiteral("last-used-tab"), action);
action = new QAction(i18nc("@action Shortcut entry", "Toggle Between Two Tabs"), this);
connect(action, &QAction::triggered, this, &Konsole::ViewManager::toggleTwoViews);
collection->addAction(QStringLiteral("toggle-two-tabs"), action);
_multiTabOnlyActions << action;
action = new QAction(i18nc("@action Shortcut entry", "Last Used Tabs (Reverse)"), this);
collection->addAction(QStringLiteral("last-used-tab-reverse"), action);
collection->setDefaultShortcut(action, Qt::CTRL | Qt::SHIFT | Qt::Key_Tab);
connect(action, &QAction::triggered, this, &ViewManager::lastUsedViewReverse);
action = new QAction(i18nc("@action Shortcut entry", "Toggle maximize current view"), this);
action->setText(i18nc("@action:inmenu", "Toggle maximize current view"));
action->setIcon(QIcon::fromTheme(QStringLiteral("view-fullscreen")));
collection->addAction(QStringLiteral("toggle-maximize-current-view"), action);
collection->setDefaultShortcut(action, Qt::CTRL | Qt::SHIFT | Qt::Key_E);
connect(action, &QAction::triggered, _viewContainer, &TabbedViewContainer::toggleMaximizeCurrentTerminal);
_multiSplitterOnlyActions << action;
_viewContainer->addAction(action);
action = new QAction(i18nc("@action Shortcut entry", "Move tab to the right"), this);
collection->addAction(QStringLiteral("move-tab-to-right"), action);
collection->setDefaultShortcut(action, Qt::CTRL | Qt::ALT | Qt::Key_Right);
connect(action, &QAction::triggered, _viewContainer, &TabbedViewContainer::moveTabRight);
_multiTabOnlyActions << action;
_viewContainer->addAction(action);
action = new QAction(i18nc("@action Shortcut entry", "Move tab to the left"), this);
collection->addAction(QStringLiteral("move-tab-to-left"), action);
collection->setDefaultShortcut(action, Qt::CTRL | Qt::ALT | Qt::Key_Left);
connect(action, &QAction::triggered, _viewContainer, &TabbedViewContainer::moveTabLeft);
_multiTabOnlyActions << action;
_viewContainer->addAction(action);
// _viewSplitter->addAction(lastUsedViewReverseAction);
const int SWITCH_TO_TAB_COUNT = 19;
for (int i = 0; i < SWITCH_TO_TAB_COUNT; ++i) {
action = new QAction(i18nc("@action Shortcut entry", "Switch to Tab %1", i + 1), this);
connect(action, &QAction::triggered, this, [this, i]() { switchToView(i); });
collection->addAction(QStringLiteral("switch-to-tab-%1").arg(i), action);
_multiTabOnlyActions << action;
// only add default shortcut bindings for the first 10 tabs, regardless of SWITCH_TO_TAB_COUNT
if (i < 9) {
collection->setDefaultShortcut(action, QStringLiteral("Alt+%1").arg(i + 1));
} else if (i == 9) {
// add shortcut for 10th tab
collection->setDefaultShortcut(action, Qt::ALT | Qt::Key_0);
}
}
connect(_viewContainer, &TabbedViewContainer::viewAdded, this, &ViewManager::toggleActionsBasedOnState);
connect(_viewContainer, &QTabWidget::currentChanged, this, &ViewManager::toggleActionsBasedOnState);
toggleActionsBasedOnState();
}
void ViewManager::toggleActionsBasedOnState() {
const int count = _viewContainer->count();
for (QAction *tabOnlyAction : qAsConst(_multiTabOnlyActions)) {
tabOnlyAction->setEnabled(count > 1);
}
if ((_viewContainer != nullptr) && (_viewContainer->activeViewSplitter() != nullptr)) {
const int splitCount = _viewContainer
->activeViewSplitter()
->getToplevelSplitter()
->findChildren<TerminalDisplay*>()
.count();
for (QAction *action : qAsConst(_multiSplitterOnlyActions)) {
action->setEnabled(splitCount > 1);
}
}
}
void ViewManager::switchToView(int index)
{
_viewContainer->setCurrentIndex(index);
}
void ViewManager::switchToTerminalDisplay(Konsole::TerminalDisplay* terminalDisplay)
{
auto splitter = qobject_cast<ViewSplitter*>(terminalDisplay->parentWidget());
auto toplevelSplitter = splitter->getToplevelSplitter();
// Focus the TermialDisplay
terminalDisplay->setFocus();
if (_viewContainer->currentWidget() != toplevelSplitter) {
// Focus the tab
switchToView(_viewContainer->indexOf(toplevelSplitter));
}
}
void ViewManager::focusUp()
{
_viewContainer->activeViewSplitter()->focusUp();
}
void ViewManager::focusDown()
{
_viewContainer->activeViewSplitter()->focusDown();
}
void ViewManager::focusLeft()
{
_viewContainer->activeViewSplitter()->focusLeft();
}
void ViewManager::focusRight()
{
_viewContainer->activeViewSplitter()->focusRight();
}
void ViewManager::moveActiveViewLeft()
{
_viewContainer->moveActiveView(TabbedViewContainer::MoveViewLeft);
}
void ViewManager::moveActiveViewRight()
{
_viewContainer->moveActiveView(TabbedViewContainer::MoveViewRight);
}
void ViewManager::nextContainer()
{
// _viewSplitter->activateNextContainer();
}
void ViewManager::nextView()
{
_viewContainer->activateNextView();
}
void ViewManager::previousView()
{
_viewContainer->activatePreviousView();
}
void ViewManager::lastView()
{
_viewContainer->activateLastView();
}
void ViewManager::activateLastUsedView(bool reverse)
{
if (_terminalDisplayHistory.count() <= 1) {
return;
}
if (_terminalDisplayHistoryIndex == -1) {
_terminalDisplayHistoryIndex = reverse ? _terminalDisplayHistory.count() - 1 : 1;
} else if (reverse) {
if (_terminalDisplayHistoryIndex == 0) {
_terminalDisplayHistoryIndex = _terminalDisplayHistory.count() - 1;
} else {
_terminalDisplayHistoryIndex--;
}
} else {
if (_terminalDisplayHistoryIndex >= _terminalDisplayHistory.count() - 1) {
_terminalDisplayHistoryIndex = 0;
} else {
_terminalDisplayHistoryIndex++;
}
}
switchToTerminalDisplay(_terminalDisplayHistory[_terminalDisplayHistoryIndex]);
}
void ViewManager::lastUsedView()
{
activateLastUsedView(false);
}
void ViewManager::lastUsedViewReverse()
{
activateLastUsedView(true);
}
void ViewManager::toggleTwoViews()
{
if (_terminalDisplayHistory.count() <= 1) {
return;
}
switchToTerminalDisplay(_terminalDisplayHistory.at(1));
}
void ViewManager::detachActiveView()
{
// find the currently active view and remove it from its container
if ((_viewContainer->findChildren<TerminalDisplay*>()).count() > 1) {
auto activeSplitter = _viewContainer->activeViewSplitter();
auto terminal = activeSplitter->activeTerminalDisplay();
auto newSplitter = new ViewSplitter();
newSplitter->addTerminalDisplay(terminal, Qt::Horizontal);
QHash<TerminalDisplay*, Session*> detachedSessions = forgetAll(newSplitter);
Q_EMIT terminalsDetached(newSplitter, detachedSessions);
focusAnotherTerminal(activeSplitter->getToplevelSplitter());
toggleActionsBasedOnState();
}
}
void ViewManager::detachActiveTab()
{
const int currentIdx = _viewContainer->currentIndex();
detachTab(currentIdx);
}
void ViewManager::detachTab(int tabIdx)
{
ViewSplitter* splitter = _viewContainer->viewSplitterAt(tabIdx);
QHash<TerminalDisplay*, Session*> detachedSessions = forgetAll(_viewContainer->viewSplitterAt(tabIdx));
Q_EMIT terminalsDetached(splitter, detachedSessions);
}
QHash<TerminalDisplay*, Session*> ViewManager::forgetAll(ViewSplitter* splitter) {
splitter->setParent(nullptr);
QHash<TerminalDisplay*, Session*> detachedSessions;
const QList<TerminalDisplay *> displays = splitter->findChildren<TerminalDisplay*>();
for (TerminalDisplay *terminal : displays) {
Session* session = forgetTerminal(terminal);
detachedSessions[terminal] = session;
}
return detachedSessions;
}
Session* ViewManager::forgetTerminal(TerminalDisplay* terminal)
{
unregisterTerminal(terminal);
removeController(terminal->sessionController());
auto session = _sessionMap.take(terminal);
if (session != nullptr) {
disconnect(session, &Konsole::Session::finished, this, &Konsole::ViewManager::sessionFinished);
}
_viewContainer->disconnectTerminalDisplay(terminal);
updateTerminalDisplayHistory(terminal, true);
return session;
}
Session* ViewManager::createSession(const Profile::Ptr &profile, const QString &directory)
{
Session *session = SessionManager::instance()->createSession(profile);
Q_ASSERT(session);
if (!directory.isEmpty()) {
session->setInitialWorkingDirectory(directory);
}
session->addEnvironmentEntry(QStringLiteral("KONSOLE_DBUS_WINDOW=/Windows/%1").arg(managerId()));
return session;
}
void ViewManager::sessionFinished()
{
// if this slot is called after the view manager's main widget
// has been destroyed, do nothing
if (_viewContainer.isNull()) {
return;
}
if (_navigationMethod == TabbedNavigation) {
// The last session/tab, and only one view (no splits), emit empty()
// so that close() is called in MainWindow, fixes #432077
if (_viewContainer->count() == 1 && _viewContainer->currentTabViewCount() == 1) {
Q_EMIT empty();
return;
}
}
auto *session = qobject_cast<Session *>(sender());
Q_ASSERT(session);
auto view = _sessionMap.key(session);
_sessionMap.remove(view);
if (SessionManager::instance()->isClosingAllSessions()){
return;
}
// Before deleting the view, let's unmaximize if it's maximized.
auto *splitter = qobject_cast<ViewSplitter*>(view->parentWidget());
if (splitter == nullptr) {
return;
}
auto *toplevelSplitter = splitter->getToplevelSplitter();
toplevelSplitter->handleMinimizeMaximize(false);
view->deleteLater();
connect(view, &QObject::destroyed, this, [this]() { toggleActionsBasedOnState(); });
// Only remove the controller from factory() if it's actually controlling
// the session from the sender.
// This fixes BUG: 348478 - messed up menus after a detached tab is closed
if ((!_pluggedController.isNull()) && (_pluggedController->session() == session)) {
// This is needed to remove this controller from factory() in
// order to prevent BUG: 185466 - disappearing menu popup
Q_EMIT unplugController(_pluggedController);
}
if (!_sessionMap.empty()) {
updateTerminalDisplayHistory(view, true);
focusAnotherTerminal(toplevelSplitter);
}
}
void ViewManager::focusAnotherTerminal(ViewSplitter *toplevelSplitter)
{
auto tabTterminalDisplays = toplevelSplitter->findChildren<TerminalDisplay*>();
if (tabTterminalDisplays.count() == 0) {
return;
}
if (tabTterminalDisplays.count() > 1) {
// Give focus to the last used terminal in this tab
for (auto *historyItem : _terminalDisplayHistory) {
for (auto *terminalDisplay : tabTterminalDisplays) {
if (terminalDisplay == historyItem) {
terminalDisplay->setFocus(Qt::OtherFocusReason);
return;
}
}
}
} else if (_terminalDisplayHistory.count() >= 1) {
// Give focus to the last used terminal tab
switchToTerminalDisplay(_terminalDisplayHistory[0]);
}
}
void ViewManager::activateView(TerminalDisplay *view)
{
if (view) {
// focus the activated view, this will cause the SessionController
// to notify the world that the view has been focused and the appropriate UI
// actions will be plugged in.
view->setFocus(Qt::OtherFocusReason);
}
}
void ViewManager::splitLeftRight()
{
splitView(Qt::Horizontal);
}
void ViewManager::splitTopBottom()
{
splitView(Qt::Vertical);
}
void ViewManager::splitView(Qt::Orientation orientation)
{
int currentSessionId = currentSession();
// At least one display/session exists if we are splitting
Q_ASSERT(currentSessionId >= 0);
Session *activeSession = SessionManager::instance()->idToSession(currentSessionId);
Q_ASSERT(activeSession);
auto profile = SessionManager::instance()->sessionProfile(activeSession);
const QString directory = profile->startInCurrentSessionDir()
? activeSession->currentWorkingDirectory()
: QString();
auto *session = createSession(profile, directory);
auto terminalDisplay = createView(session);
_viewContainer->splitView(terminalDisplay, orientation);
toggleActionsBasedOnState();
// focus the new container
terminalDisplay->setFocus();
}
void ViewManager::expandActiveContainer()
{
_viewContainer->activeViewSplitter()->adjustActiveTerminalDisplaySize(10);
}
void ViewManager::shrinkActiveContainer()
{
_viewContainer->activeViewSplitter()->adjustActiveTerminalDisplaySize(-10);
}
SessionController *ViewManager::createController(Session *session, TerminalDisplay *view)
{
// create a new controller for the session, and ensure that this view manager
// is notified when the view gains the focus
auto controller = new SessionController(session, view, this);
connect(controller, &Konsole::SessionController::viewFocused, this,
&Konsole::ViewManager::controllerChanged);
connect(session, &Konsole::Session::destroyed, controller,
&Konsole::SessionController::deleteLater);
connect(session, &Konsole::Session::primaryScreenInUse, controller,
&Konsole::SessionController::setupPrimaryScreenSpecificActions);
connect(session, &Konsole::Session::selectionChanged, controller,
&Konsole::SessionController::selectionChanged);
connect(view, &Konsole::TerminalDisplay::destroyed, controller,
&Konsole::SessionController::deleteLater);
// if this is the first controller created then set it as the active controller
if (_pluggedController.isNull()) {
controllerChanged(controller);
}
return controller;
}
// should this be handed by ViewManager::unplugController signal
void ViewManager::removeController(SessionController* controller)
{
if (_pluggedController == controller) {
_pluggedController.clear();
}
controller->deleteLater();
}
void ViewManager::controllerChanged(SessionController *controller)
{
if (controller == _pluggedController) {
return;
}
_viewContainer->setFocusProxy(controller->view());
updateTerminalDisplayHistory(controller->view());
_pluggedController = controller;
Q_EMIT activeViewChanged(controller);
}
SessionController *ViewManager::activeViewController() const
{
return _pluggedController;
}
void ViewManager::attachView(TerminalDisplay *terminal, Session *session)
{
connect(session, &Konsole::Session::finished, this, &Konsole::ViewManager::sessionFinished,
Qt::UniqueConnection);
// Disconnect from the other viewcontainer.
unregisterTerminal(terminal);
// reconnect on this container.
registerTerminal(terminal);
_sessionMap[terminal] = session;
createController(session, terminal);
toggleActionsBasedOnState();
_terminalDisplayHistory.append(terminal);
}
TerminalDisplay *ViewManager::createView(Session *session)
{
// notify this view manager when the session finishes so that its view
// can be deleted
//
// Use Qt::UniqueConnection to avoid duplicate connection
connect(session, &Konsole::Session::finished, this, &Konsole::ViewManager::sessionFinished,
Qt::UniqueConnection);
TerminalDisplay *display = createTerminalDisplay(session);
const Profile::Ptr profile = SessionManager::instance()->sessionProfile(session);
applyProfileToView(display, profile);
// set initial size
const QSize &preferredSize = session->preferredSize();
display->setSize(preferredSize.width(), preferredSize.height());
createController(session, display);
_sessionMap[display] = session;
session->addView(display);
_terminalDisplayHistory.append(display);
// tell the session whether it has a light or dark background
session->setDarkBackground(colorSchemeForProfile(profile)->hasDarkBackground());
display->setFocus(Qt::OtherFocusReason);
// updateDetachViewState();
return display;
}
TabbedViewContainer *ViewManager::createContainer()
{
auto *container = new TabbedViewContainer(this, nullptr);
container->setNavigationVisibility(_navigationVisibility);
connect(container, &TabbedViewContainer::detachTab, this, &ViewManager::detachTab);
// connect signals and slots
connect(container, &Konsole::TabbedViewContainer::viewAdded, this,
[this, container]() {
containerViewsChanged(container);
});
connect(container, &Konsole::TabbedViewContainer::viewRemoved, this,
[this, container]() {
containerViewsChanged(container);
});
connect(container, &TabbedViewContainer::newViewRequest,
this, &ViewManager::newViewRequest);
connect(container, &Konsole::TabbedViewContainer::newViewWithProfileRequest,
this, &Konsole::ViewManager::newViewWithProfileRequest);
connect(container, &Konsole::TabbedViewContainer::activeViewChanged, this,
&Konsole::ViewManager::activateView);
return container;
}
void ViewManager::setNavigationMethod(NavigationMethod method)
{
Q_ASSERT(_actionCollection);
if (_actionCollection == nullptr) {
return;
}
KActionCollection *collection = _actionCollection;
_navigationMethod = method;
// FIXME: The following disables certain actions for the KPart that it
// doesn't actually have a use for, to avoid polluting the action/shortcut
// namespace of an application using the KPart (otherwise, a shortcut may
// be in use twice, and the user gets to see an "ambiguous shortcut over-
// load" error dialog). However, this approach sucks - it's the inverse of
// what it should be. Rather than disabling actions not used by the KPart,
// a method should be devised to only enable those that are used, perhaps
// by using a separate action collection.
const bool enable = (method != NoNavigation);
auto enableAction = [&enable, &collection](const QString& actionName) {
auto *action = collection->action(actionName);
if (action != nullptr) {
action->setEnabled(enable);
}
};
enableAction(QStringLiteral("next-view"));
enableAction(QStringLiteral("previous-view"));
enableAction(QStringLiteral("last-tab"));
enableAction(QStringLiteral("last-used-tab"));
enableAction(QStringLiteral("last-used-tab-reverse"));
enableAction(QStringLiteral("split-view-left-right"));
enableAction(QStringLiteral("split-view-top-bottom"));
enableAction(QStringLiteral("rename-session"));
enableAction(QStringLiteral("move-view-left"));
enableAction(QStringLiteral("move-view-right"));
}
ViewManager::NavigationMethod ViewManager::navigationMethod() const
{
return _navigationMethod;
}
void ViewManager::containerViewsChanged(TabbedViewContainer *container)
{
Q_UNUSED(container)
// TODO: Verify that this is right.
Q_EMIT viewPropertiesChanged(viewProperties());
}
void ViewManager::viewDestroyed(QWidget *view)
{
// Note: the received QWidget has already been destroyed, so
// using dynamic_cast<> or qobject_cast<> does not work here
// We only need the pointer address to look it up below
auto *display = reinterpret_cast<TerminalDisplay *>(view);
// 1. detach view from session
// 2. if the session has no views left, close it
Session *session = _sessionMap[ display ];
_sessionMap.remove(display);
if (session != nullptr) {
if (session->views().count() == 0) {
session->close();
}
}
//we only update the focus if the splitter is still alive
toggleActionsBasedOnState();
// The below causes the menus to be messed up
// Only happens when using the tab bar close button
// if (_pluggedController)
// Q_EMIT unplugController(_pluggedController);
}
TerminalDisplay *ViewManager::createTerminalDisplay(Session *session)
{
auto display = new TerminalDisplay(nullptr);
display->setRandomSeed(session->sessionId() | (qApp->applicationPid() << 10));
registerTerminal(display);
return display;
}
const ColorScheme *ViewManager::colorSchemeForProfile(const Profile::Ptr &profile)
{
const ColorScheme *colorScheme = ColorSchemeManager::instance()->
findColorScheme(profile->colorScheme());
if (colorScheme == nullptr) {
colorScheme = ColorSchemeManager::instance()->defaultColorScheme();
}
Q_ASSERT(colorScheme);
return colorScheme;
}
bool ViewManager::profileHasBlurEnabled(const Profile::Ptr &profile)
{
return colorSchemeForProfile(profile)->blur();
}
void ViewManager::applyProfileToView(TerminalDisplay *view, const Profile::Ptr &profile)
{
Q_ASSERT(profile);
view->applyProfile(profile);
Q_EMIT updateWindowIcon();
Q_EMIT blurSettingChanged(view->colorScheme()->blur());
}
void ViewManager::updateViewsForSession(Session *session)
{
const Profile::Ptr profile = SessionManager::instance()->sessionProfile(session);
const QList<TerminalDisplay *> sessionMapKeys = _sessionMap.keys(session);
for (TerminalDisplay *view : sessionMapKeys) {
applyProfileToView(view, profile);
}
}
void ViewManager::profileChanged(const Profile::Ptr &profile)
{
// update all views associated with this profile
QHashIterator<TerminalDisplay *, Session *> iter(_sessionMap);
while (iter.hasNext()) {
iter.next();
// if session uses this profile, update the display
if (iter.key() != nullptr
&& iter.value() != nullptr
&& SessionManager::instance()->sessionProfile(iter.value()) == profile) {
applyProfileToView(iter.key(), profile);
}
}
}
QList<ViewProperties *> ViewManager::viewProperties() const
{
QList<ViewProperties *> list;
TabbedViewContainer *container = _viewContainer;
if (container == nullptr) {
return {};
}
auto terminalContainers = _viewContainer->findChildren<TerminalDisplay*>();
list.reserve(terminalContainers.size());
for(auto terminalDisplay : _viewContainer->findChildren<TerminalDisplay*>()) {
list.append(terminalDisplay->sessionController());
}
return list;
}
namespace {
QJsonObject saveSessionTerminal(TerminalDisplay *terminalDisplay)
{
QJsonObject thisTerminal;
auto terminalSession = terminalDisplay->sessionController()->session();
const int sessionRestoreId = SessionManager::instance()->getRestoreId(terminalSession);
thisTerminal.insert(QStringLiteral("SessionRestoreId"), sessionRestoreId);
return thisTerminal;
}
QJsonObject saveSessionsRecurse(QSplitter *splitter) {
QJsonObject thisSplitter;
thisSplitter.insert(
QStringLiteral("Orientation"),
splitter->orientation() == Qt::Horizontal ? QStringLiteral("Horizontal")
: QStringLiteral("Vertical")
);
QJsonArray internalWidgets;
for (int i = 0; i < splitter->count(); i++) {
auto *widget = splitter->widget(i);
auto *maybeSplitter = qobject_cast<QSplitter*>(widget);
auto *maybeTerminalDisplay = qobject_cast<TerminalDisplay*>(widget);
if (maybeSplitter != nullptr) {
internalWidgets.append(saveSessionsRecurse(maybeSplitter));
} else if (maybeTerminalDisplay != nullptr) {
internalWidgets.append(saveSessionTerminal(maybeTerminalDisplay));
}
}
thisSplitter.insert(QStringLiteral("Widgets"), internalWidgets);
return thisSplitter;
}
} // namespace
void ViewManager::saveLayoutFile() {
QFile file(QFileDialog::getSaveFileName(this->widget(), i18n("Save File"), QStringLiteral("~/"),
i18n("Konsole View Layout (*.json)")));
if (!file.open(QIODevice::WriteOnly | QIODevice::Text)) {
KMessageBox::sorry(this->widget(), i18n("A problem occurred when saving the Layout.\n%1", file.fileName()));
}
QJsonObject jsonSplit = saveSessionsRecurse(_viewContainer->activeViewSplitter());
if (!jsonSplit.isEmpty()){
file.write(QJsonDocument(jsonSplit).toJson());
qDebug() << "Maybe was saved";
}
}
void ViewManager::saveSessions(KConfigGroup &group)
{
QJsonArray rootArray;
for(int i = 0; i < _viewContainer->count(); i++) {
auto *splitter = qobject_cast<QSplitter*>(_viewContainer->widget(i));
rootArray.append(saveSessionsRecurse(splitter));
}
group.writeEntry("Tabs", QJsonDocument(rootArray).toJson(QJsonDocument::Compact));
group.writeEntry("Active", _viewContainer->currentIndex());
}
namespace {
ViewSplitter *restoreSessionsSplitterRecurse(const QJsonObject& jsonSplitter, ViewManager *manager, bool useSessionId)
{
const QJsonArray splitterWidgets = jsonSplitter[QStringLiteral("Widgets")].toArray();
auto orientation = (jsonSplitter[QStringLiteral("Orientation")].toString() == QStringLiteral("Horizontal"))
? Qt::Horizontal : Qt::Vertical;
auto *currentSplitter = new ViewSplitter();
currentSplitter->setOrientation(orientation);
for (const auto widgetJsonValue : splitterWidgets) {
const auto widgetJsonObject = widgetJsonValue.toObject();
const auto sessionIterator = widgetJsonObject.constFind(QStringLiteral("SessionRestoreId"));
if (sessionIterator != widgetJsonObject.constEnd()) {
Session *session = useSessionId
? SessionManager::instance()->idToSession(sessionIterator->toInt())
: SessionManager::instance()->createSession();
auto newView = manager->createView(session);
currentSplitter->addWidget(newView);
} else {
auto nextSplitter = restoreSessionsSplitterRecurse(widgetJsonObject, manager, useSessionId);
currentSplitter->addWidget(nextSplitter);
}
}
return currentSplitter;
}
} // namespace
void ViewManager::loadLayout(QString file) {
QFile jsonFile(file);
if (!jsonFile.open(QIODevice::ReadOnly | QIODevice::Text)) {
KMessageBox::sorry(this->widget(), i18n("A problem occurred when loading the Layout.\n%1", jsonFile.fileName()));
}
auto json = QJsonDocument::fromJson(jsonFile.readAll());
if (!json.isEmpty()){
auto splitter = restoreSessionsSplitterRecurse(json.object(), this, false);
_viewContainer->addSplitter(splitter, _viewContainer->count());
}
}
void ViewManager::loadLayoutFile() {
loadLayout(QFileDialog::getOpenFileName(this->widget(), i18n("Open File"), QStringLiteral("~/"),
i18n("Konsole View Layout (*.json)")));
}
void ViewManager::restoreSessions(const KConfigGroup &group)
{
const auto tabList = group.readEntry("Tabs", QByteArray("[]"));
const auto jsonTabs = QJsonDocument::fromJson(tabList).array();
for (const auto& jsonSplitter : jsonTabs) {
auto topLevelSplitter = restoreSessionsSplitterRecurse(jsonSplitter.toObject(), this, true);
_viewContainer->addSplitter(topLevelSplitter, _viewContainer->count());
}
if (!jsonTabs.isEmpty())
return;
// Session file is unusable, try older format
QList<int> ids = group.readEntry("Sessions", QList<int>());
int activeTab = group.readEntry("Active", 0);
TerminalDisplay *display = nullptr;
int tab = 1;
for (auto it = ids.cbegin(); it != ids.cend(); ++it) {
const int &id = *it;
Session *session = SessionManager::instance()->idToSession(id);
if (session == nullptr) {
qWarning() << "Unable to load session with id" << id;
// Force a creation of a default session below
ids.clear();
break;
}
activeContainer()->addView(createView(session));
if (!session->isRunning()) {
session->run();
}
if (tab++ == activeTab) {
display = qobject_cast<TerminalDisplay *>(activeView());
}
}
if (display != nullptr) {
activeContainer()->setCurrentWidget(display);
display->setFocus(Qt::OtherFocusReason);
}
if (ids.isEmpty()) { // Session file is unusable, start default Profile
Profile::Ptr profile = ProfileManager::instance()->defaultProfile();
Session *session = SessionManager::instance()->createSession(profile);
activeContainer()->addView(createView(session));
if (!session->isRunning()) {
session->run();
}
}
}
TabbedViewContainer *ViewManager::activeContainer()
{
return _viewContainer;
}
int ViewManager::sessionCount()
{
return _sessionMap.size();
}
QStringList ViewManager::sessionList()
{
QStringList ids;
for (int i = 0; i < _viewContainer->count(); i++) {
auto terminaldisplayList = _viewContainer->widget(i)->findChildren<TerminalDisplay *>();
for (auto *terminaldisplay : terminaldisplayList) {
ids.append(QString::number(terminaldisplay->sessionController()->session()->sessionId()));
}
}
return ids;
}
int ViewManager::currentSession()
{
if (_pluggedController != nullptr) {
Q_ASSERT(_pluggedController->session() != nullptr);
return _pluggedController->session()->sessionId();
}
return -1;
}
void ViewManager::setCurrentSession(int sessionId)
{
auto *session = SessionManager::instance()->idToSession(sessionId);
if (session == nullptr || session->views().count() == 0) {
return;
}
auto *display = session->views().at(0);
if (display != nullptr) {
display->setFocus(Qt::OtherFocusReason);
auto *splitter = qobject_cast<ViewSplitter *>(display->parent());
if (splitter != nullptr) {
_viewContainer->setCurrentWidget(splitter->getToplevelSplitter());
}
}
}
int ViewManager::newSession()
{
return newSession(QString(), QString());
}
int ViewManager::newSession(const QString &profile)
{
return newSession(profile, QString());
}
int ViewManager::newSession(const QString &profile, const QString &directory)
{
Profile::Ptr profileptr = ProfileManager::instance()->defaultProfile();
if(!profile.isEmpty()) {
const QList<Profile::Ptr> profilelist = ProfileManager::instance()->allProfiles();
for (const auto &i : profilelist) {
if (i->name() == profile) {
profileptr = i;
break;
}
}
}
Session *session = createSession(profileptr, directory);
auto newView = createView(session);
activeContainer()->addView(newView);
session->run();
return session->sessionId();
}
QString ViewManager::defaultProfile()
{
return ProfileManager::instance()->defaultProfile()->name();
}
void ViewManager::setDefaultProfile(const QString &profileName)
{
const QList<Profile::Ptr> profiles = ProfileManager::instance()->allProfiles();
for (const Profile::Ptr &profile : profiles) {
if (profile->name() == profileName) {
ProfileManager::instance()->setDefaultProfile(profile);
}
}
}
QStringList ViewManager::profileList()
{
return ProfileManager::instance()->availableProfileNames();
}
void ViewManager::nextSession()
{
nextView();
}
void ViewManager::prevSession()
{
previousView();
}
void ViewManager::moveSessionLeft()
{
moveActiveViewLeft();
}
void ViewManager::moveSessionRight()
{
moveActiveViewRight();
}
void ViewManager::setTabWidthToText(bool setTabWidthToText)
{
_viewContainer->tabBar()->setExpanding(!setTabWidthToText);
_viewContainer->tabBar()->update();
}
void ViewManager::setNavigationVisibility(NavigationVisibility navigationVisibility) {
if (_navigationVisibility != navigationVisibility) {
_navigationVisibility = navigationVisibility;
_viewContainer->setNavigationVisibility(navigationVisibility);
}
}
void ViewManager::updateTerminalDisplayHistory(TerminalDisplay* terminalDisplay, bool remove)
{
if (terminalDisplay == nullptr) {
if (_terminalDisplayHistoryIndex >= 0) {
// This is the case when we finished walking through the history
// (i.e. when Ctrl-Tab has been released)
terminalDisplay = _terminalDisplayHistory[_terminalDisplayHistoryIndex];
_terminalDisplayHistoryIndex = -1;
} else {
return;
}
}
if (_terminalDisplayHistoryIndex >= 0 && !remove) {
// Do not reorder the tab history while we are walking through it
return;
}
for (int i = 0; i < _terminalDisplayHistory.count(); i++) {
if (_terminalDisplayHistory[i] == terminalDisplay) {
_terminalDisplayHistory.removeAt(i);
if (!remove) {
_terminalDisplayHistory.prepend(terminalDisplay);
}
break;
}
}
}
void ViewManager::registerTerminal(TerminalDisplay *terminal)
{
connect(terminal, &TerminalDisplay::requestToggleExpansion,
_viewContainer, &TabbedViewContainer::toggleMaximizeCurrentTerminal, Qt::UniqueConnection);
connect(terminal, &TerminalDisplay::requestMoveToNewTab,
_viewContainer, &TabbedViewContainer::moveToNewTab, Qt::UniqueConnection);
}
void ViewManager::unregisterTerminal(TerminalDisplay *terminal)
{
disconnect(terminal, &TerminalDisplay::requestToggleExpansion, nullptr, nullptr);
disconnect(terminal, &TerminalDisplay::requestMoveToNewTab, nullptr, nullptr);
}