Changeset 51476 in vbox for trunk/src/VBox/Main/include

Timestamp:

May 30, 2014 2:58:02 PM (11 years ago)

Author:

vboxsync

Message:

DnD: API overhaul; now using IDnDTarget + IDnDSource. Renamed DragAndDrop* enumerations to DnD*. Also rewrote some internal code.

Location:

trunk/src/VBox

Files:

• . (modified) (1 prop)
• Main/include/ConsoleImpl.h (modified) (2 diffs)
• Main/include/DisplayImpl.h (modified) (3 diffs)
• Main/include/GuestDnDPrivate.h (moved) (moved from trunk/src/VBox/Main/include/GuestDnDImpl.h ) (2 diffs)
• Main/include/GuestDnDSourceImpl.h (added)
• Main/include/GuestDnDTargetImpl.h (added)
• Main/include/GuestImpl.h (modified) (10 diffs)
• Main/include/MachineImpl.h (modified) (4 diffs)
• Main/include/SessionImpl.h (modified) (2 diffs)

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

@@ -220 +220 @@
     HRESULT onCPUExecutionCapChange(ULONG aExecutionCap);
     HRESULT onClipboardModeChange(ClipboardMode_T aClipboardMode);
-    HRESULT onDragAndDropModeChange(DragAndDropMode_T aDragAndDropMode);
+    HRESULT onDnDModeChange(DnDMode_T aDnDMode);
     HRESULT onVRDEServerChange(BOOL aRestart);
     HRESULT onVideoCaptureChange();
@@ -699 +699 @@
 
     void changeClipboardMode(ClipboardMode_T aClipboardMode);
-    void changeDragAndDropMode(DragAndDropMode_T aDragAndDropMode);
+    int changeDnDMode(DnDMode_T aDnDMode);
 
 #ifdef VBOX_WITH_USB

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

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2006-2013 Oracle Corporation
+ * Copyright (C) 2006-2014 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -66 +66 @@
     uint16_t flags;
 
-    /* for saving the rectangles arrived during fb resize is in progress. */
+    /** For saving the rectangles arrived during fb resize is in progress. */
     PRTRECT mpSavedVisibleRegion;
     uint32_t mcSavedVisibleRegion;
@@ -74 +74 @@
     volatile uint32_t u32ResizeStatus;
 
-    /* The Framebuffer has default format and must be updates immediately. */
+    /** The framebuffer has default format and must be updates immediately. */
     bool fDefaultFormat;
 

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

@@ +1 @@
+/* $Id$ */
 /** @file
- * Definition of GuestDnD
+ * Private guest drag and drop code, used by GuestDnDTarget +
+ * GuestDnDSource.
  */
 
@@ -15 +17 @@
  */
 
-#ifndef ____H_GUESTDND
-#define ____H_GUESTDND
+#ifndef ____H_GUESTDNDPRIVATE
+#define ____H_GUESTDNDPRIVATE
 
-/* Forward declaration of the d-pointer. */
-class GuestDnDPrivate;
-#ifdef VBOX_WITH_DRAG_AND_DROP_GH
- class DnDGuestResponse;
-#endif
+#include "VBox/hgcmsvc.h" /* For PVBOXHGCMSVCPARM. */
 
