1 /***************************************************************************
2 * Copyright (C) 2005-2020 by the Quassel Project *
3 * devel@quassel-irc.org *
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. *
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. *
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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
21 #include "chatlinemodelitem.h"
23 #include <QFontMetrics>
24 #include <QTextBoundaryFinder>
26 #include "chatlinemodel.h"
28 #include "qtuistyle.h"
30 // This Struct is taken from Harfbuzz. We use it only to calc it's size.
31 // we use a shared memory region so we do not have to malloc a buffer area for every line
32 using HB_CharAttributes_Dummy = struct
34 /*HB_LineBreakType*/ unsigned lineBreakType : 2;
35 /*HB_Bool*/ unsigned whiteSpace : 1; /* A unicode whitespace character, except NBSP, ZWNBSP */
36 /*HB_Bool*/ unsigned charStop : 1; /* Valid cursor position (for left/right arrow) */
37 /*HB_Bool*/ unsigned wordBoundary : 1;
38 /*HB_Bool*/ unsigned sentenceBoundary : 1;
42 unsigned char* ChatLineModelItem::TextBoundaryFinderBuffer = (unsigned char*)malloc(512 * sizeof(HB_CharAttributes_Dummy));
43 int ChatLineModelItem::TextBoundaryFinderBufferSize = 512 * (sizeof(HB_CharAttributes_Dummy) / sizeof(unsigned char));
45 // ****************************************
46 // the actual ChatLineModelItem
47 // ****************************************
48 ChatLineModelItem::ChatLineModelItem(const Message& msg)
52 if (!msg.sender().contains('!'))
53 _styledMsg.setFlags(msg.flags() |= Message::ServerMsg);
55 if (_styledMsg.type() == Message::Nick) {
56 // HACK: Work around nick changes on Quassel core not properly being set as Self
57 // While this is fixed in the core, old cores and past history will still show incorrectly.
58 if (nickFromMask(_styledMsg.sender()) == stripFormatCodes(_styledMsg.contents()).toLower()) {
59 _styledMsg.setFlags(msg.flags() |= Message::Self);
62 // Unfortunately, the missing Self flag for other message types can't easily be worked around.
65 bool ChatLineModelItem::setData(int column, const QVariant& value, int role)
68 case MessageModel::FlagsRole:
69 _styledMsg.setFlags((Message::Flags)value.toInt());
72 return MessageModelItem::setData(column, value, role);
76 QVariant ChatLineModelItem::data(int column, int role) const
78 if (role == ChatLineModel::MsgLabelRole)
79 return QVariant::fromValue(messageLabel());
82 auto col = (MessageModel::ColumnType)column;
84 case ChatLineModel::TimestampColumn:
85 variant = timestampData(role);
87 case ChatLineModel::SenderColumn:
88 variant = senderData(role);
90 case ChatLineModel::ContentsColumn:
91 variant = contentsData(role);
96 if (!variant.isValid())
97 return MessageModelItem::data(column, role);
101 QVariant ChatLineModelItem::timestampData(int role) const
104 case ChatLineModel::DisplayRole:
105 return _styledMsg.decoratedTimestamp();
106 case ChatLineModel::EditRole:
107 return _styledMsg.timestamp();
108 case ChatLineModel::BackgroundRole:
109 return backgroundBrush(UiStyle::FormatType::Timestamp);
110 case ChatLineModel::SelectedBackgroundRole:
111 return backgroundBrush(UiStyle::FormatType::Timestamp, true);
112 case ChatLineModel::FormatRole:
113 return QVariant::fromValue(UiStyle::FormatList{
114 std::make_pair(quint16{0}, UiStyle::Format{UiStyle::formatType(_styledMsg.type()) | UiStyle::FormatType::Timestamp, {}, {}})});
119 QVariant ChatLineModelItem::senderData(int role) const
122 case ChatLineModel::DisplayRole:
123 return _styledMsg.decoratedSender();
124 case ChatLineModel::EditRole:
125 return _styledMsg.plainSender();
126 case ChatLineModel::BackgroundRole:
127 return backgroundBrush(UiStyle::FormatType::Sender);
128 case ChatLineModel::SelectedBackgroundRole:
129 return backgroundBrush(UiStyle::FormatType::Sender, true);
130 case ChatLineModel::FormatRole:
131 return QVariant::fromValue(UiStyle::FormatList{
132 std::make_pair(quint16{0}, UiStyle::Format{UiStyle::formatType(_styledMsg.type()) | UiStyle::FormatType::Sender, {}, {}})});
137 QVariant ChatLineModelItem::contentsData(int role) const
140 case ChatLineModel::DisplayRole:
141 case ChatLineModel::EditRole:
142 return _styledMsg.plainContents();
143 case ChatLineModel::BackgroundRole:
144 return backgroundBrush(UiStyle::FormatType::Contents);
145 case ChatLineModel::SelectedBackgroundRole:
146 return backgroundBrush(UiStyle::FormatType::Contents, true);
147 case ChatLineModel::FormatRole:
148 return QVariant::fromValue(_styledMsg.contentsFormatList());
149 case ChatLineModel::WrapListRole:
150 if (_wrapList.isEmpty())
152 return QVariant::fromValue(_wrapList);
157 UiStyle::MessageLabel ChatLineModelItem::messageLabel() const
159 using MessageLabel = UiStyle::MessageLabel;
161 auto label = static_cast<MessageLabel>(_styledMsg.senderHash() << 16);
162 if (_styledMsg.flags() & Message::Self)
163 label |= MessageLabel::OwnMsg;
164 if (_styledMsg.flags() & Message::Highlight)
165 label |= MessageLabel::Highlight;
169 QVariant ChatLineModelItem::backgroundBrush(UiStyle::FormatType subelement, bool selected) const
171 QTextCharFormat fmt = QtUi::style()->format({UiStyle::formatType(_styledMsg.type()) | subelement, {}, {}},
172 messageLabel() | (selected ? UiStyle::MessageLabel::Selected : UiStyle::MessageLabel::None));
173 if (fmt.hasProperty(QTextFormat::BackgroundBrush))
174 return QVariant::fromValue(fmt.background());
178 void ChatLineModelItem::computeWrapList() const
180 QString text = _styledMsg.plainContents();
181 int length = text.length();
185 QList<ChatLineModel::Word> wplist; // use a temp list which we'll later copy into a QVector for efficiency
186 QTextBoundaryFinder finder(QTextBoundaryFinder::Line,
187 _styledMsg.plainContents().unicode(),
189 TextBoundaryFinderBuffer,
190 TextBoundaryFinderBufferSize);
194 ChatLineModel::Word word;
196 qreal wordstartx = 0;
198 QTextLayout layout(_styledMsg.plainContents());
200 option.setWrapMode(QTextOption::NoWrap);
201 layout.setTextOption(option);
203 UiStyle::setTextLayoutFormats(layout, QtUi::style()->toTextLayoutList(_styledMsg.contentsFormatList(), length, messageLabel()));
204 layout.beginLayout();
205 QTextLine line = layout.createLine();
206 line.setNumColumns(length);
209 while ((idx = finder.toNextBoundary()) >= 0 && idx <= length) {
210 // QTextBoundaryFinder has inconsistent behavior in Qt version up to and including 4.6.3 (at least).
211 // It doesn't point to the position we should break, but to the character before that.
212 // Unfortunately Qt decided to fix this by changing the behavior of QTBF, so now we have to add a version
213 // check. At the time of this writing, I'm still trying to get this reverted upstream...
215 // cf. https://bugs.webkit.org/show_bug.cgi?id=31076 and Qt commit e6ac173
216 static int needWorkaround = -1;
217 if (needWorkaround < 0) {
219 QStringList versions = QString(qVersion()).split('.');
220 if (versions.count() == 3 && versions.at(0).toInt() == 4) {
221 if (versions.at(1).toInt() <= 6 && versions.at(2).toInt() <= 3)
225 if (needWorkaround == 1) {
235 for (; wordend > word.start; wordend--) {
236 if (!text.at(wordend - 1).isSpace())
240 qreal wordendx = line.cursorToX(wordend);
241 qreal trailingendx = line.cursorToX(idx);
242 word.endX = wordendx;
243 word.width = wordendx - wordstartx;
244 word.trailing = trailingendx - wordendx;
245 wordstartx = trailingendx;
251 // A QVector needs less space than a QList
252 _wrapList.resize(wplist.count());
253 for (int i = 0; i < wplist.count(); i++) {
254 _wrapList[i] = wplist.at(i);