Skip to content
Permalink
main
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time
//===--- LangOptions.cpp - Language & configuration options ---------------===//
//
// 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 defines the LangOptions class, which provides various
// language and configuration flags.
//
//===----------------------------------------------------------------------===//
#include "swift/Basic/LangOptions.h"
#include "swift/AST/DiagnosticEngine.h"
#include "swift/Basic/Feature.h"
#include "swift/Basic/Platform.h"
#include "swift/Basic/Range.h"
#include "swift/Config.h"
#include "llvm/ADT/Hashing.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/Support/raw_ostream.h"
#include <limits.h>
using namespace swift;
struct SupportedConditionalValue {
StringRef value;
/// If the value has been deprecated, the new value to replace it with.
StringRef replacement = "";
SupportedConditionalValue(const char *value) : value(value) {}
SupportedConditionalValue(const char *value, const char *replacement)
: value(value), replacement(replacement) {}
};
static const SupportedConditionalValue SupportedConditionalCompilationOSs[] = {
"OSX",
"macOS",
"tvOS",
"watchOS",
"iOS",
"Linux",
"FreeBSD",
"OpenBSD",
"Windows",
"Android",
"PS4",
"Cygwin",
"Haiku",
"WASI",
};
static const SupportedConditionalValue SupportedConditionalCompilationArches[] = {
"arm",
"arm64",
"arm64_32",
"i386",
"x86_64",
"powerpc64",
"powerpc64le",
"s390x",
"wasm32",
};
static const SupportedConditionalValue SupportedConditionalCompilationEndianness[] = {
"little",
"big"
};
static const SupportedConditionalValue SupportedConditionalCompilationRuntimes[] = {
"_ObjC",
"_Native",
};
static const SupportedConditionalValue SupportedConditionalCompilationTargetEnvironments[] = {
"simulator",
{ "macabi", "macCatalyst" },
"macCatalyst", // A synonym for "macabi" when compiling for iOS
};
static const SupportedConditionalValue SupportedConditionalCompilationPtrAuthSchemes[] = {
"_none",
"_arm64e",
};
static const PlatformConditionKind AllPublicPlatformConditionKinds[] = {
#define PLATFORM_CONDITION(LABEL, IDENTIFIER) PlatformConditionKind::LABEL,
#define PLATFORM_CONDITION_(LABEL, IDENTIFIER)
#include "swift/AST/PlatformConditionKinds.def"
};
ArrayRef<SupportedConditionalValue> getSupportedConditionalCompilationValues(const PlatformConditionKind &Kind) {
switch (Kind) {
case PlatformConditionKind::OS:
return SupportedConditionalCompilationOSs;
case PlatformConditionKind::Arch:
return SupportedConditionalCompilationArches;
case PlatformConditionKind::Endianness:
return SupportedConditionalCompilationEndianness;
case PlatformConditionKind::Runtime:
return SupportedConditionalCompilationRuntimes;
case PlatformConditionKind::CanImport:
return { };
case PlatformConditionKind::TargetEnvironment:
return SupportedConditionalCompilationTargetEnvironments;
case PlatformConditionKind::PtrAuth:
return SupportedConditionalCompilationPtrAuthSchemes;
}
llvm_unreachable("Unhandled PlatformConditionKind in switch");
}
PlatformConditionKind suggestedPlatformConditionKind(PlatformConditionKind Kind, const StringRef &V,
std::vector<StringRef> &suggestedValues) {
std::string lower = V.lower();
for (const PlatformConditionKind& candidateKind : AllPublicPlatformConditionKinds) {
if (candidateKind != Kind) {
auto supportedValues = getSupportedConditionalCompilationValues(candidateKind);
for (const SupportedConditionalValue& candidateValue : supportedValues) {
if (candidateValue.value.lower() == lower) {
suggestedValues.clear();
if (candidateValue.value != V) {
suggestedValues.emplace_back(candidateValue.value);
}
return candidateKind;
}
}
}
}
return Kind;
}
bool isMatching(PlatformConditionKind Kind, const StringRef &V,
PlatformConditionKind &suggestedKind, std::vector<StringRef> &suggestions) {
// Compare against known values, ignoring case to avoid penalizing
// characters with incorrect case.
unsigned minDistance = std::numeric_limits<unsigned>::max();
std::string lower = V.lower();
auto supportedValues = getSupportedConditionalCompilationValues(Kind);
for (const SupportedConditionalValue& candidate : supportedValues) {
if (candidate.value == V) {
suggestedKind = Kind;
suggestions.clear();
if (!candidate.replacement.empty())
suggestions.push_back(candidate.replacement);
return true;
}
unsigned distance = StringRef(lower).edit_distance(candidate.value.lower());
if (distance < minDistance) {
suggestions.clear();
minDistance = distance;
}
if (distance == minDistance)
suggestions.emplace_back(candidate.value);
}
suggestedKind = suggestedPlatformConditionKind(Kind, V, suggestions);
return false;
}
bool LangOptions::
checkPlatformConditionSupported(PlatformConditionKind Kind, StringRef Value,
PlatformConditionKind &suggestedKind,
std::vector<StringRef> &suggestedValues) {
switch (Kind) {
case PlatformConditionKind::OS:
case PlatformConditionKind::Arch:
case PlatformConditionKind::Endianness:
case PlatformConditionKind::Runtime:
case PlatformConditionKind::TargetEnvironment:
case PlatformConditionKind::PtrAuth:
return isMatching(Kind, Value, suggestedKind, suggestedValues);
case PlatformConditionKind::CanImport:
// All importable names are valid.
// FIXME: Perform some kind of validation of the string?
return true;
}
llvm_unreachable("Unhandled enum value");
}
StringRef
LangOptions::getPlatformConditionValue(PlatformConditionKind Kind) const {
// Last one wins.
for (auto &Opt : llvm::reverse(PlatformConditionValues)) {
if (Opt.first == Kind)
return Opt.second;
}
return StringRef();
}
bool LangOptions::
checkPlatformCondition(PlatformConditionKind Kind, StringRef Value) const {
// Check a special case that "macOS" is an alias of "OSX".
if (Kind == PlatformConditionKind::OS && Value == "macOS")
return checkPlatformCondition(Kind, "OSX");
// When compiling for iOS we consider "macCatalyst" to be a
// synonym of "macabi". This enables the use of
// #if targetEnvironment(macCatalyst) as a compilation
// condition for macCatalyst.
if (Kind == PlatformConditionKind::TargetEnvironment &&
Value == "macCatalyst" && Target.isiOS()) {
return checkPlatformCondition(Kind, "macabi");
}
for (auto &Opt : llvm::reverse(PlatformConditionValues)) {
if (Opt.first == Kind)
if (Opt.second == Value)
return true;
}
return false;
}
bool LangOptions::isCustomConditionalCompilationFlagSet(StringRef Name) const {
return std::find(CustomConditionalCompilationFlags.begin(),
CustomConditionalCompilationFlags.end(), Name)
!= CustomConditionalCompilationFlags.end();
}
std::pair<bool, bool> LangOptions::setTarget(llvm::Triple triple) {
clearAllPlatformConditionValues();
if (triple.getOS() == llvm::Triple::Darwin &&
triple.getVendor() == llvm::Triple::Apple) {
// Rewrite darwinX.Y triples to macosx10.X'.Y ones.
// It affects code generation on our platform.
llvm::SmallString<16> osxBuf;
llvm::raw_svector_ostream osx(osxBuf);
osx << llvm::Triple::getOSTypeName(llvm::Triple::MacOSX);
unsigned major, minor, micro;
triple.getMacOSXVersion(major, minor, micro);
osx << major << "." << minor;
if (micro != 0)
osx << "." << micro;
triple.setOSName(osx.str());
}
Target = std::move(triple);
bool UnsupportedOS = false;
// Set the "os" platform condition.
switch (Target.getOS()) {
case llvm::Triple::Darwin:
case llvm::Triple::MacOSX:
addPlatformConditionValue(PlatformConditionKind::OS, "OSX");
break;
case llvm::Triple::TvOS:
addPlatformConditionValue(PlatformConditionKind::OS, "tvOS");
break;
case llvm::Triple::WatchOS:
addPlatformConditionValue(PlatformConditionKind::OS, "watchOS");
break;
case llvm::Triple::IOS:
addPlatformConditionValue(PlatformConditionKind::OS, "iOS");
break;
case llvm::Triple::Linux:
if (Target.getEnvironment() == llvm::Triple::Android)
addPlatformConditionValue(PlatformConditionKind::OS, "Android");
else
addPlatformConditionValue(PlatformConditionKind::OS, "Linux");
break;
case llvm::Triple::FreeBSD:
addPlatformConditionValue(PlatformConditionKind::OS, "FreeBSD");
break;
case llvm::Triple::OpenBSD:
addPlatformConditionValue(PlatformConditionKind::OS, "OpenBSD");
break;
case llvm::Triple::Win32:
if (Target.getEnvironment() == llvm::Triple::Cygnus)
addPlatformConditionValue(PlatformConditionKind::OS, "Cygwin");
else
addPlatformConditionValue(PlatformConditionKind::OS, "Windows");
break;
case llvm::Triple::PS4:
if (Target.getVendor() == llvm::Triple::SCEI)
addPlatformConditionValue(PlatformConditionKind::OS, "PS4");
else
UnsupportedOS = false;
break;
case llvm::Triple::Haiku:
addPlatformConditionValue(PlatformConditionKind::OS, "Haiku");
break;
case llvm::Triple::WASI:
addPlatformConditionValue(PlatformConditionKind::OS, "WASI");
break;
default:
UnsupportedOS = true;
break;
}
bool UnsupportedArch = false;
// Set the "arch" platform condition.
switch (Target.getArch()) {
case llvm::Triple::ArchType::arm:
case llvm::Triple::ArchType::thumb:
addPlatformConditionValue(PlatformConditionKind::Arch, "arm");
break;
case llvm::Triple::ArchType::aarch64:
case llvm::Triple::ArchType::aarch64_32:
if (Target.getArchName() == "arm64_32") {
addPlatformConditionValue(PlatformConditionKind::Arch, "arm64_32");
} else {
addPlatformConditionValue(PlatformConditionKind::Arch, "arm64");
}
break;
case llvm::Triple::ArchType::ppc64:
addPlatformConditionValue(PlatformConditionKind::Arch, "powerpc64");
break;
case llvm::Triple::ArchType::ppc64le:
addPlatformConditionValue(PlatformConditionKind::Arch, "powerpc64le");
break;
case llvm::Triple::ArchType::x86:
addPlatformConditionValue(PlatformConditionKind::Arch, "i386");
break;
case llvm::Triple::ArchType::x86_64:
addPlatformConditionValue(PlatformConditionKind::Arch, "x86_64");
break;
case llvm::Triple::ArchType::systemz:
addPlatformConditionValue(PlatformConditionKind::Arch, "s390x");
break;
case llvm::Triple::ArchType::wasm32:
addPlatformConditionValue(PlatformConditionKind::Arch, "wasm32");
break;
default:
UnsupportedArch = true;
}
if (UnsupportedOS || UnsupportedArch)
return { UnsupportedOS, UnsupportedArch };
// Set the "_endian" platform condition.
switch (Target.getArch()) {
default: llvm_unreachable("undefined architecture endianness");
case llvm::Triple::ArchType::arm:
case llvm::Triple::ArchType::thumb:
case llvm::Triple::ArchType::aarch64:
case llvm::Triple::ArchType::aarch64_32:
case llvm::Triple::ArchType::ppc64le:
case llvm::Triple::ArchType::wasm32:
case llvm::Triple::ArchType::x86:
case llvm::Triple::ArchType::x86_64:
addPlatformConditionValue(PlatformConditionKind::Endianness, "little");
break;
case llvm::Triple::ArchType::ppc64:
case llvm::Triple::ArchType::systemz:
addPlatformConditionValue(PlatformConditionKind::Endianness, "big");
break;
}
// Set the "runtime" platform condition.
addPlatformConditionValue(PlatformConditionKind::Runtime,
EnableObjCInterop ? "_ObjC" : "_Native");
// Set the pointer authentication scheme.
if (Target.getArchName() == "arm64e") {
addPlatformConditionValue(PlatformConditionKind::PtrAuth, "_arm64e");
} else {
addPlatformConditionValue(PlatformConditionKind::PtrAuth, "_none");
}
// Set the "targetEnvironment" platform condition if targeting a simulator
// environment. Otherwise _no_ value is present for targetEnvironment; it's
// an optional disambiguating refinement of the triple.
if (Target.isSimulatorEnvironment())
addPlatformConditionValue(PlatformConditionKind::TargetEnvironment,
"simulator");
if (tripleIsMacCatalystEnvironment(Target))
addPlatformConditionValue(PlatformConditionKind::TargetEnvironment,
"macabi");
// If you add anything to this list, change the default size of
// PlatformConditionValues to not require an extra allocation
// in the common case.
return { false, false };
}
llvm::StringRef swift::getFeatureName(Feature feature) {
switch (feature) {
#define LANGUAGE_FEATURE(FeatureName, SENumber, Description, Option) \
case Feature::FeatureName: return #FeatureName;
#include "swift/Basic/Features.def"
}
llvm_unreachable("covered switch");
}
DiagnosticBehavior LangOptions::getAccessNoteFailureLimit() const {
switch (AccessNoteBehavior) {
case AccessNoteDiagnosticBehavior::Ignore:
return DiagnosticBehavior::Ignore;
case AccessNoteDiagnosticBehavior::RemarkOnFailure:
case AccessNoteDiagnosticBehavior::RemarkOnFailureOrSuccess:
return DiagnosticBehavior::Remark;
case AccessNoteDiagnosticBehavior::ErrorOnFailureRemarkOnSuccess:
return DiagnosticBehavior::Error;
}
llvm_unreachable("covered switch");
}