qa: Add [[fallthrough]] annotations where appropriate
[quassel.git] / src / qtui / bufferwidget.cpp
index e6990aa..f11094b 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-09 by the Quassel Project                          *
+ *   Copyright (C) 2005-2016 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   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.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
+#include <QIcon>
 #include <QLayout>
 #include <QKeyEvent>
 #include <QMenu>
 #include "action.h"
 #include "actioncollection.h"
 #include "bufferwidget.h"
+#include "chatline.h"
 #include "chatview.h"
 #include "chatviewsearchbar.h"
 #include "chatviewsearchcontroller.h"
+#include "chatviewsettings.h"
 #include "client.h"
-#include "iconloader.h"
 #include "multilineedit.h"
 #include "qtui.h"
 #include "settings.h"
 
-
 BufferWidget::BufferWidget(QWidget *parent)
-  : AbstractBufferContainer(parent),
-    _chatViewSearchController(new ChatViewSearchController(this))
-{
-  ui.setupUi(this);
-  layout()->setContentsMargins(0, 0, 0, 0);
-  layout()->setSpacing(0);
-  // ui.searchBar->hide();
-
-  _chatViewSearchController->setCaseSensitive(ui.searchBar->caseSensitiveBox()->isChecked());
-  _chatViewSearchController->setSearchSenders(ui.searchBar->searchSendersBox()->isChecked());
-  _chatViewSearchController->setSearchMsgs(ui.searchBar->searchMsgsBox()->isChecked());
-  _chatViewSearchController->setSearchOnlyRegularMsgs(ui.searchBar->searchOnlyRegularMsgsBox()->isChecked());
+    : AbstractBufferContainer(parent),
+    _chatViewSearchController(new ChatViewSearchController(this)),
+    _autoMarkerLine(true),
+    _autoMarkerLineOnLostFocus(true)
+{
+    ui.setupUi(this);
+    layout()->setContentsMargins(0, 0, 0, 0);
+    layout()->setSpacing(0);
+    // ui.searchBar->hide();
 
-  connect(ui.searchBar, SIGNAL(searchChanged(const QString &)),
-    _chatViewSearchController, SLOT(setSearchString(const QString &)));
-  connect(ui.searchBar->caseSensitiveBox(), SIGNAL(toggled(bool)),
-    _chatViewSearchController, SLOT(setCaseSensitive(bool)));
-  connect(ui.searchBar->searchSendersBox(), SIGNAL(toggled(bool)),
-    _chatViewSearchController, SLOT(setSearchSenders(bool)));
-  connect(ui.searchBar->searchMsgsBox(), SIGNAL(toggled(bool)),
-    _chatViewSearchController, SLOT(setSearchMsgs(bool)));
-  connect(ui.searchBar->searchOnlyRegularMsgsBox(), SIGNAL(toggled(bool)),
-    _chatViewSearchController, SLOT(setSearchOnlyRegularMsgs(bool)));
-  connect(ui.searchBar->searchUpButton(), SIGNAL(clicked()),
-    _chatViewSearchController, SLOT(highlightPrev()));
-  connect(ui.searchBar->searchDownButton(), SIGNAL(clicked()),
-    _chatViewSearchController, SLOT(highlightNext()));
+    _chatViewSearchController->setCaseSensitive(ui.searchBar->caseSensitiveBox()->isChecked());
+    _chatViewSearchController->setSearchSenders(ui.searchBar->searchSendersBox()->isChecked());
+    _chatViewSearchController->setSearchMsgs(ui.searchBar->searchMsgsBox()->isChecked());
+    _chatViewSearchController->setSearchOnlyRegularMsgs(ui.searchBar->searchOnlyRegularMsgsBox()->isChecked());
 
-  connect(ui.searchBar, SIGNAL(hidden()), this, SLOT(setFocus()));
+    connect(ui.searchBar, SIGNAL(searchChanged(const QString &)),
+        _chatViewSearchController, SLOT(setSearchString(const QString &)));
+    connect(ui.searchBar->caseSensitiveBox(), SIGNAL(toggled(bool)),
+        _chatViewSearchController, SLOT(setCaseSensitive(bool)));
+    connect(ui.searchBar->searchSendersBox(), SIGNAL(toggled(bool)),
+        _chatViewSearchController, SLOT(setSearchSenders(bool)));
+    connect(ui.searchBar->searchMsgsBox(), SIGNAL(toggled(bool)),
+        _chatViewSearchController, SLOT(setSearchMsgs(bool)));
+    connect(ui.searchBar->searchOnlyRegularMsgsBox(), SIGNAL(toggled(bool)),
+        _chatViewSearchController, SLOT(setSearchOnlyRegularMsgs(bool)));
+    connect(ui.searchBar->searchUpButton(), SIGNAL(clicked()),
+        _chatViewSearchController, SLOT(highlightPrev()));
+    connect(ui.searchBar->searchDownButton(), SIGNAL(clicked()),
+        _chatViewSearchController, SLOT(highlightNext()));
 
-  connect(_chatViewSearchController, SIGNAL(newCurrentHighlight(QGraphicsItem *)),
-    this, SLOT(scrollToHighlight(QGraphicsItem *)));
+    connect(ui.searchBar, SIGNAL(hidden()), this, SLOT(setFocus()));
 
-  ActionCollection *coll = QtUi::actionCollection();
+    connect(_chatViewSearchController, SIGNAL(newCurrentHighlight(QGraphicsItem *)),
+        this, SLOT(scrollToHighlight(QGraphicsItem *)));
 
-  Action *zoomInChatview = coll->add<Action>("ZoomInChatView", this, SLOT(zoomIn()));
-  zoomInChatview->setText(tr("Zoom In"));
-  zoomInChatview->setIcon(SmallIcon("zoom-in"));
-  zoomInChatview->setShortcut(QKeySequence::ZoomIn);
+    ActionCollection *coll = QtUi::actionCollection();
 
-  Action *zoomOutChatview = coll->add<Action>("ZoomOutChatView", this, SLOT(zoomOut()));
-  zoomOutChatview->setIcon(SmallIcon("zoom-out"));
-  zoomOutChatview->setText(tr("Zoom Out"));
-  zoomOutChatview->setShortcut(QKeySequence::ZoomOut);
+    Action *zoomInChatview = coll->add<Action>("ZoomInChatView", this, SLOT(zoomIn()));
+    zoomInChatview->setText(tr("Zoom In"));
+    zoomInChatview->setIcon(QIcon::fromTheme("zoom-in"));
+    zoomInChatview->setShortcut(QKeySequence::ZoomIn);
 
-  Action *zoomOriginalChatview = coll->add<Action>("ZoomOriginalChatView", this, SLOT(zoomOriginal()));
-  zoomOriginalChatview->setIcon(SmallIcon("zoom-original"));
-  zoomOriginalChatview->setText(tr("Actual Size"));
-  //zoomOriginalChatview->setShortcut(tr("Ctrl+0")); // used for RTS switching
-}
+    Action *zoomOutChatview = coll->add<Action>("ZoomOutChatView", this, SLOT(zoomOut()));
+    zoomOutChatview->setIcon(QIcon::fromTheme("zoom-out"));
+    zoomOutChatview->setText(tr("Zoom Out"));
+    zoomOutChatview->setShortcut(QKeySequence::ZoomOut);
+
+    Action *zoomOriginalChatview = coll->add<Action>("ZoomOriginalChatView", this, SLOT(zoomOriginal()));
+    zoomOriginalChatview->setIcon(QIcon::fromTheme("zoom-original"));
+    zoomOriginalChatview->setText(tr("Actual Size"));
+    //zoomOriginalChatview->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_0)); // used for RTS switching
 
-BufferWidget::~BufferWidget() {
-  delete _chatViewSearchController;
-  _chatViewSearchController = 0;
+    Action *setMarkerLine = coll->add<Action>("SetMarkerLineToBottom", this, SLOT(setMarkerLine()));
+    setMarkerLine->setText(tr("Set Marker Line"));
+    setMarkerLine->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_R));
+
+    Action *jumpToMarkerLine = QtUi::actionCollection("Navigation")->add<Action>("JumpToMarkerLine", this, SLOT(jumpToMarkerLine()));
+    jumpToMarkerLine->setText(tr("Go to Marker Line"));
+    jumpToMarkerLine->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_K));
+
+    ChatViewSettings s;
+    s.initAndNotify("AutoMarkerLine", this, SLOT(setAutoMarkerLine(QVariant)), true);
+    s.initAndNotify("AutoMarkerLineOnLostFocus", this, SLOT(setAutoMarkerLineOnLostFocus(QVariant)), true);
 }
 
