LLVM 20.0.0git
Public Member Functions | Friends | List of all members
llvm::VersionTuple Class Reference

Represents a version number in the form major[.minor[.subminor[.build]]]. More...

#include "llvm/Support/VersionTuple.h"

Public Member Functions

constexpr VersionTuple ()
 
constexpr VersionTuple (unsigned Major)
 
constexpr VersionTuple (unsigned Major, unsigned Minor)
 
constexpr VersionTuple (unsigned Major, unsigned Minor, unsigned Subminor)
 
constexpr VersionTuple (unsigned Major, unsigned Minor, unsigned Subminor, unsigned Build)
 
bool empty () const
 Determine whether this version information is empty (e.g., all version components are zero).
 
unsigned getMajor () const
 Retrieve the major version number.
 
std::optional< unsignedgetMinor () const
 Retrieve the minor version number, if provided.
 
std::optional< unsignedgetSubminor () const
 Retrieve the subminor version number, if provided.
 
std::optional< unsignedgetBuild () const
 Retrieve the build version number, if provided.
 
VersionTuple withoutBuild () const
 Return a version tuple that contains only the first 3 version components.
 
VersionTuple withMajorReplaced (unsigned NewMajor) const
 Return a version tuple that contains a different major version but everything else is the same.
 
VersionTuple normalize () const
 Return a version tuple that contains only components that are non-zero.
 
std::string getAsString () const
 Retrieve a string representation of the version number.
 
bool tryParse (StringRef string)
 Try to parse the given string as a version number.
 

Friends

bool operator== (const VersionTuple &X, const VersionTuple &Y)
 Determine if two version numbers are equivalent.
 
bool operator!= (const VersionTuple &X, const VersionTuple &Y)
 Determine if two version numbers are not equivalent.
 
bool operator< (const VersionTuple &X, const VersionTuple &Y)
 Determine whether one version number precedes another.
 
bool operator> (const VersionTuple &X, const VersionTuple &Y)
 Determine whether one version number follows another.
 
bool operator<= (const VersionTuple &X, const VersionTuple &Y)
 Determine whether one version number precedes or is equivalent to another.
 
bool operator>= (const VersionTuple &X, const VersionTuple &Y)
 Determine whether one version number follows or is equivalent to another.
 
hash_code hash_value (const VersionTuple &VT)
 
template<typename HasherT , llvm::endianness Endianness>
void addHash (HashBuilder< HasherT, Endianness > &HBuilder, const VersionTuple &VT)
 

Detailed Description

Represents a version number in the form major[.minor[.subminor[.build]]].

Definition at line 29 of file VersionTuple.h.

Constructor & Destructor Documentation

◆ VersionTuple() [1/5]

constexpr llvm::VersionTuple::VersionTuple ( )
inlineconstexpr

Definition at line 42 of file VersionTuple.h.

Referenced by tryParse(), withMajorReplaced(), and withoutBuild().

◆ VersionTuple() [2/5]

constexpr llvm::VersionTuple::VersionTuple ( unsigned  Major)
inlineexplicitconstexpr

Definition at line 46 of file VersionTuple.h.

◆ VersionTuple() [3/5]

constexpr llvm::VersionTuple::VersionTuple ( unsigned  Major,
unsigned  Minor 
)
inlineexplicitconstexpr

Definition at line 50 of file VersionTuple.h.

◆ VersionTuple() [4/5]

constexpr llvm::VersionTuple::VersionTuple ( unsigned  Major,
unsigned  Minor,
unsigned  Subminor 
)
inlineexplicitconstexpr

Definition at line 54 of file VersionTuple.h.

◆ VersionTuple() [5/5]

constexpr llvm::VersionTuple::VersionTuple ( unsigned  Major,
unsigned  Minor,
unsigned  Subminor,
unsigned  Build 
)
inlineexplicitconstexpr

Definition at line 59 of file VersionTuple.h.

Member Function Documentation

◆ empty()

bool llvm::VersionTuple::empty ( ) const
inline

Determine whether this version information is empty (e.g., all version components are zero).

Definition at line 66 of file VersionTuple.h.

Referenced by llvm::SPIRV::RequirementHandler::addRequirements(), EmitSDKVersionSuffix(), getDXILArchNameFromShaderModel(), llvm::MachO::getTargetTripleName(), getWindowsSDKDirViaCommandLine(), and targetVersionOrMinimumSupportedOSVersion().

◆ getAsString()

std::string VersionTuple::getAsString ( ) const

◆ getBuild()

std::optional< unsigned > llvm::VersionTuple::getBuild ( ) const
inline

Retrieve the build version number, if provided.

Definition at line 88 of file VersionTuple.h.

◆ getMajor()

unsigned llvm::VersionTuple::getMajor ( ) const
inline

◆ getMinor()

std::optional< unsigned > llvm::VersionTuple::getMinor ( ) const
inline

◆ getSubminor()

std::optional< unsigned > llvm::VersionTuple::getSubminor ( ) const
inline

Retrieve the subminor version number, if provided.

Definition at line 81 of file VersionTuple.h.

Referenced by EmitSDKVersionSuffix(), and llvm::MachO::PackedVersion::PackedVersion().

◆ normalize()

VersionTuple llvm::VersionTuple::normalize ( ) const
inline

Return a version tuple that contains only components that are non-zero.

Definition at line 108 of file VersionTuple.h.

◆ tryParse()

bool VersionTuple::tryParse ( StringRef  string)

Try to parse the given string as a version number.

Returns
true if the string does not match the regular expression [0-9]+(.[0-9]+){0,3}

Definition at line 63 of file VersionTuple.cpp.

References llvm::StringRef::consume_front(), llvm::StringRef::empty(), parseInt(), llvm::StringRef::substr(), and VersionTuple().

Referenced by getHighestNumericTupleInDirectory(), and getWindowsSDKDirViaCommandLine().

◆ withMajorReplaced()

VersionTuple llvm::VersionTuple::withMajorReplaced ( unsigned  NewMajor) const
inline

Return a version tuple that contains a different major version but everything else is the same.

Definition at line 103 of file VersionTuple.h.

References VersionTuple().

◆ withoutBuild()

VersionTuple llvm::VersionTuple::withoutBuild ( ) const
inline

Return a version tuple that contains only the first 3 version components.

Definition at line 95 of file VersionTuple.h.

References VersionTuple().

Friends And Related Function Documentation

◆ addHash

template<typename HasherT , llvm::endianness Endianness>
void addHash ( HashBuilder< HasherT, Endianness > &  HBuilder,
const VersionTuple VT 
)
friend

Definition at line 176 of file VersionTuple.h.

◆ hash_value

hash_code hash_value ( const VersionTuple VT)
friend

Definition at line 171 of file VersionTuple.h.

◆ operator!=

bool operator!= ( const VersionTuple X,
const VersionTuple Y 
)
friend

Determine if two version numbers are not equivalent.

If not provided, minor and subminor version numbers are considered to be zero.

Definition at line 132 of file VersionTuple.h.

◆ operator<

bool operator< ( const VersionTuple X,
const VersionTuple Y 
)
friend

Determine whether one version number precedes another.

If not provided, minor and subminor version numbers are considered to be zero.

Definition at line 140 of file VersionTuple.h.

◆ operator<=

bool operator<= ( const VersionTuple X,
const VersionTuple Y 
)
friend

Determine whether one version number precedes or is equivalent to another.

If not provided, minor and subminor version numbers are considered to be zero.

Definition at line 158 of file VersionTuple.h.

◆ operator==

bool operator== ( const VersionTuple X,
const VersionTuple Y 
)
friend

Determine if two version numbers are equivalent.

If not provided, minor and subminor version numbers are considered to be zero.

Definition at line 123 of file VersionTuple.h.

◆ operator>

bool operator> ( const VersionTuple X,
const VersionTuple Y 
)
friend

Determine whether one version number follows another.

If not provided, minor and subminor version numbers are considered to be zero.

Definition at line 149 of file VersionTuple.h.

◆ operator>=

bool operator>= ( const VersionTuple X,
const VersionTuple Y 
)
friend

Determine whether one version number follows or is equivalent to another.

If not provided, minor and subminor version numbers are considered to be zero.

Definition at line 167 of file VersionTuple.h.


The documentation for this class was generated from the following files: