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