Add configuration option for a custom stylesheet
[quassel.git] / src / uisupport / uistyle.cpp
index 1740185..332344c 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-07 by the Quassel IRC Team                         *
+ *   Copyright (C) 2005-09 by the Quassel Project                          *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   Free Software Foundation, Inc.,                                       *
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
+#include <QApplication>
 
+#include "qssparser.h"
+#include "quassel.h"
 #include "uistyle.h"
-#include "uistylesettings.h"
+#include "uisettings.h"
+#include "util.h"
 
-UiStyle::UiStyle(const QString &settingsKey) : _settingsKey(settingsKey) {
-  // Default format
-  QTextCharFormat def;
-  def.setForeground(QBrush("#000000"));
-  def.setFont(QFont("Mono",12));
-  _defaultFormats = QVector<QTextCharFormat>(NumFormatTypes, def);
-  _customFormats = QVector<QTextCharFormat>(NumFormatTypes, QTextFormat().toCharFormat());
+QHash<QString, UiStyle::FormatType> UiStyle::_formatCodes;
+QString UiStyle::_timestampFormatString;
 
-  // Load saved custom formats
-  UiStyleSettings s(_settingsKey);
-  foreach(FormatType type, s.availableFormats()) {
-    _customFormats[type] = s.customFormat(type);
+UiStyle::UiStyle(QObject *parent) : QObject(parent) {
+  // 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) {
+    qRegisterMetaType<FormatList>("UiStyle::FormatList");
+    qRegisterMetaTypeStreamOperators<FormatList>("UiStyle::FormatList");
+    Q_ASSERT(QVariant::nameToType("UiStyle::FormatList") != QVariant::Invalid);
   }
 
-  // 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";
-
   // Now initialize the mapping between FormatCodes and FormatTypes...
   _formatCodes["%O"] = None;
   _formatCodes["%B"] = Bold;
@@ -49,137 +44,258 @@ 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;
 
-  // 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);
-    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);
+  setTimestampFormatString("[hh:mm:ss]");
+  loadStyleSheet();
+}
+
+UiStyle::~UiStyle() {
+  qDeleteAll(_metricsCache);
+}
+
+void UiStyle::loadStyleSheet() {
+  qDeleteAll(_metricsCache);
+  _metricsCache.clear();
+  _formatCache.clear();
+
+  UiStyleSettings s;
+
+  QString styleSheet;
+  styleSheet += loadStyleSheet("file:///" + Quassel::findDataFilePath("default.qss"));
+  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;
+
+  QssParser parser;
+  parser.processStyleSheet(styleSheet);
+  QApplication::setPalette(parser.palette());
+  _formatCache = parser.formats();
+
+  qApp->setStyleSheet(styleSheet); // pass the remaining sections to the application
+
+  emit changed();
+}
+
+QString UiStyle::loadStyleSheet(const QString &styleSheet, bool shouldExist) {
+  QString ss = styleSheet;
+  if(ss.startsWith("file:///")) {
+    ss.remove(0, 8);
+    if(ss.isEmpty())
+      return QString();
+
+    QFile file(ss);
+    if(file.open(QFile::ReadOnly)) {
+      QTextStream stream(&file);
+      ss = stream.readAll();
+      file.close();
+    } else {
+      if(shouldExist)
+        qWarning() << "Could not open stylesheet file:" << file.fileName();
+      return QString();
+    }
   }
+  return ss;
+}
 
-  // Set a few more standard formats
-  QTextCharFormat bold; bold.setFontWeight(QFont::Bold);
-  setFormat(Bold, bold, Settings::Default);
+void UiStyle::setTimestampFormatString(const QString &format) {
+  if(_timestampFormatString != format) {
+    _timestampFormatString = format;
+    // FIXME reload
+  }
+}
 
-  QTextCharFormat italic; italic.setFontItalic(true);
-  setFormat(Italic, italic, Settings::Default);
+/******** Caching *******/
 
-  QTextCharFormat underline; underline.setFontUnderline(true);
-  setFormat(Underline, underline, Settings::Default);
+QTextCharFormat UiStyle::cachedFormat(quint64 key) const {
+  return _formatCache.value(key, QTextCharFormat());
+}
 
-  // All other formats should be defined in derived classes.
+QTextCharFormat UiStyle::cachedFormat(quint32 formatType, quint32 messageLabel) const {
+  return cachedFormat(formatType | ((quint64)messageLabel << 32));
 }
 
