[PrintAsObjC] Handle circularities introduced by ObjC generics. #4155
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
Like Swift generics, Objective-C generics may have constraints; unlike Swift generics, Objective-C doesn't do separate parsing and type-checking passes. This means that any generic arguments for constrained generic parameters must be fully-defined, in order to check that they satisfy the constraints. This commit addresses this problem with three different mechanisms, one for each kind of declaration that might run into this issue: - For classes, if a member references a type with constrained generic parameter, and the corresponding argument type hasn't been printed yet, that member is "delayed", which means it is put into a category at the end of the file. - Protocols cannot have categories, so for protocols we instead see if we can print the definition of the other type first. To break circular dependencies, the printer will not attempt this if both the type and the protocol are already being depended on. This isn't perfect (see below). - Rather than delaying members of extensions, we just delay them wholesale. This keeps related members together, but also has problems (see below). These approaches solve the most common cases while still not crashing in the uncommon ones. However, there are still a number of problems: - The protocol heuristic is overly negative, which means we may generate an invalid header even when there's a reasonable ordering. For example, a single class might inherit from a class A and conform to protocol P, and protocol P depends on class A as a generic argument. In this case, defining class A first is the right thing to do, but it's possible for the printer to decide that there's circularity here and just forward- declare A instead. - Protocols really can be circular. This can be fixed by printing a forward-declared protocol alongside the generic constraints, i.e. 'id <MoreThanNSCopying, NSCopying>' instead of just 'id <MoreThanNSCopying>'. - Extensions can introduce protocols as well. This is not modeled at all; if a member depends on a protocol conformance, it's assumed that simply printing the class would be sufficient. This could be fixed by checking how a generic argument satisfies its constraints, possibly delaying individual members from extensions in order to print them sooner. - More cases I haven't thought about. Test cases for some of these problems are in the new circularity-errors.swift file, mostly to make sure the ObjC printer doesn't crash when it encounters them. rdar://problem/27109377
|
@jckarter, @bitjammer, or @atrick, can you review this? @swift-ci Please test |
|
LGTM. |
|
Linux failures unrelated (and really I shouldn't have tested Linux at all, since this only affects ObjC). |
|
Majority of CI testing has passed. Merging. |
kateinoigakukun
pushed a commit
that referenced
this pull request
Aug 31, 2022
[pull] swiftwasm from main
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.
Like Swift generics, Objective-C generics may have constraints; unlike Swift generics, Objective-C doesn't do separate parsing and type-checking passes. This means that any generic arguments for constrained generic parameters must be fully-defined, in order to check that they satisfy the constraints.
This commit addresses this problem with three different mechanisms, one for each kind of declaration that might run into this issue:
These approaches solve the most common cases while still not crashing in the uncommon ones. However, there are still a number of problems:
id <MoreThanNSCopying, NSCopying>instead of justid <MoreThanNSCopying>.Test cases for some of these problems are in the new circularity-errors.swift file, mostly to make sure the ObjC printer doesn't crash when it encounters them. I intend to file bugs for these issues.
rdar://problem/27109377
Before merging this pull request to apple/swift repository:
Triggering Swift CI
The swift-ci is triggered by writing a comment on this PR addressed to the GitHub user @swift-ci. Different tests will run depending on the specific comment that you use. The currently available comments are:
Smoke Testing
A smoke test on macOS does the following:
device standard libraries are not built.
version of these tests are not run.
A smoke test on Linux does the following:
tests are not run.
Validation Testing
Lint Testing
Note: Only members of the Apple organization can trigger swift-ci.