Sanitize topic message
[quassel.git] / src / qtui / chatitem.h
index ddbffdb..0bf8ee2 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-08 by the Quassel Project                          *
+ *   Copyright (C) 2005-2013 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.         *
  ***************************************************************************/
 
 #ifndef CHATITEM_H_
 #define CHATITEM_H_
 
-#include <QGraphicsItem>
+#include <QAction>
 #include <QObject>
 
-#include "chatline.h"
 #include "chatlinemodel.h"
 #include "chatscene.h"
+#include "clickable.h"
 #include "uistyle.h"
+#include "qtui.h"
 
-class QTextLayout;
+#include <QTextLayout>
 
-class ChatItem : public QGraphicsItem {
+class ChatLine;
+class ChatView;
 
-  public:
-    ChatItem(const QPersistentModelIndex &index, QGraphicsItem *parent);
+/* All external positions are relative to the parent ChatLine */
+/* Yes, that's also true for the boundingRect() and related things */
+
+class ChatItem
+{
+protected:
+    // boundingRect is relative to the parent ChatLine
+    ChatItem(const QRectF &boundingRect, ChatLine *parent);
     virtual ~ChatItem();
 
-    inline QPersistentModelIndex index() const { return _index; }
-    inline const MessageModel *model() const { return _index.isValid() ? qobject_cast<const MessageModel *>(_index.model()) : 0; }
-    inline int row() const { return _index.isValid() ? _index.row() : 0; }
-    inline ChatScene *chatScene() const { return qobject_cast<ChatScene *>(scene()); }
+public:
+    const QAbstractItemModel *model() const;
+    ChatLine *chatLine() const;
+    ChatScene *chatScene() const;
+    ChatView *chatView() const;
+    int row() const;
+    virtual ChatLineModel::ColumnType column() const = 0;
 
-    inline QFontMetricsF *fontMetrics() const { return _fontMetrics; }
-    inline virtual QRectF boundingRect() const { return _boundingRect; }
-    inline qreal width() const { return _boundingRect.width(); }
-    inline qreal height() const { return _boundingRect.height(); }
+    // The boundingRect() is relative to the parent ChatLine
+    inline QRectF boundingRect() const;
+    inline qreal width() const;
+    inline qreal height() const;
+    inline QPointF pos() const;
+    inline qreal x() const;
+    inline qreal y() const;
 
-    inline bool haveLayout() const { return _layout != 0; }
-    void clearLayout();
-    void updateLayout();
-    virtual void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0);
+    QPointF mapToLine(const QPointF &) const;
+    QPointF mapFromLine(const QPointF &) const;
+    QPointF mapToScene(const QPointF &) const;
+    QPointF mapFromScene(const QPointF &) const;
 
-    virtual QVariant data(int role) const;
+    virtual void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0);
+    virtual inline int type() const { return ChatScene::ChatItemType; }
 
-    // returns height
-    qreal setWidth(qreal width);
+    QVariant data(int role) const;
 
     // selection stuff, to be called by the scene
+    QString selection() const;
     void clearSelection();
     void setFullSelection();
     void continueSelecting(const QPointF &pos);
+    bool hasSelection() const;
+    bool isPosOverSelection(const QPointF &pos) const;
+
+    QList<QRectF> findWords(const QString &searchWord, Qt::CaseSensitivity caseSensitive);
+
+    virtual void addActionsToMenu(QMenu *menu, const QPointF &itemPos);
+    virtual void handleClick(const QPointF &pos, ChatScene::ClickMode);
+
+    void initLayoutHelper(QTextLayout *layout, QTextOption::WrapMode, Qt::Alignment = Qt::AlignLeft) const;
+
+    //! Remove internally cached data
+    /** This removes e.g. the cached QTextLayout to avoid wasting space for nonvisible ChatLines
+     */
+    virtual void clearCache();
+
+protected:
+    enum SelectionMode {
+        NoSelection,
+        PartialSelection,
+        FullSelection
+    };
 
-  protected:
     virtual void mouseMoveEvent(QGraphicsSceneMouseEvent *event);
     virtual void mousePressEvent(QGraphicsSceneMouseEvent *event);
     virtual void mouseReleaseEvent(QGraphicsSceneMouseEvent *event);
+    virtual void hoverEnterEvent(QGraphicsSceneHoverEvent *) {}
+    virtual void hoverLeaveEvent(QGraphicsSceneHoverEvent *) {}
+    virtual void hoverMoveEvent(QGraphicsSceneHoverEvent *) {}
 
