Replace USE_WAYLAND_GRIM build option with useGrimAdapter setting (flameshot-org#3919)

Author: q4a

flameshot.example.ini

@@ -51,6 +51,9 @@
 ;; Whether the tray icon is disabled (bool)
 ;disabledTrayIcon=false
 ;
+;; Use grim-based wayland universal screenshot adapter
+;useGrimAdapter=false
+;
 ;; Disable Grim Warning notification
 ;disabledGrimWarning=true
 ;

src/CMakeLists.txt

@@ -220,17 +220,10 @@ target_link_libraries(
 )
 
 if (USE_WAYLAND_CLIPBOARD)
-  if(!USE_WAYLAND_GRIM)
-    message(WARNING "You activated the USE_WAYLAND_CLIPBOARD option, but did not activate the USE_WAYLAND_GRIM option. Flameshot will use the dbus protocol to support wayland. If you use wlroots-based wayland, it is recommended to enable USE_WAYLAND_GRIM")
-  endif()
   target_compile_definitions(flameshot PRIVATE USE_WAYLAND_CLIPBOARD=1)
   target_link_libraries(flameshot KF5::GuiAddons)
 endif()
 
-if (USE_WAYLAND_GRIM)
-    target_compile_definitions(flameshot PRIVATE USE_WAYLAND_GRIM=1)
-endif()
-
 if (APPLE)
     set(MACOSX_BUNDLE_IDENTIFIER "org.flameshot")
     set_target_properties(

src/utils/confighandler.cpp

@@ -79,6 +79,7 @@ static QMap<class QString, QSharedPointer<ValueHandler>>
     OPTION("showDesktopNotification"     ,Bool               ( true          )),
     OPTION("showAbortNotification"       ,Bool               ( true          )),
     OPTION("disabledTrayIcon"            ,Bool               ( false         )),
+    OPTION("useGrimAdapter"              ,Bool               ( false         )),
     OPTION("disabledGrimWarning"         ,Bool               ( false         )),
     OPTION("historyConfirmationToDelete" ,Bool               ( true          )),
 #if !defined(DISABLE_UPDATE_CHECKER)

src/utils/confighandler.h

@@ -89,6 +89,7 @@ class ConfigHandler : public QObject
     CONFIG_GETTER_SETTER(showAbortNotification, setShowAbortNotification, bool)
     CONFIG_GETTER_SETTER(filenamePattern, setFilenamePattern, QString)
     CONFIG_GETTER_SETTER(disabledTrayIcon, setDisabledTrayIcon, bool)
+    CONFIG_GETTER_SETTER(useGrimAdapter, useGrimAdapter, bool)
     CONFIG_GETTER_SETTER(disabledGrimWarning, disabledGrimWarning, bool)
     CONFIG_GETTER_SETTER(drawThickness, setDrawThickness, int)
     CONFIG_GETTER_SETTER(drawFontSize, setDrawFontSize, int)

src/utils/screengrabber.cpp

@@ -29,8 +29,11 @@ ScreenGrabber::ScreenGrabber(QObject* parent)
 
 void ScreenGrabber::generalGrimScreenshot(bool& ok, QPixmap& res)
 {
-#ifdef USE_WAYLAND_GRIM
 #if defined(Q_OS_LINUX) || defined(Q_OS_UNIX)
+    if (!ConfigHandler().useGrimAdapter()) {
+        return;
+    }
+
     QString runDir =
       QProcessEnvironment::systemEnvironment().value("XDG_RUNTIME_DIR");
     QString imgPath = runDir + "/flameshot.ppm";
@@ -53,7 +56,6 @@ void ScreenGrabber::generalGrimScreenshot(bool& ok, QPixmap& res)
                 "capture component is missing, please install it!");
     }
 #endif
-#endif
 }
 
 void ScreenGrabber::freeDesktopPortal(bool& ok, QPixmap& res)
@@ -162,26 +164,26 @@ QPixmap ScreenGrabber::grabEntireDesktop(bool& ok)
             case DesktopInfo::SWAY:
             case DesktopInfo::HYPRLAND:
             case DesktopInfo::OTHER: {
-#ifndef USE_WAYLAND_GRIM
-                if (!ConfigHandler().disabledGrimWarning()) {
-                    AbstractLogger::warning() << tr(
-                      "If the USE_WAYLAND_GRIM option is not activated, the "
-                      "dbus protocol will be used. It should be noted that "
-                      "using the dbus protocol under wayland is not "
-                      "recommended. It is recommended to recompile with the "
-                      "USE_WAYLAND_GRIM flag to activate the grim-based "
-                      "general wayland screenshot adapter");
+                if (!ConfigHandler().useGrimAdapter()) {
+                    if (!ConfigHandler().disabledGrimWarning()) {
+                        AbstractLogger::warning() << tr(
+                          "If the useGrimAdapter setting is not enabled, the "
+                          "dbus protocol will be used. It should be noted that "
+                          "using the dbus protocol under wayland is not "
+                          "recommended. It is recommended to enable the "
+                          "useGrimAdapter setting in flameshot.ini to activate "
+                          "the grim-based general wayland screenshot adapter");
+                    }
+                    freeDesktopPortal(ok, res);
+                } else {
+                    if (!ConfigHandler().disabledGrimWarning()) {
+                        AbstractLogger::warning() << tr(
+                          "grim's screenshot component is implemented based on "
+                          "wlroots, it may not be used in GNOME or similar "
+                          "desktop environments");
+                    }
+                    generalGrimScreenshot(ok, res);
                 }
-                freeDesktopPortal(ok, res);
-#else
-                if (!ConfigHandler().disabledGrimWarning()) {
-                    AbstractLogger::warning() << tr(
-                      "grim's screenshot component is implemented based on "
-                      "wlroots, it may not be used in GNOME or similar "
-                      "desktop environments");
-                }
-                generalGrimScreenshot(ok, res);
-#endif
                 break;
             }
             default: