VersionTuple.h

Go to the documentation of this file.

//===- VersionTuple.h - Version Number Handling -----------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
///
/// \file
/// Defines the llvm::VersionTuple class, which represents a version in
/// the form major[.minor[.subminor]].
///
//===----------------------------------------------------------------------===//
#ifndef LLVM_SUPPORT_VERSIONTUPLE_H
#define LLVM_SUPPORT_VERSIONTUPLE_H
 
#include "llvm/ADT/DenseMapInfo.h"
#include "llvm/ADT/Hashing.h"
#include "llvm/Support/Compiler.h"
#include <optional>
#include <string>
#include <tuple>
 
namespace llvm {
template <typename HasherT, llvm::endianness Endianness> class HashBuilder;
class raw_ostream;
class StringRef;
 
/// Represents a version number in the form major[.minor[.subminor[.build]]].
class VersionTuple {
  unsigned Major : 32;
 
  unsigned Minor : 31;
  unsigned HasMinor : 1;
 
  unsigned Subminor : 31;
  unsigned HasSubminor : 1;
 
  unsigned Build : 20;
  unsigned Subbuild : 10;
  unsigned HasBuild : 1;
  unsigned HasSubbuild : 1;
 
public:
  constexpr VersionTuple()
      : Major(0), Minor(0), HasMinor(false), Subminor(0), HasSubminor(false),
        Build(0), Subbuild(0), HasBuild(false), HasSubbuild(false) {}
 
  explicit constexpr VersionTuple(unsigned Major)
      : Major(Major), Minor(0), HasMinor(false), Subminor(0),
        HasSubminor(false), Build(0), Subbuild(0), HasBuild(false),
        HasSubbuild(false) {}
 
  explicit constexpr VersionTuple(unsigned Major, unsigned Minor)
      : Major(Major), Minor(Minor), HasMinor(true), Subminor(0),
        HasSubminor(false), Build(0), Subbuild(0), HasBuild(false),
        HasSubbuild(false) {}
 
  explicit constexpr VersionTuple(unsigned Major, unsigned Minor,
                                  unsigned Subminor)
      : Major(Major), Minor(Minor), HasMinor(true), Subminor(Subminor),
        HasSubminor(true), Build(0), Subbuild(0), HasBuild(false),
        HasSubbuild(false) {}
 
  explicit constexpr VersionTuple(unsigned Major, unsigned Minor,
                                  unsigned Subminor, unsigned Build)
      : Major(Major), Minor(Minor), HasMinor(true), Subminor(Subminor),
        HasSubminor(true), Build(Build), Subbuild(0), HasBuild(true),
        HasSubbuild(false) {}
 
  explicit constexpr VersionTuple(unsigned Major, unsigned Minor,
                                  unsigned Subminor, unsigned Build,
                                  unsigned Subbuild)
      : Major(Major), Minor(Minor), HasMinor(true), Subminor(Subminor),
        HasSubminor(true), Build(Build), Subbuild(Subbuild), HasBuild(true),
        HasSubbuild(true) {}
 
  std::tuple<unsigned, unsigned, unsigned, unsigned, unsigned> asTuple() const {
    return {Major, Minor, Subminor, Build, Subbuild};
  }
 
  /// Determine whether this version information is empty
  /// (e.g., all version components are zero).
  bool empty() const { return *this == VersionTuple(); }
 
  /// Retrieve the major version number.
  unsigned getMajor() const { return Major; }
 
  /// Retrieve the minor version number, if provided.
  std::optional<unsigned> getMinor() const {
    if (!HasMinor)
      return std::nullopt;
    return Minor;
  }
 
  /// Retrieve the subminor version number, if provided.
  std::optional<unsigned> getSubminor() const {
    if (!HasSubminor)
      return std::nullopt;
    return Subminor;
  }
 
  /// Retrieve the build version number, if provided.
  std::optional<unsigned> getBuild() const {
    if (!HasBuild)
      return std::nullopt;
    return Build;
  }
 
  /// Retrieve the subbuild version number, if provided.
  std::optional<unsigned> getSubbuild() const {
    if (!HasSubbuild)
      return std::nullopt;
    return Subbuild;
  }
 
  /// Return a version tuple that contains only the first 3 version components.
  VersionTuple withoutBuild() const {
    if (HasBuild)
      return VersionTuple(Major, Minor, Subminor);
    return *this;
  }
 
