zhang boie / mbed-dev-f30333

mbed-dev-f303

platform/mbed_assert.h@0:bdf663c61a82, 2022-06-14 (annotated)

Committer:
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4
Date:
Tue Jun 14 09:21:18 2022 +0000
Revision:
0:bdf663c61a82
lib

Who changed what in which revision?

UserRevisionLine numberNew contents of line
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 1
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 2 /** \addtogroup platform */
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 3 /** @{*/
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 4 /* mbed Microcontroller Library
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 5 * Copyright (c) 2006-2013 ARM Limited
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 6 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 7 * Licensed under the Apache License, Version 2.0 (the "License");
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 8 * you may not use this file except in compliance with the License.
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 9 * You may obtain a copy of the License at
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 10 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 11 * http://www.apache.org/licenses/LICENSE-2.0
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 12 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 13 * Unless required by applicable law or agreed to in writing, software
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 14 * distributed under the License is distributed on an "AS IS" BASIS,
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 16 * See the License for the specific language governing permissions and
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 17 * limitations under the License.
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 18 */
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 19 #ifndef MBED_ASSERT_H
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 20 #define MBED_ASSERT_H
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 21
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 22 #include "mbed_preprocessor.h"
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 23
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 24 #ifdef __cplusplus
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 25 extern "C" {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 26 #endif
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 27
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 28 /** Internal mbed assert function which is invoked when MBED_ASSERT macro failes.
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 29 * This function is active only if NDEBUG is not defined prior to including this
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 30 * assert header file.
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 31 * In case of MBED_ASSERT failing condition, error() is called with the assertation message.
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 32 * @param expr Expresion to be checked.
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 33 * @param file File where assertation failed.
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 34 * @param line Failing assertation line number.
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 35 */
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 36 void mbed_assert_internal(const char *expr, const char *file, int line);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 37
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 38 #ifdef __cplusplus
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 39 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 40 #endif
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 41
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 42 #ifdef NDEBUG
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 43 #define MBED_ASSERT(expr) ((void)0)
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 44
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 45 #else
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 46 #define MBED_ASSERT(expr) \
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 47 do { \
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 48 if (!(expr)) { \
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 49 mbed_assert_internal(#expr, __FILE__, __LINE__); \
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 50 } \
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 51 } while (0)
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 52 #endif
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 53
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 54
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 55 /** MBED_STATIC_ASSERT
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 56 * Declare compile-time assertions, results in compile-time error if condition is false
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 57 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 58 * The assertion acts as a declaration that can be placed at file scope, in a
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 59 * code block (except after a label), or as a member of a C++ class/struct/union.
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 60 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 61 * @note
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 62 * Use of MBED_STATIC_ASSERT as a member of a struct/union is limited:
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 63 * - In C++, MBED_STATIC_ASSERT is valid in class/struct/union scope.
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 64 * - In C, MBED_STATIC_ASSERT is not valid in struct/union scope, and
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 65 * MBED_STRUCT_STATIC_ASSERT is provided as an alternative that is valid
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 66 * in C and C++ class/struct/union scope.
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 67 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 68 * @code
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 69 * MBED_STATIC_ASSERT(MBED_LIBRARY_VERSION >= 120,
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 70 * "The mbed library must be at least version 120");
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 71 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 72 * int main() {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 73 * MBED_STATIC_ASSERT(sizeof(int) >= sizeof(char),
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 74 * "An int must be larger than a char");
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 75 * }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 76 * @endcode
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 77 */
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 78 #if defined(__cplusplus) && (__cplusplus >= 201103L || __cpp_static_assert >= 200410L)
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 79 #define MBED_STATIC_ASSERT(expr, msg) static_assert(expr, msg)
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 80 #elif !defined(__cplusplus) && __STDC_VERSION__ >= 201112L
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 81 #define MBED_STATIC_ASSERT(expr, msg) _Static_assert(expr, msg)
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 82 #elif defined(__cplusplus) && defined(__GNUC__) && defined(__GXX_EXPERIMENTAL_CXX0X__) \
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 83 && (__GNUC__*100 + __GNUC_MINOR__) > 403L
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 84 #define MBED_STATIC_ASSERT(expr, msg) __extension__ static_assert(expr, msg)
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 85 #elif !defined(__cplusplus) && defined(__GNUC__) && !defined(__CC_ARM) \
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 86 && (__GNUC__*100 + __GNUC_MINOR__) > 406L
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 87 #define MBED_STATIC_ASSERT(expr, msg) __extension__ _Static_assert(expr, msg)
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 88 #elif defined(__ICCARM__)
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 89 #define MBED_STATIC_ASSERT(expr, msg) static_assert(expr, msg)
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 90 #else
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 91 #define MBED_STATIC_ASSERT(expr, msg) \
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 92 enum {MBED_CONCAT(MBED_ASSERTION_AT_, __LINE__) = sizeof(char[(expr) ? 1 : -1])}
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 93 #endif
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 94
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 95 /** MBED_STRUCT_STATIC_ASSERT
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 96 * Declare compile-time assertions, results in compile-time error if condition is false
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 97 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 98 * Unlike MBED_STATIC_ASSERT, MBED_STRUCT_STATIC_ASSERT can and must be used
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 99 * as a member of a C/C++ class/struct/union.
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 100 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 101 * @code
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 102 * struct thing {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 103 * MBED_STATIC_ASSERT(2 + 2 == 4,
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 104 * "Hopefully the universe is mathematically consistent");
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 105 * };
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 106 * @endcode
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 107 */
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 108 #define MBED_STRUCT_STATIC_ASSERT(expr, msg) int : (expr) ? 0 : -1
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 109
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 110
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 111 #endif
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 112
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 113 /** @}*/
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 114