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>
27 #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 UiStyle::SenderPrefixMode UiStyle::_senderPrefixDisplay; /// Display of prefix modes before sender
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{icon::get("irc-channel-active")}
67 , _channelPartedIcon{icon::get("irc-channel-inactive")}
68 , _userOfflineIcon{icon::get({"im-user-offline", "user-offline"})}
69 , _userOnlineIcon{icon::get({"im-user-online", "im-user", "user-available"})}
70 , _userAwayIcon{icon::get({"im-user-away", "user-away"})}
71 , _categoryOpIcon{icon::get("irc-operator")}
72 , _categoryVoiceIcon{icon::get("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 setSenderPrefixDisplay(UiStyle::SenderPrefixMode::HighestMode);
104 enableSenderBrackets(false);
106 // BufferView / NickView settings
108 s.initAndNotify("ShowItemViewIcons", this, &UiStyle::showItemViewIconsChanged, true);
109 s.initAndNotify("AllowMircColors", this, &UiStyle::allowMircColorsChanged, true);
117 qDeleteAll(_metricsCache);
121 void UiStyle::reload()
127 void UiStyle::loadStyleSheet()
129 qDeleteAll(_metricsCache);
130 _metricsCache.clear();
131 _formatCache.clear();
137 styleSheet += loadStyleSheet("file:///" + Quassel::findDataFilePath("stylesheets/default.qss"));
138 styleSheet += loadStyleSheet("file:///" + Quassel::configDirPath() + "settings.qss");
139 if (s.value("UseCustomStyleSheet", false).toBool()) {
140 QString customSheetPath(s.value("CustomStyleSheetPath").toString());
141 QString customSheet = loadStyleSheet("file:///" + customSheetPath, true);
142 if (customSheet.isEmpty()) {
143 // MIGRATION: changed default install path for data from /usr/share/apps to /usr/share
144 if (customSheetPath.startsWith("/usr/share/apps/quassel")) {
145 customSheetPath.replace(QRegExp("^/usr/share/apps"), "/usr/share");
146 customSheet = loadStyleSheet("file:///" + customSheetPath, true);
147 if (!customSheet.isEmpty()) {
148 s.setValue("CustomStyleSheetPath", customSheetPath);
149 qDebug() << "Custom stylesheet path migrated to" << customSheetPath;
153 styleSheet += customSheet;
155 styleSheet += loadStyleSheet("file:///" + Quassel::optionValue("qss"), true);
157 if (!styleSheet.isEmpty()) {
159 parser.processStyleSheet(styleSheet);
160 QApplication::setPalette(parser.palette());
162 _uiStylePalette = parser.uiStylePalette();
163 _formats = parser.formats();
164 _listItemFormats = parser.listItemFormats();
166 styleSheet = styleSheet.trimmed();
167 if (!styleSheet.isEmpty())
168 qApp->setStyleSheet(styleSheet); // pass the remaining sections to the application
175 QString UiStyle::loadStyleSheet(const QString &styleSheet, bool shouldExist)
177 QString ss = styleSheet;
178 if (ss.startsWith("file:///")) {
184 if (file.open(QFile::ReadOnly)) {
185 QTextStream stream(&file);
186 ss = stream.readAll();
191 qWarning() << "Could not open stylesheet file:" << file.fileName();
199 void UiStyle::updateSystemTimestampFormat()
201 // Does the system locale use AM/PM designators? For example:
205 // 24-hour: hh:mm ADD things
206 // For timestamp format, see https://doc.qt.io/qt-5/qdatetime.html#toString
207 // This won't update if the system locale is changed while Quassel is running. If need be,
208 // Quassel could hook into notifications of changing system locale to update this.
210 // Match any AP or A designation if on a word boundary, including underscores.
211 // .*(\b|_)(A|AP)(\b|_).*
212 // .* Match any number of characters
213 // \b Match a word boundary, i.e. "AAA.BBB", "." is matched
214 // _ Match the literal character '_' (not considered a word boundary)
215 // (X|Y) Match either X or Y, exactly
217 // Note that '\' must be escaped as '\\'
218 // QRegExp does not support (?> ...), so it's replaced with standard matching, (...)
219 // Helpful interactive website for debugging and explaining: https://regex101.com/
220 const QRegExp regExpMatchAMPM(".*(\\b|_)(A|AP)(\\b|_).*", Qt::CaseInsensitive);
222 if (regExpMatchAMPM.exactMatch(QLocale().timeFormat(QLocale::ShortFormat))) {
224 _systemTimestampFormatString = " h:mm:ss ap";
226 // 24-hour style used
227 _systemTimestampFormatString = " hh:mm:ss";
229 // Include a space to give the timestamp a small bit of padding between the border of the chat
230 // buffer window and the numbers. Helps with readability.
231 // If you change this to include brackets, e.g. "[hh:mm:ss]", also update
232 // ChatScene::updateTimestampHasBrackets() to true or false as needed!
236 // FIXME The following should trigger a reload/refresh of the chat view.
237 void UiStyle::setUseCustomTimestampFormat(bool enabled)
239 if (_useCustomTimestampFormat != enabled) {
240 _useCustomTimestampFormat = enabled;
244 void UiStyle::setTimestampFormatString(const QString &format)
246 if (_timestampFormatString != format) {
247 _timestampFormatString = format;
251 void UiStyle::setSenderPrefixDisplay(UiStyle::SenderPrefixMode mode)
253 if (_senderPrefixDisplay != mode) {
254 _senderPrefixDisplay = mode;
258 void UiStyle::enableSenderBrackets(bool enabled)
260 if (_showSenderBrackets != enabled) {
261 _showSenderBrackets = enabled;
266 void UiStyle::allowMircColorsChanged(const QVariant &v)
268 _allowMircColors = v.toBool();
273 /******** ItemView Styling *******/
275 void UiStyle::showItemViewIconsChanged(const QVariant &v)
277 _showBufferViewIcons = _showNickViewIcons = v.toBool();
281 QVariant UiStyle::bufferViewItemData(const QModelIndex &index, int role) const
283 BufferInfo::Type type = (BufferInfo::Type)index.data(NetworkModel::BufferTypeRole).toInt();
284 bool isActive = index.data(NetworkModel::ItemActiveRole).toBool();
286 if (role == Qt::DecorationRole) {
287 if (!_showBufferViewIcons)
291 case BufferInfo::ChannelBuffer:
293 return _channelJoinedIcon;
295 return _channelPartedIcon;
296 case BufferInfo::QueryBuffer:
298 return _userOfflineIcon;
299 if (index.data(NetworkModel::UserAwayRole).toBool())
300 return _userAwayIcon;
302 return _userOnlineIcon;
308 ItemFormatType fmtType = ItemFormatType::BufferViewItem;
310 case BufferInfo::StatusBuffer:
311 fmtType |= ItemFormatType::NetworkItem;
313 case BufferInfo::ChannelBuffer:
314 fmtType |= ItemFormatType::ChannelBufferItem;
316 case BufferInfo::QueryBuffer:
317 fmtType |= ItemFormatType::QueryBufferItem;
323 QTextCharFormat fmt = _listItemFormats.value(ItemFormatType::BufferViewItem);
324 fmt.merge(_listItemFormats.value(fmtType));
326 BufferInfo::ActivityLevel activity = (BufferInfo::ActivityLevel)index.data(NetworkModel::BufferActivityRole).toInt();
327 if (activity & BufferInfo::Highlight) {
328 fmt.merge(_listItemFormats.value(ItemFormatType::BufferViewItem | ItemFormatType::HighlightedBuffer));
329 fmt.merge(_listItemFormats.value(fmtType | ItemFormatType::HighlightedBuffer));
331 else if (activity & BufferInfo::NewMessage) {
332 fmt.merge(_listItemFormats.value(ItemFormatType::BufferViewItem | ItemFormatType::UnreadBuffer));
333 fmt.merge(_listItemFormats.value(fmtType | ItemFormatType::UnreadBuffer));
335 else if (activity & BufferInfo::OtherActivity) {
336 fmt.merge(_listItemFormats.value(ItemFormatType::BufferViewItem | ItemFormatType::ActiveBuffer));
337 fmt.merge(_listItemFormats.value(fmtType | ItemFormatType::ActiveBuffer));
339 else if (!isActive) {
340 fmt.merge(_listItemFormats.value(ItemFormatType::BufferViewItem | ItemFormatType::InactiveBuffer));
341 fmt.merge(_listItemFormats.value(fmtType | ItemFormatType::InactiveBuffer));
343 else if (index.data(NetworkModel::UserAwayRole).toBool()) {
344 fmt.merge(_listItemFormats.value(ItemFormatType::BufferViewItem | ItemFormatType::UserAway));
345 fmt.merge(_listItemFormats.value(fmtType | ItemFormatType::UserAway));
348 return itemData(role, fmt);
352 QVariant UiStyle::nickViewItemData(const QModelIndex &index, int role) const
354 NetworkModel::ItemType type = (NetworkModel::ItemType)index.data(NetworkModel::ItemTypeRole).toInt();
356 if (role == Qt::DecorationRole) {
357 if (!_showNickViewIcons)
361 case NetworkModel::UserCategoryItemType:
363 int categoryId = index.data(TreeModel::SortRole).toInt();
364 if (categoryId <= _opIconLimit)
365 return _categoryOpIcon;
366 if (categoryId <= _voiceIconLimit)
367 return _categoryVoiceIcon;
368 return _userOnlineIcon;
370 case NetworkModel::IrcUserItemType:
371 if (index.data(NetworkModel::ItemActiveRole).toBool())
372 return _userOnlineIcon;
374 return _userAwayIcon;
380 QTextCharFormat fmt = _listItemFormats.value(ItemFormatType::NickViewItem);
383 case NetworkModel::IrcUserItemType:
384 fmt.merge(_listItemFormats.value(ItemFormatType::NickViewItem | ItemFormatType::IrcUserItem));
385 if (!index.data(NetworkModel::ItemActiveRole).toBool()) {
386 fmt.merge(_listItemFormats.value(ItemFormatType::NickViewItem | ItemFormatType::UserAway));
387 fmt.merge(_listItemFormats.value(ItemFormatType::NickViewItem | ItemFormatType::IrcUserItem | ItemFormatType::UserAway));
390 case NetworkModel::UserCategoryItemType:
391 fmt.merge(_listItemFormats.value(ItemFormatType::NickViewItem | ItemFormatType::UserCategoryItem));
397 return itemData(role, fmt);
401 QVariant UiStyle::itemData(int role, const QTextCharFormat &format) const
405 return format.font();
406 case Qt::ForegroundRole:
407 return format.property(QTextFormat::ForegroundBrush);
408 case Qt::BackgroundRole:
409 return format.property(QTextFormat::BackgroundBrush);
416 /******** Caching *******/
418 QTextCharFormat UiStyle::parsedFormat(quint64 key) const
420 return _formats.value(key, QTextCharFormat());
425 // Create unique key for given Format object and message label
426 QString formatKey(const UiStyle::Format &format, UiStyle::MessageLabel label)
428 return QString::number(format.type | label, 16)
429 + (format.foreground.isValid() ? format.foreground.name() : "#------")
430 + (format.background.isValid() ? format.background.name() : "#------");
435 QTextCharFormat UiStyle::cachedFormat(const Format &format, MessageLabel messageLabel) const
437 return _formatCache.value(formatKey(format, messageLabel), QTextCharFormat());
441 void UiStyle::setCachedFormat(const QTextCharFormat &charFormat, const Format &format, MessageLabel messageLabel) const
443 _formatCache[formatKey(format, messageLabel)] = charFormat;
447 QFontMetricsF *UiStyle::fontMetrics(FormatType ftype, MessageLabel label) const
449 // QFontMetricsF is not assignable, so we need to store pointers :/
450 quint64 key = ftype | label;
452 if (_metricsCache.contains(key))
453 return _metricsCache.value(key);
455 return (_metricsCache[key] = new QFontMetricsF(format({ftype, {}, {}}, label).font()));
459 /******** Generate formats ********/
461 // NOTE: This and the following functions are intimately tied to the values in FormatType. Don't change this
462 // until you _really_ know what you do!
463 QTextCharFormat UiStyle::format(const Format &format, MessageLabel label) const
465 if (format.type == FormatType::Invalid)
468 // Check if we have exactly this format readily cached already
469 QTextCharFormat charFormat = cachedFormat(format, label);
470 if (charFormat.properties().count())
473 // Merge all formats except mIRC and extended colors
474 mergeFormat(charFormat, format, label & 0xffff0000); // keep nickhash in label
475 for (quint32 mask = 0x00000001; mask <= static_cast<quint32>(MessageLabel::Last); mask <<= 1) {
476 if (static_cast<quint32>(label) & mask) {
477 mergeFormat(charFormat, format, label & (mask | 0xffff0000));
481 // Merge mIRC and extended colors, if appropriate. These override any color set previously in the format,
482 // unless the AllowForegroundOverride or AllowBackgroundOverride properties are set (via stylesheet).
483 if (_allowMircColors) {
484 mergeColors(charFormat, format, MessageLabel::None);
485 for (quint32 mask = 0x00000001; mask <= static_cast<quint32>(MessageLabel::Last); mask <<= 1) {
486 if (static_cast<quint32>(label) & mask) {
487 mergeColors(charFormat, format, label & mask);
492 setCachedFormat(charFormat, format, label);
497 void UiStyle::mergeFormat(QTextCharFormat &charFormat, const Format &format, MessageLabel label) const
499 mergeSubElementFormat(charFormat, format.type & 0x00ff, label);
501 // TODO: allow combinations for mirc formats and colors (each), e.g. setting a special format for "bold and italic"
502 // or "foreground 01 and background 03"
503 if ((format.type & 0xfff00) != FormatType::Base) { // element format
504 for (quint32 mask = 0x00100; mask <= 0x80000; mask <<= 1) {
505 if ((format.type & mask) != FormatType::Base) {
506 mergeSubElementFormat(charFormat, format.type & (mask | 0xff), label);
513 // Merge a subelement format into an existing message format
514 void UiStyle::mergeSubElementFormat(QTextCharFormat &fmt, FormatType ftype, MessageLabel label) const
516 quint64 key = ftype | label;
517 fmt.merge(parsedFormat(key & 0x0000ffffffffff00ull)); // label + subelement
518 fmt.merge(parsedFormat(key & 0x0000ffffffffffffull)); // label + subelement + msgtype
519 fmt.merge(parsedFormat(key & 0xffffffffffffff00ull)); // label + subelement + nickhash
520 fmt.merge(parsedFormat(key & 0xffffffffffffffffull)); // label + subelement + nickhash + msgtype
524 void UiStyle::mergeColors(QTextCharFormat &charFormat, const Format &format, MessageLabel label) const
526 bool allowFg = charFormat.property(static_cast<int>(FormatProperty::AllowForegroundOverride)).toBool();
527 bool allowBg = charFormat.property(static_cast<int>(FormatProperty::AllowBackgroundOverride)).toBool();
529 // Classic mIRC colors (styleable)
530 // We assume that those can't be combined with subelement and message types.
531 if (allowFg && (format.type & 0x00400000) != FormatType::Base)
532 charFormat.merge(parsedFormat((format.type & 0x0f400000) | label)); // foreground
533 if (allowBg && (format.type & 0x00800000) != FormatType::Base)
534 charFormat.merge(parsedFormat((format.type & 0xf0800000) | label)); // background
535 if (allowFg && allowBg && (format.type & 0x00c00000) == static_cast<FormatType>(0x00c00000))
536 charFormat.merge(parsedFormat((format.type & 0xffc00000) | label)); // combination
538 // Extended mIRC colors (hardcoded)
539 if (allowFg && format.foreground.isValid())
540 charFormat.setForeground(format.foreground);
541 if (allowBg && format.background.isValid())
542 charFormat.setBackground(format.background);
546 UiStyle::FormatType UiStyle::formatType(Message::Type msgType)
550 return FormatType::PlainMsg;
551 case Message::Notice:
552 return FormatType::NoticeMsg;
553 case Message::Action:
554 return FormatType::ActionMsg;
556 return FormatType::NickMsg;
558 return FormatType::ModeMsg;
560 return FormatType::JoinMsg;
562 return FormatType::PartMsg;
564 return FormatType::QuitMsg;
566 return FormatType::KickMsg;
568 return FormatType::KillMsg;
569 case Message::Server:
570 return FormatType::ServerMsg;
572 return FormatType::InfoMsg;
574 return FormatType::ErrorMsg;
575 case Message::DayChange:
576 return FormatType::DayChangeMsg;
578 return FormatType::TopicMsg;
579 case Message::NetsplitJoin:
580 return FormatType::NetsplitJoinMsg;
581 case Message::NetsplitQuit:
582 return FormatType::NetsplitQuitMsg;
583 case Message::Invite:
584 return FormatType::InviteMsg;
586 //Q_ASSERT(false); // we need to handle all message types
587 qWarning() << Q_FUNC_INFO << "Unknown message type:" << msgType;
588 return FormatType::ErrorMsg;
592 UiStyle::FormatType UiStyle::formatType(const QString &code)
594 if (_formatCodes.contains(code))
595 return _formatCodes.value(code);
596 return FormatType::Invalid;
600 QString UiStyle::formatCode(FormatType ftype)
602 return _formatCodes.key(ftype);
606 QList<QTextLayout::FormatRange> UiStyle::toTextLayoutList(const FormatList &formatList, int textLength, MessageLabel messageLabel) const
608 QList<QTextLayout::FormatRange> formatRanges;
609 QTextLayout::FormatRange range;
611 for (i = 0; i < formatList.size(); i++) {
612 range.format = format(formatList.at(i).second, messageLabel);
613 range.start = formatList.at(i).first;
615 formatRanges.last().length = range.start - formatRanges.last().start;
616 formatRanges.append(range);
619 formatRanges.last().length = textLength - formatRanges.last().start;
624 // This method expects a well-formatted string, there is no error checking!
625 // Since we create those ourselves, we should be pretty safe that nobody does something crappy here.
626 UiStyle::StyledString UiStyle::styleString(const QString &s_, FormatType baseFormat)
630 result.formatList.emplace_back(std::make_pair(quint16{0}, Format{baseFormat, {}, {}}));
632 if (s.length() > 65535) {
633 // We use quint16 for indexes
634 qWarning() << QString("String too long to be styled: %1").arg(s);
635 result.plainText = s;
639 Format curfmt{baseFormat, {}, {}};
640 QChar fgChar{'f'}; // character to indicate foreground color, changed when reversing
642 int pos = 0; quint16 length = 0;
644 pos = s.indexOf('%', pos);
646 if (s[pos+1] == '%') { // escaped %, we just remove one and continue
651 if (s[pos+1] == 'D' && s[pos+2] == 'c') { // mIRC color code
652 if (s[pos+3] == '-') { // color off
653 curfmt.type &= 0x003fffff;
654 curfmt.foreground = QColor{};
655 curfmt.background = QColor{};
659 quint32 color = 10 * s[pos+4].digitValue() + s[pos+5].digitValue();
660 // Color values 0-15 are traditional mIRC colors, defined in the stylesheet and thus going through the format engine
661 // Larger color values are hardcoded and applied separately (cf. https://modern.ircdocs.horse/formatting.html#colors-16-98)
662 if (s[pos+3] == fgChar) {
664 // Traditional mIRC color, defined in the stylesheet
665 curfmt.type &= 0xf0ffffff;
666 curfmt.type |= color << 24 | 0x00400000;
667 curfmt.foreground = QColor{};
670 curfmt.type &= 0xf0bfffff; // mask out traditional foreground color
671 curfmt.foreground = extendedMircColor(color);
676 curfmt.type &= 0x0fffffff;
677 curfmt.type |= color << 28 | 0x00800000;
678 curfmt.background = QColor{};
681 curfmt.type &= 0x0f7fffff; // mask out traditional background color
682 curfmt.background = extendedMircColor(color);
688 else if (s[pos+1] == 'D' && s[pos+2] == 'h') { // Hex color
689 QColor color{s.mid(pos+4, 7)};
690 if (s[pos+3] == fgChar) {
691 curfmt.type &= 0xf0bfffff; // mask out mIRC foreground color
692 curfmt.foreground = std::move(color);
695 curfmt.type &= 0x0f7fffff; // mask out mIRC background color
696 curfmt.background = std::move(color);
700 else if (s[pos+1] == 'O') { // reset formatting
701 curfmt.type &= 0x000000ff; // we keep message type-specific formatting
702 curfmt.foreground = QColor{};
703 curfmt.background = QColor{};
707 else if (s[pos+1] == 'R') { // Reverse colors
708 fgChar = (fgChar == 'f' ? 'b' : 'f');
709 auto orig = static_cast<quint32>(curfmt.type & 0xffc00000);
710 curfmt.type &= 0x003fffff;
711 curfmt.type |= (orig & 0x00400000) <<1;
712 curfmt.type |= (orig & 0x0f000000) <<4;
713 curfmt.type |= (orig & 0x00800000) >>1;
714 curfmt.type |= (orig & 0xf0000000) >>4;
715 std::swap(curfmt.foreground, curfmt.background);
718 else { // all others are toggles
719 QString code = QString("%") + s[pos+1];
720 if (s[pos+1] == 'D') code += s[pos+2];
721 FormatType ftype = formatType(code);
722 if (ftype == FormatType::Invalid) {
724 qWarning() << (QString("Invalid format code in string: %1").arg(s));
727 curfmt.type ^= ftype;
728 length = code.length();
730 s.remove(pos, length);
731 if (pos == result.formatList.back().first)
732 result.formatList.back().second = curfmt;
734 result.formatList.emplace_back(std::make_pair(pos, curfmt));
736 result.plainText = s;
741 QString UiStyle::mircToInternal(const QString &mirc_)
744 mirc.reserve(mirc_.size());
745 foreach (const QChar &c, mirc_) {
746 if ((c < '\x20' || c == '\x7f') && c != '\x03' && c != '\x04') {
747 switch (c.unicode()) {
758 // Monospace not supported yet
774 mirc += QChar(0x2421);
777 mirc += QChar(0x2400 + c.unicode());
786 // Now we bring the color codes (\x03) in a sane format that can be parsed more easily later.
787 // %Dcfxx is foreground, %Dcbxx is background color, where xx is a 2 digit dec number denoting the color code.
788 // %Dc- turns color off.
789 // Note: We use the "mirc standard" as described in <http://www.mirc.co.uk/help/color.txt>.
790 // This means that we don't accept something like \x03,5 (even though others, like WeeChat, do).
794 pos = mirc.indexOf('\x03', pos);
796 break; // no more mirc color codes
798 int l = mirc.length();
800 // check for fg color
801 if (i < l && mirc[i].isDigit()) {
803 if (i < l && mirc[i].isDigit())
804 num.append(mirc[i++]);
807 ins = QString("%Dcf%1").arg(num);
809 if (i+1 < l && mirc[i] == ',' && mirc[i+1].isDigit()) {
812 if (i < l && mirc[i].isDigit())
813 num.append(mirc[i++]);
816 ins += QString("%Dcb%1").arg(num);
822 mirc.replace(pos, i-pos, ins);
826 // Hex colors, as specified in https://modern.ircdocs.horse/formatting.html#hex-color
827 // %Dhf#rrggbb is foreground, %Dhb#rrggbb is background
829 static const QRegExp rx{"[\\da-fA-F]{6}"};
832 if (pos >= mirc.length())
834 pos = mirc.indexOf('\x04', pos);
839 auto num = mirc.mid(i, 6);
840 if (!num.isEmpty() && rx.exactMatch(num)) {
841 ins = "%Dhf#" + num.toLower();
843 if (i < mirc.length() && mirc[i] == ',' && !(num = mirc.mid(i + 1, 6)).isEmpty() && rx.exactMatch(num)) {
844 ins += "%Dhb#" + num.toLower();
851 mirc.replace(pos, i - pos, ins);
860 QString UiStyle::systemTimestampFormatString()
862 if (_systemTimestampFormatString.isEmpty()) {
863 // Calculate and cache the system timestamp format string
864 updateSystemTimestampFormat();
866 return _systemTimestampFormatString;
870 QString UiStyle::timestampFormatString()
872 if (useCustomTimestampFormat()) {
873 return _timestampFormatString;
875 return systemTimestampFormatString();
880 /***********************************************************************************/
881 UiStyle::StyledMessage::StyledMessage(const Message &msg)
885 // Don't compute the sender hash for message types without a nickname embedded
886 case Message::Server:
889 case Message::DayChange:
891 case Message::Invite:
892 // Don't compute the sender hash for messages with multiple nicks
893 // Fixing this without breaking themes would be.. complex.
894 case Message::NetsplitJoin:
895 case Message::NetsplitQuit:
897 // Don't compute the sender hash for message types that are not yet completed elsewhere
902 // Compute the sender hash for all other message types
909 void UiStyle::StyledMessage::style() const
911 QString user = userFromMask(sender());
912 QString host = hostFromMask(sender());
913 QString nick = nickFromMask(sender());
914 QString txt = UiStyle::mircToInternal(contents());
915 QString bufferName = bufferInfo().bufferName();
916 bufferName.replace('%', "%%"); // well, you _can_ have a % in a buffername apparently... -_-
917 host.replace('%', "%%"); // hostnames too...
918 user.replace('%', "%%"); // and the username...
919 nick.replace('%', "%%"); // ... and then there's totally RFC-violating servers like justin.tv m(
920 const int maxNetsplitNicks = 15;
925 t = QString("%1").arg(txt); break;
926 case Message::Notice:
927 t = QString("%1").arg(txt); break;
928 case Message::Action:
929 t = QString("%DN%1%DN %2").arg(nick).arg(txt);
933 if (nick == contents()) t = tr("You are now known as %DN%1%DN").arg(txt);
934 else t = tr("%DN%1%DN is now known as %DN%2%DN").arg(nick, txt);
938 if (nick.isEmpty()) t = tr("User mode: %DM%1%DM").arg(txt);
939 else t = tr("Mode %DM%1%DM by %DN%2%DN").arg(txt, nick);
943 t = tr("%DN%1%DN %DH(%2@%3)%DH has joined %DC%4%DC").arg(nick, user, host, bufferName); break;
946 t = tr("%DN%1%DN %DH(%2@%3)%DH has left %DC%4%DC").arg(nick, user, host, bufferName);
947 if (!txt.isEmpty()) t = QString("%1 (%2)").arg(t).arg(txt);
951 t = tr("%DN%1%DN %DH(%2@%3)%DH has quit").arg(nick, user, host);
952 if (!txt.isEmpty()) t = QString("%1 (%2)").arg(t).arg(txt);
956 QString victim = txt.section(" ", 0, 0);
957 QString kickmsg = txt.section(" ", 1);
959 t = tr("%DN%1%DN has kicked %DN%2%DN from %DC%3%DC").arg(nick).arg(victim).arg(bufferName);
960 if (!kickmsg.isEmpty()) t = QString("%1 (%2)").arg(t).arg(kickmsg);
963 //case Message::Kill: FIXME
965 case Message::Server:
966 t = QString("%1").arg(txt); break;
968 t = QString("%1").arg(txt); break;
970 t = QString("%1").arg(txt); break;
971 case Message::DayChange:
973 //: Day Change Message
974 t = tr("{Day changed to %1}").arg(timestamp().date().toString(Qt::DefaultLocaleLongDate));
978 t = QString("%1").arg(txt); break;
979 case Message::NetsplitJoin:
981 QStringList users = txt.split("#:#");
982 QStringList servers = users.takeLast().split(" ");
984 for (int i = 0; i < users.count() && i < maxNetsplitNicks; i++)
985 users[i] = nickFromMask(users.at(i));
987 t = tr("Netsplit between %DH%1%DH and %DH%2%DH ended. Users joined: ").arg(servers.at(0), servers.at(1));
988 if (users.count() <= maxNetsplitNicks)
989 t.append(QString("%DN%1%DN").arg(users.join(", ")));
991 t.append(tr("%DN%1%DN (%2 more)").arg(static_cast<QStringList>(users.mid(0, maxNetsplitNicks)).join(", ")).arg(users.count() - maxNetsplitNicks));
994 case Message::NetsplitQuit:
996 QStringList users = txt.split("#:#");
997 QStringList servers = users.takeLast().split(" ");
999 for (int i = 0; i < users.count() && i < maxNetsplitNicks; i++)
1000 users[i] = nickFromMask(users.at(i));
1002 t = tr("Netsplit between %DH%1%DH and %DH%2%DH. Users quit: ").arg(servers.at(0), servers.at(1));
1004 if (users.count() <= maxNetsplitNicks)
1005 t.append(QString("%DN%1%DN").arg(users.join(", ")));
1007 t.append(tr("%DN%1%DN (%2 more)").arg(static_cast<QStringList>(users.mid(0, maxNetsplitNicks)).join(", ")).arg(users.count() - maxNetsplitNicks));
1010 case Message::Invite:
1011 t = QString("%1").arg(txt); break;
1013 t = QString("[%1]").arg(txt);
1015 _contents = UiStyle::styleString(t, UiStyle::formatType(type()));
1019 const QString &UiStyle::StyledMessage::plainContents() const
1021 if (_contents.plainText.isNull())
1024 return _contents.plainText;
1028 const UiStyle::FormatList &UiStyle::StyledMessage::contentsFormatList() const
1030 if (_contents.plainText.isNull())
1033 return _contents.formatList;
1037 QString UiStyle::StyledMessage::decoratedTimestamp() const
1039 return timestamp().toLocalTime().toString(UiStyle::timestampFormatString());
1043 QString UiStyle::StyledMessage::plainSender() const
1046 case Message::Plain:
1047 case Message::Notice:
1048 return nickFromMask(sender());
1055 QString UiStyle::StyledMessage::decoratedSender() const
1057 QString _senderPrefixes;
1058 switch (_senderPrefixDisplay) {
1059 case UiStyle::SenderPrefixMode::AllModes:
1060 // Show every available mode
1061 _senderPrefixes = senderPrefixes();
1063 case UiStyle::SenderPrefixMode::HighestMode:
1064 // Show the highest available mode (left-most)
1065 _senderPrefixes = senderPrefixes().left(1);
1067 case UiStyle::SenderPrefixMode::NoModes:
1068 // Don't show any mode (already empty by default)
1073 case Message::Plain:
1074 if (_showSenderBrackets)
1075 return QString("<%1%2>").arg(_senderPrefixes, plainSender());
1077 return QString("%1%2").arg(_senderPrefixes, plainSender());
1078 case Message::Notice:
1079 return QString("[%1%2]").arg(_senderPrefixes, plainSender());
1080 case Message::Action:
1096 case Message::Server:
1100 case Message::Error:
1102 case Message::DayChange:
1104 case Message::Topic:
1106 case Message::NetsplitJoin:
1108 case Message::NetsplitQuit:
1110 case Message::Invite:
1114 return QString("%1%2").arg(_senderPrefixes, plainSender());
1118 // FIXME hardcoded to 16 sender hashes
1119 quint8 UiStyle::StyledMessage::senderHash() const
1121 if (_senderHash != 0xff)
1126 // HACK: Until multiple nicknames with different colors can be solved in the theming engine,
1127 // for /nick change notifications, use the color of the new nickname (if possible), not the old
1129 if (type() == Message::Nick) {
1130 // New nickname is given as contents. Change to that.
1131 nick = stripFormatCodes(contents()).toLower();
1133 // Just use the sender directly
1134 nick = nickFromMask(sender()).toLower();
1137 if (!nick.isEmpty()) {
1139 while (chopCount < nick.size() && nick.at(nick.count() - 1 - chopCount) == '_')
1141 if (chopCount < nick.size())
1142 nick.chop(chopCount);
1144 quint16 hash = qChecksum(nick.toLatin1().data(), nick.toLatin1().size());
1145 return (_senderHash = (hash & 0xf) + 1);
1148 /***********************************************************************************/
1150 uint qHash(UiStyle::ItemFormatType key, uint seed)
1152 return qHash(static_cast<quint32>(key), seed);
1156 UiStyle::FormatType operator|(UiStyle::FormatType lhs, UiStyle::FormatType rhs)
1158 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 auto it = formatList.cbegin();
1265 while (it != formatList.cend()) {
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}));