ViewManager.cpp 20.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
/*
    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.
*/

20 21 22
// System
#include <assert.h>

23 24 25
// Qt
#include <QSignalMapper>

26 27 28 29 30 31 32
// KDE
#include <kdebug.h>
#include <KLocale>
#include <KToggleAction>
#include <KXMLGUIFactory>

// Konsole
33
#include "BookmarkHandler.h"
34
#include "ColorScheme.h"
35
#include "Session.h"
36
#include "TerminalDisplay.h"
37 38 39 40 41 42
#include "SessionController.h"
#include "SessionManager.h"
#include "ViewContainer.h"
#include "ViewSplitter.h"
#include "ViewManager.h"

43 44
using namespace Konsole;

45 46
ViewManager::ViewManager(QObject* parent , KActionCollection* collection)
    : QObject(parent)
47
    , _viewSplitter(0)
48 49
    , _actionCollection(collection)
    , _containerSignalMapper(new QSignalMapper(this))
50
{
51 52 53 54 55 56 57 58 59 60
    // 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);

61 62 63 64 65 66
    // 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()) );
67 68 69 70

    // listen for addition or removal of views from associated containers
    connect( _containerSignalMapper , SIGNAL(mapped(QObject*)) , this , 
            SLOT(containerViewsChanged(QObject*)) ); 
71 72 73 74

    // listen for profile changes
    connect( SessionManager::instance() , SIGNAL(profileChanged(const QString&)) , this,
            SLOT(profileChanged(const QString&)) );
75 76 77 78 79
}

ViewManager::~ViewManager()
{
}
80 81 82 83 84 85 86 87 88 89 90 91
QWidget* ViewManager::activeView() const
{
    ViewContainer* container = _viewSplitter->activeContainer();
    if ( container )
    {
        return container->activeView();
    }
    else
    {
        return 0;
    }
}
92

93 94 95 96 97
QWidget* ViewManager::widget() const
{
    return _viewSplitter;
}

98 99
void ViewManager::setupActions()
{
100
    KActionCollection* collection = _actionCollection;
101

102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
    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);
    
    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->setShortcut( QKeySequence(Qt::CTRL+Qt::SHIFT+Qt::Key_S) );
123
        closeActiveAction->setEnabled(false);
124 125
        collection->addAction("close-active-view",closeActiveAction);
        connect( closeActiveAction , SIGNAL(triggered()) , this , SLOT(closeActiveView()) );
126 127
        connect( this , SIGNAL(splitViewToggle(bool)) , closeActiveAction , SLOT(setEnabled(bool)) );
        
128 129
        KAction* closeOtherAction = new KAction( i18n("Close Others") , this );
        closeOtherAction->setShortcut( QKeySequence(Qt::CTRL+Qt::SHIFT+Qt::Key_O) );
130
        closeOtherAction->setEnabled(false);
131 132
        collection->addAction("close-other-views",closeOtherAction);
        connect( closeOtherAction , SIGNAL(triggered()) , this , SLOT(closeOtherViews()) );
133
        connect( this , SIGNAL(splitViewToggle(bool)) , closeOtherAction , SLOT(setEnabled(bool)) );
134 135 136 137 138 139 140 141 142 143 144 145 146

        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) );

        connect( detachViewAction , SIGNAL(triggered()) , this , SLOT(detachActiveView()) );
    
        collection->addAction("next-view",nextViewAction);
        collection->addAction("previous-view",previousViewAction);
        collection->addAction("next-container",nextContainerAction);
Robert Knight's avatar
 
Robert Knight committed
147

148
    }
Robert Knight's avatar
 
Robert Knight committed
149

150 151 152 153
    KShortcut nextViewShortcut = nextViewAction->shortcut();
    nextViewShortcut.setAlternate( QKeySequence(Qt::SHIFT+Qt::Key_Right) );
    nextViewShortcut.setPrimary( QKeySequence(Qt::CTRL+Qt::Key_PageUp) );
    nextViewAction->setShortcut(nextViewShortcut); 
Robert Knight's avatar
 
Robert Knight committed
154
    connect( nextViewAction, SIGNAL(triggered()) , this , SLOT(nextView()) );
155
    _viewSplitter->addAction(nextViewAction);
Robert Knight's avatar
 
Robert Knight committed
156

157 158 159 160
    KShortcut previousViewShortcut = previousViewAction->shortcut();
    previousViewShortcut.setPrimary( QKeySequence(Qt::SHIFT+Qt::Key_Left) );
    previousViewShortcut.setAlternate( QKeySequence(Qt::CTRL+Qt::Key_PageDown) );
    previousViewAction->setShortcut(previousViewShortcut);
