[pigeon] Adds @SwiftClass annotation by tarrinneal · Pull Request #6372 · flutter/packages

tarrinneal · 2024-03-21T22:13:50Z

Adds annotation for @SwiftClass which will cause the swift generator to create a class instead of a struct in the generated Swift code.

This will allow for recursive classes as well as allow for Objc interop, without forcing users to lose the potential benefits of structs if they prefer them instead.

Also creates recursive data class integration test to check for coverage on all languages.

fixes flutter/flutter#145175

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

tarrinneal · 2024-03-21T22:15:41Z

@LouiseHsu Do you also need the ability to add the @objc attribute to generated classes?

LouiseHsu · 2024-03-21T23:24:53Z

@LouiseHsu Do you also need the ability to add the @objc attribute to generated classes?

Yes, that would be helpful! <3

tarrinneal · 2024-03-21T23:29:36Z

@LouiseHsu Do you also need the ability to add the @objc attribute to generated classes?

Yes, that would be helpful! <3

For api classes and data classes? or just data classes?

LouiseHsu · 2024-03-21T23:34:03Z

@LouiseHsu Do you also need the ability to add the @objc attribute to generated classes?

Yes, that would be helpful! <3

For api classes and data classes? or just data classes?

I think just data classes will be good for now :)

tarrinneal · 2024-03-22T02:32:51Z

Might be best to combine the two annotations (the inheritance being optional within the class one)

tarrinneal · 2024-03-22T04:03:26Z

Might be best to combine the two annotations (the inheritance being optional within the class one)

Done.

@stuartmorgan I'm hoping we can push this through in the morning, if you have time to review it.

…to-class

…s into swift-struct-to-class

hellohuanlin

I like the idea of using annotation, because it can get complicated to detect recursive definition and decide struct vs class for developers.

hellohuanlin · 2024-03-23T02:52:08Z

