error.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2013 ARM Limited
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy
00005  * of this software and associated documentation files (the "Software"), to deal
00006  * in the Software without restriction, including without limitation the rights
00007  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00008  * copies of the Software, and to permit persons to whom the Software is
00009  * furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included in
00012  * all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00015  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00017  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00018  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00019  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
00020  * SOFTWARE.
00021  */
00022 #ifndef MBED_ERROR_H
00023 #define MBED_ERROR_H
00024 
00025 /** To generate a fatal compile-time error, you can use the pre-processor #error directive.
00026  *
00027  * @code
00028  * #error "That shouldn't have happened!"
00029  * @endcode
00030  *
00031  * If the compiler evaluates this line, it will report the error and stop the compile.
00032  *
00033  * For example, you could use this to check some user-defined compile-time variables:
00034  *
00035  * @code
00036  * #define NUM_PORTS 7
00037  * #if (NUM_PORTS > 4)
00038  *     #error "NUM_PORTS must be less than 4"
00039  * #endif
00040  * @endcode
00041  *
00042  * Reporting Run-Time Errors:
00043  * To generate a fatal run-time error, you can use the mbed error() function.
00044  *
00045  * @code
00046  * error("That shouldn't have happened!");
00047  * @endcode
00048  *
00049  * If the mbed running the program executes this function, it will print the
00050  * message via the USB serial port, and then die with the blue lights of death!
00051  *
00052  * The message can use printf-style formatting, so you can report variables in the
00053  * message too. For example, you could use this to check a run-time condition:
00054  *
00055  * @code
00056  * if(x >= 5) {
00057  *     error("expected x to be less than 5, but got %d", x);
00058  * }
00059  * #endcode
00060  */
00061 
00062 #include <stdlib.h>
00063 #include "device.h"
00064 
00065 #ifdef DEVICE_STDIO_MESSAGES
00066     #include <stdio.h>
00067     #define error(...) (fprintf(stderr, __VA_ARGS__), exit(1))
00068 #else
00069     #define error(...) (exit(1))
00070 #endif
00071 
00072 #endif
00073