00001 /* ///////////////////////////////////////////////////////////////////////// 00002 * File: comstl/util/refcount_functions.h 00003 * 00004 * Purpose: Reference-counting helper functions. 00005 * 00006 * Created: 25th June 2002 00007 * Updated: 10th August 2009 00008 * 00009 * Home: http://stlsoft.org/ 00010 * 00011 * Copyright (c) 2002-2009, Matthew Wilson and Synesis Software 00012 * All rights reserved. 00013 * 00014 * Redistribution and use in source and binary forms, with or without 00015 * modification, are permitted provided that the following conditions are met: 00016 * 00017 * - Redistributions of source code must retain the above copyright notice, this 00018 * list of conditions and the following disclaimer. 00019 * - Redistributions in binary form must reproduce the above copyright notice, 00020 * this list of conditions and the following disclaimer in the documentation 00021 * and/or other materials provided with the distribution. 00022 * - Neither the name(s) of Matthew Wilson and Synesis Software nor the names of 00023 * any contributors may be used to endorse or promote products derived from 00024 * this software without specific prior written permission. 00025 * 00026 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 00027 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00028 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 00029 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 00030 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 00031 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 00032 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 00033 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 00034 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 00035 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 00036 * POSSIBILITY OF SUCH DAMAGE. 00037 * 00038 * ////////////////////////////////////////////////////////////////////// */ 00039 00040 00047 #ifndef COMSTL_INCL_COMSTL_UTIL_H_REFCOUNT_FUNCTIONS 00048 #define COMSTL_INCL_COMSTL_UTIL_H_REFCOUNT_FUNCTIONS 00049 00050 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION 00051 # define COMSTL_VER_COMSTL_UTIL_H_REFCOUNT_FUNCTIONS_MAJOR 4 00052 # define COMSTL_VER_COMSTL_UTIL_H_REFCOUNT_FUNCTIONS_MINOR 1 00053 # define COMSTL_VER_COMSTL_UTIL_H_REFCOUNT_FUNCTIONS_REVISION 2 00054 # define COMSTL_VER_COMSTL_UTIL_H_REFCOUNT_FUNCTIONS_EDIT 59 00055 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ 00056 00057 /* ///////////////////////////////////////////////////////////////////////// 00058 * Includes 00059 */ 00060 00061 #ifndef COMSTL_INCL_COMSTL_H_COMSTL 00062 # include <comstl/comstl.h> 00063 #endif /* !COMSTL_INCL_COMSTL_H_COMSTL */ 00064 00065 /* ///////////////////////////////////////////////////////////////////////// 00066 * Namespace 00067 */ 00068 00069 #if !defined(_COMSTL_NO_NAMESPACE) && \ 00070 !defined(STLSOFT_DOCUMENTATION_SKIP_SECTION) 00071 # if defined(_STLSOFT_NO_NAMESPACE) 00072 /* There is no stlsoft namespace, so must define ::comstl */ 00073 namespace comstl 00074 { 00075 # else 00076 /* Define stlsoft::comstl_project */ 00077 00078 namespace stlsoft 00079 { 00080 00081 namespace comstl_project 00082 { 00083 00084 # endif /* _STLSOFT_NO_NAMESPACE */ 00085 #endif /* !_COMSTL_NO_NAMESPACE */ 00086 00087 /* ///////////////////////////////////////////////////////////////////////// 00088 * C functions 00089 */ 00090 00099 STLSOFT_INLINE void comstl__addref(LPUNKNOWN punk) 00100 { 00101 COMSTL_MESSAGE_ASSERT("Cannot call AddRef() on NULL interface pointer", NULL != punk); 00102 00103 COMSTL_ITF_CALL(punk)->AddRef(COMSTL_ITF_THIS0(punk)); 00104 } 00105 00112 STLSOFT_INLINE void comstl__release(LPUNKNOWN punk) 00113 { 00114 COMSTL_ITF_CALL(punk)->Release(COMSTL_ITF_THIS0(punk)); 00115 } 00116 00123 STLSOFT_INLINE void comstl__safe_addref(LPUNKNOWN punk) 00124 { 00125 if(NULL != punk) 00126 { 00127 comstl__addref(punk); 00128 } 00129 } 00130 00137 STLSOFT_INLINE void comstl__safe_release(LPUNKNOWN punk) 00138 { 00139 if(NULL != punk) 00140 { 00141 comstl__release(punk); 00142 } 00143 } 00144 00145 /* ///////////////////////////////////////////////////////////////////////// 00146 * Namespace 00147 */ 00148 00149 #ifdef STLSOFT_DOCUMENTATION_SKIP_SECTION 00150 namespace comstl 00151 { 00152 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ 00153 00154 /* ///////////////////////////////////////////////////////////////////////// 00155 * C++ functions 00156 */ 00157 00158 #ifdef __cplusplus 00159 00168 inline void addref(LPUNKNOWN punk) 00169 { 00170 comstl__addref(punk); 00171 } 00172 00179 inline void release(LPUNKNOWN punk) 00180 { 00181 comstl__release(punk); 00182 } 00183 00190 inline void safe_addref(LPUNKNOWN punk) 00191 { 00192 comstl__safe_addref(punk); 00193 } 00194 00201 inline void safe_release(LPUNKNOWN punk) 00202 { 00203 comstl__safe_release(punk); 00204 } 00205 00212 template <ss_typename_param_k T> 00213 inline void release_set_null(T *&pt) 00214 { 00215 if(NULL != pt) 00216 { 00217 release(pt); 00218 pt = NULL; 00219 } 00220 } 00221 00222 #endif /* __cplusplus */ 00223 00224 /* ///////////////////////////////////////////////////////////////////////// 00225 * Unit-testing 00226 */ 00227 00228 #ifdef STLSOFT_UNITTEST 00229 # include "./unittest/refcount_functions_unittest_.h" 00230 #endif /* STLSOFT_UNITTEST */ 00231 00232 /* ////////////////////////////////////////////////////////////////////// */ 00233 00234 #ifndef _COMSTL_NO_NAMESPACE 00235 # if defined(_STLSOFT_NO_NAMESPACE) || \ 00236 defined(STLSOFT_DOCUMENTATION_SKIP_SECTION) 00237 } /* namespace comstl */ 00238 # else 00239 } /* namespace comstl_project */ 00240 } /* namespace stlsoft */ 00241 # endif /* _STLSOFT_NO_NAMESPACE */ 00242 #endif /* !_COMSTL_NO_NAMESPACE */ 00243 00244 /* ////////////////////////////////////////////////////////////////////// */ 00245 00246 #endif /* !COMSTL_INCL_COMSTL_UTIL_H_REFCOUNT_FUNCTIONS */ 00247 00248 /* ///////////////////////////// end of file //////////////////////////// */