iOS: Clean up @synthesize directives / ivars #56665

cbracken · 2024-11-17T22:26:44Z

In modern Objective-C, @property directives automatically generate a backing ivar (property name prefixed with an underscore), the getter, and (for readwrite properties) the setter. @synthesize directives are generally only required if the backing ivar has a different name from the property.

Also updates the FlutterMetalLayer API to match CAMetalLayer:

Adds API_AVAILABLE declaration to match that on CAMetalLayer.
Eliminates wantsExtendedDynamicRangeContent property as it's also part of CALayer's interface and unused in our implementation.

Also eliminates unnecessary ivars where they're being synthesized by @property declarations.

Previously, we were overriding the behaviour of
UIViewController.prefersStatusBarHidden by synthesizing _flutterPrefersStatusBarHidden as a backing ivar. Since we're explicitly overriding the behaviour of a superclass, it's more idiomatic to synthesize a private property or explicitly declare an ivar then explicitly override the getter instead.

Further, this adds documentation to cases where @synthesize directives are required, such as:

Creating a backing ivar for a readonly property.
Creating a backing ivar for a property with a custom getter/setter.
Synthesising the ivar, getter, and setter for a property declared in a protocol being implemented.

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide and the C++, Objective-C, Java style guides.
I listed at least one issue that this PR fixes in the description above.
I added new tests to check the change I am making or feature I am adding, or the PR is test-exempt. See testing the engine for instructions on writing and running engine tests.
I updated/added relevant documentation (doc comments with ///).
I signed the CLA.
All existing and new tests are passing.

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

In modern Objective-C, `@property` directives automatically generate a backing ivar (property name prefixed with an underscore), the getter, and (for readwrite properties) the setter. `@synthesize` directives are generally only required if the backing ivar has a different name from the property. Also updates the FlutterMetalLayer API to match CAMetalLayer: * Adds API_AVAILABLE declaration to match that on CAMetalLayer. * Eliminates wantsExtendedDynamicRangeContent property as it's also part of CALayer's interface and unused in our implementation. Previously, we were overriding the behaviour of UIViewController.prefersStatusBarHidden by synthesizing _flutterPrefersStatusBarHidden as a backing ivar. Since we're explicitly overriding the behaviour of a superclass, it's more idiomatic to synthesize a private property or explicitly declare an ivar then explicitly override the getter instead.

shell/platform/darwin/ios/framework/Source/FlutterMetalLayer.mm

stuartmorgan-g

LGTM

shell/platform/darwin/ios/framework/Source/FlutterMetalLayer.mm

shell/platform/darwin/ios/framework/Source/FlutterViewController.mm

shell/platform/darwin/ios/framework/Source/FlutterViewControllerTest.mm

shell/platform/darwin/macos/framework/Source/FlutterThreadSynchronizerTest.mm

shell/platform/darwin/macos/framework/Source/FlutterVSyncWaiterTest.mm

cbracken · 2024-11-17T23:23:20Z

Let's see if the bot agrees with me that an lgtm is as good as an approval! 😉

…e#56665)

@synthesize

…159057) flutter/engine@4878f1c...a63841d 2024-11-18 [email protected] iOS: Clean up @synthesize directives / ivars (flutter/engine#56665) 2024-11-17 [email protected] Roll Skia from 4708534db2e7 to 452208ce96aa (1 revision) (flutter/engine#56664) 2024-11-17 [email protected] iOS: Extract constant for CADisableMinimumFrameDurationOnPhone (flutter/engine#56659) 2024-11-17 [email protected] iOS: Eliminate unnecessary use of NSClassFromString (flutter/engine#56660) 2024-11-17 [email protected] iOS: Eliminate unnecessary bridged retain casts (flutter/engine#56662) 2024-11-17 [email protected] iOS,macOS: Fix string constant declarations (flutter/engine#56661) 2024-11-17 [email protected] iOS: Make FlutterViewController.engine a strong ref (flutter/engine#56663) 2024-11-17 [email protected] iOS: Clean up uses of string literal constants (flutter/engine#56658) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-engine-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

In modern Objective-C, `@property` directives automatically generate a backing ivar (property name prefixed with an underscore), the getter, and (for readwrite properties) the setter. `@synthesize` directives are generally only required if the backing ivar has a different name from the property. Also updates the FlutterMetalLayer API to match CAMetalLayer: * Adds API_AVAILABLE declaration to match that on CAMetalLayer. * Eliminates wantsExtendedDynamicRangeContent property as it's also part of CALayer's interface and unused in our implementation. Also eliminates unnecessary ivars where they're being synthesized by `@property` declarations. Previously, we were overriding the behaviour of UIViewController.prefersStatusBarHidden by synthesizing _flutterPrefersStatusBarHidden as a backing ivar. Since we're explicitly overriding the behaviour of a superclass, it's more idiomatic to synthesize a private property or explicitly declare an ivar then explicitly override the getter instead. Further, this adds documentation to cases where `@synthesize` directives are required, such as: * Creating a backing ivar for a readonly property. * Creating a backing ivar for a property with a custom getter/setter. * Synthesising the ivar, getter, and setter for a property declared in a protocol being implemented. [C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style

cbracken requested review from stuartmorgan-g, jmagman and hellohuanlin November 17, 2024 22:26

github-actions bot added platform-ios affects: desktop platform-macos labels Nov 17, 2024

cbracken changed the title ~~iOS: Clean up @synthesize directives~~ iOS: Clean up @synthesize directives / ivars Nov 17, 2024