Ermanno Brusadin / mbed

mbed library sources

Dependents:   FRDM-KL46Z_LCD_Test FRDM-KL46Z_LCD_Test FRDM-KL46Z_Plantilla FRDM-KL46Z_Plantilla ... more

api/mbed_error.h@0:6bc4ac881c8e, 2016-07-28 (annotated)

Committer:
ebrus
Date:
Thu Jul 28 15:56:34 2016 +0000
Revision:
0:6bc4ac881c8e
1;

Who changed what in which revision?

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