DongEun Koak / mbed-src

mbed library sources

Dependents:   Freedman_v2 Nucleo_i2c_OLED_BME280_copy

Fork of mbed-src by mbed official

api/error.h@10:3bc89ef62ce7, 2013-06-14 (annotated)

Committer:
emilmont
Date:
Fri Jun 14 17:49:17 2013 +0100
Revision:
10:3bc89ef62ce7
Parent:
9:0ce32e54c9a7
Child:
13:0645d8841f51
Unify mbed library sources

Who changed what in which revision?

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