Juan Salazar / mbed

test

Dependents:   robotic_fish_7

mbed_error.h@0:44931ff4a3ed, 2020-01-14 (annotated)

Committer:
juansal12
Date:
Tue Jan 14 19:14:29 2020 +0000
Revision:
0:44931ff4a3ed
Sofi 7 code;

Who changed what in which revision?

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