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