Replace deprecated additionalFormats with formats
[quassel.git] / src / qtui / chatlinemodelitem.cpp
index 24e2273..9ebc126 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-08 by the Quassel Project                          *
+ *   Copyright (C) 2005-2019 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   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 "chatlinemodelitem.h"
+
 #include <QFontMetrics>
 #include <QTextBoundaryFinder>
 
-#include "chatlinemodelitem.h"
 #include "chatlinemodel.h"
 #include "qtui.h"
 #include "qtuistyle.h"
 
 // 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_CharAttributes_Dummy;
-
-// PRIVATE DATA FOR CHATLINE MODEL ITEM
-class ChatLineModelItemPrivate {
-  struct ChatLinePart {
-    QString plainText;
-    UiStyle::FormatList formatList;
-    inline ChatLinePart(const QString &pT, const UiStyle::FormatList &fL) : plainText(pT), formatList(fL) {}
-  };
-
-public:
-  inline ChatLineModelItemPrivate(const Message &msg) : _msgBuffer(new Message(msg)), timestamp(0), sender(0), contents(0) {}
-  inline ~ChatLineModelItemPrivate() {
-    if(_msgBuffer) {
-      delete _msgBuffer;
-    } else {
-      delete timestamp;
-      delete sender;
-      delete contents;
+using HB_CharAttributes_Dummy = 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;
+};
+
+unsigned char* ChatLineModelItem::TextBoundaryFinderBuffer = (unsigned char*)malloc(512 * sizeof(HB_CharAttributes_Dummy));
+int ChatLineModelItem::TextBoundaryFinderBufferSize = 512 * (sizeof(HB_CharAttributes_Dummy) / sizeof(unsigned char));
+
+// ****************************************
+// the actual ChatLineModelItem
+// ****************************************
+ChatLineModelItem::ChatLineModelItem(const Message& msg)
+    : MessageModelItem()
+    , _styledMsg(msg)
+{
+    if (!msg.sender().contains('!'))
+        _styledMsg.setFlags(msg.flags() |= Message::ServerMsg);
+
+    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.
+}
+
+bool ChatLineModelItem::setData(int column, const QVariant& value, int role)
+{
+    switch (role) {
+    case MessageModel::FlagsRole:
+        _styledMsg.setFlags((Message::Flags)value.toInt());
+        return true;
+    default:
+        return MessageModelItem::setData(column, value, role);
     }
-  }
+}
 
-  inline bool needsStyling() { return (bool)_msgBuffer; }
+QVariant ChatLineModelItem::data(int column, int role) const
+{
+    if (role == ChatLineModel::MsgLabelRole)
+        return QVariant::fromValue<UiStyle::MessageLabel>(messageLabel());
 
-  inline ChatLinePart *partByColumn(MessageModel::ColumnType column) {
-    switch(column) {
+    QVariant variant;
+    auto col = (MessageModel::ColumnType)column;
+    switch (col) {
     case ChatLineModel::TimestampColumn:
-      return timestamp;
+        variant = timestampData(role);
+        break;
     case ChatLineModel::SenderColumn:
-      return sender;
+        variant = senderData(role);
+        break;
     case ChatLineModel::ContentsColumn:
-      return contents;
+        variant = contentsData(role);
+        break;
     default:
-      Q_ASSERT(false);
-      return 0;
+        break;
+    }
+    if (!variant.isValid())
+        return MessageModelItem::data(column, role);
+    return variant;
+}
+
+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, {}, {}})});
     }
