mbed SDK library sources
Fork of mbed-src by
Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.
If you are looking for a stable and tested release, please import one of the official mbed library releases:
Import librarymbed
The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.
api/error.h@37:88e9030f311f, 2013-10-23 (annotated)
- Committer:
- mbed_official
- Date:
- Wed Oct 23 15:30:04 2013 +0100
- Revision:
- 37:88e9030f311f
- Parent:
- 25:002053b42e66
Synchronized with git revision 5742abe6d9771e0bbfb5477645d7357c7d595702
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
bogdanm | 13:0645d8841f51 | 1 | /* mbed Microcontroller Library |
bogdanm | 13:0645d8841f51 | 2 | * Copyright (c) 2006-2013 ARM Limited |
bogdanm | 13:0645d8841f51 | 3 | * |
bogdanm | 13:0645d8841f51 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
bogdanm | 13:0645d8841f51 | 5 | * you may not use this file except in compliance with the License. |
bogdanm | 13:0645d8841f51 | 6 | * You may obtain a copy of the License at |
bogdanm | 13:0645d8841f51 | 7 | * |
bogdanm | 13:0645d8841f51 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
bogdanm | 13:0645d8841f51 | 9 | * |
bogdanm | 13:0645d8841f51 | 10 | * Unless required by applicable law or agreed to in writing, software |
bogdanm | 13:0645d8841f51 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
bogdanm | 13:0645d8841f51 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
bogdanm | 13:0645d8841f51 | 13 | * See the License for the specific language governing permissions and |
bogdanm | 13:0645d8841f51 | 14 | * limitations under the License. |
bogdanm | 13:0645d8841f51 | 15 | */ |
bogdanm | 13:0645d8841f51 | 16 | #ifndef MBED_ERROR_H |
bogdanm | 13:0645d8841f51 | 17 | #define MBED_ERROR_H |
bogdanm | 13:0645d8841f51 | 18 | |
bogdanm | 13:0645d8841f51 | 19 | /** To generate a fatal compile-time error, you can use the pre-processor #error directive. |
bogdanm | 13:0645d8841f51 | 20 | * |
bogdanm | 13:0645d8841f51 | 21 | * @code |
bogdanm | 13:0645d8841f51 | 22 | * #error "That shouldn't have happened!" |
bogdanm | 13:0645d8841f51 | 23 | * @endcode |
bogdanm | 13:0645d8841f51 | 24 | * |
bogdanm | 13:0645d8841f51 | 25 | * If the compiler evaluates this line, it will report the error and stop the compile. |
bogdanm | 13:0645d8841f51 | 26 | * |
bogdanm | 13:0645d8841f51 | 27 | * For example, you could use this to check some user-defined compile-time variables: |
bogdanm | 13:0645d8841f51 | 28 | * |
bogdanm | 13:0645d8841f51 | 29 | * @code |
bogdanm | 13:0645d8841f51 | 30 | * #define NUM_PORTS 7 |
bogdanm | 13:0645d8841f51 | 31 | * #if (NUM_PORTS > 4) |
bogdanm | 13:0645d8841f51 | 32 | * #error "NUM_PORTS must be less than 4" |
bogdanm | 13:0645d8841f51 | 33 | * #endif |
bogdanm | 13:0645d8841f51 | 34 | * @endcode |
bogdanm | 13:0645d8841f51 | 35 | * |
bogdanm | 13:0645d8841f51 | 36 | * Reporting Run-Time Errors: |
bogdanm | 13:0645d8841f51 | 37 | * To generate a fatal run-time error, you can use the mbed error() function. |
bogdanm | 13:0645d8841f51 | 38 | * |
bogdanm | 13:0645d8841f51 | 39 | * @code |
bogdanm | 13:0645d8841f51 | 40 | * error("That shouldn't have happened!"); |
bogdanm | 13:0645d8841f51 | 41 | * @endcode |
bogdanm | 13:0645d8841f51 | 42 | * |
bogdanm | 13:0645d8841f51 | 43 | * If the mbed running the program executes this function, it will print the |
bogdanm | 13:0645d8841f51 | 44 | * message via the USB serial port, and then die with the blue lights of death! |
bogdanm | 13:0645d8841f51 | 45 | * |
bogdanm | 13:0645d8841f51 | 46 | * The message can use printf-style formatting, so you can report variables in the |
bogdanm | 13:0645d8841f51 | 47 | * message too. For example, you could use this to check a run-time condition: |
bogdanm | 13:0645d8841f51 | 48 | * |
bogdanm | 13:0645d8841f51 | 49 | * @code |
bogdanm | 13:0645d8841f51 | 50 | * if(x >= 5) { |
bogdanm | 13:0645d8841f51 | 51 | * error("expected x to be less than 5, but got %d", x); |
bogdanm | 13:0645d8841f51 | 52 | * } |
bogdanm | 13:0645d8841f51 | 53 | * #endcode |
bogdanm | 13:0645d8841f51 | 54 | */ |
bogdanm | 13:0645d8841f51 | 55 | |
bogdanm | 13:0645d8841f51 | 56 | #include <stdlib.h> |
bogdanm | 13:0645d8841f51 | 57 | #include "device.h" |
bogdanm | 13:0645d8841f51 | 58 | |
mbed_official | 25:002053b42e66 | 59 | #if DEVICE_STDIO_MESSAGES |
bogdanm | 13:0645d8841f51 | 60 | #include <stdio.h> |
bogdanm | 13:0645d8841f51 | 61 | #define error(...) (fprintf(stderr, __VA_ARGS__), exit(1)) |
bogdanm | 13:0645d8841f51 | 62 | #else |
bogdanm | 13:0645d8841f51 | 63 | #define error(...) (exit(1)) |
bogdanm | 13:0645d8841f51 | 64 | #endif |
bogdanm | 13:0645d8841f51 | 65 | |
bogdanm | 13:0645d8841f51 | 66 | #endif |