Robert Knight's avatar
 
Robert Knight committed
161
    connect( previousViewAction, SIGNAL(triggered()) , this , SLOT(previousView()) );
162
    _viewSplitter->addAction(previousViewAction);
Robert Knight's avatar
 
Robert Knight committed
163 164 165

    nextContainerAction->setShortcut( QKeySequence(Qt::SHIFT+Qt::Key_Tab) );
    connect( nextContainerAction , SIGNAL(triggered()) , this , SLOT(nextContainer()) );
166
    _viewSplitter->addAction(nextContainerAction);
Robert Knight's avatar
 
Robert Knight committed
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
}

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();
190 191 192 193 194
}
void ViewManager::detachActiveView()
{
    // find the currently active view and remove it from its container 
    ViewContainer* container = _viewSplitter->activeContainer();
195
    TerminalDisplay* activeView = dynamic_cast<TerminalDisplay*>(container->activeView());
196 197 198 199 200 201 202 203 204 205

    if (!activeView)
        return;

    emit viewDetached(_sessionMap[activeView]);
    
    _sessionMap.remove(activeView);

    // remove the view from this window
    container->removeView(activeView);
206
    activeView->deleteLater();
207 208 209 210 211 212 213

    // 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 )
    {
214
        removeContainer(container);
215 216 217

        // this will need to be removed if Konsole is modified so the menu item to
        // split the view is no longer one toggle-able item
218
        //_splitViewAction->setChecked(false);
219 220 221 222
    }

}

223
void ViewManager::sessionFinished( Session* session )
224
{
225 226
    previousView();

227
    QList<TerminalDisplay*> children = _viewSplitter->findChildren<TerminalDisplay*>();
228

229
    foreach ( TerminalDisplay* view , children )
230 231 232 233
    {
        if ( _sessionMap[view] == session )
        {
            _sessionMap.remove(view);
234
            view->deleteLater();
235
        }
Robert Knight's avatar
 
Robert Knight committed
236 237 238 239 240
    }
}

void ViewManager::focusActiveView()
{
Robert Knight's avatar
Robert Knight committed
241 242 243 244 245 246
    // 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

Robert Knight's avatar
 
Robert Knight committed
247 248 249 250 251 252 253 254 255
    ViewContainer* container = _viewSplitter->activeContainer(); 
    if ( container )
    {
        QWidget* activeView = container->activeView();
        if ( activeView )
        {
            activeView->setFocus(Qt::MouseFocusReason);
        }
    }
256 257
}

258

259 260
void ViewManager::viewActivated( QWidget* view )
{
261 262 263 264 265 266
    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);
267 268
}

269
void ViewManager::splitLeftRight()
270
{
271
    splitView(Qt::Horizontal);
272
}
273
void ViewManager::splitTopBottom()
274
{
275
    splitView(Qt::Vertical);
276 277
}

278
void ViewManager::splitView(Qt::Orientation orientation)
279
{
280 281 282 283 284 285 286
    // 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 = createContainer(); 

    while (existingViewIter.hasNext())
287
    {
288 289
        Session* session = _sessionMap[(TerminalDisplay*)existingViewIter.next()];
        TerminalDisplay* display = createTerminalDisplay();
290
        loadViewSettings(display,SessionManager::instance()->profile(session->type())); 
291
        ViewProperties* properties = createController(session,display);
292

293
        _sessionMap[display] = session;
294

295 296 297
        container->addView(display,properties);
        session->addView( display );
    }
298

299 300
    _viewSplitter->addContainer(container,orientation);
    emit splitViewToggle(_viewSplitter->containers().count() > 0);
301

302 303
    // focus the new container
    container->containerWidget()->setFocus();
304 305 306

    // ensure that the active view is focused after the split / unsplit
    _viewSplitter->activeContainer()->activeView()->setFocus(Qt::OtherFocusReason);
307
}
308
void ViewManager::removeContainer(ViewContainer* container)
309
{
310
    container->deleteLater();
311 312 313 314 315 316 317 318 319 320
    emit splitViewToggle(_viewSplitter->containers().count() > 1);
}
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);
321

322 323 324 325
        // focus next container so that user can continue typing 
        // without having to manually focus it themselves
        nextContainer();
    }
