teralytic / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed by teralytic

api/mbed_error.h@148:4802eb17e82b, 2016-10-17 (annotated)

Committer:
rodriguise
Date:
Mon Oct 17 18:47:01 2016 +0000
Revision:
148:4802eb17e82b
Parent:
144:ef7eb2e8f9f7 
backup

Who changed what in which revision?

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