Add an indicator in the title bar if Streamer Mode is active

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Unversioned
 
 - Minor: Delete all but the last 5 crashdumps on application start. (#4392)
+- Minor: Add an icon showing when streamer mode is enabled (#4410)
 - Bugfix: Fixed uploaded AppImage not being able most web requests. (#4400)
 - Bugfix: Fixed a potential race condition due to using the wrong lock when loading 7TV badges. (#4402)
 - Dev: Add capability to build Chatterino with Qt6. (#4393)

resources/licenses/fluenticons.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Microsoft Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

src/Application.hpp

@@ -3,6 +3,8 @@
 #include "common/Singleton.hpp"
 #include "singletons/NativeMessaging.hpp"
 
+#include <pajlada/signals.hpp>
+#include <pajlada/signals/signal.hpp>
 #include <QApplication>
 
 #include <memory>
@@ -148,6 +150,9 @@ class Application : public IApplication
     }
     IUserDataController *getUserData() override;
 
+    // parameter: enabled
+    pajlada::Signals::NoArgSignal streamerModeChanged;
+
 private:
     void addSingleton(Singleton *singleton);
     void initPubSub();

src/singletons/Settings.cpp

@@ -1,5 +1,6 @@
 #include "singletons/Settings.hpp"
 
+#include "Application.hpp"
 #include "controllers/filters/FilterRecord.hpp"
 #include "controllers/highlights/HighlightBadge.hpp"
 #include "controllers/highlights/HighlightBlacklistUser.hpp"
@@ -136,6 +137,11 @@ Settings::Settings(const QString &settingsDirectory)
         },
         false);
 #endif
+    this->enableStreamerMode.connect(
+        []() {
+            getApp()->streamerModeChanged.invoke();
+        },
+        false);
 }
 
 Settings &Settings::instance()

src/util/StreamerMode.cpp

@@ -71,6 +71,7 @@ bool isInStreamerMode()
                 p.exitStatus() == QProcess::NormalExit)
             {
                 cache = (p.exitCode() == 0);
+                getApp()->streamerModeChanged.invoke();
                 return (p.exitCode() == 0);
             }
 
@@ -89,6 +90,7 @@ bool isInStreamerMode()
             qCWarning(chatterinoStreamerMode) << "pgrep execution timed out!";
 
             cache = false;
+            getApp()->streamerModeChanged.invoke();
             return false;
 #endif
 
@@ -122,6 +124,7 @@ bool isInStreamerMode()
                     if (broadcastingBinaries().contains(processName))
                     {
                         cache = true;
+                        getApp()->streamerModeChanged.invoke();
                         return true;
                     }
                 }
@@ -133,6 +136,7 @@ bool isInStreamerMode()
             }
 
             cache = false;
+            getApp()->streamerModeChanged.invoke();
 #endif
             return false;
     }

src/widgets/Notebook.cpp

@@ -4,10 +4,12 @@
 #include "common/QLogging.hpp"
 #include "controllers/hotkeys/HotkeyCategory.hpp"
 #include "controllers/hotkeys/HotkeyController.hpp"
+#include "singletons/Resources.hpp"
 #include "singletons/Settings.hpp"
 #include "singletons/Theme.hpp"
 #include "singletons/WindowManager.hpp"
 #include "util/InitUpdateButton.hpp"
+#include "util/StreamerMode.hpp"
 #include "widgets/dialogs/SettingsDialog.hpp"
 #include "widgets/helper/ChannelView.hpp"
 #include "widgets/helper/NotebookButton.hpp"
@@ -1154,6 +1156,41 @@ void SplitNotebook::addCustomButtons()
     auto updateBtn = this->addCustomButton();
 
     initUpdateButton(*updateBtn, this->signalHolder_);
