WPILibC++  2020.3.2
VersionTuple.h
Go to the documentation of this file.
1 //===- VersionTuple.h - Version Number Handling -----------------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
14 //===----------------------------------------------------------------------===//
15 #ifndef WPIUTIL_WPI_VERSIONTUPLE_H
16 #define WPIUTIL_WPI_VERSIONTUPLE_H
17 
18 #include "wpi/StringRef.h"
19 #include "wpi/raw_ostream.h"
20 #include <optional>
21 #include <string>
22 #include <tuple>
23 
24 namespace wpi {
25 
27 class VersionTuple {
28  unsigned Major : 32;
29 
30  unsigned Minor : 31;
31  unsigned HasMinor : 1;
32 
33  unsigned Subminor : 31;
34  unsigned HasSubminor : 1;
35 
36  unsigned Build : 31;
37  unsigned HasBuild : 1;
38 
39 public:
40  VersionTuple()
41  : Major(0), Minor(0), HasMinor(false), Subminor(0), HasSubminor(false),
42  Build(0), HasBuild(false) {}
43 
44  explicit VersionTuple(unsigned Major)
45  : Major(Major), Minor(0), HasMinor(false), Subminor(0),
46  HasSubminor(false), Build(0), HasBuild(false) {}
47 
48  explicit VersionTuple(unsigned Major, unsigned Minor)
49  : Major(Major), Minor(Minor), HasMinor(true), Subminor(0),
50  HasSubminor(false), Build(0), HasBuild(false) {}
51 
52  explicit VersionTuple(unsigned Major, unsigned Minor, unsigned Subminor)
53  : Major(Major), Minor(Minor), HasMinor(true), Subminor(Subminor),
54  HasSubminor(true), Build(0), HasBuild(false) {}
55 
56  explicit VersionTuple(unsigned Major, unsigned Minor, unsigned Subminor,
57  unsigned Build)
58  : Major(Major), Minor(Minor), HasMinor(true), Subminor(Subminor),
59  HasSubminor(true), Build(Build), HasBuild(true) {}
60 
63  bool empty() const {
64  return Major == 0 && Minor == 0 && Subminor == 0 && Build == 0;
65  }
66 
68  unsigned getMajor() const { return Major; }
69 
71  std::optional<unsigned> getMinor() const {
72  if (!HasMinor)
73  return std::nullopt;
74  return Minor;
75  }
76 
78  std::optional<unsigned> getSubminor() const {
79  if (!HasSubminor)
80  return std::nullopt;
81  return Subminor;
82  }
83 
85  std::optional<unsigned> getBuild() const {
86  if (!HasBuild)
87  return std::nullopt;
88  return Build;
89  }
90 
93  friend bool operator==(const VersionTuple &X, const VersionTuple &Y) {
94  return X.Major == Y.Major && X.Minor == Y.Minor &&
95  X.Subminor == Y.Subminor && X.Build == Y.Build;
96  }
97 
102  friend bool operator!=(const VersionTuple &X, const VersionTuple &Y) {
103  return !(X == Y);
104  }
105 
110  friend bool operator<(const VersionTuple &X, const VersionTuple &Y) {
111  return std::tie(X.Major, X.Minor, X.Subminor, X.Build) <
112  std::tie(Y.Major, Y.Minor, Y.Subminor, Y.Build);
113  }
114 
119  friend bool operator>(const VersionTuple &X, const VersionTuple &Y) {
120  return Y < X;
121  }
122 
128  friend bool operator<=(const VersionTuple &X, const VersionTuple &Y) {
129  return !(Y < X);
130  }
131 
137  friend bool operator>=(const VersionTuple &X, const VersionTuple &Y) {
138  return !(X < Y);
139  }
140 
142  std::string getAsString() const;
143 
147  bool tryParse(StringRef string);
148 };
149 
151 raw_ostream &operator<<(raw_ostream &Out, const VersionTuple &V);
152 
153 } // end namespace wpi
154 #endif // WPIUTIL_WPI_VERSIONTUPLE_H
wpi::VersionTuple
Represents a version number in the form major[.minor[.subminor[.build]]].
Definition: VersionTuple.h:27
wpi::VersionTuple::getMinor
std::optional< unsigned > getMinor() const
Retrieve the minor version number, if provided.
Definition: VersionTuple.h:71
wpi::VersionTuple::tryParse
bool tryParse(StringRef string)
Try to parse the given string as a version number.
wpi::VersionTuple::operator>
friend bool operator>(const VersionTuple &X, const VersionTuple &Y)
Determine whether one version number follows another.
Definition: VersionTuple.h:119
wpi::VersionTuple::empty
bool empty() const
Determine whether this version information is empty (e.g., all version components are zero).
Definition: VersionTuple.h:63
wpi::VersionTuple::getAsString
std::string getAsString() const
Retrieve a string representation of the version number.
wpi
WPILib C++ utilities (wpiutil) namespace.
Definition: EventLoopRunner.h:17
wpi::operator<<
raw_ostream & operator<<(raw_ostream &Out, const VersionTuple &V)
Print a version number.
wpi::StringRef
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:49
wpi::VersionTuple::getBuild
std::optional< unsigned > getBuild() const
Retrieve the build version number, if provided.
Definition: VersionTuple.h:85
wpi::VersionTuple::operator<=
friend bool operator<=(const VersionTuple &X, const VersionTuple &Y)
Determine whether one version number precedes or is equivalent to another.
Definition: VersionTuple.h:128
wpi::VersionTuple::getMajor
unsigned getMajor() const
Retrieve the major version number.
Definition: VersionTuple.h:68
wpi::VersionTuple::operator==
friend bool operator==(const VersionTuple &X, const VersionTuple &Y)
Determine if two version numbers are equivalent.
Definition: VersionTuple.h:93
wpi::VersionTuple::getSubminor
std::optional< unsigned > getSubminor() const
Retrieve the subminor version number, if provided.
Definition: VersionTuple.h:78
wpi::VersionTuple::operator!=
friend bool operator!=(const VersionTuple &X, const VersionTuple &Y)
Determine if two version numbers are not equivalent.
Definition: VersionTuple.h:102
wpi::VersionTuple::operator<
friend bool operator<(const VersionTuple &X, const VersionTuple &Y)
Determine whether one version number precedes another.
Definition: VersionTuple.h:110
wpi::VersionTuple::operator>=
friend bool operator>=(const VersionTuple &X, const VersionTuple &Y)
Determine whether one version number follows or is equivalent to another.
Definition: VersionTuple.h:137