Files
konsole/src/ViewManager.cpp

716 lines
25 KiB
C++

/*
Copyright (C) 2006-2007 by Robert Knight <robertknight@gmail.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.
*/
// Own
#include "ViewManager.h"
// System
#include <assert.h>
// Qt
#include <QtCore/QDateTime>
#include <QtCore/QSignalMapper>
// KDE
#include <kdebug.h>
#include <KLocale>
#include <KToggleAction>
#include <KXMLGUIFactory>
// Konsole
#include "BookmarkHandler.h"
#include "ColorScheme.h"
#include "Session.h"
#include "TerminalDisplay.h"
#include "SessionController.h"
#include "SessionManager.h"
#include "ViewContainer.h"
#include "ViewSplitter.h"
using namespace Konsole;
ViewManager::ViewManager(QObject* parent , KActionCollection* collection)
: QObject(parent)
, _viewSplitter(0)
, _actionCollection(collection)
, _containerSignalMapper(new QSignalMapper(this))
{
// create main view area
_viewSplitter = new ViewSplitter(0);
// the ViewSplitter class supports both recursive and non-recursive splitting,
// in non-recursive mode, all containers are inserted into the same top-level splitter
// widget, and all the divider lines between the containers have the same orientation
//
// the ViewManager class is not currently able to handle a ViewSplitter in recursive-splitting
// mode
_viewSplitter->setRecursiveSplitting(false);
// setup actions which relating to the view
setupActions();
// emit a signal when all of the views held by this view manager are destroyed
connect( _viewSplitter , SIGNAL(allContainersEmpty()) , this , SIGNAL(empty()) );
connect( _viewSplitter , SIGNAL(empty(ViewSplitter*)) , this , SIGNAL(empty()) );
// listen for addition or removal of views from associated containers
connect( _containerSignalMapper , SIGNAL(mapped(QObject*)) , this ,
SLOT(containerViewsChanged(QObject*)) );
// listen for profile changes
connect( SessionManager::instance() , SIGNAL(profileChanged(const QString&)) , this,
SLOT(profileChanged(const QString&)) );
connect( SessionManager::instance() , SIGNAL(sessionUpdated(Session*)) , this,
SLOT(updateViewsForSession(Session*)) );
}
ViewManager::~ViewManager()
{
}
QWidget* ViewManager::activeView() const
{
ViewContainer* container = _viewSplitter->activeContainer();
if ( container )
{
return container->activeView();
}
else
{
return 0;
}
}
QWidget* ViewManager::widget() const
{
return _viewSplitter;
}
void ViewManager::setupActions()
{
KActionCollection* collection = _actionCollection;
KAction* nextViewAction = new KAction( i18n("Next View") , this );
KAction* previousViewAction = new KAction( i18n("Previous View") , this );
QAction* nextContainerAction = new QAction( i18n("Next View Container") , this);
QAction* moveViewLeftAction = new QAction( i18n("Move View Left") , this );
QAction* moveViewRightAction = new QAction( i18n("Move View Right") , this );
// list of actions that should only be enabled when there are multiple view
// containers open
QList<QAction*> multiViewOnlyActions;
multiViewOnlyActions << nextContainerAction;
if ( collection )
{
KAction* splitLeftRightAction = new KAction( KIcon("view-left-right"),
i18n("Split View Left/Right"),
this );
splitLeftRightAction->setShortcut( QKeySequence(Qt::CTRL+Qt::SHIFT+Qt::Key_L) );
collection->addAction("split-view-left-right",splitLeftRightAction);
connect( splitLeftRightAction , SIGNAL(triggered()) , this , SLOT(splitLeftRight()) );
KAction* splitTopBottomAction = new KAction( KIcon("view-top-bottom") ,
i18n("Split View Top/Bottom"),this);
splitTopBottomAction->setShortcut( QKeySequence(Qt::CTRL+Qt::SHIFT+Qt::Key_T) );
collection->addAction("split-view-top-bottom",splitTopBottomAction);
connect( splitTopBottomAction , SIGNAL(triggered()) , this , SLOT(splitTopBottom()));
KAction* closeActiveAction = new KAction( i18n("Close Active") , this );
closeActiveAction->setIcon(KIcon("view-remove"));
closeActiveAction->setShortcut( QKeySequence(Qt::CTRL+Qt::SHIFT+Qt::Key_S) );
closeActiveAction->setEnabled(false);
collection->addAction("close-active-view",closeActiveAction);
connect( closeActiveAction , SIGNAL(triggered()) , this , SLOT(closeActiveView()) );
multiViewOnlyActions << closeActiveAction;
KAction* closeOtherAction = new KAction( i18n("Close Others") , this );
closeOtherAction->setShortcut( QKeySequence(Qt::CTRL+Qt::SHIFT+Qt::Key_O) );
closeOtherAction->setEnabled(false);
collection->addAction("close-other-views",closeOtherAction);
connect( closeOtherAction , SIGNAL(triggered()) , this , SLOT(closeOtherViews()) );
multiViewOnlyActions << closeOtherAction;
QAction* detachViewAction = collection->addAction("detach-view");
detachViewAction->setIcon( KIcon("tab-breakoff") );
detachViewAction->setText( i18n("&Detach View") );
// 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
detachViewAction->setShortcut( QKeySequence(Qt::CTRL+Qt::SHIFT+Qt::Key_H) );
multiViewOnlyActions << detachViewAction;
connect( detachViewAction , SIGNAL(triggered()) , this , SLOT(detachActiveView()) );
// Expand & Shrink Active View
KAction* expandActiveAction = new KAction( i18n("Expand View") , this );
expandActiveAction->setShortcut( QKeySequence(Qt::CTRL+Qt::SHIFT+Qt::Key_BracketRight) );
collection->addAction("expand-active-view",expandActiveAction);
connect( expandActiveAction , SIGNAL(triggered()) , this , SLOT(expandActiveView()) );
multiViewOnlyActions << expandActiveAction;
KAction* shrinkActiveAction = new KAction( i18n("Shrink View") , this );
shrinkActiveAction->setShortcut( QKeySequence(Qt::CTRL+Qt::SHIFT+Qt::Key_BracketLeft) );
collection->addAction("shrink-active-view",shrinkActiveAction);
connect( shrinkActiveAction , SIGNAL(triggered()) , this , SLOT(shrinkActiveView()) );
multiViewOnlyActions << shrinkActiveAction;
// Next / Previous View , Next Container
collection->addAction("next-view",nextViewAction);
collection->addAction("previous-view",previousViewAction);
collection->addAction("next-container",nextContainerAction);
collection->addAction("move-view-left",moveViewLeftAction);
collection->addAction("move-view-right",moveViewRightAction);
}
QListIterator<QAction*> iter(multiViewOnlyActions);
while ( iter.hasNext() )
{
connect( this , SIGNAL(splitViewToggle(bool)) , iter.next() , SLOT(setEnabled(bool)) );
}
// keyboard shortcut only actions
KShortcut nextViewShortcut = nextViewAction->shortcut();
nextViewShortcut.setPrimary( QKeySequence(Qt::SHIFT+Qt::Key_Right) );
nextViewShortcut.setAlternate( QKeySequence(Qt::CTRL+Qt::Key_PageUp) );
nextViewAction->setShortcut(nextViewShortcut);
connect( nextViewAction, SIGNAL(triggered()) , this , SLOT(nextView()) );
_viewSplitter->addAction(nextViewAction);
KShortcut previousViewShortcut = previousViewAction->shortcut();
previousViewShortcut.setPrimary( QKeySequence(Qt::SHIFT+Qt::Key_Left) );
previousViewShortcut.setAlternate( QKeySequence(Qt::CTRL+Qt::Key_PageDown) );
previousViewAction->setShortcut(previousViewShortcut);
connect( previousViewAction, SIGNAL(triggered()) , this , SLOT(previousView()) );
_viewSplitter->addAction(previousViewAction);
nextContainerAction->setShortcut( QKeySequence(Qt::SHIFT+Qt::Key_Tab) );
connect( nextContainerAction , SIGNAL(triggered()) , this , SLOT(nextContainer()) );
_viewSplitter->addAction(nextContainerAction);
moveViewLeftAction->setShortcut( QKeySequence(Qt::CTRL+Qt::SHIFT+Qt::Key_Left) );
connect( moveViewLeftAction , SIGNAL(triggered()) , this , SLOT(moveActiveViewLeft()) );
_viewSplitter->addAction(moveViewLeftAction);
moveViewRightAction->setShortcut( QKeySequence(Qt::CTRL+Qt::SHIFT+Qt::Key_Right) );
connect( moveViewRightAction , SIGNAL(triggered()) , this , SLOT(moveActiveViewRight()) );
_viewSplitter->addAction(moveViewRightAction);
}
void ViewManager::moveActiveViewLeft()
{
qDebug() << "Moving active view to the left";
ViewContainer* container = _viewSplitter->activeContainer();
Q_ASSERT( container );
container->moveActiveView( ViewContainer::MoveViewLeft );
}
void ViewManager::moveActiveViewRight()
{
qDebug() << "Moving active view to the right";
ViewContainer* container = _viewSplitter->activeContainer();
Q_ASSERT( container );
container->moveActiveView( ViewContainer::MoveViewRight );
}
void ViewManager::nextContainer()
{
_viewSplitter->activateNextContainer();
}
void ViewManager::nextView()
{
ViewContainer* container = _viewSplitter->activeContainer();
Q_ASSERT( container );
container->activateNextView();
}
void ViewManager::previousView()
{
ViewContainer* container = _viewSplitter->activeContainer();
Q_ASSERT( container );
container->activatePreviousView();
}
void ViewManager::detachActiveView()
{
// find the currently active view and remove it from its container
ViewContainer* container = _viewSplitter->activeContainer();
TerminalDisplay* activeView = dynamic_cast<TerminalDisplay*>(container->activeView());
if (!activeView)
return;
emit viewDetached(_sessionMap[activeView]);
_sessionMap.remove(activeView);
// remove the view from this window
container->removeView(activeView);
activeView->deleteLater();
// if the container from which the view was removed is now empty then it can be deleted,
// unless it is the only container in the window, in which case it is left empty
// so that there is always an active container
if ( _viewSplitter->containers().count() > 1 &&
container->views().count() == 0 )
{
removeContainer(container);
}
}
void ViewManager::sessionFinished()
{
Session* session = qobject_cast<Session*>(sender());
if ( _sessionMap[qobject_cast<TerminalDisplay*>(activeView())] == session )
{
// switch to the previous view before deleting the session views to prevent flicker
// occurring as a result of an interval between removing the active view and switching
// to the previous view
previousView();
}
Q_ASSERT(session);
QList<TerminalDisplay*> children = _viewSplitter->findChildren<TerminalDisplay*>();
foreach ( TerminalDisplay* view , children )
{
if ( _sessionMap[view] == session )
{
_sessionMap.remove(view);
view->deleteLater();
}
}
}
void ViewManager::focusActiveView()
{
// give the active view in a container the focus. this ensures
// that controller associated with that view is activated and the session-specific
// menu items are replaced with the ones for the newly focused view
// see the viewFocused() method
ViewContainer* container = _viewSplitter->activeContainer();
if ( container )
{
QWidget* activeView = container->activeView();
if ( activeView )
{
activeView->setFocus(Qt::MouseFocusReason);
}
}
}
void ViewManager::viewActivated( QWidget* view )
{
Q_ASSERT( view != 0 );
// 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)
{
// iterate over each session which has a view in the current active
// container and create a new view for that session in a new container
QListIterator<QWidget*> existingViewIter(_viewSplitter->activeContainer()->views());
ViewContainer* container = 0;
while (existingViewIter.hasNext())
{
Session* session = _sessionMap[(TerminalDisplay*)existingViewIter.next()];
TerminalDisplay* display = createTerminalDisplay(session);
applyProfile(display,session->profileKey());
ViewProperties* properties = createController(session,display);
_sessionMap[display] = session;
// create a container using settings from the first
// session in the previous container
if ( !container )
container = createContainer(session->profileKey());
container->addView(display,properties);
session->addView( display );
}
_viewSplitter->addContainer(container,orientation);
emit splitViewToggle(_viewSplitter->containers().count() > 0);
// focus the new container
container->containerWidget()->setFocus();
// ensure that the active view is focused after the split / unsplit
ViewContainer* activeContainer = _viewSplitter->activeContainer();
QWidget* activeView = activeContainer ? activeContainer->activeView() : 0;
if ( activeView )
activeView->setFocus(Qt::OtherFocusReason);
}
void ViewManager::removeContainer(ViewContainer* container)
{
// note that the _viewSplitter->containers().count() will not be updated
// until the container is deleted when Qt returns to the main event loop,
// so we take the previous container count and work out what the new count
// would be.
int previousCount = _viewSplitter->containers().count();
container->deleteLater();
emit splitViewToggle( (previousCount-1) > 1);
}
void ViewManager::expandActiveView()
{
_viewSplitter->adjustContainerSize(_viewSplitter->activeContainer(),10);
}
void ViewManager::shrinkActiveView()
{
_viewSplitter->adjustContainerSize(_viewSplitter->activeContainer(),-10);
}
void ViewManager::closeActiveView()
{
// only do something if there is more than one container active
if ( _viewSplitter->containers().count() > 1 )
{
ViewContainer* container = _viewSplitter->activeContainer();
removeContainer(container);
// focus next container so that user can continue typing
// without having to manually focus it themselves
nextContainer();
}
}
void ViewManager::closeOtherViews()
{
ViewContainer* active = _viewSplitter->activeContainer();
QListIterator<ViewContainer*> iter(_viewSplitter->containers());
while ( iter.hasNext() )
{
ViewContainer* next = iter.next();
if ( next != active )
delete next;
}
}
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
SessionController* controller = new SessionController(session,view,this);
connect( controller , SIGNAL(focused(SessionController*)) , this , SIGNAL(activeViewChanged(SessionController*)) );
connect( session , SIGNAL(destroyed()) , controller , SLOT(deleteLater()) );
connect( view , SIGNAL(destroyed()) , controller , SLOT(deleteLater()) );
connect( controller , SIGNAL(sendInputToAll(bool)) , this , SLOT(sendInputToAll()) );
return controller;
}
void ViewManager::createView(Session* session)
{
// create the default container
if (_viewSplitter->containers().count() == 0)
{
_viewSplitter->addContainer( createContainer(session->profileKey()) ,
Qt::Vertical );
emit splitViewToggle(false);
}
// notify this view manager when the session finishes so that its view
// can be deleted
connect( session , SIGNAL(finished()) , this , SLOT(sessionFinished()) );
// iterate over the view containers owned by this view manager
// and create a new terminal display for the session in each of them, along with
// a controller for the session/display pair
ViewContainer* const activeContainer = _viewSplitter->activeContainer();
QListIterator<ViewContainer*> containerIter(_viewSplitter->containers());
while ( containerIter.hasNext() )
{
ViewContainer* container = containerIter.next();
TerminalDisplay* display = createTerminalDisplay(session);
applyProfile(display,session->profileKey());
// set initial size
// temporary default used for now
display->setSize(80,40);
ViewProperties* properties = createController(session,display);
_sessionMap[display] = session;
container->addView(display,properties);
session->addView(display);
// tell the session whether it has a light or dark background
session->setDarkBackground( colorSchemeForProfile(session->profileKey())->hasDarkBackground() );
if ( container == activeContainer )
{
container->setActiveView(display);
display->setFocus( Qt::OtherFocusReason );
}
}
}
ViewContainer* ViewManager::createContainer(const QString& profileKey)
{
const Profile* info = SessionManager::instance()->profile(profileKey);
Q_ASSERT( info );
const int tabPosition = info->property(Profile::TabBarPosition).value<int>();
ViewContainer::NavigationPosition position = ( tabPosition == Profile::TabBarTop ) ?
ViewContainer::NavigationPositionTop :
ViewContainer::NavigationPositionBottom;
ViewContainer* container = new TabbedViewContainerV2(position,_viewSplitter);
// connect signals and slots
connect( container , SIGNAL(viewAdded(QWidget*,ViewProperties*)) , _containerSignalMapper ,
SLOT(map()) );
connect( container , SIGNAL(viewRemoved(QWidget*)) , _containerSignalMapper ,
SLOT(map()) );
_containerSignalMapper->setMapping(container,container);
connect( container , SIGNAL(viewRemoved(QWidget*)) , this , SLOT(viewCloseRequest(QWidget*)) );
connect( container , SIGNAL(closeRequest(QWidget*)) , this , SLOT(viewCloseRequest(QWidget*)) );
connect( container , SIGNAL(activeViewChanged(QWidget*)) , this , SLOT(viewActivated(QWidget*)));
return container;
}
void ViewManager::containerViewsChanged(QObject* container)
{
//qDebug() << "Container views changed";
if ( container == _viewSplitter->activeContainer() )
{
emit viewPropertiesChanged( viewProperties() );
}
}
void ViewManager::viewCloseRequest(QWidget* view)
{
// 1. detach view from session
// 2. if the session has no views left, close it
qDebug() << "Removing view.";
TerminalDisplay* display = (TerminalDisplay*)view;
Session* session = _sessionMap[ display ];
if ( session )
{
display->deleteLater();
_sessionMap.remove(display);
if ( session->views().count() == 0 )
session->close();
}
focusActiveView();
}
TerminalDisplay* ViewManager::createTerminalDisplay(Session* session)
{
TerminalDisplay* display = new TerminalDisplay(0);
//TODO Temporary settings used here
display->setBellMode(0);
display->setTerminalSizeHint(false);
display->setCutToBeginningOfLine(true);
display->setTerminalSizeStartup(false);
display->setScrollBarPosition(TerminalDisplay::ScrollBarRight);
display->setRandomSeed(session->sessionId() * 31);
return display;
}
const ColorScheme* ViewManager::colorSchemeForProfile(const QString& profileKey) const
{
Profile* info = SessionManager::instance()->profile(profileKey);
const ColorScheme* colorScheme = ColorSchemeManager::instance()->
findColorScheme(info->colorScheme());
if ( !colorScheme )
colorScheme = ColorSchemeManager::instance()->defaultColorScheme();
Q_ASSERT( colorScheme );
return colorScheme;
}
void ViewManager::applyProfile(TerminalDisplay* view , const QString& profileKey)
{
Profile* info = SessionManager::instance()->profile(profileKey);
Q_ASSERT( info );
const ColorScheme* colorScheme = colorSchemeForProfile(profileKey);
// menu bar visibility
emit setMenuBarVisible( info->property(Profile::ShowMenuBar).value<bool>() );
// tab bar visibility
ViewContainer* container = _viewSplitter->activeContainer();
int tabBarMode = info->property(Profile::TabBarMode).value<int>();
int tabBarPosition = info->property(Profile::TabBarPosition).value<int>();
if ( tabBarMode == Profile::AlwaysHideTabBar )
container->setNavigationDisplayMode(ViewContainer::AlwaysHideNavigation);
else if ( tabBarMode == Profile::AlwaysShowTabBar )
container->setNavigationDisplayMode(ViewContainer::AlwaysShowNavigation);
else if ( tabBarMode == Profile::ShowTabBarAsNeeded )
container->setNavigationDisplayMode(ViewContainer::ShowNavigationAsNeeded);
if ( tabBarPosition == Profile::TabBarTop )
container->setNavigationPosition(ViewContainer::NavigationPositionTop);
else if ( tabBarPosition == Profile::TabBarBottom )
container->setNavigationPosition(ViewContainer::NavigationPositionBottom);
// load colour scheme
ColorEntry table[TABLE_COLORS];
colorScheme->getColorTable(table , view->randomSeed() );
view->setColorTable(table);
view->setOpacity(colorScheme->opacity());
// load font
view->setVTFont(info->font());
// set scroll-bar position
int scrollBarPosition = info->property(Profile::ScrollBarPosition).value<int>();
if ( scrollBarPosition == Profile::ScrollBarHidden )
view->setScrollBarPosition(TerminalDisplay::NoScrollBar);
else if ( scrollBarPosition == Profile::ScrollBarLeft )
view->setScrollBarPosition(TerminalDisplay::ScrollBarLeft);
else if ( scrollBarPosition == Profile::ScrollBarRight )
view->setScrollBarPosition(TerminalDisplay::ScrollBarRight);
// terminal features
bool blinkingCursor = info->property(Profile::BlinkingCursorEnabled).value<bool>();
view->setBlinkingCursor(blinkingCursor);
// cursor shape
int cursorShape = info->property(Profile::CursorShape).value<int>();
if ( cursorShape == Profile::BlockCursor )
view->setKeyboardCursorShape(TerminalDisplay::BlockCursor);
else if ( cursorShape == Profile::IBeamCursor )
view->setKeyboardCursorShape(TerminalDisplay::IBeamCursor);
else if ( cursorShape == Profile::UnderlineCursor )
view->setKeyboardCursorShape(TerminalDisplay::UnderlineCursor);
// cursor color
bool useCustomColor = info->property(Profile::UseCustomCursorColor).value<bool>();
const QColor& cursorColor = info->property(Profile::CustomCursorColor).value<QColor>();
view->setKeyboardCursorColor(!useCustomColor,cursorColor);
// word characters
view->setWordCharacters( info->property(Profile::WordCharacters).value<QString>() );
}
void ViewManager::updateViewsForSession(Session* session)
{
QListIterator<QPointer<TerminalDisplay> > iter(_sessionMap.keys(session));
while ( iter.hasNext() )
{
applyProfile(iter.next(),session->profileKey());
}
}
void ViewManager::profileChanged(const QString& key)
{
QHashIterator<QPointer<TerminalDisplay>,QPointer<Session> > iter(_sessionMap);
while ( iter.hasNext() )
{
iter.next();
// if session uses this profile, update the display
if ( iter.key() != 0 && iter.value() != 0 && iter.value()->profileKey() == key )
{
applyProfile(iter.key(),key);
}
}
}
QList<ViewProperties*> ViewManager::viewProperties() const
{
QList<ViewProperties*> list;
ViewContainer* container = _viewSplitter->activeContainer();
Q_ASSERT( container );
QListIterator<QWidget*> viewIter(container->views());
while ( viewIter.hasNext() )
{
ViewProperties* properties = container->viewProperties(viewIter.next()); Q_ASSERT( properties );
list << properties;
}
return list;
}
void ViewManager::sendInputToAll()
{
SessionGroup* group = new SessionGroup();
group->setMasterMode( SessionGroup::CopyInputToAll );
Session* activeSession = _sessionMap[qobject_cast<TerminalDisplay*>(activeView())];
if ( activeSession != 0 )
{
QListIterator<Session*> iter( SessionManager::instance()->sessions() );
while ( iter.hasNext() )
group->addSession(iter.next());
group->setMasterStatus(activeSession,true);
}
}
uint qHash(QPointer<TerminalDisplay> display)
{
return qHash((TerminalDisplay*)display);
}
#include "ViewManager.moc"