exception.h

00001 ///\file
00002 
00003 /******************************************************************************
00004 The MIT License(MIT)
00005 
00006 Embedded Template Library.
00007 https://github.com/ETLCPP/etl
00008 http://www.etlcpp.com
00009 
00010 Copyright(c) 2014 jwellbelove
00011 
00012 Permission is hereby granted, free of charge, to any person obtaining a copy
00013 of this software and associated documentation files(the "Software"), to deal
00014 in the Software without restriction, including without limitation the rights
00015 to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
00016 copies of the Software, and to permit persons to whom the Software is
00017 furnished to do so, subject to the following conditions :
00018 
00019 The above copyright notice and this permission notice shall be included in all
00020 copies or substantial portions of the Software.
00021 
00022 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00023 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00024 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
00025 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00026 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00027 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
00028 SOFTWARE.
00029 ******************************************************************************/
00030 
00031 #ifndef __ETL_EXCEPTION__
00032 #define __ETL_EXCEPTION__
00033 
00034 #include "platform.h "
00035 
00036 ///\defgroup exception exception
00037 /// The base class for all ETL exceptions.
00038 ///\ingroup utilities
00039 
00040 namespace etl
00041 {
00042   //***************************************************************************
00043   ///\ingroup exception
00044   /// A low overhead exception base class.
00045   //***************************************************************************
00046   class exception
00047   {
00048   public:
00049 
00050     typedef const char* string_type;
00051     typedef int         numeric_type;
00052 
00053 #if defined(ETL_VERBOSE_ERRORS)
00054     //*************************************************************************
00055     /// Constructor.
00056     //*************************************************************************
00057     exception(string_type reason_, string_type file_, numeric_type line_)
00058       : reason_text(reason_),
00059         file_text(file_),
00060         line(line_)
00061     {
00062     }
00063 #else
00064     //*************************************************************************
00065     /// Constructor.
00066     //*************************************************************************
00067     exception(string_type reason_, string_type file_, numeric_type line_)
00068       : reason_text(reason_),
00069         line(line_)
00070     {
00071     (void)file_;
00072     }
00073 #endif
00074 
00075     //***************************************************************************
00076     /// Gets the reason for the exception.
00077     /// \return const char* to the reason.
00078     //***************************************************************************
00079     string_type what() const
00080     {
00081       return reason_text;
00082     }
00083 
00084 
00085     //***************************************************************************
00086     /// Gets the file for the exception.
00087     /// \return const char* to the file.
00088     //***************************************************************************
00089     string_type file_name() const
00090     {
00091 #if defined(ETL_VERBOSE_ERRORS)
00092       return file_text;
00093 #else
00094       return "";
00095 #endif
00096     }
00097 
00098     //***************************************************************************
00099     /// Gets the line for the exception.
00100     /// \return const char* to the line.
00101     //***************************************************************************
00102     numeric_type line_number() const
00103     {
00104       return line;
00105     }
00106 
00107   private:
00108 
00109     string_type  reason_text; ///< The reason for the exception.
00110 #if defined(ETL_VERBOSE_ERRORS)
00111     string_type  file_text;   ///< The file for the exception.
00112 #endif
00113     numeric_type line;   ///< The line for the exception.
00114   };
00115 }
00116 
00117 #endif
00118