gabriel della-monica / mbed-src

mbed library sources

Fork of mbed-src by mbed official

capi/error.h@0:fd0d7bdfcdc2, 2012-11-20 (annotated)

Committer:
mbed_official
Date:
Tue Nov 20 17:24:08 2012 +0000
Revision:
0:fd0d7bdfcdc2
Child:
1:62685faffa05
mbed sources

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 0:fd0d7bdfcdc2 1 /* mbed Microcontroller Library
mbed_official 0:fd0d7bdfcdc2 2 * Copyright (c) 2006-2012 ARM Limited
mbed_official 0:fd0d7bdfcdc2 3 *
mbed_official 0:fd0d7bdfcdc2 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
mbed_official 0:fd0d7bdfcdc2 5 * of this software and associated documentation files (the "Software"), to deal
mbed_official 0:fd0d7bdfcdc2 6 * in the Software without restriction, including without limitation the rights
mbed_official 0:fd0d7bdfcdc2 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
mbed_official 0:fd0d7bdfcdc2 8 * copies of the Software, and to permit persons to whom the Software is
mbed_official 0:fd0d7bdfcdc2 9 * furnished to do so, subject to the following conditions:
mbed_official 0:fd0d7bdfcdc2 10 *
mbed_official 0:fd0d7bdfcdc2 11 * The above copyright notice and this permission notice shall be included in
mbed_official 0:fd0d7bdfcdc2 12 * all copies or substantial portions of the Software.
mbed_official 0:fd0d7bdfcdc2 13 *
mbed_official 0:fd0d7bdfcdc2 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
mbed_official 0:fd0d7bdfcdc2 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
mbed_official 0:fd0d7bdfcdc2 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
mbed_official 0:fd0d7bdfcdc2 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
mbed_official 0:fd0d7bdfcdc2 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
mbed_official 0:fd0d7bdfcdc2 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
mbed_official 0:fd0d7bdfcdc2 20 * SOFTWARE.
mbed_official 0:fd0d7bdfcdc2 21 */
mbed_official 0:fd0d7bdfcdc2 22 #ifndef MBED_ERROR_H
mbed_official 0:fd0d7bdfcdc2 23 #define MBED_ERROR_H
mbed_official 0:fd0d7bdfcdc2 24
mbed_official 0:fd0d7bdfcdc2 25 /** To generate a fatal compile-time error, you can use the pre-processor #error directive.
mbed_official 0:fd0d7bdfcdc2 26 *
mbed_official 0:fd0d7bdfcdc2 27 * @code
mbed_official 0:fd0d7bdfcdc2 28 * #error "That shouldn't have happened!"
mbed_official 0:fd0d7bdfcdc2 29 * @endcode
mbed_official 0:fd0d7bdfcdc2 30 *
mbed_official 0:fd0d7bdfcdc2 31 * If the compiler evaluates this line, it will report the error and stop the compile.
mbed_official 0:fd0d7bdfcdc2 32 *
mbed_official 0:fd0d7bdfcdc2 33 * For example, you could use this to check some user-defined compile-time variables:
mbed_official 0:fd0d7bdfcdc2 34 *
mbed_official 0:fd0d7bdfcdc2 35 * @code
mbed_official 0:fd0d7bdfcdc2 36 * #define NUM_PORTS 7
mbed_official 0:fd0d7bdfcdc2 37 * #if (NUM_PORTS > 4)
mbed_official 0:fd0d7bdfcdc2 38 * #error "NUM_PORTS must be less than 4"
mbed_official 0:fd0d7bdfcdc2 39 * #endif
mbed_official 0:fd0d7bdfcdc2 40 * @endcode
mbed_official 0:fd0d7bdfcdc2 41 *
mbed_official 0:fd0d7bdfcdc2 42 * Reporting Run-Time Errors:
mbed_official 0:fd0d7bdfcdc2 43 * To generate a fatal run-time error, you can use the mbed error() function.
mbed_official 0:fd0d7bdfcdc2 44 *
mbed_official 0:fd0d7bdfcdc2 45 * @code
mbed_official 0:fd0d7bdfcdc2 46 * error("That shouldn't have happened!");
mbed_official 0:fd0d7bdfcdc2 47 * @endcode
mbed_official 0:fd0d7bdfcdc2 48 *
mbed_official 0:fd0d7bdfcdc2 49 * If the mbed running the program executes this function, it will print the
mbed_official 0:fd0d7bdfcdc2 50 * message via the USB serial port, and then die with the blue lights of death!
mbed_official 0:fd0d7bdfcdc2 51 *
mbed_official 0:fd0d7bdfcdc2 52 * The message can use printf-style formatting, so you can report variables in the
mbed_official 0:fd0d7bdfcdc2 53 * message too. For example, you could use this to check a run-time condition:
mbed_official 0:fd0d7bdfcdc2 54 *
mbed_official 0:fd0d7bdfcdc2 55 * @code
mbed_official 0:fd0d7bdfcdc2 56 * if(x >= 5) {
mbed_official 0:fd0d7bdfcdc2 57 * error("expected x to be less than 5, but got %d", x);
mbed_official 0:fd0d7bdfcdc2 58 * }
mbed_official 0:fd0d7bdfcdc2 59 * #endcode
mbed_official 0:fd0d7bdfcdc2 60 */
mbed_official 0:fd0d7bdfcdc2 61
mbed_official 0:fd0d7bdfcdc2 62 #include <stdlib.h>
mbed_official 0:fd0d7bdfcdc2 63 #include "device.h"
mbed_official 0:fd0d7bdfcdc2 64
mbed_official 0:fd0d7bdfcdc2 65 #ifdef DEVICE_STDIO_ERROR
mbed_official 0:fd0d7bdfcdc2 66 #include <stdio.h>
mbed_official 0:fd0d7bdfcdc2 67 #define error(...) (fprintf(stderr, __VA_ARGS__), exit(1))
mbed_official 0:fd0d7bdfcdc2 68 #else
mbed_official 0:fd0d7bdfcdc2 69 #define error(...) (exit(1))
mbed_official 0:fd0d7bdfcdc2 70 #endif
mbed_official 0:fd0d7bdfcdc2 71
mbed_official 0:fd0d7bdfcdc2 72 #endif