326 327 328 329 330 331 332 333 334 335 336 337 338 339
}
void ViewManager::closeOtherViews()
{
    ViewContainer* active = _viewSplitter->activeContainer();

    QListIterator<ViewContainer*> iter(_viewSplitter->containers());
    while ( iter.hasNext() )
    {
        ViewContainer* next = iter.next();
        if ( next != active )
            delete next;
    }
}

340
SessionController* ViewManager::createController(Session* session , TerminalDisplay* view)
341
{
Robert Knight's avatar
Robert Knight committed
342 343
    // create a new controller for the session, and ensure that this view manager
    // is notified when the view gains the focus
344
    SessionController* controller = new SessionController(session,view,this);
345
    connect( controller , SIGNAL(focused(SessionController*)) , this , SIGNAL(activeViewChanged(SessionController*)) );
346 347 348
    connect( session , SIGNAL(destroyed()) , controller , SLOT(deleteLater()) );
    connect( view , SIGNAL(destroyed()) , controller , SLOT(deleteLater()) );
    
349 350 351
    return controller;
}

352
void ViewManager::createView(Session* session)
353
{
354 355 356 357
    // create the default container
    if (_viewSplitter->containers().count() == 0)
    {
        _viewSplitter->addContainer( createContainer() , Qt::Vertical );
358
        emit splitViewToggle(false);
359 360
    }

Robert Knight's avatar
Robert Knight committed
361 362
    // notify this view manager when the session finishes so that its view
    // can be deleted
363
    connect( session , SIGNAL(done(Session*)) , this , SLOT(sessionFinished(Session*)) );
Robert Knight's avatar
Robert Knight committed
364 365 366 367
   
    // 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 
368 369 370 371 372 373
    ViewContainer* const activeContainer = _viewSplitter->activeContainer();
    QListIterator<ViewContainer*> containerIter(_viewSplitter->containers());

    while ( containerIter.hasNext() )
    {
        ViewContainer* container = containerIter.next();
374
        TerminalDisplay* display = createTerminalDisplay();
375
        loadViewSettings(display,SessionManager::instance()->profile(session->type()));
376 377 378 379 380 381
        
        // set initial size
        // temporary default used for now
        display->setSize(80,40);

        
Robert Knight's avatar
 
Robert Knight committed
382
        ViewProperties* properties = createController(session,display);
383 384

        _sessionMap[display] = session; 
Robert Knight's avatar
 
Robert Knight committed
385
        container->addView(display,properties);
386 387
        session->addView(display);

388 389
        if ( container == activeContainer ) 
        {
390
            container->setActiveView(display);
391 392
            display->setFocus( Qt::OtherFocusReason );
        }
393 394 395 396 397
    }
}

ViewContainer* ViewManager::createContainer()
{
398
    ViewContainer* container = new TabbedViewContainerV2(_viewSplitter);
399

400
    // connect signals and slots
401 402 403 404 405 406
    connect( container , SIGNAL(viewAdded(QWidget*,ViewProperties*)) , _containerSignalMapper ,
           SLOT(map()) );
    connect( container , SIGNAL(viewRemoved(QWidget*)) , _containerSignalMapper ,
           SLOT(map()) ); 
    _containerSignalMapper->setMapping(container,container);

407
    connect( container , SIGNAL(viewRemoved(QWidget*)) , this , SLOT(viewCloseRequest(QWidget*)) );
408
    connect( container , SIGNAL(closeRequest(QWidget*)) , this , SLOT(viewCloseRequest(QWidget*)) );
409
    connect( container , SIGNAL(activeViewChanged(QWidget*)) , this , SLOT(viewActivated(QWidget*)));
410
    
411
    return container;
412 413
}

414 415 416 417 418 419 420 421 422 423
void ViewManager::containerViewsChanged(QObject* container)
{
    qDebug() << "Container views changed";

    if ( container == _viewSplitter->activeContainer() )
    {
        emit viewPropertiesChanged( viewProperties() );
    } 
}

424 425 426 427
void ViewManager::viewCloseRequest(QWidget* view)
{
    // 1. detach view from session
    // 2. if the session has no views left, close it
428
    
429
    TerminalDisplay* display = (TerminalDisplay*)view;
430
    Session* session = _sessionMap[ display ];
431 432
    if ( session )
    {
433
        display->deleteLater();
434 435 436 437
        
        if ( session->views().count() == 0 )
            session->closeSession();
    }
438
        
439
    focusActiveView();
440 441
}

