cmake: avoid de-duplication of user's CXXFLAGS
[quassel.git] / src / qtui / chatscene.h
index d950c72..03a3af1 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-2015 by the Quassel Project                        *
+ *   Copyright (C) 2005-2022 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -47,12 +47,14 @@ class ChatScene : public QGraphicsScene
     Q_OBJECT
 
 public:
-    enum CutoffMode {
+    enum CutoffMode
+    {
         CutoffLeft,
         CutoffRight
     };
 
-    enum ItemType {
+    enum ItemType
+    {
         ChatLineType = QGraphicsItem::UserType + 1,
         ChatItemType,
         TimestampChatItemType,
@@ -64,7 +66,8 @@ public:
         MarkerLineType
     };
 
-    enum ClickMode {
+    enum ClickMode
+    {
         NoClick,
         DragStartClick,
         SingleClick,
@@ -72,22 +75,21 @@ public:
         TripleClick
     };
 
-    ChatScene(QAbstractItemModel *model, const QString &idString, qreal width, ChatView *parent);
-    virtual ~ChatScene();
+    ChatScene(QAbstractItemModel* model, QString idString, qreal width, ChatView* parent);
 
-    inline QAbstractItemModel *model() const { return _model; }
-    inline MessageFilter *filter() const { return qobject_cast<MessageFilter *>(_model); }
+    inline QAbstractItemModelmodel() const { return _model; }
+    inline MessageFilter* filter() const { return qobject_cast<MessageFilter*>(_model); }
     inline QString idString() const { return _idString; }
 
     int rowByScenePos(qreal y) const;
-    inline int rowByScenePos(const QPointF &pos) const { return rowByScenePos(pos.y()); }
+    inline int rowByScenePos(const QPointFpos) const { return rowByScenePos(pos.y()); }
     ChatLineModel::ColumnType columnByScenePos(qreal x) const;
-    inline ChatLineModel::ColumnType columnByScenePos(const QPointF &pos) const { return columnByScenePos(pos.x()); }
+    inline ChatLineModel::ColumnType columnByScenePos(const QPointFpos) const { return columnByScenePos(pos.x()); }
 
-    ChatView *chatView() const;
-    ChatItem *chatItemAt(const QPointF &pos) const;
-    inline ChatLine *chatLine(int row) const { return (row < _lines.count()) ? _lines.value(row) : 0; }
-    inline ChatLine *chatLine(const QModelIndex &index) const { return _lines.value(index.row()); }
+    ChatViewchatView() const;
+    ChatItem* chatItemAt(const QPointF& pos) const;
+    inline ChatLinechatLine(int row) const { return (row < _lines.count()) ? _lines.value(row) : 0; }
+    inline ChatLine* chatLine(const QModelIndex& index) const { return _lines.value(index.row()); }
 
     //! Find the ChatLine belonging to a MsgId
     /** Searches for the ChatLine belonging to a MsgId. If there are more than one ChatLine with the same msgId,
@@ -100,28 +102,45 @@ public:
      *  \param ignoreDayChange Whether we ignore day change messages
      *  \return The ChatLine corresponding to the given MsgId
      */
-    ChatLine *chatLine(MsgId msgId, bool matchExact = true, bool ignoreDayChange = true) const;
+    ChatLinechatLine(MsgId msgId, bool matchExact = true, bool ignoreDayChange = true) const;
 
-    inline ChatLine *lastLine() const { return _lines.count() ? _lines.last() : 0; }
+    inline ChatLinelastLine() const { return _lines.count() ? _lines.last() : 0; }
 
-    inline MarkerLineItem *markerLine() const { return _markerLine; }
+    inline MarkerLineItemmarkerLine() const { return _markerLine; }
 
     inline bool isSingleBufferScene() const { return _singleBufferId.isValid(); }
     inline BufferId singleBufferId() const { return _singleBufferId; }
-    bool containsBuffer(const BufferId &id) const;
+    bool containsBuffer(const BufferIdid) const;
 
-    ColumnHandleItem *firstColumnHandle() const;
-    ColumnHandleItem *secondColumnHandle() const;
+    ColumnHandleItemfirstColumnHandle() const;
+    ColumnHandleItemsecondColumnHandle() const;
 
     inline CutoffMode senderCutoffMode() const { return _cutoffMode; }
     inline void setSenderCutoffMode(CutoffMode mode) { _cutoffMode = mode; }
 
+    /**
+     * Gets whether to re-add hidden brackets around sender for all message types
+     *
+     * Used within the Chat Monitor as the normal message prefixes are overridden.
+     *
+     * @return Whether to re-add hidden brackets around sender for all message types
+     */
+    inline bool alwaysBracketSender() const { return _alwaysBracketSender; }
+    /**
+     * Sets whether to re-add hidden brackets around sender for all message types
+     *
+     * @see ChatScene::alwaysBracketSender()
+     *
+     * @param brackets Sets whether to re-add hidden brackets around sender for all message types
+     */
+    inline void setAlwaysBracketSender(bool alwaysBracket) { _alwaysBracketSender = alwaysBracket; }
+
     QString selection() const;
     bool hasSelection() const;
     bool hasGlobalSelection() const;
-    bool isPosOverSelection(const QPointF &) const;
+    bool isPosOverSelection(const QPointF&) const;
     bool isGloballySelecting() const;
-    void initiateDrag(QWidget *source);
+    void initiateDrag(QWidgetsource);
 
     bool isScrollingAllowed() const;
 
@@ -137,81 +156,107 @@ public slots:
     void jumpToMarkerLine(bool requestBacklog);
 
     // these are used by the chatitems to notify the scene and manage selections
-    void setSelectingItem(ChatItem *item);
-    ChatItem *selectingItem() const { return _selectingItem; }
-    void startGlobalSelection(ChatItem *item, const QPointF &itemPos);
+    void setSelectingItem(ChatItemitem);
+    ChatItemselectingItem() const { return _selectingItem; }
+    void startGlobalSelection(ChatItem* item, const QPointF& itemPos);
     void clearGlobalSelection();
     void clearSelection();
     void selectionToClipboard(QClipboard::Mode = QClipboard::Clipboard);
-    void stringToClipboard(const QString &str, QClipboard::Mode = QClipboard::Clipboard);
+    void stringToClipboard(const QStringstr, QClipboard::Mode = QClipboard::Clipboard);
 
     void webSearchOnSelection();
 
     void requestBacklog();
 
-#ifdef HAVE_WEBKIT
-    void loadWebPreview(ChatItem *parentItem, const QUrl &url, const QRectF &urlRect);
-    void clearWebPreview(ChatItem *parentItem = 0);
+#if defined HAVE_WEBKIT || defined HAVE_WEBENGINE
+    void loadWebPreview(ChatItem* parentItem, const QUrl& url, const QRectF& urlRect);
+    void clearWebPreview(ChatItem* parentItem = nullptr);
 #endif
 
 signals:
-    void lastLineChanged(QGraphicsItem *item, qreal offset);
-    void layoutChanged(); // indicates changes to the scenerect due to resizing of the contentsitems
-    void mouseMoveWhileSelecting(const QPointF &scenePos);
+    void lastLineChanged(QGraphicsItemitem, qreal offset);
+    void layoutChanged();  // indicates changes to the scenerect due to resizing of the contentsitems
+    void mouseMoveWhileSelecting(const QPointFscenePos);
 
 protected:
-    virtual void contextMenuEvent(QGraphicsSceneContextMenuEvent *contextMenuEvent);
-    virtual void mouseMoveEvent(QGraphicsSceneMouseEvent *mouseEvent);
-    virtual void mousePressEvent(QGraphicsSceneMouseEvent *mouseEvent);
-    virtual void mouseReleaseEvent(QGraphicsSceneMouseEvent *mouseEvent);
-    virtual void mouseDoubleClickEvent(QGraphicsSceneMouseEvent *mouseEvent);
-    virtual void handleClick(Qt::MouseButton button, const QPointF &scenePos);
+    void contextMenuEvent(QGraphicsSceneContextMenuEvent* contextMenuEvent) override;
+    void mouseMoveEvent(QGraphicsSceneMouseEvent* mouseEvent) override;
+    void mousePressEvent(QGraphicsSceneMouseEvent* mouseEvent) override;
+    void mouseReleaseEvent(QGraphicsSceneMouseEvent* mouseEvent) override;
+    void mouseDoubleClickEvent(QGraphicsSceneMouseEvent* mouseEvent) override;
+    virtual void handleClick(Qt::MouseButton button, const QPointFscenePos);
 
 protected slots:
-    void rowsInserted(const QModelIndex &, int, int);
-    void rowsAboutToBeRemoved(const QModelIndex &, int, int);
-    void dataChanged(const QModelIndex &, const QModelIndex &);
+    void rowsInserted(const QModelIndex&, int, int);
+    void rowsAboutToBeRemoved(const QModelIndex&, int, int);
+    void dataChanged(const QModelIndex&, const QModelIndex&);
 
 private slots:
     void firstHandlePositionChanged(qreal xpos);
     void secondHandlePositionChanged(qreal xpos);
-#ifdef HAVE_WEBKIT
+#if defined HAVE_WEBKIT || defined HAVE_WEBENGINE
     void webPreviewNextStep();
 #endif
     void showWebPreviewChanged();
 
+    /**
+     * Updates the local setting cache of whether or not to show sender brackets
+     */
+    void showSenderBracketsChanged();
+
+    /**
+     * Updates the local setting cache of whether or not to use the custom timestamp format
+     */
+    void useCustomTimestampFormatChanged();
+
+    /**
+     * Updates the local setting cache of the timestamp format string
+     */
+    void timestampFormatStringChanged();
+
+    /**
+     * Updates the status of whether or not the timestamp format string contains brackets
+     *
+     * When the timestamp contains brackets -and- showSenderBrackets is disabled, we need to
+     * automatically add brackets.  This function checks if the timestamp has brackets and stores
+     * the result, rather than checking each time text is copied.
+     */
+    void updateTimestampHasBrackets();
+
     void rowsRemoved();
 
     void clickTimeout();
 
 private:
     void setHandleXLimits();
-    void updateSelection(const QPointF &pos);
+    void updateSelection(const QPointFpos);
 
-    ChatView *_chatView;
+    ChatView_chatView;
     QString _idString;
-    QAbstractItemModel *_model;
-    QList<ChatLine *> _lines;
+    QAbstractItemModel_model;
+    QList<ChatLine*> _lines;
     BufferId _singleBufferId;
 
     // calls to QChatScene::sceneRect() are very expensive. As we manage the scenerect ourselves
     // we store the size in a member variable.
     QRectF _sceneRect;
-    int _firstLineRow; // the first row to display (aka: not a daychange msg)
+    int _firstLineRow;  // the first row to display (aka: not a daychange msg)
     void updateSceneRect(qreal width);
     inline void updateSceneRect() { updateSceneRect(_sceneRect.width()); }
-    void updateSceneRect(const QRectF &rect);
+    void updateSceneRect(const QRectFrect);
     qreal _viewportHeight;
 
-    MarkerLineItem *_markerLine;
+    MarkerLineItem_markerLine;
     bool _markerLineVisible, _markerLineValid, _markerLineJumpPending;
 
     ColumnHandleItem *_firstColHandle, *_secondColHandle;
     qreal _firstColHandlePos, _secondColHandlePos;
     int _defaultFirstColHandlePos, _defaultSecondColHandlePos;
     CutoffMode _cutoffMode;
+    /// Whether to re-add hidden brackets around sender for all message types
+    bool _alwaysBracketSender;
 
-    ChatItem *_selectingItem;
+    ChatItem_selectingItem;
     int _selectionStartCol, _selectionMinCol;
     int _selectionStart;
     int _selectionEnd;
@@ -226,28 +271,34 @@ private:
 
     bool _showWebPreview;
 
+    bool _showSenderBrackets;  /// If true, show brackets around sender names
+
+    bool _useCustomTimestampFormat;  /// If true, use the custom timestamp format
+    QString _timestampFormatString;  /// Format of the timestamp string
+    bool _timestampHasBrackets;      /// If true, timestamp format has [brackets] of some sort
+
     static const int _webSearchSelectionTextMaxVisible = 24;
 
-#ifdef HAVE_WEBKIT
-    struct WebPreview {
-        enum PreviewState {
+#if defined HAVE_WEBKIT || defined HAVE_WEBENGINE
+    struct WebPreview
+    {
+        enum PreviewState
+        {
             NoPreview,
             NewPreview,
             DelayPreview,
             ShowPreview,
             HidePreview
         };
-        ChatItem *parentItem;
-        QGraphicsItem *previewItem;
+        ChatItem* parentItem{nullptr};
+        QGraphicsItem* previewItem{nullptr};
         QUrl url;
         QRectF urlRect;
-        PreviewState previewState;
+        PreviewState previewState{NoPreview};
         QTimer timer;
-        WebPreview() : parentItem(0), previewItem(0), previewState(NoPreview) {}
     };
     WebPreview webPreview;
-#endif // HAVE_WEBKIT
+#endif  // HAVE_WEBKIT || HAVE_WEBENGINE
 };
 
-
 #endif