PHung Tung / DISCO-F746_WAV_PLAYER

SPKT

Dependencies:   F746_GUI SD_PlayerSkeleton F746_SAI_IO

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

Committer:
phungductung
Date:
Tue Jun 04 21:37:21 2019 +0000
Revision:
0:8ede47d38d10
SPKT

Who changed what in which revision?

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