Aleksandrs Gumenuks / MaximInterface_Extended

Extended MaximInterface

Dependents:   mbed_DS28EC20_GPIO

Utilities/SafeBool.hpp@10:de4b8812877d, 2020-01-06 (annotated)

Committer:
reARMnimator
Date:
Mon Jan 06 15:54:55 2020 +0000
Revision:
10:de4b8812877d
Parent:
7:471901a04573 
Fixed inappropriate include path.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 6:a8c83a2e6fa4 1 /*******************************************************************************
IanBenzMaxim 6:a8c83a2e6fa4 2 * Copyright (C) 2018 Maxim Integrated Products, Inc., All Rights Reserved.
IanBenzMaxim 6:a8c83a2e6fa4 3 *
IanBenzMaxim 6:a8c83a2e6fa4 4 * Permission is hereby granted, free of charge, to any person obtaining a
IanBenzMaxim 6:a8c83a2e6fa4 5 * copy of this software and associated documentation files (the "Software"),
IanBenzMaxim 6:a8c83a2e6fa4 6 * to deal in the Software without restriction, including without limitation
IanBenzMaxim 6:a8c83a2e6fa4 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
IanBenzMaxim 6:a8c83a2e6fa4 8 * and/or sell copies of the Software, and to permit persons to whom the
IanBenzMaxim 6:a8c83a2e6fa4 9 * Software is furnished to do so, subject to the following conditions:
IanBenzMaxim 6:a8c83a2e6fa4 10 *
IanBenzMaxim 6:a8c83a2e6fa4 11 * The above copyright notice and this permission notice shall be included
IanBenzMaxim 6:a8c83a2e6fa4 12 * in all copies or substantial portions of the Software.
IanBenzMaxim 6:a8c83a2e6fa4 13 *
IanBenzMaxim 6:a8c83a2e6fa4 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
IanBenzMaxim 6:a8c83a2e6fa4 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
IanBenzMaxim 6:a8c83a2e6fa4 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IanBenzMaxim 6:a8c83a2e6fa4 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
IanBenzMaxim 6:a8c83a2e6fa4 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
IanBenzMaxim 6:a8c83a2e6fa4 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
IanBenzMaxim 6:a8c83a2e6fa4 20 * OTHER DEALINGS IN THE SOFTWARE.
IanBenzMaxim 6:a8c83a2e6fa4 21 *
IanBenzMaxim 6:a8c83a2e6fa4 22 * Except as contained in this notice, the name of Maxim Integrated
IanBenzMaxim 6:a8c83a2e6fa4 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
IanBenzMaxim 6:a8c83a2e6fa4 24 * Products, Inc. Branding Policy.
IanBenzMaxim 6:a8c83a2e6fa4 25 *
IanBenzMaxim 6:a8c83a2e6fa4 26 * The mere transfer of this software does not imply any licenses
IanBenzMaxim 6:a8c83a2e6fa4 27 * of trade secrets, proprietary technology, copyrights, patents,
IanBenzMaxim 6:a8c83a2e6fa4 28 * trademarks, maskwork rights, or any other form of intellectual
IanBenzMaxim 6:a8c83a2e6fa4 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
IanBenzMaxim 6:a8c83a2e6fa4 30 * ownership rights.
IanBenzMaxim 6:a8c83a2e6fa4 31 *******************************************************************************/
IanBenzMaxim 6:a8c83a2e6fa4 32
IanBenzMaxim 6:a8c83a2e6fa4 33 #ifndef MaximInterface_SafeBool
IanBenzMaxim 6:a8c83a2e6fa4 34 #define MaximInterface_SafeBool
IanBenzMaxim 6:a8c83a2e6fa4 35
IanBenzMaxim 6:a8c83a2e6fa4 36 #include <stddef.h>
IanBenzMaxim 6:a8c83a2e6fa4 37
IanBenzMaxim 6:a8c83a2e6fa4 38 namespace MaximInterface {
IanBenzMaxim 6:a8c83a2e6fa4 39 namespace detail {
IanBenzMaxim 6:a8c83a2e6fa4 40
IanBenzMaxim 6:a8c83a2e6fa4 41 // Implement SafeBool as a member function pointer since some compilers allow
IanBenzMaxim 6:a8c83a2e6fa4 42 // function pointer to void pointer conversion.
IanBenzMaxim 6:a8c83a2e6fa4 43 struct SafeBoolHelper {
IanBenzMaxim 6:a8c83a2e6fa4 44 void trueValue() const {}
IanBenzMaxim 6:a8c83a2e6fa4 45
IanBenzMaxim 6:a8c83a2e6fa4 46 private:
IanBenzMaxim 6:a8c83a2e6fa4 47 SafeBoolHelper(); // deleted
IanBenzMaxim 6:a8c83a2e6fa4 48 };
IanBenzMaxim 6:a8c83a2e6fa4 49
IanBenzMaxim 6:a8c83a2e6fa4 50 } // namespace detail
IanBenzMaxim 6:a8c83a2e6fa4 51
IanBenzMaxim 7:471901a04573 52 /// @brief Type definition for SafeBool.
IanBenzMaxim 7:471901a04573 53 /// @details
IanBenzMaxim 6:a8c83a2e6fa4 54 /// SafeBool is a boolean type that eliminates many error-prone implicit
IanBenzMaxim 6:a8c83a2e6fa4 55 /// conversions allowed by the fundamental bool type.
IanBenzMaxim 6:a8c83a2e6fa4 56 /// @note
IanBenzMaxim 6:a8c83a2e6fa4 57 /// SafeBool can be used to add an explicit bool conversion operator to a type.
IanBenzMaxim 6:a8c83a2e6fa4 58 typedef void (detail::SafeBoolHelper::*SafeBool)() const;
IanBenzMaxim 6:a8c83a2e6fa4 59
IanBenzMaxim 6:a8c83a2e6fa4 60 /// Constructor for SafeBool.
IanBenzMaxim 6:a8c83a2e6fa4 61 inline SafeBool makeSafeBool(bool value) {
IanBenzMaxim 6:a8c83a2e6fa4 62 return value ? &detail::SafeBoolHelper::trueValue : NULL;
IanBenzMaxim 6:a8c83a2e6fa4 63 }
IanBenzMaxim 6:a8c83a2e6fa4 64
IanBenzMaxim 6:a8c83a2e6fa4 65 } // namespace MaximInterface
IanBenzMaxim 6:a8c83a2e6fa4 66
IanBenzMaxim 6:a8c83a2e6fa4 67 #endif