Useful Macros

Several useful macros defined by the OGDF. More...

Assertions (only active in debug builds)
#define	OGDF_ASSERT(expr)
	Assert condition expr. See doc/build.md for more information.
#define	OGDF_ASSERT(expr)   assert(expr)
	Assert condition expr. See doc/build.md for more information.
#define	OGDF_HEAVY_ASSERT(expr)
	Assert condition expr when using heavy debugging. See OGDF_ASSERT.
#define	OGDF_IF_DBG(x)
	Single statement that will only be compiled if OGDF_DEBUG is defined.
#define	OGDF_IF_DBG(x)   x
	Single statement that will only be compiled if OGDF_DEBUG is defined.

Throwing exceptions
#define	OGDF_THROW_PARAM(CLASS, PARAM)   OGDF_FLUSH_OUTPUTS, throw CLASS(PARAM)
	Replacement for throw.
#define	OGDF_THROW_PARAM(CLASS, PARAM)    OGDF_FLUSH_OUTPUTS, throw CLASS(PARAM, __FILE__, __LINE__)
	Replacement for throw.
#define	OGDF_THROW(CLASS)   OGDF_FLUSH_OUTPUTS, throw CLASS()
	Replacement for throw.
#define	OGDF_THROW(CLASS)   OGDF_FLUSH_OUTPUTS, throw CLASS(__FILE__, __LINE__)
	Replacement for throw.

Deprecation
#define	OGDF_DEPRECATED(reason)
	Mark a class / member / function as deprecated.

Macros for locally disabling compiler warnings
#define	OGDF_DISABLE_WARNING_PUSH
	Start a new warning configuration context (i.e. do pragma diagnostic/warning push)
#define	OGDF_DISABLE_WARNING_POP
	End the current warning configuration context (i.e. do pragma diagnostic/warning pop)
#define	OGDF_DISABLE_WARNING(warningNumber)
	Disable the warning with the given number of MSVC or name of g++/clang.
#define	OGDF_DISABLE_WARNING_THROW_TERMINATE
	Disable the warning that calling throw will always terminate the program in a noexept block.
#define	OGDF_DISABLE_WARNING_UNUSED
	Disable the warning that something is unused.
#define	OGDF_DISABLE_WARNING_DEPRECATED
	Disable deprecation warnings.

Unused results
#define	OGDF_NODISCARD
	Indicate that the result of a function call should not be discarded.

Optimization
#define	OGDF_LIKELY(x)   (x)
	Specify the likely branch in a condition.
#define	OGDF_UNLIKELY(x)   (x)
	Specify the unlikely branch in a condition.
#define	OGDF_DECL_ALIGN(b)
	Specify the minimum alignment (in bytes) of a type to be b. This is used in type declarations.

Managing memory
#define	OGDF_NEW_DELETE   OGDF_MM(OGDF_ALLOCATOR)
	Makes the class use OGDF's memory allocator.
#define	OGDF_MALLOC_NEW_DELETE   OGDF_MM(ogdf::MallocMemoryAllocator)
	Makes the class use malloc for memory allocation.

Detailed Description

Several useful macros defined by the OGDF.

Macro Definition Documentation

OGDF_ASSERT [1/2]

#define OGDF_ASSERT

(

expr

)

Assert condition expr. See doc/build.md for more information.

Definition at line 52 of file basic.h.

OGDF_ASSERT [2/2]

#define OGDF_ASSERT

(

expr

)

assert(expr)

Assert condition expr. See doc/build.md for more information.

Definition at line 52 of file basic.h.

OGDF_DECL_ALIGN

#define OGDF_DECL_ALIGN

(

b

)

Specify the minimum alignment (in bytes) of a type to be b. This is used in type declarations.

Definition at line 320 of file config.h.

OGDF_DEPRECATED

#define OGDF_DEPRECATED

(

reason

)

Mark a class / member / function as deprecated.

Definition at line 206 of file config.h.

OGDF_DISABLE_WARNING

#define OGDF_DISABLE_WARNING

(

warningNumber

)

Disable the warning with the given number of MSVC or name of g++/clang.

Definition at line 233 of file config.h.

OGDF_DISABLE_WARNING_DEPRECATED

#define OGDF_DISABLE_WARNING_DEPRECATED

Disable deprecation warnings.

Definition at line 245 of file config.h.

OGDF_DISABLE_WARNING_POP

#define OGDF_DISABLE_WARNING_POP

End the current warning configuration context (i.e. do pragma diagnostic/warning pop)

Definition at line 229 of file config.h.

OGDF_DISABLE_WARNING_PUSH

