mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
f042ba8284
When printing the public `.swiftinterface` for a `-library-level=api` module, skip emitting `@available`, `@backDeployed`, and `@_originallyDefinedIn` attributes that reference "SPI" platforms. Resolves rdar://133990140.
287 lines
10 KiB
C++
287 lines
10 KiB
C++
//===--- PlatformKind.cpp - Swift Language Platform Kinds -----------------===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
|
|
// Licensed under Apache License v2.0 with Runtime Library Exception
|
|
//
|
|
// See https://swift.org/LICENSE.txt for license information
|
|
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file implements the platform kinds for API availability.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "swift/AST/PlatformKind.h"
|
|
#include "swift/Basic/Assertions.h"
|
|
#include "swift/Basic/LangOptions.h"
|
|
#include "swift/Basic/Platform.h"
|
|
#include "llvm/ADT/StringSwitch.h"
|
|
#include "llvm/Support/ErrorHandling.h"
|
|
|
|
|
|
using namespace swift;
|
|
|
|
StringRef swift::platformString(PlatformKind platform) {
|
|
switch (platform) {
|
|
case PlatformKind::none:
|
|
return "*";
|
|
#define AVAILABILITY_PLATFORM(X, PrettyName) \
|
|
case PlatformKind::X: \
|
|
return #X;
|
|
#include "swift/AST/PlatformKinds.def"
|
|
}
|
|
llvm_unreachable("bad PlatformKind");
|
|
}
|
|
|
|
StringRef swift::prettyPlatformString(PlatformKind platform) {
|
|
switch (platform) {
|
|
case PlatformKind::none:
|
|
return "*";
|
|
#define AVAILABILITY_PLATFORM(X, PrettyName) \
|
|
case PlatformKind::X: \
|
|
return PrettyName;
|
|
#include "swift/AST/PlatformKinds.def"
|
|
}
|
|
llvm_unreachable("bad PlatformKind");
|
|
}
|
|
|
|
std::optional<PlatformKind> swift::platformFromString(StringRef Name) {
|
|
if (Name == "*")
|
|
return PlatformKind::none;
|
|
return llvm::StringSwitch<std::optional<PlatformKind>>(Name)
|
|
#define AVAILABILITY_PLATFORM(X, PrettyName) .Case(#X, PlatformKind::X)
|
|
#include "swift/AST/PlatformKinds.def"
|
|
.Case("OSX", PlatformKind::macOS)
|
|
.Case("OSXApplicationExtension", PlatformKind::macOSApplicationExtension)
|
|
.Default(std::optional<PlatformKind>());
|
|
}
|
|
|
|
std::optional<PlatformKind> swift::platformFromUnsigned(unsigned value) {
|
|
PlatformKind platform = PlatformKind(value);
|
|
switch (platform) {
|
|
case PlatformKind::none:
|
|
#define AVAILABILITY_PLATFORM(X, PrettyName) case PlatformKind::X:
|
|
#include "swift/AST/PlatformKinds.def"
|
|
return platform;
|
|
}
|
|
return std::nullopt;
|
|
}
|
|
|
|
std::optional<StringRef>
|
|
swift::closestCorrectedPlatformString(StringRef candidate) {
|
|
auto lowerCasedCandidate = candidate.lower();
|
|
auto lowerCasedCandidateRef = StringRef(lowerCasedCandidate);
|
|
auto minDistance = std::numeric_limits<unsigned int>::max();
|
|
std::optional<StringRef> result = std::nullopt;
|
|
#define AVAILABILITY_PLATFORM(X, PrettyName) \
|
|
{ \
|
|
auto platform = StringRef(#X); \
|
|
auto distance = lowerCasedCandidateRef.edit_distance(platform.lower()); \
|
|
if (distance == 0) { \
|
|
return platform; \
|
|
} \
|
|
if (distance < minDistance) { \
|
|
minDistance = distance; \
|
|
result = platform; \
|
|
} \
|
|
}
|
|
#include "swift/AST/PlatformKinds.def"
|
|
// If the most similar platform distance is greater than this threshold,
|
|
// it's not similar enough to be suggested as correction.
|
|
const unsigned int distanceThreshold = 5;
|
|
return (minDistance < distanceThreshold) ? result : std::nullopt;
|
|
}
|
|
|
|
std::optional<PlatformKind>
|
|
swift::basePlatformForExtensionPlatform(PlatformKind Platform) {
|
|
switch (Platform) {
|
|
case PlatformKind::macOSApplicationExtension:
|
|
return PlatformKind::macOS;
|
|
case PlatformKind::iOSApplicationExtension:
|
|
return PlatformKind::iOS;
|
|
case PlatformKind::macCatalystApplicationExtension:
|
|
return PlatformKind::macCatalyst;
|
|
case PlatformKind::tvOSApplicationExtension:
|
|
return PlatformKind::tvOS;
|
|
case PlatformKind::watchOSApplicationExtension:
|
|
return PlatformKind::watchOS;
|
|
case PlatformKind::visionOSApplicationExtension:
|
|
return PlatformKind::visionOS;
|
|
case PlatformKind::macOS:
|
|
case PlatformKind::iOS:
|
|
case PlatformKind::macCatalyst:
|
|
case PlatformKind::tvOS:
|
|
case PlatformKind::watchOS:
|
|
case PlatformKind::visionOS:
|
|
case PlatformKind::OpenBSD:
|
|
case PlatformKind::Windows:
|
|
case PlatformKind::none:
|
|
return std::nullopt;
|
|
}
|
|
llvm_unreachable("bad PlatformKind");
|
|
}
|
|
|
|
static bool isPlatformActiveForTarget(PlatformKind Platform,
|
|
const llvm::Triple &Target,
|
|
bool EnableAppExtensionRestrictions,
|
|
bool ForRuntimeQuery) {
|
|
if (Platform == PlatformKind::none)
|
|
return true;
|
|
|
|
if (!EnableAppExtensionRestrictions &&
|
|
isApplicationExtensionPlatform(Platform))
|
|
return false;
|
|
|
|
// FIXME: This is an awful way to get the current OS.
|
|
switch (Platform) {
|
|
case PlatformKind::macOS:
|
|
case PlatformKind::macOSApplicationExtension:
|
|
return Target.isMacOSX();
|
|
case PlatformKind::iOS:
|
|
case PlatformKind::iOSApplicationExtension:
|
|
if (!ForRuntimeQuery && Target.isXROS()) {
|
|
return true;
|
|
}
|
|
return Target.isiOS() && !Target.isTvOS();
|
|
case PlatformKind::macCatalyst:
|
|
case PlatformKind::macCatalystApplicationExtension:
|
|
return tripleIsMacCatalystEnvironment(Target);
|
|
case PlatformKind::tvOS:
|
|
case PlatformKind::tvOSApplicationExtension:
|
|
return Target.isTvOS();
|
|
case PlatformKind::watchOS:
|
|
case PlatformKind::watchOSApplicationExtension:
|
|
return Target.isWatchOS();
|
|
case PlatformKind::visionOS:
|
|
case PlatformKind::visionOSApplicationExtension:
|
|
return Target.isXROS();
|
|
case PlatformKind::OpenBSD:
|
|
return Target.isOSOpenBSD();
|
|
case PlatformKind::Windows:
|
|
return Target.isOSWindows();
|
|
case PlatformKind::none:
|
|
llvm_unreachable("handled above");
|
|
}
|
|
llvm_unreachable("bad PlatformKind");
|
|
}
|
|
|
|
bool swift::isPlatformActive(PlatformKind Platform, const LangOptions &LangOpts,
|
|
bool ForTargetVariant, bool ForRuntimeQuery) {
|
|
if (ForTargetVariant) {
|
|
assert(LangOpts.TargetVariant && "Must have target variant triple");
|
|
return isPlatformActiveForTarget(Platform, *LangOpts.TargetVariant,
|
|
LangOpts.EnableAppExtensionRestrictions,
|
|
ForRuntimeQuery);
|
|
}
|
|
|
|
return isPlatformActiveForTarget(Platform, LangOpts.Target,
|
|
LangOpts.EnableAppExtensionRestrictions, ForRuntimeQuery);
|
|
}
|
|
|
|
PlatformKind swift::targetPlatform(const LangOptions &LangOpts) {
|
|
if (LangOpts.Target.isMacOSX()) {
|
|
return (LangOpts.EnableAppExtensionRestrictions
|
|
? PlatformKind::macOSApplicationExtension
|
|
: PlatformKind::macOS);
|
|
}
|
|
|
|
if (LangOpts.Target.isTvOS()) {
|
|
return (LangOpts.EnableAppExtensionRestrictions
|
|
? PlatformKind::tvOSApplicationExtension
|
|
: PlatformKind::tvOS);
|
|
}
|
|
|
|
if (LangOpts.Target.isWatchOS()) {
|
|
return (LangOpts.EnableAppExtensionRestrictions
|
|
? PlatformKind::watchOSApplicationExtension
|
|
: PlatformKind::watchOS);
|
|
}
|
|
|
|
if (LangOpts.Target.isiOS()) {
|
|
if (tripleIsMacCatalystEnvironment(LangOpts.Target))
|
|
return (LangOpts.EnableAppExtensionRestrictions
|
|
? PlatformKind::macCatalystApplicationExtension
|
|
: PlatformKind::macCatalyst);
|
|
return (LangOpts.EnableAppExtensionRestrictions
|
|
? PlatformKind::iOSApplicationExtension
|
|
: PlatformKind::iOS);
|
|
}
|
|
|
|
if (LangOpts.Target.isXROS()) {
|
|
return (LangOpts.EnableAppExtensionRestrictions
|
|
? PlatformKind::visionOSApplicationExtension
|
|
: PlatformKind::visionOS);
|
|
}
|
|
|
|
return PlatformKind::none;
|
|
}
|
|
|
|
bool swift::inheritsAvailabilityFromPlatform(PlatformKind Child,
|
|
PlatformKind Parent) {
|
|
if (auto ChildPlatformBase = basePlatformForExtensionPlatform(Child)) {
|
|
if (Parent == ChildPlatformBase)
|
|
return true;
|
|
}
|
|
|
|
if (Child == PlatformKind::macCatalyst && Parent == PlatformKind::iOS)
|
|
return true;
|
|
|
|
if (Child == PlatformKind::macCatalystApplicationExtension) {
|
|
if (Parent == PlatformKind::iOS ||
|
|
Parent == PlatformKind::iOSApplicationExtension) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
if (Child == PlatformKind::visionOS && Parent == PlatformKind::iOS)
|
|
return true;
|
|
|
|
if (Child == PlatformKind::visionOSApplicationExtension) {
|
|
if (Parent == PlatformKind::iOS ||
|
|
Parent == PlatformKind::iOSApplicationExtension) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
llvm::VersionTuple swift::canonicalizePlatformVersion(
|
|
PlatformKind platform, const llvm::VersionTuple &version) {
|
|
|
|
// Canonicalize macOS version for macOS Big Sur to treat
|
|
// 10.16 as 11.0.
|
|
if (platform == PlatformKind::macOS ||
|
|
platform == PlatformKind::macOSApplicationExtension) {
|
|
return llvm::Triple::getCanonicalVersionForOS(llvm::Triple::MacOSX,
|
|
version);
|
|
}
|
|
|
|
return version;
|
|
}
|
|
|
|
bool swift::isPlatformSPI(PlatformKind Platform) {
|
|
switch (Platform) {
|
|
case PlatformKind::macOS:
|
|
case PlatformKind::macOSApplicationExtension:
|
|
case PlatformKind::iOS:
|
|
case PlatformKind::iOSApplicationExtension:
|
|
case PlatformKind::macCatalyst:
|
|
case PlatformKind::macCatalystApplicationExtension:
|
|
case PlatformKind::tvOS:
|
|
case PlatformKind::tvOSApplicationExtension:
|
|
case PlatformKind::watchOS:
|
|
case PlatformKind::watchOSApplicationExtension:
|
|
case PlatformKind::visionOS:
|
|
case PlatformKind::visionOSApplicationExtension:
|
|
case PlatformKind::OpenBSD:
|
|
case PlatformKind::Windows:
|
|
case PlatformKind::none:
|
|
return false;
|
|
}
|
|
llvm_unreachable("bad PlatformKind");
|
|
}
|