上一張我們著重介紹了怎么樣使用OLE和IDataObject來訪問windows粘貼板。本章主要實現一個IDataObject接口,然后使用我們完成的數據對象來存儲文本“Hello World”到粘貼板中。
創建一個COM接口-IDataObject
為了創建一個COM對象,我們需要定義一個實現所有這些函數的C++類,并且讓COM的虛函數表為我們自動包含,我們使用C++類繼承:
class CDataObject : public IDataObject
{
Public:
HRESULT __stdcall QueryInterface (REFIID iid, void ** ppvObject);
ULONG __stdcall AddRef (void);
ULONG __stdcall Release (void);
HRESULT __stdcall GetData (FORMATETC *pFormatEtc, STGMEDIUM *pmedium);
HRESULT __stdcall GetDataHere (FORMATETC *pFormatEtc, STGMEDIUM *pmedium);
HRESULT __stdcall QueryGetData (FORMATETC *pFormatEtc);
HRESULT __stdcall GetCanonicalFormatEtc (FORMATETC *pFormatEct, FORMATETC *pFormatEtcOut);
HRESULT __stdcall SetData (FORMATETC *pFormatEtc, STGMEDIUM *pMedium, BOOL fRelease);
HRESULT __stdcall EnumFormatEtc (DWORD dwDirection, IEnumFORMATETC **ppEnumFormatEtc);
HRESULT __stdcall DAdvise (FORMATETC *pFormatEtc, DWORD advf, IAdviseSink *, DWORD *);
HRESULT __stdcall DUnadvise (DWORD dwConnection);
HRESULT __stdcall EnumDAdvise (IEnumSTATDATA **ppEnumAdvise);
stgmed
CDataObject (FORMATETC *fmtetc, STGMEDIUM *, int count);
~CDataObject ()
private:
LONG m_lRefCount;
int LookupFormatEtc(FORMATETC *pFormatEtc);
};
上面列出了所有IDataObject成員,包括IUnknown接口成員,這是因為我們現在需要實現整個COM對象,因此每個成員必須正確的包含。
由于IUnknown函數我們在前面已經介紹了,我們繼續介紹IDataObject函數。有些好的消息,同時也有些壞的消息;好的消息是,不是所有餓函數都需要實現,在IDataObject的9個函數中,我們僅僅需要實現3個來支持OLE的拖放操作,因此顯著節省了我們的工作量。
壞的消息是:一般我們已經實現了IDataObject方法,我們需要實現完全獨立的COM接口-IEnumFORMATETC接口。然而到這步還有很大的距離,因此讓我們以一個簡單分配新IDataObject的實例作為一個開始。
構造IDataObject
IDataObject的主要任務是允許一個消費者查詢數據,這些查詢從QueryData或EnumFormatEtc調用來發起的,因此,IDataObject需要知道存儲什么樣的數據格式,并且在消費者需要數據的時候,它能夠提供。
我們因此需要找到一些辦法來以FORMATETC結構的形式用真正的數據片來組裝IDataObject且說明數據是什么。
IDataObject在C++類構造函數的時候組裝,為了更彈性,可能需要添加內部幫助程序來執行這個任務,但對于我們簡單實現僅在構造函數中使用。
CDataObject::CDataObject (FORMATETC *fmtetc, STGMEDIUM *stgmed, int count)
{
m_lRefCount = 1;
m_nNumFormats = count;
m_pFormatEtc = new FORMATETC[count];
m_pStgMedium = new STGMEDIUM[count];
for(int i = 0; i < count; i++)
{
m_pFormatEtc[i] = fmtetc[i];
m_pStgMedium[i] = stgmed[i];
}
}
構造函數執行兩個重要的任務,首先是初始化COM對象引用記數為1。我看到過許多不正確的COM代碼,他們初始化記數為0,COM規約明確地聲明,一個COM對象必須以“1”作為生命周期的開始,如果你記得,一個記數為0的COM對象應該被刪除,因此它應該從不應該被初始化為這個值。
第二個任務是在類構造函數中做一個私有的FORMATETC和STGMEDIUM的副本。數據對象不是每個STGMEDIUM結構體內部的所有者,它純粹是引用并且在請求調用GetData的時候復制數據。
創建IDataObject對象
現在我們有一個定義良好的IDataObject構造函數,我可以寫一個包裝函數來隱藏類的細節:
HRESULT CreateDataObject (FORMATETC *fmtetc, STGMEDIUM *stgmeds, UINT count, IDataObject **ppDataObject)
{
if(ppDataObject == 0)
return E_INVALIDARG;
*ppDataObject = new CDataObject (fmtetc, stgmeds, count);
return (*ppDataObject) ? S_OK: E_OUTOFMEMORY;
}
現在創建一個IDataObject變的非常簡單:
FORMATETC fmtetc = {CF_TEXT, 0, DVASPECT_CONTENT, -1, TYMED_HGLOBAL};
STGMEDIUM stgmed = {TYMED_HGLOBAL, {0}, 0};
stgmed.hGlobal = StringToHandle ("Hello, World!");
IDataObject *pDataObject;
CreateDataObject (&fmtetc, &stgmed, 1, &pDataObject);
許多IDataObject的實現包含許多接口內部執行內存分配的程序指定編碼;在這個實現后面的思想是可以提供一個用于各種程序的通用IDataObject。好了,在創建數據對象之前有點工作需要做就是創建FORMATETC和STGMEDIUM結構,但這很容易被隔離,并且不會污染接口編碼。
IDataObject::QueryGetData
該成員函數在某程序想檢查IDataObject看是否包含指定類型的數據時候調用。一個指向FORMATETC結構的指針作為一個參數,且IDataObject::QueryGetData來檢查這個結構且返回一個值來指示請求的數據是否可用。
HRESULT __stdcall IDataObject::QueryGetData(FORMATETC *pFormatEtc)
{
return (LookupFormatEtc(pFormat) == -1) ? DV_E_FORMATETC : S_OK;
}
這個例子中的QueryGetData函數非常簡單,我們放棄私有協助函數-LookupFormatEtc的所有工作:
int CDataObject::LookupFormatEtc(FORMATETC *pFormatEtc)
{
for(int i = 0; i < m_nNumFormats; i++)
{
if((m_pFormatEtc[i].tymed & pFormatEtc->tymed) &&
m_pFormatEtc[i].cfFormat == pFormatEtc->cfFormat &&
m_pFormatEtc[i].dwAspect == pFormatEtc->dwAspect)
{
return i;
}
}
return -1;
}
上面的函數盡量在我們數據對象的可用結構中查找一個與指定FORMATETC結構匹配的對象,如果找到一個匹配的,就簡單的返回相應m_pFormatEtc數組的索引,如果找不到,返回-1表示一個錯誤。
注意,在if從句中的位與操作符:
if( m_pFormatEtc[i].tymed & pFormatEtc->tymed )
AND操作符用在這里是因為FORMATETC::tymed成員實際上是一個位標志,它能夠包含不止一個值;例如:QueryGetData的調用者可以完全指定一個FORMATETC::tymed值(TYMED_HGLOBAL|TYMED_ISTREAM)就意味著你支持HGLOBAL或IStream嗎?
IDataObject::GetData
GetData函數和QueryGetData有許多相似之處,除了如果支持請求的數據格式,它必須返回指定的存儲類型。
HRESULT __stdcall CDataObject::GetData (FORMATETC *pFormatEtc, STGMEDIUM *pStgMedium)
{
int idx;
if((idx = LookupFormatEtc(pFormatEtc)) == -1)
return DV_E_FORMATETC;
pMedium->tymed = m_pFormatEtc[idx].tymed;
pMedium->pUnkForRelease = 0;
switch(m_pFormatEtc[idx].tymed)
{
case TYMED_HGLOBAL:
pMedium->hGlobal = DupGlobalMem(m_pStgMedium[idx].hGlobal);
break;
default:
return DV_E_FORMATETC;
}
return S_OK;
}
同樣要調用內部協助函數LookupFormatEtc來檢查是否支持請求的數據格式,如果支持,相應的STGMEDIUM數據被復制到調用者提供的結構。
注意,現在調用DupGlobalMem程序,這是一個協助函數,它返回指定HGLOBAL內存的HANDLE的副本,并且必須返回部分,因為每個GetData調用都要求一個新的數據副本。
HGLOBAL DupGlobalMemMem (HGLOBAL hMem)
{
DWORD len = GlobalSize (hMem);
PVOID source = GlobalLock (hMem);
PVOID dest = GlobalAlloc (GMEM_FIXED, len);
memcpy (dest, source, len);
GlobalUnlock (hMem);
return dest;
}
我們需要同樣的程序來支持TYMED_xxx存儲類型,但現在我們設想實現的支持格式是IStream。
IDataObject::EnumFormatEtc
這是最后需要自己動手的成員,不幸的是這個成員函數實現如此簡單,但也要求我們寫IEnumFORMATETC對象。
HRESULT __stdcall CDataObject::EnumFormatEtc (DWORD dwDirection, IEnumFORMATETC **ppEnumFormatEtc)
{
if(dwDirection == DATADIR_GET)
{
return CreateEnumFormatEtc(m_NumFormats, m_FormatEtc, ppEnumFormatEtc);
}
else
{
return E_NOTIMPL;
}
}
看到上面的代碼,你會提到SHCreateStdEnumFmtEtc這個API調用,它能夠代表我們創建IEnumFORMATETC接口,不幸的是,這個API僅僅在WIN2K上可用,因此,我們需要提供其他創建IEnumFORMATETC對象。
因此下面的旅程中,我們將提供一個CreateEnumFormatEtc的完整實現,來代替Shell API調用。
不支持的IDataObject函數
仍然有一些IDataObject函數需要實現,而同時每個函數必須是一個有效的程序,有個簡單的辦法可以指定給OLE,我們不支持這些拖放操作以外的函數。
IDataObject::DAdvise、IDataObject::EnumDAdvise和IDataObject::DUnadivise函數簡單的返回OLE_E_ADVISENOTSUPPORTED。
HRESULT CDataObject::DAdvise (FORMATETC *pFormatEtc, DWORD advf, IAdviseSink *pAdvSink, DWORD *pdwConnection)
{
return OLE_E_ADVISENOTSUPPORTED;
}
HRESULT CDataObject::DUnadvise (DWORD dwConnection)
{
return OLE_E_ADVISENOTSUPPORTED;
}
HRESULT CDataObject::EnumDAdvise (IEnumSTATDATA **ppEnumAdvise)
{
return OLE_E_ADVISENOTSUPPORTED;
}
GetDataHere只需要實現IStream和IStorage接口來支持數據對象,在我們的例子中,我們只支持HGLOBAL數據,因此返回DATA_E_FORMATETC是一個明智的選擇。
HRESULT CDataObject::GetDataHere (FORMATETC *pFormatEtc, STGMEDIUM *pMedium)
{
return DATA_E_FORMATETC;
}
SetData和GetCanonicalFormatEtc也只要簡單的實現,本例中可以返回E_NOTIMPL值,即使我們返回錯誤的值,一個GetCanonicalFormatEtc記名票據,輸出的FORMATETC結構ptd成員應該是0。
HRESULT CDataObject::GetCanonicalFormatEtc (FORMATETC *pFormatEct, FORMATETC *pFormatEtcOut)
{
pFormatEtcOut->ptd = NULL;
return E_NOTIMPL;
}
HRESULT CDataObject::SetData (FORMATETC *pFormatEtc, STGMEDIUM *pMedium, BOOL fRelease)
{
return E_NOTIMPL;
}
添加數據到粘貼板
好了,這里有一個簡單那的程序用來通過OLE和數據對象來添加“Hello World”到Windows的粘貼板。
#include <windows.h>
int main(void)
{
OleInitialize (0);
IDataObject *pDataObject;
FORMATETC fmtetc = {CF_TEXT, 0, DVASPECT_CONTENT, -1, TYMED_HGLOBAL};
STGMEDIUM stgmed = {TYMED_HGLOBAL, {0}, 0};
stgmed.hGlobal = StringToHandle ("Hello, World!”, -1);
if (CreateDataObject(&fmtetc, &stgmed, 1, &pDataObject) == S_OK)
{
OleSetClipboard (pDataObject);
OleFlushClipboard ();
pDataObject->Release();
}
ReleaseStgMedium (&stgmed);
OleUninitialize ();
return 0;
}
不幸的是這個程序不能工作,因為我們還沒有實現IEnumFORMATETC和CreateEnumFormatEtc函數。