1
0
mirror of https://github.com/qTox/qTox.git synced 2024-03-22 14:00:36 +08:00
qTox/src/chatlog/chatlog.cpp

782 lines
19 KiB
C++

/*
Copyright (C) 2014 by Project Tox <https://tox.im>
This file is part of qTox, a Qt-based graphical interface for Tox.
This program is libre 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 3 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 COPYING file for more details.
*/
#include "chatlog.h"
#include "chatmessage.h"
#include "chatlinecontent.h"
#include <QDebug>
#include <QScrollBar>
#include <QApplication>
#include <QClipboard>
#include <QAction>
#include <QTimer>
#include <QMouseEvent>
template<class T>
T clamp(T x, T min, T max)
{
if(x > max)
return max;
if(x < min)
return min;
return x;
}
ChatLog::ChatLog(QWidget* parent)
: QGraphicsView(parent)
{
// Create the scene
busyScene = new QGraphicsScene(this);
scene = new QGraphicsScene(this);
scene->setItemIndexMethod(QGraphicsScene::BspTreeIndex);
setScene(scene);
// Cfg.
setInteractive(true);
setAcceptDrops(false);
setAlignment(Qt::AlignTop | Qt::AlignLeft);
setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
setDragMode(QGraphicsView::NoDrag);
setViewportUpdateMode(MinimalViewportUpdate);
setContextMenuPolicy(Qt::CustomContextMenu);
setBackgroundBrush(QBrush(Qt::white, Qt::SolidPattern));
// The selection rect for multi-line selection
selGraphItem = scene->addRect(0,0,0,0,selectionRectColor.darker(120),selectionRectColor);
selGraphItem->setZValue(-1.0); // behind all other items
// copy action (ie. Ctrl+C)
copyAction = new QAction(this);
copyAction->setIcon(QIcon::fromTheme("edit-copy"));
copyAction->setText(tr("Copy"));
copyAction->setShortcut(QKeySequence::Copy);
copyAction->setEnabled(false);
connect(copyAction, &QAction::triggered, this, [this](bool) { copySelectedText(); });
addAction(copyAction);
// select all action (ie. Ctrl+A)
QAction* selectAllAction = new QAction(this);
selectAllAction->setIcon(QIcon::fromTheme("edit-select-all"));
selectAllAction->setText(tr("Select all"));
selectAllAction->setShortcut(QKeySequence::SelectAll);
connect(selectAllAction, &QAction::triggered, this, [this](bool) { selectAll(); });
addAction(selectAllAction);
// This timer is used to scroll the view while the user is
// moving the mouse past the top/bottom edge of the widget while selecting.
selectionTimer = new QTimer(this);
selectionTimer->setInterval(1000/30);
selectionTimer->setSingleShot(false);
selectionTimer->start();
connect(selectionTimer, &QTimer::timeout, this, &ChatLog::onSelectionTimerTimeout);
// Background worker
// Updates the layout of all chat-lines after a resize
workerTimer = new QTimer(this);
workerTimer->setSingleShot(false);
workerTimer->setInterval(5);
connect(workerTimer, &QTimer::timeout, this, &ChatLog::onWorkerTimeout);
}
void ChatLog::clearSelection()
{
if(selectionMode == None)
return;
for(int i=selFirstRow; i<=selLastRow; ++i)
lines[i]->selectionCleared();
selFirstRow = -1;
selLastRow = -1;
selClickedCol = -1;
selClickedRow = -1;
selectionMode = None;
copyAction->setEnabled(false);
updateMultiSelectionRect();
}
QRect ChatLog::getVisibleRect() const
{
return mapToScene(viewport()->rect()).boundingRect().toRect();
}
void ChatLog::updateSceneRect()
{
setSceneRect(calculateSceneRect());
}
void ChatLog::layout(int start, int end, qreal width)
{
if(lines.empty())
return;
qreal h = 0.0;
// Line at start-1 is considered to have the correct position. All following lines are
// positioned in respect to this line.
if(start - 1 >= 0)
h = lines[start - 1]->sceneBoundingRect().bottom() + lineSpacing;
start = clamp<int>(start, 0, lines.size());
end = clamp<int>(end + 1, 0, lines.size());
for(int i = start; i < end; ++i)
{
ChatLine* l = lines[i].get();
l->layout(width, QPointF(0.0, h));
h += l->sceneBoundingRect().height() + lineSpacing;
}
}
void ChatLog::mousePressEvent(QMouseEvent* ev)
{
QGraphicsView::mousePressEvent(ev);
QPointF scenePos = mapToScene(ev->pos());
if(ev->button() == Qt::LeftButton)
{
clickPos = ev->pos();
clearSelection();
}
if(ev->button() == Qt::RightButton)
{
if(!isOverSelection(scenePos))
clearSelection();
}
}
void ChatLog::mouseReleaseEvent(QMouseEvent* ev)
{
QGraphicsView::mouseReleaseEvent(ev);
QPointF scenePos = mapToScene(ev->pos());
if(ev->button() == Qt::RightButton)
{
if(!isOverSelection(scenePos))
clearSelection();
emit customContextMenuRequested(ev->pos());
}
selectionScrollDir = NoDirection;
}
void ChatLog::mouseMoveEvent(QMouseEvent* ev)
{
QGraphicsView::mouseMoveEvent(ev);
QPointF scenePos = mapToScene(ev->pos());
if(ev->buttons() & Qt::LeftButton)
{
//autoscroll
if(ev->pos().y() < 0)
selectionScrollDir = Up;
else if(ev->pos().y() > height())
selectionScrollDir = Down;
else
selectionScrollDir = NoDirection;
//select
if(selectionMode == None && (clickPos - ev->pos()).manhattanLength() > QApplication::startDragDistance())
{
QPointF sceneClickPos = mapToScene(clickPos.toPoint());
ChatLine::Ptr line = findLineByPosY(scenePos.y());
ChatLineContent* content = getContentFromPos(sceneClickPos);
if(content)
{
selClickedRow = content->getRow();
selClickedCol = content->getColumn();
selFirstRow = content->getRow();
selLastRow = content->getRow();
content->selectionStarted(sceneClickPos);
selectionMode = Precise;
copyAction->setEnabled(true);
// ungrab mouse grabber
if(scene->mouseGrabberItem())
scene->mouseGrabberItem()->ungrabMouse();
}
else if(line.get())
{
selClickedRow = line->getRow();
selFirstRow = selClickedRow;
selLastRow = selClickedRow;
selectionMode = Multi;
copyAction->setEnabled(true);
}
}
if(selectionMode != None)
{
ChatLineContent* content = getContentFromPos(scenePos);
ChatLine::Ptr line = findLineByPosY(scenePos.y());
if(!content && !line.get())
return;
int row;
if(content)
{
row = content->getRow();
int col = content->getColumn();
if(row == selClickedRow && col == selClickedCol)
{
selectionMode = Precise;
content->selectionMouseMove(scenePos);
selGraphItem->hide();
}
else if(col != selClickedCol)
{
selectionMode = Multi;
lines[selClickedRow]->selectionCleared();
}
}
else if(line.get())
{
row = line->getRow();
if(row != selClickedRow)
{
selectionMode = Multi;
lines[selClickedRow]->selectionCleared();
}
}
if(row >= selClickedRow)
selLastRow = row;
if(row <= selClickedRow)
selFirstRow = row;
updateMultiSelectionRect();
}
}
}
//Much faster than QGraphicsScene::itemAt()!
ChatLineContent* ChatLog::getContentFromPos(QPointF scenePos) const
{
if(lines.empty())
return nullptr;
auto itr = std::lower_bound(lines.cbegin(), lines.cend(), scenePos.y(), ChatLine::lessThanBSRectBottom);
//find content
if(itr != lines.cend() && (*itr)->sceneBoundingRect().contains(scenePos))
return (*itr)->getContent(scenePos);
return nullptr;
}
bool ChatLog::isOverSelection(QPointF scenePos) const
{
if(selectionMode == Precise)
{
ChatLineContent* content = getContentFromPos(scenePos);
if(content)
return content->isOverSelection(scenePos);
}
else if(selectionMode == Multi)
{
if(selGraphItem->rect().contains(scenePos))
return true;
}
return false;
}
qreal ChatLog::useableWidth() const
{
return width() - verticalScrollBar()->sizeHint().width() - margins.right() - margins.left();
}
void ChatLog::reposition(int start, int end, qreal deltaY)
{
if(lines.isEmpty())
return;
start = clamp<int>(start, 0, lines.size() - 1);
end = clamp<int>(end + 1, 0, lines.size());
for(int i = start; i < end; ++i)
{
ChatLine* l = lines[i].get();
l->moveBy(deltaY);
}
}
void ChatLog::insertChatlineAtBottom(ChatLine::Ptr l)
{
if(!l.get())
return;
bool stickToBtm = stickToBottom();
//insert
l->setRow(lines.size());
l->addToScene(scene);
lines.append(l);
//partial refresh
layout(lines.last()->getRow(), lines.size(), useableWidth());
updateSceneRect();
if(stickToBtm)
scrollToBottom();
checkVisibility();
updateTypingNotification();
}
void ChatLog::insertChatlineOnTop(ChatLine::Ptr l)
{
if(!l.get())
return;
insertChatlineOnTop(QList<ChatLine::Ptr>() << l);
}
void ChatLog::insertChatlineOnTop(const QList<ChatLine::Ptr>& newLines)
{
if(newLines.isEmpty())
return;
// move all lines down by n
int n = newLines.size();
for(ChatLine::Ptr l : lines)
l->setRow(l->getRow() + n);
// add the new line
for(ChatLine::Ptr l : newLines)
{
l->addToScene(scene);
l->setRow(--n);
l->visibilityChanged(false);
lines.prepend(l);
}
// redo layout
startResizeWorker();
}
bool ChatLog::stickToBottom() const
{
return verticalScrollBar()->value() == verticalScrollBar()->maximum();
}
void ChatLog::scrollToBottom()
{
updateSceneRect();
verticalScrollBar()->setValue(verticalScrollBar()->maximum());
}
void ChatLog::startResizeWorker()
{
if(lines.empty())
return;
// (re)start the worker
if(!workerTimer->isActive())
{
// these values must not be reevaluated while the worker is running
workerStb = stickToBottom();
if(!visibleLines.empty())
workerAnchorLine = visibleLines.first();
}
workerLastIndex = 0;
workerTimer->start();
// switch to busy scene displaying the busy notification
setScene(busyScene);
verticalScrollBar()->hide();
}
void ChatLog::mouseDoubleClickEvent(QMouseEvent *ev)
{
QPointF scenePos = mapToScene(ev->pos());
ChatLineContent* content = getContentFromPos(scenePos);
if(content)
{
content->selectionDoubleClick(scenePos);
selClickedCol = content->getColumn();
selClickedRow = content->getRow();
selFirstRow = content->getRow();
selLastRow = content->getRow();
selectionMode = Precise;
}
}
QString ChatLog::getSelectedText() const
{
if(selectionMode == Precise)
{
return lines[selClickedRow]->content[selClickedCol]->getSelectedText();
}
else if(selectionMode == Multi)
{
// build a nicely formatted message
QString out;
QString lastSender;
for(int i=selFirstRow; i<=selLastRow; ++i)
{
if(lines[i]->content[1]->getText().isEmpty())
continue;
if(lastSender != lines[i]->content[0]->getText() && !lines[i]->content[0]->getText().isEmpty())
{
//author changed
out += QString(out.isEmpty() ? "%1:\n" : "\n%1:\n").arg(lines[i]->content[0]->getText());
lastSender = lines[i]->content[0]->getText();
}
out += lines[i]->content[1]->getText();
if(i != selLastRow)
out += "\n";
}
return out;
}
return QString();
}
bool ChatLog::isEmpty() const
{
return lines.isEmpty();
}
bool ChatLog::hasTextToBeCopied() const
{
return selectionMode != None;
}
ChatLine::Ptr ChatLog::getTypingNotification() const
{
return typingNotification;
}
QVector<ChatLine::Ptr> ChatLog::getLines()
{
return lines;
}
void ChatLog::clear()
{
clearSelection();
for(ChatLine::Ptr l : lines)
l->removeFromScene();
lines.clear();
visibleLines.clear();
updateSceneRect();
}
void ChatLog::copySelectedText() const
{
QString text = getSelectedText();
QClipboard* clipboard = QApplication::clipboard();
clipboard->setText(text);
}
void ChatLog::setBusyNotification(ChatLine::Ptr notification)
{
if(!notification.get())
return;
busyNotification = notification;
busyNotification->addToScene(busyScene);
busyNotification->visibilityChanged(true);
}
void ChatLog::setTypingNotification(ChatLine::Ptr notification)
{
typingNotification = notification;
typingNotification->visibilityChanged(true);
typingNotification->setVisible(false);
typingNotification->addToScene(scene);
updateTypingNotification();
}
void ChatLog::setTypingNotificationVisible(bool visible)
{
if(typingNotification.get())
{
typingNotification->setVisible(visible);
updateTypingNotification();
}
}
void ChatLog::scrollToLine(ChatLine::Ptr line)
{
if(!line.get())
return;
updateSceneRect();
verticalScrollBar()->setValue(line->sceneBoundingRect().top());
}
void ChatLog::selectAll()
{
if(lines.empty())
return;
clearSelection();
selectionMode = Multi;
selFirstRow = 0;
selLastRow = lines.size()-1;
copyAction->setEnabled(true);
updateMultiSelectionRect();
}
void ChatLog::checkVisibility()
{
if(lines.empty())
return;
// find first visible line
auto lowerBound = std::lower_bound(lines.cbegin(), lines.cend(), getVisibleRect().top(), ChatLine::lessThanBSRectBottom);
// find last visible line
auto upperBound = std::lower_bound(lowerBound, lines.cend(), getVisibleRect().bottom(), ChatLine::lessThanBSRectTop);
// set visibilty
QList<ChatLine::Ptr> newVisibleLines;
for(auto itr = lowerBound; itr != upperBound; ++itr)
{
newVisibleLines.append(*itr);
if(!visibleLines.contains(*itr))
(*itr)->visibilityChanged(true);
visibleLines.removeOne(*itr);
}
// these lines are no longer visible
for(ChatLine::Ptr line : visibleLines)
line->visibilityChanged(false);
visibleLines = newVisibleLines;
// enforce order
std::sort(visibleLines.begin(), visibleLines.end(), ChatLine::lessThanRowIndex);
//if(!visibleLines.empty())
// qDebug() << "visible from " << visibleLines.first()->getRowIndex() << "to " << visibleLines.last()->getRowIndex() << " total " << visibleLines.size();
}
void ChatLog::scrollContentsBy(int dx, int dy)
{
QGraphicsView::scrollContentsBy(dx, dy);
checkVisibility();
}
void ChatLog::resizeEvent(QResizeEvent* ev)
{
bool stb = stickToBottom();
if(ev->size().width() != ev->oldSize().width())
{
startResizeWorker();
stb = false; // let the resize worker handle it
}
QGraphicsView::resizeEvent(ev);
if(stb)
scrollToBottom();
updateBusyNotification();
}
void ChatLog::updateMultiSelectionRect()
{
if(selectionMode == Multi && selFirstRow >= 0 && selLastRow >= 0)
{
QRectF selBBox;
selBBox = selBBox.united(lines[selFirstRow]->sceneBoundingRect());
selBBox = selBBox.united(lines[selLastRow]->sceneBoundingRect());
if(selGraphItem->rect() != selBBox)
scene->invalidate(selGraphItem->rect());
selGraphItem->setRect(selBBox);
selGraphItem->show();
}
else
{
selGraphItem->hide();
}
}
void ChatLog::updateTypingNotification()
{
ChatLine* notification = typingNotification.get();
if(!notification)
return;
qreal posY = 0.0;
if(!lines.empty())
posY = lines.last()->sceneBoundingRect().bottom() + lineSpacing;
notification->layout(useableWidth(), QPointF(0.0, posY));
}
void ChatLog::updateBusyNotification()
{
if(busyNotification.get())
{
//repoisition the busy notification (centered)
busyNotification->layout(useableWidth(), getVisibleRect().topLeft() + QPointF(0, getVisibleRect().height()/2.0));
}
}
ChatLine::Ptr ChatLog::findLineByPosY(qreal yPos) const
{
auto itr = std::lower_bound(lines.cbegin(), lines.cend(), yPos, ChatLine::lessThanBSRectBottom);
if(itr != lines.cend())
return *itr;
return ChatLine::Ptr();
}
QRectF ChatLog::calculateSceneRect() const
{
qreal bottom = (lines.empty() ? 0.0 : lines.last()->sceneBoundingRect().bottom());
if(typingNotification.get() != nullptr)
bottom += typingNotification->sceneBoundingRect().height() + lineSpacing;
return QRectF(-margins.left(), -margins.top(), useableWidth(), bottom + margins.bottom() + margins.top());
}
void ChatLog::onSelectionTimerTimeout()
{
const int scrollSpeed = 10;
switch(selectionScrollDir)
{
case Up:
verticalScrollBar()->setValue(verticalScrollBar()->value() - scrollSpeed);
break;
case Down:
verticalScrollBar()->setValue(verticalScrollBar()->value() + scrollSpeed);
break;
default:
break;
}
}
void ChatLog::onWorkerTimeout()
{
// Fairly arbitrary but
// large values will make the UI unresponsive
const int stepSize = 50;
layout(workerLastIndex, workerLastIndex+stepSize, useableWidth());
workerLastIndex += stepSize;
// done?
if(workerLastIndex >= lines.size())
{
workerTimer->stop();
// switch back to the scene containing the chat messages
setScene(scene);
// make sure everything gets updated
updateSceneRect();
checkVisibility();
updateTypingNotification();
updateMultiSelectionRect();
// scroll
if(workerStb)
scrollToBottom();
else
scrollToLine(workerAnchorLine);
// don't keep a Ptr to the anchor line
workerAnchorLine = ChatLine::Ptr();
// hidden during busy screen
verticalScrollBar()->show();
}
}
void ChatLog::showEvent(QShowEvent*)
{
// Empty.
// The default implementation calls centerOn - for some reason - causing
// the scrollbar to move.
}
void ChatLog::focusInEvent(QFocusEvent* ev)
{
QGraphicsView::focusInEvent(ev);
if(selectionMode != None)
{
selGraphItem->setBrush(QBrush(selectionRectColor));
for(int i=selFirstRow; i<=selLastRow; ++i)
lines[i]->selectionFocusChanged(true);
}
}
void ChatLog::focusOutEvent(QFocusEvent* ev)
{
QGraphicsView::focusOutEvent(ev);
if(selectionMode != None)
{
selGraphItem->setBrush(QBrush(selectionRectColor.lighter(120)));
for(int i=selFirstRow; i<=selLastRow; ++i)
lines[i]->selectionFocusChanged(false);
}
}