-    virtual void hoverEnterEvent(QGraphicsSceneHoverEvent *event);
-    virtual void hoverLeaveEvent(QGraphicsSceneHoverEvent *event);
-    virtual void hoverMoveEvent(QGraphicsSceneHoverEvent *event);
+    QTextLayout *layout() const;
 
-  private:
-    qint16 posToCursor(const QPointF &pos);
-    qreal computeHeight();
-    QTextLayout *createLayout(QTextOption::WrapMode, Qt::Alignment = Qt::AlignLeft);
+    virtual void initLayout(QTextLayout *layout) const;
+    virtual void doLayout(QTextLayout *) const;
+    virtual UiStyle::FormatList formatList() const;
 
-    // internal selection stuff
-    void setSelection(int start, int length);
+    void paintBackground(QPainter *);
+    QVector<QTextLayout::FormatRange> selectionFormats() const;
+    virtual QVector<QTextLayout::FormatRange> additionalFormats() const;
+    void overlayFormat(UiStyle::FormatList &fmtList, int start, int end, quint32 overlayFmt) const;
 
-    QRectF _boundingRect;
-    QFontMetricsF *_fontMetrics;
-    quint8 _lines;
-    QPersistentModelIndex _index;
+    inline qint16 selectionStart() const { return _selectionStart; }
+    inline void setSelectionStart(qint16 start) { _selectionStart = start; }
+    inline qint16 selectionEnd() const { return _selectionEnd; }
+    inline void setSelectionEnd(qint16 end) { _selectionEnd = end; }
+    inline SelectionMode selectionMode() const { return _selectionMode; }
+    inline void setSelectionMode(SelectionMode mode) { _selectionMode = mode; }
+    void setSelection(SelectionMode mode, qint16 selectionStart, qint16 selectionEnd);
+
+    qint16 posToCursor(const QPointF &pos) const;
 
-    QTextLayout * _layout;
-    QList<quint16> _wrapPositions;
+    inline void setGeometry(qreal width, qreal height) { clearCache(); _boundingRect.setSize(QSizeF(width, height)); }
+    inline void setHeight(const qreal &height) { clearCache(); _boundingRect.setHeight(height); }
+    inline void setWidth(const qreal &width) { clearCache(); _boundingRect.setWidth(width); }
+    inline void setPos(const QPointF &pos) { _boundingRect.moveTopLeft(pos); }
+
+private:
+    ChatLine *_parent;
+    QRectF _boundingRect;
 
-    enum SelectionMode { NoSelection, PartialSelection, FullSelection };
     SelectionMode _selectionMode;
     qint16 _selectionStart, _selectionEnd;
 