+/* Forward prototype declarations. */
+class Guest;
+class Progress;
+
+/**
+ * Class for handling drag'n drop responses from
+ * the guest side.
+ */
+class GuestDnDResponse
+{
+
+public:
+
+    GuestDnDResponse(const ComObjPtr<Guest>& pGuest);
+
+    virtual ~GuestDnDResponse(void);
+
+public:
+
+    int notifyAboutGuestResponse(void);
+    int waitForGuestResponse(RTMSINTERVAL msTimeout = 500);
+
+    void setDefAction(uint32_t a) { m_defAction = a; }
+    uint32_t defAction(void) const { return m_defAction; }
+
+    void setAllActions(uint32_t a) { m_allActions = a; }
+    uint32_t allActions() const { return m_allActions; }
+
+    void setFormat(const Utf8Str &strFormat) { m_strFormat = strFormat; }
+    Utf8Str format(void) const { return m_strFormat; }
+
+    void setDropDir(const Utf8Str &strDropDir) { m_strDropDir = strDropDir; }
+    Utf8Str dropDir(void) const { return m_strDropDir; }
+
+    int dataAdd(const void *pvData, uint32_t cbData, uint32_t *pcbCurSize);
+    int dataSetStatus(size_t cbDataAdd, size_t cbDataTotal = 0);
+    void reset(void);
+    const void *data(void) { return m_pvData; }
+    size_t size(void) const { return m_cbData; }
+
+    int setProgress(unsigned uPercentage, uint32_t uState, int rcOp = VINF_SUCCESS);
+    HRESULT resetProgress(const ComObjPtr<Guest>& pParent);
+    HRESULT queryProgressTo(IProgress **ppProgress);
+
+    int writeToFile(const char *pszPath, size_t cbPath, void *pvData, size_t cbData, uint32_t fMode);
+
+public:
+
+    Utf8Str errorToString(const ComObjPtr<Guest>& pGuest, int guestRc);
+
+private:
+    RTSEMEVENT           m_EventSem;
+    uint32_t             m_defAction;
+    uint32_t             m_allActions;
+    Utf8Str              m_strFormat;
+
+    /** The actual MIME data.*/
+    void                *m_pvData;
+    /** Size (in bytes) of MIME data. */
+    uint32_t             m_cbData;
+
+    size_t               m_cbDataCurrent;
+    size_t               m_cbDataTotal;
+    /** Dropped files directory on the host. */
+    Utf8Str              m_strDropDir;
+    /** The handle of the currently opened file being written to
+     *  or read from. */
+    RTFILE               m_hFile;
+    Utf8Str              m_strFile;
+
+    ComObjPtr<Guest>     m_parent;
+    ComObjPtr<Progress>  m_progress;
+};
+
+/**
+ * Private singleton class for the guest's DnD
+ * implementation. Can't be instanciated directly, only via
+ * the factory pattern.
+ */
 class GuestDnD
 {
 public:
+
+    static GuestDnD *createInstance(const ComObjPtr<Guest>& pGuest)
+    {
+        Assert(NULL == GuestDnD::s_pInstance);
+        GuestDnD::s_pInstance = new GuestDnD(pGuest);
+        return GuestDnD::s_pInstance;
+    }
+
+    static void destroyInstance(void)
+    {
+        if (GuestDnD::s_pInstance)
+        {
+            delete GuestDnD::s_pInstance;
+            GuestDnD::s_pInstance = NULL;
+        }
+    }
+
+    static inline GuestDnD *getInstance(void)
+    {
+        AssertPtr(GuestDnD::s_pInstance);
+        return GuestDnD::s_pInstance;
+    }
+
+protected:
+
     GuestDnD(const ComObjPtr<Guest>& pGuest);
-    ~GuestDnD();
+    virtual ~GuestDnD(void);
 
-    /* Host -> Guest */
-    HRESULT dragHGEnter(ULONG uScreenId, ULONG uX, ULONG uY, DragAndDropAction_T defaultAction, ComSafeArrayIn(DragAndDropAction_T, allowedActions), ComSafeArrayIn(IN_BSTR, formats), DragAndDropAction_T *pResultAction);
-    HRESULT dragHGMove(ULONG uScreenId, ULONG uX, ULONG uY, DragAndDropAction_T defaultAction, ComSafeArrayIn(DragAndDropAction_T, allowedActions), ComSafeArrayIn(IN_BSTR, formats), DragAndDropAction_T *pResultAction);
-    HRESULT dragHGLeave(ULONG uScreenId);
-    HRESULT dragHGDrop(ULONG uScreenId, ULONG uX, ULONG uY, DragAndDropAction_T defaultAction, ComSafeArrayIn(DragAndDropAction_T, allowedActions), ComSafeArrayIn(IN_BSTR, formats), BSTR *pstrFormat, DragAndDropAction_T *pResultAction);
-    HRESULT dragHGPutData(ULONG uScreenId, IN_BSTR wstrFormat, ComSafeArrayIn(BYTE, data), IProgress **ppProgress);
+public:
 
-    /* Guest -> Host */
-    HRESULT dragGHPending(ULONG uScreenId, ComSafeArrayOut(BSTR, formats), ComSafeArrayOut(DragAndDropAction_T, allowedActions), DragAndDropAction_T *pDefaultAction);
-    HRESULT dragGHDropped(IN_BSTR bstrFormat, DragAndDropAction_T action, IProgress **ppProgress);
-    HRESULT dragGHGetData(ComSafeArrayOut(BYTE, data));
+    /** @name Public helper functions.
+     * @{ */
+    int                        adjustScreenCoordinates(ULONG uScreenId, ULONG *puX, ULONG *puY) const;
+    int                        hostCall(uint32_t u32Function, uint32_t cParms, PVBOXHGCMSVCPARM paParms) const;
+    GuestDnDResponse          *response(void) { return m_pResponse; }
+    std::vector<com::Utf8Str>  supportedFormats(void) const { return m_strSupportedFormats; }
+    /** @}  */
 
-    /* Guest response */
-    static DECLCALLBACK(int) notifyGuestDragAndDropEvent(void *pvExtension, uint32_t u32Function, void *pvParms, uint32_t cbParms);
+public:
+
+    /** @name Static low-level HGCM callback handler.
+     * @{ */
+    static DECLCALLBACK(int)   notifyDnDDispatcher(void *pvExtension, uint32_t u32Function, void *pvParms, uint32_t cbParms);
+    /** @}  */
+
+    /** @name Static helper methods.
+     * @{ */
+    static com::Utf8Str        toFormatString(const std::vector<com::Utf8Str> &lstSupportedFormats, const std::vector<com::Utf8Str> &lstFormats);
+    static void                toFormatVector(const std::vector<com::Utf8Str> &lstSupportedFormats, const com::Utf8Str &strFormats, std::vector<com::Utf8Str> &vecformats);
+    static DnDAction_T         toMainAction(uint32_t uAction);
+    static void                toMainActions(uint32_t uActions, std::vector<DnDAction_T> &vecActions);
+    static uint32_t            toHGCMAction(DnDAction_T enmAction);
+    static void                toHGCMActions(DnDAction_T enmDefAction, uint32_t *puDefAction, const std::vector<DnDAction_T> vecAllowedActions, uint32_t *puAllowedActions);
+    /** @}  */
+
+protected:
+
+    /** @name Singleton properties.
+     * @{ */
+    /** List of supported MIME types (formats). */
+    std::vector<com::Utf8Str>  m_strSupportedFormats;
+    /** Pointer to guest implementation. */
+    const ComObjPtr<Guest>     m_pGuest;
+    /** The current (last) response from the guest. At the
+     *  moment we only support only response a time (ARQ-style). */
+    GuestDnDResponse          *m_pResponse;
+    /** @}  */
 
 protected:
 
 #ifdef VBOX_WITH_DRAG_AND_DROP_GH
-    int onGHSendData(DnDGuestResponse *pResp, const void *pvData, size_t cbData, size_t cbTotalSize);
-    int onGHSendDir(DnDGuestResponse *pResp, const char *pszPath, size_t cbPath, uint32_t fMode);
-    int onGHSendFile(DnDGuestResponse *pResp, const char *pszPath, size_t cbPath, void *pvData, size_t cbData, uint32_t fMode);
+    /** @name Dispatch handlers for the HGCM callbacks.
+     * @{ */
+    int onGHSendData(GuestDnDResponse *pResp, const void *pvData, size_t cbData, size_t cbTotalSize);
+    int onGHSendDir(GuestDnDResponse *pResp, const char *pszPath, size_t cbPath, uint32_t fMode);
+    int onGHSendFile(GuestDnDResponse *pResp, const char *pszPath, size_t cbPath, void *pvData, size_t cbData, uint32_t fMode);
+    /** @}  */
 #endif /* VBOX_WITH_DRAG_AND_DROP_GH */
 
 private:
 
-    /* d-pointer */
-    GuestDnDPrivate *d_ptr;
-
-    friend class GuestDnDPrivate;
+    /** Staic pointer to singleton instance. */
+    static GuestDnD           *s_pInstance;
 };
 
