mirror of
https://github.com/apple/swift.git
synced 2025-12-21 12:14:44 +01:00
f3ff561c6f
This is phase-1 of switching from llvm::Optional to std::optional in the
next rebranch. llvm::Optional was removed from upstream LLVM, so we need
to migrate off rather soon. On Darwin, std::optional, and llvm::Optional
have the same layout, so we don't need to be as concerned about ABI
beyond the name mangling. `llvm::Optional` is only returned from one
function in
```
getStandardTypeSubst(StringRef TypeName,
bool allowConcurrencyManglings);
```
It's the return value, so it should not impact the mangling of the
function, and the layout is the same as `std::optional`, so it should be
mostly okay. This function doesn't appear to have users, and the ABI was
already broken 2 years ago for concurrency and no one seemed to notice
so this should be "okay".
I'm doing the migration incrementally so that folks working on main can
cherry-pick back to the release/5.9 branch. Once 5.9 is done and locked
away, then we can go through and finish the replacement. Since `None`
and `Optional` show up in contexts where they are not `llvm::None` and
`llvm::Optional`, I'm preparing the work now by going through and
removing the namespace unwrapping and making the `llvm` namespace
explicit. This should make it fairly mechanical to go through and
replace llvm::Optional with std::optional, and llvm::None with
std::nullopt. It's also a change that can be brought onto the
release/5.9 with minimal impact. This should be an NFC change.
82 lines
2.7 KiB
C++
82 lines
2.7 KiB
C++
//===--- AvailabilityMixin.h - Symbol Graph Symbol Availability -----------===//
|
|
//
|
|
// 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_SYMBOLGRAPHGEN_AVAILABILITYMIXIN_H
|
|
#define SWIFT_SYMBOLGRAPHGEN_AVAILABILITYMIXIN_H
|
|
|
|
#include "swift/AST/Attr.h"
|
|
#include "swift/AST/Module.h"
|
|
#include "swift/Basic/LLVM.h"
|
|
#include "llvm/Support/JSON.h"
|
|
#include "llvm/Support/VersionTuple.h"
|
|
|
|
namespace swift {
|
|
namespace symbolgraphgen {
|
|
|
|
/// A mixin representing a symbol's effective availability in its module.
|
|
struct Availability {
|
|
/// The domain to which the availability applies, such as
|
|
/// an operating system or Swift itself.
|
|
StringRef Domain;
|
|
|
|
/// The domain version at which a symbol was introduced if defined.
|
|
llvm::Optional<llvm::VersionTuple> Introduced;
|
|
|
|
/// The domain version at which a symbol was deprecated if defined.
|
|
llvm::Optional<llvm::VersionTuple> Deprecated;
|
|
|
|
/// The domain version at which a symbol was obsoleted if defined.
|
|
llvm::Optional<llvm::VersionTuple> Obsoleted;
|
|
|
|
/// An optional message regarding a symbol's availability.
|
|
StringRef Message;
|
|
|
|
/// The informal spelling of a new replacement symbol if defined.
|
|
StringRef Renamed;
|
|
|
|
/// If \c true, is unconditionally deprecated in this \c Domain.
|
|
bool IsUnconditionallyDeprecated;
|
|
|
|
/// If \c true, is unconditionally unavailable in this \c Domain.
|
|
bool IsUnconditionallyUnavailable;
|
|
|
|
Availability(const AvailableAttr &AvAttr);
|
|
|
|
/// Update this availability from a duplicate @available
|
|
/// attribute with the same platform on the same declaration.
|
|
///
|
|
/// e.g.
|
|
/// @available(macOS, deprecated: 10.15)
|
|
/// @available(macOS, deprecated: 10.12)
|
|
/// func foo() {}
|
|
///
|
|
/// Updates the first availability using the second's information.
|
|
void updateFromDuplicate(const Availability &Other);
|
|
|
|
/// Update this availability from a parent context's availability.
|
|
void updateFromParent(const Availability &Parent);
|
|
|
|
/// Returns true if this availability item doesn't have
|
|
/// any introduced version, deprecated version, obsoleted version,
|
|
/// or unconditional deprecation status.
|
|
///
|
|
/// \note \c message and \c renamed are not considered.
|
|
bool empty() const;
|
|
|
|
void serialize(llvm::json::OStream &OS) const;
|
|
};
|
|
|
|
} // end namespace symbolgraphgen
|
|
} // end namespace swift
|
|
|
|
#endif // SWIFT_SYMBOLGRAPHGEN_AVAILABILITYMIXIN_H
|