Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

platform/mbed_error.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

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