Maxim nexpaq / nexpaq_dev

Preliminary main mbed library for nexpaq development

hal/api/mbed_error.h@0:6c56fb4bc5f0, 2016-11-04 (annotated)

Committer:
nexpaq
Date:
Fri Nov 04 20:27:58 2016 +0000
Revision:
0:6c56fb4bc5f0
Moving to library for sharing updates

Who changed what in which revision?

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