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@157:e7ca05fa8600, 2017-11-09 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 09 11:14:10 2017 +0000
Revision:
157:e7ca05fa8600
Parent:
156:ff21514d8981
Child:
158:1c57384330a6
Release 155 of the mbed library.

Who changed what in which revision?

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