enum_cast.h File Reference

#include "ic_macros/assert_type.h"
#include "ic_macros/ic_assert.h"
#include "ic_macros/integer_cast.h"
#include "zephyr/util.h"

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	IC_CAST_ENUM(type, min, max, expr)
	Compile-time constant safe cast from an integer type to an enum. More...
#define	IC_Z_CAST_ENUM(type, min, max, expr)
	Safe cast from from an integer type to an enum. More...

Macro Definition Documentation

IC_CAST_ENUM

#define IC_CAST_ENUM	(		type,
			min,
			max,
			expr
	)

Value:

    ({ \
        IC_BUILD_ASSERT(__typeof__(expr) == type || IC_IS_INT(expr) || IC_IS_UINT(expr)); \
        IC_CAST_NUMBER(type, min, max, expr); \
    })

Compile-time constant safe cast from an integer type to an enum.

Note

Use IC_Z_CAST_ENUM for a runtime variant of this macro.

Parameters

type	The enum type to cast to.
min	The minimum value of type, e.g. 0 or MY_ENUM_MIN.
max	The maximum value of type, e.g. MY_ENUM_MAX.
expr	The expression to cast.

Returns

The expr casted to type: (type) (expr)

Definition at line 21 of file enum_cast.h.

IC_Z_CAST_ENUM

#define IC_Z_CAST_ENUM	(		type,
			min,
			max,
			expr
	)

Value:

    ({ \
        __auto_type const _IC_Z_CAST_NUMBER_expr_ = IC_REQUIRE_NOT_CONSTANT(expr); \
        IC_BUILD_ASSERT(!IC_IS_FP(_IC_Z_CAST_NUMBER_expr_)); \
        IC_ASSERT(IC_IN_RANGE(_IC_Z_CAST_NUMBER_expr_, min, max)); \
        (type) _IC_Z_CAST_NUMBER_expr_; \
    })

Safe cast from from an integer type to an enum.

Note

The expression will be evaluated once.

Parameters

type	The enum type to cast to.
min	The minimum value of type, e.g. 0 or MY_ENUM_MIN.
max	The maximum value of type, e.g. MY_ENUM_MAX.
expr	The expression to cast.

Returns

The expr casted to type: (type) (expr)

Definition at line 36 of file enum_cast.h.