-UiStyle::~ UiStyle() {
-  
+void UiStyle::setCachedFormat(const QTextCharFormat &format, quint32 formatType, quint32 messageLabel) {
+  _formatCache[formatType | ((quint64)messageLabel << 32)] = format;
 }
 
-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[ftype] = QTextFormat().toCharFormat();
-      s.removeCustomFormat(ftype);
+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()));
+}
+
+/******** 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_) {
+  if(ftype == Invalid)
+    return QTextCharFormat();
+
+  quint64 label = (quint64)label_ << 32;
+
+  // check if we have exactly this format readily cached already
+  QTextCharFormat fmt = cachedFormat(label|ftype);
+  if(fmt.properties().count())
+    return fmt;
+
+  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 & 0x000f, 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 = 0x0010; mask <= 0x2000; mask <<= 1) {
+      if(ftype & mask) {
+        mergeSubElementFormat(fmt, mask | 0x0f, 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)
+    mergeSubElementFormat(fmt, ftype & 0xf0800000, label); // background
+  if((ftype & 0x00c00000) == 0x00c00000)
+    mergeSubElementFormat(fmt, ftype & 0xffc00000, label); // combination
+
+  // URL
+  if(ftype & Url)
+    mergeSubElementFormat(fmt, ftype & Url, label);
 }
 
-QTextCharFormat UiStyle::format(FormatType ftype, Settings::Mode mode) const {
-  if(mode == Settings::Custom && _customFormats[ftype].isValid()) return _customFormats[ftype];
-  else return _defaultFormats[ftype];
+// Merge a subelement format into an existing message format
+void UiStyle::mergeSubElementFormat(QTextCharFormat& fmt, quint32 ftype, quint64 label) {
+  quint64 key = ftype | label;
+  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
+}
+
+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) const {
+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);
 }
 
-UiStyle::StyledText UiStyle::styleString(QString s) {
-  StyledText result;
-  QList<FormatType> fmtList;
-  fmtList.append(None);
-  QTextLayout::FormatRange curFmtRng;
-  curFmtRng.format = format(None);
-  curFmtRng.start = 0;
-  result.formats.append(curFmtRng);
-  int pos = 0; int length;
-  int fgCol = -1, bgCol = -1;  // marks current mIRC color
+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 = 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);
+  }
+  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_, 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, baseFormat));
+  quint32 curfmt = baseFormat;
+  int pos = 0; quint16 length = 0;
   for(;;) {
     pos = s.indexOf('%', pos);
     if(pos < 0) break;
-    if(s[pos+1] == '%') { // escaped %, just remove one and continue
+    if(s[pos+1] == '%') { // escaped %, we just remove one and continue
       s.remove(pos, 1);
       pos++;
       continue;
-    } else if(s[pos+1] == 'D' && s[pos+2] == 'c') { // color code
-      if(s[pos+3] == '-') { // color off
-        if(fgCol >= 0) {
-          fmtList.removeAll((FormatType)(FgCol00 + fgCol));
-          fgCol = -1;
-        }
-        if(bgCol >= 0) {
-          fmtList.removeAll((FormatType)(BgCol00 + bgCol));
-          bgCol = -1;
-        }
-        curFmtRng.format = mergedFormat(fmtList);
+    }
+    if(s[pos+1] == 'D' && s[pos+2] == 'c') { // color code
+      if(s[pos+3] == '-') {  // color off
+        curfmt &= 0x003fffff;
         length = 4;
       } else {
         int color = 10 * s[pos+4].digitValue() + s[pos+5].digitValue();
-        int *colptr; FormatType coltype;
-        if(s[pos+3] == 'f') { // foreground
-          colptr = &fgCol; coltype = FgCol00;
-        } else {              // background
-          Q_ASSERT(s[pos+3] == 'b');
-          colptr = &bgCol; coltype = BgCol00;
-        }
-        if(*colptr >= 0) {
-          // color already set, remove format code and add new one
-          Q_ASSERT(fmtList.contains((FormatType)(coltype + *colptr)));
-          fmtList.removeAll((FormatType)(coltype + *colptr));
-          fmtList.append((FormatType)(coltype + color));
-          curFmtRng.format = mergedFormat(fmtList);
+        //TODO: use 99 as transparent color (re mirc color "standard")
+        color &= 0x0f;
+        if(s[pos+3] == 'f') {
+          curfmt &= 0xf0ffffff;
+          curfmt |= (color << 24) | 0x00400000;
         } else {
-          fmtList.append((FormatType)(coltype + color));
-          curFmtRng.format.merge(format(fmtList.last()));
+          curfmt &= 0x0fffffff;
+          curfmt |= (color << 28) | 0x00800000;
         }
-        *colptr = color;
         length = 6;
       }
     } else if(s[pos+1] == 'O') { // reset formatting
-      fmtList.clear(); fmtList.append(None);
-      curFmtRng.format = format(None);
-      fgCol = bgCol = -1;
+      curfmt &= 0x0000000f; // we keep message type-specific formatting
       length = 2;
     } else if(s[pos+1] == 'R') { // reverse
       // TODO: implement reverse formatting
@@ -190,46 +306,298 @@ UiStyle::StyledText UiStyle::styleString(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;
       }
-      //Q_ASSERT(ftype != Invalid);
+      curfmt ^= ftype;
       length = code.length();
-      if(!fmtList.contains(ftype)) {
-        // toggle it on
-        fmtList.append(ftype);
-        curFmtRng.format.merge(format(ftype));
-      } else {
-        // toggle it off
-        fmtList.removeAll(ftype);
-        curFmtRng.format = mergedFormat(fmtList);
-      }
     }
-    s.remove(pos, length); // remove format code from string
-    // now see if something changed and else insert the format
-    if(curFmtRng.format == result.formats.last().format) continue;  // no change, so we just ignore
-    curFmtRng.start = pos;
-    if(pos == result.formats.last().start) {
-      // same starting point -> we just overwrite the old format
-      result.formats.last() = curFmtRng;
+    s.remove(pos, length);
+    if(pos == result.formatList.last().first)
+      result.formatList.last().second = curfmt;
+    else
+      result.formatList.append(qMakePair((quint16)pos, curfmt));
+  }
+  result.plainText = s;
+  return result;
+}
+
+QString UiStyle::mircToInternal(const QString &mirc_) {
+  QString mirc = mirc_;
+  mirc.replace('%', "%%");      // escape % just to be sure
+  mirc.replace('\x02', "%B");
+  mirc.replace('\x0f', "%O");
+  mirc.replace('\x12', "%R");
+  mirc.replace('\x16', "%R");
+  mirc.replace('\x1d', "%S");
+  mirc.replace('\x1f', "%U");
+
+  // Now we bring the color codes (\x03) in a sane format that can be parsed more easily later.
+  // %Dcfxx is foreground, %Dcbxx is background color, where xx is a 2 digit dec number denoting the color code.
+  // %Dc- turns color off.
+  // Note: We use the "mirc standard" as described in <http://www.mirc.co.uk/help/color.txt>.
+  //       This means that we don't accept something like \x03,5 (even though others, like WeeChat, do).
+  int pos = 0;
+  for(;;) {
+    pos = mirc.indexOf('\x03', pos);
+    if(pos < 0) break; // no more mirc color codes
+    QString ins, num;
+    int l = mirc.length();
+    int i = pos + 1;
+    // check for fg color
+    if(i < l && mirc[i].isDigit()) {
+      num = mirc[i++];
+      if(i < l && mirc[i].isDigit()) num.append(mirc[i++]);
+      else num.prepend('0');
+      ins = QString("%Dcf%1").arg(num);
+
+      if(i+1 < l && mirc[i] == ',' && mirc[i+1].isDigit()) {
+        i++;
+        num = mirc[i++];
+        if(i < l && mirc[i].isDigit()) num.append(mirc[i++]);
+        else num.prepend('0');
+        ins += QString("%Dcb%1").arg(num);
+      }
     } else {
-      // fix length of last format
-      result.formats.last().length = pos - result.formats.last().start;
-      result.formats.append(curFmtRng);
+      ins = "%Dc-";
     }
+    mirc.replace(pos, i-pos, ins);
   }
-  result.formats.last().length = s.length() - result.formats.last().start;
-  if(result.formats.last().length == 0) result.formats.removeLast();
-  result.text = s;
-  return result;
+  return mirc;
+}
+
+/***********************************************************************************/
+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
 }
 
