Collaboration diagram for Assertions and panic handling:

Macros
#define	CTU_DEBUG 0
	enable panic handling More...

#define	CTU_PARANOID 0
	enable paranoid assertions for expensive assertions that shouldnt be used too often use these for things that you do not want being turned into assumes due to the execution cost More...

#define	CT_PANIC_INNER(...)

#define	CT_PANIC(...)
	panic with a message and optional format arguments More...

#define	CTASSERTF_ALWAYS(expr, ...)
	assert a condition with a message and optional format arguments More...

#define	CTASSERT_ALWAYS(expr) CTASSERTF_ALWAYS(expr, "assertion failed: %s", #expr)

#define	CTASSERTM_ALWAYS(expr, msg) CTASSERTF_ALWAYS(expr, "%s", msg)

#define	CTASSERTF(expr, ...) CT_ASSUME(expr)
	assert a condition with a message and optional format arguments More...

#define	CTASSERTM(expr, msg) CTASSERTF(expr, "%s", msg)
	assert a condition with a message More...

#define	CTASSERT(expr) CTASSERTM(expr, #expr)
	assert a condition, prints the condition as a message More...

#define	CT_NEVER(...) CT_PANIC(__VA_ARGS__)
	assert that a code path is never reached More...

#define	CT_ASSERT_RANGE_PRI(value, min, max, pri) CTASSERTF((value) >= (min) && (value) <= (max), "value " pri " not in range " pri "-" pri, (value), (min), (max))

#define	CT_ASSERT_RANGE(value, min, max) CT_ASSERT_RANGE_PRI(value, min, max, "%d")
	assert that a value is in a range inclusive bounds check More...

#define	CT_PARANOID(...)
	a block of code that is only executed in paranoid builds More...

#define	CT_PARANOID_ASSERTF(expr, ...)
	assert a condition with a message and optional format arguments More...

Typedefs
typedef void(*	panic_handler_t) (source_info_t location, STA_FORMAT_STRING const char *fmt, va_list args)
	panic handler function More...

Functions
CT_BASE_API CT_NORETURN	ctu_panic (source_info_t location, STA_FORMAT_STRING const char *msg,...)
	panic with a message, file, and line More...

CT_BASE_API CT_NORETURN	ctu_vpanic (source_info_t location, STA_FORMAT_STRING const char *msg, va_list args)
	panic with a message, file, and line More...

Variables
CT_BASE_API panic_handler_t	gPanicHandler
	the global panic handler. More...

Detailed Description

Macro Definition Documentation

◆ CT_ASSERT_RANGE

#define CT_ASSERT_RANGE	(	value,
		min,
		max
	)	CT_ASSERT_RANGE_PRI(value, min, max, "%d")

assert that a value is in a range inclusive bounds check

Parameters

value	the value to check
min	the minimum value
max	the maximum value

Definition at line 148 of file panic.h.

◆ CT_ASSERT_RANGE_PRI

#define CT_ASSERT_RANGE_PRI	(	value,
		min,
		max,
		pri
	)	CTASSERTF((value) >= (min) && (value) <= (max), "value " pri " not in range " pri "-" pri, (value), (min), (max))

Definition at line 138 of file panic.h.

◆ CT_NEVER

#define CT_NEVER ( ... ) CT_PANIC(__VA_ARGS__)

assert that a code path is never reached

Parameters

...	the format string and optional arguments to format

Definition at line 136 of file panic.h.

◆ CT_PANIC

#define CT_PANIC ( ... )

Value:

    do                               \
    {                                \
        CT_PANIC_INNER(__VA_ARGS__); \
    } while (0)

panic with a message and optional format arguments

Parameters

...	the format string and optional arguments to format

Definition at line 72 of file panic.h.

◆ CT_PANIC_INNER

#define CT_PANIC_INNER ( ... )

Value:

source_info_t panic_source = CT_SOURCE_CURRENT; \

ctu_panic(panic_source, __VA_ARGS__)

CT_SOURCE_CURRENT

#define CT_SOURCE_CURRENT

the source location of the current line

Definition: source_info.h:40

source_info_t

panic location information

Definition: source_info.h:26

Definition at line 64 of file panic.h.

◆ CT_PARANOID

#define CT_PARANOID ( ... )

a block of code that is only executed in paranoid builds

