Blame view

mbed/mbed_error.h 1.89 KB
f7c9a8e1   jdenecha   Feat : Firt dump
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
  /* mbed Microcontroller Library

   * Copyright (c) 2006-2013 ARM Limited

   *

   * Licensed under the Apache License, Version 2.0 (the "License");

   * you may not use this file except in compliance with the License.

   * You may obtain a copy of the License at

   *

   *     http://www.apache.org/licenses/LICENSE-2.0

   *

   * Unless required by applicable law or agreed to in writing, software

   * distributed under the License is distributed on an "AS IS" BASIS,

   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

   * See the License for the specific language governing permissions and

   * limitations under the License.

   */

  #ifndef MBED_ERROR_H

  #define MBED_ERROR_H

  

  /** To generate a fatal compile-time error, you can use the pre-processor #error directive.

   *

   * @code

   * #error "That shouldn't have happened!"

   * @endcode

   *

   * If the compiler evaluates this line, it will report the error and stop the compile.

   *

   * For example, you could use this to check some user-defined compile-time variables:

   *

   * @code

   * #define NUM_PORTS 7

   * #if (NUM_PORTS > 4)

   *     #error "NUM_PORTS must be less than 4"

   * #endif

   * @endcode

   *

   * Reporting Run-Time Errors:

   * To generate a fatal run-time error, you can use the mbed error() function.

   *

   * @code

   * error("That shouldn't have happened!");

   * @endcode

   *

   * If the mbed running the program executes this function, it will print the

   * message via the USB serial port, and then die with the blue lights of death!

   *

   * The message can use printf-style formatting, so you can report variables in the

   * message too. For example, you could use this to check a run-time condition:

   *

   * @code

   * if(x >= 5) {

   *     error("expected x to be less than 5, but got %d", x);

   * }

   * #endcode

   */

  

  #ifdef __cplusplus

  extern "C" {

  #endif

  

  void error(const char* format, ...);

  

  #ifdef __cplusplus

  }

  #endif

  

  #endif