hxtsmartpointer.h
上传用户:dangjiwu
上传日期:2013-07-19
资源大小:42019k
文件大小:11k
源码类别:

Symbian

开发平台:

Visual C++

  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Source last modified: $Id: hxtsmartpointer.h,v 1.1.2.3 2004/07/09 01:45:13 hubbe Exp $
  3.  * 
  4.  * Portions Copyright (c) 1995-2004 RealNetworks, Inc. All Rights Reserved.
  5.  * 
  6.  * The contents of this file, and the files included with this file,
  7.  * are subject to the current version of the RealNetworks Public
  8.  * Source License (the "RPSL") available at
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed
  10.  * the file under the current version of the RealNetworks Community
  11.  * Source License (the "RCSL") available at
  12.  * http://www.helixcommunity.org/content/rcsl, in which case the RCSL
  13.  * will apply. You may also obtain the license terms directly from
  14.  * RealNetworks.  You may not use this file except in compliance with
  15.  * the RPSL or, if you have a valid RCSL with RealNetworks applicable
  16.  * to this file, the RCSL.  Please see the applicable RPSL or RCSL for
  17.  * the rights, obligations and limitations governing use of the
  18.  * contents of the file.
  19.  * 
  20.  * Alternatively, the contents of this file may be used under the
  21.  * terms of the GNU General Public License Version 2 or later (the
  22.  * "GPL") in which case the provisions of the GPL are applicable
  23.  * instead of those above. If you wish to allow use of your version of
  24.  * this file only under the terms of the GPL, and not to allow others
  25.  * to use your version of this file under the terms of either the RPSL
  26.  * or RCSL, indicate your decision by deleting the provisions above
  27.  * and replace them with the notice and other provisions required by
  28.  * the GPL. If you do not delete the provisions above, a recipient may
  29.  * use your version of this file under the terms of any one of the
  30.  * RPSL, the RCSL or the GPL.
  31.  * 
  32.  * This file is part of the Helix DNA Technology. RealNetworks is the
  33.  * developer of the Original Code and owns the copyrights in the
  34.  * portions it created.
  35.  * 
  36.  * This file, and the files included with this file, is distributed
  37.  * and made available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY
  38.  * KIND, EITHER EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS
  39.  * ALL SUCH WARRANTIES, INCLUDING WITHOUT LIMITATION, ANY WARRANTIES
  40.  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, QUIET
  41.  * ENJOYMENT OR NON-INFRINGEMENT.
  42.  * 
  43.  * Technology Compatibility Kit Test Suite(s) Location:
  44.  *    http://www.helixcommunity.org/content/tck
  45.  * 
  46.  * Contributor(s):
  47.  * 
  48.  * ***** END LICENSE BLOCK ***** */
  49. #ifndef SMART_POINTER_H
  50. #define SMART_POINTER_H
  51. #include "hxcom.h"
  52. //
  53. // Smart Pointer class that works with any pointer derived from IUnknown
  54. template<class T>
  55. class CHXTSmartPtr
  56. {
  57. public:
  58. // contruction
  59. CHXTSmartPtr( T *ptr = 0 );
  60. CHXTSmartPtr( const CHXTSmartPtr<T> &spCopy );
  61. ~CHXTSmartPtr();
  62. // operators
  63. CHXTSmartPtr<T>& operator=( CHXTSmartPtr<T> &sp );
  64. CHXTSmartPtr<T>& operator=( T *ptr );
  65. bool operator==( const CHXTSmartPtr<T> &sp ) const;
  66. bool operator==( const T *ptr ) const;
  67. bool operator!=( const CHXTSmartPtr<T>& sp ) const;
  68. bool operator!=( const T * ptr ) const;
  69. bool operator<( const CHXTSmartPtr<T> &sp ) const;
  70. bool operator<( const T *ptr ) const;
  71. bool operator>( const CHXTSmartPtr<T> &sp ) const;
  72. bool operator>( const T *ptr ) const;
  73. T* operator->() const;
  74. T& operator*() const;
  75. operator T*() const;
  76. T* RawPointer() const; // allows explicit access to pointer without having to cast
  77. ///////////////////////////////////////////////////////////////////////////
  78. // additional accessors
  79. //
  80. // The Adopt method assumes a pointer without AddRef'ing it.
  81. // This is usefull when calling COM methods that do an Automatic AddRef.
  82. //
  83. // example:
  84. //
  85. // Foo::GetObject( IUnknown **pUnk )
  86. // {
  87. // *pUnk = new MyObject();
  88. // pUnk->AddRef();
  89. // }
  90. // ...
  91. // pFoo->GetObject( spMySmartPointer->Adopt() );
  92. T** Adopt();
  93. IUnknown** AdoptUnknown();
  94. void** AdoptVoid();
  95. protected:
  96. T *m_ptr;
  97. };
  98. // inline implementation of CHXTSmartPtr<T>
  99. template<class T>
  100. inline CHXTSmartPtr<T>::CHXTSmartPtr( T *ptr ) :
  101. m_ptr( ptr )
  102. {
  103. if ( m_ptr )
  104. {
  105. m_ptr->AddRef();
  106. }
  107. }
  108. template<class T>
  109. inline CHXTSmartPtr<T>::CHXTSmartPtr( const CHXTSmartPtr<T> &spCopy ) :
  110. m_ptr( spCopy.m_ptr ) 
  111. {
  112. if ( m_ptr )
  113. {
  114. m_ptr->AddRef();
  115. }
  116. }
  117. template<class T>
  118. inline CHXTSmartPtr<T>::~CHXTSmartPtr()
  119. {
  120. if ( m_ptr )
  121. {
  122. m_ptr->Release();
  123. m_ptr = 0;
  124. }
  125. }
  126. //
  127. // operators
  128. //
  129. template<class T>
  130. inline CHXTSmartPtr<T>& CHXTSmartPtr<T>::operator=( T *ptr )
  131. {
  132. // release current pointer if any
  133. if ( m_ptr )
  134. {
  135. m_ptr->Release();
  136. }
  137. // copy pointer
  138. m_ptr = ptr;
  139. if ( m_ptr )
  140. {
  141. // add reference
  142. m_ptr->AddRef();
  143. }
  144. return *this;
  145. }
  146. template<class T>
  147. inline CHXTSmartPtr<T>& CHXTSmartPtr<T>::operator=( CHXTSmartPtr<T> &sp )
  148. return operator=( sp.m_ptr );
  149. }
  150. template<class T>
  151. inline bool CHXTSmartPtr<T>::operator==( const CHXTSmartPtr<T> &sp ) const
  152. {
  153. return m_ptr == sp.m_ptr;
  154. }
  155. template<class T>
  156. inline bool CHXTSmartPtr<T>::operator==( const T *ptr ) const
  157. {
  158. return m_ptr == ptr;
  159. }
  160. template<class T>
  161. inline bool CHXTSmartPtr<T>::operator!=( const CHXTSmartPtr<T>& sp ) const
  162. {
  163. return m_ptr != sp.m_ptr;
  164. }
  165. template<class T>
  166. inline bool CHXTSmartPtr<T>::operator!=( const T* ptr ) const
  167. {
  168. return m_ptr != ptr;
  169. }
  170. template<class T>
  171. inline bool CHXTSmartPtr<T>::operator>( const CHXTSmartPtr<T> &sp ) const
  172. {
  173. return m_ptr > sp.m_ptr;
  174. }
  175. template<class T>
  176. inline bool CHXTSmartPtr<T>::operator>( const T *ptr ) const
  177. {
  178. return m_ptr > ptr;
  179. }
  180. template<class T>
  181. inline bool CHXTSmartPtr<T>::operator<( const CHXTSmartPtr<T> &sp ) const
  182. {
  183. return m_ptr < sp.m_ptr;
  184. }
  185. template<class T>
  186. inline bool CHXTSmartPtr<T>::operator<( const T *ptr ) const
  187. {
  188. return m_ptr < ptr;
  189. }
  190. template<class T>
  191. inline T* CHXTSmartPtr<T>::RawPointer() const
  192. {
  193. return m_ptr;
  194. }
  195. template<class T>
  196. inline T* CHXTSmartPtr<T>::operator->() const
  197. {
  198. return m_ptr;
  199. }
  200. template<class T>
  201. inline T& CHXTSmartPtr<T>::operator*() const
  202. {
  203. return *m_ptr;
  204. }
  205. template<class T>
  206. inline CHXTSmartPtr<T>::operator T*() const
  207. {
  208. return m_ptr;
  209. }
  210. template<class T>
  211. inline T** CHXTSmartPtr<T>::Adopt()
  212. {
  213. HX_RELEASE( m_ptr );
  214. return &m_ptr;
  215. }
  216. template<class T>
  217. inline IUnknown** CHXTSmartPtr<T>::AdoptUnknown()
  218. {
  219. HX_RELEASE( m_ptr );
  220. return (IUnknown**) &m_ptr;
  221. }
  222. template<class T>
  223. inline void** CHXTSmartPtr<T>::AdoptVoid()
  224. {
  225. HX_RELEASE( m_ptr );
  226. return (void**) &m_ptr;
  227. }
  228. #define HXT_MAKE_CLASS_SMART_PTR_BY_NAME( ClassName, PointerName ) typedef CHXTSmartPtr<ClassName> PointerName;
  229. #define HXT_MAKE_CLASS_SMART_PTR( ClassName ) HXT_MAKE_CLASS_SMART_PTR_BY_NAME( ClassName, ClassName ## Ptr )
  230. //  Query does a QI on the argument pointer and stores the result internally.
  231. //  eg. if ( spMyObject.Query( pCompositeObjectWhichImplementsMyObject ) )
  232. // { do stuff ... }
  233. //#define HXT_MAKE_SMART_QUERY_PTR_WITH_GUID( ClassName, THIS_CLSIID )
  234. #define HXT_MAKE_SMART_QUERY_PTR_BY_NAME_WITH_GUID( ClassName, PointerName, THIS_CLSIID )
  235. class PointerName : public CHXTSmartPtr<ClassName>
  236. {
  237. public:
  238. HX_RESULT Query( IUnknown *pIUnknown )
  239. {
  240. HX_RELEASE( m_ptr );
  241. return pIUnknown->QueryInterface( THIS_CLSIID, (void**) &m_ptr );
  242. }
  243. HX_RESULT QuerySelf()
  244. {
  245. ClassName *pResult;
  246. HX_RESULT res = m_ptr->QueryInterface( THIS_CLSIID,
  247.    (void**) &pResult );
  248. if ( SUCCEEDED( res ) )
  249. {
  250. m_ptr = pResult;
  251. pResult->Release(); /* release additional reference from QI */
  252. }
  253. return res;
  254. }
  255.                                                                                 
  256.         template <class TAFactory>                                              
  257.         HX_RESULT CreateFromFactory( TAFactory pFactory )                       
  258.         {                                                                       
  259.             return pFactory->CreateInstance( THIS_CLSIID, AdoptVoid() );        
  260.         }                                                                       
  261.                                                                                 
  262. ClassName ## Ptr() :
  263. CHXTSmartPtr<ClassName>() {}     
  264. ClassName ## Ptr( ClassName *ptr ) :
  265. CHXTSmartPtr<ClassName>( ptr ) {}
  266. ClassName ## Ptr( const ClassName ## Ptr &spCopy ):
  267. CHXTSmartPtr<ClassName>( spCopy.m_ptr ) {}
  268. ClassName ## Ptr& operator=( ClassName *ptr )
  269. { CHXTSmartPtr<ClassName>::operator=( ptr ); return *this; }
  270. ClassName ## Ptr& operator=( ClassName ## Ptr &sp )
  271. { return ClassName ## Ptr::operator=( sp.m_ptr ); }
  272. bool operator==( const ClassName *ptr ) const
  273. { return m_ptr == ptr; }
  274. bool operator==( const ClassName ## Ptr &sp ) const
  275. { return operator==( sp.m_ptr ); }
  276. bool operator!=( const ClassName * ptr ) const
  277. { return m_ptr != ptr; }
  278. bool operator!=( const ClassName ## Ptr& sp ) const
  279. { return operator!=( sp.m_ptr ); }
  280. };
  281. #define HXT_MAKE_SMART_QUERY_PTR_BY_NAME( ClassName, PointerName ) HXT_MAKE_SMART_QUERY_PTR_BY_NAME_WITH_GUID( ClassName, PointerName, IID_ ## ClassName )
  282. #define HXT_MAKE_SMART_QUERY_PTR_WITH_GUID( ClassName, THIS_CLSIID ) HXT_MAKE_SMART_QUERY_PTR_BY_NAME_WITH_GUID( ClassName, ClassName ## Ptr, THIS_CLSIID )
  283. #define HXT_MAKE_SMART_QUERY_PTR( ClassName ) HXT_MAKE_SMART_QUERY_PTR_WITH_GUID( ClassName, IID_ ## ClassName )
  284. #define HXT_MAKE_SMART_PTR HXT_MAKE_SMART_QUERY_PTR
  285. #define HXT_MAKE_SMART_PTR_WITH_GUID HXT_MAKE_SMART_QUERY_PTR_WITH_GUID 
  286. #define HXT_DEFINE_SMART_PTR( ClassName ) struct ClassName; typedef CHXTSmartPtr<ClassName> ClassName ## Ptr;
  287. // if hxassert.h has been included
  288. #ifdef _HXASSERT_H_
  289. template <class TSmartPointer>
  290. void AssertValidInterface( TSmartPointer spTest )
  291. {
  292. TSmartPointer spCheckBefore = spTest;
  293. spTest.QuerySelf();
  294. HX_ASSERT( spCheckBefore == spTest );
  295. }
  296. #endif
  297. #if defined( DEBUG ) || defined( _DEBUG )
  298. #define ASSERT_VALID_INTERFACE AssertValidInterface
  299. #else
  300. #define ASSERT_VALID_INTERFACE
  301. #endif
  302. #endif // SMART_POINTER_H