Rework mergedFormats() to handle pre-set formats
[quassel.git] / src / uisupport / uistyle.cpp
index e0af5b1..84da306 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-08 by the Quassel Project                          *
+ *   Copyright (C) 2005-09 by the Quassel Project                          *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -19,8 +19,9 @@
  ***************************************************************************/
 #include <QApplication>
 
+#include "quassel.h"
 #include "uistyle.h"
-#include "uistylesettings.h"
+#include "uisettings.h"
 #include "util.h"
 
 UiStyle::UiStyle(const QString &settingsKey) : _settingsKey(settingsKey) {
@@ -32,25 +33,23 @@ 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(QFont("Monospace", QApplication::font().pointSize()));
+  _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);
   }
 
-  // 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";
+  // 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;
@@ -79,14 +78,21 @@ UiStyle::UiStyle(const QString &settingsKey) : _settingsKey(settingsKey) {
   _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);
-    _formatCodes[QString("%Dcb%1").arg(idx)] = (FormatType)(BgCol00 + i);
+    _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), fgf, Settings::Default);
-    bgf.setBackground(QBrush(QColor(colors[i]))); setFormat((FormatType)(BgCol00 + i), bgf, Settings::Default);
+    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
@@ -103,7 +109,7 @@ UiStyle::UiStyle(const QString &settingsKey) : _settingsKey(settingsKey) {
 }
 
 UiStyle::~ UiStyle() {
-  
+  qDeleteAll(_cachedFontMetrics);
 }
 
 void UiStyle::setFormat(FormatType ftype, QTextCharFormat fmt, Settings::Mode mode) {
@@ -115,15 +121,28 @@ void UiStyle::setFormat(FormatType ftype, QTextCharFormat fmt, Settings::Mode mo
       _customFormats[ftype] = fmt;
       s.setCustomFormat(ftype, fmt);
     } else {
-      _customFormats[ftype] = QTextFormat().toCharFormat();
+      _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();
+}
+
+void UiStyle::setSenderAutoColor( bool state ) {
+  _senderAutoColor = state;
+  UiStyleSettings s(_settingsKey);
+  s.setValue("Colors/SenderAutoColor", QVariant(state));
 }
 
 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 FIXME
+    ftype = Sender;
+  }
+
   if(mode == Settings::Custom && _customFormats.contains(ftype)) return _customFormats.value(ftype);
   else return _defaultFormats.value(ftype, QTextCharFormat());
 }
