Don't put loaded formats directly in the format cache
[quassel.git] / src / uisupport / uistyle.cpp
index 6478f8c..1626c01 100644 (file)
@@ -19,6 +19,8 @@
  ***************************************************************************/
 #include <QApplication>
 
+#include "buffersettings.h"
+#include "iconloader.h"
 #include "qssparser.h"
 #include "quassel.h"
 #include "uistyle.h"
 #include "util.h"
 
 QHash<QString, UiStyle::FormatType> UiStyle::_formatCodes;
-
-UiStyle::UiStyle() {
+QString UiStyle::_timestampFormatString;
+
+UiStyle::UiStyle(QObject *parent)
+: QObject(parent),
+  _channelJoinedIcon(SmallIcon("irc-channel-active")),
+  _channelPartedIcon(SmallIcon("irc-channel-inactive")),
+  _userOfflineIcon(SmallIcon("im-user-offline")),
+  _userOnlineIcon(SmallIcon("im-user")),
+  _userAwayIcon(SmallIcon("im-user-away")),
+  _categoryOpIcon(SmallIcon("irc-operator")),
+  _categoryVoiceIcon(SmallIcon("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) {
@@ -36,8 +50,10 @@ UiStyle::UiStyle() {
     Q_ASSERT(QVariant::nameToType("UiStyle::FormatList") != QVariant::Invalid);
   }
 
+  _uiStylePalette = QVector<QBrush>(NumRoles, QBrush());
+
   // Now initialize the mapping between FormatCodes and FormatTypes...
-  _formatCodes["%O"] = None;
+  _formatCodes["%O"] = Base;
   _formatCodes["%B"] = Bold;
   _formatCodes["%S"] = Italic;
   _formatCodes["%U"] = Underline;
@@ -49,34 +65,56 @@ UiStyle::UiStyle() {
   _formatCodes["%DM"] = ModeFlags;
   _formatCodes["%DU"] = Url;
 
+  setTimestampFormatString("[hh:mm:ss]");
+
+  // BufferView / NickView settings
+  BufferSettings bufferSettings;
+  _showBufferViewIcons = _showNickViewIcons = bufferSettings.showUserStateIcons();
+  bufferSettings.notify("ShowUserStateIcons", this, SLOT(showUserStateIconsChanged()));
+
   loadStyleSheet();
 }
 
-UiStyle::~ UiStyle() {
+UiStyle::~UiStyle() {
   qDeleteAll(_metricsCache);
 }
 
+void UiStyle::reload() {
+  loadStyleSheet();
+}
+
 void UiStyle::loadStyleSheet() {
   qDeleteAll(_metricsCache);
   _metricsCache.clear();
   _formatCache.clear();
 
-  QString styleSheet;
+  UiStyleSettings s;
 
+  QString styleSheet;
   styleSheet += loadStyleSheet("file:///" + Quassel::findDataFilePath("default.qss"));
-  styleSheet += loadStyleSheet("file:///" + Quassel::configDirPath() + "custom.qss");
-  // styleSheet += loadStyleSheet("file:///" + some custom file name);  FIXME
+  styleSheet += loadStyleSheet("file:///" + Quassel::configDirPath() + "settings.qss");
+  if(s.value("UseCustomStyleSheet", false).toBool())
+    styleSheet += loadStyleSheet("file:///" + s.value("CustomStyleSheetPath").toString(), true);
   styleSheet += loadStyleSheet("file:///" + Quassel::optionValue("qss"), true);
 
-  if(styleSheet.isEmpty())
-    return;
+  if(!styleSheet.isEmpty()) {
+    QssParser parser;
+    parser.processStyleSheet(styleSheet);
+    QApplication::setPalette(parser.palette());
+    _uiStylePalette = parser.uiStylePalette();
+
+    QTextCharFormat baseFmt = parser.formats().value(Base);
+    foreach(quint64 fmtType, parser.formats().keys()) {
+      QTextCharFormat fmt = baseFmt;
+      fmt.merge(parser.formats().value(fmtType));
+      _formats[fmtType] = fmt;
+    }
+    _listItemFormats = parser.listItemFormats();
 
-  QssParser parser;
-  parser.processStyleSheet(styleSheet);
-  QApplication::setPalette(parser.palette());
-  _formatCache = parser.formats();
+    qApp->setStyleSheet(styleSheet); // pass the remaining sections to the application
+  }
 
-  qApp->setStyleSheet(styleSheet); // pass the remaining sections to the application
+  emit changed();
 }
 
 QString UiStyle::loadStyleSheet(const QString &styleSheet, bool shouldExist) {
@@ -100,66 +138,210 @@ QString UiStyle::loadStyleSheet(const QString &styleSheet, bool shouldExist) {
   return ss;
 }
 
-QTextCharFormat UiStyle::cachedFormat(quint64 key) const {
-  return _formatCache.value(key, QTextCharFormat());
+void UiStyle::setTimestampFormatString(const QString &format) {
+  if(_timestampFormatString != format) {
+    _timestampFormatString = format;
+    // FIXME reload
+  }
+}
+
+/******** ItemView Styling *******/
+
+void UiStyle::showUserStateIconsChanged() {
+  BufferSettings bufferSettings;
+  _showBufferViewIcons = _showNickViewIcons = bufferSettings.showUserStateIcons();
+}
+
+QVariant UiStyle::bufferViewItemData(const QModelIndex &index, int role) const {
+  BufferInfo::Type type = (BufferInfo::Type)index.data(NetworkModel::BufferTypeRole).toInt();
+  bool isActive = index.data(NetworkModel::ItemActiveRole).toBool();
+
+  if(role == Qt::DecorationRole) {
+    if(!_showBufferViewIcons)
+      return QVariant();
+
+    switch(type) {
+      case BufferInfo::ChannelBuffer:
+        if(isActive)
+          return _channelJoinedIcon;
+        else
+          return _channelPartedIcon;
+      case BufferInfo::QueryBuffer:
+        if(!isActive)
+          return _userOfflineIcon;
+        if(index.data(NetworkModel::UserAwayRole).toBool())
+          return _userAwayIcon;
+        else
+          return _userOnlineIcon;
+      default:
+        return QVariant();
+    }
+  }
+
+  quint32 fmtType = BufferViewItem;
+  switch(type) {
+    case BufferInfo::StatusBuffer:
+      fmtType |= NetworkItem;
+      break;
+    case BufferInfo::ChannelBuffer:
+      fmtType |= ChannelBufferItem;
+      break;
+    case BufferInfo::QueryBuffer:
+      fmtType |= QueryBufferItem;
+      break;
+    default:
+      return QVariant();
+  }
+
+  QTextCharFormat fmt = _listItemFormats.value(BufferViewItem);
+  fmt.merge(_listItemFormats.value(fmtType));
+
+  BufferInfo::ActivityLevel activity = (BufferInfo::ActivityLevel)index.data(NetworkModel::BufferActivityRole).toInt();
+  if(activity & BufferInfo::Highlight) {
+    fmt.merge(_listItemFormats.value(BufferViewItem | HighlightedBuffer));
+    fmt.merge(_listItemFormats.value(fmtType | HighlightedBuffer));
+  } else if(activity & BufferInfo::NewMessage) {
+    fmt.merge(_listItemFormats.value(BufferViewItem | UnreadBuffer));
+    fmt.merge(_listItemFormats.value(fmtType | UnreadBuffer));
+  } else if(activity & BufferInfo::OtherActivity) {
+    fmt.merge(_listItemFormats.value(BufferViewItem | ActiveBuffer));
+    fmt.merge(_listItemFormats.value(fmtType | ActiveBuffer));
+  } else if(!isActive) {
+    fmt.merge(_listItemFormats.value(BufferViewItem | InactiveBuffer));
+    fmt.merge(_listItemFormats.value(fmtType | InactiveBuffer));
+  } else if(index.data(NetworkModel::UserAwayRole).toBool()) {
+    fmt.merge(_listItemFormats.value(BufferViewItem | UserAway));
+    fmt.merge(_listItemFormats.value(fmtType | UserAway));
+  }
+
+  return itemData(role, fmt);
+}
+
+QVariant UiStyle::nickViewItemData(const QModelIndex &index, int role) const {
+  NetworkModel::ItemType type = (NetworkModel::ItemType)index.data(NetworkModel::ItemTypeRole).toInt();
+
+  if(role == Qt::DecorationRole) {
+    if(!_showNickViewIcons)
+      return QVariant();
+
+    switch(type) {
+      case NetworkModel::UserCategoryItemType:
+      {
+        int categoryId = index.data(TreeModel::SortRole).toInt();
+        if(categoryId <= _opIconLimit)
+          return _categoryOpIcon;
+        if(categoryId <= _voiceIconLimit)
+          return _categoryVoiceIcon;
+        return _userOnlineIcon;
+      }
+      case NetworkModel::IrcUserItemType:
+        if(index.data(NetworkModel::ItemActiveRole).toBool())
+          return _userOnlineIcon;
+        else
+          return _userAwayIcon;
+      default:
+        return QVariant();
+    }
+  }
+
+  QTextCharFormat fmt = _listItemFormats.value(NickViewItem);
+
+  switch(type) {
+    case NetworkModel::IrcUserItemType:
+      fmt.merge(_listItemFormats.value(NickViewItem | IrcUserItem));
+      if(!index.data(NetworkModel::ItemActiveRole).toBool()) {
+        fmt.merge(_listItemFormats.value(NickViewItem | UserAway));
+        fmt.merge(_listItemFormats.value(NickViewItem | IrcUserItem | UserAway));
+      }
+      break;
+    case NetworkModel::UserCategoryItemType:
+      fmt.merge(_listItemFormats.value(NickViewItem | UserCategoryItem));
+      break;
+    default:
+      return QVariant();
+  }
+
+  return itemData(role, fmt);
+}
+
+QVariant UiStyle::itemData(int role, const QTextCharFormat &format) const {
+  switch(role) {
+    case Qt::FontRole:
+      return format.font();
+    case Qt::ForegroundRole:
+      return format.property(QTextFormat::ForegroundBrush);
+    case Qt::BackgroundRole:
+      return format.property(QTextFormat::BackgroundBrush);
+    default:
+      return QVariant();
+  }
+}
+
+/******** Caching *******/
+
+QTextCharFormat UiStyle::format(quint64 key) const {
+  return _formats.value(key, QTextCharFormat());
 }
 
 QTextCharFormat UiStyle::cachedFormat(quint32 formatType, quint32 messageLabel) const {
-  return cachedFormat(formatType | ((quint64)messageLabel << 32));
+  return _formatCache.value(formatType | ((quint64)messageLabel << 32), QTextCharFormat());
 }
 
 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) {
+QFontMetricsF *UiStyle::fontMetrics(quint32 ftype, quint32 label) {
+  // QFontMetricsF is not assignable, so we need to store pointers :/
   quint64 key = ftype | ((quint64)label << 32);
 
-  // start with the most general format and then specialize
-  fmt.merge(cachedFormat(key & Q_UINT64_C(0x00000000fffffff0)));  // basic subelement format
-  fmt.merge(cachedFormat(key & Q_UINT64_C(0x00000000ffffffff)));  // subelement + msgtype
-  fmt.merge(cachedFormat(key & Q_UINT64_C(0xffff0000fffffff0)));  // subelement + nickhash
-  fmt.merge(cachedFormat(key & Q_UINT64_C(0xffff0000ffffffff)));  // subelement + nickhash + msgtype
-  fmt.merge(cachedFormat(key & Q_UINT64_C(0x0000fffffffffff0)));  // label + subelement
-  fmt.merge(cachedFormat(key & Q_UINT64_C(0x0000ffffffffffff)));  // label + subelement + msgtype
-  fmt.merge(cachedFormat(key & Q_UINT64_C(0xfffffffffffffff0)));  // label + subelement + nickhash
-  fmt.merge(cachedFormat(key & Q_UINT64_C(0xffffffffffffffff)));  // label + subelement + nickhash + msgtype
+  if(_metricsCache.contains(key))
+    return _metricsCache.value(key);
+
+  return (_metricsCache[key] = new QFontMetricsF(format(ftype, label).font()));
 }
 
-// NOTE: This function is intimately tied to the values in FormatType. Don't change this
+/******** Generate formats ********/
+
+// NOTE: This and the following functions are intimately tied to the values in FormatType. Don't change this
 //       until you _really_ know what you do!
-QTextCharFormat UiStyle::format(quint32 ftype, quint32 label) {
+QTextCharFormat UiStyle::format(quint32 ftype, quint32 label_) {
   if(ftype == Invalid)
     return QTextCharFormat();
 
-  quint64 key = ftype | ((quint64)label << 32);
+  quint64 label = (quint64)label_ << 32;
 
   // check if we have exactly this format readily cached already
-  QTextCharFormat fmt = cachedFormat(key);
+  QTextCharFormat fmt = cachedFormat(ftype, label_);
   if(fmt.properties().count())
     return fmt;
 
-  fmt.merge(cachedFormat(key & Q_UINT64_C(0x0000000000000000)));  // basic
-  fmt.merge(cachedFormat(key & Q_UINT64_C(0x000000000000000f)));  // msgtype
-  fmt.merge(cachedFormat(key & Q_UINT64_C(0xffff000000000000)));  // nickhash
-  fmt.merge(cachedFormat(key & Q_UINT64_C(0xffff00000000000f)));  // nickhash + msgtype
-  fmt.merge(cachedFormat(key & Q_UINT64_C(0x0000ffff00000000)));  // label
-  fmt.merge(cachedFormat(key & Q_UINT64_C(0x0000ffff0000000f)));  // label + msgtype
-  fmt.merge(cachedFormat(key & Q_UINT64_C(0xffffffff00000000)));  // label + nickhash
-  fmt.merge(cachedFormat(key & Q_UINT64_C(0xffffffff0000000f)));  // label + nickhash + msgtype
+  mergeFormat(fmt, ftype, label & Q_UINT64_C(0xffff000000000000));
+
+  for(quint64 mask = Q_UINT64_C(0x0000000100000000); mask <= (quint64)Selected << 32; mask <<=1) {
+    if(label & mask)
+      mergeFormat(fmt, ftype, mask | Q_UINT64_C(0xffff000000000000));
+  }
+
+  setCachedFormat(fmt, ftype, label_);
+  return fmt;
+}
+
+void UiStyle::mergeFormat(QTextCharFormat &fmt, quint32 ftype, quint64 label) {
+  mergeSubElementFormat(fmt, ftype & 0x00ff, label);
 
   // 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 & 0xfff00)) { // element format
+    for(quint32 mask = 0x00100; mask <= 0x40000; mask <<= 1) {
       if(ftype & mask) {
-        mergeSubElementFormat(fmt, ftype & 0xffff, label);
+        mergeSubElementFormat(fmt, mask | 0xff, label);
       }
     }
   }
 
   // Now we handle color codes
+  // We assume that those can't be combined with subelement and message types.
   if(ftype & 0x00400000)
     mergeSubElementFormat(fmt, ftype & 0x0f400000, label); // foreground
   if(ftype & 0x00800000)
@@ -170,19 +352,15 @@ QTextCharFormat UiStyle::format(quint32 ftype, quint32 label) {
   // URL
   if(ftype & Url)
     mergeSubElementFormat(fmt, ftype & Url, label);
-
-  setCachedFormat(fmt, ftype, label);
-  return fmt;
 }
 
-QFontMetricsF *UiStyle::fontMetrics(quint32 ftype, quint32 label) {
-  // QFontMetricsF is not assignable, so we need to store pointers :/
-  quint64 key = ftype | ((quint64)label << 32);
-
-  if(_metricsCache.contains(key))
-    return _metricsCache.value(key);
-
-  return (_metricsCache[key] = new QFontMetricsF(format(ftype, label).font()));
+// Merge a subelement format into an existing message format
+void UiStyle::mergeSubElementFormat(QTextCharFormat& fmt, quint32 ftype, quint64 label) {
+  quint64 key = ftype | label;
+  fmt.merge(format(key & Q_UINT64_C(0x0000ffffffffff00)));  // label + subelement
+  fmt.merge(format(key & Q_UINT64_C(0x0000ffffffffffff)));  // label + subelement + msgtype
+  fmt.merge(format(key & Q_UINT64_C(0xffffffffffffff00)));  // label + subelement + nickhash
+  fmt.merge(format(key & Q_UINT64_C(0xffffffffffffffff)));  // label + subelement + nickhash + msgtype
 }
 
 UiStyle::FormatType UiStyle::formatType(Message::Type msgType) {
@@ -216,7 +394,8 @@ UiStyle::FormatType UiStyle::formatType(Message::Type msgType) {
     case Message::DayChange:
       return DayChangeMsg;
   }
-  Q_ASSERT(false); // we need to handle all message types
+  //Q_ASSERT(false); // we need to handle all message types
+  qWarning() << Q_FUNC_INFO << "Unknown message type:" << msgType;
   return ErrorMsg;
 }
 
@@ -281,7 +460,7 @@ UiStyle::StyledString UiStyle::styleString(const QString &s_, quint32 baseFormat
         length = 6;
       }
     } else if(s[pos+1] == 'O') { // reset formatting
-      curfmt &= 0x0000000f; // we keep message type-specific formatting
+      curfmt &= 0x000000ff; // we keep message type-specific formatting
       length = 2;
     } else if(s[pos+1] == 'R') { // reverse
       // TODO: implement reverse formatting
@@ -449,7 +628,7 @@ const UiStyle::FormatList &UiStyle::StyledMessage::contentsFormatList() const {
 }
 
 QString UiStyle::StyledMessage::decoratedTimestamp() const {
-  return QString("[%1]").arg(timestamp().toLocalTime().toString("hh:mm:ss"));
+  return timestamp().toLocalTime().toString(UiStyle::timestampFormatString());
 }
 
 QString UiStyle::StyledMessage::plainSender() const {
@@ -468,20 +647,12 @@ 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:
@@ -505,50 +676,6 @@ QString UiStyle::StyledMessage::decoratedSender() const {
   }
 }
 
-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::NickMsg; break;
-    case Message::Mode:
-      return UiStyle::ModeMsg; break;
-    case Message::Action:
-      return UiStyle::ActionMsg; break;
-    default:
-      return UiStyle::ErrorMsg;
-  }
-}
-
 // FIXME hardcoded to 16 sender hashes
 quint8 UiStyle::StyledMessage::senderHash() const {
   if(_senderHash != 0xff)