Initial implementation of the plugin framework

Plugin RFC #2529 Signed-off-by: Ouyang Chunhui <[email protected]>
flameshot-org · Jul 5, 2024 · 5286322 · 5286322
1 parent ccb5a27
commit 5286322
Show file tree

Hide file tree

Showing 27 changed files with 1,952 additions and 23 deletions.
diff --git a/0001-Initial-implementation-of-the-plugin-framework.patch b/0001-Initial-implementation-of-the-plugin-framework.patch
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -69,6 +69,12 @@ option(USE_EXTERNAL_SINGLEAPPLICATION "Use external QtSingleApplication library"
 option(USE_LAUNCHER_ABSOLUTE_PATH "Use absolute path for the desktop launcher" ON)
 option(USE_WAYLAND_CLIPBOARD "USE KF Gui Wayland Clipboard" OFF)
 option(DISABLE_UPDATE_CHECKER "Disable check for updates" OFF)
+option(USE_PLUGIN_MANAGER "Activate the Plugin Manager" ON)
+option(USE_WAYLAND_GRIM "Activate the Wayland GRIM screenshot adapter" OFF)
+
+if (USE_PLUGIN_MANAGER)
+    set(PLUGIN_DIRECTORY "app_plugins" CACHE PATH "Setting the Plugin Manager Plugin Directory")
+endif()
 if (DISABLE_UPDATE_CHECKER)
   add_compile_definitions(DISABLE_UPDATE_CHECKER)
 endif ()

diff --git a/data/graphics.qrc b/data/graphics.qrc
@@ -99,5 +99,9 @@
         <file>img/material/black/image.svg</file>
         <file>img/material/white/apps.svg</file>
         <file>img/material/white/image.svg</file>
+        <file>img/material/black/content-print.svg</file>
+        <file>img/material/black/save-to-pdf.svg</file>
+        <file>img/material/white/content-print.svg</file>
+        <file>img/material/white/save-to-pdf.svg</file>
     </qresource>
 </RCC>
diff --git a/data/img/material/black/content-print.svg b/data/img/material/black/content-print.svg
diff --git a/data/img/material/black/save-to-pdf.svg b/data/img/material/black/save-to-pdf.svg
diff --git a/data/img/material/white/content-print.svg b/data/img/material/white/content-print.svg
diff --git a/data/img/material/white/save-to-pdf.svg b/data/img/material/white/save-to-pdf.svg
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -8,12 +8,18 @@ find_package(
         Network
         Svg
         DBus
-        LinguistTools)
+        LinguistTools
+        PrintSupport)
 
 if (USE_WAYLAND_CLIPBOARD)
     find_package(KF5GuiAddons)
 endif()
 
+if (USE_PLUGIN_MANAGER)
+    find_package(yaml-cpp)
+endif()
+
+set(USE_PLUGIN_MANAGER ON)
 set(CMAKE_AUTOMOC ON)
 set(CMAKE_AUTORCC ON)
 set(CMAKE_AUTOUIC ON)
@@ -213,6 +219,7 @@ target_link_libraries(
         Qt5::DBus
         Qt5::Network
         Qt5::Widgets
+        Qt5::PrintSupport
         ${QTSINGLEAPPLICATION_LIBRARY}
         QtColorWidgets
 

diff --git a/src/core/CMakeLists.txt b/src/core/CMakeLists.txt
@@ -3,6 +3,8 @@ target_sources(flameshot PRIVATE
     flameshotdaemon.h
     flameshotdbusadapter.h
     qguiappcurrentscreen.h
+    pluginmanager.h
+    corepluginInterface.h
 )
 
 target_sources(flameshot PRIVATE
@@ -11,6 +13,7 @@ target_sources(flameshot PRIVATE
     flameshotdaemon.cpp
     flameshotdbusadapter.cpp
     qguiappcurrentscreen.cpp
+    pluginmanager.cpp
 )
 
 IF (WIN32)

diff --git a/src/core/capturerequest.h b/src/core/capturerequest.h
@@ -27,6 +27,8 @@ class CaptureRequest
         PIN = 16,
         UPLOAD = 32,
         ACCEPT_ON_SELECT = 64,
+        PRINT_SYSTEM = 128,
+        SAVE_TO_PDF = 256
     };
 
     CaptureRequest(CaptureMode mode,

diff --git a/src/core/corepluginInterface.h b/src/core/corepluginInterface.h
@@ -0,0 +1,20 @@
+#ifndef COREPLUGININTERFACE_H
+#define COREPLUGININTERFACE_H
+
+#include <QtPlugin>
+
+class CorePluginInterface {
+public:
+    virtual ~CorePluginInterface() = 0;
+    virtual bool load(std::map<std::string, std::string> &PluginConfig) = 0;
+    virtual void unload() = 0;
+    virtual bool ImagePost(QPixmap &pixmap) = 0;
+    virtual bool ImageToPDFPost(QPixmap &pixmap) = 0;
+    virtual bool PrintPre(QPixmap &pixmap) = 0;
+};
+
+#define FlameshotPlugin_iid "FlameshotPlugin.CorePluginInterface"
+
+Q_DECLARE_INTERFACE(CorePluginInterface, FlameshotPlugin_iid)
+
+#endif // COREPLUGININTERFACE_H