+      String inheritNSObject = '';
+      if (classDefinition.isSwiftObjcInteropClass) {
+        inheritNSObject = ': NSObject';
+        indent.writeln('@objc');


iirc @objc isn't necessary since it's already a subclass of NSObject, which is already exposed to objc runtime.

Oh sorry i missed it in my previous review - in addition to the above, we probably need to add @objc for all custom members that are not inherited from NSObject (basically all the properties and the init function defined here).

Can you also write some ObjC tests to make sure it works? (requesting changes since this is not tested)

all properties? even primitives? or only custom types?

All properties and methods that are not inherited from NSObject need to be annotated, in order for them to be accessible by objc runtime. The class definition itself and its members inherited from NSObject are already implicitly annotated.

So yes, even the properties of primitive types.

hellohuanlin · 2024-03-23T07:29:24Z

+      String inheritNSObject = '';
+      if (classDefinition.isSwiftObjcInteropClass) {
+        inheritNSObject = ': NSObject';
+        indent.writeln('@objc');


Oh sorry i missed it in my previous review - in addition to the above, we probably need to add @objc for all custom members that are not inherited from NSObject (basically all the properties and the init function defined here).

Can you also write some ObjC tests to make sure it works? (requesting changes since this is not tested)

stuartmorgan-g

LGTM once @hellohuanlin's concerns are addressed. (Marking now since I'll be OOO.)

tarrinneal · 2024-03-26T00:13:21Z

@hellohuanlin I removed the @objc feature for now to unblock this pr. I'll throw up a new pr with just that in a short while.

hellohuanlin

As discussed offline, feel free to land this first and create a separate PR for objc interop.

tarrinneal · 2024-03-26T06:32:52Z

Landing to fix the tree

@SwiftClass

flutter/packages@28d126c...ab1630b 2024-03-26 [email protected] [pigeon] Adds @SwiftClass annotation (flutter/packages#6372) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

@SwiftClass

Adds annotation for @SwiftClass which will cause the swift generator to create a `class` instead of a `struct` in the generated Swift code. This will allow for recursive classes as well as allow for Objc interop, without forcing users to lose the potential benefits of structs if they prefer them instead. Also creates recursive data class integration test to check for coverage on all languages. fixes flutter/flutter#145175 ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [relevant style guides] and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use `dart format`.) - [x] I signed the [CLA]. - [x] The title of the PR starts with the name of the package surrounded by square brackets, e.g. `[shared_preferences]` - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated `pubspec.yaml` with an appropriate new version according to the [pub versioning philosophy], or this PR is [exempt from version changes]. - [x] I updated `CHANGELOG.md` to add a description of the change, [following repository CHANGELOG style]. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord].  [Contributor Guide]: https://github.com/flutter/packages/blob/main/CONTRIBUTING.md [Tree Hygiene]: https://github.com/flutter/flutter/wiki/Tree-hygiene [relevant style guides]: https://github.com/flutter/packages/blob/main/CONTRIBUTING.md#style [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/wiki/Tree-hygiene#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/wiki/Chat [pub versioning philosophy]: https://dart.dev/tools/pub/versioning [exempt from version changes]: https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#version-and-changelog-updates [following repository CHANGELOG style]: https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#changelog-style [test-exempt]: https://github.com/flutter/flutter/wiki/Tree-hygiene#tests --------- Co-authored-by: Stuart Morgan <[email protected]>

@SwiftClass

Adds annotation for @SwiftClass which will cause the swift generator to create a `class` instead of a `struct` in the generated Swift code. This will allow for recursive classes as well as allow for Objc interop, without forcing users to lose the potential benefits of structs if they prefer them instead. Also creates recursive data class integration test to check for coverage on all languages. fixes flutter/flutter#145175 ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [relevant style guides] and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use `dart format`.) - [x] I signed the [CLA]. - [x] The title of the PR starts with the name of the package surrounded by square brackets, e.g. `[shared_preferences]` - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated `pubspec.yaml` with an appropriate new version according to the [pub versioning philosophy], or this PR is [exempt from version changes]. - [x] I updated `CHANGELOG.md` to add a description of the change, [following repository CHANGELOG style]. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord].  [Contributor Guide]: https://github.com/flutter/packages/blob/main/CONTRIBUTING.md [Tree Hygiene]: https://github.com/flutter/flutter/wiki/Tree-hygiene [relevant style guides]: https://github.com/flutter/packages/blob/main/CONTRIBUTING.md#style [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/wiki/Tree-hygiene#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/wiki/Chat [pub versioning philosophy]: https://dart.dev/tools/pub/versioning [exempt from version changes]: https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#version-and-changelog-updates [following repository CHANGELOG style]: https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#changelog-style [test-exempt]: https://github.com/flutter/flutter/wiki/Tree-hygiene#tests --------- Co-authored-by: Stuart Morgan <[email protected]>

tarrinneal added 3 commits March 21, 2024 12:01

add integration test and ast changes

b20727b

update swift to use classes

f530351

changelog

b6ab323

tarrinneal requested review from LouiseHsu and stuartmorgan-g March 21, 2024 22:13

tarrinneal requested a review from hellohuanlin as a code owner March 21, 2024 22:13

github-actions Bot added p: pigeon platform-android platform-ios platform-macos platform-windows labels Mar 21, 2024

clean up code, improve tests

5a8dfc7

hellohuanlin reviewed Mar 21, 2024

View reviewed changes

Comment thread packages/pigeon/pigeons/core_tests.dart

tarrinneal added 2 commits March 21, 2024 15:29

readme

7ce8b6e

add back annotation class

ca02c42

tarrinneal added 2 commits March 21, 2024 17:10

add integration tests for with/without recursion classes

1ed419f

@objc annotation

a992a23

fix android unit test bug, merge annotations, one windows fix

73935b9

stuartmorgan-g requested changes Mar 22, 2024

View reviewed changes

Comment thread packages/pigeon/README.md Outdated

Comment thread packages/pigeon/pigeons/core_tests.dart

Comment thread packages/pigeon/platform_tests/test_plugin/windows/pigeon/core_tests.gen.h Outdated

tarrinneal and others added 2 commits March 22, 2024 08:42

nits

7e2966a

Convert custom classes to unique_ptr.

58ca10e

tarrinneal requested a review from stuartmorgan-g March 22, 2024 20:25

stuartmorgan-g and others added 2 commits March 22, 2024 16:25

Add Windows note to CHANGELOG

e608372

Merge branch 'main' of github.com:flutter/packages into swift-struct-…

c0e01f2

…to-class

Merge branch 'swift-struct-to-class' of github.com:tarrinneal/package…

05a0e1c

…s into swift-struct-to-class

hellohuanlin approved these changes Mar 23, 2024

View reviewed changes

hellohuanlin requested changes Mar 23, 2024

View reviewed changes

stuartmorgan-g approved these changes Mar 25, 2024

View reviewed changes

tarrinneal added 3 commits March 25, 2024 17:06

nits

b043459

readme

b62c0ee

remove @objc

6d91995

cleaner classes

ee5eda0

tarrinneal requested a review from hellohuanlin March 26, 2024 00:18

hellohuanlin approved these changes Mar 26, 2024

View reviewed changes

tarrinneal added the autosubmit Merge PR when tree becomes green via auto submit App label Mar 26, 2024

tarrinneal merged commit ab1630b into flutter:main Mar 26, 2024

engine-flutter-autoroll mentioned this pull request Mar 26, 2024

Roll Packages from 28d126c54c63 to ab1630b9b9bd (1 revision) flutter/flutter#145755

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Mar 26, 2024

ab1630b [pigeon] Adds @SwiftClass annotation (flutter/packages#6372)

b9dea86

reidbaker mentioned this pull request Apr 1, 2024

[camera_android_camerax] Move integration_test dependency to tests reidbaker/packages#4

Closed

11 tasks

fam-tung-lam mentioned this pull request Oct 9, 2026

[CRASH] [IOS DEBUG BUILD] Pigeon codec stack overflow after adding the metadata display-name field in DEBUG build fam-tung-lam/health_connector#247

Closed

3 tasks done

Conversation

tarrinneal commented Mar 21, 2024

Pre-launch Checklist

Uh oh!

tarrinneal commented Mar 21, 2024

Uh oh!

Uh oh!

LouiseHsu commented Mar 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tarrinneal commented Mar 21, 2024

Uh oh!

LouiseHsu commented Mar 21, 2024

Uh oh!

tarrinneal commented Mar 22, 2024

Uh oh!

tarrinneal commented Mar 22, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hellohuanlin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

hellohuanlin Mar 23, 2024

Choose a reason for hiding this comment

Uh oh!

hellohuanlin Mar 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tarrinneal Mar 24, 2024

Choose a reason for hiding this comment

Uh oh!

hellohuanlin Mar 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hellohuanlin Mar 24, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

hellohuanlin Mar 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

tarrinneal commented Mar 26, 2024

Uh oh!

hellohuanlin left a comment

Choose a reason for hiding this comment

Uh oh!

tarrinneal commented Mar 26, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

LouiseHsu commented Mar 21, 2024 •

edited

Loading

hellohuanlin Mar 23, 2024 •

edited

Loading

hellohuanlin Mar 24, 2024 •

edited

Loading

hellohuanlin Mar 23, 2024 •

edited

Loading