轉載 C++實作的委托機制
1.引言
下面的委托實作使用的MyGUI裡面的委托實作,MyGUI是一款強大的GUI庫,想了解更多的MyGUI資訊,猛擊這裡http://mygui.info/
最終的代碼可以在這裡下載下傳:http://download.csdn.net/detail/gouki04/3641328 我們的目标是要實作一個跟.NET幾乎完全一樣的委托,使用簡單,支援多點傳播,可以添加删除委托。同時支援C++的普通函數、模闆函數、類成員函數,類的靜态成員函數,并且支援多态。使用方式如下:
- // 普通函數
- void normalFunc(){ cout << "func1" << endl; }
- class Base
- {
- public:
- // 類成員函數
- void classFunc(){ cout << "Base func1" << endl; }
- };
- int main()
- {
- Base b;
- CMultiDelegate myDelegate;
- myDelegate += newDelegate(normalFunc);
- myDelegate += newDelegate(&b, &Base::classFunc);
- myDelegate(); // 此時會調用normalFunc和classFunc
- myDelegate -= newDelegate(&b, &Base::classFunc);
- myDelegate(); // 此時會調用normalFunc
- return 0;
- }
2.實作無參函數委托
要實作委托,首先要解決的是封裝C++中的函數指針。因為在C++中,普通函數指針和類成員函數指針是完全不一樣的。如下例子
- class CMyClass
- {
- public:
- void func(int);
- };
- // 定義一個指向CMyClass類型,參數清單為(int),傳回值為void的函數指針
- typedef void (CMyClass::*ClassMethod) (int); // 注意定義時使用了特殊的運算符::*
那麼此函數指針隻能指向CMyClass類型的成員函數,不能指向其他類或者普通函數
類成員函數指針不能直接調用,要通過一個類執行個體來調用,如下
- CMyClass *object = new CMyClass;
- ClassMethod method = CMyClass::func;
- (object->*method)(5); // 注意調用時使用了特殊運算符->*
那麼如何封裝呢?我們先來定義下接口吧
(為了簡單起見,下面的實作都是以無參函數為例,後續會講到如何支援任意參數)
- class IDelegate
- {
- public:
- virtual ~IDelegate() { }
- virtual bool isType(const std::type_info& _type) = 0;
- virtual void invoke() = 0;
- virtual bool compare(IDelegate *_delegate) const = 0;
- };
IDelegate類的接口很少,也很簡單,必要接口隻有一個,就是invoke,用于觸發函數
但為了可以友善管理,使用了isType和compare函數來進行相等判斷。
下面是封裝的普通函數指針
- class CStaticDelegate : public IDelegate
- {
- public:
- typedef void (*Func)();
- CStaticDelegate(Func _func) : mFunc(_func) { }
- virtual bool isType( const std::type_info& _type) { return typeid(CStaticDelegate) == _type; }
- virtual void invoke() { mFunc(); }
- virtual bool compare(IDelegate *_delegate) const
- {
- if (0 == _delegate || !_delegate->isType(typeid(CStaticDelegate)) ) return false;
- CStaticDelegate * cast = static_cast<CStaticDelegate*>(_delegate);
- return cast->mFunc == mFunc;
- }
- private:
- Func mFunc;
- };
可以看到,CStaticDelegate隻是簡單地封裝了普通函數指針,代碼也非常簡單
(類的某些成員函數,如isType和compare使用了RTTI,
對C++的動态類型判斷不熟的可以猛擊這裡http://blog.csdn.net/gouki04/article/details/6796173)
好了,注意了,下面開始封裝類成員函數指針
- template<class T>
- class CMethodDelegate : public IDelegate
- {
- public:
- typedef void (T::*Method)();
- CMethodDelegate(T * _object, Method _method) : mObject(_object), mMethod(_method) { }
- virtual bool isType( const std::type_info& _type) { return typeid(CMethodDelegate) == _type; }
- virtual void invoke()
- {
- (mObject->*mMethod)();
- }
- virtual bool compare(IDelegate *_delegate) const
- {
- if (0 == _delegate || !_delegate->isType(typeid(CMethodDelegate)) ) return false;
- CMethodDelegate* cast = static_cast<CMethodDelegate* >(_delegate);
- return cast->mObject == mObject && cast->mMethod == mMethod;
- }
- private:
- T * mObject;
- Method mMethod;
- };
首先解釋一下:因為類成員函數指針與類的類型有關,不同類的成員函數指針是不一樣的。
要解決類型不同,很簡單,使用模闆就行。
代碼跟CStaticDelegate基本一樣,下面稍微解釋一下:
CMethodDelegate類主要封裝了一個類執行個體指針以及類成員函數的指針
這樣在invoke時就不要額外的通過一個類執行個體了
要注意一點,compare函數的實作中,相等判定是類執行個體以及類函數指針都一樣。
也就是說就算是指針同一個成員函數,但執行個體不同,委托就不同
為了友善使用,定義函數newDelegate來建立委托使用的函數
- inline IDelegate* newDelegate( void (*_func)() )
- {
- return new CStaticDelegate(_func);
- }
- template<class T>
- inline IDelegate* newDelegate( T * _object, void (T::*_method)() )
- {
- return new CMethodDelegate<T>(_object, _method);
- }
至此,對C++函數指針的封裝就完成了,不難吧。
下面就是委托的實作了
- class CMultiDelegate
- {
- public:
- typedef std::list<IDelegate*> ListDelegate;
- typedef ListDelegate::iterator ListDelegateIterator;
- typedef ListDelegate::const_iterator ConstListDelegateIterator;
- CMultiDelegate () { }
- ~CMultiDelegate () { clear(); }
- bool empty() const
- {
- for (ConstListDelegateIterator iter = mListDelegates.begin(); iter!=mListDelegates.end(); ++iter)
- {
- if (*iter) return false;
- }
- return true;
- }
- void clear()
- {
- for (ListDelegateIterator iter=mListDelegates.begin(); iter!=mListDelegates.end(); ++iter)
- {
- if (*iter)
- {
- delete (*iter);
- (*iter) = 0;
- }
- }
- }
- CMultiDelegate& operator+=(IDelegate* _delegate)
- {
- for (ListDelegateIterator iter=mListDelegates.begin(); iter!=mListDelegates.end(); ++iter)
- {
- if ((*iter) && (*iter)->compare(_delegate))
- {
- delete _delegate;
- return *this;
- }
- }
- mListDelegates.push_back(_delegate);
- return *this;
- }
- CMultiDelegate& operator-=(IDelegate* _delegate)
- {
- for (ListDelegateIterator iter=mListDelegates.begin(); iter!=mListDelegates.end(); ++iter)
- {
- if ((*iter) && (*iter)->compare(_delegate))
- {
- if ((*iter) != _delegate) delete (*iter);
- (*iter) = 0;
- break;
- }
- }
- delete _delegate;
- return *this;
- }
- void operator()( )
- {
- ListDelegateIterator iter = mListDelegates.begin();
- while (iter != mListDelegates.end())
- {
- if (0 == (*iter))
- {
- iter = mListDelegates.erase(iter);
- }
- else
- {
- (*iter)->invoke();
- ++iter;
- }
- }
- }
- private:
- CMultiDelegate (const CMultiDelegate& _event);
- CMultiDelegate& operator=(const CMultiDelegate& _event);
- private:
- ListDelegate mListDelegates;
- };
仔細了解下CMultiDelegate類的實作,代碼都不深奧。
比較重要的是3個函數 :+=,-=,()運算符的重載函數
+= 用于添加一個委托函數
-= 用于去掉一個委托函數
() 用于觸發委托函數
差不多就是普通的stl容器使用了。
這裡要重點說明的一點是,大家仔細看 += 函數的實作中
- if ((*iter) && (*iter)->compare(_delegate))
- {
- delete _delegate; // 如果該委托函數已經被添加了,則delete掉外部的_delegate
- return *this;
- }
為什麼要delete掉外部的指針呢?
因為C++的記憶體洩露一直是個麻煩事,是以MyUGI的委托裡,所有的委托函數統一由Delegate本身管理
外部不要自己new或delete委托函數,也不要儲存一個委托函數,Delegate本身會管理好的。
建議像如下使用:
- CMultiDelegate myDelegate;
- myDelegate += newDelegate(normalFunc);
- myDelegate -= newDelegate(normalFunc);
而不建議像如下使用:
- CMultiDelegate myDelegate;
- IDelegate* delegateFunc = newDelegate(normalFunc);
- myDelegate += delegateFunc;
- myDelegate -= delegateFunc;
上面2種方法都沒錯,都不會造成記憶體洩露
你可能會覺得第2種方法減少new的次數,比第一種方法更好。其實不然,因為第2種方法有個很大的隐患
- myDelegate -= delegateFunc; // 在這一步,delegateFunc所指向的空間已經被釋放掉了(在-=函數裡面)
是以如果你後面又想将delegateFunc添加到myDelegate裡面時,你就不能再這樣用了
- myDelegate += delegateFunc; // 錯誤,因為delegateFunc的空間已經被釋放了
你得重新new一個
delegateFunc = newDelegate(normalFunc);
myDelegate += delegateFunc;
相信你不會願意這樣做的,因為這種方法很容易造成記憶體洩露或者崩潰
現在你應該可以明白 -= 函數是怎麼釋放委托函數記憶體了吧。
1.實作任意參數的函數委托
按上一篇文章的方法,你已經可以使用無參數的函數委托了。當然,這遠遠不夠。要實作任意參數的函數委托,這裡的任意參數包括任意個數和任意類型。任意類型這個容易解決,使用模闆就行,但任意參數個數呢?
注:最終的實作代碼可以在這裡下載下傳:http://download.csdn.net/detail/gouki04/3641328
隻能不同個數各實作一個類,如
- // 單參函數委托
- template<typename TP1>
- class CMultiDelegate1{};
- // 雙參函數委托
- template<typename TP1, typename TP2>
- class CMultiDelegate2{};
注意類名是不一樣的,分别為CMultiDelegate1和CMultiDelegate2
C++裡面,類名相同但模闆參數個數不同是會當成一個類對待的,是以那樣編譯不過的
這樣是不是很麻煩呢?
不是很麻煩,是相當麻煩。因為不單單是CMultiDelegate要實作多個參數的版本
連IDelegate、CStaticDelegate和CMethodDelegate都要實作對應的多個參數的版本!
其實所有版本的内部實作幾乎一樣,下面給出雙參函數的版本
- template<typename TP1, typename TP2>
- class IDelegate2
- {
- public:
- virtual ~IDelegate2() { }
- virtual bool isType( const std::type_info& _type) = 0;
- virtual void invoke( TP1 p1, TP2 p2 ) = 0;
- virtual bool compare( IDelegate2<typename TP1, typename TP2> *_delegate) const = 0;
- };
- template<typename TP1, typename TP2>
- class CStaticDelegate2 : public IDelegate2<typename TP1, typename TP2>
- {
- public:
- typedef void (*Func)( TP1 p1, TP2 p2 );
- CStaticDelegate2 (Func _func) : mFunc(_func) { }
- virtual bool isType( const std::type_info& _type) { return typeid( CStaticDelegate2<typename TP1, typename TP2> ) == _type; }
- virtual void invoke( TP1 p1, TP2 p2 )
- {
- mFunc( p1, p2 );
- }
- virtual bool compare( IDelegate2<typename TP1, typename TP2> *_delegate) const
- {
- if (0 == _delegate || !_delegate->isType(typeid(CStaticDelegate2 <typename TP1, typename TP2>)) ) return false;
- CStaticDelegate2 <typename TP1, typename TP2> * cast = static_cast<CStaticDelegate2 <typename TP1, typename TP2> *>(_delegate);
- return cast->mFunc == mFunc;
- }
- virtual bool compare(IDelegateUnlink * _unlink) const { return false; }
- private:
- Func mFunc;
- };
- template <typename T, typename TP1, typename TP2>
- class CMethodDelegate2 : public IDelegate2 <typename TP1, typename TP2>
- {
- public:
- typedef void (T::*Method)( TP1 p1, TP2 p2 );
- CMethodDelegate2(T * _object, Method _method) : mObject(_object), mMethod(_method) { }
- virtual bool isType( const std::type_info& _type) { return typeid( CMethodDelegate2 <T, TP1, TP2> ) == _type; }
- virtual void invoke( TP1 p1, TP2 p2 )
- {
- (mObject->*mMethod)( p1, p2 );
- }
- virtual bool compare( IDelegate2 <typename TP1, typename TP2> * _delegate) const
- {
- if (0 == _delegate || !_delegate->isType(typeid(CMethodDelegate2 <T, TP1, TP2>)) ) return false;
- CMethodDelegate2 <T, TP1, TP2> * cast = static_cast< CMethodDelegate2 <T, TP1, TP2> * >(_delegate);
- return cast->mObject == mObject && cast->mMethod == mMethod;
- }
- private:
- T * mObject;
- Method mMethod;
- };
- template <typename TP1, typename TP2>
- inline delegates::IDelegate2 <typename TP1, typename TP2> * newDelegate( void (*_func)( TP1 p1, TP2 p2 ) )
- {
- return new delegates::CStaticDelegate2 <typename TP1, typename TP2> (_func);
- }
- template <typename T, typename TP1, typename TP2>
- inline delegates::IDelegate2 <typename TP1, typename TP2> * newDelegate( T * _object, void (T::*_method)( TP1 p1, TP2 p2 ) )
- {
- return new delegates::CMethodDelegate2 <T, TP1, TP2> (_object, _method);
- }
- template <typename TP1, typename TP2>
- class CMultiDelegate2
- {
- public:
- typedef IDelegate2 <typename TP1, typename TP2> IDelegate;
- typedef typename std::list<IDelegate*> ListDelegate;
- typedef typename ListDelegate::iterator ListDelegateIterator;
- typedef typename ListDelegate::const_iterator ConstListDelegateIterator;
- CMultiDelegate2 () { }
- ~CMultiDelegate2 () { clear(); }
- bool empty() const
- {
- for (ConstListDelegateIterator iter = mListDelegates.begin(); iter!=mListDelegates.end(); ++iter)
- {
- if (*iter) return false;
- }
- return true;
- }
- void clear()
- {
- for (ListDelegateIterator iter=mListDelegates.begin(); iter!=mListDelegates.end(); ++iter)
- {
- if (*iter)
- {
- delete (*iter);
- (*iter) = 0;
- }
- }
- }
- CMultiDelegate2 <typename TP1, typename TP2> & operator+=(IDelegate* _delegate)
- {
- for (ListDelegateIterator iter=mListDelegates.begin(); iter!=mListDelegates.end(); ++iter)
- {
- if ((*iter) && (*iter)->compare(_delegate))
- {
- delete _delegate;
- return *this;
- //MYGUI_ASSERT(false, "dublicate delegate");
- }
- }
- mListDelegates.push_back(_delegate);
- return *this;
- }
- CMultiDelegate2 <typename TP1, typename TP2> & operator-=(IDelegate* _delegate)
- {
- for (ListDelegateIterator iter=mListDelegates.begin(); iter!=mListDelegates.end(); ++iter)
- {
- if ((*iter) && (*iter)->compare(_delegate))
- {
- if ((*iter) != _delegate) delete (*iter);
- (*iter) = 0;
- break;
- }
- }
- delete _delegate;
- return *this;
- }
- void operator()( TP1 p1, TP2 p2 )
- {
- ListDelegateIterator iter = mListDelegates.begin();
- while (iter != mListDelegates.end())
- {
- if (0 == (*iter))
- {
- iter = mListDelegates.erase(iter);
- }
- else
- {
- (*iter)->invoke( p1, p2 );
- ++iter;
- }
- }
- }
- private:
- CMultiDelegate2 (const CMultiDelegate2 <typename TP1, typename TP2> & _event);
- CMultiDelegate2<typename TP1, typename TP2> & operator=(const CMultiDelegate2<typename TP1, typename TP2> & _event);
- private:
- ListDelegate mListDelegates;
- };
當然放心啦,不會讓大家将不同參數的版本各寫一遍的
下面要介紹的是MyGUI的解決方法,一個利用預編譯和頭檔案重複編譯的方法(很有意思的)
我們一般寫頭檔案時,都會加上防止頭檔案重複編譯的代碼,如
- #ifndef __XXX_H__
- #define __XXX_H__
- // ..類聲明等
- #endif
這裡我們就要反其道而行,去掉防止重複編譯的代碼,然後重複包含這個頭檔案,但每次其編譯的都是不同參數個數的版本
第一次編譯的是無參的,第二次是單參的,第三次是雙參.....一直到你想要支援的參數個數
那怎麼讓其每次編譯的都不同呢?
答案就是使用強大的預編譯:宏
下面給出單參的IDelegate的例子
首先定義以下宏:
- #define DELEGATE_TEMPLATE template
- #define DELEGATE_TEMPLATE_PARAMS <typename TP1>
- #define DELEGATE_TEMPLATE_ARGS TP1 p1
- #define MYGUI_I_DELEGATE IDelegate1
那麼下面這段代碼就會編譯出單參的IDelegate版本
- DELEGATE_TEMPLATE DELEGATE_TEMPLATE_PARAMS
- class MYGUI_I_DELEGATE
- {
- public:
- virtual ~MYGUI_I_DELEGATE() { }
- virtual bool isType( const std::type_info& _type) = 0;
- virtual void invoke( DELEGATE_PARAMS ) = 0;
- virtual bool compare( MYGUI_I_DELEGATE DELEGATE_TEMPLATE_ARGS * _delegate) const = 0;
- };
神奇吧,這裡使用的可以說是宏實作的多态。
在這段代碼編譯完了之後,将所有宏都undefine掉,如
- #undef DELEGATE_TEMPLATE
- #undef DELEGATE_TEMPLATE_PARAMS
- #undef DELEGATE_TEMPLATE_ARGS
- #undef MYGUI_I_DELEGATE
再重新定義雙參版本的,如
- #define DELEGATE_TEMPLATE template
- #define DELEGATE_TEMPLATE_PARAMS <typename TP1, typename TP2>
- #define DELEGATE_TEMPLATE_ARGS TP1 p1, TP2 p2
- #define MYGUI_I_DELEGATE IDelegate2
那麼編譯出來的就是雙參的版本了!
使用這種方法就可以将其他的如CStaticDelegate、CMethodDelegate和CMultiDelegate的各種版本都實作了,
而你要做的僅是重新define下那些宏就行了,夠友善了吧。
下一篇文章将會介紹MyGUI實作的一些輔助類,如單委托和DelegateUnlink。并給出一個測試例子,測試該委托機制對C++各種函數的支援。
1.引言
按上一篇文章的方法,你已經可以使用任意參數的函數委托了。這裡介紹下MyGUI實作的兩個輔助類,CDelegate類和IDelegateUnlink。如果你不為了深入了解MyGUI的委托實作,可以跳過此處。CDelegate即為單委托,實際效果跟函數指針差不多,于CMultiDelegate的差別在于其不支援多點傳播。而IDelegateUnlink類主要是在CMultiDelegate中使用,在多點傳播下一次性去掉自身的所有委托。
2.單委托
- // 無參的單委托實作
- class CDelegate
- {
- public:
- typedef CDelegate IDelegate;
- CDelegate () : mDelegate(0) { }
- CDelegate (const CDelegate& _event)
- {
- // 在拷貝構造時,将被拷貝的委托去掉,即委托隻存在一份
- mDelegate = _event.mDelegate;
- const_cast<CDelegate&>(_event).mDelegate = 0;
- }
- ~CDelegate () { clear(); }
- bool empty() const { return mDelegate == 0; }
- void clear()
- {
- if (mDelegate)
- {
- delete mDelegate;
- mDelegate = 0;
- }
- }
- CDelegate & operator=(IDelegate* _delegate)
- {
- delete mDelegate;
- mDelegate = _delegate;
- return *this;
- }
- CDelegate & operator=(const CDelegate& _event)
- {
- // 在指派時,将右值的委托去掉,即委托隻存在一份
- delete mDelegate;
- mDelegate = _event.mDelegate;
- const_cast<CDelegate&>(_event).mDelegate = 0;
- return *this;
- }
- void operator()( )
- {
- if (mDelegate == 0) return;
- mDelegate->invoke( );
- }
- private:
- IDelegate * mDelegate;
- };
可以看到,單委托隻實作了 = 運算符,沒有實作 += 運算符。
而且在指派時會将原委托去掉,確定隻有一份委托。
其實單委托跟普通函數指針差不多,在使用單委托的地方可以換成使用普通函數指針。
3.斷開委托
- // 斷開委托的基類
- class IDelegateUnlink
- {
- public:
- virtual ~IDelegateUnlink() { }
- IDelegateUnlink() { m_baseDelegateUnlink = this; }
- bool compare(IDelegateUnlink * _unlink) const { return m_baseDelegateUnlink == _unlink->m_baseDelegateUnlink; }
- private:
- IDelegateUnlink * m_baseDelegateUnlink;
- };
所謂斷開委托,隻能用在多重委托,即CMultiDelegate中,可以斷開自身與其相連的所有委托。
使用方法就在将自身的類從IDelegateUnlink派生,然後使用CMultiDelegate中的clear函數即可斷開委托。
在下面會有例子說明。
4.測試
- #include "delegate.h"
- #include <iostream>
- using namespace std;
- // 普通函數1
- void func(int a, int b)
- {
- cout << "func(" << a << ", " << b << ")" << endl;
- }
- // 普通函數2
- void func2(int a, int b)
- {
- cout << "func2(" << a << ", " << b << ")" << endl;
- }
- // 普通類
- class NormalClass
- {
- public:
- // 類的普通成員函數
- void normalFunc(int a, int b)
- {
- cout << "NormalClass::normalFunc(" << a << ", " << b << ")" << endl;
- }
- };
- // 實作了IDelegateUnlink的類
- class BaseUnlinkClass : public delegates::IDelegateUnlink
- {
- public:
- // 類的虛函數
- virtual void virFunc(int a, int b)
- {
- cout << "BaseUnlinkClass::virFunc(" << a << ", " << b << ")" << endl;
- }
- // 類的普通成員函數
- void normalFunc(int a, int b)
- {
- cout << "BaseUnlinkClass::normalFunc(" << a << ", " << b << ")" << endl;
- }
- };
- class DerivedClass : public BaseUnlinkClass
- {
- public:
- // 類的虛函數
- virtual void virFunc(int a, int b)
- {
- cout << "DerivedClass::virFunc(" << a << ", " << b << ")" << endl;
- }
- // 類的靜态成員函數
- static void staticFunc(int a, int b)
- {
- cout << "DerivedClass::staticFunc(" << a << ", " << b << ")" << endl;
- }
- };
- // 模闆函數
- template<class T>
- void TFunc(T a, T b)
- {
- cout << "TFunc(" << a << ", " << b << ")" << endl;
- }
- int main()
- {
- BaseUnlinkClass *baseUnlinkClass = new BaseUnlinkClass;
- DerivedClass *derivedClass = new DerivedClass;
- NormalClass *normalClass = new NormalClass;
- // 定義委托
- typedef delegates::CMultiDelegate2<int, int> EvenetHandler;
- EvenetHandler event;
- // 添加普通函數
- event += newDelegate(func);
- event += newDelegate(func2);
- // 添加類的普通成員函數
- event += newDelegate(normalClass, &NormalClass::normalFunc);
- event += newDelegate(baseUnlinkClass, &BaseUnlinkClass::normalFunc);
- // 添加類的虛函數
- event += newDelegate(baseUnlinkClass, &BaseUnlinkClass::virFunc);
- event += newDelegate(derivedClass, &DerivedClass::virFunc);
- // 注意在多态下,使用基類指針時,函數指針要用基類的函數指針,不能用派生類的
- // 但是在調用時會響應多态,也就是會調用派生類的虛函數
- event += newDelegate((BaseUnlinkClass*)derivedClass, &BaseUnlinkClass::virFunc);
- // 添加類的靜态成員函數
- event += newDelegate(&DerivedClass::staticFunc);
- // 添加模闆函數
- event += newDelegate(TFunc<int>);
- // 觸發事件
- event(1, 2);
- cout << endl;
- // 去掉函數
- event -= newDelegate(func);
- // 去掉baseUnlinkClass所有的函數
- event.clear(baseUnlinkClass);
- // 去掉derivedClass所有的函數
- // 注意靜态成員函數staticFunc不會去掉
- event.clear(derivedClass);
- //event.clear(normalClass);
- // 錯誤調用,normalClass不是IDelegateUnlink的派生類
- // 不能使用clear去掉自身的函數
- // 應該使用如下方法
- event -= newDelegate(normalClass, &NormalClass::normalFunc);
- // 觸發事件
- event(2, 3);
- cout << endl;
- return 0;
- }