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@43:e2ed12d17f06, 2012-10-26 (annotated)

Committer:
emilmont
Date:
Fri Oct 26 17:40:46 2012 +0100
Revision:
43:e2ed12d17f06
Parent:
27:7110ebee3484
Child:
44:24d45a770a51
Update documentation

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rolf.meyer@arm.com 11:1c1ebd0324fa 1 /* mbed Microcontroller Library - error
rolf.meyer@arm.com 11:1c1ebd0324fa 2 * Copyright (c) 2006-2009 ARM Limited. All rights reserved.
rolf.meyer@arm.com 11:1c1ebd0324fa 3 */
rolf.meyer@arm.com 11:1c1ebd0324fa 4
rolf.meyer@arm.com 11:1c1ebd0324fa 5 #ifndef MBED_ERROR_H
rolf.meyer@arm.com 11:1c1ebd0324fa 6 #define MBED_ERROR_H
rolf.meyer@arm.com 11:1c1ebd0324fa 7
emilmont 43:e2ed12d17f06 8 /** To generate a fatal compile-time error, you can use the pre-processor #error directive.
rolf.meyer@arm.com 11:1c1ebd0324fa 9 *
emilmont 43:e2ed12d17f06 10 * @code
emilmont 43:e2ed12d17f06 11 * #error "That shouldn't have happened!"
emilmont 43:e2ed12d17f06 12 * @endcode
rolf.meyer@arm.com 11:1c1ebd0324fa 13 *
rolf.meyer@arm.com 11:1c1ebd0324fa 14 * If the compiler evaluates this line, it will report the error and stop the compile.
rolf.meyer@arm.com 11:1c1ebd0324fa 15 *
rolf.meyer@arm.com 11:1c1ebd0324fa 16 * For example, you could use this to check some user-defined compile-time variables:
emilmont 43:e2ed12d17f06 17 *
emilmont 43:e2ed12d17f06 18 * @code
emilmont 43:e2ed12d17f06 19 * #define NUM_PORTS 7
emilmont 43:e2ed12d17f06 20 * #if (NUM_PORTS > 4)
emilmont 43:e2ed12d17f06 21 * #error "NUM_PORTS must be less than 4"
emilmont 43:e2ed12d17f06 22 * #endif
emilmont 43:e2ed12d17f06 23 * @endcode
rolf.meyer@arm.com 11:1c1ebd0324fa 24 *
rolf.meyer@arm.com 11:1c1ebd0324fa 25 * Reporting Run-Time Errors:
rolf.meyer@arm.com 11:1c1ebd0324fa 26 * To generate a fatal run-time error, you can use the mbed error() function.
rolf.meyer@arm.com 11:1c1ebd0324fa 27 *
emilmont 43:e2ed12d17f06 28 * @code
emilmont 43:e2ed12d17f06 29 * error("That shouldn't have happened!");
emilmont 43:e2ed12d17f06 30 * @endcode
rolf.meyer@arm.com 11:1c1ebd0324fa 31 *
rolf.meyer@arm.com 11:1c1ebd0324fa 32 * If the mbed running the program executes this function, it will print the
rolf.meyer@arm.com 11:1c1ebd0324fa 33 * message via the USB serial port, and then die with the blue lights of death!
rolf.meyer@arm.com 11:1c1ebd0324fa 34 *
rolf.meyer@arm.com 11:1c1ebd0324fa 35 * The message can use printf-style formatting, so you can report variables in the
rolf.meyer@arm.com 11:1c1ebd0324fa 36 * message too. For example, you could use this to check a run-time condition:
rolf.meyer@arm.com 11:1c1ebd0324fa 37 *
emilmont 43:e2ed12d17f06 38 * @code
emilmont 43:e2ed12d17f06 39 * if(x >= 5) {
emilmont 43:e2ed12d17f06 40 * error("expected x to be less than 5, but got %d", x);
emilmont 43:e2ed12d17f06 41 * }
emilmont 43:e2ed12d17f06 42 * #endcode
rolf.meyer@arm.com 11:1c1ebd0324fa 43 */
rolf.meyer@arm.com 11:1c1ebd0324fa 44
rolf.meyer@arm.com 11:1c1ebd0324fa 45 #if 0 // for documentation only
emilmont 43:e2ed12d17f06 46 /** Report a fatal runtime error
rolf.meyer@arm.com 11:1c1ebd0324fa 47 *
emilmont 43:e2ed12d17f06 48 * Outputs the specified error message to stderr so it will appear via the USB
emilmont 43:e2ed12d17f06 49 * serial port, and then calls exit(1) to die with the blue lights of death.
rolf.meyer@arm.com 11:1c1ebd0324fa 50 *
emilmont 43:e2ed12d17f06 51 * @param format printf-style format string, followed by associated variables
rolf.meyer@arm.com 11:1c1ebd0324fa 52 */
rolf.meyer@arm.com 11:1c1ebd0324fa 53 void error(const char* format, ...);
rolf.meyer@arm.com 11:1c1ebd0324fa 54 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 55
rolf.meyer@arm.com 11:1c1ebd0324fa 56 #include <stdlib.h>
rolf.meyer@arm.com 11:1c1ebd0324fa 57
rolf.meyer@arm.com 11:1c1ebd0324fa 58 #ifdef NDEBUG
rolf.meyer@arm.com 11:1c1ebd0324fa 59 #define error(...) (exit(1))
rolf.meyer@arm.com 11:1c1ebd0324fa 60 #else
rolf.meyer@arm.com 11:1c1ebd0324fa 61 #include <stdio.h>
rolf.meyer@arm.com 11:1c1ebd0324fa 62 #define error(...) (fprintf(stderr, __VA_ARGS__), exit(1))
rolf.meyer@arm.com 11:1c1ebd0324fa 63 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 64
rolf.meyer@arm.com 11:1c1ebd0324fa 65 #endif