-QTextCharFormat UiStyle::mergedFormat(QList<FormatType> formatList) {
-  QTextCharFormat fmt;
-  foreach(FormatType ftype, formatList) {
-    fmt.merge(format(ftype));
+void UiStyle::StyledMessage::style() const {
+  QString user = userFromMask(sender());
+  QString host = hostFromMask(sender());
+  QString nick = nickFromMask(sender());
+  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:
+      //: Plain Message
+      t = tr("%1").arg(txt); break;
+    case Message::Notice:
+      //: 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:
+      //: 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:
+      //: 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:
+      //: 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);
+        //: 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::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("[%1]").arg(txt);
   }
-  return fmt;
+  _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 {
+  return timestamp().toLocalTime().toString(UiStyle::timestampFormatString());
+}
+
+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;
+<<<<<<< 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:
+      return tr("<--"); break;
+    case Message::Quit:
+      return tr("<--"); break;
+    case Message::Kick:
+      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());
+  }
+}
+
+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)
+    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);
+}
+
+/***********************************************************************************/
+
+QDataStream &operator<<(QDataStream &out, const UiStyle::FormatList &formatList) {
+  out << formatList.count();
+  UiStyle::FormatList::const_iterator it = formatList.begin();
+  while(it != formatList.end()) {
+    out << (*it).first << (*it).second;
+    ++it;
+  }
+  return out;
+}
+
+QDataStream &operator>>(QDataStream &in, UiStyle::FormatList &formatList) {
+  quint16 cnt;
+  in >> cnt;
+  for(quint16 i = 0; i < cnt; i++) {
+    quint16 pos; quint32 ftype;
+    in >> pos >> ftype;
+    formatList.append(qMakePair((quint16)pos, ftype));
+  }
+  return in;
+}