Changeset 100651 in vbox

Timestamp:

Jul 19, 2023 11:52:59 AM (18 months ago)

Author:

vboxsync

Message:

Shared Clipboard: Also give the registered service extension the chance of calling an optional callback. Only used by VRDE so far (and probably never will be used by anything else, historical reasons). bugref:9437

Location:

trunk/src/VBox/Main

Files:

• include/GuestShClPrivate.h (modified) (3 diffs)
• src-client/GuestShClPrivate.cpp (modified) (5 diffs)

trunk/src/VBox/Main/include/GuestShClPrivate.h

@@ -32 +32 @@
 #endif
 
+#include <VBox/HostServices/VBoxClipboardExt.h>
+
 /**
  * Forward prototype declarations.
@@ -44 +46 @@
     /** Service extension callback function.
      *  Setting this to NULL deactivates the extension. */
-    PFNHGCMSVCEXT    pfnExt;
+    PFNHGCMSVCEXT      pfnExt;
     /** User-supplied service extension data. Might be NULL if not being used. */
-    void            *pvExt;
+    void            *  pvExt;
+    /** Pointer to an optional extension callback.
+     *  Might be NULL if not being used. */
+    PFNSHCLEXTCALLBACK pfnExtCallback;
 };
 /** Pointer to a Shared Clipboard service extension. */
@@ -136 +141 @@
     /** Pointer an additional service extension handle to serve (daisy chaining).
      *
-     *  This currently only is being used by the Console VRDP server helper class.
-     *  We might want to transform this into a map later if we (ever) need more than one service extension. */
+     *  This currently only is being used by the Console VRDP server helper class (historical reasons).
+     *  We might want to transform this into a map later if we (ever) need more than one service extension,
+     *  or drop this concept althogether when we move the service stuff out of the VM process (later). */
     SHCLSVCEXT                  m_SvcExtVRDP;
+    /** Pointer to an optional extension callback.
+     *  Might be NULL if not being used. */
+    PFNSHCLEXTCALLBACK          m_pfnExtCallback;
     /** @}  */
 

trunk/src/VBox/Main/src-client/GuestShClPrivate.cpp

@@ -60 +60 @@
 GuestShCl::GuestShCl(Console *pConsole)
     : m_pConsole(pConsole)
+    , m_pfnExtCallback(NULL)
 {
     LogFlowFuncEnter();
@@ -86 +87 @@
 
     RT_ZERO(m_SvcExtVRDP);
+
+    m_pfnExtCallback = NULL;
 }
 
@@ -122 +125 @@
 {
     AssertPtrReturn(pfnExtension, VERR_INVALID_POINTER);
+    /* pvExtension is optional. */
 
     lock();
 
+    LogFlowFunc(("m_pfnExtCallback=%p\n", this->m_pfnExtCallback));
+
     PSHCLSVCEXT pExt = &this->m_SvcExtVRDP; /* Currently we only have one extension only. */
 
     Assert(pExt->pfnExt == NULL);
 
-    pExt->pfnExt = pfnExtension;
-    pExt->pvExt  = pvExtension;
+    pExt->pfnExt         = pfnExtension;
+    pExt->pvExt          = pvExtension;
+    pExt->pfnExtCallback = this->m_pfnExtCallback; /* Assign callback function. Optional and can be NULL. */
+
+    if (pExt->pfnExtCallback)
+    {
+        /* Make sure to also give the extension the ability to use the callback. */
+        SHCLEXTPARMS parms;
+        RT_ZERO(parms);
+
+        parms.u.SetCallback.pfnCallback = pExt->pfnExtCallback;
+
+        /* ignore rc, callback is optional */ pExt->pfnExt(pExt->pvExt,
+                                                           VBOX_CLIPBOARD_EXT_FN_SET_CALLBACK, &parms, sizeof(parms));
+    }
 
     unlock();
@@ -153 +172 @@
     AssertReturnStmt(pExt->pfnExt == pfnExtension, unlock(), VERR_INVALID_PARAMETER);
     AssertPtr(pExt->pfnExt);
+
+    /* Unregister the callback (setting to NULL). */
+    SHCLEXTPARMS parms;
+    RT_ZERO(parms);
+
+    /* ignore rc, callback is optional */ pExt->pfnExt(pExt->pvExt,
+                                                       VBOX_CLIPBOARD_EXT_FN_SET_CALLBACK, &parms, sizeof(parms));
 
     RT_BZERO(pExt, sizeof(SHCLSVCEXT));
@@ -244 +270 @@
     switch (u32Function)
     {
+        case VBOX_CLIPBOARD_EXT_FN_SET_CALLBACK:
+            pThis->m_pfnExtCallback = pParms->u.SetCallback.pfnCallback;
+            vrc = VINF_SUCCESS;
+            break;
+
         case VBOX_CLIPBOARD_EXT_FN_ERROR:
         {