Mark Turner / MarksMbed

This is a repository for all my programs or modified programs.

error.h@0:72480818e4a9, 2016-09-11 (annotated)

Committer:
mturner5
Date:
Sun Sep 11 23:48:09 2016 +0000
Revision:
0:72480818e4a9
Made delays for the LEDS and button presses

Who changed what in which revision?

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