Sanitize topic message
[quassel.git] / src / qtui / chatitem.h
index b8b6e14..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 "chatlinemodel.h"
 #include "chatscene.h"
+#include "clickable.h"
 #include "uistyle.h"
 #include "qtui.h"
 
-class QTextLayout;
-struct ChatItemPrivate;
+#include <QTextLayout>
 
-class ChatItem : public QGraphicsItem {
-protected:
-  ChatItem(const qreal &width, const qreal &height, const QPointF &pos, QGraphicsItem *parent);
-  virtual ~ChatItem();
-
-public:
-  inline const QAbstractItemModel *model() const;
-  inline int row() const;
-  virtual ChatLineModel::ColumnType column() const = 0;
-  inline ChatScene *chatScene() const { return qobject_cast<ChatScene *>(scene()); }
-
-  inline QRectF boundingRect() const { return _boundingRect; }
-  inline qreal width() const { return _boundingRect.width(); }
-  inline qreal height() const { return _boundingRect.height(); }
-
-  inline bool hasLayout() const { return (bool)_data; }
-  QTextLayout *createLayout(QTextOption::WrapMode, Qt::Alignment = Qt::AlignLeft);
-  virtual inline QTextLayout *createLayout() { return createLayout(QTextOption::WrapAnywhere); }
-  virtual void updateLayout();
-  void clearLayout();
-
-  virtual void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0);
-
-  QVariant data(int role) const;
-
-  // selection stuff, to be called by the scene
-  void clearSelection();
-  void setFullSelection();
-  void continueSelecting(const QPointF &pos);
+class ChatLine;
+class ChatView;
 
-  QList<QRectF> findWords(const QString &searchWord, Qt::CaseSensitivity caseSensitive);
+/* All external positions are relative to the parent ChatLine */
+/* Yes, that's also true for the boundingRect() and related things */
 
+class ChatItem
+{
 protected:
-  virtual void mouseMoveEvent(QGraphicsSceneMouseEvent *event);
-  virtual void mousePressEvent(QGraphicsSceneMouseEvent *event);
-  virtual void mouseReleaseEvent(QGraphicsSceneMouseEvent *event);
+    // boundingRect is relative to the parent ChatLine
+    ChatItem(const QRectF &boundingRect, ChatLine *parent);
+    virtual ~ChatItem();
 
-  inline QTextLayout *layout() const;
-
-  virtual inline QVector<QTextLayout::FormatRange> additionalFormats() const { return QVector<QTextLayout::FormatRange>(); }
-  qint16 posToCursor(const QPointF &pos);
-
-  inline void setPrivateData(ChatItemPrivate *data) { Q_ASSERT(!_data); _data = data; }
-  inline ChatItemPrivate *privateData() const;
+public:
+    const QAbstractItemModel *model() const;
+    ChatLine *chatLine() const;
+    ChatScene *chatScene() const;
+    ChatView *chatView() const;
+    int row() const;
+    virtual ChatLineModel::ColumnType column() const = 0;
+
+    // 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;
+
+    QPointF mapToLine(const QPointF &) const;
+    QPointF mapFromLine(const QPointF &) const;
+    QPointF mapToScene(const QPointF &) const;
+    QPointF mapFromScene(const QPointF &) const;
+
+    virtual void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0);
+    virtual inline int type() const { return ChatScene::ChatItemType; }
+
+    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();
 
-  // WARNING: setGeometry and setHeight should not be used without either:
-  //  a) calling prepareGeometryChange() immediately before setColumns()
-  //  b) calling Chatline::setPos() immediately afterwards
-  inline void setGeometry(qreal width, qreal height) {
-    _boundingRect.setWidth(width);
-    _boundingRect.setHeight(height);
-  }
-  inline void setHeight(const qreal &height) { _boundingRect.setHeight(height); }
-  inline void setWidth(const qreal &width) { _boundingRect.setWidth(width); }
+protected:
+    enum SelectionMode {
+        NoSelection,
+        PartialSelection,
+        FullSelection
+    };
+
+    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 *) {}
+
+    QTextLayout *layout() const;
+
+    virtual void initLayout(QTextLayout *layout) const;
+    virtual void doLayout(QTextLayout *) const;
+    virtual UiStyle::FormatList formatList() const;
+
+    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;
+
+    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;
+
+    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:
-  // internal selection stuff
-  void setSelection(int start, int length);
+    ChatLine *_parent;
+    QRectF _boundingRect;
 
