SafeBool.hpp

00001 /*******************************************************************************
00002 * Copyright (C) 2018 Maxim Integrated Products, Inc., All Rights Reserved.
00003 *
00004 * Permission is hereby granted, free of charge, to any person obtaining a
00005 * copy of this software and associated documentation files (the "Software"),
00006 * to deal in the Software without restriction, including without limitation
00007 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00008 * and/or sell copies of the Software, and to permit persons to whom the
00009 * Software is furnished to do so, subject to the following conditions:
00010 *
00011 * The above copyright notice and this permission notice shall be included
00012 * in all copies or substantial portions of the Software.
00013 *
00014 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00015 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00017 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
00018 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00019 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00020 * OTHER DEALINGS IN THE SOFTWARE.
00021 *
00022 * Except as contained in this notice, the name of Maxim Integrated
00023 * Products, Inc. shall not be used except as stated in the Maxim Integrated
00024 * Products, Inc. Branding Policy.
00025 *
00026 * The mere transfer of this software does not imply any licenses
00027 * of trade secrets, proprietary technology, copyrights, patents,
00028 * trademarks, maskwork rights, or any other form of intellectual
00029 * property whatsoever. Maxim Integrated Products, Inc. retains all
00030 * ownership rights.
00031 *******************************************************************************/
00032 
00033 #ifndef MaximInterface_SafeBool
00034 #define MaximInterface_SafeBool
00035 
00036 #include <stddef.h>
00037 
00038 namespace MaximInterface {
00039 namespace detail {
00040 
00041 // Implement SafeBool as a member function pointer since some compilers allow
00042 // function pointer to void pointer conversion.
00043 struct SafeBoolHelper {
00044   void trueValue() const {}
00045   
00046 private:
00047   SafeBoolHelper(); // deleted
00048 };
00049 
00050 } // namespace detail
00051 
00052 /// @brief Type definition for SafeBool.
00053 /// @details
00054 /// SafeBool is a boolean type that eliminates many error-prone implicit
00055 /// conversions allowed by the fundamental bool type.
00056 /// @note
00057 /// SafeBool can be used to add an explicit bool conversion operator to a type.
00058 typedef void (detail::SafeBoolHelper::*SafeBool)() const;
00059 
00060 /// Constructor for SafeBool.
00061 inline SafeBool makeSafeBool(bool value) {
00062   return value ? &detail::SafeBoolHelper::trueValue : NULL;
00063 }
00064 
00065 } // namespace MaximInterface
00066 
00067 #endif