#define OGDF_DISABLE_WARNING_PUSH

Start a new warning configuration context (i.e. do pragma diagnostic/warning push)

Definition at line 225 of file config.h.

OGDF_DISABLE_WARNING_THROW_TERMINATE

#define OGDF_DISABLE_WARNING_THROW_TERMINATE

Disable the warning that calling throw will always terminate the program in a noexept block.

Definition at line 237 of file config.h.

OGDF_DISABLE_WARNING_UNUSED

#define OGDF_DISABLE_WARNING_UNUSED

Disable the warning that something is unused.

Definition at line 241 of file config.h.

OGDF_HEAVY_ASSERT

#define OGDF_HEAVY_ASSERT

(

expr

)

Assert condition expr when using heavy debugging. See OGDF_ASSERT.

Definition at line 55 of file basic.h.

OGDF_IF_DBG [1/2]

#define OGDF_IF_DBG

(

x

)

Single statement that will only be compiled if OGDF_DEBUG is defined.

Definition at line 98 of file basic.h.

OGDF_IF_DBG [2/2]

#define OGDF_IF_DBG

(

x

)

x

Single statement that will only be compiled if OGDF_DEBUG is defined.

Definition at line 98 of file basic.h.

OGDF_LIKELY

#define OGDF_LIKELY

(

x

)

(x)

Specify the likely branch in a condition.

Usage:

if (OGDF_LIKELY(i >= 0)) { likely branch } else { unlikely branch } 

Definition at line 309 of file config.h.

OGDF_MALLOC_NEW_DELETE

#define OGDF_MALLOC_NEW_DELETE   OGDF_MM(ogdf::MallocMemoryAllocator)

Makes the class use malloc for memory allocation.

Creates new and delete operators in a class using the given memory allocator.

In other words, adding this macro in a class declaration makes that class managed by the respective memory manager. Throws an ogdf::InsufficientMemoryException if no more memory is available.

Definition at line 92 of file memory.h.

OGDF_NEW_DELETE

#define OGDF_NEW_DELETE   OGDF_MM(OGDF_ALLOCATOR)

Makes the class use OGDF's memory allocator.

Creates new and delete operators in a class using the given memory allocator.

In other words, adding this macro in a class declaration makes that class managed by the respective memory manager. Throws an ogdf::InsufficientMemoryException if no more memory is available.

Definition at line 85 of file memory.h.

OGDF_NODISCARD

#define OGDF_NODISCARD

Indicate that the result of a function call should not be discarded.

Definition at line 289 of file config.h.

OGDF_THROW [1/2]

#define OGDF_THROW

(

CLASS

)

OGDF_FLUSH_OUTPUTS, throw CLASS()

Replacement for throw.

This macro is used to throw an exception and pass the file name and line number of the location in the source file (in Debug mode only).

Parameters

CLASS

is the name of the exception class.

Definition at line 67 of file exceptions.h.

OGDF_THROW [2/2]

#define OGDF_THROW

(

CLASS

)

OGDF_FLUSH_OUTPUTS, throw CLASS(__FILE__, __LINE__)

Replacement for throw.

This macro is used to throw an exception and pass the file name and line number of the location in the source file (in Debug mode only).

Parameters

CLASS

is the name of the exception class.

Definition at line 67 of file exceptions.h.

OGDF_THROW_PARAM [1/2]

#define OGDF_THROW_PARAM	(		CLASS,
			PARAM
	)		OGDF_FLUSH_OUTPUTS, throw CLASS(PARAM)

Replacement for throw.

This macro is used to throw an exception and pass the file name and line number of the location in the source file (in Debug mode only).

Parameters

CLASS	is the name of the exception class.
PARAM	is an additional parameter (like the error code) required by the exception calls.

Definition at line 58 of file exceptions.h.

OGDF_THROW_PARAM [2/2]

#define OGDF_THROW_PARAM	(		CLASS,
			PARAM
	)		OGDF_FLUSH_OUTPUTS, throw CLASS(PARAM, __FILE__, __LINE__)

Replacement for throw.

This macro is used to throw an exception and pass the file name and line number of the location in the source file (in Debug mode only).

Parameters

CLASS	is the name of the exception class.
PARAM	is an additional parameter (like the error code) required by the exception calls.

Definition at line 58 of file exceptions.h.

OGDF_UNLIKELY

#define OGDF_UNLIKELY

(

x

)

(x)

Specify the unlikely branch in a condition.

Usage:

if (OGDF_UNLIKELY(set.empty())) { unlikely branch } else { likely branch } 

Definition at line 316 of file config.h.