qss: Introduce new message label "hovered"
[quassel.git] / src / uisupport / uistyle.cpp
index 714fe91..cbae7e6 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-2016 by the Quassel Project                        *
+ *   Copyright (C) 2005-2018 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
+#include <utility>
 #include <vector>
 
 #include <QApplication>
 #include <QColor>
-#include <QIcon>
 
 #include "buffersettings.h"
+#include "icon.h"
 #include "qssparser.h"
 #include "quassel.h"
 #include "uistyle.h"
@@ -35,7 +36,7 @@ QHash<QString, UiStyle::FormatType> UiStyle::_formatCodes;
 bool UiStyle::_useCustomTimestampFormat;       /// If true, use the custom timestamp format
 QString UiStyle::_timestampFormatString;       /// Timestamp format
 QString UiStyle::_systemTimestampFormatString; /// Cached copy of system locale timestamp format
-bool UiStyle::_showSenderPrefixes;             /// If true, show prefixmodes before sender names
+UiStyle::SenderPrefixMode UiStyle::_senderPrefixDisplay; /// Display of prefix modes before sender
 bool UiStyle::_showSenderBrackets;             /// If true, show brackets around sender names
 
 namespace {
@@ -61,33 +62,32 @@ QColor extendedMircColor(int number)
 }
 
 UiStyle::UiStyle(QObject *parent)
-    : QObject(parent),
-    _channelJoinedIcon(QIcon::fromTheme("irc-channel-joined", QIcon(":/icons/irc-channel-joined.png"))),
-    _channelPartedIcon(QIcon::fromTheme("irc-channel-parted", QIcon(":/icons/irc-channel-parted.png"))),
-    _userOfflineIcon(QIcon::fromTheme("im-user-offline", QIcon::fromTheme("user-offline", QIcon(":/icons/im-user-offline.png")))),
-    _userOnlineIcon(QIcon::fromTheme("im-user", QIcon::fromTheme("user-available", QIcon(":/icons/im-user.png")))), // im-user-* are non-standard oxygen extensions
-    _userAwayIcon(QIcon::fromTheme("im-user-away", QIcon::fromTheme("user-away", QIcon(":/icons/im-user-away.png")))),
-    _categoryOpIcon(QIcon::fromTheme("irc-operator")),
-    _categoryVoiceIcon(QIcon::fromTheme("irc-voice")),
-    _opIconLimit(UserCategoryItem::categoryFromModes("o")),
-    _voiceIconLimit(UserCategoryItem::categoryFromModes("v"))
+    : QObject(parent)
+    , _channelJoinedIcon{icon::get("irc-channel-active")}
+    , _channelPartedIcon{icon::get("irc-channel-inactive")}
+    , _userOfflineIcon{icon::get({"im-user-offline", "user-offline"})}
+    , _userOnlineIcon{icon::get({"im-user-online", "im-user", "user-available"})}
+    , _userAwayIcon{icon::get({"im-user-away", "user-away"})}
+    , _categoryOpIcon{icon::get("irc-operator")}
+    , _categoryVoiceIcon{icon::get("irc-voice")}
+    , _opIconLimit{UserCategoryItem::categoryFromModes("o")}
+    , _voiceIconLimit{UserCategoryItem::categoryFromModes("v")}
 {
-    // register FormatList if that hasn't happened yet
-    // FIXME I don't think this actually avoids double registration... then again... does it hurt?
-    if (QVariant::nameToType("UiStyle::FormatList") == QVariant::Invalid) {
-        qRegisterMetaType<FormatList>("UiStyle::FormatList");
-        qRegisterMetaTypeStreamOperators<FormatList>("UiStyle::FormatList");
-        Q_ASSERT(QVariant::nameToType("UiStyle::FormatList") != QVariant::Invalid);
-    }
+    static bool registered = []() {
+        qRegisterMetaType<FormatList>();
+        qRegisterMetaTypeStreamOperators<FormatList>();
+        return true;
+    }();
+    Q_UNUSED(registered)
 
     _uiStylePalette = QVector<QBrush>(static_cast<int>(ColorRole::NumRoles), QBrush());
 
     // Now initialize the mapping between FormatCodes and FormatTypes...
     _formatCodes["%O"] = FormatType::Base;
     _formatCodes["%B"] = FormatType::Bold;
-    _formatCodes["%S"] = FormatType::Italic;
+    _formatCodes["%I"] = FormatType::Italic;
     _formatCodes["%U"] = FormatType::Underline;
-    _formatCodes["%R"] = FormatType::Reverse;
+    _formatCodes["%S"] = FormatType::Strikethrough;
 
     _formatCodes["%DN"] = FormatType::Nick;
     _formatCodes["%DH"] = FormatType::Hostmask;
@@ -100,8 +100,8 @@ UiStyle::UiStyle(QObject *parent)
     // in there.
     setUseCustomTimestampFormat(false);
     setTimestampFormatString(" hh:mm:ss");
-    enableSenderPrefixes(false);
-    enableSenderBrackets(true);
+    setSenderPrefixDisplay(UiStyle::SenderPrefixMode::HighestMode);
+    enableSenderBrackets(false);
 
     // BufferView / NickView settings
     UiStyleSettings s;
@@ -251,10 +251,10 @@ void UiStyle::setTimestampFormatString(const QString &format)
     }
 }
 
