00001 /* ///////////////////////////////////////////////////////////////////////// 00002 * File: stlsoft/error/iteration_interruption.hpp 00003 * 00004 * Purpose: An exception thrown when an active end iterator is exhausted. 00005 * 00006 * Created: 30th November 2005 00007 * Updated: 10th August 2009 00008 * 00009 * Home: http://stlsoft.org/ 00010 * 00011 * Copyright (c) 2005-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_ERROR_HPP_ITERATION_INTERRUPTION 00049 #define STLSOFT_INCL_STLSOFT_ERROR_HPP_ITERATION_INTERRUPTION 00050 00051 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION 00052 # define STLSOFT_VER_STLSOFT_ERROR_HPP_ITERATION_INTERRUPTION_MAJOR 2 00053 # define STLSOFT_VER_STLSOFT_ERROR_HPP_ITERATION_INTERRUPTION_MINOR 0 00054 # define STLSOFT_VER_STLSOFT_ERROR_HPP_ITERATION_INTERRUPTION_REVISION 3 00055 # define STLSOFT_VER_STLSOFT_ERROR_HPP_ITERATION_INTERRUPTION_EDIT 15 00056 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ 00057 00058 /* ///////////////////////////////////////////////////////////////////////// 00059 * Auto-generation and compatibility 00060 */ 00061 00062 /* ///////////////////////////////////////////////////////////////////////// 00063 * Includes 00064 */ 00065 00066 #ifndef STLSOFT_INCL_STLSOFT_H_STLSOFT 00067 # include <stlsoft/stlsoft.h> 00068 #endif /* !STLSOFT_INCL_STLSOFT_H_STLSOFT */ 00069 00070 #ifndef STLSOFT_INCL_STDEXCEPT 00071 # define STLSOFT_INCL_STDEXCEPT 00072 # include <stdexcept> 00073 #endif /* !STLSOFT_INCL_STDEXCEPT */ 00074 00075 /* ///////////////////////////////////////////////////////////////////////// 00076 * Namespace 00077 */ 00078 00079 #ifndef _STLSOFT_NO_NAMESPACE 00080 namespace stlsoft 00081 { 00082 #endif /* _STLSOFT_NO_NAMESPACE */ 00083 00084 /* ///////////////////////////////////////////////////////////////////////// 00085 * Classes 00086 */ 00087 00093 class iteration_interruption 00094 : public stlsoft_ns_qual_std(runtime_error) 00095 { 00098 public: 00099 typedef stlsoft_ns_qual_std(runtime_error) parent_class_type; 00100 typedef iteration_interruption class_type; 00102 00105 public: 00106 iteration_interruption() 00107 : parent_class_type("") 00108 , m_errorCode(0) 00109 {} 00110 ss_explicit_k iteration_interruption(char const* message) 00111 : parent_class_type(message) 00112 , m_errorCode(0) 00113 {} 00114 iteration_interruption(char const* message, long errorCode) 00115 : parent_class_type(message) 00116 , m_errorCode(errorCode) 00117 {} 00118 00119 virtual ~iteration_interruption() throw() 00120 {} 00122 00125 public: 00126 virtual char const* what() const throw() 00127 { 00128 char const* message = parent_class_type::what(); 00129 00130 #if 0 00131 if( NULL == message || 00132 '\0' == *message) 00133 #endif /* 0 */ 00134 { 00135 message = this->real_what_(); 00136 } 00137 00138 return message; 00139 } 00140 00142 virtual long get_error_code() const throw() 00143 { 00144 return m_errorCode; 00145 } 00146 00150 virtual long errorCode() const throw() 00151 { 00152 return get_error_code(); 00153 } 00155 00158 private: 00159 virtual char const* real_what_() const throw() 00160 { 00161 return "iteration interruption"; 00162 } 00164 00167 private: 00168 const long m_errorCode; 00170 00173 private: 00174 class_type& operator =(class_type const&); 00176 }; 00177 00179 // Unit-testing 00180 00181 #ifdef STLSOFT_UNITTEST 00182 # include "./unittest/iteration_interruption_unittest_.h" 00183 #endif /* STLSOFT_UNITTEST */ 00184 00185 /* ////////////////////////////////////////////////////////////////////// */ 00186 00187 #ifndef _STLSOFT_NO_NAMESPACE 00188 } // namespace stlsoft 00189 #endif /* _STLSOFT_NO_NAMESPACE */ 00190 00191 /* ////////////////////////////////////////////////////////////////////// */ 00192 00193 #endif /* !STLSOFT_INCL_STLSOFT_ERROR_HPP_ITERATION_INTERRUPTION */ 00194 00195 /* ///////////////////////////// end of file //////////////////////////// */