uistyle: Add more type-safety to UiStyle, and clean up a bit
[quassel.git] / src / qtui / chatlinemodelitem.cpp
index 7d6e832..5582fe8 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-09 by the Quassel Project                          *
+ *   Copyright (C) 2005-2016 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -15,7 +15,7 @@
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
 #include <QFontMetrics>
 // This Struct is taken from Harfbuzz. We use it only to calc it's size.
 // we use a shared memory region so we do not have to malloc a buffer area for every line
 typedef struct {
-    /*HB_LineBreakType*/ unsigned lineBreakType  :2;
-    /*HB_Bool*/ unsigned whiteSpace              :1;     /* A unicode whitespace character, except NBSP, ZWNBSP */
-    /*HB_Bool*/ unsigned charStop                :1;     /* Valid cursor position (for left/right arrow) */
-    /*HB_Bool*/ unsigned wordBoundary            :1;
-    /*HB_Bool*/ unsigned sentenceBoundary        :1;
-    unsigned unused                  :2;
+    /*HB_LineBreakType*/ unsigned lineBreakType  : 2;
+    /*HB_Bool*/ unsigned whiteSpace              : 1;     /* A unicode whitespace character, except NBSP, ZWNBSP */
+    /*HB_Bool*/ unsigned charStop                : 1;     /* Valid cursor position (for left/right arrow) */
+    /*HB_Bool*/ unsigned wordBoundary            : 1;
+    /*HB_Bool*/ unsigned sentenceBoundary        : 1;
+    unsigned unused                  : 2;
 } HB_CharAttributes_Dummy;
 
-// PRIVATE DATA FOR CHATLINE MODEL ITEM
-class ChatLineModelItemPrivate {
+unsigned char *ChatLineModelItem::TextBoundaryFinderBuffer = (unsigned char *)malloc(512 * sizeof(HB_CharAttributes_Dummy));
+int ChatLineModelItem::TextBoundaryFinderBufferSize = 512 * (sizeof(HB_CharAttributes_Dummy) / sizeof(unsigned char));
 
-public:
-  inline ChatLineModelItemPrivate(const Message &msg);
-  ~ChatLineModelItemPrivate();
-
-  inline bool needsStyling();
-  QVariant data(MessageModel::ColumnType column, int role);
-
-private:
-  void style();
-  void computeWrapList();
-
-  ChatLineModel::WrapList _wrapList;
-  Message *_msgBuffer;
-  UiStyle::StyledMessage *_styledMsg;
+// ****************************************
+// the actual ChatLineModelItem
+// ****************************************
+ChatLineModelItem::ChatLineModelItem(const Message &msg)
+    : MessageModelItem(),
+    _styledMsg(msg)
+{
+    if (!msg.sender().contains('!'))
+        _styledMsg.setFlags(msg.flags() |= Message::ServerMsg);
 
-  static unsigned char *TextBoundaryFinderBuffer;
-  static int TextBoundaryFinderBufferSize;
-};
+    if (_styledMsg.type() == Message::Nick) {
+        // HACK: Work around nick changes on Quassel core not properly being set as Self
+        // While this is fixed in the core, old cores and past history will still show incorrectly.
+        if (nickFromMask(_styledMsg.sender()) == stripFormatCodes(_styledMsg.contents()).toLower()) {
+            _styledMsg.setFlags(msg.flags() |= Message::Self);
+        }
+    }
+    // Unfortunately, the missing Self flag for other message types can't easily be worked around.
+}
 
