version.hpp

// SPDX-License-Identifier: Apache-2.0
 
#pragma once
#include <string_view>
 
// The five macros below are the `#if`-testable half of morph's version API, and
// being macros is the whole of what they are for. A downstream compiling against
// two morph releases writes
//
//     #if MORPH_VERSION >= MORPH_MAKE_VERSION(1, 2, 0)
//
// which the preprocessor has to answer before any C++ declaration exists. An
// enumerator or a `constexpr int` is invisible in a `#if`, and a `constexpr`
// function cannot be called from one, so `MORPH_MAKE_VERSION` has to be
// function-like for the same reason. The three checks below do not propose a
// different spelling of this header; they propose removing the capability it
// exists to provide. That is the meaning of "unfixable by construction", and it
// is why this is a suppression rather than a deferral -- there is no later
// version of this file in which the finding goes away.
//
// The C++-visible constants the checks ask for do exist: `morph::version::kMajor`
// and friends, below, defined *from* these macros so the two cannot drift. Code
// that does not need a `#if` should use those, and this header offering both is
// the resolution, not a duplication.
//
// docs/spec/VERSIONING.md is the contract; tests/test_version.cpp pins these
// against the top-level `project(morph VERSION ...)`.
// NOLINTBEGIN(cppcoreguidelines-macro-to-enum, modernize-macro-to-enum, cppcoreguidelines-macro-usage)
 
/// @brief morph's major version component (semantic-versioning MAJOR:
/// incremented for a breaking source change to the stable public surface —
/// see docs/spec/VERSIONING.md).
#define MORPH_VERSION_MAJOR 0
 
/// @brief morph's minor version component (semantic-versioning MINOR:
/// incremented for additive, source-compatible changes).
#define MORPH_VERSION_MINOR 1
 
/// @brief morph's patch version component (semantic-versioning PATCH: bug
/// fixes and doc corrections that change neither the stable surface nor its
/// documented behavior).
#define MORPH_VERSION_PATCH 0
 
/// @brief Packs (major, minor, patch) into one comparable integer
/// (`major * 10000 + minor * 100 + patch`), for `#if`-testable feature
/// checks against a specific morph release, e.g.
/// `#if MORPH_VERSION >= MORPH_MAKE_VERSION(1, 2, 0)`.
/// @param major Major version component.
/// @param minor Minor version component.
/// @param patch Patch version component.
#define MORPH_MAKE_VERSION(major, minor, patch) ((major) * 10000 + (minor) * 100 + (patch))
 
/// @brief morph's current release, packed via `MORPH_MAKE_VERSION`. Mirrors
/// the `VERSION` field of the top-level `project(morph VERSION ...)` in
/// `CMakeLists.txt` — the two are cross-checked by `tests/test_version.cpp`.
#define MORPH_VERSION MORPH_MAKE_VERSION(MORPH_VERSION_MAJOR, MORPH_VERSION_MINOR, MORPH_VERSION_PATCH)
 
// NOLINTEND(cppcoreguidelines-macro-to-enum, modernize-macro-to-enum, cppcoreguidelines-macro-usage)
 
namespace morph::version {
 
/// @brief morph's major version component, as a compile-time constant. See `MORPH_VERSION_MAJOR`.
inline constexpr int kMajor = MORPH_VERSION_MAJOR;
 
/// @brief morph's minor version component, as a compile-time constant. See `MORPH_VERSION_MINOR`.
inline constexpr int kMinor = MORPH_VERSION_MINOR;
 
/// @brief morph's patch version component, as a compile-time constant. See `MORPH_VERSION_PATCH`.
inline constexpr int kPatch = MORPH_VERSION_PATCH;
 
/// @brief morph's current release as a dotted string, e.g. `"0.1.0"`.
inline constexpr std::string_view kString = "0.1.0";
 
}  // namespace morph::version