-#endif /* ____H_GUESTDND */
+/** Access to the GuestDnD's singleton instance. */
+#define GuestDnDInst() GuestDnD::getInstance()
 
+#endif /* ____H_GUESTDNDPRIVATE */
+

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

@@ -4 +4 @@
 
 /*
- * Copyright (C) 2006-2013 Oracle Corporation
+ * Copyright (C) 2006-2014 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -26 +26 @@
 #include "AdditionsFacilityImpl.h"
 #include "GuestCtrlImplPrivate.h"
+#ifdef VBOX_WITH_DRAG_AND_DROP
+# include "GuestDnDSourceImpl.h"
+# include "GuestDnDTargetImpl.h"
+#endif
 #include "GuestSessionImpl.h"
 #include "HGCM.h"
-
-#ifdef VBOX_WITH_DRAG_AND_DROP
-class GuestDnD;
-#endif
 
 typedef enum
@@ -48 +48 @@
 
 class Console;
-#ifdef VBOX_WITH_GUEST_CONTROL
-class Progress;
-#endif
 
 class ATL_NO_VTABLE Guest :
@@ -77 +74 @@
 
     // IGuest properties.
-    STDMETHOD(COMGETTER(OSTypeId)) (BSTR *aOSTypeId);
-    STDMETHOD(COMGETTER(AdditionsRunLevel)) (AdditionsRunLevelType_T *aRunLevel);
+    STDMETHOD(COMGETTER(OSTypeId))(BSTR *aOSTypeId);
+    STDMETHOD(COMGETTER(AdditionsRunLevel))(AdditionsRunLevelType_T *aRunLevel);
     STDMETHOD(COMGETTER(AdditionsVersion))(BSTR *a_pbstrAdditionsVersion);
     STDMETHOD(COMGETTER(AdditionsRevision))(ULONG *a_puAdditionsRevision);
+    STDMETHOD(COMGETTER(DnDSource))(IGuestDnDSource ** aSource);
+    STDMETHOD(COMGETTER(DnDTarget))(IGuestDnDTarget ** aTarget);
     STDMETHOD(COMGETTER(EventSource))(IEventSource ** aEventSource);
-    STDMETHOD(COMGETTER(Facilities)) (ComSafeArrayOut(IAdditionsFacility *, aFacilities));
-    STDMETHOD(COMGETTER(Sessions)) (ComSafeArrayOut(IGuestSession *, aSessions));
+    STDMETHOD(COMGETTER(Facilities))(ComSafeArrayOut(IAdditionsFacility *, aFacilities));
+    STDMETHOD(COMGETTER(Sessions))(ComSafeArrayOut(IGuestSession *, aSessions));
     STDMETHOD(COMGETTER(MemoryBalloonSize)) (ULONG *aMemoryBalloonSize);
     STDMETHOD(COMSETTER(MemoryBalloonSize)) (ULONG aMemoryBalloonSize);
@@ -93 +92 @@
     STDMETHOD(SetCredentials)(IN_BSTR aUsername, IN_BSTR aPassword,
                               IN_BSTR aDomain, BOOL aAllowInteractiveLogon);
-    // Drag'n drop support.
-    STDMETHOD(DragHGEnter)(ULONG uScreenId, ULONG uX, ULONG uY, DragAndDropAction_T defaultAction, ComSafeArrayIn(DragAndDropAction_T, allowedActions), ComSafeArrayIn(IN_BSTR, formats), DragAndDropAction_T *pResultAction);
-    STDMETHOD(DragHGMove)(ULONG uScreenId, ULONG uX, ULONG uY, DragAndDropAction_T defaultAction, ComSafeArrayIn(DragAndDropAction_T, allowedActions), ComSafeArrayIn(IN_BSTR, formats), DragAndDropAction_T *pResultAction);
-    STDMETHOD(DragHGLeave)(ULONG uScreenId);
-    STDMETHOD(DragHGDrop)(ULONG uScreenId, ULONG uX, ULONG uY, DragAndDropAction_T defaultAction, ComSafeArrayIn(DragAndDropAction_T, allowedActions), ComSafeArrayIn(IN_BSTR, formats), BSTR *pstrFormat, DragAndDropAction_T *pResultAction);
-    STDMETHOD(DragHGPutData)(ULONG uScreenId, IN_BSTR strFormat, ComSafeArrayIn(BYTE, data), IProgress **ppProgress);
-    STDMETHOD(DragGHPending)(ULONG uScreenId, ComSafeArrayOut(BSTR, formats), ComSafeArrayOut(DragAndDropAction_T, allowedActions), DragAndDropAction_T *pDefaultAction);
-    STDMETHOD(DragGHDropped)(IN_BSTR strFormat, DragAndDropAction_T action, IProgress **ppProgress);
-    STDMETHOD(DragGHGetData)(ComSafeArrayOut(BYTE, data));
     // Guest control.
     STDMETHOD(CreateSession)(IN_BSTR aUser, IN_BSTR aPassword, IN_BSTR aDomain, IN_BSTR aSessionName, IGuestSession **aGuestSession);
@@ -129 +119 @@
     bool facilityIsActive(VBoxGuestFacilityType enmFacility);
     void facilityUpdate(VBoxGuestFacilityType a_enmFacility, VBoxGuestFacilityStatus a_enmStatus, uint32_t a_fFlags, PCRTTIMESPEC a_pTimeSpecTS);
+    ComObjPtr<Console> getConsole(void) { return mParent; }
     void setAdditionsStatus(VBoxGuestFacilityType a_enmFacility, VBoxGuestFacilityStatus a_enmStatus, uint32_t a_fFlags, PCRTTIMESPEC a_pTimeSpecTS);
     void onUserStateChange(Bstr aUser, Bstr aDomain, VBoxGuestUserState enmState, const uint8_t *puDetails, uint32_t cbDetails);
@@ -142 +133 @@
     int         dispatchToSession(PVBOXGUESTCTRLHOSTCBCTX pCtxCb, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb);
     uint32_t    getAdditionsVersion(void) { return mData.mAdditionsVersionFull; }
-    Console    *getConsole(void) { return mParent; }
     int         sessionRemove(GuestSession *pSession);
     int         sessionCreate(const GuestSessionStartupInfo &ssInfo, const GuestCredentials &guestCreds, ComObjPtr<GuestSession> &pGuestSession);
@@ -170 +160 @@
         { }
 
-        Bstr                    mOSTypeId;
-        FacilityMap             mFacilityMap;
-        AdditionsRunLevelType_T mAdditionsRunLevel;
-        uint32_t                mAdditionsVersionFull;
-        Bstr                    mAdditionsVersionNew;
-        uint32_t                mAdditionsRevision;
-        uint32_t                mAdditionsFeatures;
-        Bstr                    mInterfaceVersion;
-        GuestSessions           mGuestSessions;
-        uint32_t                mNextSessionID;
+        Bstr                        mOSTypeId;
+        FacilityMap                 mFacilityMap;
+        AdditionsRunLevelType_T     mAdditionsRunLevel;
+        uint32_t                    mAdditionsVersionFull;
+        Bstr                        mAdditionsVersionNew;
+        uint32_t                    mAdditionsRevision;
+        uint32_t                    mAdditionsFeatures;
+        Bstr                        mInterfaceVersion;
+        GuestSessions               mGuestSessions;
+        uint32_t                    mNextSessionID;
     } mData;
 
@@ -192 +182 @@
     BOOL                            mfPageFusionEnabled;
 
-    Console                        *mParent;
+    const ComObjPtr<Console>        mParent;
 
 #ifdef VBOX_WITH_GUEST_CONTROL
@@ -206 +196 @@
 
 #ifdef VBOX_WITH_DRAG_AND_DROP
-    GuestDnD         *m_pGuestDnD;
-    friend class GuestDnD;
-    friend class GuestDnDPrivate;
-#endif
-
-    RTTIMERLR         mStatTimer;
-    uint32_t          mMagic;
+    /** The guest's DnD source. */
+    const ComObjPtr<GuestDnDSource> mDnDSource;
+    /** The guest's DnD target. */
+    const ComObjPtr<GuestDnDTarget> mDnDTarget;
+#endif
+
+    RTTIMERLR                       mStatTimer;
+    uint32_t                        mMagic; /** @todo r=andy Rename this to something more meaningful. */
 };
