mirror of
https://github.com/apple/swift.git
synced 2025-12-21 12:14:44 +01:00
f2c0aab26d
Recently, unexpected binary module sharing between compilers that had inconsistent views of the `PlatformKind` enumeration caused me to spend several days debugging undefined behavior in the compiler. We should validate that enumeration values decoded during deserialization are valid, and fail fast when they are not to make debugging this kind of issue less time consuming. This change just validates the `PlatformKind` value decoded for an `AvailableAttr`, but more of deserialization could be updated to do similar validation. Resolves rdar://123770273
97 lines
3.9 KiB
C++
97 lines
3.9 KiB
C++
//===--- PlatformKind.h - Swift Language Platform Kinds ---------*- C++ -*-===//
|
|
//
|
|
// 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 platform kinds for API availability.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_AST_PLATFORM_KIND_H
|
|
#define SWIFT_AST_PLATFORM_KIND_H
|
|
|
|
#include "swift/Basic/LLVM.h"
|
|
#include "swift/Config.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/Support/VersionTuple.h"
|
|
#include <optional>
|
|
|
|
namespace swift {
|
|
|
|
class LangOptions;
|
|
|
|
/// Available platforms for the availability attribute.
|
|
enum class PlatformKind: uint8_t {
|
|
none,
|
|
#define AVAILABILITY_PLATFORM(X, PrettyName) X,
|
|
#include "swift/AST/PlatformKinds.def"
|
|
};
|
|
|
|
/// Returns the short string representing the platform, suitable for
|
|
/// use in availability specifications (e.g., "OSX").
|
|
StringRef platformString(PlatformKind platform);
|
|
|
|
/// Returns the platform kind corresponding to the passed-in short platform name
|
|
/// or None if such a platform kind does not exist.
|
|
std::optional<PlatformKind> platformFromString(StringRef Name);
|
|
|
|
/// Safely converts the given unsigned value to a valid \c PlatformKind value or
|
|
/// \c nullopt otherwise.
|
|
std::optional<PlatformKind> platformFromUnsigned(unsigned value);
|
|
|
|
/// Returns a valid platform string that is closest to the candidate string
|
|
/// based on edit distance. Returns \c None if the closest valid platform
|
|
/// distance is not within a minimum threshold.
|
|
std::optional<StringRef> closestCorrectedPlatformString(StringRef candidate);
|
|
|
|
/// Returns a human-readable version of the platform name as a string, suitable
|
|
/// for emission in diagnostics (e.g., "macOS").
|
|
StringRef prettyPlatformString(PlatformKind platform);
|
|
|
|
/// Returns the base platform for an application-extension platform. For example
|
|
/// `iOS` would be returned for `iOSApplicationExtension`. Returns `None` for
|
|
/// platforms which are not application extension platforms.
|
|
std::optional<PlatformKind>
|
|
basePlatformForExtensionPlatform(PlatformKind Platform);
|
|
|
|
/// Returns true if \p Platform represents and application extension platform,
|
|
/// e.g. `iOSApplicationExtension`.
|
|
inline bool isApplicationExtensionPlatform(PlatformKind Platform) {
|
|
return basePlatformForExtensionPlatform(Platform).has_value();
|
|
}
|
|
|
|
/// Returns whether the passed-in platform is active, given the language
|
|
/// options. A platform is active if either it is the target platform or its
|
|
/// AppExtension variant is the target platform. For example, OS X is
|
|
/// considered active when the target operating system is OS X and app extension
|
|
/// restrictions are enabled, but OSXApplicationExtension is not considered
|
|
/// active when the target platform is OS X and app extension restrictions are
|
|
/// disabled. PlatformKind::none is always considered active.
|
|
/// If ForTargetVariant is true then for zippered builds the target-variant
|
|
/// triple will be used rather than the target to determine whether the
|
|
/// platform is active.
|
|
bool isPlatformActive(PlatformKind Platform, const LangOptions &LangOpts,
|
|
bool ForTargetVariant = false);
|
|
|
|
/// Returns the target platform for the given language options.
|
|
PlatformKind targetPlatform(const LangOptions &LangOpts);
|
|
|
|
/// Returns true when availability attributes from the "parent" platform
|
|
/// should also apply to the "child" platform for declarations without
|
|
/// an explicit attribute for the child.
|
|
bool inheritsAvailabilityFromPlatform(PlatformKind Child, PlatformKind Parent);
|
|
|
|
llvm::VersionTuple canonicalizePlatformVersion(
|
|
PlatformKind platform, const llvm::VersionTuple &version);
|
|
|
|
} // end namespace swift
|
|
|
|
#endif
|