From cd018b6ba3a53776ce1fa3a7daaf30ff23b537fe Mon Sep 17 00:00:00 2001
From: Vlad Zahorodnii <vlad.zahorodnii@kde.org>
Date: Sat, 30 Oct 2021 19:11:13 +0300
Subject: [PATCH] effects/screenshot: Add
 org.kde.KWin.ScreenShot2.CaptureActiveScreen

The new method can be used to implement the "Current Screen" capture
mode in Spectacle.
---
 .../screenshot/org.kde.KWin.ScreenShot2.xml   | 40 +++++++++++++++++++
 .../screenshot/screenshotdbusinterface2.cpp   | 26 ++++++++++++
 .../screenshot/screenshotdbusinterface2.h     |  2 +
 3 files changed, 68 insertions(+)

diff --git a/src/effects/screenshot/org.kde.KWin.ScreenShot2.xml b/src/effects/screenshot/org.kde.KWin.ScreenShot2.xml
index a84cdc8a0c..8a726d45a7 100644
--- a/src/effects/screenshot/org.kde.KWin.ScreenShot2.xml
+++ b/src/effects/screenshot/org.kde.KWin.ScreenShot2.xml
@@ -191,6 +191,46 @@
             <arg name="results" type="a{sv}" direction="out" />
         </method>
 
+        <!--
+            CaptureActiveScreen:
+            @options: Optional vardict with screenshot options
+            @pipe: The pipe file descriptor where the screenshot will be written
+
+            Take a screenshot of the active monitor. The application that
+            requests the screenshot must have the org.kde.KWin.ScreenShot2
+            interface listed in the X-KDE-DBUS-Restricted-Interfaces desktop file
+            entry.
+
+            Supported since version 2.
+
+            Available @options include:
+
+            * "include-cursor" (b): Whether the cursor should be included.
+                                    Defaults to false
+            * "native-resolution" (b): Whether the screenshot should be in
+                                       native size. Defaults to false
+
+            The following results get returned via the @results vardict:
+
+            * "type" (s): The type of the image written to the pipe. Currently,
+                          the only supported type is "raw"
+            * "width" (u): The width of the image. Available only if the image
+                           type is "raw"
+            * "height" (u): The height of the image. Available only if the image
+                            type is "raw"
+            * "stride" (u): The number of bytes per row. Available only if the
+                            image type is "raw"
+            * "format" (u): The image format, as defined in QImage::Format.
+                            Available only if the image type is "raw"
+        -->
+        <method name="CaptureActiveScreen">
+            <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap" />
+            <arg name="options" type="a{sv}" direction="in" />
+            <arg name="pipe" type="h" direction="in" />
+            <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QVariantMap" />
+            <arg name="results" type="a{sv}" direction="out" />
+        </method>
+
         <!--
             CaptureInteractive:
             @kind: 0 - window, 1 - screen
diff --git a/src/effects/screenshot/screenshotdbusinterface2.cpp b/src/effects/screenshot/screenshotdbusinterface2.cpp
index d6bb7cf935..1d9c83a7fc 100644
--- a/src/effects/screenshot/screenshotdbusinterface2.cpp
+++ b/src/effects/screenshot/screenshotdbusinterface2.cpp
@@ -415,6 +415,32 @@ QVariantMap ScreenShotDBusInterface2::CaptureScreen(const QString &name,
     return QVariantMap();
 }
 
+QVariantMap ScreenShotDBusInterface2::CaptureActiveScreen(const QVariantMap &options,
+                                                          QDBusUnixFileDescriptor pipe)
+{
+    if (!checkPermissions()) {
+        return QVariantMap();
+    }
+
+    EffectScreen *screen = effects->activeScreen();
+    if (!screen) {
+        sendErrorReply(s_errorInvalidScreen, s_errorInvalidScreenMessage);
+        return QVariantMap();
+    }
+
+    const int fileDescriptor = dup(pipe.fileDescriptor());
+    if (fileDescriptor == -1) {
+        sendErrorReply(s_errorFileDescriptor, s_errorFileDescriptorMessage);
+        return QVariantMap();
+    }
+
+    takeScreenShot(screen, screenShotFlagsFromOptions(options),
+                   new ScreenShotSinkPipe2(fileDescriptor, message()));
+
+    setDelayedReply(true);
+    return QVariantMap();
+}
+
 QVariantMap ScreenShotDBusInterface2::CaptureInteractive(uint kind,
                                                          const QVariantMap &options,
                                                          QDBusUnixFileDescriptor pipe)
diff --git a/src/effects/screenshot/screenshotdbusinterface2.h b/src/effects/screenshot/screenshotdbusinterface2.h
index ac768a16ea..4bc472b8c5 100644
--- a/src/effects/screenshot/screenshotdbusinterface2.h
+++ b/src/effects/screenshot/screenshotdbusinterface2.h
@@ -49,6 +49,8 @@ public Q_SLOTS:
                             QDBusUnixFileDescriptor pipe);
     QVariantMap CaptureScreen(const QString &name, const QVariantMap &options,
                               QDBusUnixFileDescriptor pipe);
+    QVariantMap CaptureActiveScreen(const QVariantMap &options,
+                                    QDBusUnixFileDescriptor pipe);
     QVariantMap CaptureInteractive(uint kind, const QVariantMap &options,
                                    QDBusUnixFileDescriptor pipe);