VBoxDnD.h revision b35358a47f67398b71a08eb89e6617493a847f7d
/* $Id$ */
/** @file
* VBoxDnD.h - Windows-specific bits of the drag'n drop service.
*/
/*
* Copyright (C) 2013-2014 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*/
#ifndef __VBOXTRAYDND__H
#define __VBOXTRAYDND__H
#include <iprt/critsect.h>
#include <iprt/cpp/mtlist.h>
#include <iprt/cpp/ministring.h>
int VBoxDnDInit (const VBOXSERVICEENV *pEnv, void **ppInstance, bool *pfStartThread);
unsigned __stdcall VBoxDnDThread (void *pInstance);
void VBoxDnDStop (const VBOXSERVICEENV *pEnv, void *pInstance);
void VBoxDnDDestroy (const VBOXSERVICEENV *pEnv, void *pInstance);
class VBoxDnDWnd;
class VBoxDnDDataObject : public IDataObject
{
public:
enum Status
{
Uninitialized = 0,
Initialized,
Dropping,
Dropped,
Aborted
};
public:
VBoxDnDDataObject(FORMATETC *pFormatEtc = NULL, STGMEDIUM *pStgMed = NULL, ULONG cFormats = 0);
virtual ~VBoxDnDDataObject(void);
public:
static int CreateDataObject(FORMATETC *pFormatEtc, STGMEDIUM *pStgMeds,
ULONG cFormats, IDataObject **ppDataObject);
public: /* IUnknown methods. */
STDMETHOD(QueryInterface)(REFIID iid, void ** ppvObject);
STDMETHOD_(ULONG, AddRef)(void);
STDMETHOD_(ULONG, Release)(void);
public: /* IDataObject methods. */
STDMETHOD(GetData)(FORMATETC *pFormatEtc, STGMEDIUM *pMedium);
STDMETHOD(GetDataHere)(FORMATETC *pFormatEtc, STGMEDIUM *pMedium);
STDMETHOD(QueryGetData)(FORMATETC *pFormatEtc);
STDMETHOD(GetCanonicalFormatEtc)(FORMATETC *pFormatEct, FORMATETC *pFormatEtcOut);
STDMETHOD(SetData)(FORMATETC *pFormatEtc, STGMEDIUM *pMedium, BOOL fRelease);
STDMETHOD(EnumFormatEtc)(DWORD dwDirection, IEnumFORMATETC **ppEnumFormatEtc);
STDMETHOD(DAdvise)(FORMATETC *pFormatEtc, DWORD advf, IAdviseSink *pAdvSink, DWORD *pdwConnection);
STDMETHOD(DUnadvise)(DWORD dwConnection);
STDMETHOD(EnumDAdvise)(IEnumSTATDATA **ppEnumAdvise);
public:
static const char* ClipboardFormatToString(CLIPFORMAT fmt);
int Abort(void);
void SetStatus(Status status);
int Signal(const RTCString &strFormat, const void *pvData, uint32_t cbData);
protected:
bool LookupFormatEtc(FORMATETC *pFormatEtc, ULONG *puIndex);
static HGLOBAL MemDup(HGLOBAL hMemSource);
void RegisterFormat(FORMATETC *pFormatEtc, CLIPFORMAT clipFormat, TYMED tyMed = TYMED_HGLOBAL,
LONG lindex = -1, DWORD dwAspect = DVASPECT_CONTENT, DVTARGETDEVICE *pTargetDevice = NULL);
Status mStatus;
LONG mRefCount;
ULONG mcFormats;
FORMATETC *mpFormatEtc;
STGMEDIUM *mpStgMedium;
RTSEMEVENT mSemEvent;
RTCString mstrFormat;
void *mpvData;
uint32_t mcbData;
};
class VBoxDnDDropSource : public IDropSource
{
public:
VBoxDnDDropSource(VBoxDnDWnd *pThis);
virtual ~VBoxDnDDropSource(void);
public:
static int CreateDropSource(VBoxDnDWnd *pParent, IDropSource **ppDropSource);
public:
uint32_t GetCurrentAction(void) { return muCurAction; }
public: /* IUnknown methods. */
STDMETHOD(QueryInterface)(REFIID iid, void ** ppvObject);
STDMETHOD_(ULONG, AddRef)(void);
STDMETHOD_(ULONG, Release)(void);
public: /* IDropSource methods. */
STDMETHOD(QueryContinueDrag)(BOOL fEscapePressed, DWORD dwKeyState);
STDMETHOD(GiveFeedback)(DWORD dwEffect);
protected:
LONG mRefCount;
VBoxDnDWnd *mpWndParent;
uint32_t mClientID;
DWORD mdwCurEffect;
uint32_t muCurAction;
};
class VBoxDnDDropTarget : public IDropTarget
{
public:
VBoxDnDDropTarget(VBoxDnDWnd *pThis);
virtual ~VBoxDnDDropTarget(void);
public:
static int CreateDropTarget(VBoxDnDWnd *pParent, IDropTarget **ppDropTarget);
public: /* IUnknown methods. */
STDMETHOD(QueryInterface)(REFIID iid, void ** ppvObject);
STDMETHOD_(ULONG, AddRef)(void);
STDMETHOD_(ULONG, Release)(void);
public: /* IDropTarget methods. */
STDMETHOD(DragEnter)(IDataObject *pDataObject, DWORD grfKeyState, POINTL pt, DWORD *pdwEffect);
STDMETHOD(DragOver)(DWORD grfKeyState, POINTL pt, DWORD *pdwEffect);
STDMETHOD(DragLeave)(void);
STDMETHOD(Drop)(IDataObject *pDataObject, DWORD grfKeyState, POINTL pt, DWORD *pdwEffect);
protected:
static DWORD GetDropEffect(DWORD grfKeyState, DWORD dwAllowedEffects);
protected:
LONG mRefCount;
VBoxDnDWnd *mpWndParent;
uint32_t mClientID;
DWORD mdwCurEffect;
IDataObject *mpDataObject;
bool mfHasDropData;
};
class VBoxDnDEnumFormatEtc : public IEnumFORMATETC
{
public:
VBoxDnDEnumFormatEtc(FORMATETC *pFormatEtc, ULONG cFormats);
virtual ~VBoxDnDEnumFormatEtc(void);
public:
STDMETHOD(QueryInterface)(REFIID iid, void ** ppvObject);
STDMETHOD_(ULONG, AddRef)(void);
STDMETHOD_(ULONG, Release)(void);
STDMETHOD(Next)(ULONG cFormats, FORMATETC *pFormatEtc, ULONG *pcFetched);
STDMETHOD(Skip)(ULONG cFormats);
STDMETHOD(Reset)(void);
STDMETHOD(Clone)(IEnumFORMATETC ** ppEnumFormatEtc);
public:
static void CopyFormat(FORMATETC *pFormatDest, FORMATETC *pFormatSource);
static HRESULT CreateEnumFormatEtc(UINT cFormats, FORMATETC *pFormatEtc, IEnumFORMATETC **ppEnumFormatEtc);
private:
LONG m_lRefCount;
ULONG m_nIndex;
ULONG m_nNumFormats;
FORMATETC * m_pFormatEtc;
};
struct VBOXDNDCONTEXT;
class VBoxDnDWnd;
/*
* A drag'n drop event from the host.
*/
typedef struct VBOXDNDEVENT
{
/** The actual event data. */
VBGLR3DNDHGCMEVENT Event;
} VBOXDNDEVENT, *PVBOXDNDEVENT;
/**
* DnD context data.
*/
typedef struct VBOXDNDCONTEXT
{
/** Pointer to the service environment. */
const VBOXSERVICEENV *pEnv;
/** Shutdown indicator. */
bool fShutdown;
/** Thread handle for main event queue
* processing. */
RTTHREAD hEvtQueue;
/** The DnD main event queue. */
RTCMTList<VBOXDNDEVENT> lstEvtQueue;
/** Semaphore for waiting on main event queue
* events. */
RTSEMEVENT hEvtQueueSem;
/** List of drag'n drop windows. At
* the moment only one source is supported. */
RTCMTList<VBoxDnDWnd*> lstWnd;
} VBOXDNDCONTEXT, *PVBOXDNDCONTEXT;
static VBOXDNDCONTEXT gCtx = {0};
/**
* Everything which is required to successfully start
* a drag'n drop operation via DoDragDrop().
*/
typedef struct VBOXDNDSTARTUPINFO
{
/** Our DnD data object, holding
* the raw DnD data. */
VBoxDnDDataObject *pDataObject;
/** The drop source for sending the
* DnD request to a IDropTarget. */
VBoxDnDDropSource *pDropSource;
/** The DnD effects which are wanted / allowed. */
DWORD dwOKEffects;
} VBOXDNDSTARTUPINFO, *PVBOXDNDSTARTUPINFO;
/**
* Class for handling a DnD proxy window.
** @todo Unify this and VBoxClient's DragInstance!
*/
class VBoxDnDWnd
{
/**
* Current state of a DnD proxy
* window.
*/
enum State
{
Uninitialized = 0,
Initialized,
Dragging,
Dropped,
Canceled
};
/**
* Current operation mode of
* a DnD proxy window.
*/
enum Mode
{
/** Unknown mode. */
Unknown = 0,
/** Host to guest. */
HG,
/** Guest to host. */
GH
};
public:
VBoxDnDWnd(void);
virtual ~VBoxDnDWnd(void);
public:
int Initialize(PVBOXDNDCONTEXT pContext);
public:
/** The window's thread for the native message pump and
* OLE context. */
static int Thread(RTTHREAD hThread, void *pvUser);
public:
static BOOL CALLBACK MonitorEnumProc(HMONITOR hMonitor, HDC hdcMonitor, LPRECT lprcMonitor, LPARAM lParam);
/** The per-instance wndproc routine. */
LRESULT CALLBACK WndProc(HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam);
public:
#ifdef VBOX_WITH_DRAG_AND_DROP_GH
int RegisterAsDropTarget(void);
int UnregisterAsDropTarget(void);
#endif
public:
int OnCreate(void);
void OnDestroy(void);
/* H->G */
int OnHgEnter(const RTCList<RTCString> &formats, uint32_t uAllActions);
int OnHgMove(uint32_t u32xPos, uint32_t u32yPos, uint32_t uAllActions);
int OnHgDrop(void);
int OnHgLeave(void);
int OnHgDataReceived(const void *pvData, uint32_t cData);
int OnHgCancel(void);
#ifdef VBOX_WITH_DRAG_AND_DROP_GH
/* G->H */
int OnGhIsDnDPending(uint32_t uScreenID);
int OnGhDropped(const char *pszFormats, uint32_t cbFormats, uint32_t uDefAction);
#endif
int ProcessEvent(PVBOXDNDEVENT pEvent);
public:
int hide(void);
protected:
int dragRelease(void);
int makeFullscreen(void);
void reset(void);
public: /** @todo Make protected! */
/** Pointer to DnD context. */
PVBOXDNDCONTEXT pContext;
RTCRITSECT mCritSect;
RTSEMEVENT mEventSem;
#ifdef RT_OS_WINDOWS
/** The window's handle. */
HWND hWnd;
/** List of allowed MIME types this
* client can handle. Make this a per-instance
* property so that we can selectively allow/forbid
* certain types later on runtime. */
RTCList<RTCString> lstAllowedFormats;
/** List of formats for the current
* drag'n drop operation. */
RTCList<RTCString> lstFormats;
/** Flags of all current drag'n drop
* actions allowed. */
uint32_t uAllActions;
/** The startup information required
* for the actual DoDragDrop() call. */
VBOXDNDSTARTUPINFO startupInfo;
/** Is the left mouse button being pressed
* currently while being in this window? */
bool mfMouseButtonDown;
# ifdef VBOX_WITH_DRAG_AND_DROP_GH
IDropTarget *pDropTarget;
# endif /* VBOX_WITH_DRAG_AND_DROP_GH */
#else
/** @todo Implement me. */
#endif
/** The window's own HGCM client ID. */
uint32_t mClientID;
/** The current operation mode. */
Mode mMode;
/** The current state. */
State mState;
RTCString mFormatRequested;
RTCList<RTCString> mLstFormats;
RTCList<RTCString> mLstActions;
};
#endif /* __VBOXTRAYDND__H */