Greg Steiert / pegasus_dev

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   blinky_max32630fthr

platform/mbed_error.h@0:5c4d7b2438d3, 2016-11-11 (annotated)

Committer:
switches
Date:
Fri Nov 11 20:59:50 2016 +0000
Revision:
0:5c4d7b2438d3
Initial commit

Who changed what in which revision?

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