VersionNumber.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Deutsches Elektronen-Synchrotron DESY, MSK, ChimeraTK Project <chimeratk-support@desy.de>
// SPDX-License-Identifier: LGPL-3.0-or-later
#pragma once
 
#include <atomic>
#include <chrono>
#include <cstdint>
#include <format>
#include <string>
 
namespace ChimeraTK {
 
  /********************************************************************************************************************/
 
  class VersionNumber {
   public:
    VersionNumber() : _value(nextVersionNumber()), _time(std::chrono::system_clock::now()) {}
 
    VersionNumber(const VersionNumber& other) = default;
 
    VersionNumber& operator=(const VersionNumber& other) = default;
 
    explicit VersionNumber(std::chrono::system_clock::time_point timestamp);
 
    explicit VersionNumber(std::nullptr_t) : _value(0) {}
 
    [[nodiscard]] std::chrono::time_point<std::chrono::system_clock> getTime() const { return _time; }
 
    bool operator==(const VersionNumber& other) const { return _value == other._value; }
    bool operator!=(const VersionNumber& other) const { return _value != other._value; }
    bool operator>(const VersionNumber& other) const { return _value > other._value; }
    bool operator<(const VersionNumber& other) const { return _value < other._value; }
    bool operator>=(const VersionNumber& other) const { return _value >= other._value; }
    bool operator<=(const VersionNumber& other) const { return _value <= other._value; }
 
    explicit operator std::string() const;
 
   private:
    std::uint64_t _value;
 
    std::chrono::time_point<std::chrono::system_clock> _time;
 
    static uint64_t nextVersionNumber() { return ++_lastGeneratedVersionNumber; }
 
    static std::atomic<uint64_t> _lastGeneratedVersionNumber;
 
    friend std::ostream& operator<<(std::ostream& stream, const VersionNumber& version);
 
    template<class T, class CharT>
    friend struct std::formatter;
  };
 
  /********************************************************************************************************************/
 
  inline VersionNumber::VersionNumber(std::chrono::system_clock::time_point timestamp)
  : _value(nextVersionNumber()), _time(timestamp) {}
 
  /********************************************************************************************************************/
  /********************************************************************************************************************/
 
  std::ostream& operator<<(std::ostream& stream, const VersionNumber& version);
 
  /********************************************************************************************************************/
 
} // namespace ChimeraTK
 
/**********************************************************************************************************************/
 
template<class CharT>
struct std::formatter<ChimeraTK::VersionNumber, CharT> {
  bool printVersion{false};
  bool printTime{false};
 
  template<class ParseContext>
  constexpr ParseContext::iterator parse(ParseContext& ctx) {
    auto it = ctx.begin();
    if(it == ctx.end()) {
      return it;
    }
    if(*it == 'v') {
      printVersion = true;
      ++it;
    }
    if(*it == 't') {
      printTime = true;
      ++it;
    }
    if(it != ctx.end() && *it != '}') {
      throw std::format_error("Invalid format args for ChimeraTK::VersionNumber.");
    }
    if(!printVersion && !printTime) {
      // print version by default
      printVersion = true;
    }
    return it;
  }
 
  template<typename FormatContext>
  auto format(const ChimeraTK::VersionNumber& v, FormatContext& ctx) const {
    std::string fmt;
    if(printVersion) {
      fmt = "v{0}";
    }
    if(printTime) {
      fmt += "@{1}";
    }
    return std::vformat_to(ctx.out(), fmt, std::make_format_args(v._value, v._time));
  }
};
 
/**********************************************************************************************************************/