Changeset 34086 in vbox for trunk/include/VBox/ExtPack/ExtPack.h

Timestamp:

Nov 15, 2010 5:45:50 PM (14 years ago)

Author:

vboxsync

Message:

Main: Pass more IVirtualBox pointers to the extension pack. VRDE registration hook, VirtualBoxReady hook.

File:

• trunk/include/VBox/ExtPack/ExtPack.h (modified) (8 diffs)

trunk/include/VBox/ExtPack/ExtPack.h

@@ -29 +29 @@
 #include <VBox/types.h>
 
-#if defined(__cplusplus)
-class IConsole;
-class IMachine;
+/** @def VBOXEXTPACK_IF_CS
+ * Selects 'class' on 'struct' for interface references.
+ * @param I         The interface name
+ */
+#if defined(__cplusplus) && !defined(RT_OS_WINDOWS)
+# define VBOXEXTPACK_IF_CS(I)   class I
 #else
-typedef struct IConsole IConsole;
-typedef struct IMachine IMachine;
+# define VBOXEXTPACK_IF_CS(I)   struct I
 #endif
+
+VBOXEXTPACK_IF_CS(IConsole);
+VBOXEXTPACK_IF_CS(IMachine);
+VBOXEXTPACK_IF_CS(IVirtualBox);
 
 
@@ -92 +98 @@
     DECLR3CALLBACKMEMBER(int, pfnGetFilePath,(PCVBOXEXTPACKHLP pHlp, const char *pszFilename, char *pszPath, size_t cbPath));
 
+    /**
+     * Registers a VRDE library (IVirtualBox::VRDERegisterLibrary wrapper).
+     *
+     * @returns VBox status code.
+     * @param   pHlp            Pointer to this helper structure.
+     * @param   pszName         The module base name.  This will be found using
+     *                          the pfnFindModule algorithm.
+     * @param   fSetDefault     Whether to make it default if no other default
+     *                          is set.
+     *
+     * @remarks This helper should be called from pfnVirtualBoxReady as it may
+     *          cause trouble when called from pfnInstalled.
+     */
+    DECLR3CALLBACKMEMBER(int, pfnRegisterVrde,(PCVBOXEXTPACKHLP pHlp, const char *pszName, bool fSetDefault));
 
     /** End of structure marker (VBOXEXTPACKHLP_VERSION). */
@@ -119 +139 @@
      *
      * @param   pThis       Pointer to this structure.
-     */
-    DECLCALLBACKMEMBER(void, pfnInstalled)(PCVBOXEXTPACKREG pThis);
+     * @param   pVirtualBox The VirtualBox interface.
+     */
+    DECLCALLBACKMEMBER(void, pfnInstalled)(PCVBOXEXTPACKREG pThis, VBOXEXTPACK_IF_CS(IVirtualBox) *pVirtualBox);
 
     /**
@@ -129 +150 @@
      * @returns VBox status code.
      * @param   pThis       Pointer to this structure.
-     */
-    DECLCALLBACKMEMBER(int, pfnUninstall)(PCVBOXEXTPACKREG pThis);
+     * @param   pVirtualBox The VirtualBox interface.
+     */
+    DECLCALLBACKMEMBER(int, pfnUninstall)(PCVBOXEXTPACKREG pThis, VBOXEXTPACK_IF_CS(IVirtualBox) *pVirtualBox);
+
+    /**
+     * Hook for doing work after the VirtualBox object is ready.
+     *
+     * This is called in the context of the per-user service (VBoxSVC).  There
+     * will not be any similar call from the VM process.
+     *
+     * @param   pThis       Pointer to this structure.
+     * @param   pVirtualBox The VirtualBox interface.
+     */
+    DECLCALLBACKMEMBER(void, pfnVirtualBoxReady)(PCVBOXEXTPACKREG pThis, VBOXEXTPACK_IF_CS(IVirtualBox) *pVirtualBox);
 
     /**
@@ -153 +186 @@
      * @returns VBox status code.
      * @param   pThis       Pointer to this structure.
+     * @param   pVirtualBox The VirtualBox interface.
      * @param   pMachine    The machine interface.
      */
-    DECLCALLBACKMEMBER(int, pfnVMCreated)(PCVBOXEXTPACKREG pThis, IMachine *pMachine);
+    DECLCALLBACKMEMBER(int, pfnVMCreated)(PCVBOXEXTPACKREG pThis, VBOXEXTPACK_IF_CS(IVirtualBox) *pVirtualBox,
+                                          VBOXEXTPACK_IF_CS(IMachine) *pMachine);
 
     /**
@@ -167 +202 @@
      * @param   pVM         The VM handle.
      */
-    DECLCALLBACKMEMBER(int, pfnVMConfigureVMM)(PCVBOXEXTPACKREG pThis, IConsole *pConsole, PVM pVM);
+    DECLCALLBACKMEMBER(int, pfnVMConfigureVMM)(PCVBOXEXTPACKREG pThis, VBOXEXTPACK_IF_CS(IConsole) *pConsole, PVM pVM);
 
     /**
@@ -179 +214 @@
      * @param   pVM         The VM handle.
      */
-    DECLCALLBACKMEMBER(int, pfnVMPowerOn)(PCVBOXEXTPACKREG pThis, IConsole *pConsole, PVM pVM);
+    DECLCALLBACKMEMBER(int, pfnVMPowerOn)(PCVBOXEXTPACKREG pThis, VBOXEXTPACK_IF_CS(IConsole) *pConsole, PVM pVM);
 
     /**
@@ -190 +225 @@
      * @param   pVM         The VM handle.  Can be NULL.
      */
-    DECLCALLBACKMEMBER(void, pfnVMPowerOff)(PCVBOXEXTPACKREG pThis, IConsole *pConsole, PVM pVM);
+    DECLCALLBACKMEMBER(void, pfnVMPowerOff)(PCVBOXEXTPACKREG pThis, VBOXEXTPACK_IF_CS(IConsole) *pConsole, PVM pVM);
 
     /**