◆ CT_PARANOID_ASSERTF

#define CT_PARANOID_ASSERTF	(	expr,
		...
	)

assert a condition with a message and optional format arguments

◆ CTASSERT

#define CTASSERT ( expr ) CTASSERTM(expr, #expr)

assert a condition, prints the condition as a message

Parameters

expr	the condition to assert

Definition at line 130 of file panic.h.

◆ CTASSERT_ALWAYS

#define CTASSERT_ALWAYS ( expr ) CTASSERTF_ALWAYS(expr, "assertion failed: %s", #expr)

Definition at line 94 of file panic.h.

◆ CTASSERTF

#define CTASSERTF	(	expr,
		...
	)	CT_ASSUME(expr)

assert a condition with a message and optional format arguments

Note: in release builds this expands to CT_ASSUME

Parameters

expr	the condition to assert
...	the format string and optional arguments to format

Definition at line 116 of file panic.h.

◆ CTASSERTF_ALWAYS

#define CTASSERTF_ALWAYS	(	expr,
		...
	)

Value:

    do                                   \
    {                                    \
        if (!(expr))                     \
        {                                \
            CT_PANIC_INNER(__VA_ARGS__); \
        }                                \
    } while (0)

assert a condition with a message and optional format arguments

Note: this always expands to a panic

Parameters

expr	the condition to assert
...	the format string and optional arguments to format

Definition at line 85 of file panic.h.

◆ CTASSERTM

#define CTASSERTM	(	expr,
		msg
	)	CTASSERTF(expr, "%s", msg)

assert a condition with a message

Parameters

expr	the condition to assert
msg	the message to print

Definition at line 124 of file panic.h.

◆ CTASSERTM_ALWAYS

#define CTASSERTM_ALWAYS	(	expr,
		msg
	)	CTASSERTF_ALWAYS(expr, "%s", msg)

Definition at line 95 of file panic.h.

◆ CTU_DEBUG

#define CTU_DEBUG 0

enable panic handling

Note: this is only enabled in debug builds, see The build guide for more information

Definition at line 29 of file panic.h.

◆ CTU_PARANOID

#define CTU_PARANOID 0

enable paranoid assertions for expensive assertions that shouldnt be used too often use these for things that you do not want being turned into assumes due to the execution cost

Definition at line 30 of file panic.h.

Typedef Documentation

◆ panic_handler_t

typedef void(* panic_handler_t) (source_info_t location, STA_FORMAT_STRING const char *fmt, va_list args)

panic handler function

Parameters

location	the source location of the panic
fmt	the format string
args	the format arguments

Note: this function should not allocate memory using a compiler arena; this function should not return

Definition at line 40 of file panic.h.

Function Documentation

◆ ctu_panic()

CT_BASE_API CT_NORETURN ctu_panic	(	source_info_t	location,
		STA_FORMAT_STRING const char *	msg,
			...
	)

panic with a message, file, and line

Parameters

location	the source location of the panic
msg	the message to panic with
...	the arguments to format

◆ ctu_vpanic()

CT_BASE_API CT_NORETURN ctu_vpanic	(	source_info_t	location,
		STA_FORMAT_STRING const char *	msg,
		va_list	args
	)

panic with a message, file, and line

Parameters

location	the source location of the panic
msg	the message to panic with
args	the arguments to format

Variable Documentation

◆ gPanicHandler

CT_BASE_API panic_handler_t gPanicHandler

extern

the global panic handler.

by default this prints a stacktrace and aborts it can be overridden for testing purposes or to add more functionality

Definition at line 5 of file panic.c.

Macros

Typedefs

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ CT_ASSERT_RANGE

◆ CT_ASSERT_RANGE_PRI

◆ CT_NEVER

◆ CT_PANIC

◆ CT_PANIC_INNER

◆ CT_PARANOID

◆ CT_PARANOID_ASSERTF

◆ CTASSERT

◆ CTASSERT_ALWAYS

◆ CTASSERTF

◆ CTASSERTF_ALWAYS

◆ CTASSERTM

◆ CTASSERTM_ALWAYS

◆ CTU_DEBUG

◆ CTU_PARANOID

Typedef Documentation

◆ panic_handler_t

Function Documentation

◆ ctu_panic()

◆ ctu_vpanic()

Variable Documentation

◆ gPanicHandler