|
|||
|
|
|
|||
|
|
Several useful macros defined by the OGDF. More...
Macros | |
| #define | OGDF_SIZEOF_POINTER 8 |
| The size of a pointer. | |
Assertions (only active in debug builds) | |
| #define | OGDF_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. | |
Throwing exceptions | |
| #define | OGDF_THROW_PARAM(CLASS, PARAM) OGDF_FLUSH_OUTPUTS, throw CLASS(PARAM) |
Replacement for throw. | |
| #define | OGDF_THROW(CLASS) OGDF_FLUSH_OUTPUTS, throw CLASS() |
Replacement for throw. | |
Deprecation | |
| #define | OGDF_DEPRECATED(reason) |
| Mark a class / member / function as deprecated. | |
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. | |
Several useful macros defined by the OGDF.
Assert condition expr. See doc/build.md for more information.
| #define OGDF_DECL_ALIGN | ( | b | ) |
| #define OGDF_DEPRECATED | ( | reason | ) |
| #define OGDF_LIKELY | ( | x | ) | (x) |
Specify the likely branch in a condition.
Usage:
| #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.
| #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.
| #define OGDF_SIZEOF_POINTER 8 |
The size of a pointer.
Definition at line 25 of file config_autogen.h.
| #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).
| CLASS | is the name of the exception class. |
Definition at line 63 of file exceptions.h.
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).
| 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 54 of file exceptions.h.
| #define OGDF_UNLIKELY | ( | x | ) | (x) |
Specify the unlikely branch in a condition.
Usage:
