clang 17.0.0git
Distro.h
Go to the documentation of this file.
1//===--- Distro.h - Linux distribution detection support --------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef LLVM_CLANG_DRIVER_DISTRO_H
10#define LLVM_CLANG_DRIVER_DISTRO_H
11
12#include "llvm/Support/VirtualFileSystem.h"
13#include "llvm/TargetParser/Triple.h"
14
15namespace clang {
16namespace driver {
17
18/// Distro - Helper class for detecting and classifying Linux distributions.
19///
20/// This class encapsulates the clang Linux distribution detection mechanism
21/// as well as helper functions that match the specific (versioned) results
22/// into wider distribution classes.
23class Distro {
24public:
26 // Special value means that no detection was performed yet.
28 // NB: Releases of a particular Linux distro should be kept together
29 // in this enum, because some tests are done by integer comparison against
30 // the first and last known member in the family, e.g. IsRedHat().
81 };
82
83private:
84 /// The distribution, possibly with specific version.
85 DistroType DistroVal;
86
87public:
88 /// @name Constructors
89 /// @{
90
91 /// Default constructor leaves the distribution unknown.
92 Distro() : DistroVal() {}
93
94 /// Constructs a Distro type for specific distribution.
95 Distro(DistroType D) : DistroVal(D) {}
96
97 /// Detects the distribution using specified VFS.
98 explicit Distro(llvm::vfs::FileSystem &VFS, const llvm::Triple &TargetOrHost);
99
100 bool operator==(const Distro &Other) const {
101 return DistroVal == Other.DistroVal;
102 }
103
104 bool operator!=(const Distro &Other) const {
105 return DistroVal != Other.DistroVal;
106 }
107
108 bool operator>=(const Distro &Other) const {
109 return DistroVal >= Other.DistroVal;
110 }
111
112 bool operator<=(const Distro &Other) const {
113 return DistroVal <= Other.DistroVal;
114 }
115
116 /// @}
117 /// @name Convenience Predicates
118 /// @{
119
120 bool IsRedhat() const {
121 return DistroVal == Fedora || (DistroVal >= RHEL5 && DistroVal <= RHEL7);
122 }
123
124 bool IsOpenSUSE() const { return DistroVal == OpenSUSE; }
125
126 bool IsDebian() const {
127 return DistroVal >= DebianLenny && DistroVal <= DebianTrixie;
128 }
129
130 bool IsUbuntu() const {
131 return DistroVal >= UbuntuHardy && DistroVal <= UbuntuLunar;
132 }
133
134 bool IsAlpineLinux() const { return DistroVal == AlpineLinux; }
135
136 bool IsGentoo() const { return DistroVal == Gentoo; }
137
138 /// @}
139};
140
141} // end namespace driver
142} // end namespace clang
143
144#endif
Distro - Helper class for detecting and classifying Linux distributions.
Definition: Distro.h:23
bool IsDebian() const
Definition: Distro.h:126
Distro()
Default constructor leaves the distribution unknown.
Definition: Distro.h:92
bool IsOpenSUSE() const
Definition: Distro.h:124
bool IsGentoo() const
Definition: Distro.h:136
Distro(DistroType D)
Constructs a Distro type for specific distribution.
Definition: Distro.h:95
bool operator!=(const Distro &Other) const
Definition: Distro.h:104
bool operator==(const Distro &Other) const
Definition: Distro.h:100
bool IsAlpineLinux() const
Definition: Distro.h:134
bool IsRedhat() const
Definition: Distro.h:120
bool operator<=(const Distro &Other) const
Definition: Distro.h:112
bool operator>=(const Distro &Other) const
Definition: Distro.h:108
bool IsUbuntu() const
Definition: Distro.h:130