File: pr_static_assert.rst

package info (click to toggle)
thunderbird 1%3A115.16.0esr-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 3,476,252 kB
  • sloc: cpp: 6,972,150; javascript: 5,209,211; ansic: 3,507,222; python: 1,137,609; asm: 432,531; xml: 205,149; java: 175,761; sh: 116,485; makefile: 22,152; perl: 13,971; objc: 12,561; yacc: 4,583; pascal: 2,840; lex: 1,720; ruby: 1,075; exp: 762; sql: 666; awk: 580; php: 436; lisp: 430; sed: 70; csh: 10
file content (46 lines) | stat: -rw-r--r-- 934 bytes parent folder | download | duplicates (18) 
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
 
PR_STATIC_ASSERT
================

Prevents code from compiling when an expression has the value ``FALSE``
at compile time.


Syntax
------

.. code::

   #include <prlog.h>

   PR_STATIC_ASSERT ( expression );


Parameters
~~~~~~~~~~

The macro has this parameter:

expression
   Any valid expression which evaluates at compile-time to ``TRUE`` or
   ``FALSE``. An expression which cannot be evaluated at compile time
   will cause a compiler error; see :ref:`PR_ASSERT` for a runtime
   alternative.


Returns
~~~~~~~

Nothing


Description
-----------

This macro evaluates the specified expression. When the result is zero
(``FALSE``) program compilation will fail with a compiler error;
otherwise compilation completes successfully. The compiler error will
include the number of the line for which the compile-time assertion
failed.

This macro may only be used in locations where an ``extern`` function
declaration may be used.