Juan Salazar / sofi7

test

Dependents:   robotic_fish_6

mbed_error.h@0:c792b17d9f78, 2021-12-03 (annotated)

Committer:
juansal12
Date:
Fri Dec 03 23:00:34 2021 +0000
Revision:
0:c792b17d9f78
uploaded sofi code ;

Who changed what in which revision?

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