PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

api/mbed_error.h@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

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