ChatScene speed improvement. This might even fix the dreaded CPU bug!
[quassel.git] / src / qtui / chatitem.cpp
1 /***************************************************************************
2  *   Copyright (C) 2005-08 by the Quassel Project                          *
3  *   devel@quassel-irc.org                                                 *
4  *                                                                         *
5  *   This program is free software; you can redistribute it and/or modify  *
6  *   it under the terms of the GNU General Public License as published by  *
7  *   the Free Software Foundation; either version 2 of the License, or     *
8  *   (at your option) version 3.                                           *
9  *                                                                         *
10  *   This program is distributed in the hope that it will be useful,       *
11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
13  *   GNU General Public License for more details.                          *
14  *                                                                         *
15  *   You should have received a copy of the GNU General Public License     *
16  *   along with this program; if not, write to the                         *
17  *   Free Software Foundation, Inc.,                                       *
18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
19  ***************************************************************************/
20
21 #include <QApplication>
22 #include <QClipboard>
23 #include <QDesktopServices>
24 #include <QFontMetrics>
25 #include <QGraphicsSceneMouseEvent>
26 #include <QPainter>
27 #include <QPalette>
28 #include <QTextLayout>
29
30 #include "chatitem.h"
31 #include "chatlinemodel.h"
32 #include "qtui.h"
33
34 ChatItem::ChatItem(ChatLineModel::ColumnType col, QAbstractItemModel *model, QGraphicsItem *parent)
35   : QGraphicsItem(parent),
36     _fontMetrics(0),
37     _selectionMode(NoSelection),
38     _selectionStart(-1),
39     _layout(0)
40 {
41   Q_ASSERT(model);
42   QModelIndex index = model->index(row(), col);
43   _fontMetrics = QtUi::style()->fontMetrics(model->data(index, ChatLineModel::FormatRole).value<UiStyle::FormatList>().at(0).second);
44   setAcceptHoverEvents(true);
45   setZValue(20);
46 }
47
48 ChatItem::~ChatItem() {
49   delete _layout;
50 }
51
52 QVariant ChatItem::data(int role) const {
53   QModelIndex index = model()->index(row(), column());
54   if(!index.isValid()) {
55     qWarning() << "ChatItem::data(): model index is invalid!" << index;
56     return QVariant();
57   }
58   return model()->data(index, role);
59 }
60
61 qreal ChatItem::setGeometry(qreal w, qreal h) {
62   if(w == _boundingRect.width()) return _boundingRect.height();
63   prepareGeometryChange();
64   _boundingRect.setWidth(w);
65   if(h < 0) h = computeHeight();
66   //if(h < 0) h = fontMetrics()->lineSpacing(); // only contents can be multi-line
67   _boundingRect.setHeight(h);
68   if(haveLayout()) updateLayout();
69   return h;
70 }
71
72 qreal ChatItem::computeHeight() {
73   return fontMetrics()->lineSpacing(); // only contents can be multi-line
74 }
75
76 QTextLayout *ChatItem::createLayout(QTextOption::WrapMode wrapMode, Qt::Alignment alignment) {
77   QTextLayout *layout = new QTextLayout(data(MessageModel::DisplayRole).toString());
78
79   QTextOption option;
80   option.setWrapMode(wrapMode);
81   option.setAlignment(alignment);
82   layout->setTextOption(option);
83
84   QList<QTextLayout::FormatRange> formatRanges
85          = QtUi::style()->toTextLayoutList(data(MessageModel::FormatRole).value<UiStyle::FormatList>(), layout->text().length());
86   layout->setAdditionalFormats(formatRanges);
87   return layout;
88 }
89
90 void ChatItem::updateLayout() {
91   if(!haveLayout())
92     setLayout(createLayout(QTextOption::WrapAnywhere, Qt::AlignLeft));
93
94   layout()->beginLayout();
95   QTextLine line = layout()->createLine();
96   if(line.isValid()) {
97     line.setLineWidth(width());
98     line.setPosition(QPointF(0,0));
99   }
100   layout()->endLayout();
101 }
102
103 void ChatItem::clearLayout() {
104   delete _layout;
105   _layout = 0;
106 }
107
108 // NOTE: This is not the most time-efficient implementation, but it saves space by not caching unnecessary data
109 //       This is a deliberate trade-off. (-> selectFmt creation, data() call)
110 void ChatItem::paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget) {
111   Q_UNUSED(option); Q_UNUSED(widget);
112   if(!haveLayout()) updateLayout();
113   painter->setClipRect(boundingRect()); // no idea why QGraphicsItem clipping won't work
114   //if(_selectionMode == FullSelection) {
115     //painter->save();
116     //painter->fillRect(boundingRect(), QApplication::palette().brush(QPalette::Highlight));
117     //painter->restore();
118   //}
119   QVector<QTextLayout::FormatRange> formats;
120   if(_selectionMode != NoSelection) {
121     QTextLayout::FormatRange selectFmt;
122     selectFmt.format.setForeground(QApplication::palette().brush(QPalette::HighlightedText));
123     selectFmt.format.setBackground(QApplication::palette().brush(QPalette::Highlight));
124     if(_selectionMode == PartialSelection) {
125       selectFmt.start = qMin(_selectionStart, _selectionEnd);
126       selectFmt.length = qAbs(_selectionStart - _selectionEnd);
127     } else { // FullSelection
128       selectFmt.start = 0;
129       selectFmt.length = data(MessageModel::DisplayRole).toString().length();
130     }
131     formats.append(selectFmt);
132   }
133   layout()->draw(painter, QPointF(0,0), formats, boundingRect());
134 }
135
136 qint16 ChatItem::posToCursor(const QPointF &pos) {
137   if(pos.y() > height()) return data(MessageModel::DisplayRole).toString().length();
138   if(pos.y() < 0) return 0;
139   if(!haveLayout()) updateLayout();
140   for(int l = layout()->lineCount() - 1; l >= 0; l--) {
141     QTextLine line = layout()->lineAt(l);
142     if(pos.y() >= line.y()) {
143       return line.xToCursor(pos.x(), QTextLine::CursorOnCharacter);
144     }
145   }
146   return 0;
147 }
148
149 void ChatItem::setFullSelection() {
150   if(_selectionMode != FullSelection) {
151     _selectionMode = FullSelection;
152     update();
153   }
154 }
155
156 void ChatItem::clearSelection() {
157   _selectionMode = NoSelection;
158   update();
159 }
160
161 void ChatItem::continueSelecting(const QPointF &pos) {
162   _selectionMode = PartialSelection;
163   _selectionEnd = posToCursor(pos);
164   update();
165 }
166
167 QList<QRectF> ChatItem::findWords(const QString &searchWord, Qt::CaseSensitivity caseSensitive) {
168   QList<QRectF> resultList;
169   const QAbstractItemModel *model_ = model();
170   if(!model_)
171     return resultList;
172
173   QString plainText = model_->data(model_->index(row(), column()), MessageModel::DisplayRole).toString();
174   QList<int> indexList;
175   int searchIdx = plainText.indexOf(searchWord, 0, caseSensitive);
176   while(searchIdx != -1) {
177     indexList << searchIdx;
178     searchIdx = plainText.indexOf(searchWord, searchIdx + 1, caseSensitive);
179   }
180
181   if(!haveLayout())
182     updateLayout();
183
184   foreach(int idx, indexList) {
185     QTextLine line = layout()->lineForTextPosition(idx);
186     qreal x = line.cursorToX(idx);
187     qreal width = line.cursorToX(idx + searchWord.count()) - x;
188     qreal height = fontMetrics()->lineSpacing();
189     qreal y = height * line.lineNumber();
190     resultList << QRectF(x, y, width, height);
191   }
192   return resultList;
193 }
194
195 void ChatItem::mousePressEvent(QGraphicsSceneMouseEvent *event) {
196   if(event->buttons() == Qt::LeftButton) {
197     chatScene()->setSelectingItem(this);
198     _selectionStart = _selectionEnd = posToCursor(event->pos());
199     _selectionMode = NoSelection; // will be set to PartialSelection by mouseMoveEvent
200     update();
201     event->accept();
202   } else {
203     event->ignore();
204   }
205 }
206
207 void ChatItem::mouseMoveEvent(QGraphicsSceneMouseEvent *event) {
208   if(event->buttons() == Qt::LeftButton) {
209     if(contains(event->pos())) {
210       qint16 end = posToCursor(event->pos());
211       if(end != _selectionEnd) {
212         _selectionEnd = end;
213         _selectionMode = (_selectionStart != _selectionEnd ? PartialSelection : NoSelection);
214         update();
215       }
216     } else {
217       setFullSelection();
218       chatScene()->startGlobalSelection(this, event->pos());
219     }
220     event->accept();
221   } else {
222     event->ignore();
223   }
224 }
225
226 void ChatItem::mouseReleaseEvent(QGraphicsSceneMouseEvent *event) {
227   if(_selectionMode != NoSelection && !event->buttons() & Qt::LeftButton) {
228     _selectionEnd = posToCursor(event->pos());
229     QString selection
230         = data(MessageModel::DisplayRole).toString().mid(qMin(_selectionStart, _selectionEnd), qAbs(_selectionStart - _selectionEnd));
231     chatScene()->putToClipboard(selection);
232     event->accept();
233   } else {
234     event->ignore();
235   }
236 }
237
238 /*************************************************************************************************/
239
240 /*************************************************************************************************/
241
242 void SenderChatItem::updateLayout() {
243   if(!haveLayout()) setLayout(createLayout(QTextOption::WrapAnywhere, Qt::AlignRight));
244   ChatItem::updateLayout();
245 }
246
247 /*************************************************************************************************/
248
249 ContentsChatItem::ContentsChatItem(QAbstractItemModel *model, QGraphicsItem *parent) : ChatItem(column(), model, parent),
250   _layoutData(0)
251 {
252
253 }
254
255 ContentsChatItem::~ContentsChatItem() {
256   delete _layoutData;
257 }
258
259 qreal ContentsChatItem::computeHeight() {
260   int lines = 1;
261   WrapColumnFinder finder(this);
262   while(finder.nextWrapColumn() > 0) lines++;
263   return lines * fontMetrics()->lineSpacing();
264 }
265
266 void ContentsChatItem::setLayout(QTextLayout *layout) {
267   if(!_layoutData)
268     _layoutData = new LayoutData;
269   _layoutData->layout = layout;
270 }
271
272 void ContentsChatItem::clearLayout() {
273   delete _layoutData;
274   _layoutData = 0;
275 }
276
277 void ContentsChatItem::updateLayout() {
278   if(!haveLayout()) setLayout(createLayout(QTextOption::WrapAnywhere));
279
280   // Now layout
281   ChatLineModel::WrapList wrapList = data(ChatLineModel::WrapListRole).value<ChatLineModel::WrapList>();
282   if(!wrapList.count()) return; // empty chatitem
283
284   qreal h = 0;
285   WrapColumnFinder finder(this);
286   layout()->beginLayout();
287   forever {
288     QTextLine line = layout()->createLine();
289     if(!line.isValid())
290       break;
291
292     int col = finder.nextWrapColumn();
293     line.setNumColumns(col >= 0 ? col - line.textStart() : layout()->text().length());
294     line.setPosition(QPointF(0, h));
295     h += line.height() + fontMetrics()->leading();
296   }
297   layout()->endLayout();
298 }
299
300 void ContentsChatItem::mouseDoubleClickEvent(QGraphicsSceneMouseEvent *event) {
301   // FIXME dirty and fast hack to make http:// urls klickable
302
303   QRegExp regex("\\b([hf]t{1,2}ps?://[^\\s]+)\\b");
304   QString str = data(ChatLineModel::DisplayRole).toString();
305   int idx = posToCursor(event->pos());
306   int mi = 0;
307   do {
308     mi = regex.indexIn(str, mi);
309     if(mi < 0) break;
310     if(idx >= mi && idx < mi + regex.matchedLength()) {
311       QDesktopServices::openUrl(QUrl(regex.capturedTexts()[1]));
312       break;
313     }
314     mi += regex.matchedLength();
315   } while(mi >= 0);
316   event->accept();
317 }
318
319 void ContentsChatItem::hoverEnterEvent(QGraphicsSceneHoverEvent *event) {
320   //qDebug() << (void*)this << "entering";
321   event->ignore();
322 }
323
324 void ContentsChatItem::hoverLeaveEvent(QGraphicsSceneHoverEvent *event) {
325   //qDebug() << (void*)this << "leaving";
326   event->ignore();
327 }
328
329 void ContentsChatItem::hoverMoveEvent(QGraphicsSceneHoverEvent *event) {
330   //qDebug() << (void*)this << event->pos();
331   event->ignore();
332 }
333
334 /*************************************************************************************************/
335
336 ContentsChatItem::WrapColumnFinder::WrapColumnFinder(ChatItem *_item)
337   : item(_item),
338     layout(0),
339     wrapList(item->data(ChatLineModel::WrapListRole).value<ChatLineModel::WrapList>()),
340     wordidx(0),
341     lastwrapcol(0),
342     lastwrappos(0),
343     w(0)
344 {
345 }
346
347 ContentsChatItem::WrapColumnFinder::~WrapColumnFinder() {
348   delete layout;
349 }
350
351 qint16 ContentsChatItem::WrapColumnFinder::nextWrapColumn() {
352   while(wordidx < wrapList.count()) {
353     w += wrapList.at(wordidx).width;
354     if(w >= item->width()) {
355       if(lastwrapcol >= wrapList.at(wordidx).start) {
356         // first word, and it doesn't fit
357         if(!line.isValid()) {
358           layout = item->createLayout(QTextOption::NoWrap);
359           layout->beginLayout();
360           line = layout->createLine();
361           line.setLineWidth(item->width());
362           layout->endLayout();
363         }
364         int idx = line.xToCursor(lastwrappos + item->width(), QTextLine::CursorOnCharacter);
365         qreal x = line.cursorToX(idx, QTextLine::Trailing);
366         w = w - wrapList.at(wordidx).width - (x - lastwrappos);
367         lastwrappos = x;
368         lastwrapcol = idx;
369         return idx;
370       }
371       // not the first word, so just wrap before this
372       lastwrapcol = wrapList.at(wordidx).start;
373       lastwrappos = lastwrappos + w - wrapList.at(wordidx).width;
374       w = 0;
375       return lastwrapcol;
376     }
377     w += wrapList.at(wordidx).trailing;
378     wordidx++;
379   }
380   return -1;
381 }