00001 /* ///////////////////////////////////////////////////////////////////////// 00002 * File: winstl/system/console_ctrl_handler_scope.hpp 00003 * 00004 * Purpose: Contains the basic_console_ctrl_handler_scope class. 00005 * 00006 * Created: 8th August 2004 00007 * Updated: 10th August 2009 00008 * 00009 * Home: http://stlsoft.org/ 00010 * 00011 * Copyright (c) 2004-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 00049 #ifndef WINSTL_INCL_WINSTL_SYSTEM_HPP_CONSOLE_CTRL_HANDLER_SCOPE 00050 #define WINSTL_INCL_WINSTL_SYSTEM_HPP_CONSOLE_CTRL_HANDLER_SCOPE 00051 00052 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION 00053 # define WINSTL_VER_WINSTL_SYSTEM_HPP_CONSOLE_CTRL_HANDLER_SCOPE_MAJOR 4 00054 # define WINSTL_VER_WINSTL_SYSTEM_HPP_CONSOLE_CTRL_HANDLER_SCOPE_MINOR 0 00055 # define WINSTL_VER_WINSTL_SYSTEM_HPP_CONSOLE_CTRL_HANDLER_SCOPE_REVISION 2 00056 # define WINSTL_VER_WINSTL_SYSTEM_HPP_CONSOLE_CTRL_HANDLER_SCOPE_EDIT 25 00057 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ 00058 00059 /* ///////////////////////////////////////////////////////////////////////// 00060 * Compatibility 00061 */ 00062 00063 /* 00064 [Incompatibilies-start] 00065 [Incompatibilies-end] 00066 */ 00067 00068 /* ///////////////////////////////////////////////////////////////////////// 00069 * Includes 00070 */ 00071 00072 #ifndef WINSTL_INCL_WINSTL_H_WINSTL 00073 # include <winstl/winstl.h> 00074 #endif /* !WINSTL_INCL_WINSTL_H_WINSTL */ 00075 00076 /* ///////////////////////////////////////////////////////////////////////// 00077 * Namespace 00078 */ 00079 00080 #ifndef _WINSTL_NO_NAMESPACE 00081 # if defined(_STLSOFT_NO_NAMESPACE) || \ 00082 defined(STLSOFT_DOCUMENTATION_SKIP_SECTION) 00083 /* There is no stlsoft namespace, so must define ::winstl */ 00084 namespace winstl 00085 { 00086 # else 00087 /* Define stlsoft::winstl_project */ 00088 00089 namespace stlsoft 00090 { 00091 00092 namespace winstl_project 00093 { 00094 00095 # endif /* _STLSOFT_NO_NAMESPACE */ 00096 #endif /* !_WINSTL_NO_NAMESPACE */ 00097 00098 /* ///////////////////////////////////////////////////////////////////////// 00099 * Classes 00100 */ 00101 00106 class console_ctrl_handler_scope 00107 { 00110 public: 00111 typedef console_ctrl_handler_scope class_type; 00113 00116 public: 00120 ss_explicit_k console_ctrl_handler_scope(PHANDLER_ROUTINE handler) 00121 : m_handler(handler) 00122 , m_bRegistered(::SetConsoleCtrlHandler(handler, true)) 00123 {} 00125 ~console_ctrl_handler_scope() stlsoft_throw_0() 00126 { 00127 if(m_bRegistered) 00128 { 00129 ::SetConsoleCtrlHandler(m_handler, false); 00130 } 00131 } 00133 00136 private: 00137 const PHANDLER_ROUTINE m_handler; 00138 const BOOL m_bRegistered; 00140 00143 private: 00144 console_ctrl_handler_scope(class_type const&); 00145 class_type& operator =(class_type const&); 00147 }; 00148 00149 /* ///////////////////////////////////////////////////////////////////////// 00150 * Unit-testing 00151 */ 00152 00153 #ifdef STLSOFT_UNITTEST 00154 # include "./unittest/console_ctrl_handler_scope_unittest_.h" 00155 #endif /* STLSOFT_UNITTEST */ 00156 00157 /* ////////////////////////////////////////////////////////////////////// */ 00158 00159 #ifndef _WINSTL_NO_NAMESPACE 00160 # if defined(_STLSOFT_NO_NAMESPACE) || \ 00161 defined(STLSOFT_DOCUMENTATION_SKIP_SECTION) 00162 } // namespace winstl 00163 # else 00164 } // namespace winstl_project 00165 } // namespace stlsoft 00166 # endif /* _STLSOFT_NO_NAMESPACE */ 00167 #endif /* !_WINSTL_NO_NAMESPACE */ 00168 00169 /* ////////////////////////////////////////////////////////////////////// */ 00170 00171 #endif /* WINSTL_INCL_WINSTL_SYSTEM_HPP_CONSOLE_CTRL_HANDLER_SCOPE */ 00172 00173 /* ///////////////////////////// end of file //////////////////////////// */