SR-2405 Print IB_DESIGNABLE and IBInspectable in the generated ObjC header #5252

JGiola · 2016-10-12T13:13:37Z

Add support for @IBDesignable and @IBInspectable attribute to the
generated ObjC headers.

It’s my first try to commit to a project like this, and I’m not so sure if I get how the tests works.
I’m doing it right? I have to add some more?

jrose-apple

Code looks good, a few comments on the tests. Were you able to test this in Xcode as well for both frameworks and apps, or would you like me to try that?

jrose-apple · 2016-10-12T16:14:01Z

test/PrintAsObjC/classes.swift

@@ -318,6 +318,13 @@ typealias AliasForNSRect = NSRect
  func testBridgingOptionality(_ a: UnsafePointer<Int>?, b: UnsafeMutablePointer<Int>!, c: AutoreleasingUnsafeMutablePointer<Methods?>?) {}
 }

+// CHECK-LABEL: IB_DESIGNABLE
+// CHECK-LABEL: @interface MyDesignableObject : NSObject


Here CHECK-LABEL is a sort of "start over" annotation. I think it makes more sense to check that the IB_DESIGNABLE is actually attached to MyDesignableObject using CHECK-NEXT, even though it means we need to match the next line as well.

(CHECK-NEXT does handle partial matches, so you don't actually have to include the mangled name.)

Are you sure of that? I'm using CHECK LABEL because using CHECK NEXT was failing on the mangled name. Or at least is what I've understood from the test report.

Ah, the case I'm concerned about looks like this:

IB_DESIGNABLE // first CHECK-LABEL matches here SWIFT_RUNTIME_NAME("...") @interface SomeUnrelatedObject @end SWIFT_RUNTIME_NAME("...") @interface MyDesignableObject : NSObject // next CHECK-LABEL matches here

The only way to tell that the two have anything to do with each other is to use CHECK-NEXT so that we know what's exactly in between. I think this would be sufficient:

// CHECK-LABEL: IB_DESIGNABLE // CHECK-NEXT: SWIFT_RUNTIME_NAME( // CHECK-NEXT: @interface MyDesignableObject : NSObject

JGiola · 2016-10-13T00:01:25Z

I don't think I'm understanding what you ask...
I have run the tests with through the utils/build-script -t, what I have to do to do the additional tests you asks?

Edit: removing the double negation :), sorry I have to stop trying to write in English at 2 am...

lattner · 2016-10-13T04:55:13Z

Welcome to the project!

JGiola · 2016-10-13T07:51:28Z

Thank you @lattner :)
And thanks to the Hacktoberfest initiative to finally made me try to contribute!

jrose-apple · 2016-10-14T16:27:50Z

Normally running build-script -t would be sufficient, but like I said in the bug I'm worried about IB's detection of IBDesignable/IBInspectable getting confused. The way to test this would be to build a toolchain and try using it with Xcode in various scenarios. That's definitely a little more involved than we'd usually ask from a first-time contributor, though, so I'll see if I can find time to test it for you.

Thanks again for taking this!

JGiola · 2016-10-14T19:06:48Z

I've change the test to use CHECK-NEXT instead of the double CHECK-LABEL

CodaFi · 2017-01-13T05:09:59Z

@swift-ci please smoke test.

jrose-apple · 2017-01-13T17:03:08Z

Sorry, this is still waiting on me testing it in an Xcode! I'll file a bug against myself so I don't let it keep slipping.

jrose-apple