@@ -131,23 +150,83 @@ QTextCharFormat UiStyle::format(FormatType ftype, Settings::Mode mode) const {
 // 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[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));
+  if(ftype == Invalid)
+    return QTextCharFormat();
+  if(_cachedFormats.contains(ftype))
+    return _cachedFormats.value(ftype);
+
+  QTextCharFormat fmt;
+
+  // Check if we have a special message format stored already sans color codes
+  if(_cachedFormats.contains(ftype & 0x1fffff))
+    fmt = _cachedFormats.value(ftype &0x1fffff);
+  else {
+    // Nope, so we have to construct it...
+    // We assume that we don't mix mirc format codes and component codes, so at this point we know that it's either
+    // a stock (not stylesheeted) component, or mirc formats
+    // In both cases, we start off with the basic format for this message type and then merge the extra stuff
+
+    // Check if we at least already have something stored for the message type first
+    if(_cachedFormats.contains(ftype & 0xf))
+      fmt = _cachedFormats.value(ftype & 0xf);
+    else {
+      // Not being in the cache means it hasn't been preset via stylesheet (or used before)
+      // We might still have set something in code as a fallback, so merge
+      fmt = format(None);
+      fmt.merge(format((FormatType)(ftype & 0x0f)));
+      // This can be cached
+      _cachedFormats[ftype & 0x0f] = fmt;
+    }
+    // OK, at this point we have the message type format - now merge the rest
+    if((ftype & 0xf0)) { // mirc format
+      for(quint32 mask = 0x10; mask <= 0x80; mask <<= 1) {
+        if(!(ftype & mask))
+          continue;
+        // We need to check for overrides in the cache
+        if(_cachedFormats.contains(mask | (ftype & 0x0f)))
+          fmt.merge(_cachedFormats.value(mask | (ftype & 0x0f)));
+        else if(_cachedFormats.contains(mask))
+          fmt.merge(_cachedFormats.value(mask));
+        else // nothing in cache, use stock format
+          fmt.merge(format((FormatType)mask));
+      }
+    } else { // component
+      // We've already checked the cache for the combo of msgtype and component and failed,
+      // so we check if we defined a general format and merge this, or the stock format else
+      if(_cachedFormats.contains(ftype & 0xff00))
+        fmt.merge(_cachedFormats.value(ftype & 0xff00));
+      else
+        fmt.merge(format((FormatType)(ftype & 0xff00)));
+    }
   }
-  // color codes!
-  if(ftype & 0x00400000) fmt.merge(format((FormatType)(ftype & 0x0f400000))); // foreground
-  if(ftype & 0x00800000) fmt.merge(format((FormatType)(ftype & 0xf0800000))); // background
+
+  // Now we handle color codes. We assume that those can't be combined with components
+  if(ftype & 0x00400000)
+    fmt.merge(format((FormatType)(ftype & 0x0f400000))); // foreground
+  if(ftype & 0x00800000)
+    fmt.merge(format((FormatType)(ftype & 0xf0800000))); // background
+
+  // Sender auto colors
+  if(_senderAutoColor && (ftype & 0x200) && (ftype & 0xff000200) != 0x200) {
+    if(_cachedFormats.contains(ftype & 0xff00020f))
+      fmt.merge(_cachedFormats.value(ftype & 0xff00020f));
+    else if(_cachedFormats.contains(ftype & 0xff000200))
+      fmt.merge(_cachedFormats.value(ftype & 0xff000200));
+    else
+      fmt.merge(format((FormatType)(ftype & 0xff000200)));
+  }
+
   // URL
-  if(ftype & Url) fmt.merge(format(Url));
-  _cachedFormats[ftype] = fmt;
-  return fmt;
+  if(ftype & Url)
+    fmt.merge(format(Url)); // TODO handle this properly
+
+  return _cachedFormats[ftype] = fmt;
+}
+
+QFontMetricsF *UiStyle::fontMetrics(quint32 ftype) {
+  // 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()));
 }
 
 UiStyle::FormatType UiStyle::formatType(const QString & code) const {
@@ -159,14 +238,32 @@ QString UiStyle::formatCode(FormatType ftype) const {
   return _formatCodes.key(ftype);
 }
 
+QList<QTextLayout::FormatRange> UiStyle::toTextLayoutList(const FormatList &formatList, int textLength) {
+  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.start = formatList.at(i).first;
+    if(i > 0) formatRanges.last().length = range.start - formatRanges.last().start;
+    formatRanges.append(range);
+  }
+  if(i > 0) formatRanges.last().length = textLength - formatRanges.last().start;
+  return formatRanges;
+}
+
 // 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_) {
   QString s = s_;
+  if(s.length() > 65535) {
+    qWarning() << QString("String too long to be styled: %1").arg(s);
+    return StyledString();
+  }
   StyledString result;
-  result.formats.append(qMakePair(0, (quint32)None));
+  result.formatList.append(qMakePair((quint16)0, (quint32)None));
   quint32 curfmt = (quint32)None;
-  int pos = 0; int length = 0;
+  int pos = 0; quint16 length = 0;
   for(;;) {
     pos = s.indexOf('%', pos);
     if(pos < 0) break;
@@ -183,10 +280,13 @@ UiStyle::StyledString UiStyle::styleString(const QString &s_) {
         int color = 10 * s[pos+4].digitValue() + s[pos+5].digitValue();
         //TODO: use 99 as transparent color (re mirc color "standard")
         color &= 0x0f;
-        if(pos+3 == 'f')
+        if(s[pos+3] == 'f') {
+          curfmt &= 0xf0ffffff;
           curfmt |= (color << 24) | 0x00400000;
-        else
+        } else {
+          curfmt &= 0x0fffffff;
           curfmt |= (color << 28) | 0x00800000;
+        }
         length = 6;
       }
     } else if(s[pos+1] == 'O') { // reset formatting
@@ -201,23 +301,23 @@ UiStyle::StyledString UiStyle::styleString(const QString &s_) {
       if(s[pos+1] == 'D') code += s[pos+2];
       FormatType ftype = formatType(code);
       if(ftype == Invalid) {
-        qWarning(qPrintable(QString("Invalid format code in string: %1").arg(s)));
+        qWarning() << (QString("Invalid format code in string: %1").arg(s));
         continue;
       }
       curfmt ^= ftype;
       length = code.length();
     }
     s.remove(pos, length);
-    if(pos == result.formats.last().first)
-      result.formats.last().second = curfmt;
+    if(pos == result.formatList.last().first)
+      result.formatList.last().second = curfmt;
     else
-      result.formats.append(qMakePair(pos, curfmt));
+      result.formatList.append(qMakePair((quint16)pos, curfmt));
   }
