ViewManager.cpp 20.5 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
// Own
#include "ViewManager.h"

23 24 25
// System
#include <assert.h>

26
// Qt
Dirk Mueller's avatar
Dirk Mueller committed
27
#include <QtCore/QSignalMapper>
28

29 30 31 32 33 34 35
// KDE
#include <kdebug.h>
#include <KLocale>
#include <KToggleAction>
#include <KXMLGUIFactory>

// Konsole
36
#include "BookmarkHandler.h"
37
#include "ColorScheme.h"
38
#include "Session.h"
39
#include "TerminalDisplay.h"
40 41 42 43 44
#include "SessionController.h"
#include "SessionManager.h"
#include "ViewContainer.h"
#include "ViewSplitter.h"

45 46
using namespace Konsole;

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

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

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

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

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

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

100 101
void ViewManager::setupActions()
{
102
    KActionCollection* collection = _actionCollection;
103

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

        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()) );
146 147 148 149 150 151 152 153 154 155 156 157 158
   
        // 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()) );

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

        // Next / Previous View , Next Container
159 160 161
        collection->addAction("next-view",nextViewAction);
        collection->addAction("previous-view",previousViewAction);
        collection->addAction("next-container",nextContainerAction);
Robert Knight's avatar
 
Robert Knight committed
162

163
    }
Robert Knight's avatar
 
Robert Knight committed
164

165 166 167 168
    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
169
    connect( nextViewAction, SIGNAL(triggered()) , this , SLOT(nextView()) );
170
    _viewSplitter->addAction(nextViewAction);
Robert Knight's avatar
 
Robert Knight committed
171

172 173 174 175
    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
176
    connect( previousViewAction, SIGNAL(triggered()) , this , SLOT(previousView()) );
177
    _viewSplitter->addAction(previousViewAction);
Robert Knight's avatar
 
Robert Knight committed
178 179 180

    nextContainerAction->setShortcut( QKeySequence(Qt::SHIFT+Qt::Key_Tab) );
    connect( nextContainerAction , SIGNAL(triggered()) , this , SLOT(nextContainer()) );
181
    _viewSplitter->addAction(nextContainerAction);
Robert Knight's avatar
 
Robert Knight committed
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
}

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();
205 206 207 208 209
}
void ViewManager::detachActiveView()
{
    // find the currently active view and remove it from its container 
    ViewContainer* container = _viewSplitter->activeContainer();
210
    TerminalDisplay* activeView = dynamic_cast<TerminalDisplay*>(container->activeView());
211 212 213 214 215 216 217 218 219 220

    if (!activeView)
        return;

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

    // remove the view from this window
    container->removeView(activeView);
221
    activeView->deleteLater();
222 223 224 225 226 227 228

    // 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 )
    {
229
        removeContainer(container);
230 231 232

        // 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
233
        //_splitViewAction->setChecked(false);
234 235 236 237
    }

}

238
void ViewManager::sessionFinished()
239
{
240 241
    previousView();

242 243 244 245
    Session* session = qobject_cast<Session*>(sender());

    Q_ASSERT(session);

246
    QList<TerminalDisplay*> children = _viewSplitter->findChildren<TerminalDisplay*>();
247

248
    foreach ( TerminalDisplay* view , children )
249 250 251 252
    {
        if ( _sessionMap[view] == session )
        {
            _sessionMap.remove(view);
253
            view->deleteLater();
254
        }
Robert Knight's avatar
 
Robert Knight committed
255 256 257 258 259
    }
}

void ViewManager::focusActiveView()
{
Robert Knight's avatar
Robert Knight committed
260 261 262 263 264 265
    // 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
266 267 268 269 270 271 272 273 274
    ViewContainer* container = _viewSplitter->activeContainer(); 
    if ( container )
    {
        QWidget* activeView = container->activeView();
        if ( activeView )
        {
            activeView->setFocus(Qt::MouseFocusReason);
        }
    }
275 276
}

277

278 279
void ViewManager::viewActivated( QWidget* view )
{
280 281 282 283 284 285
    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);
