Archive attributes and runtime support for it #9432
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…angled names. The name mangling changed from Swift 3 to Swift 4, and may get slight tweaks as we lock down ABI stability. Identify and warn about (in Swift 3) or error about (in Swift 4) the cases where we don't have obviously-stable name mangling, e.g., * private/fileprivate classes (whose mangled names involve the file name) * nested classes (whose mangled names depend on their enclosing type) * generic classes (whose mangled names involve the type arguments)
This attribute allows one to provide the "legacy" name of a class for the purposes of archival (via NSCoding). At the moment, it is only useful for suppressing the warnings/errors about classes with unstable archiving names.
Generic classes don't have a single name to register, so disallow @NSKeyedArchiveLegacy.
Currently inactive, this attribute indicates that a static initializer should be emitted to register the Objective-C metadata when the image is loaded, rather than on first use of the Objective-C metadata. Infer this attribute for NSCoding classes that won’t have static Objective-C metadata or have an @NSKeyedArchiveLegacy attributed.
…raging. The diagnostic regarding NSCoding classes with unstable names can be suppressed by adding @objc (the preferred solution for new code) or @NSKeyedArchiveLegacy (for existing archives). Provide those as Fix-Its, in that order. (Thanks, Jordan!)
…diags. Introduce the @NSKeyedArchiveSubclassesOnly attribute, which can be placed on a class that conforms to NSCoding to suppress the unstable-name diagnostics by promising to only archive subclasses---not this class directly.
Infer @_staticInitializeObjCMetadata in those cases where we need a static initializer to make an NSCoding-conforming class visible to the Objective-C runtime. This does *not* include classes with one of the @NSKeyedArchive attributes: * @NSKeyedArchiveLegacy implies that we'll register the class directly, with the necessary side effect of initialize Objective-C metadata. * @NSKeyedArchiveSubclassesOnly promises not to archive the class directly anyway.
Register class names for NSKeyedArchiver and NSKeyedUnarchiver based on the @NSKeyedArchiveLegacy and @_staticInitializeObjCMetadata class attributes. @NSKeyedArchiveLegacy registers a class name translation. @_staticInitializeObjCMetadata just makes sure that the metadata of a class is instantiated. This registration code is executed as a static initializer, like a C++ global constructor.
|
@swift-ci Please test |
|
@jrose-apple Can you please review this? |
gparker42
reviewed
May 9, 2017
| @@ -36,6 +36,7 @@ | |||
| // implementations. | |||
| #define FOR_CONV_DefaultCC(...) | |||
| #define FOR_CONV_C_CC(...) | |||
| #define FOR_CONV_SwiftCC(...) | |||
There was a problem hiding this comment.
This needs documentation. The other CCs are described in the nearby comments.
|
I am getting these warnings on Linux: Presumably this will happen on any platform where we don't yet use the just-built Clang to build the runtime. |
|
What do we need the |
|
This attribute is automatically generated. It's for classes where we just have to make sure that it's metadata is initialized (before any unarchiving). For example non-generic subclasses of generic classes |
|
Can we prevent people from spelling the attribute in source code? |
A question for @DougGregor |
|
We could make it RejectByParser instead of just UserInaccessible. |
|
Yeah, that's a fine idea. I'll do the |
|
Sounds good. Runtime changes LGTM. |
|
That PR is over at #9473 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explanation: This is the second part for supporting NSKeyedArchives. It adds new attributes for classes (Doug's changes) and runtime support for it (Erik's changes).
Scope: This is a new feature
Issue: rdar://problem/32083946
Risk: Low. It only affects swift code which actually uses those attributes.
Testing: There are test case in this PR for swift CI