Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

iOS: Clean up uses of string literal constants #56658

Merged
merged 1 commit into from
Nov 17, 2024

Conversation

cbracken
Copy link
Member

Three changes related to string constants:

  1. Uses the kIOSurfaceColorSpace constant, which is a CFStringRef pointing to the string "IOSurfaceColorSpace"

  2. Uses the kCVPixelFormatType_32BGRA enum value from the CoreVideo headers (which is equal to 'BGRA') in place of hardcoding the string.

From the headers:

kCVPixelFormatType_32BGRA         = 'BGRA',     /* 32 bit BGRA */
  1. Declares kIOServicePlane as a constexpr const char* rather than static const char*, this ensures only a single instance is created, rather than one per translation unit into which the header is included. This string is part of IOKit, but see the comment at the top of the header as to why it's apparently needed.

No test changes since there are no semantic changes.

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.

Three changes related to string constants:

1. Uses the kIOSurfaceColorSpace constant, which is a CFStringRef
   pointing to the string "IOSurfaceColorSpace"

2. Uses the kCVPixelFormatType_32BGRA enum value from the CoreVideo
   headers (which is equal to 'BGRA') in place of hardcoding the string.

From the headers:
```
kCVPixelFormatType_32BGRA         = 'BGRA',     /* 32 bit BGRA */
```

3. Declares kIOServicePlane as a `constexpr const char*` rather than
   `static const char*`, this ensures only a single instance is created,
   rather than one per translation unit into which the header is
   included. This string is part of IOKit, but see the comment at the
   top of the header as to why it's apparently needed.

No test changes since there are no semantic changes.
@flutter-dashboard
Copy link

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption, contact "@test-exemption-reviewer" in the #hackers channel in Discord (don't just cc them here, they won't see it!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing. The test exemption team is a small volunteer group, so all reviewers should feel empowered to ask for tests, without delegating that responsibility entirely to the test exemption group.

@stuartmorgan-g
Copy link
Contributor

test-exempt: code refactor with no semantic change

Copy link
Contributor

@stuartmorgan-g stuartmorgan-g left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@cbracken cbracken added the autosubmit Merge PR when tree becomes green via auto submit App label Nov 17, 2024
@auto-submit auto-submit bot merged commit e86b989 into flutter:main Nov 17, 2024
31 checks passed
@auto-submit auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Nov 17, 2024
@cbracken cbracken deleted the use-existing-constant branch November 17, 2024 22:41
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Nov 17, 2024
github-merge-queue bot pushed a commit to flutter/flutter that referenced this pull request Nov 18, 2024
…159055)

flutter/engine@4878f1c...d0f0526

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
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Nov 18, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Nov 18, 2024
github-merge-queue bot pushed a commit to flutter/flutter that referenced this pull request Nov 18, 2024
…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
nick9822 pushed a commit to nick9822/flutter that referenced this pull request Dec 18, 2024
Three changes related to string constants:

1. Uses the kIOSurfaceColorSpace constant, which is a CFStringRef pointing to the string "IOSurfaceColorSpace"

2. Uses the kCVPixelFormatType_32BGRA enum value from the CoreVideo headers (which is equal to 'BGRA') in place of hardcoding the string.

From the headers:
```
kCVPixelFormatType_32BGRA         = 'BGRA',     /* 32 bit BGRA */
```

3. Declares kIOServicePlane as a `constexpr const char*` rather than `static const char*`, this ensures only a single instance is created, rather than one per translation unit into which the header is included. This string is part of IOKit, but see the comment at the top of the header as to why it's apparently needed.

No test changes since there are no semantic changes.

[C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants