mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
3494c0bd88
This does several different things to improve how platforms are described in availability diagnostics: • Mentions the platform in diagnostics for platform-specific @available(unavailable) attributes. • Replaces “OS X” with “macOS”. • Replaces “fooOS application extension” with “application extensions for fooOS”. • Replaces “on fooOS” with “in fooOS”. Fixes <rdar://problem/49963341>.
62 lines
2.3 KiB
C++
62 lines
2.3 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"
|
|
|
|
namespace swift {
|
|
|
|
class LangOptions;
|
|
|
|
/// Available platforms for the availability attribute.
|
|
enum class PlatformKind {
|
|
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.
|
|
Optional<PlatformKind> platformFromString(StringRef Name);
|
|
|
|
/// 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 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.
|
|
bool isPlatformActive(PlatformKind Platform, LangOptions &LangOpts);
|
|
|
|
/// Returns the target platform for the given language options.
|
|
PlatformKind targetPlatform(LangOptions &LangOpts);
|
|
|
|
} // end namespace swift
|
|
|
|
#endif
|