00001 /* ///////////////////////////////////////////////////////////////////////// 00002 * File: stlsoft/util/unused_return_value_monitor.hpp 00003 * 00004 * Purpose: Basic functionals. 00005 * 00006 * Created: 8th 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 00048 #ifndef STLSOFT_INCL_STLSOFT_UTIL_HPP_UNUSED_RETURN_VALUE_MONITOR 00049 #define STLSOFT_INCL_STLSOFT_UTIL_HPP_UNUSED_RETURN_VALUE_MONITOR 00050 00051 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION 00052 # define STLSOFT_VER_STLSOFT_UTIL_HPP_UNUSED_RETURN_VALUE_MONITOR_MAJOR 4 00053 # define STLSOFT_VER_STLSOFT_UTIL_HPP_UNUSED_RETURN_VALUE_MONITOR_MINOR 0 00054 # define STLSOFT_VER_STLSOFT_UTIL_HPP_UNUSED_RETURN_VALUE_MONITOR_REVISION 1 00055 # define STLSOFT_VER_STLSOFT_UTIL_HPP_UNUSED_RETURN_VALUE_MONITOR_EDIT 43 00056 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ 00057 00058 /* ///////////////////////////////////////////////////////////////////////// 00059 * Includes 00060 */ 00061 00062 #ifndef STLSOFT_INCL_STLSOFT_H_STLSOFT 00063 # include <stlsoft/stlsoft.h> 00064 #endif /* !STLSOFT_INCL_STLSOFT_H_STLSOFT */ 00065 00066 /* ///////////////////////////////////////////////////////////////////////// 00067 * Namespace 00068 */ 00069 00070 #ifndef _STLSOFT_NO_NAMESPACE 00071 namespace stlsoft 00072 { 00073 #endif /* _STLSOFT_NO_NAMESPACE */ 00074 00075 /* ///////////////////////////////////////////////////////////////////////// 00076 * Classes 00077 */ 00078 00149 template< ss_typename_param_k V 00150 , ss_typename_param_k M 00151 , ss_typename_param_k R = V // Could be V const&, if you know the value is to persist 00152 > 00153 // class unused_return_value_monitor 00154 class unused_return_value_monitor 00155 { 00156 public: 00157 typedef V value_type; 00158 typedef M monitor_function; 00159 typedef R reference_type; 00160 typedef unused_return_value_monitor<V, M, R> class_type; 00161 00164 public: 00165 /* ss_explicit_k */ unused_return_value_monitor(reference_type value) 00166 : m_value(value) 00167 , m_monitorFn() 00168 , m_bUsed(false) 00169 {} 00170 unused_return_value_monitor(reference_type value, monitor_function monitorFn) 00171 : m_value(value) 00172 , m_monitorFn(monitorFn) 00173 , m_bUsed(false) 00174 {} 00175 unused_return_value_monitor(class_type const& rhs) 00176 : m_value(rhs.m_value) 00177 , m_monitorFn(rhs.m_monitorFn) 00178 , m_bUsed(rhs.m_bUsed) 00179 { 00180 rhs.m_bUsed = false; 00181 } 00189 ~unused_return_value_monitor() stlsoft_throw_0() 00190 { 00191 if(!m_bUsed) 00192 { 00193 m_monitorFn(this, m_value); 00194 } 00195 } 00197 00200 public: 00201 operator value_type() const 00202 { 00203 const_cast<class_type*>(this)->m_bUsed = true; 00204 00205 return m_value; 00206 } 00208 00213 private: 00214 reference_type m_value; 00215 monitor_function m_monitorFn; 00216 ss_bool_t m_bUsed; 00217 00218 // Not to be implemented 00219 private: 00220 unused_return_value_monitor& operator =(class_type const& rhs); 00221 }; 00222 00223 /* ////////////////////////////////////////////////////////////////////// */ 00224 00225 #ifndef _STLSOFT_NO_NAMESPACE 00226 } // namespace stlsoft 00227 #endif /* _STLSOFT_NO_NAMESPACE */ 00228 00229 /* ////////////////////////////////////////////////////////////////////// */ 00230 00231 #endif /* !STLSOFT_INCL_STLSOFT_UTIL_HPP_UNUSED_RETURN_VALUE_MONITOR */ 00232 00233 /* ///////////////////////////// end of file //////////////////////////// */