qa: Avoid deprecation warnings for QList/QSet conversions
[quassel.git] / src / qtui / chatview.cpp
index f8fe6b8..132565e 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-09 by the Quassel Project                          *
+ *   Copyright (C) 2005-2019 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 "chatview.h"
+
+#include <algorithm>
+
 #include <QGraphicsTextItem>
 #include <QKeyEvent>
 #include <QMenu>
 #include <QScrollBar>
 
 #include "bufferwidget.h"
+#include "chatline.h"
 #include "chatscene.h"
-#include "chatview.h"
 #include "client.h"
+#include "clientignorelistmanager.h"
 #include "messagefilter.h"
 #include "qtui.h"
 #include "qtuistyle.h"
-#include "clientignorelistmanager.h"
+#include "util.h"
 
-ChatView::ChatView(BufferId bufferId, QWidget *parent)
-  : QGraphicsView(parent),
-    AbstractChatView(),
-    _bufferContainer(0),
-    _currentScaleFactor(1),
-    _invalidateFilter(false)
+ChatView::ChatView(BufferId bufferId, QWidget* parent)
+    : QGraphicsView(parent)
+    , AbstractChatView()
 {
-  QList<BufferId> filterList;
-  filterList.append(bufferId);
-  MessageFilter *filter = new MessageFilter(Client::messageModel(), filterList, this);
-  init(filter);
+    QList<BufferId> filterList;
+    filterList.append(bufferId);
+    auto* filter = new MessageFilter(Client::messageModel(), filterList, this);
+    init(filter);
 }
 
-ChatView::ChatView(MessageFilter *filter, QWidget *parent)
-  : QGraphicsView(parent),
-    AbstractChatView(),
-    _bufferContainer(0),
-    _currentScaleFactor(1),
-    _invalidateFilter(false)
+ChatView::ChatView(MessageFilter* filter, QWidget* parent)
+    : QGraphicsView(parent)
+    , AbstractChatView()
 {
-  init(filter);
+    init(filter);
+}
+
+void ChatView::init(MessageFilter* filter)
+{
+    _bufferContainer = nullptr;
+    _currentScaleFactor = 1;
+    _invalidateFilter = false;
+
+    setAttribute(Qt::WA_AcceptTouchEvents);
+    setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
+    setVerticalScrollBarPolicy(Qt::ScrollBarAsNeeded);
+    setAlignment(Qt::AlignLeft | Qt::AlignBottom);
+    setInteractive(true);
+    // setOptimizationFlags(QGraphicsView::DontClipPainter | QGraphicsView::DontAdjustForAntialiasing);
+    // setOptimizationFlags(QGraphicsView::DontAdjustForAntialiasing);
+    setViewportUpdateMode(QGraphicsView::BoundingRectViewportUpdate);
+    // setTransformationAnchor(QGraphicsView::NoAnchor);
+    setTransformationAnchor(QGraphicsView::AnchorViewCenter);
+
+    _scrollTimer.setInterval(100);
+    _scrollTimer.setSingleShot(true);
+    connect(&_scrollTimer, &QTimer::timeout, this, &ChatView::scrollTimerTimeout);
+
+    _scene = new ChatScene(filter, filter->idString(), viewport()->width(), this);
+    connect(_scene, &QGraphicsScene::sceneRectChanged, this, &ChatView::adjustSceneRect);
+    connect(_scene, &ChatScene::lastLineChanged, this, &ChatView::lastLineChanged);
+    connect(_scene, &ChatScene::mouseMoveWhileSelecting, this, &ChatView::mouseMoveWhileSelecting);
+    setScene(_scene);
+
+    connect(verticalScrollBar(), &QAbstractSlider::valueChanged, this, &ChatView::verticalScrollbarChanged);
+    _lastScrollbarPos = verticalScrollBar()->maximum();
+
+    connect(Client::networkModel(), &NetworkModel::markerLineSet, this, &ChatView::markerLineSet);
+
+    // only connect if client is synched with a core
+    if (Client::isConnected())
+        connect(Client::ignoreListManager(), &ClientIgnoreListManager::ignoreListChanged, this, &ChatView::invalidateFilter);
 }
 
