RYUICHI NAKAYAMA / mbed-dev

OK

Fork of mbed-dev by mbed official

api/mbed_error.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

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