Fixed tab completion rarely completing the wrong word.

CHANGELOG.md

@@ -26,6 +26,7 @@
 - Bugfix: Fixed crash that could occurr when closing the usercard too quickly after blocking or unblocking a user. (#4711)
 - Bugfix: Fixed highlights sometimes not working after changing sound device, or switching users in your operating system. (#4729)
 - Bugfix: Fixed key bindings not showing in context menus on Mac. (#4722)
+- Bugfix: Fixed tab completion rarely completing the wrong word. (#4735)
 - Dev: Added command to set Qt's logging filter/rules at runtime (`/c2-set-logging-rules`). (#4637)
 - Dev: Added the ability to see & load custom themes from the Themes directory. No stable promises are made of this feature, changes might be made that breaks custom themes without notice. (#4570)
 - Dev: Added test cases for emote and tab completion. (#4644)

src/widgets/helper/ResizingTextEdit.cpp

@@ -2,6 +2,7 @@
 
 #include "common/Common.hpp"
 #include "common/CompletionModel.hpp"
+#include "common/QLogging.hpp"
 #include "singletons/Settings.hpp"
 
 #include <QMimeData>
@@ -19,6 +20,15 @@ ResizingTextEdit::ResizingTextEdit()
 
     QObject::connect(this, &QTextEdit::textChanged, this,
                      &QWidget::updateGeometry);
+    QObject::connect(this, &QTextEdit::cursorPositionChanged, [this]() {
+        if (this->updatingText_ || !this->completionInProgress_)
+        {
+            return;
+        }
+        qCDebug(chatterinoCommon)
+            << "Finishing completion because cursor moved";
+        this->completionInProgress_ = false;
+    });
 
     // Whenever the setting for emote completion changes, force a
     // refresh on the completion model the next time "Tab" is pressed
@@ -144,6 +154,7 @@ void ResizingTextEdit::keyPressEvent(QKeyEvent *event)
         {
             return;
         }
+        this->updatingText_ = true;
 
         auto *completionModel =
             static_cast<CompletionModel *>(this->completer_->model());
@@ -158,6 +169,7 @@ void ResizingTextEdit::keyPressEvent(QKeyEvent *event)
             this->completionInProgress_ = true;
             this->completer_->setCompletionPrefix(currentCompletionPrefix);
             this->completer_->complete();
+            this->updatingText_ = false;
             return;
         }
 
@@ -183,6 +195,7 @@ void ResizingTextEdit::keyPressEvent(QKeyEvent *event)
         }
 
         this->completer_->complete();
+        this->updatingText_ = false;
         return;
     }
 

src/widgets/helper/ResizingTextEdit.hpp

@@ -66,6 +66,21 @@ class ResizingTextEdit : public QTextEdit
      */
     bool completionInProgress_ = false;
 
+    /**
+     * This is set whenever the tab completion is triggered.
+     * When this variable is set, moving the cursor will not reset tab completion.
+     *
+     * For example:
+     *
+     * input: "pog"
+     *  - type Tab to complete to "PogBones"
+     *    - updatingText_ is set to true,
+     *    - text is updated, cursor is moved after the new word
+     *    - updatingText_ is set to false,
+     *  - moving the cursor now would result in completionInProgress_ being set to false
+     */
+    bool updatingText_ = false;
+
     bool eventFilter(QObject *obj, QEvent *event) override;
 
 private slots: