10a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor//===- VersionTuple.h - Version Number Handling -----------------*- C++ -*-===// 20a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor// 30a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor// The LLVM Compiler Infrastructure 40a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor// 50a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor// This file is distributed under the University of Illinois Open Source 60a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor// License. See LICENSE.TXT for details. 70a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor// 80a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor//===----------------------------------------------------------------------===// 92f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// 102f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// \file 112f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// \brief Defines the clang::VersionTuple class, which represents a version in 122f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// the form major[.minor[.subminor]]. 132f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// 140a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor//===----------------------------------------------------------------------===// 150a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor#ifndef LLVM_CLANG_BASIC_VERSIONTUPLE_H 160a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor#define LLVM_CLANG_BASIC_VERSIONTUPLE_H 170a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 188cc488fefb2fb04bc8d5398da29f0182f97934cfChris Lattner#include "clang/Basic/LLVM.h" 190a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor#include "llvm/ADT/Optional.h" 200a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor#include <string> 21651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines#include <tuple> 220a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 230a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregornamespace clang { 240a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 250a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor/// \brief Represents a version number in the form major[.minor[.subminor]]. 260a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregorclass VersionTuple { 270a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor unsigned Major; 280a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor unsigned Minor : 31; 290a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor unsigned Subminor : 31; 300a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor unsigned HasMinor : 1; 310a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor unsigned HasSubminor : 1; 320a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 330a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregorpublic: 340a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor VersionTuple() 350a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor : Major(0), Minor(0), Subminor(0), HasMinor(false), HasSubminor(false) { } 360a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 370a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor explicit VersionTuple(unsigned Major) 380a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor : Major(Major), Minor(0), Subminor(0), HasMinor(false), HasSubminor(false) 390a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor { } 400a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 410a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor explicit VersionTuple(unsigned Major, unsigned Minor) 420a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor : Major(Major), Minor(Minor), Subminor(0), HasMinor(true), 430a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor HasSubminor(false) 440a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor { } 450a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 460a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor explicit VersionTuple(unsigned Major, unsigned Minor, unsigned Subminor) 470a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor : Major(Major), Minor(Minor), Subminor(Subminor), HasMinor(true), 480a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor HasSubminor(true) 490a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor { } 500a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 510a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// \brief Determine whether this version information is empty 520a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// (e.g., all version components are zero). 530a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor bool empty() const { return Major == 0 && Minor == 0 && Subminor == 0; } 540a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 550a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// \brief Retrieve the major version number. 560a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor unsigned getMajor() const { return Major; } 570a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 580a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// \brief Retrieve the minor version number, if provided. 59dc84cd5efdd3430efb22546b4ac656aa0540b210David Blaikie Optional<unsigned> getMinor() const { 600a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor if (!HasMinor) 6166874fb18afbffb8b2ca05576851a64534be3352David Blaikie return None; 620a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor return Minor; 630a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor } 640a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 650a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// \brief Retrieve the subminor version number, if provided. 66dc84cd5efdd3430efb22546b4ac656aa0540b210David Blaikie Optional<unsigned> getSubminor() const { 670a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor if (!HasSubminor) 6866874fb18afbffb8b2ca05576851a64534be3352David Blaikie return None; 690a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor return Subminor; 700a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor } 710a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 720a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// \brief Determine if two version numbers are equivalent. If not 730a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// provided, minor and subminor version numbers are considered to be zero. 740a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor friend bool operator==(const VersionTuple& X, const VersionTuple &Y) { 750a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor return X.Major == Y.Major && X.Minor == Y.Minor && X.Subminor == Y.Subminor; 760a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor } 770a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 78af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Determine if two version numbers are not equivalent. 79af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 80af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// If not provided, minor and subminor version numbers are considered to be 810a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// zero. 820a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor friend bool operator!=(const VersionTuple &X, const VersionTuple &Y) { 830a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor return !(X == Y); 840a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor } 850a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 86af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Determine whether one version number precedes another. 87af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 88af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// If not provided, minor and subminor version numbers are considered to be 89af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// zero. 900a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor friend bool operator<(const VersionTuple &X, const VersionTuple &Y) { 91651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines return std::tie(X.Major, X.Minor, X.Subminor) < 92651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines std::tie(Y.Major, Y.Minor, Y.Subminor); 930a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor } 940a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 95af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Determine whether one version number follows another. 96af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 97af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// If not provided, minor and subminor version numbers are considered to be 98af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// zero. 990a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor friend bool operator>(const VersionTuple &X, const VersionTuple &Y) { 1000a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor return Y < X; 1010a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor } 1020a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 1030a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// \brief Determine whether one version number precedes or is 104af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// equivalent to another. 105af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 106af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// If not provided, minor and subminor version numbers are considered to be 107af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// zero. 1080a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor friend bool operator<=(const VersionTuple &X, const VersionTuple &Y) { 1090a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor return !(Y < X); 1100a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor } 1110a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 1120a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// \brief Determine whether one version number follows or is 113af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// equivalent to another. 114af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 115af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// If not provided, minor and subminor version numbers are considered to be 116af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// zero. 1170a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor friend bool operator>=(const VersionTuple &X, const VersionTuple &Y) { 1180a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor return !(X < Y); 1190a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor } 1200a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 121af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Retrieve a string representation of the version number. 1220a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor std::string getAsString() const; 123260611a32535c851237926bfcf78869b13c07d5bJohn McCall 124260611a32535c851237926bfcf78869b13c07d5bJohn McCall /// \brief Try to parse the given string as a version number. 125af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \returns \c true if the string does not match the regular expression 126260611a32535c851237926bfcf78869b13c07d5bJohn McCall /// [0-9]+(\.[0-9]+(\.[0-9]+)) 127260611a32535c851237926bfcf78869b13c07d5bJohn McCall bool tryParse(StringRef string); 1280a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor}; 1290a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 1300a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor/// \brief Print a version number. 1318cc488fefb2fb04bc8d5398da29f0182f97934cfChris Lattnerraw_ostream& operator<<(raw_ostream &Out, const VersionTuple &V); 1320a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 1330a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor} // end namespace clang 1340a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor#endif // LLVM_CLANG_BASIC_VERSIONTUPLE_H 135