Jhon Plantikow / I2C_EEPROM

I2C_EEPROM

mbed_error.h@0:ac8863619623, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:23:16 2015 +0000
Revision:
0:ac8863619623
I2C

Who changed what in which revision?

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