-void ChatView::init(MessageFilter *filter) {
-  setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
-  setAlignment(Qt::AlignBottom);
-  setInteractive(true);
-  //setOptimizationFlags(QGraphicsView::DontClipPainter | QGraphicsView::DontAdjustForAntialiasing);
-  // setOptimizationFlags(QGraphicsView::DontAdjustForAntialiasing);
-  setViewportUpdateMode(QGraphicsView::BoundingRectViewportUpdate);
-  // setTransformationAnchor(QGraphicsView::NoAnchor);
-  setTransformationAnchor(QGraphicsView::AnchorViewCenter);
+bool ChatView::event(QEvent* event)
+{
+    if (event->type() == QEvent::KeyPress) {
+        auto* keyEvent = static_cast<QKeyEvent*>(event);
+        switch (keyEvent->key()) {
+        case Qt::Key_Up:
+        case Qt::Key_Down:
+        case Qt::Key_PageUp:
+        case Qt::Key_PageDown:
+            if (!verticalScrollBar()->isVisible()) {
+                scene()->requestBacklog();
+                return true;
+            }
+        default:
+            break;
+        }
+    }
+
+    if (event->type() == QEvent::TouchBegin && ((QTouchEvent*)event)->device()->type() == QTouchDevice::TouchScreen) {
+        // Enable scrolling by draging, disable selecting/clicking content
+        setDragMode(QGraphicsView::ScrollHandDrag);
+        setInteractive(false);
+        // if scrollbar is not visible we need to request backlog below else we need to accept
+        // the event now (return true) so that we will receive TouchUpdate and TouchEnd/TouchCancel
+        if (verticalScrollBar()->isVisible())
+            return true;
+    }
 
-  _scrollTimer.setInterval(100);
-  _scrollTimer.setSingleShot(true);
-  connect(&_scrollTimer, SIGNAL(timeout()), SLOT(scrollTimerTimeout()));
+    if (event->type() == QEvent::TouchEnd || event->type() == QEvent::TouchCancel) {
+        // End scroll and reset settings to default
+        setDragMode(QGraphicsView::NoDrag);
+        setInteractive(true);
+        _firstTouchUpdateHappened = false;
+        return true;
+    }
 
-  _scene = new ChatScene(filter, filter->idString(), viewport()->width() - 4, this); // see below: resizeEvent()
-  connect(_scene, SIGNAL(sceneRectChanged(const QRectF &)), this, SLOT(sceneRectChanged(const QRectF &)));
-  connect(_scene, SIGNAL(lastLineChanged(QGraphicsItem *, qreal)), this, SLOT(lastLineChanged(QGraphicsItem *, qreal)));
-  connect(_scene, SIGNAL(mouseMoveWhileSelecting(const QPointF &)), this, SLOT(mouseMoveWhileSelecting(const QPointF &)));
-  setScene(_scene);
+    if (event->type() == QEvent::TouchUpdate) {
+        if (!_firstTouchUpdateHappened) {
+            // After the first movement of a Touch-Point, calculate the distance in both axis
+            // and if the point moved more horizontally abort scroll.
+            QTouchEvent::TouchPoint p = ((QTouchEvent*)event)->touchPoints().at(0);
+            double dx = qAbs(p.lastPos().x() - p.pos().x());
+            double dy = qAbs(p.lastPos().y() - p.pos().y());
+            if (dx > dy) {
+                setDragMode(QGraphicsView::NoDrag);
+                setInteractive(true);
+            }
+            _firstTouchUpdateHappened = true;
+        }
+        // Applying the movement happens automatically by the drag-mode
+    }
+    if (event->type() == QEvent::Wheel
+        || (event->type() == QEvent::TouchBegin && ((QTouchEvent*)event)->device()->type() == QTouchDevice::TouchScreen)
+        || event->type() == QEvent::TouchUpdate) {
+        if (!verticalScrollBar()->isVisible()) {
+            scene()->requestBacklog();
+            return true;
+        }
+    }
 
-  connect(verticalScrollBar(), SIGNAL(valueChanged(int)), this, SLOT(verticalScrollbarChanged(int)));
+    if (event->type() == QEvent::Show) {
+        if (_invalidateFilter)
+            invalidateFilter();
+    }
 
-  // only connect if client is synched with a core
-  if(Client::isSynced())
-    connect(Client::ignoreListManager(), SIGNAL(ignoreListChanged()), this, SLOT(invalidateFilter()));
+    return QGraphicsView::event(event);
 }
 
-bool ChatView::event(QEvent *event) {
-  if(event->type() == QEvent::KeyPress) {
-    QKeyEvent *keyEvent = static_cast<QKeyEvent*>(event);
-    switch(keyEvent->key()) {
-    case Qt::Key_Up:
-    case Qt::Key_Down:
-    case Qt::Key_PageUp:
-    case Qt::Key_PageDown:
-      if(!verticalScrollBar()->isVisible()) {
-       scene()->requestBacklog();
-       return true;
-      }
-    default:
-      break;
+void ChatView::resizeEvent(QResizeEvent* event)
+{
+    // if view is currently scrolled to bottom, we want it that way after resizing
+    bool atBottom = (_lastScrollbarPos == verticalScrollBar()->maximum());
+
+    QGraphicsView::resizeEvent(event);
+
+    // if scrolling to bottom, do it immediately.
+    if (atBottom) {
+        // we can reduce viewport updates if we scroll to the bottom allready at the beginning
+        verticalScrollBar()->setValue(verticalScrollBar()->maximum());
     }
-  }
 
-  if(event->type() == QEvent::Wheel) {
-    if(!verticalScrollBar()->isVisible()) {
-      scene()->requestBacklog();
-      return true;
+    scene()->updateForViewport(viewport()->width(), viewport()->height());
+    adjustSceneRect();
+
+    if (atBottom) {
+        _lastScrollbarPos = verticalScrollBar()->maximum();
+        verticalScrollBar()->setValue(verticalScrollBar()->maximum());
     }
-  }
+    checkChatLineCaches();
+}
 
-  if(event->type() == QEvent::Show) {
-    if(_invalidateFilter)
-      invalidateFilter();
-  }
+void ChatView::adjustSceneRect()
+{
+    // Workaround for QTBUG-6322
+    // If the viewport's sceneRect() is (almost) as wide as as the viewport itself,
+    // Qt wants to reserve space for scrollbars even if they're turned off, resulting in
+    // an ugly white space at the bottom of the ChatView.
+    // Since the view's scene's width actually doesn't matter at all, we just adjust it
+    // by some hopefully large enough value to avoid this problem.
+
+    setSceneRect(scene()->sceneRect().adjusted(0, 0, -25, 0));
+}
 
-  return QGraphicsView::event(event);
+void ChatView::mouseMoveWhileSelecting(const QPointF& scenePos)
+{
+    int y = (int)mapFromScene(scenePos).y();
+    _scrollOffset = 0;
+    if (y < 0)
+        _scrollOffset = y;
+    else if (y > height())
+        _scrollOffset = y - height();
+
+    if (_scrollOffset && !_scrollTimer.isActive())
+        _scrollTimer.start();
 }
 
-void ChatView::resizeEvent(QResizeEvent *event) {
-  QGraphicsView::resizeEvent(event);
+void ChatView::scrollTimerTimeout()
+{
+    // scroll view
+    QAbstractSlider* vbar = verticalScrollBar();
+    if (_scrollOffset < 0 && vbar->value() > 0)
+        vbar->setValue(qMax(vbar->value() + _scrollOffset, 0));
+    else if (_scrollOffset > 0 && vbar->value() < vbar->maximum())
+        vbar->setValue(qMin(vbar->value() + _scrollOffset, vbar->maximum()));
+}
 
-  // we can reduce viewport updates if we scroll to the bottom allready at the beginning
-  verticalScrollBar()->setValue(verticalScrollBar()->maximum());
+void ChatView::lastLineChanged(QGraphicsItem* chatLine, qreal offset)
+{
+    Q_UNUSED(chatLine)
+    // disabled until further testing/discussion
+    // if(!scene()->isScrollingAllowed())
+    //  return;
+
+    QAbstractSlider* vbar = verticalScrollBar();
+    Q_ASSERT(vbar);
+    if (vbar->maximum() - vbar->value() <= (offset + 5) * _currentScaleFactor) {  // 5px grace area
+        vbar->setValue(vbar->maximum());
+    }
+}
 
-  // FIXME: without the hardcoded -4 Qt reserves space for a horizontal scrollbar even though it's disabled permanently.
-  // this does only occur on QtX11 (at least not on Qt for Mac OS). Seems like a Qt Bug.
-  scene()->updateForViewport(viewport()->width() - 4, viewport()->height());
+void ChatView::verticalScrollbarChanged(int newPos)
+{
+    QAbstractSlider* vbar = verticalScrollBar();
+    Q_ASSERT(vbar);
+
+    // check for backlog request
+    if (newPos < _lastScrollbarPos) {
+        int relativePos = 100;
+        if (vbar->maximum() - vbar->minimum() != 0)
+            relativePos = (newPos - vbar->minimum()) * 100 / (vbar->maximum() - vbar->minimum());
+
+        if (relativePos < 20) {
+            scene()->requestBacklog();
+        }
+    }
+    _lastScrollbarPos = newPos;
 
-  _lastScrollbarPos = verticalScrollBar()->maximum();
-  verticalScrollBar()->setValue(verticalScrollBar()->maximum());
+    // FIXME: Fugly workaround for the ChatView scrolling up 1px on buffer switch
+    if (vbar->maximum() - newPos <= 2)
+        vbar->setValue(vbar->maximum());
 }
 
-void ChatView::mouseMoveWhileSelecting(const QPointF &scenePos) {
-  int y = (int)mapFromScene(scenePos).y();
-  _scrollOffset = 0;
-  if(y < 0)
-    _scrollOffset = y;
-  else if(y > height())
-    _scrollOffset = y - height();
+MsgId ChatView::lastMsgId() const
+{
+    if (!scene())
+        return {};
+
+    QAbstractItemModel* model = scene()->model();
+    if (!model || model->rowCount() == 0)
+        return {};
 
-  if(_scrollOffset && !_scrollTimer.isActive())
-    _scrollTimer.start();
+    return model->index(model->rowCount() - 1, 0).data(MessageModel::MsgIdRole).value<MsgId>();
 }
 
-void ChatView::scrollTimerTimeout() {
-  // scroll view
-  QAbstractSlider *vbar = verticalScrollBar();
-  if(_scrollOffset < 0 && vbar->value() > 0)
-    vbar->setValue(qMax(vbar->value() + _scrollOffset, 0));
-  else if(_scrollOffset > 0 && vbar->value() < vbar->maximum())
-    vbar->setValue(qMin(vbar->value() + _scrollOffset, vbar->maximum()));
+MsgId ChatView::lastVisibleMsgId() const
+{
+    ChatLine* line = lastVisibleChatLine();
+
+    if (line)
+        return line->msgId();
+
+    return {};
 }
 
-void ChatView::lastLineChanged(QGraphicsItem *chatLine, qreal offset) {
-  Q_UNUSED(chatLine)
-  // disabled until further testing/discussion
-  //if(!scene()->isScrollingAllowed())
-  //  return;
+bool chatLinePtrLessThan(ChatLine* one, ChatLine* other)
+{
+    return one->row() < other->row();
+}
+
+// TODO: figure out if it's cheaper to use a cached list (that we'd need to keep updated)
+QSet<ChatLine*> ChatView::visibleChatLines(Qt::ItemSelectionMode mode) const
+{
+    QSet<ChatLine*> result;
+    foreach (QGraphicsItem* item, items(viewport()->rect().adjusted(-1, -1, 1, 1), mode)) {
+        auto* line = qgraphicsitem_cast<ChatLine*>(item);
+        if (line)
+            result.insert(line);
+    }
+    return result;
+}
 
-  QAbstractSlider *vbar = verticalScrollBar();
-  Q_ASSERT(vbar);
-  if(vbar->maximum() - vbar->value() <= (offset + 5) * _currentScaleFactor ) { // 5px grace area
-    vbar->setValue(vbar->maximum());
-  }
+QList<ChatLine*> ChatView::visibleChatLinesSorted(Qt::ItemSelectionMode mode) const
+{
+    QList<ChatLine*> result = visibleChatLines(mode).values();
+    std::sort(result.begin(), result.end(), chatLinePtrLessThan);
+    return result;
 }
 
-void ChatView::verticalScrollbarChanged(int newPos) {
-  QAbstractSlider *vbar = verticalScrollBar();
-  Q_ASSERT(vbar);
+ChatLine* ChatView::lastVisibleChatLine(bool ignoreDayChange) const
+{
+    if (!scene())
+        return nullptr;
 
-  // check for backlog request
-  if(newPos < _lastScrollbarPos) {
-    int relativePos = 100;
-    if(vbar->maximum() - vbar->minimum() != 0)
-      relativePos = (newPos - vbar->minimum()) * 100 / (vbar->maximum() - vbar->minimum());
+    QAbstractItemModel* model = scene()->model();
+    if (!model || model->rowCount() == 0)
+        return nullptr;
 
-    if(relativePos < 20) {
-      scene()->requestBacklog();
+    int row = -1;
+
+    QSet<ChatLine*> visibleLines = visibleChatLines(Qt::ContainsItemBoundingRect);
+    foreach (ChatLine* line, visibleLines) {
+        if (line->row() > row && (ignoreDayChange ? line->msgType() != Message::DayChange : true))
+            row = line->row();
     }
-  }
-  _lastScrollbarPos = newPos;
 
-  // FIXME: Fugly workaround for the ChatView scrolling up 1px on buffer switch
-  if(vbar->maximum() - newPos <= 2)
-    vbar->setValue(vbar->maximum());
+    if (row >= 0)
+        return scene()->chatLine(row);
+
+    return nullptr;
 }
 
-MsgId ChatView::lastMsgId() const {
-  if(!scene())
-    return MsgId();
+void ChatView::setMarkerLineVisible(bool visible)
+{
+    scene()->setMarkerLineVisible(visible);
+}
+
+void ChatView::setMarkerLine(MsgId msgId)
+{
+    if (!scene()->isSingleBufferScene())
+        return;
+
+    BufferId bufId = scene()->singleBufferId();
+    Client::setMarkerLine(bufId, msgId);
+}
 
-  QAbstractItemModel *model = scene()->model();
-  if(!model || model->rowCount() == 0)
-    return MsgId();
+void ChatView::markerLineSet(BufferId buffer, MsgId msgId)
+{
+    if (!scene()->isSingleBufferScene() || scene()->singleBufferId() != buffer)
+        return;
 
-  return model->data(model->index(model->rowCount() - 1, 0), MessageModel::MsgIdRole).value<MsgId>();
+    scene()->setMarkerLine(msgId);
+    scene()->setMarkerLineVisible(true);
 }
 
-void ChatView::addActionsToMenu(QMenu *menu, const QPointF &pos) {
-  // zoom actions
-  BufferWidget *bw = qobject_cast<BufferWidget *>(bufferContainer());
-  if(bw) {
-    bw->addActionsToMenu(menu, pos);
-    menu->addSeparator();
-  }
+void ChatView::jumpToMarkerLine(bool requestBacklog)
+{
+    scene()->jumpToMarkerLine(requestBacklog);
 }
 
-void ChatView::zoomIn() {
+void ChatView::addActionsToMenu(QMenu* menu, const QPointF& pos)
+{
+    // zoom actions
+    auto* bw = qobject_cast<BufferWidget*>(bufferContainer());
+    if (bw) {
+        bw->addActionsToMenu(menu, pos);
+        menu->addSeparator();
+    }
+}
+
+void ChatView::zoomIn()
+{
     _currentScaleFactor *= 1.2;
     scale(1.2, 1.2);
     scene()->setWidth(viewport()->width() / _currentScaleFactor - 2);
 }
 
-void ChatView::zoomOut() {
+void ChatView::zoomOut()
+{
     _currentScaleFactor /= 1.2;
     scale(1 / 1.2, 1 / 1.2);
     scene()->setWidth(viewport()->width() / _currentScaleFactor - 2);
 }
 
-void ChatView::zoomOriginal() {
-    scale(1/_currentScaleFactor, 1/_currentScaleFactor);
+void ChatView::zoomOriginal()
+{
+    scale(1 / _currentScaleFactor, 1 / _currentScaleFactor);
     _currentScaleFactor = 1;
     scene()->setWidth(viewport()->width() - 2);
 }
 
-void ChatView::invalidateFilter() {
-  // if this is the currently selected chatview
-  // invalidate immediately
-  if(isVisible()) {
-    _scene->filter()->invalidateFilter();
-    _invalidateFilter = false;
-  }
-  // otherwise invalidate whenever the view is shown
-  else {
-    _invalidateFilter = true;
-  }
+void ChatView::invalidateFilter()
+{
+    // if this is the currently selected chatview
+    // invalidate immediately
+    if (isVisible()) {
+        _scene->filter()->invalidateFilter();
+        _invalidateFilter = false;
+    }
+    // otherwise invalidate whenever the view is shown
+    else {
+        _invalidateFilter = true;
+    }
+}
+
+void ChatView::scrollContentsBy(int dx, int dy)
+{
+    QGraphicsView::scrollContentsBy(dx, dy);
+    checkChatLineCaches();
+}
+
+void ChatView::setHasCache(ChatLine* line, bool hasCache)
+{
+    if (hasCache)
+        _linesWithCache.insert(line);
+    else
+        _linesWithCache.remove(line);
+}
+
+void ChatView::checkChatLineCaches()
+{
+    qreal top = mapToScene(viewport()->rect().topLeft()).y() - 10;  // some grace area to avoid premature cleaning
+    qreal bottom = mapToScene(viewport()->rect().bottomRight()).y() + 10;
+    QSet<ChatLine*>::iterator iter = _linesWithCache.begin();
+    while (iter != _linesWithCache.end()) {
+        ChatLine* line = *iter;
+        if (line->pos().y() + line->height() < top || line->pos().y() > bottom) {
+            line->clearCache();
+            iter = _linesWithCache.erase(iter);
+        }
+        else
+            ++iter;
+    }
 }