Remove QObjectRef in favor of QPointer (#4666)

* replace usage of QObjectRef with QPointer

* delete QObjectRef class

* inlucde QPointer header

* Add changelog entry

* use isNull() instead of ! data()

---------

Co-authored-by: Rasmus Karlsson <rasmus.karlsson@pajlada.com>

CHANGELOG.md

@@ -13,6 +13,7 @@
 - Dev: Expanded upon `$$$` test channels. (#4655)
 - Dev: Added tools to help debug image GC. (#4578)
 - Dev: Removed duplicate license when having plugins enabled. (#4665)
+- Dev: Replace our QObjectRef class with Qt's QPointer class. (#4666)
 
 ## 2.4.4
 

src/common/NetworkPrivate.cpp

@@ -174,7 +174,7 @@ void loadUncached(std::shared_ptr<NetworkData> &&data)
         }
 
         auto handleReply = [data, reply]() mutable {
-            if (data->hasCaller_ && !data->caller_.get())
+            if (data->hasCaller_ && data->caller_.isNull())
             {
                 return;
             }
@@ -350,7 +350,7 @@ void loadCached(std::shared_ptr<NetworkData> &&data)
             // XXX: If outcome is Failure, we should invalidate the cache file
             // somehow/somewhere
             /*auto outcome =*/
-            if (data->hasCaller_ && !data->caller_.get())
+            if (data->hasCaller_ && data->caller_.isNull())
             {
                 return;
             }
@@ -359,7 +359,7 @@ void loadCached(std::shared_ptr<NetworkData> &&data)
         else
         {
             postToThread([data, result]() {
-                if (data->hasCaller_ && !data->caller_.get())
+                if (data->hasCaller_ && data->caller_.isNull())
                 {
                     return;
                 }
@@ -373,7 +373,7 @@ void loadCached(std::shared_ptr<NetworkData> &&data)
     {
         if (data->executeConcurrently_ || isGuiThread())
         {
-            if (data->hasCaller_ && !data->caller_.get())
+            if (data->hasCaller_ && data->caller_.isNull())
             {
                 return;
             }
@@ -383,7 +383,7 @@ void loadCached(std::shared_ptr<NetworkData> &&data)
         else
         {
             postToThread([data]() {
-                if (data->hasCaller_ && !data->caller_.get())
+                if (data->hasCaller_ && data->caller_.isNull())
                 {
                     return;
                 }

src/common/NetworkPrivate.hpp

@@ -1,10 +1,10 @@
 #pragma once
 
 #include "common/NetworkCommon.hpp"
-#include "util/QObjectRef.hpp"
 
 #include <QHttpMultiPart>
 #include <QNetworkRequest>
+#include <QPointer>
 #include <QTimer>
 
 #include <functional>
@@ -38,7 +38,7 @@ struct NetworkData {
 
     QNetworkRequest request_;
     bool hasCaller_{};
-    QObjectRef<QObject> caller_;
+    QPointer<QObject> caller_;
     bool cache_{};
     bool executeConcurrently_{};
 

src/providers/irc/IrcServer.cpp

@@ -11,9 +11,9 @@
 #include "providers/twitch/TwitchIrcServer.hpp"  // NOTE: Included to access the mentions channel
 #include "singletons/Settings.hpp"
 #include "util/IrcHelpers.hpp"
-#include "util/QObjectRef.hpp"
 
 #include <QMetaEnum>
+#include <QPointer>
 
 #include <cassert>
 #include <cstdlib>
@@ -151,7 +151,7 @@ void IrcServer::initializeConnection(IrcConnection *connection,
                 [[fallthrough]];
             case IrcAuthType::Pass:
                 this->data_->getPassword(
-                    this, [conn = new QObjectRef(connection) /* can't copy */,
+                    this, [conn = new QPointer(connection) /* can't copy */,
                            this](const QString &password) mutable {
                         if (*conn)
                         {

src/util/QObjectRef.hpp

@@ -1,86 +0,0 @@
-#pragma once
-
-#include <QApplication>
-#include <QObject>
-
-#include <type_traits>
-
-namespace chatterino {
-/// Holds a pointer to a QObject and resets it to nullptr if the QObject
-/// gets destroyed.
-template <typename T>
-class QObjectRef
-{
-public:
-    QObjectRef()
-    {
-        static_assert(std::is_base_of_v<QObject, T>);
-    }
-
-    explicit QObjectRef(T *t)
-    {
-        static_assert(std::is_base_of_v<QObject, T>);
-
-        this->set(t);
-    }
-
-    QObjectRef(const QObjectRef &other)
-    {
-        this->set(other.t_);
-    }
-
-    ~QObjectRef()
-    {
-        this->set(nullptr);
-    }
-
-    QObjectRef &operator=(T *t)
-    {
-        this->set(t);
-
-        return *this;
-    }
-
-    operator bool()
-    {
-        return t_;
-    }
-
-    T *operator->()
-    {
-        return t_;
-    }
-
-    T *get()
-    {
-        return t_;
-    }
-
-private:
-    void set(T *other)
-    {
-        // old
-        if (this->conn_)
-        {
-            QObject::disconnect(this->conn_);
-        }
-
-        // new
-        if (other)
-        {
-            // the cast here should absolutely not be necessary, but gcc still requires it
-            this->conn_ =
-                QObject::connect((QObject *)other, &QObject::destroyed, qApp,
-                                 [this](QObject *) {
-                                     this->set(nullptr);
-                                 },
-                                 Qt::DirectConnection);
-        }
-
-        this->t_ = other;
-    }
-
-    std::atomic<T *> t_{};
-    QMetaObject::Connection conn_;
-};
-}  // namespace chatterino

src/widgets/splits/SplitInput.cpp

@@ -630,7 +630,7 @@ bool SplitInput::eventFilter(QObject *obj, QEvent *event)
     if (event->type() == QEvent::ShortcutOverride ||
         event->type() == QEvent::Shortcut)
     {
-        if (auto popup = this->inputCompletionPopup_.get())
+        if (auto popup = this->inputCompletionPopup_.data())
         {
             if (popup->isVisible())
             {
@@ -650,7 +650,7 @@ void SplitInput::installKeyPressedEvent()
 {
     this->ui_.textEdit->keyPressed.disconnectAll();
     this->ui_.textEdit->keyPressed.connect([this](QKeyEvent *event) {
-        if (auto *popup = this->inputCompletionPopup_.get())
+        if (auto *popup = this->inputCompletionPopup_.data())
         {
             if (popup->isVisible())
             {
@@ -764,12 +764,12 @@ void SplitInput::updateCompletionPopup()
 
 void SplitInput::showCompletionPopup(const QString &text, bool emoteCompletion)
 {
-    if (!this->inputCompletionPopup_.get())
+    if (this->inputCompletionPopup_.isNull())
     {
         this->inputCompletionPopup_ = new InputCompletionPopup(this);
         this->inputCompletionPopup_->setInputAction(
-            [that = QObjectRef(this)](const QString &text) mutable {
+            [that = QPointer(this)](const QString &text) mutable {
-                if (auto *this2 = that.get())
+                if (auto *this2 = that.data())
                 {
                     this2->insertCompletionText(text);
                     this2->hideCompletionPopup();
@@ -777,7 +777,7 @@ void SplitInput::showCompletionPopup(const QString &text, bool emoteCompletion)
             });
     }
 
-    auto *popup = this->inputCompletionPopup_.get();
+    auto *popup = this->inputCompletionPopup_.data();
     assert(popup);
 
     if (emoteCompletion)
@@ -798,7 +798,7 @@ void SplitInput::showCompletionPopup(const QString &text, bool emoteCompletion)
 
 void SplitInput::hideCompletionPopup()
 {
-    if (auto *popup = this->inputCompletionPopup_.get())
+    if (auto *popup = this->inputCompletionPopup_.data())
     {
         popup->hide();
     }

src/widgets/splits/SplitInput.hpp

@@ -1,12 +1,12 @@
 #pragma once
 
-#include "util/QObjectRef.hpp"
 #include "widgets/BaseWidget.hpp"
 
 #include <QHBoxLayout>
 #include <QLabel>
 #include <QLineEdit>
 #include <QPaintEvent>
+#include <QPointer>
 #include <QTextEdit>
 #include <QVBoxLayout>
 #include <QWidget>
@@ -113,8 +113,8 @@ protected:
 
     Split *const split_;
     ChannelView *const channelView_;
-    QObjectRef<EmotePopup> emotePopup_;
+    QPointer<EmotePopup> emotePopup_;
-    QObjectRef<InputCompletionPopup> inputCompletionPopup_;
+    QPointer<InputCompletionPopup> inputCompletionPopup_;
 
     struct {
         ResizingTextEdit *textEdit;