modtronix H / mbed_nz32sc151

mbed library for NZ32-SC151

api/mbed_error.h@17:639ed60ce759, 2016-08-19 (annotated)

Committer:
modtronix-com
Date:
Fri Aug 19 15:46:42 2016 +1000
Revision:
17:639ed60ce759
Parent:
1:71204b8406f2 
Added tag v1.1 for changeset 076cbe3e55be

Who changed what in which revision?

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