spinal cord / PokittoLib_

PokittoLib is the library needed for programming the Pokitto DIY game console (www.pokitto.com)

mbed-pokitto/api/mbed_error.h@5:ea7377f3d1af, 2017-10-11 (annotated)

Committer:
Pokitto
Date:
Wed Oct 11 20:35:27 2017 +0000
Revision:
5:ea7377f3d1af
Fixed PokittoLib. Includes a working custom mbed-src

Who changed what in which revision?

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