chdr.hpp.in

/*
 * Computational Helper for Direction and Routing (CHDR)
 * Copyright (c) 2024 by Nazar Elsayed & Louis Eriksson
 *
 * Licensed under CC BY-NC-ND 4.0
 * https://creativecommons.org/licenses/by-nc-nd/4.0/
 */

#ifndef CHDR_COMMON_HPP
#define CHDR_COMMON_HPP

#ifndef __cplusplus
#error "<chdr.hpp> is for C++ only."
#endif

/**
 * @file chdr.hpp
 *
 * @details Include this header in your project to access the CHDR library.
 *
 * @code
 * #include <chdr.hpp>
 * @endcode
 *
 * @note Please refer to the [manual](docs/manual/getting_started.md) for more information.
 */

/** @brief Full version string of the CHDR library. */
#define CHDR_VERSION          "@CHDR_VERSION_FULL@"

/** @brief CHDR major version number. */
#define CHDR_VERSION_MAJOR     @CHDR_VERSION_MAJOR@

/** @brief CHDR minor version number. */
#define CHDR_VERSION_MINOR     @CHDR_VERSION_MINOR@

/** @brief CHDR patch version number. */
#define CHDR_VERSION_PATCH     @CHDR_VERSION_PATCH@

/** @brief CHDR version tweak string. */
#define CHDR_VERSION_TWEAK    "@CHDR_VERSION_TWEAK@"

/** @brief CHDR version metadata string. */
#define CHDR_VERSION_METADATA "@CHDR_VERSION_METADATA@"

/** @brief Flag indicating whether or not diagnostics should be output by the library (0 = off, 1 = on). */
#ifndef CHDR_DIAGNOSTICS
#define CHDR_DIAGNOSTICS 0
#endif //CHDR_DIAGNOSTICS

/* ReSharper enable CppUnusedIncludeDirective */
// NOLINTBEGIN(*-include-cleaner)

@INCLUDE_HEADERS@
// NOLINTEND(*-include-cleaner)
/* ReSharper disable CppUnusedIncludeDirective */

#endif //CHDR_COMMON_HPP