Sertel_Srinath Gopalan / USB_SERTEL_LOG

Soundharrajan

Fork of mbed by mbed official

error.h@92:f7fcbaa5f1b5, 2016-06-12 (annotated)

Committer:
mrsoundhar
Date:
Sun Jun 12 16:45:04 2016 +0000
Revision:
92:f7fcbaa5f1b5
Parent:
27:7110ebee3484
Child:
43:e2ed12d17f06
Soundharrajan

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