config.h File Reference

Basic configuration file. More...

#include <ogdf/basic/internal/config_autogen.h>
#include <ogdf/basic/internal/version.h>
#include <sstream>
#include <string>

Go to the source code of this file.

Classes
class	ogdf::Configuration
	Provides information about how OGDF has been configured. More...

Namespaces
	ogdf
	The namespace for all OGDF objects.

Macros
#define	OGDF_CASE_FALLTHROUGH
	An attribute to mark cases (in switch) that fall through to the next case. More...
#define	OGDF_HAS_CPP_ATTRIBUTE(x)   0
Important when compiling OGDF as DLL
#define	OGDF_EXPORT
	Specifies that a function or class is exported by the OGDF DLL. More...
Deprecation
#define	OGDF_DEPRECATED(reason)
	Mark a class / member / function as deprecated. More...
Macros for locally disabling compiler warnings
#define	OGDF_DISABLE_WARNING(warningNumber)
	Disable the warning with the given number of MSVC or name of g++/clang. More...
#define	OGDF_DISABLE_WARNING_DEPRECATED
	Disable deprecation warnings. More...
#define	OGDF_DISABLE_WARNING_POP
	End the current warning configuration context (i.e. do pragma diagnostic/warning pop) More...
#define	OGDF_DISABLE_WARNING_PUSH
	Start a new warning configuration context (i.e. do pragma diagnostic/warning push) More...
#define	OGDF_DISABLE_WARNING_THROW_TERMINATE
	Disable the warning that calling throw will always terminate the program in a noexept block. More...
#define	OGDF_DISABLE_WARNING_UNUSED
	Disable the warning that something is unused. More...
Unused results
#define	OGDF_NODISCARD
	Indicate that the result of a function call should not be discarded. More...
Optimization
#define	OGDF_DECL_ALIGN(b)
	Specify the minimum alignment (in bytes) of a type to be b. This is used in type declarations. More...
#define	OGDF_LIKELY(x)   (x)
	Specify the likely branch in a condition. More...
#define	OGDF_UNLIKELY(x)   (x)
	Specify the unlikely branch in a condition. More...

Functions
std::ostream &	ogdf::operator<< (std::ostream &os, Configuration::LPSolver lps)
	Output operator for Configuration::LPSolver (uses Configuration::toString(Configuration::LPSolver)). More...
std::ostream &	ogdf::operator<< (std::ostream &os, Configuration::MemoryManager mm)
	Output operator for Configuration::MemoryManager (uses Configuration::toString(Configuration::MemoryManager)). More...
std::ostream &	ogdf::operator<< (std::ostream &os, Configuration::System sys)
	Output operator for Configuration::System (uses Configuration::toString(Configuration::System)). More...

Detailed Description

Basic configuration file.

Author

Carsten Gutwenger

License:

This file is part of the Open Graph Drawing Framework (OGDF).

Copyright (C)
See README.md in the OGDF root directory for details.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License Version 2 or 3 as published by the Free Software Foundation; see the file LICENSE.txt included in the packaging of this file for details.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, see http://www.gnu.org/copyleft/gpl.html

Definition in file config.h.

Macro Definition Documentation

OGDF_CASE_FALLTHROUGH

#define OGDF_CASE_FALLTHROUGH

An attribute to mark cases (in switch) that fall through to the next case.

Definition at line 251 of file config.h.

OGDF_EXPORT

#define OGDF_EXPORT

Specifies that a function or class is exported by the OGDF DLL.

It is set according to the definition of OGDF_INSTALL (OGDF is build as DLL) and OGDF_DLL (OGDF is used as DLL). If none of these are defined (OGDF is build or used as static library), the define expands to nothing.

Definition at line 101 of file config.h.

OGDF_HAS_CPP_ATTRIBUTE

#define OGDF_HAS_CPP_ATTRIBUTE

(

x

)

0

Definition at line 89 of file config.h.