286 287
}

288
void ViewManager::splitLeftRight()
289
{
290
    splitView(Qt::Horizontal);
291
}
292
void ViewManager::splitTopBottom()
293
{
294
    splitView(Qt::Vertical);
295 296
}

297
void ViewManager::splitView(Qt::Orientation orientation)
298
{
299 300 301 302 303 304 305
    // 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())
306
    {
307 308
        Session* session = _sessionMap[(TerminalDisplay*)existingViewIter.next()];
        TerminalDisplay* display = createTerminalDisplay();
309
        applyProfile(display,session->profileKey()); 
310
        ViewProperties* properties = createController(session,display);
311

312
        _sessionMap[display] = session;
313

314 315 316
        container->addView(display,properties);
        session->addView( display );
    }
317

318 319
    _viewSplitter->addContainer(container,orientation);
    emit splitViewToggle(_viewSplitter->containers().count() > 0);
320

321 322
    // focus the new container
    container->containerWidget()->setFocus();
323 324

    // ensure that the active view is focused after the split / unsplit
325 326 327 328 329
    ViewContainer* activeContainer = _viewSplitter->activeContainer();
    QWidget* activeView = activeContainer ? activeContainer->activeView() : 0;

    if ( activeView )
        activeView->setFocus(Qt::OtherFocusReason);
330
}
331
void ViewManager::removeContainer(ViewContainer* container)
332
{
333
    container->deleteLater();
334 335
    emit splitViewToggle(_viewSplitter->containers().count() > 1);
}
336 337 338 339 340 341 342 343
void ViewManager::expandActiveView()
{
    _viewSplitter->adjustContainerSize(_viewSplitter->activeContainer(),10);
}
void ViewManager::shrinkActiveView()
{
    _viewSplitter->adjustContainerSize(_viewSplitter->activeContainer(),-10);
}
344 345 346 347 348 349 350 351
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);
352

353 354 355 356
        // focus next container so that user can continue typing 
        // without having to manually focus it themselves
        nextContainer();
    }
