PHung Tung / WAV2

SPKT

Dependencies:   F746_GUI SD_PlayerSkeleton F746_SAI_IO

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

Committer:
phungductung
Date:
Tue Jun 04 09:08:29 2019 +0000
Revision:
0:aa3fc5ad02f7
SPKT

Who changed what in which revision?

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