+
+    // streamer mode
+    this->streamerModeIcon_ = this->addCustomButton();
+    QObject::connect(this->streamerModeIcon_, &NotebookButton::leftClicked,
+                     [this] {
+                         getApp()->windows->showSettingsDialog(
+                             this, SettingsDialogPreference::StreamerMode);
+                     });
+    this->signalHolder_.managedConnect(getApp()->streamerModeChanged, [this]() {
+        this->updateStreamerModeIcon();
+    });
+    this->updateStreamerModeIcon();
+}
+
+void SplitNotebook::updateStreamerModeIcon()
+{
+    // A duplicate of this code is in Window class
+    // That copy handles the TitleBar icon in Window (main window on Windows)
+    // This one is the one near splits (on linux and mac or non-main windows on Windows)
+    if (getTheme()->isLightTheme())
+    {
+        this->streamerModeIcon_->setPixmap(
+            getResources().buttons.streamerModeEnabledLight);
+    }
+    else
+    {
+        this->streamerModeIcon_->setPixmap(
+            getResources().buttons.streamerModeEnabledDark);
+    }
+    this->streamerModeIcon_->setVisible(isInStreamerMode());
+}
+
+void SplitNotebook::themeChangedEvent()
+{
+    this->updateStreamerModeIcon();
 }
 
 SplitContainer *SplitNotebook::addPage(bool select)

src/widgets/Notebook.hpp

@@ -123,6 +123,7 @@ class SplitNotebook : public Notebook
     SplitContainer *addPage(bool select = false);
     SplitContainer *getOrAddSelectedPage();
     void select(QWidget *page, bool focusPage = true) override;
+    void themeChangedEvent() override;
 
 protected:
     void showEvent(QShowEvent *event) override;
@@ -131,6 +132,11 @@ class SplitNotebook : public Notebook
     void addCustomButtons();
 
     pajlada::Signals::SignalHolder signalHolder_;
+
+    // Main window on Windows has basically a duplicate of this in Window
+    NotebookButton *streamerModeIcon_;
+
+    void updateStreamerModeIcon();
 };
 
 }  // namespace chatterino

src/widgets/Window.cpp

@@ -9,6 +9,7 @@
 #include "controllers/hotkeys/HotkeyController.hpp"
 #include "providers/twitch/TwitchAccount.hpp"
 #include "providers/twitch/TwitchIrcServer.hpp"
+#include "singletons/Resources.hpp"
 #include "singletons/Settings.hpp"
 #include "singletons/Theme.hpp"
 #include "singletons/Updates.hpp"
@@ -186,6 +187,51 @@ void Window::addCustomTitlebarButtons()
             this->userLabel_->rect().bottomLeft()));
     });
     this->userLabel_->setMinimumWidth(20 * scale());
+
+    // streamer mode
+    this->streamerModeTitlebarIcon_ =
+        this->addTitleBarButton(TitleBarButtonStyle::StreamerMode, [this] {
+            getApp()->windows->showSettingsDialog(
+                this, SettingsDialogPreference::StreamerMode);
+        });
+    this->signalHolder_.managedConnect(getApp()->streamerModeChanged, [this]() {
+        this->updateStreamerModeIcon();
+    });
+}
+
+void Window::updateStreamerModeIcon()
+{
+    // A duplicate of this code is in SplitNotebook class (in Notebook.{c,h}pp)
+    // That one is the one near splits (on linux and mac or non-main windows on Windows)
+    // This copy handles the TitleBar icon in Window (main window on Windows)
+    if (this->streamerModeTitlebarIcon_ == nullptr)
+    {
+        return;
+    }
+#ifdef Q_OS_WIN
+    assert(this->getType() == WindowType::Main);
+    if (getTheme()->isLightTheme())
+    {
+        this->streamerModeTitlebarIcon_->setPixmap(
+            getResources().buttons.streamerModeEnabledLight);
+    }
+    else
+    {
+        this->streamerModeTitlebarIcon_->setPixmap(
+            getResources().buttons.streamerModeEnabledDark);
+    }
+    this->streamerModeTitlebarIcon_->setVisible(isInStreamerMode());
+#else
+    // clang-format off
+    assert(false && "Streamer mode TitleBar icon should not exist on non-Windows OSes");
+    // clang-format on
+#endif
+}
+
+void Window::themeChangedEvent()
+{
+    this->updateStreamerModeIcon();
+    BaseWindow::themeChangedEvent();
 }
 
 void Window::addDebugStuff(HotkeyController::HotkeyMap &actions)