-  result.text = s;
+  result.plainText = s;
   return result;
 }
 
-QString UiStyle::mircToInternal(const QString &mirc_) {
+QString UiStyle::mircToInternal(const QString &mirc_) const {
   QString mirc = mirc_;
   mirc.replace('%', "%%");      // escape % just to be sure
   mirc.replace('\x02', "%B");
@@ -261,69 +361,156 @@ QString UiStyle::mircToInternal(const QString &mirc_) {
   return mirc;
 }
 
-UiStyle::StyledMessage UiStyle::styleMessage(const Message &msg) {
-  QString user = userFromMask(msg.sender());
-  QString host = hostFromMask(msg.sender());
-  QString nick = nickFromMask(msg.sender());
-  QString txt = mircToInternal(msg.text());
-  QString bufferName = msg.bufferInfo().bufferName();
-
-  StyledMessage result;
+/***********************************************************************************/
+UiStyle::StyledMessage::StyledMessage(const Message &msg)
+  : Message(msg)
+{
+}
 
-  result.timestamp = styleString(tr("%DT[%1]").arg(msg.timestamp().toLocalTime().toString("hh:mm:ss")));
+void UiStyle::StyledMessage::style(UiStyle *style) const {
+  QString user = userFromMask(sender());
+  QString host = hostFromMask(sender());
+  QString nick = nickFromMask(sender());
+  QString txt = style->mircToInternal(contents());
+  QString bufferName = bufferInfo().bufferName();
+  bufferName.replace('%', "%%"); // well, you _can_ have a % in a buffername apparently... -_-
 
-  QString s, t;
-  switch(msg.type()) {
+  QString t;
+  switch(type()) {
     case Message::Plain:
-      s = tr("%DS<%1>").arg(nick); t = tr("%D0%1").arg(txt); break;
+      t = tr("%D0%1").arg(txt); break;
     case Message::Notice:
-      s = tr("%Dn[%1]").arg(nick); t = tr("%Dn%1").arg(txt); break;
+      t = tr("%Dn%1").arg(txt); break;
+    case Message::Topic:
     case Message::Server:
-      s = tr("%Ds*"); t = tr("%Ds%1").arg(txt); break;
+      t = tr("%Ds%1").arg(txt); break;
     case Message::Error:
-      s = tr("%De*"); t = tr("%De%1").arg(txt); break;
+      t = tr("%De%1").arg(txt); break;
     case Message::Join:
-      s = tr("%Dj-->"); t = tr("%Dj%DN%1%DN %DH(%2@%3)%DH has joined %DC%4%DC").arg(nick, user, host, bufferName); break;
+      t = tr("%Dj%DN%1%DN %DH(%2@%3)%DH has joined %DC%4%DC").arg(nick, user, host, bufferName); break;
     case Message::Part:
-      s = tr("%Dp<--"); t = tr("%Dp%DN%1%DN %DH(%2@%3)%DH has left %DC%4%DC").arg(nick, user, host, bufferName);
+      t = tr("%Dp%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:
-      s = tr("%Dq<--"); t = tr("%Dq%DN%DU%1%DU%DN %DH(%2@%3)%DH has quit").arg(nick, user, host);
+      t = tr("%Dq%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:
-      { s = tr("%Dk<-*");
+    case Message::Kick: {
         QString victim = txt.section(" ", 0, 0);
-        //if(victim == ui.ownNick->currentText()) victim = tr("you");
         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);
         if(!kickmsg.isEmpty()) t = QString("%1 (%2)").arg(t).arg(kickmsg);
       }
       break;
     case Message::Nick:
-      s = tr("%Dr<->");
-      if(nick == msg.text()) t = tr("%DrYou are now known as %DN%1%DN").arg(txt);
+      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:
-      s = tr("%Dm***");
       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:
-      s = tr("%Da-*-");
       t = tr("%Da%DN%1%DN %2").arg(nick).arg(txt);
       break;
     default:
-      s = tr("%De%1").arg(msg.sender());
       t = tr("%De[%1]").arg(txt);
   }
-  result.sender = styleString(s);
-  result.text = styleString(t);
-  return result;
+  _contents = style->styleString(t);
 }
 
+QString UiStyle::StyledMessage::decoratedTimestamp() const {
+  return QString("[%1]").arg(timestamp().toLocalTime().toString("hh:mm:ss"));
+}
+
+QString UiStyle::StyledMessage::plainSender() const {
+  switch(type()) {
+    case Message::Plain:
+    case Message::Notice:
+      return nickFromMask(sender());
+    default:
+      return QString();
+  }
+}
+
+QString UiStyle::StyledMessage::decoratedSender() const {
+  switch(type()) {
+    case Message::Plain:
+      return tr("<%1>").arg(plainSender()); break;
+    case Message::Notice:
+      return tr("[%1]").arg(plainSender()); break;
+    case Message::Topic:
+    case Message::Server:
+      return tr("*"); break;
+    case Message::Error:
+      return tr("*"); break;
+    case Message::Join:
+      return tr("-->"); break;
+    case Message::Part:
+      return tr("<--"); break;
+    case Message::Quit:
+      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;
+    default:
+      return tr("%1").arg(plainSender());
+  }
+}
+
+UiStyle::FormatType UiStyle::StyledMessage::senderFormat() const {
+  switch(type()) {
+    case Message::Plain:
+      // To produce random like but stable nick colorings some sort of hashing should work best.
+      // In this case we just use the qt function qChecksum which produces a
+      // CRC16 hash. This should be fast and 16 bits are more than enough.
+      {
+        QString nick = nickFromMask(sender()).toLower();
+        if(!nick.isEmpty()) {
+          int chopCount = 0;
+          while(nick[nick.count() - 1 - chopCount] == '_') {
+            chopCount++;
+          }
+          nick.chop(chopCount);
+        }
+        quint16 hash = qChecksum(nick.toAscii().data(), nick.toAscii().size());
+        return (UiStyle::FormatType)((((hash % 12) + 1) << 24) + 0x200); // FIXME: amount of sender colors hardwired
+      }
+    case Message::Notice:
+      return UiStyle::NoticeMsg; break;
+    case Message::Topic:
+    case Message::Server:
+      return UiStyle::ServerMsg; break;
+    case Message::Error:
+      return UiStyle::ErrorMsg; break;
+    case Message::Join:
+      return UiStyle::JoinMsg; break;
+    case Message::Part:
+      return UiStyle::PartMsg; break;
+    case Message::Quit:
+      return UiStyle::QuitMsg; break;
+    case Message::Kick:
+      return UiStyle::KickMsg; break;
+    case Message::Nick:
+      return UiStyle::RenameMsg; break;
+    case Message::Mode:
+      return UiStyle::ModeMsg; break;
+    case Message::Action:
+      return UiStyle::ActionMsg; break;
+    default:
+      return UiStyle::ErrorMsg;
+  }
+}
+
+
+/***********************************************************************************/
+
 QDataStream &operator<<(QDataStream &out, const UiStyle::FormatList &formatList) {
   out << formatList.count();
   UiStyle::FormatList::const_iterator it = formatList.begin();
@@ -335,12 +522,12 @@ QDataStream &operator<<(QDataStream &out, const UiStyle::FormatList &formatList)
 }
 
 QDataStream &operator>>(QDataStream &in, UiStyle::FormatList &formatList) {
-  int cnt;
+  quint16 cnt;
   in >> cnt;
-  for(int i = 0; i < cnt; i++) {
-    int pos; quint32 ftype;
+  for(quint16 i = 0; i < cnt; i++) {
+    quint16 pos; quint32 ftype;
     in >> pos >> ftype;
-    formatList.append(qMakePair(pos, ftype));
+    formatList.append(qMakePair((quint16)pos, ftype));
   }
   return in;
 }