-#define GUEST_MAGIC 0xCEED2006u
+#define GUEST_MAGIC 0xCEED2006u /** @todo r=andy Not very well defined!? */
 
 #endif // ____H_GUESTIMPL

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

@@ -297 +297 @@
 
         ClipboardMode_T     mClipboardMode;
-        DragAndDropMode_T   mDragAndDropMode;
+        DnDMode_T           mDnDMode;
 
         typedef std::map<Utf8Str, GuestProperty> GuestPropertyMap;
@@ -473 +473 @@
     STDMETHOD(COMGETTER(ClipboardMode))(ClipboardMode_T *aClipboardMode);
     STDMETHOD(COMSETTER(ClipboardMode))(ClipboardMode_T aClipboardMode);
-    STDMETHOD(COMGETTER(DragAndDropMode))(DragAndDropMode_T *aDragAndDropMode);
-    STDMETHOD(COMSETTER(DragAndDropMode))(DragAndDropMode_T aDragAndDropMode);
+    STDMETHOD(COMGETTER(DnDMode))(DnDMode_T *aDnDMode);
+    STDMETHOD(COMSETTER(DnDMode))(DnDMode_T aDnDMode);
     STDMETHOD(COMGETTER(GuestPropertyNotificationPatterns))(BSTR *aPattern);
     STDMETHOD(COMSETTER(GuestPropertyNotificationPatterns))(IN_BSTR aPattern);
