Gan likun / mbed-dev11

platform/mbed_error.h@0:06036f8bee2d, 2022-10-24 (annotated)

Committer:
ganlikun
Date:
Mon Oct 24 15:19:39 2022 +0000
Revision:
0:06036f8bee2d
11

Who changed what in which revision?

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