include/corecel/Version.hh

0001 //------------------------------- -*- C++ -*- -------------------------------//
0002 // Copyright Celeritas contributors: see top-level COPYRIGHT file for details
0003 // SPDX-License-Identifier: (Apache-2.0 OR MIT)
0004 //---------------------------------------------------------------------------//
0005 /*!
0006  * \file corecel/Version.hh
0007  * \brief Celeritas version macro and declaration.
0008  *
0009  * This file should be the primary means of interrogating Celeritas
0010  * capabilities/APIs from downstream software.
0011  */
0012 //---------------------------------------------------------------------------//
0013 #pragma once
0014
0015 /*!
0016 * Celeritas version as a compile-time constant.
0017 *
0018 * Encoded as a big-endian hexadecimal with one byte per component:
0019 * (major * 256 + minor) * 256 + patch.
0020 */
0021 #define CELERITAS_VERSION 0x000600
0022
0023 namespace celeritas
0024 {
0025 //---------------------------------------------------------------------------//
0026
0027 //! Celeritas version string with git metadata
0028 extern char const version_string[];
0029 //! Celeritas major version
0030 extern unsigned int const version_major;
0031 //! Celeritas minor version
0032 extern unsigned int const version_minor;
0033 //! Celeritas patch version
0034 extern unsigned int const version_patch;
0035
0036 //---------------------------------------------------------------------------//
0037 }  // namespace celeritas