-  ChatItemPrivate *_data;
-  QRectF _boundingRect;
+    SelectionMode _selectionMode;
+    qint16 _selectionStart, _selectionEnd;
 
-  enum SelectionMode { NoSelection, PartialSelection, FullSelection };
-  SelectionMode _selectionMode;
-  qint16 _selectionStart, _selectionEnd;
+    mutable QTextLayout *_cachedLayout;
 
-  friend class ChatLine;
-};
+    // internal selection stuff
+    void setSelection(int start, int length);
 
-struct ChatItemPrivate {
-  QTextLayout *layout;
-  ChatItemPrivate(QTextLayout *l) : layout(l) {}
-  ~ChatItemPrivate() {
-    delete layout;
-  }
+    friend class ChatLine;
 };
 
-// inlines of ChatItem
-QTextLayout *ChatItem::layout() const { return privateData()->layout; }
-ChatItemPrivate *ChatItem::privateData() const { return _data; }
 
 // ************************************************************
 // TimestampChatItem
 // ************************************************************
 
 //! A ChatItem for the timestamp column
-class TimestampChatItem : public ChatItem {
+class TimestampChatItem : public ChatItem
+{
 public:
-  TimestampChatItem(const qreal &width, const qreal &height, QGraphicsItem *parent) : ChatItem(width, height, QPointF(0, 0), parent) {}
-  virtual inline ChatLineModel::ColumnType column() const { return ChatLineModel::TimestampColumn; }
+    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 {
+class SenderChatItem : public ChatItem
+{
 public:
-  SenderChatItem(const qreal &width, const qreal &height, const QPointF &pos, QGraphicsItem *parent) : ChatItem(width, height, pos, parent) {}
-  virtual inline ChatLineModel::ColumnType column() const { return ChatLineModel::SenderColumn; }
-  virtual inline QTextLayout *createLayout() { return ChatItem::createLayout(QTextOption::WrapAnywhere, Qt::AlignRight); }
+    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 {
+class ContentsChatItem : public ChatItem
+{
+    Q_DECLARE_TR_FUNCTIONS(ContentsChatItem)
+
 public:
-  ContentsChatItem(const qreal &width, const QPointF &pos, QGraphicsItem *parent);
+    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;
 
-  inline ChatLineModel::ColumnType column() const { return ChatLineModel::ContentsColumn; }
-  inline QFontMetricsF *fontMetrics() const { return _fontMetrics; }
+    virtual void clearCache();
 
 protected:
-  virtual void mouseMoveEvent(QGraphicsSceneMouseEvent *event);
-  virtual void mousePressEvent(QGraphicsSceneMouseEvent *event);
-  virtual void mouseReleaseEvent(QGraphicsSceneMouseEvent *event);
-  virtual void hoverLeaveEvent(QGraphicsSceneHoverEvent *event);
-  virtual void hoverMoveEvent(QGraphicsSceneHoverEvent *event);
+    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 QVector<QTextLayout::FormatRange> additionalFormats() const;
+    virtual void addActionsToMenu(QMenu *menu, const QPointF &itemPos);
+    virtual void copyLinkToClipboard();
 
-  virtual void updateLayout();
+    virtual QVector<QTextLayout::FormatRange> additionalFormats() const;
+
+    virtual void initLayout(QTextLayout *layout) const;
+    virtual void doLayout(QTextLayout *layout) const;
+    virtual UiStyle::FormatList formatList() const;
 
 private:
-  struct Clickable;
-  class WrapColumnFinder;
+    class ActionProxy;
+    class WrapColumnFinder;
 
-  inline ContentsChatItemPrivate *privateData() const;
+    mutable ContentsChatItemPrivate *_data;
+    ContentsChatItemPrivate *privateData() const;
 
-  QList<Clickable> findClickables();
-  void endHoverMode();
-  void showWebPreview(const Clickable &click);
-  void clearWebPreview();
+    Clickable clickableAt(const QPointF &pos) const;
 
+    void endHoverMode();
+    void showWebPreview(const Clickable &click);
+    void clearWebPreview();
 
-  // WARNING: setGeometry and setHeight should not be used without either:
-  //  a) calling prepareGeometryChange() immediately before setColumns()
-  //  b) calling Chatline::setPos() immediately afterwards
-  qreal setGeometryByWidth(qreal w);
-  friend class ChatLine;
-  friend struct ContentsChatItemPrivate;
+    qreal setGeometryByWidth(qreal w);
 
-  QFontMetricsF *_fontMetrics;
-};
+    QFontMetricsF *_fontMetrics;
 
-struct ContentsChatItem::Clickable {
-  // Don't change these enums without also changing the regexps in analyze()!
-  enum Type {
-    Invalid = -1,
-    Url = 0,
-    Channel = 1,
-    Nick = 2
-  };
-
-  Type type;
-  quint16 start;
-  quint16 length;
-
-  inline Clickable() : type(Invalid) {};
-  inline Clickable(Type type_, quint16 start_, quint16 length_) : type(type_), start(start_), length(length_) {};
-  inline bool isValid() const { return type != Invalid; }
+    // we need a receiver for Action signals
+    static ActionProxy _actionProxy;
+
+    friend class ChatLine;
+    friend struct ContentsChatItemPrivate;
 };
 
-struct ContentsChatItemPrivate : ChatItemPrivate {
-  ContentsChatItem *contentsItem;
-  QList<ContentsChatItem::Clickable> clickables;
-  ContentsChatItem::Clickable currentClickable;
-  bool hasDragged;
 
-  ContentsChatItemPrivate(QTextLayout *l, const QList<ContentsChatItem::Clickable> &c, ContentsChatItem *parent) : ChatItemPrivate(l), contentsItem(parent), clickables(c), hasDragged(false) {}
+struct ContentsChatItemPrivate {
+    ContentsChatItem *contentsItem;
+    ClickableList clickables;
+    Clickable currentClickable;
+    Clickable activeClickable;
+
+    ContentsChatItemPrivate(const ClickableList &c, ContentsChatItem *parent) : contentsItem(parent), clickables(c) {}
 };
 
+class ContentsChatItem::WrapColumnFinder
+{
+public:
+    WrapColumnFinder(const ChatItem *parent);
+    ~WrapColumnFinder();
 
-//inlines regarding ContentsChatItemPrivate
-ContentsChatItemPrivate *ContentsChatItem::privateData() const { return (ContentsChatItemPrivate *)ChatItem::privateData(); }
+    qint16 nextWrapColumn(qreal width);
 
-class ContentsChatItem::WrapColumnFinder {
-public:
-  WrapColumnFinder(ChatItem *parent);
-  ~WrapColumnFinder();
+private:
+    const ChatItem *item;
+    QTextLayout layout;
+    QTextLine line;
+    ChatLineModel::WrapList wrapList;
+    qint16 wordidx;
+    qint16 lineCount;
+    qreal choppedTrailing;
+};
 
-  qint16 nextWrapColumn();
+
+//! 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:
-  ChatItem *item;
-  QTextLayout *layout;
-  QTextLine line;
-  ChatLineModel::WrapList wrapList;
-  qint16 wordidx;
-  qint16 lineCount;
-  qreal choppedTrailing;
+    /// 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 *>());
+    }
 };
 
+
 /*************************************************************************************************/
 
-// Avoid circular include deps
-#include "chatline.h"
-const QAbstractItemModel *ChatItem::model() const { return static_cast<ChatLine *>(parentItem())->model(); }
-int ChatItem::row() const { return static_cast<ChatLine *>(parentItem())->row(); }
+// 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