-AbstractChatView *BufferWidget::createChatView(BufferId id) {
-  ChatView *chatView;
-  chatView = new ChatView(id, this);
-  chatView->setBufferContainer(this);
-  _chatViews[id] = chatView;
-  ui.stackedWidget->addWidget(chatView);
-  chatView->setFocusProxy(this);
-  return chatView;
+
+BufferWidget::~BufferWidget()
+{
+    delete _chatViewSearchController;
+    _chatViewSearchController = 0;
 }
 
-void BufferWidget::removeChatView(BufferId id) {
-  QWidget *view = _chatViews.value(id, 0);
-  if(!view) return;
-  ui.stackedWidget->removeWidget(view);
-  view->deleteLater();
-  _chatViews.take(id);
+
+void BufferWidget::setAutoMarkerLine(const QVariant &v)
+{
+    _autoMarkerLine = v.toBool();
 }
 
-void BufferWidget::showChatView(BufferId id) {
-  if(!id.isValid()) {
-    ui.stackedWidget->setCurrentWidget(ui.page);
-  } else {
-    ChatView *view = qobject_cast<ChatView *>(_chatViews.value(id));
-    Q_ASSERT(view);
-    ui.stackedWidget->setCurrentWidget(view);
-    _chatViewSearchController->setScene(view->scene());
-  }
+void BufferWidget::setAutoMarkerLineOnLostFocus(const QVariant &v)
+{
+    _autoMarkerLineOnLostFocus = v.toBool();
 }
 
-void BufferWidget::scrollToHighlight(QGraphicsItem *highlightItem) {
-  ChatView *view = qobject_cast<ChatView *>(ui.stackedWidget->currentWidget());
-  if(view) {
-    view->centerOn(highlightItem);
-  }
+
+AbstractChatView *BufferWidget::createChatView(BufferId id)
+{
+    ChatView *chatView;
+    chatView = new ChatView(id, this);
+    chatView->setBufferContainer(this);
+    _chatViews[id] = chatView;
+    ui.stackedWidget->addWidget(chatView);
+    chatView->setFocusProxy(this);
+    return chatView;
 }
 
 
-void BufferWidget::zoomIn() {
-  ChatView *view = qobject_cast<ChatView *>(ui.stackedWidget->currentWidget());
-  if(view)
-    view->zoomIn();
+void BufferWidget::removeChatView(BufferId id)
+{
+    QWidget *view = _chatViews.value(id, 0);
+    if (!view) return;
+    ui.stackedWidget->removeWidget(view);
+    view->deleteLater();
+    _chatViews.take(id);
 }
 
-void BufferWidget::zoomOut() {
-  ChatView *view = qobject_cast<ChatView *>(ui.stackedWidget->currentWidget());
-  if(view)
-    view->zoomOut();
+
+void BufferWidget::showChatView(BufferId id)
+{
+    if (!id.isValid()) {
+        ui.stackedWidget->setCurrentWidget(ui.page);
+    }
+    else {
+        ChatView *view = qobject_cast<ChatView *>(_chatViews.value(id));
+        Q_ASSERT(view);
+        ui.stackedWidget->setCurrentWidget(view);
+        _chatViewSearchController->setScene(view->scene());
+    }
 }
 
-void BufferWidget::zoomOriginal() {
-  ChatView *view = qobject_cast<ChatView *>(ui.stackedWidget->currentWidget());
-  if(view)
-    view->zoomOriginal();
+
+void BufferWidget::scrollToHighlight(QGraphicsItem *highlightItem)
+{
+    ChatView *view = qobject_cast<ChatView *>(ui.stackedWidget->currentWidget());
+    if (view) {
+        view->centerOn(highlightItem);
+    }
 }
 
-void BufferWidget::addActionsToMenu(QMenu *menu, const QPointF &pos) {
-  Q_UNUSED(pos);
-  ActionCollection *coll = QtUi::actionCollection();
-  menu->addSeparator();
-  menu->addAction(coll->action("ZoomInChatView"));
-  menu->addAction(coll->action("ZoomOutChatView"));
-  menu->addAction(coll->action("ZoomOriginalChatView"));
+
+void BufferWidget::zoomIn()
+{
+    ChatView *view = qobject_cast<ChatView *>(ui.stackedWidget->currentWidget());
+    if (view)
+        view->zoomIn();
 }
 
-bool BufferWidget::eventFilter(QObject *watched, QEvent *event) {
-  if(event->type() != QEvent::KeyPress)
-    return false;
 
-  QKeyEvent *keyEvent = static_cast<QKeyEvent*>(event);
+void BufferWidget::zoomOut()
+{
+    ChatView *view = qobject_cast<ChatView *>(ui.stackedWidget->currentWidget());
+    if (view)
+        view->zoomOut();
+}
 
-  MultiLineEdit *inputLine = qobject_cast<MultiLineEdit *>(watched);
-  if(!inputLine)
-    return false;
 
-  // Intercept copy key presses
-  if(keyEvent == QKeySequence::Copy) {
-    if(inputLine->hasSelectedText())
-      return false;
+void BufferWidget::zoomOriginal()
+{
     ChatView *view = qobject_cast<ChatView *>(ui.stackedWidget->currentWidget());
-    if(view)
-      view->scene()->selectionToClipboard();
-    return true;
-  }
-
-  // We don't want to steal cursor movement keys if the input line is in multiline mode
-  if(!inputLine->isSingleLine())
-    return false;
-
-  switch(keyEvent->key()) {
-  case Qt::Key_Up:
-  case Qt::Key_Down:
-    if(!(keyEvent->modifiers() & Qt::ShiftModifier))
-      return false;
-  case Qt::Key_PageUp:
-  case Qt::Key_PageDown:
-    // static cast to access public qobject::event
-    return static_cast<QObject*>(ui.stackedWidget->currentWidget())->event(event);
-  default:
-    return false;
-  }
+    if (view)
+        view->zoomOriginal();
+}
+
+
+void BufferWidget::addActionsToMenu(QMenu *menu, const QPointF &pos)
+{
+    Q_UNUSED(pos);
+    ActionCollection *coll = QtUi::actionCollection();
+    menu->addSeparator();
+    menu->addAction(coll->action("ZoomInChatView"));
+    menu->addAction(coll->action("ZoomOutChatView"));
+    menu->addAction(coll->action("ZoomOriginalChatView"));
+}
+
+
+bool BufferWidget::eventFilter(QObject *watched, QEvent *event)
+{
+    if (event->type() != QEvent::KeyPress)
+        return false;
+
+    QKeyEvent *keyEvent = static_cast<QKeyEvent *>(event);
+
+    MultiLineEdit *inputLine = qobject_cast<MultiLineEdit *>(watched);
+    if (!inputLine)
+        return false;
+
+    // Intercept copy key presses
+    if (keyEvent == QKeySequence::Copy) {
+        if (inputLine->hasSelectedText())
+            return false;
+        ChatView *view = qobject_cast<ChatView *>(ui.stackedWidget->currentWidget());
+        if (view)
+            view->scene()->selectionToClipboard();
+        return true;
+    }
+
+    // We don't want to steal cursor movement keys if the input line is in multiline mode
+    if (!inputLine->isSingleLine())
+        return false;
+
+    switch (keyEvent->key()) {
+    case Qt::Key_Up:
+    case Qt::Key_Down:
+        if (!(keyEvent->modifiers() & Qt::ShiftModifier))
+            return false;
+        [[fallthrough]];
+    case Qt::Key_PageUp:
+    case Qt::Key_PageDown:
+        // static cast to access public qobject::event
+        return static_cast<QObject *>(ui.stackedWidget->currentWidget())->event(event);
+    default:
+        return false;
+    }
+}
+
+
+void BufferWidget::currentChanged(const QModelIndex &current, const QModelIndex &previous)
+{
+    ChatView *prevView = qobject_cast<ChatView *>(ui.stackedWidget->currentWidget());
+
+    AbstractBufferContainer::currentChanged(current, previous); // switch first to avoid a redraw
+
+    // we need to hide the marker line if it's already/still at the bottom of the view (and not scrolled up)
+    ChatView *curView = qobject_cast<ChatView *>(ui.stackedWidget->currentWidget());
+    if (curView) {
+        BufferId curBufferId = current.data(NetworkModel::BufferIdRole).value<BufferId>();
+        if (curBufferId.isValid()) {
+            MsgId markerMsgId = Client::networkModel()->markerLineMsgId(curBufferId);
+            if (markerMsgId == curView->lastMsgId() && markerMsgId == curView->lastVisibleMsgId())
+                curView->setMarkerLineVisible(false);
+            else
+                curView->setMarkerLineVisible(true);
+        }
+    }
+
+    if (prevView && autoMarkerLine())
+        setMarkerLine(prevView, false);
+}
+
+
+void BufferWidget::setMarkerLine(ChatView *view, bool allowGoingBack)
+{
+    if (!view)
+        view = qobject_cast<ChatView *>(ui.stackedWidget->currentWidget());
+    if (!view)
+        return;
+
+    ChatLine *lastLine = view->lastVisibleChatLine();
+    if (lastLine) {
+        QModelIndex idx = lastLine->index();
+        MsgId msgId = idx.data(MessageModel::MsgIdRole).value<MsgId>();
+        BufferId bufId = view->scene()->singleBufferId();
+
+        if (!allowGoingBack) {
+            MsgId oldMsgId = Client::markerLine(bufId);
+            if (oldMsgId.isValid() && msgId <= oldMsgId)
+                return;
+        }
+        Client::setMarkerLine(bufId, msgId);
+    }
+}
+
+
+void BufferWidget::jumpToMarkerLine(ChatView *view, bool requestBacklog)
+{
+    if (!view)
+        view = qobject_cast<ChatView *>(ui.stackedWidget->currentWidget());
+    if (!view)
+        return;
+
+    view->jumpToMarkerLine(requestBacklog);
 }