defs.h File Reference

This file contains preprocessor utility definitions shared among the ARI library. More...

Macros
#define	_U_
	Mark an unused parameter Within a function definition.
#define	UNLIKELY(expr)   (expr)
#define	LIKELY(expr)   (expr)
#define	CHKRET(cond, val)
	Check a condition and if not met return a specific value.
#define	CHKVOID(cond)   CHKRET(cond, )
	Return from void functions if condition fails.
#define	CHKNULL(cond)   CHKRET(cond, NULL)
	Return a null pointer if condition fails.
#define	CHKFALSE(cond)   CHKRET(cond, false)
	Return false if condition fails.
#define	CHKERR1(cond)   CHKRET(cond, 1)
	Return the error value 1 if condition fails.
#define	CHKERRVAL(value)   CHKRET(!value, value)
	Check a value for non-zero and return that value.

Detailed Description

This file contains preprocessor utility definitions shared among the ARI library.

Macro Definition Documentation

_U_

#define _U_

Mark an unused parameter Within a function definition.

This avoids compiler warnings when parameters need to be present to satisfy an interface but are otherwise unused.

CHKERR1

#define CHKERR1

(

cond

)

CHKRET(cond, 1)

Return the error value 1 if condition fails.

CHKERRVAL

#define CHKERRVAL

(

value

)

CHKRET(!value, value)

Check a value for non-zero and return that value.

Warning

The parameter is evaluated twice so should be a simple variable.

Parameters

value

The value to check and conditionally return.

CHKFALSE

#define CHKFALSE

(

cond

)

CHKRET(cond, false)

Return false if condition fails.

CHKNULL

#define CHKNULL

(

cond

)

CHKRET(cond, NULL)

Return a null pointer if condition fails.

CHKRET

#define CHKRET	(		cond,
			val
	)

Value:

    if (!LIKELY(cond))    \
    {                     \
        return val;       \
    }

Check a condition and if not met return a specific value.

Parameters

cond	The condition to check.
val	The return value if the check fails.

CHKVOID

#define CHKVOID

(

cond

)

CHKRET(cond, )

Return from void functions if condition fails.

LIKELY

#define LIKELY

(

expr

)

(expr)

UNLIKELY

#define UNLIKELY

(

expr

)

(expr)