-void UiStyle::enableSenderPrefixes(bool enabled)
+void UiStyle::setSenderPrefixDisplay(UiStyle::SenderPrefixMode mode)
 {
-    if (_showSenderPrefixes != enabled) {
-        _showSenderPrefixes = enabled;
+    if (_senderPrefixDisplay != mode) {
+        _senderPrefixDisplay = mode;
     }
 }
 
@@ -418,7 +418,7 @@ QVariant UiStyle::itemData(int role, const QTextCharFormat &format) const
 
 /******** Caching *******/
 
-QTextCharFormat UiStyle::format(quint64 key) const
+QTextCharFormat UiStyle::parsedFormat(quint64 key) const
 {
     return _formats.value(key, QTextCharFormat());
 }
@@ -473,11 +473,22 @@ QTextCharFormat UiStyle::format(const Format &format, MessageLabel label) const
     if (charFormat.properties().count())
         return charFormat;
 
+    // Merge all formats except mIRC and extended colors
     mergeFormat(charFormat, format, label & 0xffff0000);  // keep nickhash in label
-
-    for (quint32 mask = 0x00000001; mask <= static_cast<quint32>(MessageLabel::Selected); mask <<= 1) {
+    for (quint32 mask = 0x00000001; mask <= static_cast<quint32>(MessageLabel::Last); mask <<= 1) {
         if (static_cast<quint32>(label) & mask) {
-            mergeFormat(charFormat, {format.type, {}, {}}, label & (mask | 0xffff0000));  // Don't re-apply extended colors
+            mergeFormat(charFormat, format, label & (mask | 0xffff0000));
+        }
+    }
+
+    // Merge mIRC and extended colors, if appropriate. These override any color set previously in the format,
+    // unless the AllowForegroundOverride or AllowBackgroundOverride properties are set (via stylesheet).
+    if (_allowMircColors) {
+        mergeColors(charFormat, format, MessageLabel::None);
+        for (quint32 mask = 0x00000001; mask <= static_cast<quint32>(MessageLabel::Last); mask <<= 1) {
+            if (static_cast<quint32>(label) & mask) {
+                mergeColors(charFormat, format, label & mask);
+            }
         }
     }
 
@@ -493,34 +504,12 @@ void UiStyle::mergeFormat(QTextCharFormat &charFormat, const Format &format, Mes
     // TODO: allow combinations for mirc formats and colors (each), e.g. setting a special format for "bold and italic"
     //       or "foreground 01 and background 03"
     if ((format.type & 0xfff00) != FormatType::Base) { // element format
-        for (quint32 mask = 0x00100; mask <= 0x40000; mask <<= 1) {
+        for (quint32 mask = 0x00100; mask <= 0x80000; mask <<= 1) {
             if ((format.type & mask) != FormatType::Base) {
                 mergeSubElementFormat(charFormat, format.type & (mask | 0xff), label);
             }
         }
     }
-
-    // Now we handle color codes
-    // We assume that those can't be combined with subelement and message types.
-    if (_allowMircColors) {
-        // Classic mIRC colors (styleable)
-        if ((format.type & 0x00400000) != FormatType::Base)
-            mergeSubElementFormat(charFormat, format.type & 0x0f400000, label);  // foreground
-        if ((format.type & 0x00800000) != FormatType::Base)
-            mergeSubElementFormat(charFormat, format.type & 0xf0800000, label);  // background
-        if ((format.type & 0x00c00000) == static_cast<FormatType>(0x00c00000))
-            mergeSubElementFormat(charFormat, format.type & 0xffc00000, label);  // combination
-
-        // Extended mIRC colors (hardcoded)
-        if (format.foreground.isValid())
-            charFormat.setForeground(format.foreground);
-        if (format.background.isValid())
-            charFormat.setBackground(format.background);
-    }
-
-    // URL
-    if ((format.type & FormatType::Url) != FormatType::Base)
-        mergeSubElementFormat(charFormat, format.type & (FormatType::Url | static_cast<FormatType>(0x000000ff)), label);
 }
 
 
@@ -528,10 +517,32 @@ void UiStyle::mergeFormat(QTextCharFormat &charFormat, const Format &format, Mes
 void UiStyle::mergeSubElementFormat(QTextCharFormat &fmt, FormatType ftype, MessageLabel label) const
 {
     quint64 key = ftype | label;
-    fmt.merge(format(key & 0x0000ffffffffff00ull)); // label + subelement
-    fmt.merge(format(key & 0x0000ffffffffffffull)); // label + subelement + msgtype
-    fmt.merge(format(key & 0xffffffffffffff00ull)); // label + subelement + nickhash
-    fmt.merge(format(key & 0xffffffffffffffffull)); // label + subelement + nickhash + msgtype
+    fmt.merge(parsedFormat(key & 0x0000ffffffffff00ull)); // label + subelement
+    fmt.merge(parsedFormat(key & 0x0000ffffffffffffull)); // label + subelement + msgtype
+    fmt.merge(parsedFormat(key & 0xffffffffffffff00ull)); // label + subelement + nickhash
+    fmt.merge(parsedFormat(key & 0xffffffffffffffffull)); // label + subelement + nickhash + msgtype
+}
+
+
+void UiStyle::mergeColors(QTextCharFormat &charFormat, const Format &format, MessageLabel label) const
+{
+    bool allowFg = charFormat.property(static_cast<int>(FormatProperty::AllowForegroundOverride)).toBool();
+    bool allowBg = charFormat.property(static_cast<int>(FormatProperty::AllowBackgroundOverride)).toBool();
+
+    // Classic mIRC colors (styleable)
+    // We assume that those can't be combined with subelement and message types.
+    if (allowFg && (format.type & 0x00400000) != FormatType::Base)
+        charFormat.merge(parsedFormat((format.type & 0x0f400000) | label));  // foreground
+    if (allowBg && (format.type & 0x00800000) != FormatType::Base)
+        charFormat.merge(parsedFormat((format.type & 0xf0800000) | label));  // background
+    if (allowFg && allowBg && (format.type & 0x00c00000) == static_cast<FormatType>(0x00c00000))
+        charFormat.merge(parsedFormat((format.type & 0xffc00000) | label));  // combination
+
+    // Extended mIRC colors (hardcoded)
+    if (allowFg && format.foreground.isValid())
+        charFormat.setForeground(format.foreground);
+    if (allowBg && format.background.isValid())
+        charFormat.setBackground(format.background);
 }
 
 
@@ -629,6 +640,7 @@ UiStyle::StyledString UiStyle::styleString(const QString &s_, FormatType baseFor
     }
 
     Format curfmt{baseFormat, {}, {}};
+    QChar fgChar{'f'}; // character to indicate foreground color, changed when reversing
 
     int pos = 0; quint16 length = 0;
     for (;;) {
@@ -639,7 +651,7 @@ UiStyle::StyledString UiStyle::styleString(const QString &s_, FormatType baseFor
             pos++;
             continue;
         }
-        if (s[pos+1] == 'D' && s[pos+2] == 'c') { // color code
+        if (s[pos+1] == 'D' && s[pos+2] == 'c') { // mIRC color code
             if (s[pos+3] == '-') { // color off
                 curfmt.type &= 0x003fffff;
                 curfmt.foreground = QColor{};
@@ -650,7 +662,7 @@ UiStyle::StyledString UiStyle::styleString(const QString &s_, FormatType baseFor
                 quint32 color = 10 * s[pos+4].digitValue() + s[pos+5].digitValue();
                 // Color values 0-15 are traditional mIRC colors, defined in the stylesheet and thus going through the format engine
                 // Larger color values are hardcoded and applied separately (cf. https://modern.ircdocs.horse/formatting.html#colors-16-98)
-                if (s[pos+3] == 'f') {
+                if (s[pos+3] == fgChar) {
                     if (color < 16) {
                         // Traditional mIRC color, defined in the stylesheet
                         curfmt.type &= 0xf0ffffff;
@@ -676,15 +688,34 @@ UiStyle::StyledString UiStyle::styleString(const QString &s_, FormatType baseFor
                 length = 6;
             }
         }
+        else if (s[pos+1] == 'D' && s[pos+2] == 'h') { // Hex color
+            QColor color{s.mid(pos+4, 7)};
+            if (s[pos+3] == fgChar) {
+                curfmt.type &= 0xf0bfffff;  // mask out mIRC foreground color
+                curfmt.foreground = std::move(color);
+            }
+            else {
+                curfmt.type &= 0x0f7fffff;  // mask out mIRC background color
+                curfmt.background = std::move(color);
+            }
+            length = 11;
+        }
         else if (s[pos+1] == 'O') { // reset formatting
             curfmt.type &= 0x000000ff; // we keep message type-specific formatting
             curfmt.foreground = QColor{};
             curfmt.background = QColor{};
+            fgChar = 'f';
             length = 2;
         }
-        else if (s[pos+1] == 'R') { // reverse
-            // TODO: implement reverse formatting
-
+        else if (s[pos+1] == 'R') { // Reverse colors
+            fgChar = (fgChar == 'f' ? 'b' : 'f');
+            quint32 orig = static_cast<quint32>(curfmt.type & 0xffc00000);
+            curfmt.type &= 0x003fffff;
+            curfmt.type |= (orig & 0x00400000) <<1;
+            curfmt.type |= (orig & 0x0f000000) <<4;
+            curfmt.type |= (orig & 0x00800000) >>1;
+            curfmt.type |= (orig & 0xf0000000) >>4;
+            std::swap(curfmt.foreground, curfmt.background);
             length = 2;
         }
         else { // all others are toggles
@@ -715,7 +746,7 @@ QString UiStyle::mircToInternal(const QString &mirc_)
     QString mirc;
     mirc.reserve(mirc_.size());
     foreach (const QChar &c, mirc_) {
-        if ((c < '\x20' || c == '\x7f') && c != '\x03') {
+        if ((c < '\x20' || c == '\x7f') && c != '\x03' && c != '\x04') {
             switch (c.unicode()) {
                 case '\x02':
                     mirc += "%B";
@@ -726,11 +757,17 @@ QString UiStyle::mircToInternal(const QString &mirc_)
                 case '\x09':
                     mirc += "        ";
                     break;
+                case '\x11':
+                    // Monospace not supported yet
+                    break;
                 case '\x12':
                 case '\x16':
                     mirc += "%R";
                     break;
                 case '\x1d':
+                    mirc += "%I";
+                    break;
+                case '\x1e':
                     mirc += "%S";
                     break;
                 case '\x1f':
@@ -754,38 +791,71 @@ QString UiStyle::mircToInternal(const QString &mirc_)
     // %Dc- turns color off.
     // Note: We use the "mirc standard" as described in <http://www.mirc.co.uk/help/color.txt>.
     //       This means that we don't accept something like \x03,5 (even though others, like WeeChat, do).
-    int pos = 0;
-    while (true) {
-        pos = mirc.indexOf('\x03', pos);
-        if (pos < 0)
-            break;  // no more mirc color codes
-        QString ins, num;
-        int l = mirc.length();
-        int i = pos + 1;
-        // check for fg color
-        if (i < l && mirc[i].isDigit()) {
-            num = mirc[i++];
-            if (i < l && mirc[i].isDigit())
-                num.append(mirc[i++]);
-            else
-                num.prepend('0');
-            ins = QString("%Dcf%1").arg(num);
-
-            if (i+1 < l && mirc[i] == ',' && mirc[i+1].isDigit()) {
-                i++;
+    {
+        int pos = 0;
+        while (true) {
+            pos = mirc.indexOf('\x03', pos);
+            if (pos < 0)
+                break;  // no more mirc color codes
+            QString ins, num;
+            int l = mirc.length();
+            int i = pos + 1;
+            // check for fg color
+            if (i < l && mirc[i].isDigit()) {
                 num = mirc[i++];
                 if (i < l && mirc[i].isDigit())
                     num.append(mirc[i++]);
                 else
                     num.prepend('0');
-                ins += QString("%Dcb%1").arg(num);
+                ins = QString("%Dcf%1").arg(num);
+
+                if (i+1 < l && mirc[i] == ',' && mirc[i+1].isDigit()) {
+                    i++;
+                    num = mirc[i++];
+                    if (i < l && mirc[i].isDigit())
+                        num.append(mirc[i++]);
+                    else
+                        num.prepend('0');
+                    ins += QString("%Dcb%1").arg(num);
+                }
+            }
+            else {
+                ins = "%Dc-";
             }
+            mirc.replace(pos, i-pos, ins);
         }
-        else {
-            ins = "%Dc-";
+    }
+
+    // Hex colors, as specified in https://modern.ircdocs.horse/formatting.html#hex-color
+    // %Dhf#rrggbb is foreground, %Dhb#rrggbb is background
+    {
+        static const QRegExp rx{"[\\da-fA-F]{6}"};
+        int pos = 0;
+        while (true) {
+            if (pos >= mirc.length())
+                break;
+            pos = mirc.indexOf('\x04', pos);
+            if (pos < 0)
+                break;
+            int i = pos + 1;
+            QString ins;
+            auto num = mirc.mid(i, 6);
+            if (!num.isEmpty() && rx.exactMatch(num)) {
+                ins = "%Dhf#" + num.toLower();
+                i += 6;
+                if (i < mirc.length() && mirc[i] == ',' && !(num = mirc.mid(i + 1, 6)).isEmpty() && rx.exactMatch(num)) {
+                    ins += "%Dhb#" + num.toLower();
+                    i += 7;
+                }
+            }
+            else {
+                ins = "%Dc-";
+            }
+            mirc.replace(pos, i - pos, ins);
+            pos += ins.length();
         }
-        mirc.replace(pos, i-pos, ins);
     }
+
     return mirc;
 }
 
@@ -988,8 +1058,18 @@ QString UiStyle::StyledMessage::plainSender() const
 QString UiStyle::StyledMessage::decoratedSender() const
 {
     QString _senderPrefixes;
-    if (_showSenderPrefixes) {
+    switch (_senderPrefixDisplay) {
+    case UiStyle::SenderPrefixMode::AllModes:
+        // Show every available mode
         _senderPrefixes = senderPrefixes();
+        break;
+    case UiStyle::SenderPrefixMode::HighestMode:
+        // Show the highest available mode (left-most)
+        _senderPrefixes = senderPrefixes().left(1);
+        break;
+    case UiStyle::SenderPrefixMode::NoModes:
+        // Don't show any mode (already empty by default)
+        break;
     }
 
     switch (type()) {