macros.h File Reference

Defines macros and constants for the library. More...

Go to the source code of this file.

Macros
#define	CHESS_CONSTEXPR   const
	Expands to constexpr if available, otherwise to const.
#define	CHESS_DEFINE_INTEGRAL_CONSTANT(type, name, value)
	Defines a compile time integral constant.
#define	CHESS_ENUM(type, name)
	Defines a typed enum or a typedef enum based on the availability of typed enums in the compiler.
#define	CHESS_NULL   NULL
	Expands to nullptr if available, otherwise to NULL.
#define	CHESS_ARRAY_LENGTH(array)   (sizeof(array) / sizeof((array)[0]))
	Computes the length of the given array.

Detailed Description

Defines macros and constants for the library.

Author

Tarek Saeed

Date

2025-06-14

Macro Definition Documentation

CHESS_ARRAY_LENGTH

#define CHESS_ARRAY_LENGTH

(

array

)

(sizeof(array) / sizeof((array)[0]))

Computes the length of the given array.

Parameters

[in]

array

The array

Returns

The length of the array

CHESS_DEFINE_INTEGRAL_CONSTANT

#define CHESS_DEFINE_INTEGRAL_CONSTANT	(		type,
			name,
			value
	)

Value:

      enum {                                                  \
        name = (value)                                        \
      }

Defines a compile time integral constant.

Parameters

[in]	type	The type of the constant.
[in]	name	The name of the constant.
[in]	value	The value of the constant.

CHESS_ENUM

#define CHESS_ENUM	(		type,
			name
	)

Value:

    typedef type name;           \
    enum name

Defines a typed enum or a typedef enum based on the availability of typed enums in the compiler.

Parameters

[in]	type	The underlying type of the enum.
[in]	name	The name of the enum type.