(marking as blocked so it doesn't get drive-by merged)

CodaFi · 2017-06-04T20:14:26Z

We lost the testing logs for this a long time ago.

@swift-ci please smoke test

JGiola · 2017-06-05T12:06:39Z

The failure can be caused by being behind master of like a 10000 commit? I can push a rebase if it can help.

Edit: 10.000 commits, not 1.000 😅

CodaFi · 2017-06-09T20:42:36Z

@swift-ci please smoke test

JGiola · 2017-07-18T20:23:18Z

@jrose-apple there are any news on this PR?

jrose-apple · 2017-07-18T20:33:58Z

Still haven't tested it. :-(

JGiola · 2017-09-21T19:59:02Z

I've rebased the branch to see if everything is ok, and merged the two commit into for a cleaner history

CodaFi · 2017-09-21T20:02:02Z

Holy crap, why did this kick off CI? // @shahmishal

CodaFi · 2017-09-22T19:44:11Z

@JGiola If you want to try to build your own toolchain and plug it into Xcode yourself, this script should get you most of the way there.

JGiola · 2017-09-24T18:11:38Z

Ok, I will try this week when I find a moment and report back the results (only doubt is if I can test Xcode on all the intended scenarios).

JGiola · 2017-10-02T21:40:20Z

I can't make a running toolchain. I'm building from zero with swift/utils/build-script -R --llbuild --swiftpm and then run the script, but when I start the basic single view project in Xcode and open one of the swift file the source editor doesn't highlight or do anything at all asking me to report the bug...
I'm missing some steps to produce a functioning toolchain?

CodaFi · 2017-10-03T16:57:41Z

@JGiola I spent some time updating the script and pushed a new version of the gist. Unfortunately, I'm seeing some MMX include oddities but that could be due to my box still being on 10.12.6. You may need to edit some headers to get things to build, but it should work for macOS projects at least.

CodaFi · 2017-12-09T18:09:14Z

@swift-ci please smoke test

JGiola · 2017-12-10T21:58:34Z

Sorry for being missing from here, I haven’t received the notification for your message in October.
Today I’ve tried to build the toolchain with your updated script but when I fire up Xcode the source editor will crash every time :/
I don’t know what I’m doing wrong...

shahmishal · 2018-02-13T08:20:44Z

Linux: https://ci.swift.org/job/swift-PR-toolchain-Linux/20/artifact/branch-master/swift-PR-5252-20-ubuntu16.04.tar.gz

theblixguy · 2019-10-07T23:34:39Z

Is this ready for a re-review or CI testing? There have been lots of force pushes since over a year and no one has re-reviewed it.

(I’m happy to test the toolchain in Xcode - anything important that I should look for?).

JGiola · 2019-10-08T07:17:54Z

I'm trying to keep it on par with master, but it seems I'm incapable to build a toolchain on my machine (the build-toolchain script always exit with an error and I can't find a solution).

The gist of testing on Xcode is to observe if the generated Obj-C headers with the IBDesignable and/or IBInspectable annotation can confuse it.

theblixguy · 2019-10-08T10:53:22Z

What's the error that you get?

JGiola · 2019-10-15T18:38:33Z

Maybe I was doing something wrong at the time but after some trouble I have a seemingly functional toolchain, but the generated Obj-C headers don’t contain my changes so 🤷‍♂
And to add the worst, every toolchain build on my mbp took like 4/5 hours every time (with a full deletion of everything because I will run low on disk space)

@IBDesignable

Add support for @IBDesignable and @IBInspectable attribute to the generated ObjC headers

jrose-apple

I owe you a huge apology for just letting this sit for literally three years. And possibly a cupcake or something if we ever meet in person.

I finally tested this in Xcode and it looks good—no duplicate fields showing up in IB or anything. Xcode does get a little confused and thinks that there might be a designable class named "MyDesignableObject" as well as "MyModule.MyDesignableObject", but that's not really different from any other case where Xcode gets confused about ObjC names being different from Swift names. (A custom @objc on a property won't be respected by IB, for example.) So let's take it, and I'll let you know if it has problems inside of Apple.

jrose-apple · 2019-10-19T01:10:27Z

@swift-ci Please smoke test

jrose-apple · 2019-10-19T01:10:32Z

@swift-ci Please test source compatibility

jrose-apple · 2019-10-19T03:04:22Z

@swift-ci Please smoke test Linux

JGiola · 2019-10-19T09:04:35Z

I can not refuse a free cupcake 😄, but seriously no problem. It was fun to keep in sync with master every once in a while.

jrose-apple reviewed Oct 12, 2016

View reviewed changes

jrose-apple self-assigned this Oct 14, 2016

jrose-apple suggested changes Jan 13, 2017

View reviewed changes

JGiola force-pushed the SR-2405 branch from 5ef3239 to 91ac96f Compare June 6, 2017 13:36

JGiola force-pushed the SR-2405 branch from 91ac96f to 6bc3af1 Compare September 21, 2017 19:57

JGiola force-pushed the SR-2405 branch 3 times, most recently from 1d9fcc7 to ad553f6 Compare October 2, 2017 19:56

JGiola force-pushed the SR-2405 branch from ad553f6 to a18fe6f Compare November 29, 2017 11:15

JGiola force-pushed the SR-2405 branch from a18fe6f to 246bb08 Compare December 26, 2017 18:45

JGiola force-pushed the SR-2405 branch 2 times, most recently from 40658f3 to d2213bb Compare March 29, 2018 07:23

JGiola force-pushed the SR-2405 branch from d2213bb to 561dce3 Compare April 3, 2018 06:54

JGiola force-pushed the SR-2405 branch from 561dce3 to 5526998 Compare April 23, 2018 07:00

JGiola force-pushed the SR-2405 branch from 5526998 to e61d6aa Compare June 17, 2018 10:12

JGiola force-pushed the SR-2405 branch from e61d6aa to 4cfb388 Compare July 25, 2018 07:08

JGiola force-pushed the SR-2405 branch 2 times, most recently from 8106463 to 93e466a Compare September 3, 2018 06:50

JGiola force-pushed the SR-2405 branch from 93e466a to 2cb9c3e Compare November 25, 2018 12:48

JGiola force-pushed the SR-2405 branch from 2cb9c3e to 1aac20c Compare January 10, 2019 08:05

JGiola force-pushed the SR-2405 branch from 1aac20c to ac7362b Compare August 2, 2019 22:04

JGiola force-pushed the SR-2405 branch from ac7362b to c65bd49 Compare September 4, 2019 21:02

JGiola force-pushed the SR-2405 branch 2 times, most recently from e4a61e3 to 81af97e Compare October 7, 2019 22:13

JGiola force-pushed the SR-2405 branch from 81af97e to 40a5541 Compare October 13, 2019 21:25

Print IB_DESIGNABLE and IBInspectable in the generated ObjC header

5902a47

Add support for @IBDesignable and @IBInspectable attribute to the generated ObjC headers

JGiola force-pushed the SR-2405 branch from 40a5541 to 5902a47 Compare October 16, 2019 18:24

jrose-apple approved these changes Oct 19, 2019

View reviewed changes

jrose-apple merged commit bb83722 into swiftlang:master Oct 21, 2019

JGiola deleted the SR-2405 branch October 21, 2019 17:00

JGiola mentioned this pull request Oct 12, 2016

[SR-2405] Print IB_DESIGNABLE and IBInspectable in the generated ObjC header #45012

Closed

SR-2405 Print IB_DESIGNABLE and IBInspectable in the generated ObjC header #5252

SR-2405 Print IB_DESIGNABLE and IBInspectable in the generated ObjC header #5252

Uh oh!

Conversation

JGiola commented Oct 12, 2016

Uh oh!

jrose-apple left a comment

Choose a reason for hiding this comment

Uh oh!

jrose-apple Oct 12, 2016

Choose a reason for hiding this comment

Uh oh!

jrose-apple Oct 12, 2016

Choose a reason for hiding this comment

Uh oh!

JGiola Oct 12, 2016

Choose a reason for hiding this comment

Uh oh!

jrose-apple Oct 14, 2016

Choose a reason for hiding this comment

Uh oh!

JGiola commented Oct 13, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lattner commented Oct 13, 2016

Uh oh!

JGiola commented Oct 13, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jrose-apple commented Oct 14, 2016

Uh oh!

JGiola commented Oct 14, 2016

Uh oh!

CodaFi commented Jan 13, 2017

Uh oh!

jrose-apple commented Jan 13, 2017

Uh oh!

jrose-apple left a comment

Choose a reason for hiding this comment

Uh oh!

CodaFi commented Jun 4, 2017

Uh oh!

JGiola commented Jun 5, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CodaFi commented Jun 9, 2017

Uh oh!

JGiola commented Jul 18, 2017

Uh oh!

jrose-apple commented Jul 18, 2017

Uh oh!

JGiola commented Sep 21, 2017

Uh oh!

CodaFi commented Sep 21, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CodaFi commented Sep 22, 2017

Uh oh!

JGiola commented Sep 24, 2017

Uh oh!

JGiola commented Oct 2, 2017

Uh oh!

CodaFi commented Oct 3, 2017

Uh oh!

CodaFi commented Dec 9, 2017

Uh oh!

JGiola commented Dec 10, 2017

Uh oh!

shahmishal commented Feb 13, 2018

Uh oh!

theblixguy commented Oct 7, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JGiola commented Oct 8, 2019

Uh oh!

theblixguy commented Oct 8, 2019

Uh oh!

JGiola commented Oct 15, 2019

Uh oh!

jrose-apple left a comment

JGiola commented Oct 13, 2016 •

edited

Loading

JGiola commented Oct 13, 2016 •

edited

Loading

JGiola commented Jun 5, 2017 •

edited

Loading

CodaFi commented Sep 21, 2017 •

edited

Loading

theblixguy commented Oct 7, 2019 •

edited

Loading