Common macros used throughout the project. More...

Collaboration diagram for Common macros:

Modules
	ANSI Colour macros
	ANSI escape string colour macros.

	Exit codes
	Exit codes that match with GNU standard codes.

Macros
#define	CT_STATIC_ASSERT(expr, msg) _Static_assert(expr, msg)

#define	CT_DEPRECATED(msg)
	mark a function as deprecated More...

#define	CT_MAX(L, R) ((L) > (R) ? (L) : (R))

#define	CT_MIN(L, R) ((L) < (R) ? (L) : (R))

#define	CT_ALIGN_POW2(X, ALIGN) (((X) + (ALIGN)-1) & ~((ALIGN)-1))

#define	CT_UNUSED(x) ((void)(x))
	mark a variable as unused More...

#define	CT_STR(x) CT_INNER_STR(x)
	converts a macro to a string More...

#define	CT_INNER_STR(x) #x

#define	CT_CONCAT(a, b) a##b
	concatenates two macros More...

#define	CT_VERSION_STR CT_STR(CTU_VERSION_MAJOR) "." CT_STR(CTU_VERSION_MINOR) "." CT_STR(CTU_VERSION_PATCH)
	the version of the project as a string More...

#define	CT_ARRAY_LEN(arr) (sizeof(arr) / sizeof(*arr))
	returns the length of an array More...

Detailed Description

Common macros used throughout the project.

Macro Definition Documentation

◆ CT_ALIGN_POW2

#define CT_ALIGN_POW2	(	X,
		ALIGN
	)	(((X) + (ALIGN)-1) & ~((ALIGN)-1))

aligns X to the next power of 2 of ALIGN

Definition at line 42 of file macros.h.

◆ CT_ARRAY_LEN

#define CT_ARRAY_LEN ( arr ) (sizeof(arr) / sizeof(*arr))

returns the length of an array

Definition at line 63 of file macros.h.

◆ CT_CONCAT

#define CT_CONCAT	(	a,
		b
	)	a##b

concatenates two macros

Definition at line 55 of file macros.h.

◆ CT_DEPRECATED

#define CT_DEPRECATED ( msg )

mark a function as deprecated

Parameters

msg	the message to display when the function is used

◆ CT_INNER_STR

#define CT_INNER_STR ( x ) #x

Definition at line 50 of file macros.h.

◆ CT_MAX

#define CT_MAX	(	L,
		R
	)	((L) > (R) ? (L) : (R))

returns the maximum of lhs and rhs

Definition at line 34 of file macros.h.

◆ CT_MIN

#define CT_MIN	(	L,
		R
	)	((L) < (R) ? (L) : (R))

returns the minimum of lhs and rhs

Definition at line 38 of file macros.h.

◆ CT_STATIC_ASSERT

#define CT_STATIC_ASSERT	(	expr,
		msg
	)	_Static_assert(expr, msg)

Definition at line 15 of file macros.h.

◆ CT_STR

#define CT_STR ( x ) CT_INNER_STR(x)

converts a macro to a string

Definition at line 51 of file macros.h.

◆ CT_UNUSED

#define CT_UNUSED ( x ) ((void)(x))

mark a variable as unused

Definition at line 46 of file macros.h.

◆ CT_VERSION_STR

#define CT_VERSION_STR CT_STR(CTU_VERSION_MAJOR) "." CT_STR(CTU_VERSION_MINOR) "." CT_STR(CTU_VERSION_PATCH)

the version of the project as a string

Definition at line 59 of file macros.h.

Modules

Macros