VersionTuple.h revision 260611a32535c851237926bfcf78869b13c07d5b
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//===----------------------------------------------------------------------===// 90a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor// 100a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor// This header defines the VersionTuple class, which represents a version in 110a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor// the form major[.minor[.subminor]]. 120a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor// 130a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor//===----------------------------------------------------------------------===// 140a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor#ifndef LLVM_CLANG_BASIC_VERSIONTUPLE_H 150a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor#define LLVM_CLANG_BASIC_VERSIONTUPLE_H 160a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 178cc488fefb2fb04bc8d5398da29f0182f97934cfChris Lattner#include "clang/Basic/LLVM.h" 180a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor#include "llvm/ADT/Optional.h" 190a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor#include <string> 200a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 210a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregornamespace clang { 220a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 230a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor/// \brief Represents a version number in the form major[.minor[.subminor]]. 240a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregorclass VersionTuple { 250a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor unsigned Major; 260a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor unsigned Minor : 31; 270a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor unsigned Subminor : 31; 280a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor unsigned HasMinor : 1; 290a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor unsigned HasSubminor : 1; 300a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 310a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregorpublic: 320a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor VersionTuple() 330a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor : Major(0), Minor(0), Subminor(0), HasMinor(false), HasSubminor(false) { } 340a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 350a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor explicit VersionTuple(unsigned Major) 360a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor : Major(Major), Minor(0), Subminor(0), HasMinor(false), HasSubminor(false) 370a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor { } 380a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 390a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor explicit VersionTuple(unsigned Major, unsigned Minor) 400a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor : Major(Major), Minor(Minor), Subminor(0), HasMinor(true), 410a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor HasSubminor(false) 420a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor { } 430a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 440a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor explicit VersionTuple(unsigned Major, unsigned Minor, unsigned Subminor) 450a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor : Major(Major), Minor(Minor), Subminor(Subminor), HasMinor(true), 460a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor HasSubminor(true) 470a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor { } 480a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 490a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// \brief Determine whether this version information is empty 500a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// (e.g., all version components are zero). 510a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor bool empty() const { return Major == 0 && Minor == 0 && Subminor == 0; } 520a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 530a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// \brief Retrieve the major version number. 540a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor unsigned getMajor() const { return Major; } 550a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 560a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// \brief Retrieve the minor version number, if provided. 570a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor llvm::Optional<unsigned> getMinor() const { 580a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor if (!HasMinor) 590a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor return llvm::Optional<unsigned>(); 600a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor return Minor; 610a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor } 620a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 630a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// \brief Retrieve the subminor version number, if provided. 640a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor llvm::Optional<unsigned> getSubminor() const { 650a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor if (!HasSubminor) 660a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor return llvm::Optional<unsigned>(); 670a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor return Subminor; 680a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor } 690a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 700a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// \brief Determine if two version numbers are equivalent. If not 710a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// provided, minor and subminor version numbers are considered to be zero. 720a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor friend bool operator==(const VersionTuple& X, const VersionTuple &Y) { 730a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor return X.Major == Y.Major && X.Minor == Y.Minor && X.Subminor == Y.Subminor; 740a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor } 750a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 760a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// \brief Determine if two version numbers are not equivalent. If 770a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// not provided, minor and subminor version numbers are considered to be 780a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// zero. 790a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor friend bool operator!=(const VersionTuple &X, const VersionTuple &Y) { 800a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor return !(X == Y); 810a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor } 820a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 830a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// \brief Determine whether one version number precedes another. If not 840a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// provided, minor and subminor version numbers are considered to be zero. 850a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor friend bool operator<(const VersionTuple &X, const VersionTuple &Y) { 860a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor if (X.Major != Y.Major) 870a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor return X.Major < Y.Major; 880a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 890a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor if (X.Minor != Y.Minor) 900a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor return X.Minor < Y.Minor; 910a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 920a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor return X.Subminor < Y.Subminor; 930a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor } 940a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 950a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// \brief Determine whether one version number follows another. If not 960a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// provided, minor and subminor version numbers are considered to be zero. 970a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor friend bool operator>(const VersionTuple &X, const VersionTuple &Y) { 980a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor return Y < X; 990a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor } 1000a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 1010a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// \brief Determine whether one version number precedes or is 1020a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// equivalent to another. If not provided, minor and subminor 1030a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// version numbers are considered to be zero. 1040a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor friend bool operator<=(const VersionTuple &X, const VersionTuple &Y) { 1050a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor return !(Y < X); 1060a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor } 1070a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 1080a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// \brief Determine whether one version number follows or is 1090a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// equivalent to another. If not provided, minor and subminor 1100a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// version numbers are considered to be zero. 1110a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor friend bool operator>=(const VersionTuple &X, const VersionTuple &Y) { 1120a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor return !(X < Y); 1130a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor } 1140a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 1150a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor /// \brief Retrieve a string representation of the version number/ 1160a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor std::string getAsString() const; 117260611a32535c851237926bfcf78869b13c07d5bJohn McCall 118260611a32535c851237926bfcf78869b13c07d5bJohn McCall /// \brief Try to parse the given string as a version number. 119260611a32535c851237926bfcf78869b13c07d5bJohn McCall /// Returns true if the string does not match the regular expression 120260611a32535c851237926bfcf78869b13c07d5bJohn McCall /// [0-9]+(\.[0-9]+(\.[0-9]+)) 121260611a32535c851237926bfcf78869b13c07d5bJohn McCall bool tryParse(StringRef string); 1220a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor}; 1230a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 1240a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor/// \brief Print a version number. 1258cc488fefb2fb04bc8d5398da29f0182f97934cfChris Lattnerraw_ostream& operator<<(raw_ostream &Out, const VersionTuple &V); 1260a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor 1270a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor} // end namespace clang 1280a0d2b179085a52c10402feebeb6db8b4d96a140Douglas Gregor#endif // LLVM_CLANG_BASIC_VERSIONTUPLE_H 129