Skip to content

Fix printing of nested typealias types and make it consistent with printing of nominal types #4250

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

akyrtzi
Copy link
Contributor

@akyrtzi akyrtzi commented Aug 12, 2016

What's in this pull request?

Reviewed by Ben Langmuir.

The primary motivation is to fix a problem where 'fixit casts' don't put qualified names of nested types if the type is a typealias. This results in the fixit creating invalid code.

The underlying problem is that typealias printing is inconsistent with the way nested nominal types are printed. By making it consistent we address several problems as well:

  • By default parent types of alias types are not printed, which results in
    • Erroneous fixits, for example when casting to 'Notification.Name' from a string, which ends up adding erroneous cast
      as "Name(rawValue: ...)"
    • Hard to understand type-names in code-completion results and diagnostics
  • When printing with the 'fully-qualified' option, typealias types are printed erroneously like "[PARENT].Type.[TYPEALIAS]"

The change makes typealias printing same as nominal types and addresses the above.
The fix is simple, the bulk of the changes are for updating the tests to account for the changes above.

Resolved bug number: (SR-)

rdar://27809198


Before merging this pull request to apple/swift repository:

  • Test pull request on Swift continuous integration.

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

Platform Comment
All supported platforms @swift-ci Please smoke test
All supported platforms @swift-ci Please smoke test and merge
OS X platform @swift-ci Please smoke test OS X platform
Linux platform @swift-ci Please smoke test Linux platform

A smoke test on macOS does the following:

  1. Builds the compiler incrementally.
  2. Builds the standard library only for macOS. Simulator standard libraries and
    device standard libraries are not built.
  3. lldb is not built.
  4. The test and validation-test targets are run only for macOS. The optimized
    version of these tests are not run.

A smoke test on Linux does the following:

  1. Builds the compiler incrementally.
  2. Builds the standard library incrementally.
  3. lldb is built incrementally.
  4. The swift test and validation-test targets are run. The optimized version of these
    tests are not run.
  5. lldb is tested.

Validation Testing

Platform Comment
All supported platforms @swift-ci Please test
All supported platforms @swift-ci Please test and merge
OS X platform @swift-ci Please test OS X platform
OS X platform @swift-ci Please benchmark
Linux platform @swift-ci Please test Linux platform

Lint Testing

Language Comment
Python @swift-ci Please Python lint

Note: Only members of the Apple organization can trigger swift-ci.

…stent with printing of nominal types.

This fixes several issues:

  • By default parent types of alias types are not printed which results in
    • Erroneous fixits, for example when casting to 'Notification.Name' from a string, which ends up adding erroneous cast
      as "Name(rawValue: ...)"
    • Hard to understand types in code-completion results and diagnostics
  • When printing with 'fully-qualified' option typealias types are printed erroneously like this ".Type."

The change make typealias printing same as nominal types and addresses the above.

…stent with printing of nominal types.

This fixes several issues:
- By default parent types of alias types are not printed which results in
	- Erroneous fixits, for example when casting to 'Notification.Name' from a string, which ends up adding erroneous cast
	  as "Name(rawValue: ...)"
	- Hard to understand types in code-completion results and diagnostics
- When printing with 'fully-qualified' option typealias types are printed erroneously like this "<PARENT>.Type.<TYPEALIAS>"

The change make typealias printing same as nominal types and addresses the above.
@akyrtzi akyrtzi added this to the Swift 3.0 milestone Aug 12, 2016
@akyrtzi
Copy link
Contributor Author

akyrtzi commented Aug 12, 2016

@swift-ci test OS X platform

@tkremenek tkremenek merged commit 4f8fe8d into swiftlang:swift-3.0-branch Aug 12, 2016
@akyrtzi akyrtzi deleted the typealias-print-swift3 branch January 8, 2019 06:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants