EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

platform/mbed_assert.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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