  /// Return a version tuple that contains a different major version but
  /// everything else is the same.
  LLVM_ABI VersionTuple withMajorReplaced(unsigned NewMajor) const;
 
  /// Return a version tuple that contains only components that are non-zero.
  VersionTuple normalize() const {
    VersionTuple Result = *this;
    if (Result.Subbuild == 0) {
      Result.HasSubbuild = false;
      if (Result.Build == 0) {
        Result.HasBuild = false;
        if (Result.Subminor == 0) {
          Result.HasSubminor = false;
          if (Result.Minor == 0)
            Result.HasMinor = false;
        }
      }
    }
    return Result;
  }
 
  /// Determine if two version numbers are equivalent. If not
  /// provided, minor and subminor version numbers are considered to be zero.
  friend bool operator==(const VersionTuple &X, const VersionTuple &Y) {
    return X.asTuple() == Y.asTuple();
  }
 
  /// Determine if two version numbers are not equivalent.
  ///
  /// If not provided, minor and subminor version numbers are considered to be
  /// zero.
  friend bool operator!=(const VersionTuple &X, const VersionTuple &Y) {
    return !(X == Y);
  }
 
  /// Determine whether one version number precedes another.
  ///
  /// If not provided, minor and subminor version numbers are considered to be
  /// zero.
  friend bool operator<(const VersionTuple &X, const VersionTuple &Y) {
    return X.asTuple() < Y.asTuple();
  }
 
  /// Determine whether one version number follows another.
  ///
  /// If not provided, minor and subminor version numbers are considered to be
  /// zero.
  friend bool operator>(const VersionTuple &X, const VersionTuple &Y) {
    return Y < X;
  }
 
  /// Determine whether one version number precedes or is
  /// equivalent to another.
  ///
  /// If not provided, minor and subminor version numbers are considered to be
  /// zero.
  friend bool operator<=(const VersionTuple &X, const VersionTuple &Y) {
    return !(Y < X);
  }
 
  /// Determine whether one version number follows or is
  /// equivalent to another.
  ///
  /// If not provided, minor and subminor version numbers are considered to be
  /// zero.
  friend bool operator>=(const VersionTuple &X, const VersionTuple &Y) {
    return !(X < Y);
  }
 
  friend hash_code hash_value(const VersionTuple &VT) {
    return hash_combine(VT.Major, VT.Minor, VT.Subminor, VT.Build, VT.Subbuild);
  }
 
  template <typename HasherT, llvm::endianness Endianness>
  friend void addHash(HashBuilder<HasherT, Endianness> &HBuilder,
                      const VersionTuple &VT) {
    HBuilder.add(VT.Major, VT.Minor, VT.Subminor, VT.Build, VT.Subbuild);
  }
 
  /// Retrieve a string representation of the version number.
  LLVM_ABI std::string getAsString() const;
 
  /// Try to parse the given string as a version number.
  /// \returns \c true if the string does not match the regular expression
  ///   [0-9]+(\.[0-9]+){0,3}
  LLVM_ABI bool tryParse(StringRef string);
};
 
/// Print a version number.
LLVM_ABI raw_ostream &operator<<(raw_ostream &Out, const VersionTuple &V);
 
// Provide DenseMapInfo for version tuples.
template <> struct DenseMapInfo<VersionTuple> {
  static inline VersionTuple getEmptyKey() { return VersionTuple(0x7FFFFFFF); }
  static inline VersionTuple getTombstoneKey() {
    return VersionTuple(0x7FFFFFFE);
  }
  static unsigned getHashValue(const VersionTuple &Value) {
    unsigned Result = Value.getMajor();
    if (auto Minor = Value.getMinor())
      Result = detail::combineHashValue(Result, *Minor);
    if (auto Subminor = Value.getSubminor())
      Result = detail::combineHashValue(Result, *Subminor);
    if (auto Build = Value.getBuild())
      Result = detail::combineHashValue(Result, *Build);
    if (auto Subbuild = Value.getSubbuild())
      Result = detail::combineHashValue(Result, *Subbuild);
 
    return Result;
  }
 
  static bool isEqual(const VersionTuple &LHS, const VersionTuple &RHS) {
    return LHS == RHS;
  }
};
 
} // end namespace llvm
#endif // LLVM_SUPPORT_VERSIONTUPLE_H