src/widgets/Window.hpp

@@ -31,6 +31,7 @@ class Window : public BaseWindow
 protected:
     void closeEvent(QCloseEvent *event) override;
     bool event(QEvent *event) override;
+    void themeChangedEvent() override;
 
 private:
     void addCustomTitlebarButtons();
@@ -51,6 +52,10 @@ class Window : public BaseWindow
     pajlada::Signals::SignalHolder signalHolder_;
     std::vector<boost::signals2::scoped_connection> bSignals_;
 
+    // this is only used on Windows and only on the main window, for the one used otherwise, see SplitNotebook in Notebook.hpp
+    TitleBarButton *streamerModeTitlebarIcon_ = nullptr;
+    void updateStreamerModeIcon();
+
     friend class Notebook;
 };
 

src/widgets/dialogs/SettingsDialog.cpp

@@ -194,6 +194,11 @@ void SettingsDialog::filterElements(const QString &text)
     }
 }
 
+void SettingsDialog::setElementFilter(const QString &query)
+{
+    this->ui_.search->setText(query);
+}
+
 void SettingsDialog::addTabs()
 {
     this->ui_.tabContainer->setSpacing(0);
@@ -202,7 +207,7 @@ void SettingsDialog::addTabs()
     // Constructors are wrapped in std::function to remove some strain from first time loading.
 
     // clang-format off
-    this->addTab([]{return new GeneralPage;},          "General",        ":/settings/about.svg");
+    this->addTab([]{return new GeneralPage;},          "General",        ":/settings/about.svg", SettingsTabId::General);
     this->ui_.tabContainer->addSpacing(16);
     this->addTab([]{return new AccountsPage;},         "Accounts",       ":/settings/accounts.svg", SettingsTabId::Accounts);
     this->addTab([]{return new NicknamesPage;},        "Nicknames",      ":/settings/accounts.svg");
@@ -312,10 +317,20 @@ void SettingsDialog::showDialog(QWidget *parent,
             }
             break;
 
+        case SettingsDialogPreference::StreamerMode: {
+            instance->selectTab(SettingsTabId::General);
+        }
+        break;
+
         default:;
     }
 
     instance->show();
+    if (preferredTab == SettingsDialogPreference::StreamerMode)
+    {
+        // this is needed because each time the settings are opened, the query is reset
+        instance->setElementFilter("Streamer Mode");
+    }
     instance->activateWindow();
     instance->raise();
     instance->setFocus();

src/widgets/dialogs/SettingsDialog.hpp

@@ -27,6 +27,7 @@ class PageHeader : public QFrame
 
 enum class SettingsDialogPreference {
     NoPreference,
+    StreamerMode,
     Accounts,
     ModerationActions,
 };
@@ -57,6 +58,7 @@ class SettingsDialog : public BaseWindow
     void selectTab(SettingsDialogTab *tab, const bool byUser = true);
     void selectTab(SettingsTabId id);
     void filterElements(const QString &query);
+    void setElementFilter(const QString &query);
 
     void onOkClicked();
     void onCancelClicked();

src/widgets/helper/SettingsDialogTab.hpp

@@ -15,6 +15,7 @@ class SettingsDialog;
 
 enum class SettingsTabId {
     None,
+    General,
     Accounts,
     Moderation,
 };

src/widgets/helper/TitlebarButton.hpp

@@ -11,7 +11,8 @@ enum class TitleBarButtonStyle {
     Unmaximize = 4,
     Close = 8,
     User = 16,
-    Settings = 32
+    Settings = 32,
+    StreamerMode = 64,
 };
 
 class TitleBarButton : public Button

src/widgets/settingspages/AboutPage.cpp

@@ -119,6 +119,9 @@ AboutPage::AboutPage()
                        "https://github.com/getsentry/crashpad",
                        ":/licenses/crashpad.txt");
 #endif
+            addLicense(form.getElement(), "Fluent icons",
+                       "https://github.com/microsoft/fluentui-system-icons",
+                       ":/licenses/fluenticons.txt");
         }
 
         // Attributions