Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: STM32F031_blink_LED_2
api/mbed_error.h@0:38ccae254a29, 2014-10-18 (annotated)
- Committer:
- mega64
- Date:
- Sat Oct 18 02:40:17 2014 +0000
- Revision:
- 0:38ccae254a29
only for STM32F030F4
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| mega64 | 0:38ccae254a29 | 1 | /* mbed Microcontroller Library |
| mega64 | 0:38ccae254a29 | 2 | * Copyright (c) 2006-2013 ARM Limited |
| mega64 | 0:38ccae254a29 | 3 | * |
| mega64 | 0:38ccae254a29 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| mega64 | 0:38ccae254a29 | 5 | * you may not use this file except in compliance with the License. |
| mega64 | 0:38ccae254a29 | 6 | * You may obtain a copy of the License at |
| mega64 | 0:38ccae254a29 | 7 | * |
| mega64 | 0:38ccae254a29 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| mega64 | 0:38ccae254a29 | 9 | * |
| mega64 | 0:38ccae254a29 | 10 | * Unless required by applicable law or agreed to in writing, software |
| mega64 | 0:38ccae254a29 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| mega64 | 0:38ccae254a29 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| mega64 | 0:38ccae254a29 | 13 | * See the License for the specific language governing permissions and |
| mega64 | 0:38ccae254a29 | 14 | * limitations under the License. |
| mega64 | 0:38ccae254a29 | 15 | */ |
| mega64 | 0:38ccae254a29 | 16 | #ifndef MBED_ERROR_H |
| mega64 | 0:38ccae254a29 | 17 | #define MBED_ERROR_H |
| mega64 | 0:38ccae254a29 | 18 | |
| mega64 | 0:38ccae254a29 | 19 | /** To generate a fatal compile-time error, you can use the pre-processor #error directive. |
| mega64 | 0:38ccae254a29 | 20 | * |
| mega64 | 0:38ccae254a29 | 21 | * @code |
| mega64 | 0:38ccae254a29 | 22 | * #error "That shouldn't have happened!" |
| mega64 | 0:38ccae254a29 | 23 | * @endcode |
| mega64 | 0:38ccae254a29 | 24 | * |
| mega64 | 0:38ccae254a29 | 25 | * If the compiler evaluates this line, it will report the error and stop the compile. |
| mega64 | 0:38ccae254a29 | 26 | * |
| mega64 | 0:38ccae254a29 | 27 | * For example, you could use this to check some user-defined compile-time variables: |
| mega64 | 0:38ccae254a29 | 28 | * |
| mega64 | 0:38ccae254a29 | 29 | * @code |
| mega64 | 0:38ccae254a29 | 30 | * #define NUM_PORTS 7 |
| mega64 | 0:38ccae254a29 | 31 | * #if (NUM_PORTS > 4) |
| mega64 | 0:38ccae254a29 | 32 | * #error "NUM_PORTS must be less than 4" |
| mega64 | 0:38ccae254a29 | 33 | * #endif |
| mega64 | 0:38ccae254a29 | 34 | * @endcode |
| mega64 | 0:38ccae254a29 | 35 | * |
| mega64 | 0:38ccae254a29 | 36 | * Reporting Run-Time Errors: |
| mega64 | 0:38ccae254a29 | 37 | * To generate a fatal run-time error, you can use the mbed error() function. |
| mega64 | 0:38ccae254a29 | 38 | * |
| mega64 | 0:38ccae254a29 | 39 | * @code |
| mega64 | 0:38ccae254a29 | 40 | * error("That shouldn't have happened!"); |
| mega64 | 0:38ccae254a29 | 41 | * @endcode |
| mega64 | 0:38ccae254a29 | 42 | * |
| mega64 | 0:38ccae254a29 | 43 | * If the mbed running the program executes this function, it will print the |
| mega64 | 0:38ccae254a29 | 44 | * message via the USB serial port, and then die with the blue lights of death! |
| mega64 | 0:38ccae254a29 | 45 | * |
| mega64 | 0:38ccae254a29 | 46 | * The message can use printf-style formatting, so you can report variables in the |
| mega64 | 0:38ccae254a29 | 47 | * message too. For example, you could use this to check a run-time condition: |
| mega64 | 0:38ccae254a29 | 48 | * |
| mega64 | 0:38ccae254a29 | 49 | * @code |
| mega64 | 0:38ccae254a29 | 50 | * if(x >= 5) { |
| mega64 | 0:38ccae254a29 | 51 | * error("expected x to be less than 5, but got %d", x); |
| mega64 | 0:38ccae254a29 | 52 | * } |
| mega64 | 0:38ccae254a29 | 53 | * #endcode |
| mega64 | 0:38ccae254a29 | 54 | */ |
| mega64 | 0:38ccae254a29 | 55 | |
| mega64 | 0:38ccae254a29 | 56 | #ifdef __cplusplus |
| mega64 | 0:38ccae254a29 | 57 | extern "C" { |
| mega64 | 0:38ccae254a29 | 58 | #endif |
| mega64 | 0:38ccae254a29 | 59 | |
| mega64 | 0:38ccae254a29 | 60 | void error(const char* format, ...); |
| mega64 | 0:38ccae254a29 | 61 | |
| mega64 | 0:38ccae254a29 | 62 | #ifdef __cplusplus |
| mega64 | 0:38ccae254a29 | 63 | } |
| mega64 | 0:38ccae254a29 | 64 | #endif |
| mega64 | 0:38ccae254a29 | 65 | |
| mega64 | 0:38ccae254a29 | 66 | #endif |