-  }
-
-  inline const QString &plainText(MessageModel::ColumnType column) {
-    if(needsStyling())
-      style();
-    return partByColumn(column)->plainText;
-  }
-
-  inline const UiStyle::FormatList &formatList(MessageModel::ColumnType column) {
-    if(needsStyling())
-      style();
-    return partByColumn(column)->formatList;
-  }
-
-  inline const ChatLineModel::WrapList &wrapList() {
-    if(needsStyling())
-      style();
-    if(_wrapList.isEmpty())
-      computeWrapList();
-    return _wrapList;
-  }
-
-private:
-  inline void style() {
-    QtUiStyle::StyledMessage m = QtUi::style()->styleMessage(*_msgBuffer);
-
-    timestamp = new ChatLinePart(m.timestamp.plainText, m.timestamp.formatList);
-    sender = new ChatLinePart(m.sender.plainText, m.sender.formatList);
-    contents = new ChatLinePart(m.contents.plainText, m.contents.formatList);
-
-    delete _msgBuffer;
-    _msgBuffer = 0;
-  }
-
-  inline void computeWrapList() {
-    if(contents->plainText.isEmpty())
-      return;
-
-    enum Mode { SearchStart, SearchEnd };
+    return QVariant();
+}
+
+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, {}, {}})});
+    }
+    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);
+    }
+    return QVariant();
+}
+
+UiStyle::MessageLabel ChatLineModelItem::messageLabel() const
+{
+    using MessageLabel = UiStyle::MessageLabel;
+
+    auto 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;
+}
+
+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();
+}
+
+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::Word, contents->plainText.unicode(), contents->plainText.length(), TextBoundaryFinderBuffer, TextBoundaryFinderBufferSize);
+    QTextBoundaryFinder finder(QTextBoundaryFinder::Line,
+                               _styledMsg.plainContents().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(contents->plainText);
+    QTextLayout layout(_styledMsg.plainContents());
     QTextOption option;
     option.setWrapMode(QTextOption::NoWrap);
     layout.setTextOption(option);
 
-    layout.setAdditionalFormats(QtUi::style()->toTextLayoutList(contents->formatList, contents->plainText.length()));
+    UiStyle::setTextLayoutFormats(layout, QtUi::style()->toTextLayoutList(_styledMsg.contentsFormatList(), length, messageLabel()));
     layout.beginLayout();
     QTextLine line = layout.createLine();
-    line.setNumColumns(contents->plainText.length());
+    line.setNumColumns(length);
     layout.endLayout();
 
-    do {
-      idx = finder.toNextBoundary();
-      if(idx < 0) {
-       idx = contents->plainText.length();
-       wordStart = false;
-       wordEnd = false;
-       mode = SearchStart;
-      } else {
-       wordStart = finder.boundaryReasons().testFlag(QTextBoundaryFinder::StartWord);
-       wordEnd = finder.boundaryReasons().testFlag(QTextBoundaryFinder::EndWord);
-      }
-
-      //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;
-      }
-      qreal wordendx = line.cursorToX(oldidx);
-      qreal trailingendx = line.cursorToX(idx);
-      word.width = wordendx - wordstartx;
-      word.trailing = trailingendx - wordendx;
-      wordstartx = trailingendx;
-      wplist.append(word);
-
-      if(wordStart) {
-       word.start = idx;
-       mode = SearchEnd;
-      }
-      // 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() == contents->plainText.length()));
+    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);
+    for (int i = 0; i < wplist.count(); i++) {
+        _wrapList[i] = wplist.at(i);
     }
-  }
-
-  ChatLineModel::WrapList _wrapList;
-  Message *_msgBuffer;
-  ChatLinePart *timestamp, *sender, *contents;
-
-  static unsigned char *TextBoundaryFinderBuffer;
-  static int TextBoundaryFinderBufferSize;
-};
-
-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))
-{
-}
-
-ChatLineModelItem::~ChatLineModelItem() {
-  delete _data;
 }
-
-QVariant ChatLineModelItem::data(int column, int role) const {
-  if(column < ChatLineModel::TimestampColumn || column > ChatLineModel::ContentsColumn)
-    return MessageModelItem::data(column, role);
-  MessageModel::ColumnType columnType = (MessageModel::ColumnType)column;
-
-  switch(role) {
-  case ChatLineModel::DisplayRole:
-    return _data->plainText(columnType);
-  case ChatLineModel::FormatRole:
-    return QVariant::fromValue<UiStyle::FormatList>(_data->formatList(columnType));
-  case ChatLineModel::WrapListRole:
-    if(columnType != ChatLineModel::ContentsColumn)
-      return QVariant();
-    return QVariant::fromValue<ChatLineModel::WrapList>(_data->wrapList());
-  }
-  return MessageModelItem::data(column, role);
-}
-