EIC code displayed by LXR master/​include/​corecel/​sys/​Version.hh	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2026-11-04 09:58:33

 //------------------------------- -*- C++ -*- -------------------------------//
 // Copyright Celeritas contributors: see top-level COPYRIGHT file for details
 // SPDX-License-Identifier: (Apache-2.0 OR MIT)
 //---------------------------------------------------------------------------//
 //! \file corecel/sys/Version.hh
 //---------------------------------------------------------------------------//
 #pragma once
 
 #include <array>
 #include <cstdlib>  // IWYU pragma: keep
 #include <iosfwd>
 #include <string_view>
 
 // Undefine macros from <sys/sysmacros.h> if included; possibly included
 // through <sys/types.h> for historical reasons
 #ifdef major
 #    undef major
 #endif
 #ifdef minor
 #    undef minor
 #endif
 
 namespace celeritas
 {
 //---------------------------------------------------------------------------//
 /*!
  * Simple version comparison.
  *
  * This is intended to be constructed with version numbers from \c
  * celeritas_cmake_strings.hh and used in unit tests. It can be used in `if
  * constexpr` expressions with preprocessor macros. In the constructor
  * documentation, x/y/z correspond to major/minor/patch.
  *
  * Versions evaluate to \c false with the default constructor or when
  * constructed from a Celeritas package that is disabled.
  *
  * \par Constructors
  *
  * With Geant4 enabled, these should all produce the same Version object:
  * \code
  * Version::from_package("Geant4"); // [1]
  * Version::from_hex_xxyyzz(CELERITAS_GEANT4_VERSION); // [1, 2]
  * Version::from_dec_xyz(G4VERSION_NUMBER); // [2, 3]
  * \endcode
  *
  * but note that:
  * - [1] uses the built-in Celeritas CMake configuration (requires including
  *   \c corecel/Config.hh)
  * - [2] is constexpr
  * - [3] uses an external header file (must link against a Geant4 cmake target
  *   to access the include directories)
  *
  * \par Example
  *
  * \code
  * assert(Version(4) == Version(4.0) == Version(4.0.0));
  * assert(Version(3.1) > Version(3));
  * \endcode
  */
 class Version
 {
   public:
     //!@{
     //! \name Type aliases
     using size_type = unsigned int;
     using ArrayT = std::array<size_type, 3>;
     //!@}
 
   public:
     // Construct from a string "1.2.3"
     static Version from_string(std::string_view sv);
 
     // Construct from a Celeritas-configured package name "vecgeom"/"VecGeom"
     // False/zero if undefined, throw if unknown package
     static Version from_package(std::string_view p);
 
     // Construct from an 0xXXYYZZ integer
     static inline constexpr Version from_hex_xxyyzz(size_type value);
 
     // Construct from an 0xXXYZ integer
     static inline constexpr Version from_dec_xyz(size_type value);
 
     // Construct from x.y.z integers
     inline constexpr Version(
         size_type major, size_type minor = 0, size_type patch = 0);
 
     //! Default (false) version
     constexpr Version() : version_{0, 0, 0} {}
 
     //!@{
     //! \name Accessors
 
     //! Get version as an array
     constexpr ArrayT const& value() const { return version_; }
 
     //! Get major version
     constexpr size_type major() const { return version_[0]; }
 
     //! Get minor version
     constexpr size_type minor() const { return version_[1]; }
 
     //! Get patch version
     constexpr size_type patch() const { return version_[2]; }
 
     //! Whether the version is defined
     constexpr explicit operator bool() const
     {
         return version_[0] || version_[1] || version_[2];
     }
     //!@}
 
     //// INLINE FRIENDS ////
 
 #define CELER_DEFINE_VERSION_CMP(TOKEN) \
     inline friend bool operator TOKEN(Version const& lhs, Version const& rhs) \
     { \
         return lhs.value() TOKEN rhs.value(); \
     }
 
     CELER_DEFINE_VERSION_CMP(==)
     CELER_DEFINE_VERSION_CMP(!=)
     CELER_DEFINE_VERSION_CMP(<)
     CELER_DEFINE_VERSION_CMP(>)
     CELER_DEFINE_VERSION_CMP(<=)
     CELER_DEFINE_VERSION_CMP(>=)
 
 #undef CELER_DEFINE_VERSION_CMP
 
     // Write to stream
     friend std::ostream& operator<<(std::ostream&, Version const&);
 
   private:
     ArrayT version_;
 };
 
 //---------------------------------------------------------------------------//
 // INLINE DEFINITIONS
 //---------------------------------------------------------------------------//
 /*!
  * Construct from an 0xXXYYZZ integer.
  *
  * This version scheme is used by Celeritas. (The leading 0x prevents
  * version `01` from turning the expression into an octal.)
  */
 constexpr Version Version::from_hex_xxyyzz(size_type value)
 {
     return {(value >> 16 & 0xffu), (value >> 8 & 0xffu), (value & 0xffu)};
 }
 
 //---------------------------------------------------------------------------//
 /*!
  * Construct from a decimal with XYZ or XXYZ.
  *
  * This version scheme is used by Geant4.
  */
 constexpr Version Version::from_dec_xyz(size_type value)
 {
     return {(value / 100), (value / 10) % 10, value % 10};
 }
 
 //---------------------------------------------------------------------------//
 /*!
  * Construct from x.y.z integers.
  */
 constexpr Version::Version(size_type major, size_type minor, size_type patch)
     : version_{{major, minor, patch}}
 {
 }
 
 // Get the Celeritas version as an object
 Version celer_version();
 
 //---------------------------------------------------------------------------//
 }  // namespace celeritas

This page was automatically generated by the 2.3.7 LXR engine. The LXR team