ju Lei / 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@64:75c1708b266b, 2013-07-05 (annotated)

Committer:
ldyz
Date:
Fri Jul 05 13:16:13 2013 +0000
Revision:
64:75c1708b266b
Parent:
59:0883845fe643 
test

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 44:24d45a770a51 1 /* mbed Microcontroller Library
emilmont 54:71b101360fb9 2 * Copyright (c) 2006-2013 ARM Limited
emilmont 44:24d45a770a51 3 *
emilmont 59:0883845fe643 4 * Licensed under the Apache License, Version 2.0 (the "License");
emilmont 59:0883845fe643 5 * you may not use this file except in compliance with the License.
emilmont 59:0883845fe643 6 * You may obtain a copy of the License at
emilmont 59:0883845fe643 7 *
emilmont 59:0883845fe643 8 * http://www.apache.org/licenses/LICENSE-2.0
emilmont 44:24d45a770a51 9 *
emilmont 59:0883845fe643 10 * Unless required by applicable law or agreed to in writing, software
emilmont 59:0883845fe643 11 * distributed under the License is distributed on an "AS IS" BASIS,
emilmont 59:0883845fe643 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
emilmont 59:0883845fe643 13 * See the License for the specific language governing permissions and
emilmont 59:0883845fe643 14 * limitations under the License.
emilmont 44:24d45a770a51 15 */
rolf.meyer@arm.com 11:1c1ebd0324fa 16 #ifndef MBED_ERROR_H
rolf.meyer@arm.com 11:1c1ebd0324fa 17 #define MBED_ERROR_H
rolf.meyer@arm.com 11:1c1ebd0324fa 18
emilmont 43:e2ed12d17f06 19 /** To generate a fatal compile-time error, you can use the pre-processor #error directive.
rolf.meyer@arm.com 11:1c1ebd0324fa 20 *
emilmont 43:e2ed12d17f06 21 * @code
emilmont 43:e2ed12d17f06 22 * #error "That shouldn't have happened!"
emilmont 43:e2ed12d17f06 23 * @endcode
rolf.meyer@arm.com 11:1c1ebd0324fa 24 *
rolf.meyer@arm.com 11:1c1ebd0324fa 25 * If the compiler evaluates this line, it will report the error and stop the compile.
rolf.meyer@arm.com 11:1c1ebd0324fa 26 *
rolf.meyer@arm.com 11:1c1ebd0324fa 27 * For example, you could use this to check some user-defined compile-time variables:
emilmont 44:24d45a770a51 28 *
emilmont 43:e2ed12d17f06 29 * @code
emilmont 43:e2ed12d17f06 30 * #define NUM_PORTS 7
emilmont 43:e2ed12d17f06 31 * #if (NUM_PORTS > 4)
emilmont 43:e2ed12d17f06 32 * #error "NUM_PORTS must be less than 4"
emilmont 43:e2ed12d17f06 33 * #endif
emilmont 43:e2ed12d17f06 34 * @endcode
rolf.meyer@arm.com 11:1c1ebd0324fa 35 *
rolf.meyer@arm.com 11:1c1ebd0324fa 36 * Reporting Run-Time Errors:
rolf.meyer@arm.com 11:1c1ebd0324fa 37 * To generate a fatal run-time error, you can use the mbed error() function.
rolf.meyer@arm.com 11:1c1ebd0324fa 38 *
emilmont 43:e2ed12d17f06 39 * @code
emilmont 43:e2ed12d17f06 40 * error("That shouldn't have happened!");
emilmont 43:e2ed12d17f06 41 * @endcode
rolf.meyer@arm.com 11:1c1ebd0324fa 42 *
emilmont 55:d722ed6a4237 43 * If the mbed running the program executes this function, it will print the
rolf.meyer@arm.com 11:1c1ebd0324fa 44 * message via the USB serial port, and then die with the blue lights of death!
rolf.meyer@arm.com 11:1c1ebd0324fa 45 *
emilmont 55:d722ed6a4237 46 * The message can use printf-style formatting, so you can report variables in the
rolf.meyer@arm.com 11:1c1ebd0324fa 47 * message too. For example, you could use this to check a run-time condition:
emilmont 55:d722ed6a4237 48 *
emilmont 43:e2ed12d17f06 49 * @code
emilmont 43:e2ed12d17f06 50 * if(x >= 5) {
emilmont 43:e2ed12d17f06 51 * error("expected x to be less than 5, but got %d", x);
emilmont 43:e2ed12d17f06 52 * }
emilmont 43:e2ed12d17f06 53 * #endcode
rolf.meyer@arm.com 11:1c1ebd0324fa 54 */
rolf.meyer@arm.com 11:1c1ebd0324fa 55
rolf.meyer@arm.com 11:1c1ebd0324fa 56 #include <stdlib.h>
emilmont 44:24d45a770a51 57 #include "device.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 58
emimon01 47:134def52cfa0 59 #ifdef DEVICE_STDIO_MESSAGES
rolf.meyer@arm.com 11:1c1ebd0324fa 60 #include <stdio.h>
rolf.meyer@arm.com 11:1c1ebd0324fa 61 #define error(...) (fprintf(stderr, __VA_ARGS__), exit(1))
emilmont 44:24d45a770a51 62 #else
emilmont 44:24d45a770a51 63 #define error(...) (exit(1))
rolf.meyer@arm.com 11:1c1ebd0324fa 64 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 65
rolf.meyer@arm.com 11:1c1ebd0324fa 66 #endif