Add more tests

src/libneochat/chattextitemhelper.h

@@ -21,10 +21,12 @@ class NeoChatRoom;
  *
  * A class to wrap around a QQuickItem that is a QML TextEdit (or inherited from it).
  *
- * @note This basically exists because Qt does not give us access to the cpp headers of
- * most QML items.
+ * This class has 2 key functions:
+ *  - Provide easy read/write access to the properties of the TextEdit. This is required
+ *    because Qt does not give us access to the cpp headers of most QML items.
+ *  - Provide standard functions to edit the underlying QTextDocument.
  *
- * @sa QQuickItem, TextEdit
+ * @sa QQuickItem, TextEdit, QTextDocument
  */
 class ChatTextItemHelper : public QObject
 {
@@ -45,71 +47,196 @@ public:
 
     explicit ChatTextItemHelper(QObject *parent = nullptr);
 
+    /**
+     * @brief Set the NeoChatRoom required by the syntax highlighter.
+     *
+     * @sa NeoChatRoom
+     */
     void setRoom(NeoChatRoom *room);
 
+    /**
+     * @brief Set the ChatBarType::Type required by the syntax highlighter.
+     *
+     * @sa ChatBarType::Type
+     */
     void setType(ChatBarType::Type type);
 
     QQuickItem *textItem() const;
     void setTextItem(QQuickItem *textItem);
 
+    /**
+     * @brief The fixed characters that will always be at the beginning of the text item.
+     */
     QString fixedStartChars() const;
+
+    /**
+     * @brief The fixed characters that will always be at the end of the text item.
+     */
     QString fixedEndChars() const;
+
+    /**
+     * @brief Set the fixed characters that will always be at the beginning and end of the text item.
+     */
     void setFixedChars(const QString &startChars, const QString &endChars);
+
+    /**
+     * @brief Any text to initialise the text item with when set.
+     */
     QString initialText() const;
+
+    /**
+     * @brief Set the text to initialise the text item with when set.
+     *
+     * This text will only be set if the text item is empty when set.
+     */
     void setInitialText(const QString &text);
 
+    /**
+     * @brief The underlying QTextDocument.
+     *
+     * @sa QTextDocument
+     */
     QTextDocument *document() const;
+
+    /**
+     * @brief The line count of the text item.
+     */
     int lineCount() const;
+
+    /**
+     * @brief Remove the first QTextBlock from the QTextDocument and return as a QTextDocumentFragment.
+     *
+     * @sa QTextBlock, QTextDocument, QTextDocumentFragment
+     */
     QTextDocumentFragment takeFirstBlock();
+
+    /**
+     * @brief Fill the given QTextDocumentFragment with the text item contents.
+     *
+     * The idea is to split the QTextDocument into 3. There is the QTextBlock that the
+     * cursor is currently in, the midFragment. Then if there are any blocks after
+     * this they are put into the afterFragment. The if there is any block before
+     * the midFragment these are left and hasBefore is set to true.
+     *
+     * This is used when inserting a new block type at the cursor. The midFragement will be
+     * given the new style and then the before and after are put back as the same
+     * block type.
+     *
+     * @sa QTextBlock, QTextDocument, QTextDocumentFragment
+     */
     void fillFragments(bool &hasBefore, QTextDocumentFragment &midFragment, std::optional<QTextDocumentFragment> &afterFragment);
+
+    /**
+     * @brief Insert the given QTextDocumentFragment as the given position.
+     */
     void insertFragment(const QTextDocumentFragment fragment, InsertPosition position = Cursor, bool keepPosition = false);
 
+    /**
+     * @brief Return a QTextCursor pointing to the current cursor position.
+     */
     QTextCursor textCursor() const;
-    int cursorPosition() const;
-    void setCursorPosition(int pos);
-    void setCursorVisible(bool visible);
-    void setCursorFromTextItem(ChatTextItemHelper *textItem, bool infront, int defaultPosition = 0);
 
-    QList<RichFormat::Format> formatsAtCursor(QTextCursor cursor = {}) const;
+    /**
+     * @brief Return the current cursor position of the underlying text item.
+     */
+    std::optional<int> cursorPosition() const;
+
+    /**
+     * @brief Set the cursor position of the underlying text item to the given value.
+     */
+    void setCursorPosition(int pos);
+
+    /**
+     * @brief Set the cursor visibility of the underlying text item to the given value.
+     */
+    void setCursorVisible(bool visible);
+
+    /**
+     * @brief Set the cursor position to the same as the given text item.
+     *
+     * This will either be the first or last line dependent upon the infront value.
+     */
+    void setCursorFromTextItem(ChatTextItemHelper *textItem, bool infront);
+
+    /**
+     * @brief Merge the given format on the given QTextCursor.
+     */
     void mergeFormatOnCursor(RichFormat::Format format, QTextCursor cursor = {});
 
+    /**
+     * @brief Whether the list can be indented more at the given cursor.
+     */
     bool canIndentListMoreAtCursor(QTextCursor cursor = {}) const;
+
+    /**
+     * @brief Whether the list can be indented less at the given cursor.
+     */
     bool canIndentListLessAtCursor(QTextCursor cursor = {}) const;
+
+    /**
+     * @brief Indented the list more at the given cursor.
+     */
     void indentListMoreAtCursor(QTextCursor cursor = {});
+
+    /**
+     * @brief Indented the list less at the given cursor.
+     */
     void indentListLessAtCursor(QTextCursor cursor = {});
 
+    /**
+     * @brief Force active focus on the underlying text item.
+     */
     void forceActiveFocus() const;
 
+    /**
+     * @brief Rehightlight the text in the text item.
+     */
     void rehighlight() const;
 
+    /**
+     * @brief Output the text in the text item in markdown format.
+     */
     QString markdownText() const;
 
 Q_SIGNALS:
     void textItemChanged();
-
-    void contentsChange(int position, int charsRemoved, int charsAdded);
-
-    void contentsChanged();
-
-    void cleared(ChatTextItemHelper *self);
-
-    void cursorPositionChanged();
-
     void formatChanged();
     void textFormatChanged();
     void styleChanged();
     void listChanged();
 
+    /**
+     * @brief Emitted when the contents of the underlying text item are changed.
+     */
+    void contentsChange(int position, int charsRemoved, int charsAdded);
+
+    /**
+     * @brief Emitted when the contents of the underlying text item are changed.
+     */
+    void contentsChanged();
+
+    /**
+     * @brief Emitted when the contents of the underlying text item are cleared.
+     */
+    void cleared(ChatTextItemHelper *self);
+
+    /**
+     * @brief Emitted when the cursor position of the underlying text item is changed.
+     */
+    void cursorPositionChanged(bool fromContentsChange);
+
 private:
     QPointer<QQuickItem> m_textItem;
     QPointer<ChatBarSyntaxHighlighter> m_highlighter;
 
+    bool m_contentsJustChanged = false;
     std::optional<Qt::TextFormat> textFormat() const;
 
     QString m_fixedStartChars = {};
     QString m_fixedEndChars = {};
     QString m_initialText = {};
     void initializeChars();
+    bool m_initializingChars = false;
 
     bool isEmpty() const;
     std::optional<int> lineLength(int lineNumber) const;