-ChatLineModelItemPrivate::ChatLineModelItemPrivate(const Message &msg)
-: _msgBuffer(new Message(msg)),
-  _styledMsg(0) {
 
+bool ChatLineModelItem::setData(int column, const QVariant &value, int role)
+{
+    switch (role) {
+    case MessageModel::FlagsRole:
+        _styledMsg.setFlags((Message::Flags)value.toUInt());
+        return true;
+    default:
+        return MessageModelItem::setData(column, value, role);
+    }
 }
 
-ChatLineModelItemPrivate::~ChatLineModelItemPrivate() {
-  if(_msgBuffer) {
-    delete _msgBuffer;
-  } else {
-    delete _styledMsg;
-  }
-}
 
-bool ChatLineModelItemPrivate::needsStyling() {
-  return (bool)_msgBuffer;
-}
+QVariant ChatLineModelItem::data(int column, int role) const
+{
+    if (role == ChatLineModel::MsgLabelRole)
+        return QVariant::fromValue<UiStyle::MessageLabel>(messageLabel());
 
-QVariant ChatLineModelItemPrivate::data(MessageModel::ColumnType column, int role) {
-  if(needsStyling())
-    style();
-  switch(column) {
+    QVariant variant;
+    MessageModel::ColumnType col = (MessageModel::ColumnType)column;
+    switch (col) {
     case ChatLineModel::TimestampColumn:
-      switch(role) {
-        case ChatLineModel::DisplayRole:
-          return _styledMsg->decoratedTimestamp();
-        case ChatLineModel::EditRole:
-          return _styledMsg->timestamp();
-        case ChatLineModel::FormatRole:
-          return QVariant::fromValue<UiStyle::FormatList>(UiStyle::FormatList()
-                                    << qMakePair((quint16)0, (quint32)_styledMsg->timestampFormat()));
-      }
-      break;
+        variant = timestampData(role);
+        break;
     case ChatLineModel::SenderColumn:
-      switch(role) {
-        case ChatLineModel::DisplayRole:
-          return _styledMsg->decoratedSender();
-        case ChatLineModel::EditRole:
-          return _styledMsg->sender();
-        case ChatLineModel::FormatRole:
-          return QVariant::fromValue<UiStyle::FormatList>(UiStyle::FormatList()
-                                    << qMakePair((quint16)0, (quint32)_styledMsg->senderFormat()));
-      }
-      break;
+        variant = senderData(role);
+        break;
     case ChatLineModel::ContentsColumn:
-      switch(role) {
-        case ChatLineModel::DisplayRole:
-        case ChatLineModel::EditRole:
-          return _styledMsg->contents();
-        case ChatLineModel::FormatRole:
-          return QVariant::fromValue<UiStyle::FormatList>(_styledMsg->contentsFormatList());
-        case ChatLineModel::WrapListRole:
-          if(_wrapList.isEmpty())
-            computeWrapList();
-          return QVariant::fromValue<ChatLineModel::WrapList>(_wrapList);
-      }
-      break;
+        variant = contentsData(role);
+        break;
     default:
-      Q_ASSERT(false);
-      return 0;
-  }
-  return QVariant();
+        break;
+    }
+    if (!variant.isValid())
+        return MessageModelItem::data(column, role);
+    return variant;
 }
 
-void ChatLineModelItemPrivate::style() {
-  _styledMsg = new QtUiStyle::StyledMessage(QtUi::style()->styleMessage(*_msgBuffer));
-  delete _msgBuffer;
-  _msgBuffer = 0;
-}
 
-void ChatLineModelItemPrivate::computeWrapList() {
-  int length = _styledMsg->contents().length();
-  if(!length)
-    return;
-
-  enum Mode { SearchStart, SearchEnd };
-
-  QList<ChatLineModel::Word> wplist;  // use a temp list which we'll later copy into a QVector for efficiency
-  QTextBoundaryFinder finder(QTextBoundaryFinder::Word, _styledMsg->contents().unicode(), length,
-                              TextBoundaryFinderBuffer, TextBoundaryFinderBufferSize);
-
-  int idx;
-  int oldidx = 0;
-  bool wordStart = false;
-  bool wordEnd = false;
-  Mode mode = SearchEnd;
-  ChatLineModel::Word word;
-  word.start = 0;
-  qreal wordstartx = 0;
-
-  QTextLayout layout(_styledMsg->contents());
-  QTextOption option;
-  option.setWrapMode(QTextOption::NoWrap);
-  layout.setTextOption(option);
-
-  layout.setAdditionalFormats(QtUi::style()->toTextLayoutList(_styledMsg->contentsFormatList(), length));
-  layout.beginLayout();
-  QTextLine line = layout.createLine();
-  line.setNumColumns(length);
-  layout.endLayout();
-
-  do {
-    idx = finder.toNextBoundary();
-    if(idx < 0) {
-      idx = length;
-      wordStart = false;
-      wordEnd = false;
-      mode = SearchStart;
-    } else {
-      wordStart = finder.boundaryReasons().testFlag(QTextBoundaryFinder::StartWord);
-      wordEnd = finder.boundaryReasons().testFlag(QTextBoundaryFinder::EndWord);
+QVariant ChatLineModelItem::timestampData(int role) const
+{
+    switch (role) {
+    case ChatLineModel::DisplayRole:
+        return _styledMsg.decoratedTimestamp();
+    case ChatLineModel::EditRole:
+        return _styledMsg.timestamp();
+    case ChatLineModel::BackgroundRole:
+        return backgroundBrush(UiStyle::FormatType::Timestamp);
+    case ChatLineModel::SelectedBackgroundRole:
+        return backgroundBrush(UiStyle::FormatType::Timestamp, true);
+    case ChatLineModel::FormatRole:
+        return QVariant::fromValue<UiStyle::FormatList>({std::make_pair(quint16{0}, UiStyle::Format{UiStyle::formatType(_styledMsg.type()) | UiStyle::FormatType::Timestamp})});
     }
+    return QVariant();
+}
 
-    //if(flg) qDebug() << idx << mode << wordStart << wordEnd << contents->plainText.left(idx) << contents->plainText.mid(idx);
 
-    if(mode == SearchEnd || (!wordStart && wordEnd)) {
-      if(wordStart || !wordEnd) continue;
-      oldidx = idx;
-      mode = SearchStart;
-      continue;
+QVariant ChatLineModelItem::senderData(int role) const
+{
+    switch (role) {
+    case ChatLineModel::DisplayRole:
+        return _styledMsg.decoratedSender();
+    case ChatLineModel::EditRole:
+        return _styledMsg.plainSender();
+    case ChatLineModel::BackgroundRole:
+        return backgroundBrush(UiStyle::FormatType::Sender);
+    case ChatLineModel::SelectedBackgroundRole:
+        return backgroundBrush(UiStyle::FormatType::Sender, true);
+    case ChatLineModel::FormatRole:
+        return QVariant::fromValue<UiStyle::FormatList>({std::make_pair(quint16{0}, UiStyle::Format{UiStyle::formatType(_styledMsg.type()) | UiStyle::FormatType::Sender})});
     }
-    qreal wordendx = line.cursorToX(oldidx);
-    qreal trailingendx = line.cursorToX(idx);
-    word.endX = wordendx;
-    word.width = wordendx - wordstartx;
-    word.trailing = trailingendx - wordendx;
-    wordstartx = trailingendx;
-    wplist.append(word);
-
-    if(wordStart) {
-      word.start = idx;
-      mode = SearchEnd;
+    return QVariant();
+}
+
+
+QVariant ChatLineModelItem::contentsData(int role) const
+{
+    switch (role) {
+    case ChatLineModel::DisplayRole:
+    case ChatLineModel::EditRole:
+        return _styledMsg.plainContents();
+    case ChatLineModel::BackgroundRole:
+        return backgroundBrush(UiStyle::FormatType::Contents);
+    case ChatLineModel::SelectedBackgroundRole:
+        return backgroundBrush(UiStyle::FormatType::Contents, true);
+    case ChatLineModel::FormatRole:
+        return QVariant::fromValue<UiStyle::FormatList>(_styledMsg.contentsFormatList());
+    case ChatLineModel::WrapListRole:
+        if (_wrapList.isEmpty())
+            computeWrapList();
+        return QVariant::fromValue<ChatLineModel::WrapList>(_wrapList);
     }
-    // the part " || (finder.position() == contents->plainText.length())" shouldn't be necessary
-    // but in rare and indeterministic cases Qt states that the end of the text is not a boundary o_O
-  } while(finder.isAtBoundary() || (finder.position() == length));
-
-  // A QVector needs less space than a QList
-  _wrapList.resize(wplist.count());
-  for(int i = 0; i < wplist.count(); i++) {
-    _wrapList[i] = wplist.at(i);
-  }
+    return QVariant();
 }
 
-unsigned char *ChatLineModelItemPrivate::TextBoundaryFinderBuffer = (unsigned char *)malloc(512 * sizeof(HB_CharAttributes_Dummy));
-int ChatLineModelItemPrivate::TextBoundaryFinderBufferSize = 512 * (sizeof(HB_CharAttributes_Dummy) / sizeof(unsigned char));
 
-// ****************************************
-// the actual ChatLineModelItem
-// ****************************************
-ChatLineModelItem::ChatLineModelItem(const Message &msg)
-  : MessageModelItem(msg),
-    _data(new ChatLineModelItemPrivate(msg))
+UiStyle::MessageLabel ChatLineModelItem::messageLabel() const
 {
+    using MessageLabel = UiStyle::MessageLabel;
+
+    MessageLabel label = static_cast<MessageLabel>(_styledMsg.senderHash() << 16);
+    if (_styledMsg.flags() & Message::Self)
+        label |= MessageLabel::OwnMsg;
+    if (_styledMsg.flags() & Message::Highlight)
+        label |= MessageLabel::Highlight;
+    return label;
 }
 
-ChatLineModelItem::~ChatLineModelItem() {
-  delete _data;
+
+QVariant ChatLineModelItem::backgroundBrush(UiStyle::FormatType subelement, bool selected) const
+{
+    QTextCharFormat fmt = QtUi::style()->format(UiStyle::formatType(_styledMsg.type()) | subelement,
+                                                messageLabel() | (selected ? UiStyle::MessageLabel::Selected : UiStyle::MessageLabel::None));
+    if (fmt.hasProperty(QTextFormat::BackgroundBrush))
+        return QVariant::fromValue<QBrush>(fmt.background());
+    return QVariant();
 }
 
-QVariant ChatLineModelItem::data(int column, int role) const {
-  QVariant d = _data->data((MessageModel::ColumnType)column, role);
-  if(!d.isValid()) return MessageModelItem::data(column, role);
-  return d;
+
+void ChatLineModelItem::computeWrapList() const
+{
+    QString text = _styledMsg.plainContents();
+    int length = text.length();
+    if (!length)
+        return;
+
+    QList<ChatLineModel::Word> wplist; // use a temp list which we'll later copy into a QVector for efficiency
+    QTextBoundaryFinder finder(QTextBoundaryFinder::Line, _styledMsg.plainContents().unicode(), length,
+        TextBoundaryFinderBuffer, TextBoundaryFinderBufferSize);
+
+    int idx;
+    int oldidx = 0;
+    ChatLineModel::Word word;
+    word.start = 0;
+    qreal wordstartx = 0;
+
+    QTextLayout layout(_styledMsg.plainContents());
+    QTextOption option;
+    option.setWrapMode(QTextOption::NoWrap);
+    layout.setTextOption(option);
+
+    layout.setAdditionalFormats(QtUi::style()->toTextLayoutList(_styledMsg.contentsFormatList(), length, messageLabel()));
+    layout.beginLayout();
+    QTextLine line = layout.createLine();
+    line.setNumColumns(length);
+    layout.endLayout();
+
+    while ((idx = finder.toNextBoundary()) >= 0 && idx <= length) {
+        // QTextBoundaryFinder has inconsistent behavior in Qt version up to and including 4.6.3 (at least).
+        // It doesn't point to the position we should break, but to the character before that.
+        // Unfortunately Qt decided to fix this by changing the behavior of QTBF, so now we have to add a version
+        // check. At the time of this writing, I'm still trying to get this reverted upstream...
+        //
+        // cf. https://bugs.webkit.org/show_bug.cgi?id=31076 and Qt commit e6ac173
+        static int needWorkaround = -1;
+        if (needWorkaround < 0) {
+            needWorkaround = 0;
+            QStringList versions = QString(qVersion()).split('.');
+            if (versions.count() == 3 && versions.at(0).toInt() == 4) {
+                if (versions.at(1).toInt() <= 6 && versions.at(2).toInt() <= 3)
+                    needWorkaround = 1;
+            }
+        }
+        if (needWorkaround == 1) {
+            if (idx < length)
+                idx++;
+        }
+
+        if (idx == oldidx)
+            continue;
+
+        word.start = oldidx;
+        int wordend = idx;
+        for (; wordend > word.start; wordend--) {
+            if (!text.at(wordend-1).isSpace())
+                break;
+        }
+
+        qreal wordendx = line.cursorToX(wordend);
+        qreal trailingendx = line.cursorToX(idx);
+        word.endX = wordendx;
+        word.width = wordendx - wordstartx;
+        word.trailing = trailingendx - wordendx;
+        wordstartx = trailingendx;
+        wplist.append(word);
+
+        oldidx = idx;
+    }
+
+    // A QVector needs less space than a QList
+    _wrapList.resize(wplist.count());
+    for (int i = 0; i < wplist.count(); i++) {
+        _wrapList[i] = wplist.at(i);
+    }
 }