ihash.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) 2015 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_IHASH__
00032 #define __ETL_IHASH__
00033 
00034 #include <stdint.h>
00035 #include <utility>
00036 
00037 #include "platform.h "
00038 #include "exception.h "
00039 #include "error_handler.h "
00040 
00041 ///\defgroup ihash Common data for all hash type classes.
00042 ///\ingroup hash
00043 
00044 #undef ETL_FILE
00045 #define ETL_FILE "19"
00046 
00047 namespace etl
00048 {
00049   //***************************************************************************
00050   ///\ingroup hash
00051   /// Exception base for hashes.
00052   //***************************************************************************
00053   class hash_exception : public exception
00054   {
00055   public:
00056 
00057     hash_exception(string_type reason_, string_type file_name_, numeric_type line_number_)
00058       : exception(reason_, file_name_, line_number_)
00059     {}
00060   };
00061 
00062   //***************************************************************************
00063   ///\ingroup vector
00064   /// Hash finalised exception.
00065   //***************************************************************************
00066   class hash_finalised : public hash_exception
00067   {
00068   public:
00069 
00070     hash_finalised(string_type file_name_, numeric_type line_number_)
00071       : hash_exception(ETL_ERROR_TEXT("ihash:finalised", ETL_FILE"A"), file_name_, line_number_)
00072     {}
00073   };
00074 
00075   /// For the Americans
00076   typedef hash_finalised hash_finalized;
00077 }
00078 
00079 #undef ETL_FILE
00080 
00081 #endif
00082