0e9a93a015cea465495fb8863de5e0b5ecf055c7
[quassel.git] / src / uisupport / uistyle.cpp
1 /***************************************************************************
2  *   Copyright (C) 2005-2016 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  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
19  ***************************************************************************/
20
21 #include <vector>
22
23 #include <QApplication>
24 #include <QColor>
25 #include <QIcon>
26
27 #include "buffersettings.h"
28 #include "qssparser.h"
29 #include "quassel.h"
30 #include "uistyle.h"
31 #include "uisettings.h"
32 #include "util.h"
33
34 QHash<QString, UiStyle::FormatType> UiStyle::_formatCodes;
35 bool UiStyle::_useCustomTimestampFormat;       /// If true, use the custom timestamp format
36 QString UiStyle::_timestampFormatString;       /// Timestamp format
37 QString UiStyle::_systemTimestampFormatString; /// Cached copy of system locale timestamp format
38 bool UiStyle::_showSenderPrefixes;             /// If true, show prefixmodes before sender names
39 bool UiStyle::_showSenderBrackets;             /// If true, show brackets around sender names
40
41 namespace {
42
43 // Extended mIRC colors as defined in https://modern.ircdocs.horse/formatting.html#colors-16-98
44 QColor extendedMircColor(int number)
45 {
46     static const std::vector<QColor> colorMap = {
47         "#470000", "#472100", "#474700", "#324700", "#004700", "#00472c", "#004747", "#002747", "#000047", "#2e0047", "#470047", "#47002a",
48         "#740000", "#743a00", "#747400", "#517400", "#007400", "#007449", "#007474", "#004074", "#000074", "#4b0074", "#740074", "#740045",
49         "#b50000", "#b56300", "#b5b500", "#7db500", "#00b500", "#00b571", "#00b5b5", "#0063b5", "#0000b5", "#7500b5", "#b500b5", "#b5006b",
50         "#ff0000", "#ff8c00", "#ffff00", "#b2ff00", "#00ff00", "#00ffa0", "#00ffff", "#008cff", "#0000ff", "#a500ff", "#ff00ff", "#ff0098",
51         "#ff5959", "#ffb459", "#ffff71", "#cfff60", "#6fff6f", "#65ffc9", "#6dffff", "#59b4ff", "#5959ff", "#c459ff", "#ff66ff", "#ff59bc",
52         "#ff9c9c", "#ffd39c", "#ffff9c", "#e2ff9c", "#9cff9c", "#9cffdb", "#9cffff", "#9cd3ff", "#9c9cff", "#dc9cff", "#ff9cff", "#ff94d3",
53         "#000000", "#131313", "#282828", "#363636", "#4d4d4d", "#656565", "#818181", "#9f9f9f", "#bcbcbc", "#e2e2e2", "#ffffff"
54     };
55     if (number < 16)
56         return {};
57     size_t index = number - 16;
58     return (index < colorMap.size() ? colorMap[index] : QColor{});
59 }
60
61 }
62
63 UiStyle::UiStyle(QObject *parent)
64     : QObject(parent),
65     _channelJoinedIcon(QIcon::fromTheme("irc-channel-joined", QIcon(":/icons/irc-channel-joined.png"))),
66     _channelPartedIcon(QIcon::fromTheme("irc-channel-parted", QIcon(":/icons/irc-channel-parted.png"))),
67     _userOfflineIcon(QIcon::fromTheme("im-user-offline", QIcon::fromTheme("user-offline", QIcon(":/icons/im-user-offline.png")))),
68     _userOnlineIcon(QIcon::fromTheme("im-user", QIcon::fromTheme("user-available", QIcon(":/icons/im-user.png")))), // im-user-* are non-standard oxygen extensions
69     _userAwayIcon(QIcon::fromTheme("im-user-away", QIcon::fromTheme("user-away", QIcon(":/icons/im-user-away.png")))),
70     _categoryOpIcon(QIcon::fromTheme("irc-operator")),
71     _categoryVoiceIcon(QIcon::fromTheme("irc-voice")),
72     _opIconLimit(UserCategoryItem::categoryFromModes("o")),
73     _voiceIconLimit(UserCategoryItem::categoryFromModes("v"))
74 {
75     static bool registered = []() {
76         qRegisterMetaType<FormatList>();
77         qRegisterMetaTypeStreamOperators<FormatList>();
78         return true;
79     }();
80     Q_UNUSED(registered)
81
82     _uiStylePalette = QVector<QBrush>(static_cast<int>(ColorRole::NumRoles), QBrush());
83
84     // Now initialize the mapping between FormatCodes and FormatTypes...
85     _formatCodes["%O"] = FormatType::Base;
86     _formatCodes["%B"] = FormatType::Bold;
87     _formatCodes["%S"] = FormatType::Italic;
88     _formatCodes["%U"] = FormatType::Underline;
89     _formatCodes["%R"] = FormatType::Reverse;
90
91     _formatCodes["%DN"] = FormatType::Nick;
92     _formatCodes["%DH"] = FormatType::Hostmask;
93     _formatCodes["%DC"] = FormatType::ChannelName;
94     _formatCodes["%DM"] = FormatType::ModeFlags;
95     _formatCodes["%DU"] = FormatType::Url;
96
97     // Initialize fallback defaults
98     // NOTE: If you change this, update qtui/chatviewsettings.h, too.  More explanations available
99     // in there.
100     setUseCustomTimestampFormat(false);
101     setTimestampFormatString(" hh:mm:ss");
102     enableSenderPrefixes(false);
103     enableSenderBrackets(true);
104
105     // BufferView / NickView settings
106     UiStyleSettings s;
107     _showBufferViewIcons = _showNickViewIcons = s.value("ShowItemViewIcons", true).toBool();
108     s.notify("ShowItemViewIcons", this, SLOT(showItemViewIconsChanged(QVariant)));
109
110     _allowMircColors = s.value("AllowMircColors", true).toBool();
111     s.notify("AllowMircColors", this, SLOT(allowMircColorsChanged(QVariant)));
112
113     loadStyleSheet();
114 }
115
116
117 UiStyle::~UiStyle()
118 {
119     qDeleteAll(_metricsCache);
120 }
121
122
123 void UiStyle::reload()
124 {
125     loadStyleSheet();
126 }
127
128
129 void UiStyle::loadStyleSheet()
130 {
131     qDeleteAll(_metricsCache);
132     _metricsCache.clear();
133     _formatCache.clear();
134     _formats.clear();
135
136     UiStyleSettings s;
137
138     QString styleSheet;
139     styleSheet += loadStyleSheet("file:///" + Quassel::findDataFilePath("stylesheets/default.qss"));
140     styleSheet += loadStyleSheet("file:///" + Quassel::configDirPath() + "settings.qss");
141     if (s.value("UseCustomStyleSheet", false).toBool()) {
142         QString customSheetPath(s.value("CustomStyleSheetPath").toString());
143         QString customSheet = loadStyleSheet("file:///" + customSheetPath, true);
144         if (customSheet.isEmpty()) {
145             // MIGRATION: changed default install path for data from /usr/share/apps to /usr/share
146             if (customSheetPath.startsWith("/usr/share/apps/quassel")) {
147                 customSheetPath.replace(QRegExp("^/usr/share/apps"), "/usr/share");
148                 customSheet = loadStyleSheet("file:///" + customSheetPath, true);
149                 if (!customSheet.isEmpty()) {
150                     s.setValue("CustomStyleSheetPath", customSheetPath);
151                     qDebug() << "Custom stylesheet path migrated to" << customSheetPath;
152                 }
153             }
154         }
155         styleSheet += customSheet;
156     }
157     styleSheet += loadStyleSheet("file:///" + Quassel::optionValue("qss"), true);
158
159     if (!styleSheet.isEmpty()) {
160         QssParser parser;
161         parser.processStyleSheet(styleSheet);
162         QApplication::setPalette(parser.palette());
163
164         _uiStylePalette = parser.uiStylePalette();
165         _formats = parser.formats();
166         _listItemFormats = parser.listItemFormats();
167
168         styleSheet = styleSheet.trimmed();
169         if (!styleSheet.isEmpty())
170             qApp->setStyleSheet(styleSheet);  // pass the remaining sections to the application
171     }
172
173     emit changed();
174 }
175
176
177 QString UiStyle::loadStyleSheet(const QString &styleSheet, bool shouldExist)
178 {
179     QString ss = styleSheet;
180     if (ss.startsWith("file:///")) {
181         ss.remove(0, 8);
182         if (ss.isEmpty())
183             return QString();
184
185         QFile file(ss);
186         if (file.open(QFile::ReadOnly)) {
187             QTextStream stream(&file);
188             ss = stream.readAll();
189             file.close();
190         }
191         else {
192             if (shouldExist)
193                 qWarning() << "Could not open stylesheet file:" << file.fileName();
194             return QString();
195         }
196     }
197     return ss;
198 }
199
200
201 void UiStyle::updateSystemTimestampFormat()
202 {
203     // Does the system locale use AM/PM designators?  For example:
204     // AM/PM:    h:mm AP
205     // AM/PM:    hh:mm a
206     // 24-hour:  h:mm
207     // 24-hour:  hh:mm ADD things
208     // For timestamp format, see https://doc.qt.io/qt-5/qdatetime.html#toString
209     // This won't update if the system locale is changed while Quassel is running.  If need be,
210     // Quassel could hook into notifications of changing system locale to update this.
211     //
212     // Match any AP or A designation if on a word boundary, including underscores.
213     //   .*(\b|_)(A|AP)(\b|_).*
214     //   .*         Match any number of characters
215     //   \b         Match a word boundary, i.e. "AAA.BBB", "." is matched
216     //   _          Match the literal character '_' (not considered a word boundary)
217     //   (X|Y)  Match either X or Y, exactly
218     //
219     // Note that '\' must be escaped as '\\'
220     // QRegExp does not support (?> ...), so it's replaced with standard matching, (...)
221     // Helpful interactive website for debugging and explaining:  https://regex101.com/
222     const QRegExp regExpMatchAMPM(".*(\\b|_)(A|AP)(\\b|_).*", Qt::CaseInsensitive);
223
224     if (regExpMatchAMPM.exactMatch(QLocale::system().timeFormat(QLocale::ShortFormat))) {
225         // AM/PM style used
226         _systemTimestampFormatString = " h:mm:ss ap";
227     } else {
228         // 24-hour style used
229         _systemTimestampFormatString = " hh:mm:ss";
230     }
231     // Include a space to give the timestamp a small bit of padding between the border of the chat
232     // buffer window and the numbers.  Helps with readability.
233     // If you change this to include brackets, e.g. "[hh:mm:ss]", also update
234     // ChatScene::updateTimestampHasBrackets() to true or false as needed!
235 }
236
237
238 // FIXME The following should trigger a reload/refresh of the chat view.
239 void UiStyle::setUseCustomTimestampFormat(bool enabled)
240 {
241     if (_useCustomTimestampFormat != enabled) {
242         _useCustomTimestampFormat = enabled;
243     }
244 }
245
246 void UiStyle::setTimestampFormatString(const QString &format)
247 {
248     if (_timestampFormatString != format) {
249         _timestampFormatString = format;
250     }
251 }
252
253 void UiStyle::enableSenderPrefixes(bool enabled)
254 {
255     if (_showSenderPrefixes != enabled) {
256         _showSenderPrefixes = enabled;
257     }
258 }
259
260 void UiStyle::enableSenderBrackets(bool enabled)
261 {
262     if (_showSenderBrackets != enabled) {
263         _showSenderBrackets = enabled;
264     }
265 }
266
267
268 void UiStyle::allowMircColorsChanged(const QVariant &v)
269 {
270     _allowMircColors = v.toBool();
271     emit changed();
272 }
273
274
275 /******** ItemView Styling *******/
276
277 void UiStyle::showItemViewIconsChanged(const QVariant &v)
278 {
279     _showBufferViewIcons = _showNickViewIcons = v.toBool();
280 }
281
282
283 QVariant UiStyle::bufferViewItemData(const QModelIndex &index, int role) const
284 {
285     BufferInfo::Type type = (BufferInfo::Type)index.data(NetworkModel::BufferTypeRole).toInt();
286     bool isActive = index.data(NetworkModel::ItemActiveRole).toBool();
287
288     if (role == Qt::DecorationRole) {
289         if (!_showBufferViewIcons)
290             return QVariant();
291
292         switch (type) {
293         case BufferInfo::ChannelBuffer:
294             if (isActive)
295                 return _channelJoinedIcon;
296             else
297                 return _channelPartedIcon;
298         case BufferInfo::QueryBuffer:
299             if (!isActive)
300                 return _userOfflineIcon;
301             if (index.data(NetworkModel::UserAwayRole).toBool())
302                 return _userAwayIcon;
303             else
304                 return _userOnlineIcon;
305         default:
306             return QVariant();
307         }
308     }
309
310     ItemFormatType fmtType = ItemFormatType::BufferViewItem;
311     switch (type) {
312     case BufferInfo::StatusBuffer:
313         fmtType |= ItemFormatType::NetworkItem;
314         break;
315     case BufferInfo::ChannelBuffer:
316         fmtType |= ItemFormatType::ChannelBufferItem;
317         break;
318     case BufferInfo::QueryBuffer:
319         fmtType |= ItemFormatType::QueryBufferItem;
320         break;
321     default:
322         return QVariant();
323     }
324
325     QTextCharFormat fmt = _listItemFormats.value(ItemFormatType::BufferViewItem);
326     fmt.merge(_listItemFormats.value(fmtType));
327
328     BufferInfo::ActivityLevel activity = (BufferInfo::ActivityLevel)index.data(NetworkModel::BufferActivityRole).toInt();
329     if (activity & BufferInfo::Highlight) {
330         fmt.merge(_listItemFormats.value(ItemFormatType::BufferViewItem | ItemFormatType::HighlightedBuffer));
331         fmt.merge(_listItemFormats.value(fmtType | ItemFormatType::HighlightedBuffer));
332     }
333     else if (activity & BufferInfo::NewMessage) {
334         fmt.merge(_listItemFormats.value(ItemFormatType::BufferViewItem | ItemFormatType::UnreadBuffer));
335         fmt.merge(_listItemFormats.value(fmtType | ItemFormatType::UnreadBuffer));
336     }
337     else if (activity & BufferInfo::OtherActivity) {
338         fmt.merge(_listItemFormats.value(ItemFormatType::BufferViewItem | ItemFormatType::ActiveBuffer));
339         fmt.merge(_listItemFormats.value(fmtType | ItemFormatType::ActiveBuffer));
340     }
341     else if (!isActive) {
342         fmt.merge(_listItemFormats.value(ItemFormatType::BufferViewItem | ItemFormatType::InactiveBuffer));
343         fmt.merge(_listItemFormats.value(fmtType | ItemFormatType::InactiveBuffer));
344     }
345     else if (index.data(NetworkModel::UserAwayRole).toBool()) {
346         fmt.merge(_listItemFormats.value(ItemFormatType::BufferViewItem | ItemFormatType::UserAway));
347         fmt.merge(_listItemFormats.value(fmtType | ItemFormatType::UserAway));
348     }
349
350     return itemData(role, fmt);
351 }
352
353
354 QVariant UiStyle::nickViewItemData(const QModelIndex &index, int role) const
355 {
356     NetworkModel::ItemType type = (NetworkModel::ItemType)index.data(NetworkModel::ItemTypeRole).toInt();
357
358     if (role == Qt::DecorationRole) {
359         if (!_showNickViewIcons)
360             return QVariant();
361
362         switch (type) {
363         case NetworkModel::UserCategoryItemType:
364         {
365             int categoryId = index.data(TreeModel::SortRole).toInt();
366             if (categoryId <= _opIconLimit)
367                 return _categoryOpIcon;
368             if (categoryId <= _voiceIconLimit)
369                 return _categoryVoiceIcon;
370             return _userOnlineIcon;
371         }
372         case NetworkModel::IrcUserItemType:
373             if (index.data(NetworkModel::ItemActiveRole).toBool())
374                 return _userOnlineIcon;
375             else
376                 return _userAwayIcon;
377         default:
378             return QVariant();
379         }
380     }
381
382     QTextCharFormat fmt = _listItemFormats.value(ItemFormatType::NickViewItem);
383
384     switch (type) {
385     case NetworkModel::IrcUserItemType:
386         fmt.merge(_listItemFormats.value(ItemFormatType::NickViewItem | ItemFormatType::IrcUserItem));
387         if (!index.data(NetworkModel::ItemActiveRole).toBool()) {
388             fmt.merge(_listItemFormats.value(ItemFormatType::NickViewItem | ItemFormatType::UserAway));
389             fmt.merge(_listItemFormats.value(ItemFormatType::NickViewItem | ItemFormatType::IrcUserItem | ItemFormatType::UserAway));
390         }
391         break;
392     case NetworkModel::UserCategoryItemType:
393         fmt.merge(_listItemFormats.value(ItemFormatType::NickViewItem | ItemFormatType::UserCategoryItem));
394         break;
395     default:
396         return QVariant();
397     }
398
399     return itemData(role, fmt);
400 }
401
402
403 QVariant UiStyle::itemData(int role, const QTextCharFormat &format) const
404 {
405     switch (role) {
406     case Qt::FontRole:
407         return format.font();
408     case Qt::ForegroundRole:
409         return format.property(QTextFormat::ForegroundBrush);
410     case Qt::BackgroundRole:
411         return format.property(QTextFormat::BackgroundBrush);
412     default:
413         return QVariant();
414     }
415 }
416
417
418 /******** Caching *******/
419
420 QTextCharFormat UiStyle::format(quint64 key) const
421 {
422     return _formats.value(key, QTextCharFormat());
423 }
424
425 namespace {
426
427 // Create unique key for given Format object and message label
428 QString formatKey(const UiStyle::Format &format, UiStyle::MessageLabel label)
429 {
430     return QString::number(format.type | label, 16)
431             + (format.foreground.isValid() ? format.foreground.name() : "#------")
432             + (format.background.isValid() ? format.background.name() : "#------");
433 }
434
435 }
436
437 QTextCharFormat UiStyle::cachedFormat(const Format &format, MessageLabel messageLabel) const
438 {
439     return _formatCache.value(formatKey(format, messageLabel), QTextCharFormat());
440 }
441
442
443 void UiStyle::setCachedFormat(const QTextCharFormat &charFormat, const Format &format, MessageLabel messageLabel) const
444 {
445     _formatCache[formatKey(format, messageLabel)] = charFormat;
446 }
447
448
449 QFontMetricsF *UiStyle::fontMetrics(FormatType ftype, MessageLabel label) const
450 {
451     // QFontMetricsF is not assignable, so we need to store pointers :/
452     quint64 key = ftype | label;
453
454     if (_metricsCache.contains(key))
455         return _metricsCache.value(key);
456
457     return (_metricsCache[key] = new QFontMetricsF(format({ftype, {}, {}}, label).font()));
458 }
459
460
461 /******** Generate formats ********/
462
463 // NOTE: This and the following functions are intimately tied to the values in FormatType. Don't change this
464 //       until you _really_ know what you do!
465 QTextCharFormat UiStyle::format(const Format &format, MessageLabel label) const
466 {
467     if (format.type == FormatType::Invalid)
468         return {};
469
470     // Check if we have exactly this format readily cached already
471     QTextCharFormat charFormat = cachedFormat(format, label);
472     if (charFormat.properties().count())
473         return charFormat;
474
475     mergeFormat(charFormat, format, label & 0xffff0000);  // keep nickhash in label
476
477     for (quint32 mask = 0x00000001; mask <= static_cast<quint32>(MessageLabel::Selected); mask <<= 1) {
478         if (static_cast<quint32>(label) & mask) {
479             mergeFormat(charFormat, {format.type, {}, {}}, label & (mask | 0xffff0000));  // Don't re-apply extended colors
480         }
481     }
482
483     setCachedFormat(charFormat, format, label);
484     return charFormat;
485 }
486
487
488 void UiStyle::mergeFormat(QTextCharFormat &charFormat, const Format &format, MessageLabel label) const
489 {
490     mergeSubElementFormat(charFormat, format.type & 0x00ff, label);
491
492     // TODO: allow combinations for mirc formats and colors (each), e.g. setting a special format for "bold and italic"
493     //       or "foreground 01 and background 03"
494     if ((format.type & 0xfff00) != FormatType::Base) { // element format
495         for (quint32 mask = 0x00100; mask <= 0x40000; mask <<= 1) {
496             if ((format.type & mask) != FormatType::Base) {
497                 mergeSubElementFormat(charFormat, format.type & (mask | 0xff), label);
498             }
499         }
500     }
501
502     // Now we handle color codes
503     // We assume that those can't be combined with subelement and message types.
504     if (_allowMircColors) {
505         // Classic mIRC colors (styleable)
506         if ((format.type & 0x00400000) != FormatType::Base)
507             mergeSubElementFormat(charFormat, format.type & 0x0f400000, label);  // foreground
508         if ((format.type & 0x00800000) != FormatType::Base)
509             mergeSubElementFormat(charFormat, format.type & 0xf0800000, label);  // background
510         if ((format.type & 0x00c00000) == static_cast<FormatType>(0x00c00000))
511             mergeSubElementFormat(charFormat, format.type & 0xffc00000, label);  // combination
512
513         // Extended mIRC colors (hardcoded)
514         if (format.foreground.isValid())
515             charFormat.setForeground(format.foreground);
516         if (format.background.isValid())
517             charFormat.setBackground(format.background);
518     }
519
520     // URL
521     if ((format.type & FormatType::Url) != FormatType::Base)
522         mergeSubElementFormat(charFormat, format.type & (FormatType::Url | static_cast<FormatType>(0x000000ff)), label);
523 }
524
525
526 // Merge a subelement format into an existing message format
527 void UiStyle::mergeSubElementFormat(QTextCharFormat &fmt, FormatType ftype, MessageLabel label) const
528 {
529     quint64 key = ftype | label;
530     fmt.merge(format(key & 0x0000ffffffffff00ull)); // label + subelement
531     fmt.merge(format(key & 0x0000ffffffffffffull)); // label + subelement + msgtype
532     fmt.merge(format(key & 0xffffffffffffff00ull)); // label + subelement + nickhash
533     fmt.merge(format(key & 0xffffffffffffffffull)); // label + subelement + nickhash + msgtype
534 }
535
536
537 UiStyle::FormatType UiStyle::formatType(Message::Type msgType)
538 {
539     switch (msgType) {
540     case Message::Plain:
541         return FormatType::PlainMsg;
542     case Message::Notice:
543         return FormatType::NoticeMsg;
544     case Message::Action:
545         return FormatType::ActionMsg;
546     case Message::Nick:
547         return FormatType::NickMsg;
548     case Message::Mode:
549         return FormatType::ModeMsg;
550     case Message::Join:
551         return FormatType::JoinMsg;
552     case Message::Part:
553         return FormatType::PartMsg;
554     case Message::Quit:
555         return FormatType::QuitMsg;
556     case Message::Kick:
557         return FormatType::KickMsg;
558     case Message::Kill:
559         return FormatType::KillMsg;
560     case Message::Server:
561         return FormatType::ServerMsg;
562     case Message::Info:
563         return FormatType::InfoMsg;
564     case Message::Error:
565         return FormatType::ErrorMsg;
566     case Message::DayChange:
567         return FormatType::DayChangeMsg;
568     case Message::Topic:
569         return FormatType::TopicMsg;
570     case Message::NetsplitJoin:
571         return FormatType::NetsplitJoinMsg;
572     case Message::NetsplitQuit:
573         return FormatType::NetsplitQuitMsg;
574     case Message::Invite:
575         return FormatType::InviteMsg;
576     }
577     //Q_ASSERT(false); // we need to handle all message types
578     qWarning() << Q_FUNC_INFO << "Unknown message type:" << msgType;
579     return FormatType::ErrorMsg;
580 }
581
582
583 UiStyle::FormatType UiStyle::formatType(const QString &code)
584 {
585     if (_formatCodes.contains(code))
586         return _formatCodes.value(code);
587     return FormatType::Invalid;
588 }
589
590
591 QString UiStyle::formatCode(FormatType ftype)
592 {
593     return _formatCodes.key(ftype);
594 }
595
596
597 QList<QTextLayout::FormatRange> UiStyle::toTextLayoutList(const FormatList &formatList, int textLength, MessageLabel messageLabel) const
598 {
599     QList<QTextLayout::FormatRange> formatRanges;
600     QTextLayout::FormatRange range;
601     size_t i = 0;
602     for (i = 0; i < formatList.size(); i++) {
603         range.format = format(formatList.at(i).second, messageLabel);
604         range.start = formatList.at(i).first;
605         if (i > 0)
606             formatRanges.last().length = range.start - formatRanges.last().start;
607         formatRanges.append(range);
608     }
609     if (i > 0)
610         formatRanges.last().length = textLength - formatRanges.last().start;
611     return formatRanges;
612 }
613
614
615 // This method expects a well-formatted string, there is no error checking!
616 // Since we create those ourselves, we should be pretty safe that nobody does something crappy here.
617 UiStyle::StyledString UiStyle::styleString(const QString &s_, FormatType baseFormat)
618 {
619     QString s = s_;
620     StyledString result;
621     result.formatList.emplace_back(std::make_pair(quint16{0}, Format{baseFormat, {}, {}}));
622
623     if (s.length() > 65535) {
624         // We use quint16 for indexes
625         qWarning() << QString("String too long to be styled: %1").arg(s);
626         result.plainText = s;
627         return result;
628     }
629
630     Format curfmt{baseFormat, {}, {}};
631
632     int pos = 0; quint16 length = 0;
633     for (;;) {
634         pos = s.indexOf('%', pos);
635         if (pos < 0) break;
636         if (s[pos+1] == '%') { // escaped %, we just remove one and continue
637             s.remove(pos, 1);
638             pos++;
639             continue;
640         }
641         if (s[pos+1] == 'D' && s[pos+2] == 'c') { // mIRC color code
642             if (s[pos+3] == '-') { // color off
643                 curfmt.type &= 0x003fffff;
644                 curfmt.foreground = QColor{};
645                 curfmt.background = QColor{};
646                 length = 4;
647             }
648             else {
649                 quint32 color = 10 * s[pos+4].digitValue() + s[pos+5].digitValue();
650                 // Color values 0-15 are traditional mIRC colors, defined in the stylesheet and thus going through the format engine
651                 // Larger color values are hardcoded and applied separately (cf. https://modern.ircdocs.horse/formatting.html#colors-16-98)
652                 if (s[pos+3] == 'f') {
653                     if (color < 16) {
654                         // Traditional mIRC color, defined in the stylesheet
655                         curfmt.type &= 0xf0ffffff;
656                         curfmt.type |= color << 24 | 0x00400000;
657                         curfmt.foreground = QColor{};
658                     }
659                     else {
660                         curfmt.type &= 0xf0bfffff;  // mask out traditional foreground color
661                         curfmt.foreground = extendedMircColor(color);
662                     }
663                 }
664                 else {
665                     if (color < 16) {
666                         curfmt.type &= 0x0fffffff;
667                         curfmt.type |= color << 28 | 0x00800000;
668                         curfmt.background = QColor{};
669                     }
670                     else {
671                         curfmt.type &= 0x0f7fffff;  // mask out traditional background color
672                         curfmt.background = extendedMircColor(color);
673                     }
674                 }
675                 length = 6;
676             }
677         }
678         else if (s[pos+1] == 'D' && s[pos+2] == 'h') { // Hex color
679             QColor color{s.mid(pos+4, 7)};
680             if (s[pos+3] == 'f') {
681                 curfmt.type &= 0xf0bfffff;  // mask out mIRC foreground color
682                 curfmt.foreground = std::move(color);
683             }
684             else {
685                 curfmt.type &= 0x0f7fffff;  // mask out mIRC background color
686                 curfmt.background = std::move(color);
687             }
688             length = 11;
689         }
690         else if (s[pos+1] == 'O') { // reset formatting
691             curfmt.type &= 0x000000ff; // we keep message type-specific formatting
692             curfmt.foreground = QColor{};
693             curfmt.background = QColor{};
694             length = 2;
695         }
696         else if (s[pos+1] == 'R') { // reverse
697             // TODO: implement reverse formatting
698
699             length = 2;
700         }
701         else { // all others are toggles
702             QString code = QString("%") + s[pos+1];
703             if (s[pos+1] == 'D') code += s[pos+2];
704             FormatType ftype = formatType(code);
705             if (ftype == FormatType::Invalid) {
706                 pos++;
707                 qWarning() << (QString("Invalid format code in string: %1").arg(s));
708                 continue;
709             }
710             curfmt.type ^= ftype;
711             length = code.length();
712         }
713         s.remove(pos, length);
714         if (pos == result.formatList.back().first)
715             result.formatList.back().second = curfmt;
716         else
717             result.formatList.emplace_back(std::make_pair(pos, curfmt));
718     }
719     result.plainText = s;
720     return result;
721 }
722
723
724 QString UiStyle::mircToInternal(const QString &mirc_)
725 {
726     QString mirc;
727     mirc.reserve(mirc_.size());
728     foreach (const QChar &c, mirc_) {
729         if ((c < '\x20' || c == '\x7f') && c != '\x03' && c != '\x04') {
730             switch (c.unicode()) {
731                 case '\x02':
732                     mirc += "%B";
733                     break;
734                 case '\x0f':
735                     mirc += "%O";
736                     break;
737                 case '\x09':
738                     mirc += "        ";
739                     break;
740                 case '\x12':
741                 case '\x16':
742                     mirc += "%R";
743                     break;
744                 case '\x1d':
745                     mirc += "%S";
746                     break;
747                 case '\x1f':
748                     mirc += "%U";
749                     break;
750                 case '\x7f':
751                     mirc += QChar(0x2421);
752                     break;
753                 default:
754                     mirc += QChar(0x2400 + c.unicode());
755             }
756         } else {
757             if (c == '%')
758                 mirc += c;
759             mirc += c;
760         }
761     }
762
763     // Now we bring the color codes (\x03) in a sane format that can be parsed more easily later.
764     // %Dcfxx is foreground, %Dcbxx is background color, where xx is a 2 digit dec number denoting the color code.
765     // %Dc- turns color off.
766     // Note: We use the "mirc standard" as described in <http://www.mirc.co.uk/help/color.txt>.
767     //       This means that we don't accept something like \x03,5 (even though others, like WeeChat, do).
768     {
769         int pos = 0;
770         while (true) {
771             pos = mirc.indexOf('\x03', pos);
772             if (pos < 0)
773                 break;  // no more mirc color codes
774             QString ins, num;
775             int l = mirc.length();
776             int i = pos + 1;
777             // check for fg color
778             if (i < l && mirc[i].isDigit()) {
779                 num = mirc[i++];
780                 if (i < l && mirc[i].isDigit())
781                     num.append(mirc[i++]);
782                 else
783                     num.prepend('0');
784                 ins = QString("%Dcf%1").arg(num);
785
786                 if (i+1 < l && mirc[i] == ',' && mirc[i+1].isDigit()) {
787                     i++;
788                     num = mirc[i++];
789                     if (i < l && mirc[i].isDigit())
790                         num.append(mirc[i++]);
791                     else
792                         num.prepend('0');
793                     ins += QString("%Dcb%1").arg(num);
794                 }
795             }
796             else {
797                 ins = "%Dc-";
798             }
799             mirc.replace(pos, i-pos, ins);
800         }
801     }
802
803     // Hex colors, as specified in https://modern.ircdocs.horse/formatting.html#hex-color
804     // %Dhf#rrggbb is foreground, %Dhb#rrggbb is background
805     {
806         static const QRegExp rx{"[\\da-fA-F]{6}"};
807         int pos = 0;
808         while (true) {
809             if (pos >= mirc.length())
810                 break;
811             pos = mirc.indexOf('\x04', pos);
812             if (pos < 0)
813                 break;
814             int i = pos + 1;
815             QString ins;
816             auto num = mirc.mid(i, 6);
817             if (!num.isEmpty() && rx.exactMatch(num)) {
818                 ins = "%Dhf#" + num.toLower();
819                 i += 6;
820                 if (i < mirc.length() && mirc[i] == ',' && !(num = mirc.mid(i + 1, 6)).isEmpty() && rx.exactMatch(num)) {
821                     ins += "%Dhb#" + num.toLower();
822                     i += 7;
823                 }
824             }
825             else {
826                 ins = "%Dc-";
827             }
828             mirc.replace(pos, i - pos, ins);
829             pos += ins.length();
830         }
831     }
832
833     return mirc;
834 }
835
836
837 QString UiStyle::systemTimestampFormatString()
838 {
839     if (_systemTimestampFormatString.isEmpty()) {
840         // Calculate and cache the system timestamp format string
841         updateSystemTimestampFormat();
842     }
843     return _systemTimestampFormatString;
844 }
845
846
847 QString UiStyle::timestampFormatString()
848 {
849     if (useCustomTimestampFormat()) {
850         return _timestampFormatString;
851     } else {
852         return systemTimestampFormatString();
853     }
854 }
855
856
857 /***********************************************************************************/
858 UiStyle::StyledMessage::StyledMessage(const Message &msg)
859     : Message(msg)
860 {
861     switch (type()) {
862         // Don't compute the sender hash for message types without a nickname embedded
863         case Message::Server:
864         case Message::Info:
865         case Message::Error:
866         case Message::DayChange:
867         case Message::Topic:
868         case Message::Invite:
869         // Don't compute the sender hash for messages with multiple nicks
870         // Fixing this without breaking themes would be.. complex.
871         case Message::NetsplitJoin:
872         case Message::NetsplitQuit:
873         case Message::Kick:
874         // Don't compute the sender hash for message types that are not yet completed elsewhere
875         case Message::Kill:
876             _senderHash = 0x00;
877             break;
878         default:
879             // Compute the sender hash for all other message types
880             _senderHash = 0xff;
881             break;
882     }
883 }
884
885
886 void UiStyle::StyledMessage::style() const
887 {
888     QString user = userFromMask(sender());
889     QString host = hostFromMask(sender());
890     QString nick = nickFromMask(sender());
891     QString txt = UiStyle::mircToInternal(contents());
892     QString bufferName = bufferInfo().bufferName();
893     bufferName.replace('%', "%%"); // well, you _can_ have a % in a buffername apparently... -_-
894     host.replace('%', "%%");     // hostnames too...
895     user.replace('%', "%%");     // and the username...
896     nick.replace('%', "%%");     // ... and then there's totally RFC-violating servers like justin.tv m(
897     const int maxNetsplitNicks = 15;
898
899     QString t;
900     switch (type()) {
901     case Message::Plain:
902         t = QString("%1").arg(txt); break;
903     case Message::Notice:
904         t = QString("%1").arg(txt); break;
905     case Message::Action:
906         t = QString("%DN%1%DN %2").arg(nick).arg(txt);
907         break;
908     case Message::Nick:
909         //: Nick Message
910         if (nick == contents()) t = tr("You are now known as %DN%1%DN").arg(txt);
911         else t = tr("%DN%1%DN is now known as %DN%2%DN").arg(nick, txt);
912         break;
913     case Message::Mode:
914         //: Mode Message
915         if (nick.isEmpty()) t = tr("User mode: %DM%1%DM").arg(txt);
916         else t = tr("Mode %DM%1%DM by %DN%2%DN").arg(txt, nick);
917         break;
918     case Message::Join:
919         //: Join Message
920         t = tr("%DN%1%DN %DH(%2@%3)%DH has joined %DC%4%DC").arg(nick, user, host, bufferName); break;
921     case Message::Part:
922         //: Part Message
923         t = tr("%DN%1%DN %DH(%2@%3)%DH has left %DC%4%DC").arg(nick, user, host, bufferName);
924         if (!txt.isEmpty()) t = QString("%1 (%2)").arg(t).arg(txt);
925         break;
926     case Message::Quit:
927         //: Quit Message
928         t = tr("%DN%1%DN %DH(%2@%3)%DH has quit").arg(nick, user, host);
929         if (!txt.isEmpty()) t = QString("%1 (%2)").arg(t).arg(txt);
930         break;
931     case Message::Kick:
932     {
933         QString victim = txt.section(" ", 0, 0);
934         QString kickmsg = txt.section(" ", 1);
935         //: Kick Message
936         t = tr("%DN%1%DN has kicked %DN%2%DN from %DC%3%DC").arg(nick).arg(victim).arg(bufferName);
937         if (!kickmsg.isEmpty()) t = QString("%1 (%2)").arg(t).arg(kickmsg);
938     }
939     break;
940     //case Message::Kill: FIXME
941
942     case Message::Server:
943         t = QString("%1").arg(txt); break;
944     case Message::Info:
945         t = QString("%1").arg(txt); break;
946     case Message::Error:
947         t = QString("%1").arg(txt); break;
948     case Message::DayChange:
949     {
950         //: Day Change Message
951         t = tr("{Day changed to %1}").arg(timestamp().date().toString(Qt::DefaultLocaleLongDate));
952     }
953         break;
954     case Message::Topic:
955         t = QString("%1").arg(txt); break;
956     case Message::NetsplitJoin:
957     {
958         QStringList users = txt.split("#:#");
959         QStringList servers = users.takeLast().split(" ");
960
961         for (int i = 0; i < users.count() && i < maxNetsplitNicks; i++)
962             users[i] = nickFromMask(users.at(i));
963
964         t = tr("Netsplit between %DH%1%DH and %DH%2%DH ended. Users joined: ").arg(servers.at(0), servers.at(1));
965         if (users.count() <= maxNetsplitNicks)
966             t.append(QString("%DN%1%DN").arg(users.join(", ")));
967         else
968             t.append(tr("%DN%1%DN (%2 more)").arg(static_cast<QStringList>(users.mid(0, maxNetsplitNicks)).join(", ")).arg(users.count() - maxNetsplitNicks));
969     }
970     break;
971     case Message::NetsplitQuit:
972     {
973         QStringList users = txt.split("#:#");
974         QStringList servers = users.takeLast().split(" ");
975
976         for (int i = 0; i < users.count() && i < maxNetsplitNicks; i++)
977             users[i] = nickFromMask(users.at(i));
978
979         t = tr("Netsplit between %DH%1%DH and %DH%2%DH. Users quit: ").arg(servers.at(0), servers.at(1));
980
981         if (users.count() <= maxNetsplitNicks)
982             t.append(QString("%DN%1%DN").arg(users.join(", ")));
983         else
984             t.append(tr("%DN%1%DN (%2 more)").arg(static_cast<QStringList>(users.mid(0, maxNetsplitNicks)).join(", ")).arg(users.count() - maxNetsplitNicks));
985     }
986     break;
987     case Message::Invite:
988         t = QString("%1").arg(txt); break;
989     default:
990         t = QString("[%1]").arg(txt);
991     }
992     _contents = UiStyle::styleString(t, UiStyle::formatType(type()));
993 }
994
995
996 const QString &UiStyle::StyledMessage::plainContents() const
997 {
998     if (_contents.plainText.isNull())
999         style();
1000
1001     return _contents.plainText;
1002 }
1003
1004
1005 const UiStyle::FormatList &UiStyle::StyledMessage::contentsFormatList() const
1006 {
1007     if (_contents.plainText.isNull())
1008         style();
1009
1010     return _contents.formatList;
1011 }
1012
1013
1014 QString UiStyle::StyledMessage::decoratedTimestamp() const
1015 {
1016     return timestamp().toLocalTime().toString(UiStyle::timestampFormatString());
1017 }
1018
1019
1020 QString UiStyle::StyledMessage::plainSender() const
1021 {
1022     switch (type()) {
1023     case Message::Plain:
1024     case Message::Notice:
1025         return nickFromMask(sender());
1026     default:
1027         return QString();
1028     }
1029 }
1030
1031
1032 QString UiStyle::StyledMessage::decoratedSender() const
1033 {
1034     QString _senderPrefixes;
1035     if (_showSenderPrefixes) {
1036         _senderPrefixes = senderPrefixes();
1037     }
1038
1039     switch (type()) {
1040     case Message::Plain:
1041         if (_showSenderBrackets)
1042             return QString("<%1%2>").arg(_senderPrefixes, plainSender());
1043         else
1044             return QString("%1%2").arg(_senderPrefixes, plainSender());
1045     case Message::Notice:
1046         return QString("[%1%2]").arg(_senderPrefixes, plainSender());
1047     case Message::Action:
1048         return "-*-";
1049     case Message::Nick:
1050         return "<->";
1051     case Message::Mode:
1052         return "***";
1053     case Message::Join:
1054         return "-->";
1055     case Message::Part:
1056         return "<--";
1057     case Message::Quit:
1058         return "<--";
1059     case Message::Kick:
1060         return "<-*";
1061     case Message::Kill:
1062         return "<-x";
1063     case Message::Server:
1064         return "*";
1065     case Message::Info:
1066         return "*";
1067     case Message::Error:
1068         return "*";
1069     case Message::DayChange:
1070         return "-";
1071     case Message::Topic:
1072         return "*";
1073     case Message::NetsplitJoin:
1074         return "=>";
1075     case Message::NetsplitQuit:
1076         return "<=";
1077     case Message::Invite:
1078         return "->";
1079     }
1080
1081     return QString("%1%2").arg(_senderPrefixes, plainSender());
1082 }
1083
1084
1085 // FIXME hardcoded to 16 sender hashes
1086 quint8 UiStyle::StyledMessage::senderHash() const
1087 {
1088     if (_senderHash != 0xff)
1089         return _senderHash;
1090
1091     QString nick;
1092
1093     // HACK: Until multiple nicknames with different colors can be solved in the theming engine,
1094     // for /nick change notifications, use the color of the new nickname (if possible), not the old
1095     // nickname.
1096     if (type() == Message::Nick) {
1097         // New nickname is given as contents.  Change to that.
1098         nick = stripFormatCodes(contents()).toLower();
1099     } else {
1100         // Just use the sender directly
1101         nick = nickFromMask(sender()).toLower();
1102     }
1103
1104     if (!nick.isEmpty()) {
1105         int chopCount = 0;
1106         while (chopCount < nick.size() && nick.at(nick.count() - 1 - chopCount) == '_')
1107             chopCount++;
1108         if (chopCount < nick.size())
1109             nick.chop(chopCount);
1110     }
1111     quint16 hash = qChecksum(nick.toLatin1().data(), nick.toLatin1().size());
1112     return (_senderHash = (hash & 0xf) + 1);
1113 }
1114
1115 /***********************************************************************************/
1116
1117 #if QT_VERSION < 0x050000
1118 uint qHash(UiStyle::ItemFormatType key)
1119 {
1120     return qHash(static_cast<quint32>(key));
1121 }
1122
1123 #else
1124
1125 uint qHash(UiStyle::ItemFormatType key, uint seed)
1126 {
1127     return qHash(static_cast<quint32>(key), seed);
1128 }
1129 #endif
1130
1131 UiStyle::FormatType operator|(UiStyle::FormatType lhs, UiStyle::FormatType rhs)
1132 {
1133     return static_cast<UiStyle::FormatType>(static_cast<quint32>(lhs) | static_cast<quint32>(rhs));
1134 }
1135
1136 UiStyle::FormatType& operator|=(UiStyle::FormatType& lhs, UiStyle::FormatType rhs)
1137 {
1138     lhs = static_cast<UiStyle::FormatType>(static_cast<quint32>(lhs) | static_cast<quint32>(rhs));
1139     return lhs;
1140 }
1141
1142
1143 UiStyle::FormatType operator|(UiStyle::FormatType lhs, quint32 rhs)
1144 {
1145     return static_cast<UiStyle::FormatType>(static_cast<quint32>(lhs) | rhs);
1146 }
1147
1148
1149 UiStyle::FormatType& operator|=(UiStyle::FormatType &lhs, quint32 rhs)
1150 {
1151     lhs = static_cast<UiStyle::FormatType>(static_cast<quint32>(lhs) | rhs);
1152     return lhs;
1153 }
1154
1155
1156 UiStyle::FormatType operator&(UiStyle::FormatType lhs, UiStyle::FormatType rhs)
1157 {
1158     return static_cast<UiStyle::FormatType>(static_cast<quint32>(lhs) & static_cast<quint32>(rhs));
1159 }
1160
1161
1162 UiStyle::FormatType& operator&=(UiStyle::FormatType &lhs, UiStyle::FormatType rhs)
1163 {
1164     lhs = static_cast<UiStyle::FormatType>(static_cast<quint32>(lhs) & static_cast<quint32>(rhs));
1165     return lhs;
1166 }
1167
1168
1169 UiStyle::FormatType operator&(UiStyle::FormatType lhs, quint32 rhs)
1170 {
1171     return static_cast<UiStyle::FormatType>(static_cast<quint32>(lhs) & rhs);
1172 }
1173
1174
1175 UiStyle::FormatType& operator&=(UiStyle::FormatType &lhs, quint32 rhs)
1176 {
1177     lhs = static_cast<UiStyle::FormatType>(static_cast<quint32>(lhs) & rhs);
1178     return lhs;
1179 }
1180
1181
1182 UiStyle::FormatType& operator^=(UiStyle::FormatType &lhs, UiStyle::FormatType rhs)
1183 {
1184     lhs = static_cast<UiStyle::FormatType>(static_cast<quint32>(lhs) ^ static_cast<quint32>(rhs));
1185     return lhs;
1186 }
1187
1188
1189 UiStyle::MessageLabel operator|(UiStyle::MessageLabel lhs, UiStyle::MessageLabel rhs)
1190 {
1191     return static_cast<UiStyle::MessageLabel>(static_cast<quint32>(lhs) | static_cast<quint32>(rhs));
1192 }
1193
1194
1195 UiStyle::MessageLabel& operator|=(UiStyle::MessageLabel &lhs, UiStyle::MessageLabel rhs)
1196 {
1197     lhs = static_cast<UiStyle::MessageLabel>(static_cast<quint32>(lhs) | static_cast<quint32>(rhs));
1198     return lhs;
1199 }
1200
1201
1202 UiStyle::MessageLabel operator&(UiStyle::MessageLabel lhs, quint32 rhs)
1203 {
1204     return static_cast<UiStyle::MessageLabel>(static_cast<quint32>(lhs) & rhs);
1205 }
1206
1207
1208 UiStyle::MessageLabel& operator&=(UiStyle::MessageLabel &lhs, UiStyle::MessageLabel rhs)
1209 {
1210     lhs = static_cast<UiStyle::MessageLabel>(static_cast<quint32>(lhs) & static_cast<quint32>(rhs));
1211     return lhs;
1212 }
1213
1214
1215 quint64 operator|(UiStyle::FormatType lhs, UiStyle::MessageLabel rhs)
1216 {
1217     return static_cast<quint64>(lhs) | (static_cast<quint64>(rhs) << 32ull);
1218 }
1219
1220
1221 UiStyle::ItemFormatType operator|(UiStyle::ItemFormatType lhs, UiStyle::ItemFormatType rhs)
1222 {
1223     return static_cast<UiStyle::ItemFormatType>(static_cast<quint32>(lhs) | static_cast<quint32>(rhs));
1224 }
1225
1226
1227 UiStyle::ItemFormatType& operator|=(UiStyle::ItemFormatType &lhs, UiStyle::ItemFormatType rhs)
1228 {
1229     lhs = static_cast<UiStyle::ItemFormatType>(static_cast<quint32>(lhs) | static_cast<quint32>(rhs));
1230     return lhs;
1231 }
1232
1233 /***********************************************************************************/
1234
1235 QDataStream &operator<<(QDataStream &out, const UiStyle::FormatList &formatList)
1236 {
1237     out << static_cast<quint16>(formatList.size());
1238     UiStyle::FormatList::const_iterator it = formatList.begin();
1239     while (it != formatList.end()) {
1240         out << it->first
1241             << static_cast<quint32>(it->second.type)
1242             << it->second.foreground
1243             << it->second.background;
1244         ++it;
1245     }
1246     return out;
1247 }
1248
1249
1250 QDataStream &operator>>(QDataStream &in, UiStyle::FormatList &formatList)
1251 {
1252     quint16 cnt;
1253     in >> cnt;
1254     for (quint16 i = 0; i < cnt; i++) {
1255         quint16 pos;
1256         quint32 ftype;
1257         QColor foreground;
1258         QColor background;
1259         in >> pos >> ftype >> foreground >> background;
1260         formatList.emplace_back(std::make_pair(quint16{pos}, UiStyle::Format{static_cast<UiStyle::FormatType>(ftype), foreground, background}));
1261     }
1262     return in;
1263 }