common.h File Reference

Go to the source code of this file.

Macros
#define	KSI_ATTRIBUTE(x)
#define	KSI_IS_VALID_TREE_LEVEL(level)   (((level) <= 0xff) && ((int)(level) >= 0))
#define	KSI_FN_DEPRECATED(decl, comment)   /*! \deprecated comment */ decl
#define	KSI_VAR_DEPRECATED(decl, comment)   /*! \deprecated comment */ decl
#define	KSI_ENUM_DEPRECATED(decl, comment)   /*! \deprecated comment */ decl
#define	KSI_DEFINE_EXTERN(e)   extern e
#define	KSI_UNUSED(x)   KSI_ATTRIBUTE((__unused__)) x

Macro Definition Documentation

KSI_ATTRIBUTE

#define KSI_ATTRIBUTE

(

x

)

KSI_DEFINE_EXTERN

#define KSI_DEFINE_EXTERN

(

e

)

extern e

KSI_ENUM_DEPRECATED

#define KSI_ENUM_DEPRECATED	(		decl,
			comment
	)		/*! \deprecated comment */ decl

Marks a enumerator as deprecated.

KSI_FN_DEPRECATED

#define KSI_FN_DEPRECATED	(		decl,
			comment
	)		/*! \deprecated comment */ decl

Marks a function as deprecated.

KSI_IS_VALID_TREE_LEVEL

#define KSI_IS_VALID_TREE_LEVEL

(

level

)

(((level) <= 0xff) && ((int)(level) >= 0))

A macro for validating the correctness of any given hash tree level.

Parameters

[in]

level

The level to be checked.

Returns

If the parameter is a valid hash tree level a non-zero value is return, zero otherwise.

KSI_UNUSED

#define KSI_UNUSED

(

x

)

KSI_ATTRIBUTE((__unused__)) x

The function parameter is unused inside the function body.

KSI_VAR_DEPRECATED

#define KSI_VAR_DEPRECATED	(		decl,
			comment
	)		/*! \deprecated comment */ decl

Marks a variable as deprecated.