feat: add REPL for plugins

Author: Nerixyz

Diff for: resources/buttons/changeFontDark.svg

@@ -589,6 +589,8 @@ set(SOURCE_FILES
         widgets/Notebook.hpp
         widgets/OverlayWindow.cpp
         widgets/OverlayWindow.hpp
+        widgets/PluginRepl.cpp
+        widgets/PluginRepl.hpp
         widgets/Scrollbar.cpp
         widgets/Scrollbar.hpp
         widgets/TooltipEntryWidget.cpp

Diff for: resources/buttons/changeFontLight.svg

@@ -31,19 +31,6 @@
 namespace {
 using namespace chatterino;
 
-void logHelper(lua_State *L, Plugin *pl, QDebug stream,
-               const sol::variadic_args &args)
-{
-    stream.noquote();
-    stream << "[" + pl->id + ":" + pl->meta.name + "]";
-    for (const auto &arg : args)
-    {
-        stream << lua::toString(L, arg.stack_index());
-        // Remove this from our stack
-        lua_pop(L, 1);
-    }
-}
-
 QDebug qdebugStreamForLogLevel(lua::api::LogLevel lvl)
 {
     auto base =
@@ -101,7 +88,7 @@ void c2_log(ThisPluginState L, LogLevel lvl, sol::variadic_args args)
     lua::StackGuard guard(L);
     {
         QDebug stream = qdebugStreamForLogLevel(lvl);
-        logHelper(L, L.plugin(), stream, args);
+        L.plugin()->log(L.state(), lvl, std::move(stream), args);
     }
 }
 
@@ -261,7 +248,7 @@ void g_print(ThisPluginState L, sol::variadic_args args)
         (QMessageLogger(QT_MESSAGELOG_FILE, QT_MESSAGELOG_LINE,
                         QT_MESSAGELOG_FUNC, chatterinoLua().categoryName())
              .debug());
-    logHelper(L, L.plugin(), stream, args);
+    L.plugin()->log(L.state(), LogLevel::Info, std::move(stream), args);
 }
 
 void package_loadlib(sol::variadic_args args)

Diff for: resources/buttons/reloadDark.svg

@@ -218,6 +218,8 @@ std::unordered_set<QString> Plugin::listRegisteredCommands()
 
 Plugin::~Plugin()
 {
+    this->onDestroyed_();
+
     for (auto *timer : this->activeTimeouts)
     {
         QObject::disconnect(timer, nullptr, nullptr, nullptr);
@@ -293,5 +295,45 @@ bool Plugin::hasHTTPPermissionFor(const QUrl &url)
     });
 }
 
+boost::signals2::connection Plugin::onDestroyed(
+    const OnDestroyed::slot_type &slot)
+{
+    return this->onDestroyed_.connect(slot);
+}
+
+boost::signals2::connection Plugin::onLog(const OnLog::slot_type &slot)
+{
+    return this->onLog_.connect(slot);
+}
+
+void Plugin::log(lua_State *L, lua::api::LogLevel level, QDebug stream,
+                 const sol::variadic_args &args)
+{
+    stream.noquote();
+    stream << "[" + this->id + ":" + this->meta.name + "]";
+    QString fullMessage;
+    for (const auto &arg : args)
+    {
+        auto s = lua::toString(L, arg.stack_index());
+        stream << s;
+
+        if (!fullMessage.isEmpty())
+        {
+            fullMessage.append(' ');
+        }
+        fullMessage.append(s);
+
+        // Remove this from our stack
+        lua_pop(L, 1);
+    }
+
+    this->onLog_(level, fullMessage);
+}
+
+sol::state_view Plugin::state()
+{
+    return {this->state_};
+}
+
 }  // namespace chatterino
 #endif

Diff for: resources/buttons/reloadLight.svg

@@ -7,6 +7,7 @@
 #    include "controllers/plugins/LuaUtilities.hpp"
 #    include "controllers/plugins/PluginPermission.hpp"
 
+#    include <boost/signals2/signal.hpp>
 #    include <QDir>
 #    include <QString>
 #    include <QUrl>
@@ -22,6 +23,10 @@
 struct lua_State;
 class QTimer;
 
