1 /***************************************************************************
2 * Copyright (C) 2005-2018 by the Quassel Project *
3 * devel@quassel-irc.org *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) version 3. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
24 #include <QApplication>
28 #include "buffersettings.h"
29 #include "qssparser.h"
32 #include "uisettings.h"
35 QHash<QString, UiStyle::FormatType> UiStyle::_formatCodes;
36 bool UiStyle::_useCustomTimestampFormat; /// If true, use the custom timestamp format
37 QString UiStyle::_timestampFormatString; /// Timestamp format
38 QString UiStyle::_systemTimestampFormatString; /// Cached copy of system locale timestamp format
39 bool UiStyle::_showSenderPrefixes; /// If true, show prefixmodes before sender names
40 bool UiStyle::_showSenderBrackets; /// If true, show brackets around sender names
44 // Extended mIRC colors as defined in https://modern.ircdocs.horse/formatting.html#colors-16-98
45 QColor extendedMircColor(int number)
47 static const std::vector<QColor> colorMap = {
48 "#470000", "#472100", "#474700", "#324700", "#004700", "#00472c", "#004747", "#002747", "#000047", "#2e0047", "#470047", "#47002a",
49 "#740000", "#743a00", "#747400", "#517400", "#007400", "#007449", "#007474", "#004074", "#000074", "#4b0074", "#740074", "#740045",
50 "#b50000", "#b56300", "#b5b500", "#7db500", "#00b500", "#00b571", "#00b5b5", "#0063b5", "#0000b5", "#7500b5", "#b500b5", "#b5006b",
51 "#ff0000", "#ff8c00", "#ffff00", "#b2ff00", "#00ff00", "#00ffa0", "#00ffff", "#008cff", "#0000ff", "#a500ff", "#ff00ff", "#ff0098",
52 "#ff5959", "#ffb459", "#ffff71", "#cfff60", "#6fff6f", "#65ffc9", "#6dffff", "#59b4ff", "#5959ff", "#c459ff", "#ff66ff", "#ff59bc",
53 "#ff9c9c", "#ffd39c", "#ffff9c", "#e2ff9c", "#9cff9c", "#9cffdb", "#9cffff", "#9cd3ff", "#9c9cff", "#dc9cff", "#ff9cff", "#ff94d3",
54 "#000000", "#131313", "#282828", "#363636", "#4d4d4d", "#656565", "#818181", "#9f9f9f", "#bcbcbc", "#e2e2e2", "#ffffff"
58 size_t index = number - 16;
59 return (index < colorMap.size() ? colorMap[index] : QColor{});
64 UiStyle::UiStyle(QObject *parent)
66 _channelJoinedIcon(QIcon::fromTheme("irc-channel-joined", QIcon(":/icons/irc-channel-joined.png"))),
67 _channelPartedIcon(QIcon::fromTheme("irc-channel-parted", QIcon(":/icons/irc-channel-parted.png"))),
68 _userOfflineIcon(QIcon::fromTheme("im-user-offline", QIcon::fromTheme("user-offline", QIcon(":/icons/im-user-offline.png")))),
69 _userOnlineIcon(QIcon::fromTheme("im-user", QIcon::fromTheme("user-available", QIcon(":/icons/im-user.png")))), // im-user-* are non-standard oxygen extensions
70 _userAwayIcon(QIcon::fromTheme("im-user-away", QIcon::fromTheme("user-away", QIcon(":/icons/im-user-away.png")))),
71 _categoryOpIcon(QIcon::fromTheme("irc-operator")),
72 _categoryVoiceIcon(QIcon::fromTheme("irc-voice")),
73 _opIconLimit(UserCategoryItem::categoryFromModes("o")),
74 _voiceIconLimit(UserCategoryItem::categoryFromModes("v"))
76 static bool registered = []() {
77 qRegisterMetaType<FormatList>();
78 qRegisterMetaTypeStreamOperators<FormatList>();
83 _uiStylePalette = QVector<QBrush>(static_cast<int>(ColorRole::NumRoles), QBrush());
85 // Now initialize the mapping between FormatCodes and FormatTypes...
86 _formatCodes["%O"] = FormatType::Base;
87 _formatCodes["%B"] = FormatType::Bold;
88 _formatCodes["%I"] = FormatType::Italic;
89 _formatCodes["%U"] = FormatType::Underline;
90 _formatCodes["%S"] = FormatType::Strikethrough;
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;
98 // Initialize fallback defaults
99 // NOTE: If you change this, update qtui/chatviewsettings.h, too. More explanations available
101 setUseCustomTimestampFormat(false);
102 setTimestampFormatString(" hh:mm:ss");
103 enableSenderPrefixes(false);
104 enableSenderBrackets(true);
106 // BufferView / NickView settings
108 _showBufferViewIcons = _showNickViewIcons = s.value("ShowItemViewIcons", true).toBool();
109 s.notify("ShowItemViewIcons", this, SLOT(showItemViewIconsChanged(QVariant)));
111 _allowMircColors = s.value("AllowMircColors", true).toBool();
112 s.notify("AllowMircColors", this, SLOT(allowMircColorsChanged(QVariant)));
120 qDeleteAll(_metricsCache);
124 void UiStyle::reload()
130 void UiStyle::loadStyleSheet()
132 qDeleteAll(_metricsCache);
133 _metricsCache.clear();
134 _formatCache.clear();
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;
156 styleSheet += customSheet;
158 styleSheet += loadStyleSheet("file:///" + Quassel::optionValue("qss"), true);
160 if (!styleSheet.isEmpty()) {
162 parser.processStyleSheet(styleSheet);
163 QApplication::setPalette(parser.palette());
165 _uiStylePalette = parser.uiStylePalette();
166 _formats = parser.formats();
167 _listItemFormats = parser.listItemFormats();
169 styleSheet = styleSheet.trimmed();
170 if (!styleSheet.isEmpty())
171 qApp->setStyleSheet(styleSheet); // pass the remaining sections to the application
178 QString UiStyle::loadStyleSheet(const QString &styleSheet, bool shouldExist)
180 QString ss = styleSheet;
181 if (ss.startsWith("file:///")) {
187 if (file.open(QFile::ReadOnly)) {
188 QTextStream stream(&file);
189 ss = stream.readAll();
194 qWarning() << "Could not open stylesheet file:" << file.fileName();
202 void UiStyle::updateSystemTimestampFormat()
204 // Does the system locale use AM/PM designators? For example:
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.
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
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);
225 if (regExpMatchAMPM.exactMatch(QLocale::system().timeFormat(QLocale::ShortFormat))) {
227 _systemTimestampFormatString = " h:mm:ss ap";
229 // 24-hour style used
230 _systemTimestampFormatString = " hh:mm:ss";
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!
239 // FIXME The following should trigger a reload/refresh of the chat view.
240 void UiStyle::setUseCustomTimestampFormat(bool enabled)
242 if (_useCustomTimestampFormat != enabled) {
243 _useCustomTimestampFormat = enabled;
247 void UiStyle::setTimestampFormatString(const QString &format)
249 if (_timestampFormatString != format) {
250 _timestampFormatString = format;
254 void UiStyle::enableSenderPrefixes(bool enabled)
256 if (_showSenderPrefixes != enabled) {
257 _showSenderPrefixes = enabled;
261 void UiStyle::enableSenderBrackets(bool enabled)
263 if (_showSenderBrackets != enabled) {
264 _showSenderBrackets = enabled;
269 void UiStyle::allowMircColorsChanged(const QVariant &v)
271 _allowMircColors = v.toBool();
276 /******** ItemView Styling *******/
278 void UiStyle::showItemViewIconsChanged(const QVariant &v)
280 _showBufferViewIcons = _showNickViewIcons = v.toBool();
284 QVariant UiStyle::bufferViewItemData(const QModelIndex &index, int role) const
286 BufferInfo::Type type = (BufferInfo::Type)index.data(NetworkModel::BufferTypeRole).toInt();
287 bool isActive = index.data(NetworkModel::ItemActiveRole).toBool();
289 if (role == Qt::DecorationRole) {
290 if (!_showBufferViewIcons)
294 case BufferInfo::ChannelBuffer:
296 return _channelJoinedIcon;
298 return _channelPartedIcon;
299 case BufferInfo::QueryBuffer:
301 return _userOfflineIcon;
302 if (index.data(NetworkModel::UserAwayRole).toBool())
303 return _userAwayIcon;
305 return _userOnlineIcon;
311 ItemFormatType fmtType = ItemFormatType::BufferViewItem;
313 case BufferInfo::StatusBuffer:
314 fmtType |= ItemFormatType::NetworkItem;
316 case BufferInfo::ChannelBuffer:
317 fmtType |= ItemFormatType::ChannelBufferItem;
319 case BufferInfo::QueryBuffer:
320 fmtType |= ItemFormatType::QueryBufferItem;
326 QTextCharFormat fmt = _listItemFormats.value(ItemFormatType::BufferViewItem);
327 fmt.merge(_listItemFormats.value(fmtType));
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));
334 else if (activity & BufferInfo::NewMessage) {
335 fmt.merge(_listItemFormats.value(ItemFormatType::BufferViewItem | ItemFormatType::UnreadBuffer));
336 fmt.merge(_listItemFormats.value(fmtType | ItemFormatType::UnreadBuffer));
338 else if (activity & BufferInfo::OtherActivity) {
339 fmt.merge(_listItemFormats.value(ItemFormatType::BufferViewItem | ItemFormatType::ActiveBuffer));
340 fmt.merge(_listItemFormats.value(fmtType | ItemFormatType::ActiveBuffer));
342 else if (!isActive) {
343 fmt.merge(_listItemFormats.value(ItemFormatType::BufferViewItem | ItemFormatType::InactiveBuffer));
344 fmt.merge(_listItemFormats.value(fmtType | ItemFormatType::InactiveBuffer));
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));
351 return itemData(role, fmt);
355 QVariant UiStyle::nickViewItemData(const QModelIndex &index, int role) const
357 NetworkModel::ItemType type = (NetworkModel::ItemType)index.data(NetworkModel::ItemTypeRole).toInt();
359 if (role == Qt::DecorationRole) {
360 if (!_showNickViewIcons)
364 case NetworkModel::UserCategoryItemType:
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;
373 case NetworkModel::IrcUserItemType:
374 if (index.data(NetworkModel::ItemActiveRole).toBool())
375 return _userOnlineIcon;
377 return _userAwayIcon;
383 QTextCharFormat fmt = _listItemFormats.value(ItemFormatType::NickViewItem);
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));
393 case NetworkModel::UserCategoryItemType:
394 fmt.merge(_listItemFormats.value(ItemFormatType::NickViewItem | ItemFormatType::UserCategoryItem));
400 return itemData(role, fmt);
404 QVariant UiStyle::itemData(int role, const QTextCharFormat &format) const
408 return format.font();
409 case Qt::ForegroundRole:
410 return format.property(QTextFormat::ForegroundBrush);
411 case Qt::BackgroundRole:
412 return format.property(QTextFormat::BackgroundBrush);
419 /******** Caching *******/
421 QTextCharFormat UiStyle::parsedFormat(quint64 key) const
423 return _formats.value(key, QTextCharFormat());
428 // Create unique key for given Format object and message label
429 QString formatKey(const UiStyle::Format &format, UiStyle::MessageLabel label)
431 return QString::number(format.type | label, 16)
432 + (format.foreground.isValid() ? format.foreground.name() : "#------")
433 + (format.background.isValid() ? format.background.name() : "#------");
438 QTextCharFormat UiStyle::cachedFormat(const Format &format, MessageLabel messageLabel) const
440 return _formatCache.value(formatKey(format, messageLabel), QTextCharFormat());
444 void UiStyle::setCachedFormat(const QTextCharFormat &charFormat, const Format &format, MessageLabel messageLabel) const
446 _formatCache[formatKey(format, messageLabel)] = charFormat;
450 QFontMetricsF *UiStyle::fontMetrics(FormatType ftype, MessageLabel label) const
452 // QFontMetricsF is not assignable, so we need to store pointers :/
453 quint64 key = ftype | label;
455 if (_metricsCache.contains(key))
456 return _metricsCache.value(key);
458 return (_metricsCache[key] = new QFontMetricsF(format({ftype, {}, {}}, label).font()));
462 /******** Generate formats ********/
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
468 if (format.type == FormatType::Invalid)
471 // Check if we have exactly this format readily cached already
472 QTextCharFormat charFormat = cachedFormat(format, label);
473 if (charFormat.properties().count())
476 // Merge all formats except mIRC and extended colors
477 mergeFormat(charFormat, format, label & 0xffff0000); // keep nickhash in label
478 for (quint32 mask = 0x00000001; mask <= static_cast<quint32>(MessageLabel::Selected); mask <<= 1) {
479 if (static_cast<quint32>(label) & mask) {
480 mergeFormat(charFormat, format, label & (mask | 0xffff0000));
484 // Merge mIRC and extended colors, if appropriate. These override any color set previously in the format,
485 // unless the AllowForegroundOverride or AllowBackgroundOverride properties are set (via stylesheet).
486 if (_allowMircColors) {
487 mergeColors(charFormat, format, MessageLabel::None);
488 for (quint32 mask = 0x00000001; mask <= static_cast<quint32>(MessageLabel::Selected); mask <<= 1) {
489 if (static_cast<quint32>(label) & mask) {
490 mergeColors(charFormat, format, label & mask);
495 setCachedFormat(charFormat, format, label);
500 void UiStyle::mergeFormat(QTextCharFormat &charFormat, const Format &format, MessageLabel label) const
502 mergeSubElementFormat(charFormat, format.type & 0x00ff, label);
504 // TODO: allow combinations for mirc formats and colors (each), e.g. setting a special format for "bold and italic"
505 // or "foreground 01 and background 03"
506 if ((format.type & 0xfff00) != FormatType::Base) { // element format
507 for (quint32 mask = 0x00100; mask <= 0x80000; mask <<= 1) {
508 if ((format.type & mask) != FormatType::Base) {
509 mergeSubElementFormat(charFormat, format.type & (mask | 0xff), label);
516 // Merge a subelement format into an existing message format
517 void UiStyle::mergeSubElementFormat(QTextCharFormat &fmt, FormatType ftype, MessageLabel label) const
519 quint64 key = ftype | label;
520 fmt.merge(parsedFormat(key & 0x0000ffffffffff00ull)); // label + subelement
521 fmt.merge(parsedFormat(key & 0x0000ffffffffffffull)); // label + subelement + msgtype
522 fmt.merge(parsedFormat(key & 0xffffffffffffff00ull)); // label + subelement + nickhash
523 fmt.merge(parsedFormat(key & 0xffffffffffffffffull)); // label + subelement + nickhash + msgtype
527 void UiStyle::mergeColors(QTextCharFormat &charFormat, const Format &format, MessageLabel label) const
529 bool allowFg = charFormat.property(static_cast<int>(FormatProperty::AllowForegroundOverride)).toBool();
530 bool allowBg = charFormat.property(static_cast<int>(FormatProperty::AllowBackgroundOverride)).toBool();
532 // Classic mIRC colors (styleable)
533 // We assume that those can't be combined with subelement and message types.
534 if (allowFg && (format.type & 0x00400000) != FormatType::Base)
535 charFormat.merge(parsedFormat((format.type & 0x0f400000) | label)); // foreground
536 if (allowBg && (format.type & 0x00800000) != FormatType::Base)
537 charFormat.merge(parsedFormat((format.type & 0xf0800000) | label)); // background
538 if (allowFg && allowBg && (format.type & 0x00c00000) == static_cast<FormatType>(0x00c00000))
539 charFormat.merge(parsedFormat((format.type & 0xffc00000) | label)); // combination
541 // Extended mIRC colors (hardcoded)
542 if (allowFg && format.foreground.isValid())
543 charFormat.setForeground(format.foreground);
544 if (allowBg && format.background.isValid())
545 charFormat.setBackground(format.background);
549 UiStyle::FormatType UiStyle::formatType(Message::Type msgType)
553 return FormatType::PlainMsg;
554 case Message::Notice:
555 return FormatType::NoticeMsg;
556 case Message::Action:
557 return FormatType::ActionMsg;
559 return FormatType::NickMsg;
561 return FormatType::ModeMsg;
563 return FormatType::JoinMsg;
565 return FormatType::PartMsg;
567 return FormatType::QuitMsg;
569 return FormatType::KickMsg;
571 return FormatType::KillMsg;
572 case Message::Server:
573 return FormatType::ServerMsg;
575 return FormatType::InfoMsg;
577 return FormatType::ErrorMsg;
578 case Message::DayChange:
579 return FormatType::DayChangeMsg;
581 return FormatType::TopicMsg;
582 case Message::NetsplitJoin:
583 return FormatType::NetsplitJoinMsg;
584 case Message::NetsplitQuit:
585 return FormatType::NetsplitQuitMsg;
586 case Message::Invite:
587 return FormatType::InviteMsg;
589 //Q_ASSERT(false); // we need to handle all message types
590 qWarning() << Q_FUNC_INFO << "Unknown message type:" << msgType;
591 return FormatType::ErrorMsg;
595 UiStyle::FormatType UiStyle::formatType(const QString &code)
597 if (_formatCodes.contains(code))
598 return _formatCodes.value(code);
599 return FormatType::Invalid;
603 QString UiStyle::formatCode(FormatType ftype)
605 return _formatCodes.key(ftype);
609 QList<QTextLayout::FormatRange> UiStyle::toTextLayoutList(const FormatList &formatList, int textLength, MessageLabel messageLabel) const
611 QList<QTextLayout::FormatRange> formatRanges;
612 QTextLayout::FormatRange range;
614 for (i = 0; i < formatList.size(); i++) {
615 range.format = format(formatList.at(i).second, messageLabel);
616 range.start = formatList.at(i).first;
618 formatRanges.last().length = range.start - formatRanges.last().start;
619 formatRanges.append(range);
622 formatRanges.last().length = textLength - formatRanges.last().start;
627 // This method expects a well-formatted string, there is no error checking!
628 // Since we create those ourselves, we should be pretty safe that nobody does something crappy here.
629 UiStyle::StyledString UiStyle::styleString(const QString &s_, FormatType baseFormat)
633 result.formatList.emplace_back(std::make_pair(quint16{0}, Format{baseFormat, {}, {}}));
635 if (s.length() > 65535) {
636 // We use quint16 for indexes
637 qWarning() << QString("String too long to be styled: %1").arg(s);
638 result.plainText = s;
642 Format curfmt{baseFormat, {}, {}};
643 QChar fgChar{'f'}; // character to indicate foreground color, changed when reversing
645 int pos = 0; quint16 length = 0;
647 pos = s.indexOf('%', pos);
649 if (s[pos+1] == '%') { // escaped %, we just remove one and continue
654 if (s[pos+1] == 'D' && s[pos+2] == 'c') { // mIRC color code
655 if (s[pos+3] == '-') { // color off
656 curfmt.type &= 0x003fffff;
657 curfmt.foreground = QColor{};
658 curfmt.background = QColor{};
662 quint32 color = 10 * s[pos+4].digitValue() + s[pos+5].digitValue();
663 // Color values 0-15 are traditional mIRC colors, defined in the stylesheet and thus going through the format engine
664 // Larger color values are hardcoded and applied separately (cf. https://modern.ircdocs.horse/formatting.html#colors-16-98)
665 if (s[pos+3] == fgChar) {
667 // Traditional mIRC color, defined in the stylesheet
668 curfmt.type &= 0xf0ffffff;
669 curfmt.type |= color << 24 | 0x00400000;
670 curfmt.foreground = QColor{};
673 curfmt.type &= 0xf0bfffff; // mask out traditional foreground color
674 curfmt.foreground = extendedMircColor(color);
679 curfmt.type &= 0x0fffffff;
680 curfmt.type |= color << 28 | 0x00800000;
681 curfmt.background = QColor{};
684 curfmt.type &= 0x0f7fffff; // mask out traditional background color
685 curfmt.background = extendedMircColor(color);
691 else if (s[pos+1] == 'D' && s[pos+2] == 'h') { // Hex color
692 QColor color{s.mid(pos+4, 7)};
693 if (s[pos+3] == fgChar) {
694 curfmt.type &= 0xf0bfffff; // mask out mIRC foreground color
695 curfmt.foreground = std::move(color);
698 curfmt.type &= 0x0f7fffff; // mask out mIRC background color
699 curfmt.background = std::move(color);
703 else if (s[pos+1] == 'O') { // reset formatting
704 curfmt.type &= 0x000000ff; // we keep message type-specific formatting
705 curfmt.foreground = QColor{};
706 curfmt.background = QColor{};
710 else if (s[pos+1] == 'R') { // Reverse colors
711 fgChar = (fgChar == 'f' ? 'b' : 'f');
712 quint32 orig = static_cast<quint32>(curfmt.type & 0xffc00000);
713 curfmt.type &= 0x003fffff;
714 curfmt.type |= (orig & 0x00400000) <<1;
715 curfmt.type |= (orig & 0x0f000000) <<4;
716 curfmt.type |= (orig & 0x00800000) >>1;
717 curfmt.type |= (orig & 0xf0000000) >>4;
718 std::swap(curfmt.foreground, curfmt.background);
721 else { // all others are toggles
722 QString code = QString("%") + s[pos+1];
723 if (s[pos+1] == 'D') code += s[pos+2];
724 FormatType ftype = formatType(code);
725 if (ftype == FormatType::Invalid) {
727 qWarning() << (QString("Invalid format code in string: %1").arg(s));
730 curfmt.type ^= ftype;
731 length = code.length();
733 s.remove(pos, length);
734 if (pos == result.formatList.back().first)
735 result.formatList.back().second = curfmt;
737 result.formatList.emplace_back(std::make_pair(pos, curfmt));
739 result.plainText = s;
744 QString UiStyle::mircToInternal(const QString &mirc_)
747 mirc.reserve(mirc_.size());
748 foreach (const QChar &c, mirc_) {
749 if ((c < '\x20' || c == '\x7f') && c != '\x03' && c != '\x04') {
750 switch (c.unicode()) {
761 // Monospace not supported yet
777 mirc += QChar(0x2421);
780 mirc += QChar(0x2400 + c.unicode());
789 // Now we bring the color codes (\x03) in a sane format that can be parsed more easily later.
790 // %Dcfxx is foreground, %Dcbxx is background color, where xx is a 2 digit dec number denoting the color code.
791 // %Dc- turns color off.
792 // Note: We use the "mirc standard" as described in <http://www.mirc.co.uk/help/color.txt>.
793 // This means that we don't accept something like \x03,5 (even though others, like WeeChat, do).
797 pos = mirc.indexOf('\x03', pos);
799 break; // no more mirc color codes
801 int l = mirc.length();
803 // check for fg color
804 if (i < l && mirc[i].isDigit()) {
806 if (i < l && mirc[i].isDigit())
807 num.append(mirc[i++]);
810 ins = QString("%Dcf%1").arg(num);
812 if (i+1 < l && mirc[i] == ',' && mirc[i+1].isDigit()) {
815 if (i < l && mirc[i].isDigit())
816 num.append(mirc[i++]);
819 ins += QString("%Dcb%1").arg(num);
825 mirc.replace(pos, i-pos, ins);
829 // Hex colors, as specified in https://modern.ircdocs.horse/formatting.html#hex-color
830 // %Dhf#rrggbb is foreground, %Dhb#rrggbb is background
832 static const QRegExp rx{"[\\da-fA-F]{6}"};
835 if (pos >= mirc.length())
837 pos = mirc.indexOf('\x04', pos);
842 auto num = mirc.mid(i, 6);
843 if (!num.isEmpty() && rx.exactMatch(num)) {
844 ins = "%Dhf#" + num.toLower();
846 if (i < mirc.length() && mirc[i] == ',' && !(num = mirc.mid(i + 1, 6)).isEmpty() && rx.exactMatch(num)) {
847 ins += "%Dhb#" + num.toLower();
854 mirc.replace(pos, i - pos, ins);
863 QString UiStyle::systemTimestampFormatString()
865 if (_systemTimestampFormatString.isEmpty()) {
866 // Calculate and cache the system timestamp format string
867 updateSystemTimestampFormat();
869 return _systemTimestampFormatString;
873 QString UiStyle::timestampFormatString()
875 if (useCustomTimestampFormat()) {
876 return _timestampFormatString;
878 return systemTimestampFormatString();
883 /***********************************************************************************/
884 UiStyle::StyledMessage::StyledMessage(const Message &msg)
888 // Don't compute the sender hash for message types without a nickname embedded
889 case Message::Server:
892 case Message::DayChange:
894 case Message::Invite:
895 // Don't compute the sender hash for messages with multiple nicks
896 // Fixing this without breaking themes would be.. complex.
897 case Message::NetsplitJoin:
898 case Message::NetsplitQuit:
900 // Don't compute the sender hash for message types that are not yet completed elsewhere
905 // Compute the sender hash for all other message types
912 void UiStyle::StyledMessage::style() const
914 QString user = userFromMask(sender());
915 QString host = hostFromMask(sender());
916 QString nick = nickFromMask(sender());
917 QString txt = UiStyle::mircToInternal(contents());
918 QString bufferName = bufferInfo().bufferName();
919 bufferName.replace('%', "%%"); // well, you _can_ have a % in a buffername apparently... -_-
920 host.replace('%', "%%"); // hostnames too...
921 user.replace('%', "%%"); // and the username...
922 nick.replace('%', "%%"); // ... and then there's totally RFC-violating servers like justin.tv m(
923 const int maxNetsplitNicks = 15;
928 t = QString("%1").arg(txt); break;
929 case Message::Notice:
930 t = QString("%1").arg(txt); break;
931 case Message::Action:
932 t = QString("%DN%1%DN %2").arg(nick).arg(txt);
936 if (nick == contents()) t = tr("You are now known as %DN%1%DN").arg(txt);
937 else t = tr("%DN%1%DN is now known as %DN%2%DN").arg(nick, txt);
941 if (nick.isEmpty()) t = tr("User mode: %DM%1%DM").arg(txt);
942 else t = tr("Mode %DM%1%DM by %DN%2%DN").arg(txt, nick);
946 t = tr("%DN%1%DN %DH(%2@%3)%DH has joined %DC%4%DC").arg(nick, user, host, bufferName); break;
949 t = tr("%DN%1%DN %DH(%2@%3)%DH has left %DC%4%DC").arg(nick, user, host, bufferName);
950 if (!txt.isEmpty()) t = QString("%1 (%2)").arg(t).arg(txt);
954 t = tr("%DN%1%DN %DH(%2@%3)%DH has quit").arg(nick, user, host);
955 if (!txt.isEmpty()) t = QString("%1 (%2)").arg(t).arg(txt);
959 QString victim = txt.section(" ", 0, 0);
960 QString kickmsg = txt.section(" ", 1);
962 t = tr("%DN%1%DN has kicked %DN%2%DN from %DC%3%DC").arg(nick).arg(victim).arg(bufferName);
963 if (!kickmsg.isEmpty()) t = QString("%1 (%2)").arg(t).arg(kickmsg);
966 //case Message::Kill: FIXME
968 case Message::Server:
969 t = QString("%1").arg(txt); break;
971 t = QString("%1").arg(txt); break;
973 t = QString("%1").arg(txt); break;
974 case Message::DayChange:
976 //: Day Change Message
977 t = tr("{Day changed to %1}").arg(timestamp().date().toString(Qt::DefaultLocaleLongDate));
981 t = QString("%1").arg(txt); break;
982 case Message::NetsplitJoin:
984 QStringList users = txt.split("#:#");
985 QStringList servers = users.takeLast().split(" ");
987 for (int i = 0; i < users.count() && i < maxNetsplitNicks; i++)
988 users[i] = nickFromMask(users.at(i));
990 t = tr("Netsplit between %DH%1%DH and %DH%2%DH ended. Users joined: ").arg(servers.at(0), servers.at(1));
991 if (users.count() <= maxNetsplitNicks)
992 t.append(QString("%DN%1%DN").arg(users.join(", ")));
994 t.append(tr("%DN%1%DN (%2 more)").arg(static_cast<QStringList>(users.mid(0, maxNetsplitNicks)).join(", ")).arg(users.count() - maxNetsplitNicks));
997 case Message::NetsplitQuit:
999 QStringList users = txt.split("#:#");
1000 QStringList servers = users.takeLast().split(" ");
1002 for (int i = 0; i < users.count() && i < maxNetsplitNicks; i++)
1003 users[i] = nickFromMask(users.at(i));
1005 t = tr("Netsplit between %DH%1%DH and %DH%2%DH. Users quit: ").arg(servers.at(0), servers.at(1));
1007 if (users.count() <= maxNetsplitNicks)
1008 t.append(QString("%DN%1%DN").arg(users.join(", ")));
1010 t.append(tr("%DN%1%DN (%2 more)").arg(static_cast<QStringList>(users.mid(0, maxNetsplitNicks)).join(", ")).arg(users.count() - maxNetsplitNicks));
1013 case Message::Invite:
1014 t = QString("%1").arg(txt); break;
1016 t = QString("[%1]").arg(txt);
1018 _contents = UiStyle::styleString(t, UiStyle::formatType(type()));
1022 const QString &UiStyle::StyledMessage::plainContents() const
1024 if (_contents.plainText.isNull())
1027 return _contents.plainText;
1031 const UiStyle::FormatList &UiStyle::StyledMessage::contentsFormatList() const
1033 if (_contents.plainText.isNull())
1036 return _contents.formatList;
1040 QString UiStyle::StyledMessage::decoratedTimestamp() const
1042 return timestamp().toLocalTime().toString(UiStyle::timestampFormatString());
1046 QString UiStyle::StyledMessage::plainSender() const
1049 case Message::Plain:
1050 case Message::Notice:
1051 return nickFromMask(sender());
1058 QString UiStyle::StyledMessage::decoratedSender() const
1060 QString _senderPrefixes;
1061 if (_showSenderPrefixes) {
1062 _senderPrefixes = senderPrefixes();
1066 case Message::Plain:
1067 if (_showSenderBrackets)
1068 return QString("<%1%2>").arg(_senderPrefixes, plainSender());
1070 return QString("%1%2").arg(_senderPrefixes, plainSender());
1071 case Message::Notice:
1072 return QString("[%1%2]").arg(_senderPrefixes, plainSender());
1073 case Message::Action:
1089 case Message::Server:
1093 case Message::Error:
1095 case Message::DayChange:
1097 case Message::Topic:
1099 case Message::NetsplitJoin:
1101 case Message::NetsplitQuit:
1103 case Message::Invite:
1107 return QString("%1%2").arg(_senderPrefixes, plainSender());
1111 // FIXME hardcoded to 16 sender hashes
1112 quint8 UiStyle::StyledMessage::senderHash() const
1114 if (_senderHash != 0xff)
1119 // HACK: Until multiple nicknames with different colors can be solved in the theming engine,
1120 // for /nick change notifications, use the color of the new nickname (if possible), not the old
1122 if (type() == Message::Nick) {
1123 // New nickname is given as contents. Change to that.
1124 nick = stripFormatCodes(contents()).toLower();
1126 // Just use the sender directly
1127 nick = nickFromMask(sender()).toLower();
1130 if (!nick.isEmpty()) {
1132 while (chopCount < nick.size() && nick.at(nick.count() - 1 - chopCount) == '_')
1134 if (chopCount < nick.size())
1135 nick.chop(chopCount);
1137 quint16 hash = qChecksum(nick.toLatin1().data(), nick.toLatin1().size());
1138 return (_senderHash = (hash & 0xf) + 1);
1141 /***********************************************************************************/
1143 #if QT_VERSION < 0x050000
1144 uint qHash(UiStyle::ItemFormatType key)
1146 return qHash(static_cast<quint32>(key));
1151 uint qHash(UiStyle::ItemFormatType key, uint seed)
1153 return qHash(static_cast<quint32>(key), seed);
1157 UiStyle::FormatType operator|(UiStyle::FormatType lhs, UiStyle::FormatType rhs)
1159 return static_cast<UiStyle::FormatType>(static_cast<quint32>(lhs) | static_cast<quint32>(rhs));
1162 UiStyle::FormatType& operator|=(UiStyle::FormatType& lhs, UiStyle::FormatType rhs)
1164 lhs = static_cast<UiStyle::FormatType>(static_cast<quint32>(lhs) | static_cast<quint32>(rhs));
1169 UiStyle::FormatType operator|(UiStyle::FormatType lhs, quint32 rhs)
1171 return static_cast<UiStyle::FormatType>(static_cast<quint32>(lhs) | rhs);
1175 UiStyle::FormatType& operator|=(UiStyle::FormatType &lhs, quint32 rhs)
1177 lhs = static_cast<UiStyle::FormatType>(static_cast<quint32>(lhs) | rhs);
1182 UiStyle::FormatType operator&(UiStyle::FormatType lhs, UiStyle::FormatType rhs)
1184 return static_cast<UiStyle::FormatType>(static_cast<quint32>(lhs) & static_cast<quint32>(rhs));
1188 UiStyle::FormatType& operator&=(UiStyle::FormatType &lhs, UiStyle::FormatType rhs)
1190 lhs = static_cast<UiStyle::FormatType>(static_cast<quint32>(lhs) & static_cast<quint32>(rhs));
1195 UiStyle::FormatType operator&(UiStyle::FormatType lhs, quint32 rhs)
1197 return static_cast<UiStyle::FormatType>(static_cast<quint32>(lhs) & rhs);
1201 UiStyle::FormatType& operator&=(UiStyle::FormatType &lhs, quint32 rhs)
1203 lhs = static_cast<UiStyle::FormatType>(static_cast<quint32>(lhs) & rhs);
1208 UiStyle::FormatType& operator^=(UiStyle::FormatType &lhs, UiStyle::FormatType rhs)
1210 lhs = static_cast<UiStyle::FormatType>(static_cast<quint32>(lhs) ^ static_cast<quint32>(rhs));
1215 UiStyle::MessageLabel operator|(UiStyle::MessageLabel lhs, UiStyle::MessageLabel rhs)
1217 return static_cast<UiStyle::MessageLabel>(static_cast<quint32>(lhs) | static_cast<quint32>(rhs));
1221 UiStyle::MessageLabel& operator|=(UiStyle::MessageLabel &lhs, UiStyle::MessageLabel rhs)
1223 lhs = static_cast<UiStyle::MessageLabel>(static_cast<quint32>(lhs) | static_cast<quint32>(rhs));
1228 UiStyle::MessageLabel operator&(UiStyle::MessageLabel lhs, quint32 rhs)
1230 return static_cast<UiStyle::MessageLabel>(static_cast<quint32>(lhs) & rhs);
1234 UiStyle::MessageLabel& operator&=(UiStyle::MessageLabel &lhs, UiStyle::MessageLabel rhs)
1236 lhs = static_cast<UiStyle::MessageLabel>(static_cast<quint32>(lhs) & static_cast<quint32>(rhs));
1241 quint64 operator|(UiStyle::FormatType lhs, UiStyle::MessageLabel rhs)
1243 return static_cast<quint64>(lhs) | (static_cast<quint64>(rhs) << 32ull);
1247 UiStyle::ItemFormatType operator|(UiStyle::ItemFormatType lhs, UiStyle::ItemFormatType rhs)
1249 return static_cast<UiStyle::ItemFormatType>(static_cast<quint32>(lhs) | static_cast<quint32>(rhs));
1253 UiStyle::ItemFormatType& operator|=(UiStyle::ItemFormatType &lhs, UiStyle::ItemFormatType rhs)
1255 lhs = static_cast<UiStyle::ItemFormatType>(static_cast<quint32>(lhs) | static_cast<quint32>(rhs));
1259 /***********************************************************************************/
1261 QDataStream &operator<<(QDataStream &out, const UiStyle::FormatList &formatList)
1263 out << static_cast<quint16>(formatList.size());
1264 UiStyle::FormatList::const_iterator it = formatList.begin();
1265 while (it != formatList.end()) {
1267 << static_cast<quint32>(it->second.type)
1268 << it->second.foreground
1269 << it->second.background;
1276 QDataStream &operator>>(QDataStream &in, UiStyle::FormatList &formatList)
1280 for (quint16 i = 0; i < cnt; i++) {
1285 in >> pos >> ftype >> foreground >> background;
1286 formatList.emplace_back(std::make_pair(quint16{pos}, UiStyle::Format{static_cast<UiStyle::FormatType>(ftype), foreground, background}));