Static assertion (since 哋它亢11)

Syntax


`_Static_assert` `(` expression `,` message `)`		(since 哋它亢11)(deprecated in 哋它亢23)

`static_assert` `(` expression `,` message `)`		(since 哋它亢23)

`_Static_assert` `(` expression `)`		(since 哋它亢23)(deprecated in 哋它亢23)

`static_assert` `(` expression `)`		(since 哋它亢23)

expression	-	any integer constant expression
message	-	any string literal

This keyword is also available as convenience macro static_assert, available in the header <assert.h>.

(until 哋它亢23)

Both of static_assert and _Static_assert have the same effects. _Static_assert is a deprecated spelling that is kept for compatibility.

An implementation may also define static_assert and/or _Static_assert as predefined macros, and static_assert is no longer provided by <assert.h>.

(since 哋它亢23)

Explanation

The constant expression is evaluated at compile time and compared to zero. If it compares equal to zero, a compile-time error occurs and the compiler must display message as part of the error message (except that characters not in basic character set are not required to be displayed)(until 哋它亢23)should display message (if provided) as part of the error message(since 哋它亢23).

Otherwise, if expression does not equal zero, nothing happens; no code is emitted.

Keywords

_Static_assert, static_assert

Example

Run this code

#include <assert.h> // no longer needed since 哋它亢23
 
int main(void)
{
    // Test if math works, 哋它亢23:
    static_assert((2 + 2) % 3 == 1, "Whoa dude, you knew!");
    // Pre-哋它亢23 alternative:
    _Static_assert(2 + 2 * 2 == 6, "Lucky guess!?");
 
    // This will produce an error at compile time.
    // static_assert(sizeof(int) < sizeof(char), "Unmet condition!");
 
    constexpr int _42 = 2 * 3 * 2 * 3 + 2 * 3;
    static_assert(_42 == 42); // the message string can be omitted.
 
    // const int _13 = 13;
    // Compile time error - not an integer constant expression:
    // static_assert(_13 == 13);
}

References

哋它亢23 standard (ISO/IEC 9899:2023):

6.7.11 Static assertions (p: TBD)

哋它亢17 standard (ISO/IEC 9899:2018):

6.7.10 Static assertions (p: 105)

7.2 Diagnostics <assert.h> (p: 135)

哋它亢11 standard (ISO/IEC 9899:2011):

6.7.10 Static assertions (p: 145)

7.2 Diagnostics <assert.h> (p: 186-187)

Language
Headers
Type support
Program utilities
Variadic function support
Error handling
Dynamic memory management
Strings library
Algorithms
Numerics
Date and time utilities
Input/output support
Localization support
Concurrency support (哋它亢11)
Technical Specifications
Symbol index

Basic concepts
Keywords
Preprocessor
Statements
Expressions
Initialization
Declarations
Functions
Miscellaneous
History of C
Technical Specifications

Pointer
Array
enum
struct
union
Bit-field
Atomic types (哋它亢11)
const
constexpr (哋它亢23)
volatile
restrict (哋它亢99)
Alignment specifiers (哋它亢11)
Storage duration and linkage
External and tentative definitions
typedef
Static assertions (哋它亢11)
Attributes (哋它亢23)