+namespace chatterino::lua::api {
+enum class LogLevel;
+}  // namespace chatterino::lua::api
+
 namespace chatterino {
 
 struct PluginMeta {
@@ -65,6 +70,10 @@ struct PluginMeta {
 
 class Plugin
 {
+    using OnDestroyed = boost::signals2::signal<void()>;
+    using OnLog =
+        boost::signals2::signal<void(lua::api::LogLevel, const QString &)>;
+
 public:
     QString id;
     PluginMeta meta;
@@ -137,6 +146,14 @@ class Plugin
     bool hasFSPermissionFor(bool write, const QString &path);
     bool hasHTTPPermissionFor(const QUrl &url);
 
+    boost::signals2::connection onDestroyed(const OnDestroyed::slot_type &slot);
+    boost::signals2::connection onLog(const OnLog::slot_type &slot);
+
+    void log(lua_State *L, lua::api::LogLevel level, QDebug stream,
+             const sol::variadic_args &args);
+
+    sol::state_view state();
+
     std::map<lua::api::EventType, sol::protected_function> callbacks;
 
     // In-flight HTTP Requests
@@ -154,6 +171,9 @@ class Plugin
     std::vector<QTimer *> activeTimeouts;
     int lastTimerId = 0;
 
+    OnDestroyed onDestroyed_;
+    OnLog onLog_;
+
     friend class PluginController;
     friend class PluginControllerAccess;  // this is for tests
 };

Diff for: src/CMakeLists.txt

@@ -276,6 +276,8 @@ void PluginController::load(const QFileInfo &index, const QDir &pluginDir,
     }
     temp->dataDirectory().mkpath(".");
 
+    // make sure we capture log messages during load
+    this->onPluginLoaded_(temp);
     qCDebug(chatterinoLua) << "Running lua file:" << index;
     int err = luaL_dofile(l, index.absoluteFilePath().toStdString().c_str());
     if (err != 0)
@@ -428,5 +430,11 @@ std::pair<bool, QStringList> PluginController::updateCustomCompletions(
     return {false, results};
 }
 
+boost::signals2::connection PluginController::onPluginLoaded(
+    const OnPluginLoaded::slot_type &slot)
+{
+    return this->onPluginLoaded_.connect(slot);
+}
+
 }  // namespace chatterino
 #endif

Diff for: src/controllers/plugins/LuaAPI.cpp

@@ -5,6 +5,7 @@
 #    include "controllers/commands/CommandContext.hpp"
 #    include "controllers/plugins/Plugin.hpp"
 
+#    include <boost/signals2/signal.hpp>
 #    include <QDir>
 #    include <QFileInfo>
 #    include <QJsonArray>
@@ -26,6 +27,8 @@ class Paths;
 
 class PluginController
 {
+    using OnPluginLoaded = boost::signals2::signal<void(Plugin *)>;
+
     const Paths &paths;
 
 public:
@@ -61,6 +64,9 @@ class PluginController
         const QString &query, const QString &fullTextContent,
         int cursorPosition, bool isFirstWord) const;
 
+    boost::signals2::connection onPluginLoaded(
+        const OnPluginLoaded::slot_type &slot);
+
 private:
     void loadPlugins();
     void load(const QFileInfo &index, const QDir &pluginDir,
@@ -75,6 +81,8 @@ class PluginController
     bool tryLoadFromDir(const QDir &pluginDir);
     std::map<QString, std::unique_ptr<Plugin>> plugins_;
 
+    OnPluginLoaded onPluginLoaded_;
+
     // This is for tests, pay no attention
     friend class PluginControllerAccess;
 };

Diff for: src/controllers/plugins/Plugin.cpp

@@ -645,6 +645,12 @@ class Settings
 
     BoolSetting showSendButton = {"/ui/showSendButton", false};
 
+    struct {
+        QStringSetting fontFamily = {"/ui/pluginRepl/fontFamily", {}};
+        QStringSetting fontStyle = {"/ui/pluginRepl/fontStyle", "Regular"};
+        IntSetting fontSize = {"/ui/pluginRepl/fontSize", 10};
+    } pluginRepl;
+
     // Similarity
     BoolSetting similarityEnabled = {"/similarity/similarityEnabled", false};
     BoolSetting colorSimilarDisabled = {"/similarity/colorSimilarDisabled",