Make sender-hash based styling ("colored nicks") work again
[quassel.git] / src / uisupport / uistyle.cpp
index 19f9fd1..b5e8911 100644 (file)
  ***************************************************************************/
 #include <QApplication>
 
+#include "qssparser.h"
 #include "quassel.h"
 #include "uistyle.h"
 #include "uisettings.h"
 #include "util.h"
 
-UiStyle::UiStyle(const QString &settingsKey) : _settingsKey(settingsKey) {
+QHash<QString, UiStyle::FormatType> UiStyle::_formatCodes;
+
+UiStyle::UiStyle() {
   // 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) {
@@ -33,24 +36,6 @@ UiStyle::UiStyle(const QString &settingsKey) : _settingsKey(settingsKey) {
     Q_ASSERT(QVariant::nameToType("UiStyle::FormatList") != QVariant::Invalid);
   }
 
-  _defaultFont = QFont("Monospace", QApplication::font().pointSize());
-
-  // Default format
-  _defaultPlainFormat.setForeground(QBrush("#000000"));
-  _defaultPlainFormat.setFont(_defaultFont);
-  _defaultPlainFormat.font().setFixedPitch(true);
-  _defaultPlainFormat.font().setStyleHint(QFont::TypeWriter);
-  setFormat(None, _defaultPlainFormat, Settings::Default);
-
-  // Load saved custom formats
-  UiStyleSettings s(_settingsKey);
-  foreach(FormatType type, s.availableFormats()) {
-    _customFormats[type] = s.customFormat(type);
-  }
-
-  // Check for the sender auto coloring option
-  _senderAutoColor = s.value("Colors/SenderAutoColor", false).toBool();
-
   // Now initialize the mapping between FormatCodes and FormatTypes...
   _formatCodes["%O"] = None;
   _formatCodes["%B"] = Bold;
@@ -58,139 +43,154 @@ UiStyle::UiStyle(const QString &settingsKey) : _settingsKey(settingsKey) {
   _formatCodes["%U"] = Underline;
   _formatCodes["%R"] = Reverse;
 
-  _formatCodes["%D0"] = PlainMsg;
-  _formatCodes["%Dn"] = NoticeMsg;
-  _formatCodes["%Ds"] = ServerMsg;
-  _formatCodes["%De"] = ErrorMsg;
-  _formatCodes["%Dj"] = JoinMsg;
-  _formatCodes["%Dp"] = PartMsg;
-  _formatCodes["%Dq"] = QuitMsg;
-  _formatCodes["%Dk"] = KickMsg;
-  _formatCodes["%Dr"] = RenameMsg;
-  _formatCodes["%Dm"] = ModeMsg;
-  _formatCodes["%Da"] = ActionMsg;
-
-  _formatCodes["%DT"] = Timestamp;
-  _formatCodes["%DS"] = Sender;
   _formatCodes["%DN"] = Nick;
   _formatCodes["%DH"] = Hostmask;
   _formatCodes["%DC"] = ChannelName;
   _formatCodes["%DM"] = ModeFlags;
   _formatCodes["%DU"] = Url;
 
-  // Initialize color codes according to mIRC "standard"
-  QStringList colors;
-  //colors << "white" << "black" << "navy" << "green" << "red" << "maroon" << "purple" << "orange";
-  //colors << "yellow" << "lime" << "teal" << "aqua" << "royalblue" << "fuchsia" << "grey" << "silver";
-  colors << "#ffffff" << "#000000" << "#000080" << "#008000" << "#ff0000" << "#800000" << "#800080" << "#ffa500";
-  colors << "#ffff00" << "#00ff00" << "#008080" << "#00ffff" << "#4169E1" << "#ff00ff" << "#808080" << "#c0c0c0";
-
-  // Set color formats
-  for(int i = 0; i < 16; i++) {
-    QString idx = QString("%1").arg(i, (int)2, (int)10, (QChar)'0');
-    _formatCodes[QString("%Dcf%1").arg(idx)] = (FormatType)(FgCol00 | i<<24);
-    _formatCodes[QString("%Dcb%1").arg(idx)] = (FormatType)(BgCol00 | i<<28);
-    QTextCharFormat fgf, bgf;
-    fgf.setForeground(QBrush(QColor(colors[i]))); setFormat((FormatType)(FgCol00 | i<<24), fgf, Settings::Default);
-    bgf.setBackground(QBrush(QColor(colors[i]))); setFormat((FormatType)(BgCol00 | i<<28), bgf, Settings::Default);
-  }
-
-  // Set a few more standard formats
-  QTextCharFormat bold; bold.setFontWeight(QFont::Bold);
-  setFormat(Bold, bold, Settings::Default);
-
-  QTextCharFormat italic; italic.setFontItalic(true);
-  setFormat(Italic, italic, Settings::Default);
-
-  QTextCharFormat underline; underline.setFontUnderline(true);
-  setFormat(Underline, underline, Settings::Default);
-
-  // All other formats should be defined in derived classes.
+  loadStyleSheet();
 }
 
 UiStyle::~ UiStyle() {
-  qDeleteAll(_cachedFontMetrics);
+  qDeleteAll(_metricsCache);
 }
 
-void UiStyle::setFormat(FormatType ftype, QTextCharFormat fmt, Settings::Mode mode) {
-  if(mode == Settings::Default) {
-    _defaultFormats[ftype] = fmt;
-  } else {
-    UiStyleSettings s(_settingsKey);
-    if(fmt != _defaultFormats[ftype]) {
-      _customFormats[ftype] = fmt;
-      s.setCustomFormat(ftype, fmt);
-    } else {
-      _customFormats.remove(ftype);
-      s.removeCustomFormat(ftype);
-    }
-  }
-  // TODO: invalidate only affected cached formats... if that's possible with less overhead than just rebuilding them
-  _cachedFormats.clear();
-  _cachedFontMetrics.clear();
+QTextCharFormat UiStyle::cachedFormat(quint64 key) const {
+  return _formatCache.value(key, QTextCharFormat());
 }
 
-void UiStyle::setSenderAutoColor( bool state ) {
-  _senderAutoColor = state;
-  UiStyleSettings s(_settingsKey);
-  s.setValue("Colors/SenderAutoColor", QVariant(state));
+QTextCharFormat UiStyle::cachedFormat(quint32 formatType, quint32 messageLabel) const {
+  return cachedFormat(formatType | ((quint64)messageLabel << 32));
 }
 
-QTextCharFormat UiStyle::format(FormatType ftype, Settings::Mode mode) const {
-  // Check for enabled sender auto coloring
-  if ( (ftype & 0x00000fff) == Sender && !_senderAutoColor ) {
-    // Just use the default sender style if auto coloring is disabled
-    ftype = Sender;
-  }
+void UiStyle::setCachedFormat(const QTextCharFormat &format, quint32 formatType, quint32 messageLabel) {
+  _formatCache[formatType | ((quint64)messageLabel << 32)] = format;
+}
 
-  if(mode == Settings::Custom && _customFormats.contains(ftype)) return _customFormats.value(ftype);
-  else return _defaultFormats.value(ftype, QTextCharFormat());
+// Merge a subelement format into an existing message format
+void UiStyle::mergeSubElementFormat(QTextCharFormat& fmt, quint32 ftype, quint32 label) {
+  quint64 key = ftype | ((quint64)label << 32);
+
+  // start with the most general format and then specialize
+  fmt.merge(cachedFormat(key & 0x00000000fffffff0));  // basic subelement format
+  fmt.merge(cachedFormat(key & 0x00000000ffffffff));  // subelement + msgtype
+  fmt.merge(cachedFormat(key & 0xffff0000fffffff0));  // subelement + nickhash
+  fmt.merge(cachedFormat(key & 0xffff0000ffffffff));  // subelement + nickhash + msgtype
+  fmt.merge(cachedFormat(key & 0x0000fffffffffff0));  // label + subelement
+  fmt.merge(cachedFormat(key & 0x0000ffffffffffff));  // label + subelement + msgtype
+  fmt.merge(cachedFormat(key & 0xfffffffffffffff0));  // label + subelement + nickhash
+  fmt.merge(cachedFormat(key & 0xffffffffffffffff));  // label + subelement + nickhash + msgtype
 }
 
 // NOTE: This function is intimately tied to the values in FormatType. Don't change this
 //       until you _really_ know what you do!
-QTextCharFormat UiStyle::mergedFormat(quint32 ftype) {
-  if(_cachedFormats.contains(ftype)) return _cachedFormats.value(ftype);
-  if(ftype == Invalid) return QTextCharFormat();
-  // Now we construct the merged format, starting with the default
-  QTextCharFormat fmt = format(None);
-  // First: general message format
-  fmt.merge(format((FormatType)(ftype & 0x0f)));
-  // now more specific ones
-  for(quint32 mask = 0x0010; mask <= 0x2000; mask <<= 1) {
-    if(ftype & mask) fmt.merge(format((FormatType)mask));
+QTextCharFormat UiStyle::format(quint32 ftype, quint32 label) {
+  if(ftype == Invalid)
+    return QTextCharFormat();
+
+  quint64 key = ftype | ((quint64)label << 32);
+
+  // check if we have exactly this format readily cached already
+  QTextCharFormat fmt = cachedFormat(key);
+  if(fmt.properties().count())
+    return fmt;
+
+  fmt.merge(cachedFormat(key & 0x0000000000000000));  // basic
+  fmt.merge(cachedFormat(key & 0x000000000000000f));  // msgtype
+  fmt.merge(cachedFormat(key & 0xffff000000000000));  // nickhash
+  fmt.merge(cachedFormat(key & 0xffff00000000000f));  // nickhash + msgtype
+  fmt.merge(cachedFormat(key & 0x0000ffff00000000));  // label
+  fmt.merge(cachedFormat(key & 0x0000ffff0000000f));  // label + msgtype
+  fmt.merge(cachedFormat(key & 0xffffffff00000000));  // label + nickhash
+  fmt.merge(cachedFormat(key & 0xffffffff0000000f));  // label + nickhash + msgtype
+
+  // 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((ftype & 0xfff0)) { // element format
+    for(quint32 mask = 0x10; mask <= 0x2000; mask <<= 1) {
+      if(ftype & mask) {
+        mergeSubElementFormat(fmt, ftype & 0xffff, label);
+      }
+    }
   }
-  // color codes!
-  if(ftype & 0x00400000) fmt.merge(format((FormatType)(ftype & 0x0f400000))); // foreground
-  if(ftype & 0x00800000) fmt.merge(format((FormatType)(ftype & 0xf0800000))); // background
-  // Sender auto colors
-  if((ftype & 0xfff) == 0x200 && (ftype & 0xff000200) != 0x200) fmt.merge(format((FormatType)(ftype & 0xff000200)));
+
+  // Now we handle color codes
+  if(ftype & 0x00400000)
+    mergeSubElementFormat(fmt, ftype & 0x0f400000, label); // foreground
+  if(ftype & 0x00800000)
+    mergeSubElementFormat(fmt, ftype & 0xf0800000, label); // background
+  if((ftype & 0x00c00000) == 0x00c00000)
+    mergeSubElementFormat(fmt, ftype & 0xffc00000, label); // combination
+
   // URL
-  if(ftype & Url) fmt.merge(format(Url));
-  return _cachedFormats[ftype] = fmt;
+  if(ftype & Url)
+    mergeSubElementFormat(fmt, ftype & Url, label);
+
+  setCachedFormat(fmt, ftype, label);
+  return fmt;
 }
 
-QFontMetricsF *UiStyle::fontMetrics(quint32 ftype) {
+QFontMetricsF *UiStyle::fontMetrics(quint32 ftype, quint32 label) {
   // QFontMetricsF is not assignable, so we need to store pointers :/
-  if(_cachedFontMetrics.contains(ftype)) return _cachedFontMetrics.value(ftype);
-  return (_cachedFontMetrics[ftype] = new QFontMetricsF(mergedFormat(ftype).font()));
+  quint64 key = ftype | ((quint64)label << 32);
+
+  if(_metricsCache.contains(key))
+    return _metricsCache.value(key);
+
+  return (_metricsCache[key] = new QFontMetricsF(format(ftype, label).font()));
 }
 
-UiStyle::FormatType UiStyle::formatType(const QString & code) const {
+UiStyle::FormatType UiStyle::formatType(Message::Type msgType) {
+  switch(msgType) {
+    case Message::Plain:
+      return PlainMsg;
+    case Message::Notice:
+      return NoticeMsg;
+    case Message::Action:
+      return ActionMsg;
+    case Message::Nick:
+      return NickMsg;
+    case Message::Mode:
+      return ModeMsg;
+    case Message::Join:
+      return JoinMsg;
+    case Message::Part:
+      return PartMsg;
+    case Message::Quit:
+      return QuitMsg;
+    case Message::Kick:
+      return KickMsg;
+    case Message::Kill:
+      return KillMsg;
+    case Message::Server:
+      return ServerMsg;
+    case Message::Info:
+      return InfoMsg;
+    case Message::Error:
+      return ErrorMsg;
+    case Message::DayChange:
+      return DayChangeMsg;
+  }
+  Q_ASSERT(false); // we need to handle all message types
+  return ErrorMsg;
+}
+
+UiStyle::FormatType UiStyle::formatType(const QString & code) {
   if(_formatCodes.contains(code)) return _formatCodes.value(code);
   return Invalid;
 }
 
-QString UiStyle::formatCode(FormatType ftype) const {
+QString UiStyle::formatCode(FormatType ftype) {
   return _formatCodes.key(ftype);
 }
 
-QList<QTextLayout::FormatRange> UiStyle::toTextLayoutList(const FormatList &formatList, int textLength) {
+QList<QTextLayout::FormatRange> UiStyle::toTextLayoutList(const FormatList &formatList, int textLength, quint32 messageLabel) {
   QList<QTextLayout::FormatRange> formatRanges;
   QTextLayout::FormatRange range;
   int i = 0;
   for(i = 0; i < formatList.count(); i++) {
-    range.format = mergedFormat(formatList.at(i).second);
+    range.format = format(formatList.at(i).second, messageLabel);
     range.start = formatList.at(i).first;
     if(i > 0) formatRanges.last().length = range.start - formatRanges.last().start;
     formatRanges.append(range);
@@ -201,15 +201,15 @@ QList<QTextLayout::FormatRange> UiStyle::toTextLayoutList(const FormatList &form
 
 // This method expects a well-formatted string, there is no error checking!
 // Since we create those ourselves, we should be pretty safe that nobody does something crappy here.
-UiStyle::StyledString UiStyle::styleString(const QString &s_) {
+UiStyle::StyledString UiStyle::styleString(const QString &s_, quint32 baseFormat) {
   QString s = s_;
   if(s.length() > 65535) {
     qWarning() << QString("String too long to be styled: %1").arg(s);
     return StyledString();
   }
   StyledString result;
-  result.formatList.append(qMakePair((quint16)0, (quint32)None));
-  quint32 curfmt = (quint32)None;
+  result.formatList.append(qMakePair((quint16)0, baseFormat));
+  quint32 curfmt = baseFormat;
   int pos = 0; quint16 length = 0;
   for(;;) {
     pos = s.indexOf('%', pos);
@@ -264,7 +264,7 @@ UiStyle::StyledString UiStyle::styleString(const QString &s_) {
   return result;
 }
 
-QString UiStyle::mircToInternal(const QString &mirc_) const {
+QString UiStyle::mircToInternal(const QString &mirc_) {
   QString mirc = mirc_;
   mirc.replace('%', "%%");      // escape % just to be sure
   mirc.replace('\x02', "%B");
@@ -312,59 +312,96 @@ QString UiStyle::mircToInternal(const QString &mirc_) const {
 UiStyle::StyledMessage::StyledMessage(const Message &msg)
   : Message(msg)
 {
+  if(type() == Message::Plain)
+    _senderHash = 0xff;
+  else
+    _senderHash = 0x00;  // this means we never compute the hash for msgs that aren't plain
 }
 
-void UiStyle::StyledMessage::style(UiStyle *style) const {
+void UiStyle::StyledMessage::style() const {
   QString user = userFromMask(sender());
   QString host = hostFromMask(sender());
   QString nick = nickFromMask(sender());
-  QString txt = style->mircToInternal(contents());
+  QString txt = UiStyle::mircToInternal(contents());
   QString bufferName = bufferInfo().bufferName();
   bufferName.replace('%', "%%"); // well, you _can_ have a % in a buffername apparently... -_-
 
   QString t;
   switch(type()) {
     case Message::Plain:
-      t = tr("%D0%1").arg(txt); break;
+      //: Plain Message
+      t = tr("%1").arg(txt); break;
     case Message::Notice:
-      t = tr("%Dn%1").arg(txt); break;
-    case Message::Topic:
-    case Message::Server:
-      t = tr("%Ds%1").arg(txt); break;
-    case Message::Error:
-      t = tr("%De%1").arg(txt); break;
+      //: Notice Message
+      t = tr("%1").arg(txt); break;
+    case Message::Action:
+      //: Action Message
+      t = tr("%DN%1%DN %2").arg(nick).arg(txt);
+      break;
+    case Message::Nick:
+      //: Nick Message
+      if(nick == contents()) t = tr("You are now known as %DN%1%DN").arg(txt);
+      else t = tr("%DN%1%DN is now known as %DN%2%DN").arg(nick, txt);
+      break;
+    case Message::Mode:
+      //: Mode Message
+      if(nick.isEmpty()) t = tr("User mode: %DM%1%DM").arg(txt);
+      else t = tr("Mode %DM%1%DM by %DN%2%DN").arg(txt, nick);
+      break;
     case Message::Join:
-      t = tr("%Dj%DN%1%DN %DH(%2@%3)%DH has joined %DC%4%DC").arg(nick, user, host, bufferName); break;
+      //: Join Message
+      t = tr("%DN%1%DN %DH(%2@%3)%DH has joined %DC%4%DC").arg(nick, user, host, bufferName); break;
     case Message::Part:
-      t = tr("%Dp%DN%1%DN %DH(%2@%3)%DH has left %DC%4%DC").arg(nick, user, host, bufferName);
+      //: Part Message
+      t = tr("%DN%1%DN %DH(%2@%3)%DH has left %DC%4%DC").arg(nick, user, host, bufferName);
       if(!txt.isEmpty()) t = QString("%1 (%2)").arg(t).arg(txt);
       break;
     case Message::Quit:
-      t = tr("%Dq%DN%1%DN %DH(%2@%3)%DH has quit").arg(nick, user, host);
+      //: Quit Message
+      t = tr("%DN%1%DN %DH(%2@%3)%DH has quit").arg(nick, user, host);
       if(!txt.isEmpty()) t = QString("%1 (%2)").arg(t).arg(txt);
       break;
     case Message::Kick: {
         QString victim = txt.section(" ", 0, 0);
         QString kickmsg = txt.section(" ", 1);
-        t = tr("%Dk%DN%1%DN has kicked %DN%2%DN from %DC%3%DC").arg(nick).arg(victim).arg(bufferName);
+        //: Kick Message
+        t = tr("%DN%1%DN has kicked %DN%2%DN from %DC%3%DC").arg(nick).arg(victim).arg(bufferName);
         if(!kickmsg.isEmpty()) t = QString("%1 (%2)").arg(t).arg(kickmsg);
       }
       break;
-    case Message::Nick:
-      if(nick == contents()) t = tr("%DrYou are now known as %DN%1%DN").arg(txt);
-      else t = tr("%Dr%DN%1%DN is now known as %DN%2%DN").arg(nick, txt);
-      break;
-    case Message::Mode:
-      if(nick.isEmpty()) t = tr("%DmUser mode: %DM%1%DM").arg(txt);
-      else t = tr("%DmMode %DM%1%DM by %DN%2%DN").arg(txt, nick);
-      break;
-    case Message::Action:
-      t = tr("%Da%DN%1%DN %2").arg(nick).arg(txt);
+    //case Message::Kill: FIXME
+
+    case Message::Server:
+      //: Server Message
+      t = tr("%1").arg(txt); break;
+    case Message::Info:
+      //: Info Message
+      t = tr("%1").arg(txt); break;
+    case Message::Error:
+      //: Error Message
+      t = tr("%1").arg(txt); break;
+    case Message::DayChange:
+      //: Day Change Message
+      t = tr("{Day changed to %1}").arg(timestamp().toString());
       break;
     default:
-      t = tr("%De[%1]").arg(txt);
+      t = tr("[%1]").arg(txt);
   }
-  _contents = style->styleString(t);
+  _contents = UiStyle::styleString(t, UiStyle::formatType(type()));
+}
+
+const QString &UiStyle::StyledMessage::plainContents() const {
+  if(_contents.plainText.isNull())
+    style();
+
+  return _contents.plainText;
+}
+
+const UiStyle::FormatList &UiStyle::StyledMessage::contentsFormatList() const {
+  if(_contents.plainText.isNull())
+    style();
+
+  return _contents.formatList;
 }
 
 QString UiStyle::StyledMessage::decoratedTimestamp() const {
@@ -387,11 +424,20 @@ QString UiStyle::StyledMessage::decoratedSender() const {
       return tr("<%1>").arg(plainSender()); break;
     case Message::Notice:
       return tr("[%1]").arg(plainSender()); break;
+<<<<<<< HEAD
     case Message::Topic:
     case Message::Server:
       return tr("*"); break;
     case Message::Error:
       return tr("*"); break;
+=======
+    case Message::Action:
+      return tr("-*-"); break;
+    case Message::Nick:
+      return tr("<->"); break;
+    case Message::Mode:
+      return tr("***"); break;
+>>>>>>> Handle all message types properly in UiStyle; eliminate msgtype format codes
     case Message::Join:
       return tr("-->"); break;
     case Message::Part:
@@ -400,12 +446,16 @@ QString UiStyle::StyledMessage::decoratedSender() const {
       return tr("<--"); break;
     case Message::Kick:
       return tr("<-*"); break;
-    case Message::Nick:
-      return tr("<->"); break;
-    case Message::Mode:
-      return tr("***"); break;
-    case Message::Action:
-      return tr("-*-"); break;
+    case Message::Kill:
+      return tr("<-x"); break;
+    case Message::Server:
+      return tr("*"); break;
+    case Message::Info:
+      return tr("*"); break;
+    case Message::Error:
+      return tr("*"); break;
+    case Message::DayChange:
+      return tr("-"); break;
     default:
       return tr("%1").arg(plainSender());
   }
@@ -445,7 +495,7 @@ UiStyle::FormatType UiStyle::StyledMessage::senderFormat() const {
     case Message::Kick:
       return UiStyle::KickMsg; break;
     case Message::Nick:
-      return UiStyle::RenameMsg; break;
+      return UiStyle::NickMsg; break;
     case Message::Mode:
       return UiStyle::ModeMsg; break;
     case Message::Action:
@@ -455,6 +505,21 @@ UiStyle::FormatType UiStyle::StyledMessage::senderFormat() const {
   }
 }
 
+// FIXME hardcoded to 16 sender hashes
+quint8 UiStyle::StyledMessage::senderHash() const {
+  if(_senderHash != 0xff)
+    return _senderHash;
+
+  QString nick = nickFromMask(sender()).toLower();
+  if(!nick.isEmpty()) {
+    int chopCount = 0;
+    while(nick.at(nick.count() - 1 - chopCount) == '_')
+      chopCount++;
+    nick.chop(chopCount);
+  }
+  quint16 hash = qChecksum(nick.toAscii().data(), nick.toAscii().size());
+  return (_senderHash = (hash & 0xf) + 1);
+}
 
 /***********************************************************************************/
 
@@ -478,3 +543,19 @@ QDataStream &operator>>(QDataStream &in, UiStyle::FormatList &formatList) {
   }
   return in;
 }
+
+/***********************************************************************************/
+// Stylesheet handling
+/***********************************************************************************/
+
+void UiStyle::loadStyleSheet() {
+  QssParser parser;
+  parser.loadStyleSheet(qApp->styleSheet());
+
+  // TODO handle results
+  QApplication::setPalette(parser.palette());
+
+  qDeleteAll(_metricsCache);
+  _metricsCache.clear();
+  _formatCache = parser.formats();
+}