Synthesize Equatable/Hashable for complex enums, structs

[allevato]

This is the implementation of the yet-to-be-merged/reviewed evolution proposal to synthesize Equatable/Hashable for enums with payloads and for structs (apple/swift-evolution#706). I'm offering this in the hopes that we can get the proposal reviewed, any updates if needed can be made to the implementation, and it can make it into Swift 4.

This is my first foray into a big change to the compiler itself, so I'm sure there are a number of subtleties about building these ASTs that may have gone over my head. I'm very open to any feedback anyone has on these changes!

[CodaFi]

Overall it looks pretty good. I'll have more in-depth comments later.

[CodaFi]

Overall it looks pretty good. I'll have more in-depth comments later.

[allevato]

Thanks for the feedback! I've pushed the low-hanging formatting clean-up and am working on the more involved items.

[allevato]

Thanks for the feedback! I've pushed the low-hanging formatting clean-up and am working on the more involved items.

[allevato]

I've updated this PR (and the proposal) to forbid synthesis in extensions, to stay in sync with the recently merged Codable change (#9758).

[allevato]

I've updated this PR (and the proposal) to forbid synthesis in extensions, to stay in sync with the recently merged Codable change (#9758).

[CodaFi]

@swift-ci please smoke test

[CodaFi]

@swift-ci please smoke test

[allevato]

I'm a bit puzzled at why the swiftpm build is crashing on Linux but not on macOS in that smoke test (especially without a stack trace to look at).

I'll try to get a development environment set up on a Linux instance but it'll take a little while to carve out that time.

[allevato]

I'm a bit puzzled at why the swiftpm build is crashing on Linux but not on macOS in that smoke test (especially without a stack trace to look at).

I'll try to get a development environment set up on a Linux instance but it'll take a little while to carve out that time.

[CodaFi]

@allevato Could you rebase? I'll try to run this on a Linux box for you.

[CodaFi]

@allevato Could you rebase? I'll try to run this on a Linux box for you.

[allevato]

@CodaFi I've rebased and pushed. Thanks for taking a look at this!

[allevato]

@CodaFi I've rebased and pushed. Thanks for taking a look at this!

[allevato]

I did a little more digging and found that the smoke tests on macOS don't build Swift Package Manager, which explains why the problem didn't manifest there. I built it explicitly on my Mac and got the same crash that was in the CI logs, so now I have something to debug with.

[allevato]

I did a little more digging and found that the smoke tests on macOS don't build Swift Package Manager, which explains why the problem didn't manifest there. I built it explicitly on my Mac and got the same crash that was in the CI logs, so now I have something to debug with.

[allevato]

I've pushed a new commit that fixes the type checker issue, added unit tests to verify the fix, and also verified that Swift Package Manager builds with this change.

Can you please kick off another smoke test?

[allevato]

I've pushed a new commit that fixes the type checker issue, added unit tests to verify the fix, and also verified that Swift Package Manager builds with this change.

Can you please kick off another smoke test?

[CodaFi]

@swift-ci please smoke test

[CodaFi]

@swift-ci please smoke test

[CodaFi]

@swift-ci please smoke test

[CodaFi]

@swift-ci please smoke test

[lattner]

Please add a test case for indirect enums. Thanks!

[lattner]

Please add a test case for indirect enums. Thanks!

[allevato]

Please add a test case for indirect enums. Thanks!

Done.

[allevato]

Please add a test case for indirect enums. Thanks!

Done.

[DougGregor]

@swift-ci please smoke test

[DougGregor]

@swift-ci please smoke test

[allevato]

@slavapestov I've merged master in, just because this PR was done over such a long course of time that a true rebase would require a lot of manual conflict fixups across the commit history. Let me know if that's ok, if I should squash my local state and rebase that on top of master, or if I should do those fixups.

[allevato]

@slavapestov I've merged master in, just because this PR was done over such a long course of time that a true rebase would require a lot of manual conflict fixups across the commit history. Let me know if that's ok, if I should squash my local state and rebase that on top of master, or if I should do those fixups.

[slavapestov]

@allevato That's fine then, let's leave the history as-is. Looks like there's one more merge conflict (sorry), once you fix that I'll merge this PR. Thanks!

[slavapestov]

@allevato That's fine then, let's leave the history as-is. Looks like there's one more merge conflict (sorry), once you fix that I'll merge this PR. Thanks!

[allevato]

@slavapestov Done—this should be ready to merge now. Thanks! 😄

[allevato]

@slavapestov Done—this should be ready to merge now. Thanks! 😄

[slavapestov]

Alright, thank you!

[slavapestov]

Alright, thank you!

[slavapestov]

@swift-ci Please test

[slavapestov]

@swift-ci Please test

[slavapestov]

@swift-ci Please test source compatibility

[slavapestov]

@swift-ci Please test source compatibility

[slavapestov]

@swift-ci Please test

[slavapestov]

@swift-ci Please test

[slavapestov]

@swift-ci Please test

[slavapestov]

@swift-ci Please test

[slavapestov]

@swift-ci Please test source compatibility

[slavapestov]

@swift-ci Please test source compatibility

[slavapestov]

@swift-ci Please test macOS

[slavapestov]

@swift-ci Please test macOS

[slavapestov]

Looks like CI is down for maintenance. Should be back soon

[slavapestov]

Looks like CI is down for maintenance. Should be back soon

[swift-ci]

Build failed
Swift Test Linux Platform
Git Sha - ddaa390

[swift-ci]

Build failed
Swift Test Linux Platform
Git Sha - ddaa390

[allevato]

It looks like that failure might be unrelated, but can someone else verify?

<unknown>:0: error: module map file '/home/buildnode/jenkins/workspace/swift-PR-Linux/branch-master/swift-corelibs-libdispatch/dispatch/module.modulemap' not found
<unknown>:0: error: missing required module 'SwiftShims'
ninja: build stopped: subcommand failed.

[allevato]

It looks like that failure might be unrelated, but can someone else verify?

<unknown>:0: error: module map file '/home/buildnode/jenkins/workspace/swift-PR-Linux/branch-master/swift-corelibs-libdispatch/dispatch/module.modulemap' not found
<unknown>:0: error: missing required module 'SwiftShims'
ninja: build stopped: subcommand failed.

[DougGregor]

@swift-ci please clean smoke test Linux

[DougGregor]

@swift-ci please clean smoke test Linux

[DougGregor]

@swift-ci please clean smoke test Linux

[DougGregor]

@swift-ci please clean smoke test Linux

[DougGregor]

Yeah, it's unrelated. Would like to get actual Linux testing though

[DougGregor]

Yeah, it's unrelated. Would like to get actual Linux testing though

[DougGregor]

@swift-ci please clean smoke test Linux

[DougGregor]

@swift-ci please clean smoke test Linux

[DougGregor]

@swift-ci please clean test Linux

[DougGregor]

@swift-ci please clean test Linux

[therealbnut]

🎉 congratulations @allevato et al. I look forward to seeing this in an upcoming Swift release! (hopefully not too far away 😉)

[therealbnut]

🎉 congratulations @allevato et al. I look forward to seeing this in an upcoming Swift release! (hopefully not too far away 😉)

[lattner]

Great work @allevato !

[lattner]

Great work @allevato !

[solidcell]

Thanks so much @allevato! This was one of my top most wanted features in Swift.

Is this likely to make it into a specific upcoming version? I'm not sure how release coordination works for Swift.

[solidcell]

Thanks so much @allevato! This was one of my top most wanted features in Swift.

Is this likely to make it into a specific upcoming version? I'm not sure how release coordination works for Swift.

[lattner]

This is most likely to go out in "swift 4.1" in spring 2018

[lattner]

This is most likely to go out in "swift 4.1" in spring 2018

[bielikb]

Hi guys, today I've tried snapshot of Swift 4.1. (4.1-DEVELOPMENT-SNAPSHOT-2017-12-12-a) I've tried to define enum with associated values in which the value also conforms to Equatable.

enum EnumWithAssociatedValues : Equatable {
    case first(String)
    case second(String)
}

However the conformance was not added and compiler threw couple of errors. Is it possible I misread the proposal and enums/value types with associated values are not yet supported/not part of this proposal? Thanks for your answer in advance.

[bielikb]

Hi guys, today I've tried snapshot of Swift 4.1. (4.1-DEVELOPMENT-SNAPSHOT-2017-12-12-a) I've tried to define enum with associated values in which the value also conforms to Equatable.

enum EnumWithAssociatedValues : Equatable {
    case first(String)
    case second(String)
}

However the conformance was not added and compiler threw couple of errors. Is it possible I misread the proposal and enums/value types with associated values are not yet supported/not part of this proposal? Thanks for your answer in advance.

[xwu]

@bielikb Your example works without any errors for me. Are you set up to use the toolchain you downloaded? (Xcode Playgrounds, for example, do not.)

[xwu]

@bielikb Your example works without any errors for me. Are you set up to use the toolchain you downloaded? (Xcode Playgrounds, for example, do not.)

[bielikb]

Ive tried to use both - terminal (set local version using swiftenv) & xcode playgrounds (set toolchain). Ill check it tomorrow. Equatable/Hashable conformance worked for enums/structs with no associated types without any problem.

[bielikb]

Ive tried to use both - terminal (set local version using swiftenv) & xcode playgrounds (set toolchain). Ill check it tomorrow. Equatable/Hashable conformance worked for enums/structs with no associated types without any problem.

[ematejska]

@bielikb If you want to easily try it and make sure that you're using the correct toolchain do the following:

1. Launch Xcode and select Xcode->Toolchains->your_downloaded_toolchain
2. Create a new command line project for MacOS (File->New->macOs->Command Line Tool)
3. Go to your project and select the main.swift file and paste your code you want to test.

The problem you have is that Playgrounds will not respect the toolchain setting so using those will not work for testing.

[ematejska]

@bielikb If you want to easily try it and make sure that you're using the correct toolchain do the following:

1. Launch Xcode and select Xcode->Toolchains->your_downloaded_toolchain
2. Create a new command line project for MacOS (File->New->macOs->Command Line Tool)
3. Go to your project and select the main.swift file and paste your code you want to test.

The problem you have is that Playgrounds will not respect the toolchain setting so using those will not work for testing.

[bielikb]

@ematejska Thanks for hints, that's something I already know.
Im getting errors also for swift script file.

Could you try to build the Swift script that I attached to this comment, if it works for you? Maybe then it's env related problem, rather then implementation itself. When I run Enums.swift with associated values, I got couple of compiler errors. If I remove associated values from declaration, it builds just fine.
Please note that the attached zip contains also .swift-version file that specifies 4.1 snapshot I'm using.

Feel free to correct me, if I'm doing something wrong.

enum_associated_values.zip

[bielikb]

@ematejska Thanks for hints, that's something I already know.
Im getting errors also for swift script file.

Could you try to build the Swift script that I attached to this comment, if it works for you? Maybe then it's env related problem, rather then implementation itself. When I run Enums.swift with associated values, I got couple of compiler errors. If I remove associated values from declaration, it builds just fine.
Please note that the attached zip contains also .swift-version file that specifies 4.1 snapshot I'm using.

Feel free to correct me, if I'm doing something wrong.

enum_associated_values.zip

[ematejska]

@bielikb I already had the 4.1-Snapshot-2017-12-13(a) toolchain installed so I tried it with that and Xcode 9. Seems to work for me. I saw errors with the default toolchain that was shipped with Xcode 9 or the form "error: type 'EnumWithAssociatedValues' does not conform to protocol 'Equatable'" and then when I switched to the 4.1-Snapshot, I was able to build successfully.

Just to be clear, I didn't run this as a script but pasted your code into my command line project as described in the previous comment.

[ematejska]

@bielikb I already had the 4.1-Snapshot-2017-12-13(a) toolchain installed so I tried it with that and Xcode 9. Seems to work for me. I saw errors with the default toolchain that was shipped with Xcode 9 or the form "error: type 'EnumWithAssociatedValues' does not conform to protocol 'Equatable'" and then when I switched to the 4.1-Snapshot, I was able to build successfully.

Just to be clear, I didn't run this as a script but pasted your code into my command line project as described in the previous comment.

[bielikb]

@ematejska I've tried to run it in XCode 9.1 in sample project and it worked! As you mentioned. I however still get problems to build it as a script - but that might be problem of choosing the correct Swift toolchain - e.g. although I specified 4.1 snapshot as local swift version through swiftenv for dir with my Enums.swift, it's probably picking 4.0.2 toolchain. Thanks for help & getting me out of the "fog". I cannot wait until 4.1 will hit the world, good night boiler plate.

[bielikb]

@ematejska I've tried to run it in XCode 9.1 in sample project and it worked! As you mentioned. I however still get problems to build it as a script - but that might be problem of choosing the correct Swift toolchain - e.g. although I specified 4.1 snapshot as local swift version through swiftenv for dir with my Enums.swift, it's probably picking 4.0.2 toolchain. Thanks for help & getting me out of the "fog". I cannot wait until 4.1 will hit the world, good night boiler plate.

[benrimmington]

@bielikb Try including the xctoolchain alias/identifier in your script:

#!/usr/bin/xcrun --toolchain 'swift' swift

or

#!/usr/bin/xcrun --toolchain 'org.swift.4120171212a' swift

[benrimmington]

@bielikb Try including the xctoolchain alias/identifier in your script:

#!/usr/bin/xcrun --toolchain 'swift' swift

or

#!/usr/bin/xcrun --toolchain 'org.swift.4120171212a' swift

[bielikb]

@benrimmington I've tried the former definition and it worked! Thanks a lot guys ;)

[bielikb]

@benrimmington I've tried the former definition and it worked! Thanks a lot guys ;)