A header- and constexpr-safe version of PW_CHECK().

If the given condition is false, crash the system. Otherwise, do nothing. The condition is guaranteed to be evaluated. This assert implementation is guaranteed to be constexpr-safe.

Warning

Unlike the PW_CHECK_*() suite of macros, not all backends for this API capture rich information like line numbers, the file, expression arguments, or the stringified expression. Use these macros only when absolutely necessary — in headers, constexpr contexts, or in rare cases where the call site overhead of a full PW_CHECK must be avoided. Use PW_CHECK_*() whenever possible.

Set to one of the following to define how pw_assert_basic should act after an assert failure:

• PW_ASSERT_BASIC_ACTION_ABORT: Call std::abort()
• PW_ASSERT_BASIC_ACTION_EXIT: Call std::_Exit(-1)
• PW_ASSERT_BASIC_ACTION_LOOP: Loop forever

Controls whether the evaluated values of a CHECK statement are captured as arguments to the final string. Disabling this will reduce code size at CHECK callsites, but slightly reduces debuggability.

This defaults to enabled.

Controls whether DCHECK and DASSERT are enabled.

This defaults to being disabled if NDEBUG is defined, else it is enabled by default.

Handles a low-level crash from pw_assert/assert.h. Backends must ensure their implementation is safe for usage in headers, constexpr contexts, and templates. This macro should expand to an expression that does not return.

A header- and constexpr-safe version of PW_CHECK_NOTNULL().

If the given pointer is nullptr, crash the system. Otherwise, return the pointer unchanged. The expression is guaranteed to be evaluated once.

In C++, ptr may be a raw pointer, function pointer, or smart pointer (any type comparable to nullptr). The argument's type and value category are preserved, making it suitable for initializing member variables in constructor initializer lists. This macro is only available in C++.

Warning

Unlike the PW_CHECK_*() suite of macros, not all backends for this API capture rich information like line numbers, the file, expression arguments, or the stringified expression. Use these macros only when absolutely necessary — in headers, constexpr contexts, or in rare cases where the call site overhead of a full PW_CHECK must be avoided. Use PW_CHECK_*() whenever possible.

A header- and constexpr-safe version of PW_CHECK_OK().

If expression does not evaluate to an OK status, crash. Otherwise, do nothing. The expression is guaranteed to be evaluated.

In C++, expression must evaluate to a value convertible to a status via pw::internal::ConvertToStatus(). This includes pw::Status, pw_Status, pw::StatusWithSize, pw::Result, and custom pw::StatusBase-derived types.

In C, expression must evaluate to a pw_Status value.

Unlike PW_CHECK_OK, this macro does not currently log the failed status kind.

Warning

Unlike the PW_CHECK_*() suite of macros, not all backends for this API capture rich information like line numbers, the file, expression arguments, or the stringified expression. Use these macros only when absolutely necessary — in headers, constexpr contexts, or in rare cases where the call site overhead of a full PW_CHECK must be avoided. Use PW_CHECK_*() whenever possible.

Asserts that a condition is true, optionally including a message with arguments to report if the condition is false.

Overloads:

• PW_CHECK(condition)
• PW_CHECK(condition, format, ...)

Asserts that (a >= b - abs_tolerance) && (a <= b + abs_tolerance) is true, where a, b, and abs_tolerance are converted to float. Also asserts that abs_tolerance >= 0.

Overloads:

• PW_CHECK_FLOAT_NEAR(a, b, abs_tolerance)
• PW_CHECK_FLOAT_NEAR(a, b, abs_tolerance, format, ...)

Asserts that the given pointer is not NULL (nullptr in C++), optionally including a message with arguments to report if the pointer is NULL.

Overloads:

• PW_CHECK_NOTNULL(ptr)
• PW_CHECK_NOTNULL(ptr, format, ...)

Asserts that expression evaluates to pw::OkStatus() (in C++) or PW_STATUS_OK (in C). Optionally includes a message with arguments to report.

In C++, expression must evaluate to a value convertible to a status via pw::internal::ConvertToStatus(). This includes pw::Status, pw_Status, pw::StatusWithSize, pw::Result, and custom pw::StatusBase-derived types.

In C, expression must evaluate to a pw_Status value.

Overloads:

• PW_CHECK_OK(status)
• PW_CHECK_OK(status, format, ...)

Triggers a crash with a message. Replaces LOG_FATAL() in other systems. Can include a message with format arguments; for example:

A header- and constexpr-safe version of PW_DCHECK().

Same as PW_ASSERT(), except that if PW_ASSERT_ENABLE_DEBUG == 0, the assert is disabled and condition is not evaluated.

Warning

Unlike the PW_CHECK_*() suite of macros, not all backends for this API capture rich information like line numbers, the file, expression arguments, or the stringified expression. Use these macros only when absolutely necessary — in headers, constexpr contexts, or in rare cases where the call site overhead of a full PW_CHECK must be avoided. Use PW_CHECK_*() whenever possible.

Debug variant of PW_CHECK that only runs if PW_ASSERT_ENABLE_DEBUG is enabled; otherwise, the entire statement is removed (and the expression not evaluated).

Overloads:

• PW_DCHECK(condition)
• PW_DCHECK(condition, format, ...)

Debug variant of PW_CHECK_OK that only runs if PW_ASSERT_ENABLE_DEBUG is enabled.

Overloads:

• PW_DCHECK_OK(status)
• PW_DCHECK_OK(status, format, ...)

Triggers a system crash or halt for a failed binary comparison assert (e.g. any of the PW_CHECK_<type>_<op> macros). The handler should combine the assert components into a useful message for the user; though in some cases this may not be possible.

• arg_a_str - Stringified first operand.
• arg_a_val - The value of the first operand.
• comparison_op_str - The string version of the operator.
• arg_b_str - Stringified second operand.
• arg_b_val - The value of the second operand.
• type_fmt - The format code for the type.
• ... - A formatted message and arguments to go with the assert.

Triggers a system crash or halt, and if possible, delivers the condition string (indicating what expression was false) and the message with format arguments, to the user or developer.

This macro is invoked from the PW_CHECK facade macro if condition is false.

Triggers a system crash or halt, and if possible, delivers the specified message and arguments to the user or developer.

Handles a low-level crash from pw_assert/assert.h. In this crash handler, there is no access to line, file, expression, or other rich assert information. Must not return.