/home/fwph/code/wurde/rde/core/wds-debug.h File Reference

Go to the source code of this file.

Defines
Level 3 debugging macros
#define	debug_3(format,...)
	Print debug message.
#define	debug_verbose(format,...)
	Print debug message.
Level 2 debugging macros
#define	debug_2(format,...)
	Print debug message.
#define	debug_medium(format,...)
	Print debug message.
Level 1 debugging macros
#define	debug_1(format,...)
	Print debug message.
Pointer helper macros
Print debug message
#define	invalidate_pointer(pointer)   pointer = NULL
	Invalidate a pointer by setting it to NULL. This will only take effect in debug mode.
Helper assertions
These helper macros perform some common assertion checks.
#define	assert_pointer(pointer)   assert((pointer) != NULL)
	Assert that a pointer is not NULL.
#define	assert_range(number, low, high)   assert(((number) >= (low)) && ((number) < (high)))
	Assert that low <= number < high.
#define	assert_natural(number)   assert((number) >= 0)
	Assert that number >= 0.
#define	assert_range_inc(number, low, high)   assert(((number) >= (low)) && ((number) <= (high)))
	Assert that low <= number <= high.
#define	assert_more(number, threshold)   assert((number) > (threshold))
	Assert that number > threshold.
#define	assert_more_inc(number, threshold)   assert((number) >= (threshold))
	Assert that number >= threshold.
#define	assert_less(number, threshold)   assert((number) < (threshold))
	Assert that number < threshold.
#define	assert_less_inc(number, threshold)   assert((number) <= (threshold))
	Assert that number <= threshold.
#define	assert_prob(number)   assert_range_inc(number, 0.0, 1.0)
	Assert that number is a valid probability.

---

Define Documentation

#define assert_less	(	number,
		threshold		)	assert((number) < (threshold))

Assert that number < threshold.

Parameters:

[in]	number	A number
[in]	threshold	The threhsold

Definition at line 226 of file wds-debug.h.

#define assert_less_inc	(	number,
		threshold		)	assert((number) <= (threshold))

Assert that number <= threshold.

Parameters:

[in]	number	A number
[in]	threshold	The threshold

Definition at line 231 of file wds-debug.h.

#define assert_more	(	number,
		threshold		)	assert((number) > (threshold))

Assert that number > threshold.

Parameters:

[in]	number	A number
[in]	threshold	The threshold

Definition at line 216 of file wds-debug.h.

#define assert_more_inc	(	number,
		threshold		)	assert((number) >= (threshold))

Assert that number >= threshold.

Parameters:

[in]	number	A number
[in]	threshold	The threshold

Definition at line 221 of file wds-debug.h.

#define assert_natural

(

number

)

assert((number) >= 0)

Assert that number >= 0.

Parameters:

[in]

number

A number

Definition at line 204 of file wds-debug.h.

#define assert_pointer

(

pointer

)

assert((pointer) != NULL)

Assert that a pointer is not NULL.

Parameters:

[in]

pointer

A pointer

Definition at line 193 of file wds-debug.h.

#define assert_prob

(

number

)

assert_range_inc(number, 0.0, 1.0)

Assert that number is a valid probability.

Parameters:

[in]

number

A number

Definition at line 235 of file wds-debug.h.

#define assert_range	(	number,
		low,
		high		)	assert(((number) >= (low)) && ((number) < (high)))

Assert that low <= number < high.

Parameters:

[in]	number	A number
[in]	low	Low limit
[in]	high	High limit

Definition at line 199 of file wds-debug.h.

Referenced by GameController::axis(), GameController::button(), LocalArray2d::operator()(), LocalArray< double, Size >::operator()(), Array2d::operator()(), Array::operator()(), LocalArray< double, Size >::operator[](), and Array::operator[]().

#define assert_range_inc	(	number,
		low,
		high		)	assert(((number) >= (low)) && ((number) <= (high)))

Assert that low <= number <= high.

Parameters:

[in]	number	A number
[in]	low	Low limit
[in]	high	High limit

Definition at line 210 of file wds-debug.h.

#define debug_1	(	format,
		...		)

Print debug message.

Parameters:

[in]	format	Output in fprintf format, with appropriate arguments.
[in]	...	Variable argument list, corresponding to format argument.

Definition at line 164 of file wds-debug.h.

#define debug_2	(	format,
		...		)

Print debug message.

Parameters:

[in]	format	Output in fprintf format, with appropriate arguments.
[in]	...	Variable argument list, corresponding to format argument.

Definition at line 138 of file wds-debug.h.

#define debug_3	(	format,
		...		)

Print debug message.

Parameters:

[in]	format	Output in fprintf format, with appropriate arguments.
[in]	...	Variable argument list, corresponding to format argument.

Definition at line 115 of file wds-debug.h.

#define debug_medium	(	format,
		...		)

Print debug message.

Parameters:

[in]	format	Output in fprintf format, with appropriate arguments.
[in]	...	Variable argument list, corresponding to format argument.

Definition at line 142 of file wds-debug.h.

#define debug_verbose	(	format,
		...		)

Print debug message.

Parameters:

[in]	format	Output in fprintf format, with appropriate arguments.
[in]	...	Variable argument list, corresponding to format argument.

Definition at line 119 of file wds-debug.h.

#define invalidate_pointer

(

pointer

)

pointer = NULL

Invalidate a pointer by setting it to NULL. This will only take effect in debug mode.

Parameters:

[in]

pointer

A pointer

Definition at line 181 of file wds-debug.h.

Referenced by Array::~Array(), and Array2d::~Array2d().

---