Egor Rumjantsev / mbed

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

Fork of mbed by mbed official

error.h@44:24d45a770a51, 2012-11-21 (annotated)

Committer:
emilmont
Date:
Wed Nov 21 10:49:56 2012 +0000
Revision:
44:24d45a770a51
Parent:
43:e2ed12d17f06
Child:
47:134def52cfa0
Complete refactoring of the mbed library to move the target dependent code to a thin well defined layer, defining a proper object oriented C API to be implemented by the different silicon vendors.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 44:24d45a770a51 1 /* mbed Microcontroller Library
emilmont 44:24d45a770a51 2 * Copyright (c) 2006-2012 ARM Limited
emilmont 44:24d45a770a51 3 *
emilmont 44:24d45a770a51 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
emilmont 44:24d45a770a51 5 * of this software and associated documentation files (the "Software"), to deal
emilmont 44:24d45a770a51 6 * in the Software without restriction, including without limitation the rights
emilmont 44:24d45a770a51 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
emilmont 44:24d45a770a51 8 * copies of the Software, and to permit persons to whom the Software is
emilmont 44:24d45a770a51 9 * furnished to do so, subject to the following conditions:
emilmont 44:24d45a770a51 10 *
emilmont 44:24d45a770a51 11 * The above copyright notice and this permission notice shall be included in
emilmont 44:24d45a770a51 12 * all copies or substantial portions of the Software.
emilmont 44:24d45a770a51 13 *
emilmont 44:24d45a770a51 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
emilmont 44:24d45a770a51 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
emilmont 44:24d45a770a51 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
emilmont 44:24d45a770a51 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
emilmont 44:24d45a770a51 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
emilmont 44:24d45a770a51 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
emilmont 44:24d45a770a51 20 * SOFTWARE.
emilmont 44:24d45a770a51 21 */
rolf.meyer@arm.com 11:1c1ebd0324fa 22 #ifndef MBED_ERROR_H
rolf.meyer@arm.com 11:1c1ebd0324fa 23 #define MBED_ERROR_H
rolf.meyer@arm.com 11:1c1ebd0324fa 24
emilmont 43:e2ed12d17f06 25 /** To generate a fatal compile-time error, you can use the pre-processor #error directive.
rolf.meyer@arm.com 11:1c1ebd0324fa 26 *
emilmont 43:e2ed12d17f06 27 * @code
emilmont 43:e2ed12d17f06 28 * #error "That shouldn't have happened!"
emilmont 43:e2ed12d17f06 29 * @endcode
rolf.meyer@arm.com 11:1c1ebd0324fa 30 *
rolf.meyer@arm.com 11:1c1ebd0324fa 31 * If the compiler evaluates this line, it will report the error and stop the compile.
rolf.meyer@arm.com 11:1c1ebd0324fa 32 *
rolf.meyer@arm.com 11:1c1ebd0324fa 33 * For example, you could use this to check some user-defined compile-time variables:
emilmont 44:24d45a770a51 34 *
emilmont 43:e2ed12d17f06 35 * @code
emilmont 43:e2ed12d17f06 36 * #define NUM_PORTS 7
emilmont 43:e2ed12d17f06 37 * #if (NUM_PORTS > 4)
emilmont 43:e2ed12d17f06 38 * #error "NUM_PORTS must be less than 4"
emilmont 43:e2ed12d17f06 39 * #endif
emilmont 43:e2ed12d17f06 40 * @endcode
rolf.meyer@arm.com 11:1c1ebd0324fa 41 *
rolf.meyer@arm.com 11:1c1ebd0324fa 42 * Reporting Run-Time Errors:
rolf.meyer@arm.com 11:1c1ebd0324fa 43 * To generate a fatal run-time error, you can use the mbed error() function.
rolf.meyer@arm.com 11:1c1ebd0324fa 44 *
emilmont 43:e2ed12d17f06 45 * @code
emilmont 43:e2ed12d17f06 46 * error("That shouldn't have happened!");
emilmont 43:e2ed12d17f06 47 * @endcode
rolf.meyer@arm.com 11:1c1ebd0324fa 48 *
rolf.meyer@arm.com 11:1c1ebd0324fa 49 * If the mbed running the program executes this function, it will print the
rolf.meyer@arm.com 11:1c1ebd0324fa 50 * message via the USB serial port, and then die with the blue lights of death!
rolf.meyer@arm.com 11:1c1ebd0324fa 51 *
rolf.meyer@arm.com 11:1c1ebd0324fa 52 * The message can use printf-style formatting, so you can report variables in the
rolf.meyer@arm.com 11:1c1ebd0324fa 53 * message too. For example, you could use this to check a run-time condition:
rolf.meyer@arm.com 11:1c1ebd0324fa 54 *
emilmont 43:e2ed12d17f06 55 * @code
emilmont 43:e2ed12d17f06 56 * if(x >= 5) {
emilmont 43:e2ed12d17f06 57 * error("expected x to be less than 5, but got %d", x);
emilmont 43:e2ed12d17f06 58 * }
emilmont 43:e2ed12d17f06 59 * #endcode
rolf.meyer@arm.com 11:1c1ebd0324fa 60 */
rolf.meyer@arm.com 11:1c1ebd0324fa 61
rolf.meyer@arm.com 11:1c1ebd0324fa 62 #include <stdlib.h>
emilmont 44:24d45a770a51 63 #include "device.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 64
emilmont 44:24d45a770a51 65 #ifdef DEVICE_STDIO_ERROR
rolf.meyer@arm.com 11:1c1ebd0324fa 66 #include <stdio.h>
rolf.meyer@arm.com 11:1c1ebd0324fa 67 #define error(...) (fprintf(stderr, __VA_ARGS__), exit(1))
emilmont 44:24d45a770a51 68 #else
emilmont 44:24d45a770a51 69 #define error(...) (exit(1))
rolf.meyer@arm.com 11:1c1ebd0324fa 70 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 71
rolf.meyer@arm.com 11:1c1ebd0324fa 72 #endif