Switch to lowercase for subelement and message types in QssParser
[quassel.git] / src / uisupport / uistyle.cpp
index afa77e6..6322fb8 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>
-
-UiStyle::UiStyle(const QString &settingsKey) : _settingsKey(settingsKey) {
+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) {
@@ -36,39 +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(), Quassel::buildInfo().clientApplicationName);
-#else
-  QSettings mys(QCoreApplication::organizationName(), Quassel::buildInfo().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
-  _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);
-  }
-
   // Now initialize the mapping between FormatCodes and FormatTypes...
   _formatCodes["%O"] = None;
   _formatCodes["%B"] = Bold;
@@ -96,88 +61,92 @@ 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<<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);
+  loadStyleSheet();
+}
 
-  QTextCharFormat underline; underline.setFontUnderline(true);
-  setFormat(Underline, underline, Settings::Default);
+UiStyle::~ UiStyle() {
+  qDeleteAll(_metricsCache);
+}
 
-  // All other formats should be defined in derived classes.
+QTextCharFormat UiStyle::cachedFormat(quint64 key) const {
+  return _formatCache.value(key, QTextCharFormat());
 }
 
-UiStyle::~ UiStyle() {
-  qDeleteAll(_cachedFontMetrics);
+QTextCharFormat UiStyle::cachedFormat(quint32 formatType, quint32 messageLabel) const {
+  return cachedFormat(formatType | ((quint64)messageLabel << 32));
 }
 
-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();
+void UiStyle::setCachedFormat(const QTextCharFormat &format, quint32 formatType, quint32 messageLabel) {
+  _formatCache[formatType | ((quint64)messageLabel << 32)] = format;
 }
 
-QTextCharFormat UiStyle::format(FormatType ftype, Settings::Mode mode) const {
-  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 & 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(format(ftype, label).font()));
 }
 
 UiStyle::FormatType UiStyle::formatType(const QString & code) const {
@@ -194,7 +163,7 @@ QList<QTextLayout::FormatRange> UiStyle::toTextLayoutList(const FormatList &form
   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);
     range.start = formatList.at(i).first;
     if(i > 0) formatRanges.last().length = range.start - formatRanges.last().start;
     formatRanges.append(range);
@@ -312,31 +281,27 @@ QString UiStyle::mircToInternal(const QString &mirc_) const {
   return mirc;
 }
 
-UiStyle::StyledMessage UiStyle::styleMessage(const Message &msg) {
-  return StyledMessage(msg, this);
-}
-
 /***********************************************************************************/
+UiStyle::StyledMessage::StyledMessage(const Message &msg)
+  : Message(msg)
+{
+}
 
-UiStyle::StyledMessage::StyledMessage(const Message &msg, UiStyle *style) {
-  QString user = userFromMask(msg.sender());
-  QString host = hostFromMask(msg.sender());
-  QString nick = nickFromMask(msg.sender());
-  QString txt = style->mircToInternal(msg.contents());
-  QString bufferName = msg.bufferInfo().bufferName();
+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... -_-
 
-  _msgType = msg.type();
-  _timestamp = msg.timestamp();
-
   QString t;
-  switch(msg.type()) {
+  switch(type()) {
     case Message::Plain:
-      _sender = nick;
       t = tr("%D0%1").arg(txt); break;
     case Message::Notice:
-      _sender = nick;
       t = tr("%Dn%1").arg(txt); break;
+    case Message::Topic:
     case Message::Server:
       t = tr("%Ds%1").arg(txt); break;
     case Message::Error:
@@ -353,14 +318,13 @@ UiStyle::StyledMessage::StyledMessage(const Message &msg, UiStyle *style) {
       break;
     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:
-      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:
@@ -371,25 +335,20 @@ UiStyle::StyledMessage::StyledMessage(const Message &msg, UiStyle *style) {
       t = tr("%Da%DN%1%DN %2").arg(nick).arg(txt);
       break;
     default:
-      _sender = msg.sender();
       t = tr("%De[%1]").arg(txt);
   }
   _contents = style->styleString(t);
 }
 
-QDateTime UiStyle::StyledMessage::timestamp() const {
-  return _timestamp;
-}
-
 QString UiStyle::StyledMessage::decoratedTimestamp() const {
-  return QString("[%1]").arg(_timestamp.toLocalTime().toString("hh:mm:ss"));
+  return QString("[%1]").arg(timestamp().toLocalTime().toString("hh:mm:ss"));
 }
 
-QString UiStyle::StyledMessage::sender() const {
+QString UiStyle::StyledMessage::plainSender() const {
   switch(type()) {
     case Message::Plain:
     case Message::Notice:
-      return _sender;
+      return nickFromMask(sender());
     default:
       return QString();
   }
@@ -398,9 +357,10 @@ QString UiStyle::StyledMessage::sender() const {
 QString UiStyle::StyledMessage::decoratedSender() const {
   switch(type()) {
     case Message::Plain:
-      return tr("<%1>").arg(_sender); break;
+      return tr("<%1>").arg(plainSender()); break;
     case Message::Notice:
-      return tr("[%1]").arg(_sender); break;
+      return tr("[%1]").arg(plainSender()); break;
+    case Message::Topic:
     case Message::Server:
       return tr("*"); break;
     case Message::Error:
@@ -420,24 +380,31 @@ QString UiStyle::StyledMessage::decoratedSender() const {
     case Message::Action:
       return tr("-*-"); break;
     default:
-      return tr("%1").arg(_sender);
+      return tr("%1").arg(plainSender());
   }
 }
 
-QString UiStyle::StyledMessage::contents() const {
-  return _contents.plainText;
-}
-
-UiStyle::FormatType UiStyle::StyledMessage::timestampFormat() const {
-  return UiStyle::Timestamp;
-}
-
 UiStyle::FormatType UiStyle::StyledMessage::senderFormat() const {
   switch(type()) {
     case Message::Plain:
-      return UiStyle::Sender; break;
+      // 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:
@@ -461,9 +428,6 @@ UiStyle::FormatType UiStyle::StyledMessage::senderFormat() const {
   }
 }
 
-UiStyle::FormatList UiStyle::StyledMessage::contentsFormatList() const {
-  return _contents.formatList;
-}
 
 /***********************************************************************************/
 
@@ -487,3 +451,20 @@ 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();
+
+}