Vladimir Vana / mbed

pro vyuku PSS v Jecne

mbed_error.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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