357 358 359 360 361 362 363 364 365 366 367 368 369 370
}
void ViewManager::closeOtherViews()
{
    ViewContainer* active = _viewSplitter->activeContainer();

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

371
SessionController* ViewManager::createController(Session* session , TerminalDisplay* view)
372
{
Robert Knight's avatar
Robert Knight committed
373 374
    // create a new controller for the session, and ensure that this view manager
    // is notified when the view gains the focus
375
    SessionController* controller = new SessionController(session,view,this);
376
    connect( controller , SIGNAL(focused(SessionController*)) , this , SIGNAL(activeViewChanged(SessionController*)) );
377 378 379
    connect( session , SIGNAL(destroyed()) , controller , SLOT(deleteLater()) );
    connect( view , SIGNAL(destroyed()) , controller , SLOT(deleteLater()) );
    
380 381 382
    return controller;
}

383
void ViewManager::createView(Session* session)
384
{
385 386 387 388
    // create the default container
    if (_viewSplitter->containers().count() == 0)
    {
        _viewSplitter->addContainer( createContainer() , Qt::Vertical );
389
        emit splitViewToggle(false);
390 391
    }

Robert Knight's avatar
Robert Knight committed
392 393
    // notify this view manager when the session finishes so that its view
    // can be deleted
394
    connect( session , SIGNAL(finished()) , this , SLOT(sessionFinished()) );
Robert Knight's avatar
Robert Knight committed
395 396 397 398
   
    // 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 
399 400 401 402 403 404
    ViewContainer* const activeContainer = _viewSplitter->activeContainer();
    QListIterator<ViewContainer*> containerIter(_viewSplitter->containers());

    while ( containerIter.hasNext() )
    {
        ViewContainer* container = containerIter.next();
405
        TerminalDisplay* display = createTerminalDisplay();
406
        applyProfile(display,session->profileKey());
407 408 409 410 411 412
        
        // set initial size
        // temporary default used for now
        display->setSize(80,40);

        
Robert Knight's avatar
 
Robert Knight committed
413
        ViewProperties* properties = createController(session,display);
414 415

        _sessionMap[display] = session; 
Robert Knight's avatar
 
Robert Knight committed
416
        container->addView(display,properties);
417 418
        session->addView(display);

419 420
        if ( container == activeContainer ) 
        {
421
            container->setActiveView(display);
422 423
            display->setFocus( Qt::OtherFocusReason );
        }
424 425 426 427 428
    }
}

ViewContainer* ViewManager::createContainer()
{
429
    ViewContainer* container = new TabbedViewContainerV2(_viewSplitter);
430

431
    // connect signals and slots
432 433 434 435 436 437
    connect( container , SIGNAL(viewAdded(QWidget*,ViewProperties*)) , _containerSignalMapper ,
           SLOT(map()) );
    connect( container , SIGNAL(viewRemoved(QWidget*)) , _containerSignalMapper ,
           SLOT(map()) ); 
    _containerSignalMapper->setMapping(container,container);

438
    connect( container , SIGNAL(viewRemoved(QWidget*)) , this , SLOT(viewCloseRequest(QWidget*)) );
439
    connect( container , SIGNAL(closeRequest(QWidget*)) , this , SLOT(viewCloseRequest(QWidget*)) );
440
    connect( container , SIGNAL(activeViewChanged(QWidget*)) , this , SLOT(viewActivated(QWidget*)));
441
    
442
    return container;
443 444
}

445 446 447 448 449 450 451 452 453 454
void ViewManager::containerViewsChanged(QObject* container)
{
    qDebug() << "Container views changed";

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

455 456 457 458
void ViewManager::viewCloseRequest(QWidget* view)
{
    // 1. detach view from session
    // 2. if the session has no views left, close it
459
    
460
    TerminalDisplay* display = (TerminalDisplay*)view;
461
    Session* session = _sessionMap[ display ];
462 463
    if ( session )
    {
464
        display->deleteLater();
465 466
        
        if ( session->views().count() == 0 )
467
            session->close();
468
    }
469
        
470
    focusActiveView();
471 472
}

473
TerminalDisplay* ViewManager::createTerminalDisplay()
474
{
475
   TerminalDisplay* display = new TerminalDisplay(0);
476 477 478 479 480 481

   //TODO Temporary settings used here
   display->setBellMode(0);
   display->setTerminalSizeHint(false);
   display->setCutToBeginningOfLine(true);
   display->setTerminalSizeStartup(false);
482
   display->setScrollBarLocation(TerminalDisplay::SCROLLBAR_RIGHT);
483
   
484 485 486
   return display;
}

487
void ViewManager::applyProfile(TerminalDisplay* view , const QString& profileKey)
488
{
489 490
    Profile* info = SessionManager::instance()->profile(profileKey);

491 492 493 494
    Q_ASSERT( info );

    const ColorScheme* colorScheme = ColorSchemeManager::instance()->
                                            findColorScheme(info->colorScheme());
495 496
    if ( !colorScheme )
       colorScheme = ColorSchemeManager::instance()->defaultColorScheme(); 
497 498
    Q_ASSERT( colorScheme );

499 500 501 502 503 504 505 506 507 508 509 510 511
    // 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);

512
    // load colour scheme
513
    view->setColorTable(colorScheme->colorTable());
514
    view->setOpacity(colorScheme->opacity());
515
    
516
    // load font 
517
    view->setVTFont(info->font());
518 519 520 521 522 523 524 525 526 527

    // 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);
528 529 530 531 532 533

    // 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>();
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
    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>() );
554 555 556 557 558 559 560 561 562 563 564
}

void ViewManager::profileChanged(const QString& key)
{
    QHashIterator<TerminalDisplay*,Session*> iter(_sessionMap);

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

        // if session uses this profile, update the display
565
        if ( iter.value() != 0 && iter.value()->profileKey() == key )
566
        {
567
            applyProfile(iter.key(),key);
568 569
        }
    }
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
}

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

587
    return list;
588 589
}

590
#include "ViewManager.moc"