@@ -749 +749 @@
     virtual HRESULT onSharedFolderChange() { return S_OK; }
     virtual HRESULT onClipboardModeChange(ClipboardMode_T /* aClipboardMode */) { return S_OK; }
-    virtual HRESULT onDragAndDropModeChange(DragAndDropMode_T /* aDragAndDropMode */) { return S_OK; }
+    virtual HRESULT onDnDModeChange(DnDMode_T /* aDnDMode */) { return S_OK; }
     virtual HRESULT onBandwidthGroupChange(IBandwidthGroup * /* aBandwidthGroup */) { return S_OK; }
     virtual HRESULT onStorageDeviceChange(IMediumAttachment * /* mediumAttachment */, BOOL /* remove */, BOOL /* silent */) { return S_OK; }
@@ -1139 +1139 @@
     HRESULT onSharedFolderChange();
     HRESULT onClipboardModeChange(ClipboardMode_T aClipboardMode);
-    HRESULT onDragAndDropModeChange(DragAndDropMode_T aDragAndDropMode);
+    HRESULT onDnDModeChange(DnDMode_T aDnDMode);
     HRESULT onBandwidthGroupChange(IBandwidthGroup *aBandwidthGroup);
     HRESULT onStorageDeviceChange(IMediumAttachment *aMediumAttachment, BOOL aRemove, BOOL aSilent);

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

@@ -4 +4 @@
 
 /*
- * Copyright (C) 2006-2013 Oracle Corporation
+ * Copyright (C) 2006-2014 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -92 +92 @@
     STDMETHOD(OnSharedFolderChange)(BOOL aGlobal);
     STDMETHOD(OnClipboardModeChange)(ClipboardMode_T aClipboardMode);
-    STDMETHOD(OnDragAndDropModeChange)(DragAndDropMode_T aDragAndDropMode);
+    STDMETHOD(OnDnDModeChange)(DnDMode_T aDnDMode);
     STDMETHOD(OnUSBDeviceAttach)(IUSBDevice *aDevice, IVirtualBoxErrorInfo *aError, ULONG aMaskedIfs);
     STDMETHOD(OnUSBDeviceDetach)(IN_BSTR aId, IVirtualBoxErrorInfo *aError);