mirror of
https://github.com/apple/swift.git
synced 2025-12-21 12:14:44 +01:00
37088d4fb9
Change the syntax of availability queries from #available(iOS >= 8.0, OSX >= 10.10, *) to This change reflects the fact that now that we spell the query '#available()' rather than '#os()', the specification is about availability of the APIs introduced in a particular OS release rather than an explicit range of OS versions on which the developer expects the code to run. There is a Fix-It to remove '>=' to ease adopting the new syntax. Swift SVN r28025
123 lines
4.2 KiB
C++
123 lines
4.2 KiB
C++
//===--- AvailabilitySpec.h - Swift Availability Query ASTs -----*- C++ -*-===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2015 Apple Inc. and the Swift project authors
|
|
// Licensed under Apache License v2.0 with Runtime Library Exception
|
|
//
|
|
// See http://swift.org/LICENSE.txt for license information
|
|
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file defines the availability specification AST classes.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_AST_AVAILABILITY_SPEC_H
|
|
#define SWIFT_AST_AVAILABILITY_SPEC_H
|
|
|
|
#include "swift/AST/Identifier.h"
|
|
#include "swift/Basic/SourceLoc.h"
|
|
#include "swift/AST/PlatformKind.h"
|
|
#include "clang/Basic/VersionTuple.h"
|
|
|
|
namespace swift {
|
|
class ASTContext;
|
|
|
|
enum class VersionComparison { GreaterThanEqual };
|
|
|
|
enum class AvailabilitySpecKind {
|
|
/// A version constraint of the form PlatformName X.Y.Z
|
|
VersionConstraint,
|
|
|
|
/// A wildcard constraint, spelled '*', that is be equivalent
|
|
/// to CurrentPlatformName >= MinimumDeploymentTargetVersion
|
|
OtherPlatform
|
|
};
|
|
|
|
/// The root class for specifications of API availability in availability
|
|
/// queries.
|
|
class AvailabilitySpec {
|
|
AvailabilitySpecKind Kind;
|
|
|
|
public:
|
|
AvailabilitySpec(AvailabilitySpecKind Kind) : Kind(Kind) {}
|
|
|
|
AvailabilitySpecKind getKind() const { return Kind; }
|
|
|
|
SourceRange getSourceRange() const;
|
|
|
|
void *
|
|
operator new(size_t Bytes, ASTContext &C,
|
|
unsigned Alignment = alignof(AvailabilitySpec));
|
|
void *operator new(size_t Bytes) throw() = delete;
|
|
void operator delete(void *Data) throw() = delete;
|
|
};
|
|
|
|
/// \brief An availability specification that guards execution based on the
|
|
/// run-time platform and version, e.g., OSX >= 10.10.
|
|
class VersionConstraintAvailabilitySpec : public AvailabilitySpec {
|
|
PlatformKind Platform;
|
|
SourceLoc PlatformLoc;
|
|
|
|
clang::VersionTuple Version;
|
|
SourceRange VersionSrcRange;
|
|
|
|
public:
|
|
VersionConstraintAvailabilitySpec(PlatformKind Platform,
|
|
SourceLoc PlatformLoc,
|
|
clang::VersionTuple Version,
|
|
SourceRange VersionSrcRange)
|
|
: AvailabilitySpec(AvailabilitySpecKind::VersionConstraint),
|
|
Platform(Platform),
|
|
PlatformLoc(PlatformLoc), Version(Version),
|
|
VersionSrcRange(VersionSrcRange) {}
|
|
|
|
/// The required platform.
|
|
PlatformKind getPlatform() const { return Platform; }
|
|
SourceLoc getPlatformLoc() const { return PlatformLoc; }
|
|
|
|
// The platform version to compare against.
|
|
clang::VersionTuple getVersion() const { return Version; }
|
|
SourceRange getVersionSrcRange() const { return VersionSrcRange; }
|
|
|
|
SourceRange getSourceRange() const;
|
|
|
|
void print(raw_ostream &OS, unsigned Indent) const;
|
|
|
|
static bool classof(const AvailabilitySpec *Spec) {
|
|
return Spec->getKind() == AvailabilitySpecKind::VersionConstraint;
|
|
}
|
|
};
|
|
|
|
/// A wildcard availability specification that guards execution
|
|
/// by checking that the run-time version is greater than the minimum
|
|
/// deployment target. This specification is designed to ease porting
|
|
/// to new platforms. Because new platforms typically branch from
|
|
/// existing platforms, the wildcard allows an #available() check to do the
|
|
/// "right" thing (executing the the guarded branch) on the new platform without
|
|
/// requiring a modification to every availablity guard in the program. Note
|
|
/// that we still do compile-time availability checking with '*', so the
|
|
/// compiler will still catch references to potentially unavailable symbols.
|
|
class OtherPlatformAvailabilitySpec : public AvailabilitySpec {
|
|
SourceLoc StarLoc;
|
|
|
|
public:
|
|
OtherPlatformAvailabilitySpec(SourceLoc StarLoc)
|
|
: AvailabilitySpec(AvailabilitySpecKind::OtherPlatform),
|
|
StarLoc(StarLoc) {}
|
|
|
|
SourceRange getSourceRange() const { return SourceRange(StarLoc, StarLoc); }
|
|
|
|
void print(raw_ostream &OS, unsigned Indent) const;
|
|
|
|
static bool classof(const AvailabilitySpec *Spec) {
|
|
return Spec->getKind() == AvailabilitySpecKind::OtherPlatform;
|
|
}
|
|
};
|
|
|
|
} // end namespace swift
|
|
|
|
#endif
|