Move QssParser out of UiStyle
[quassel.git] / src / uisupport / uistyle.cpp
index 627ba5e..e0dbce9 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  *
  ***************************************************************************/
 #include <QApplication>
 
+#include "qssparser.h"
+#include "quassel.h"
 #include "uistyle.h"
 #include "uisettings.h"
 #include "util.h"
 
-// FIXME remove with migration code
-#include <QSettings>
-#include "global.h"
-
 UiStyle::UiStyle(const QString &settingsKey) : _settingsKey(settingsKey) {
   // register FormatList if that hasn't happened yet
   // FIXME I don't think this actually avoids double registration... then again... does it hurt?
@@ -36,24 +34,6 @@ UiStyle::UiStyle(const QString &settingsKey) : _settingsKey(settingsKey) {
     Q_ASSERT(QVariant::nameToType("UiStyle::FormatList") != QVariant::Invalid);
   }
 
-  // FIXME remove migration at some point
-  // We remove old settings if we find them, since they conflict
-#ifdef Q_WS_MAC
-  QSettings mys(QCoreApplication::organizationDomain(), Global::clientApplicationName);
-#else
-  QSettings mys(QCoreApplication::organizationName(), Global::clientApplicationName);
-#endif
-  mys.beginGroup("QtUi");
-  if(mys.childGroups().contains("Colors")) {
-    qDebug() << "Removing obsolete UiStyle settings!";
-    mys.endGroup();
-    mys.remove("Ui");
-    mys.remove("QtUiStyle");
-    mys.remove("QtUiStyleNew");
-    mys.remove("QtUi/Colors");
-    mys.sync();
-  }
-
   _defaultFont = QFont("Monospace", QApplication::font().pointSize());
 
   // Default format
@@ -69,6 +49,9 @@ UiStyle::UiStyle(const QString &settingsKey) : _settingsKey(settingsKey) {
     _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;
@@ -122,12 +105,12 @@ UiStyle::UiStyle(const QString &settingsKey) : _settingsKey(settingsKey) {
 
   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) {
@@ -144,39 +127,107 @@ void UiStyle::setFormat(FormatType ftype, QTextCharFormat fmt, Settings::Mode mo
     }
   }
   // TODO: invalidate only affected cached formats... if that's possible with less overhead than just rebuilding them
-  _cachedFormats.clear();
+  qDeleteAll(_metricsCache);
+  _metricsCache.clear();
+  _formatCache.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());
 }
 
+QTextCharFormat UiStyle::cachedFormat(quint64 key) const {
+  return _formatCache.value(key, QTextCharFormat());
+}
+
+QTextCharFormat UiStyle::cachedFormat(quint32 formatType, quint32 messageLabel) const {
+  return cachedFormat(formatType | ((quint64)messageLabel << 32));
+}
+
+void UiStyle::setCachedFormat(const QTextCharFormat &format, quint32 formatType, quint32 messageLabel) {
+  _formatCache[formatType | ((quint64)messageLabel << 32)] = format;
+}
+
+// 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::mergedFormat(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.isValid())
+    return fmt;
+
+  fmt.merge(cachedFormat(key & 0x0000000000000000));  // basic
+  fmt.merge(cachedFormat(key & 0x000000000000000f));  // msgtype
+  fmt.merge(cachedFormat(key & 0x0000ffff00000000));  // label
+  fmt.merge(cachedFormat(key & 0x0000ffff0000000f));  // label + 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
+
+  // 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(mergedFormat(ftype, label).font()));
 }
 
 UiStyle::FormatType UiStyle::formatType(const QString & code) const {
@@ -251,7 +302,7 @@ 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;
@@ -311,69 +362,156 @@ QString UiStyle::mircToInternal(const QString &mirc_) const {
   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.contents());
-  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.contents()) 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.contents = 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();
@@ -394,3 +532,16 @@ 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());
+  //QApplication::setStyleSheet(qApp->styleSheet()); // reload with custom palette settings
+}