442 443
void ViewManager::merge(ViewManager* otherManager)
{
Robert Knight's avatar
Robert Knight committed
444 445 446 447 448 449
    // iterate over the views in otherManager's active container and take them from that
    // manager and put them in the active container in this manager
    //
    // TODO - This currently does not consider views in containers other than
    //        the active one in the other manager
    //
450 451 452 453 454 455 456 457 458
    ViewSplitter* otherSplitter = otherManager->_viewSplitter;
    ViewContainer* otherContainer = otherSplitter->activeContainer();

    QListIterator<QWidget*> otherViewIter(otherContainer->views());

    ViewContainer* activeContainer = _viewSplitter->activeContainer();

    while ( otherViewIter.hasNext() )
    {
459
        TerminalDisplay* view = dynamic_cast<TerminalDisplay*>(otherViewIter.next());
460 461 462
        
        assert(view);

463
        takeView(otherManager,otherContainer,activeContainer,view);
464 465 466
    } 
}

467 468

void ViewManager::takeView(ViewManager* otherManager , ViewContainer* otherContainer, 
469
                           ViewContainer* newContainer, TerminalDisplay* view)
470
{
Robert Knight's avatar
Robert Knight committed
471 472 473
    // FIXME - the controller associated with the display which is being moved
    //         may have signals which are connected to otherManager.  they need
    //         to be redirected to slots in this view manager
474 475 476 477 478 479 480 481 482 483
    ViewProperties* properties = otherContainer->viewProperties(view);
    otherContainer->removeView(view);

    newContainer->addView(view,properties);

    // transfer the session map entries
    _sessionMap.insert(view,otherManager->_sessionMap[view]);
    otherManager->_sessionMap.remove(view);
}

484
TerminalDisplay* ViewManager::createTerminalDisplay()
485
{
486
   TerminalDisplay* display = new TerminalDisplay(0);
487 488 489 490 491 492

   //TODO Temporary settings used here
   display->setBellMode(0);
   display->setTerminalSizeHint(false);
   display->setCutToBeginningOfLine(true);
   display->setTerminalSizeStartup(false);
493
   display->setScrollBarLocation(TerminalDisplay::SCROLLBAR_RIGHT);
494

495
   
496 497 498
   return display;
}

499
void ViewManager::loadViewSettings(TerminalDisplay* view , Profile* info)
500
{
501 502 503 504
    Q_ASSERT( info );

    const ColorScheme* colorScheme = ColorSchemeManager::instance()->
                                            findColorScheme(info->colorScheme());
505 506
    if ( !colorScheme )
       colorScheme = ColorSchemeManager::instance()->defaultColorScheme(); 
507 508
    Q_ASSERT( colorScheme );

509 510 511 512 513 514 515 516 517 518 519 520 521
    // 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>();
    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);

522
    // load colour scheme
523 524
    view->setColorTable(colorScheme->colorTable());
    
525
    // load font 
526
    view->setVTFont(info->font());
527 528 529 530 531 532 533 534 535 536

    // set scroll-bar position
    int scrollBarPosition = info->property(Profile::ScrollBarPosition).value<int>();

    if ( scrollBarPosition == Profile::ScrollBarHidden )
       view->setScrollBarLocation(TerminalDisplay::SCROLLBAR_NONE);
    else if ( scrollBarPosition == Profile::ScrollBarLeft )
       view->setScrollBarLocation(TerminalDisplay::SCROLLBAR_LEFT);
    else if ( scrollBarPosition == Profile::ScrollBarRight )
       view->setScrollBarLocation(TerminalDisplay::SCROLLBAR_RIGHT);
537 538 539 540 541 542

    // terminal features
    //bool blinkingText = info->property(Profile::BlinkingTextEnabled).value<bool>();
    //TODO - Add a method in TerminalDisplay to allow this to be turned on or off 

    bool blinkingCursor = info->property(Profile::BlinkingCursorEnabled).value<bool>();
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
    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>() );
563 564 565 566 567 568 569 570 571 572 573 574 575
}

void ViewManager::profileChanged(const QString& key)
{
    Profile* info = SessionManager::instance()->profile(key);

    QHashIterator<TerminalDisplay*,Session*> iter(_sessionMap);

    while ( iter.hasNext() )
    {
        iter.next();

        // if session uses this profile, update the display
576
        if ( iter.value() != 0 && iter.value()->type() == key )
577 578 579 580
        {
            loadViewSettings(iter.key(),info);
        }
    }
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
}

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; 
    } 
597

598
    return list;
599 600
}

601
#include "ViewManager.moc"