+    mutable QTextLayout *_cachedLayout;
+
+    // internal selection stuff
+    void setSelection(int start, int length);
+
+    friend class ChatLine;
+};
+
+
+// ************************************************************
+// TimestampChatItem
+// ************************************************************
+
+//! A ChatItem for the timestamp column
+class TimestampChatItem : public ChatItem
+{
+public:
+    TimestampChatItem(const QRectF &boundingRect, ChatLine *parent) : ChatItem(boundingRect, parent) {}
+    virtual inline int type() const { return ChatScene::TimestampChatItemType; }
+    virtual inline ChatLineModel::ColumnType column() const { return ChatLineModel::TimestampColumn; }
+};
+
+
+// ************************************************************
+// SenderChatItem
+// ************************************************************
+//! A ChatItem for the sender column
+class SenderChatItem : public ChatItem
+{
+public:
+    SenderChatItem(const QRectF &boundingRect, ChatLine *parent) : ChatItem(boundingRect, parent) {}
+    virtual inline ChatLineModel::ColumnType column() const { return ChatLineModel::SenderColumn; }
+    virtual void handleClick(const QPointF &pos, ChatScene::ClickMode clickMode);
+
+protected:
+    virtual void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0);
+    virtual inline int type() const { return ChatScene::SenderChatItemType; }
+    virtual void initLayout(QTextLayout *layout) const;
+};
+
+
+// ************************************************************
+// ContentsChatItem
+// ************************************************************
+struct ContentsChatItemPrivate;
+
+//! A ChatItem for the contents column
+class ContentsChatItem : public ChatItem
+{
+    Q_DECLARE_TR_FUNCTIONS(ContentsChatItem)
+
+public:
+    ContentsChatItem(const QPointF &pos, const qreal &width, ChatLine *parent);
+    ~ContentsChatItem();
+
+    virtual inline int type() const { return ChatScene::ContentsChatItemType; }
+
+    inline ChatLineModel::ColumnType column() const { return ChatLineModel::ContentsColumn; }
+    QFontMetricsF *fontMetrics() const;
+
+    virtual void clearCache();
+
+protected:
+    virtual void mouseMoveEvent(QGraphicsSceneMouseEvent *event);
+    virtual void hoverLeaveEvent(QGraphicsSceneHoverEvent *event);
+    virtual void hoverMoveEvent(QGraphicsSceneHoverEvent *event);
+    virtual void handleClick(const QPointF &pos, ChatScene::ClickMode clickMode);
+
+    virtual void addActionsToMenu(QMenu *menu, const QPointF &itemPos);
+    virtual void copyLinkToClipboard();
+
+    virtual QVector<QTextLayout::FormatRange> additionalFormats() const;
+
+    virtual void initLayout(QTextLayout *layout) const;
+    virtual void doLayout(QTextLayout *layout) const;
+    virtual UiStyle::FormatList formatList() const;
+
+private:
+    class ActionProxy;
     class WrapColumnFinder;
+
+    mutable ContentsChatItemPrivate *_data;
+    ContentsChatItemPrivate *privateData() const;
+
+    Clickable clickableAt(const QPointF &pos) const;
+
+    void endHoverMode();
+    void showWebPreview(const Clickable &click);
+    void clearWebPreview();
+
+    qreal setGeometryByWidth(qreal w);
+
+    QFontMetricsF *_fontMetrics;
+
+    // we need a receiver for Action signals
+    static ActionProxy _actionProxy;
+
+    friend class ChatLine;
+    friend struct ContentsChatItemPrivate;
+};
+
+
+struct ContentsChatItemPrivate {
+    ContentsChatItem *contentsItem;
+    ClickableList clickables;
+    Clickable currentClickable;
+    Clickable activeClickable;
+
+    ContentsChatItemPrivate(const ClickableList &c, ContentsChatItem *parent) : contentsItem(parent), clickables(c) {}
 };
 
-class ChatItem::WrapColumnFinder {
-  public:
-    WrapColumnFinder(ChatItem *parent);
+class ContentsChatItem::WrapColumnFinder
+{
+public:
+    WrapColumnFinder(const ChatItem *parent);
     ~WrapColumnFinder();
 
-    qint16 nextWrapColumn();
+    qint16 nextWrapColumn(qreal width);
 
-  private:
-    ChatItem *item;
-    QTextLayout *layout;
+private:
+    const ChatItem *item;
+    QTextLayout layout;
     QTextLine line;
     ChatLineModel::WrapList wrapList;
     qint16 wordidx;
-    qint16 lastwrapcol;
-    qreal lastwrappos;
-    qreal w;
+    qint16 lineCount;
+    qreal choppedTrailing;
+};
+
+
+//! Acts as a proxy for Action signals targetted at a ContentsChatItem
+/** Since a ChatItem is not a QObject, hence cannot receive signals, we use a static ActionProxy
+ *  as a receiver instead. This avoids having to handle ChatItem actions (e.g. context menu entries)
+ *  outside the ChatItem.
+ */
+class ContentsChatItem::ActionProxy : public QObject
+{
+    Q_OBJECT
+
+public slots:
+    inline void copyLinkToClipboard() { item()->copyLinkToClipboard(); }
+
+private:
+    /// Returns the ContentsChatItem that should receive the action event.
+    /** For efficiency reasons, values are not checked for validity. You gotta make sure that you set the data() member
+     *  in the Action correctly.
+     *  @return The ChatItem from which the sending Action originated
+     */
+    inline ContentsChatItem *item() const
+    {
+        return static_cast<ContentsChatItem *>(qobject_cast<QAction *>(sender())->data().value<void *>());
+    }
 };
 
+
+/*************************************************************************************************/
+
+// Inlines
+
+QRectF ChatItem::boundingRect() const { return _boundingRect; }
+qreal ChatItem::width() const { return _boundingRect.width(); }
+qreal ChatItem::height() const { return _boundingRect.height(); }
+QPointF ChatItem::pos() const { return _boundingRect.topLeft(); }
+qreal ChatItem::x() const { return pos().x(); }
+qreal ChatItem::y() const { return pos().y(); }
+
 #endif