Jhon Plantikow / Dataloger

Dataloger

mbed_error.h@0:666850d06c9f, 2015-08-20 (annotated)

Committer:
jhon309
Date:
Thu Aug 20 00:37:14 2015 +0000
Revision:
0:666850d06c9f
ok

Who changed what in which revision?

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