mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

platform/mbed_error.h@143:86740a56073b, 2017-05-26 (annotated)

Committer:
AnnaBridge
Date:
Fri May 26 12:30:20 2017 +0100
Revision:
143:86740a56073b
Parent:
128:9bcdf88f62b0
Child:
145:64910690c574
Release 143 of the mbed library.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 128:9bcdf88f62b0 1
<> 128:9bcdf88f62b0 2 /** \addtogroup platform */
<> 128:9bcdf88f62b0 3 /** @{*/
<> 128:9bcdf88f62b0 4 /* mbed Microcontroller Library
<> 128:9bcdf88f62b0 5 * Copyright (c) 2006-2013 ARM Limited
<> 128:9bcdf88f62b0 6 *
<> 128:9bcdf88f62b0 7 * Licensed under the Apache License, Version 2.0 (the "License");
<> 128:9bcdf88f62b0 8 * you may not use this file except in compliance with the License.
<> 128:9bcdf88f62b0 9 * You may obtain a copy of the License at
<> 128:9bcdf88f62b0 10 *
<> 128:9bcdf88f62b0 11 * http://www.apache.org/licenses/LICENSE-2.0
<> 128:9bcdf88f62b0 12 *
<> 128:9bcdf88f62b0 13 * Unless required by applicable law or agreed to in writing, software
<> 128:9bcdf88f62b0 14 * distributed under the License is distributed on an "AS IS" BASIS,
<> 128:9bcdf88f62b0 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<> 128:9bcdf88f62b0 16 * See the License for the specific language governing permissions and
<> 128:9bcdf88f62b0 17 * limitations under the License.
<> 128:9bcdf88f62b0 18 */
<> 128:9bcdf88f62b0 19 #ifndef MBED_ERROR_H
<> 128:9bcdf88f62b0 20 #define MBED_ERROR_H
<> 128:9bcdf88f62b0 21
<> 128:9bcdf88f62b0 22 /** To generate a fatal compile-time error, you can use the pre-processor #error directive.
<> 128:9bcdf88f62b0 23 *
<> 128:9bcdf88f62b0 24 * @code
<> 128:9bcdf88f62b0 25 * #error "That shouldn't have happened!"
<> 128:9bcdf88f62b0 26 * @endcode
<> 128:9bcdf88f62b0 27 *
<> 128:9bcdf88f62b0 28 * If the compiler evaluates this line, it will report the error and stop the compile.
<> 128:9bcdf88f62b0 29 *
<> 128:9bcdf88f62b0 30 * For example, you could use this to check some user-defined compile-time variables:
<> 128:9bcdf88f62b0 31 *
<> 128:9bcdf88f62b0 32 * @code
<> 128:9bcdf88f62b0 33 * #define NUM_PORTS 7
<> 128:9bcdf88f62b0 34 * #if (NUM_PORTS > 4)
<> 128:9bcdf88f62b0 35 * #error "NUM_PORTS must be less than 4"
<> 128:9bcdf88f62b0 36 * #endif
<> 128:9bcdf88f62b0 37 * @endcode
<> 128:9bcdf88f62b0 38 *
<> 128:9bcdf88f62b0 39 * Reporting Run-Time Errors:
<> 128:9bcdf88f62b0 40 * To generate a fatal run-time error, you can use the mbed error() function.
<> 128:9bcdf88f62b0 41 *
<> 128:9bcdf88f62b0 42 * @code
<> 128:9bcdf88f62b0 43 * error("That shouldn't have happened!");
<> 128:9bcdf88f62b0 44 * @endcode
<> 128:9bcdf88f62b0 45 *
<> 128:9bcdf88f62b0 46 * If the mbed running the program executes this function, it will print the
<> 128:9bcdf88f62b0 47 * message via the USB serial port, and then die with the blue lights of death!
<> 128:9bcdf88f62b0 48 *
<> 128:9bcdf88f62b0 49 * The message can use printf-style formatting, so you can report variables in the
<> 128:9bcdf88f62b0 50 * message too. For example, you could use this to check a run-time condition:
<> 128:9bcdf88f62b0 51 *
<> 128:9bcdf88f62b0 52 * @code
<> 128:9bcdf88f62b0 53 * if(x >= 5) {
<> 128:9bcdf88f62b0 54 * error("expected x to be less than 5, but got %d", x);
<> 128:9bcdf88f62b0 55 * }
<> 128:9bcdf88f62b0 56 * #endcode
<> 128:9bcdf88f62b0 57 */
<> 128:9bcdf88f62b0 58
<> 128:9bcdf88f62b0 59 #ifdef __cplusplus
<> 128:9bcdf88f62b0 60 extern "C" {
<> 128:9bcdf88f62b0 61 #endif
<> 128:9bcdf88f62b0 62
<> 128:9bcdf88f62b0 63 void error(const char* format, ...);
<> 128:9bcdf88f62b0 64
<> 128:9bcdf88f62b0 65 #ifdef __cplusplus
<> 128:9bcdf88f62b0 66 }
<> 128:9bcdf88f62b0 67 #endif
<> 128:9bcdf88f62b0 68
<> 128:9bcdf88f62b0 69 #endif
<> 128:9bcdf88f62b0 70
<> 128:9bcdf88f62b0 71 /** @}*/