aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/api/assert.rst
blob: 76330b66d6c5989550ca84b3318eead41fe32721 (plain)
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
.. highlight:: cpp

.. _lang-assert:

``ASSERT(...)``
===============

ASSERT() can be very useful for basic program debugging. It accepts a
boolean; for example::

  ASSERT(state == WAIT);

Zero is false and any other number is true.  If the boolean is true,
the assertion passes and the program continues as usual.  If it is
false, the assertion fails: the program is halted, debug information
is printed to USART2, and the status LED begins to throb (it's
noticeably different from blinking). The debug information is printed
at 9600 baud and consists of the filename and line number where the
ASSERT() failed.

Including assertions in a program increases the program size. When
using libmaple **from the command line only**, they can be disabled by
making the definition ::

  #define DEBUG_LEVEL DEBUG_NONE

before including either wirish.h or libmaple.h. In this case, all
assertions will pass without any lost clock cycles.  Note that this
will **not work in the IDE**; even with this definition, assertions
will still be enabled.