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

Replace deprecated [UIScreen mainScreen] in FlutterViewController.mm and FlutterViewControllerTest.mm #43690

Merged
merged 7 commits into from
Jul 24, 2023
Merged

Replace deprecated [UIScreen mainScreen] in FlutterViewController.mm and FlutterViewControllerTest.mm #43690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5cd5ccb
renaming mainScreenIfViewLoaded to screenIfViewLoaded to better match…
mossmana Jul 14, 2023
1a8ef92
calling screenIfViewLoaded instead of UIScreen mainScreen
mossmana Jul 14, 2023
a9efcdc
refactor to make it easier to switch to a test screen instead of UISc…
mossmana Jul 17, 2023
2a55240
mocking screen instead of using UIScreen main
mossmana Jul 18, 2023
1ebb401
added back improved log message
mossmana Jul 19, 2023
b9dc437
corrected setup usage to setUp
mossmana Jul 19, 2023
54560bb
Merge branch 'main' into issue128260
mossmana Jul 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 44 additions & 40 deletions shell/platform/darwin/ios/framework/Source/FlutterViewController.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -477,10 +477,30 @@ - (void)loadView {
return pointer_data;
}

static void SendFakeTouchEvent(FlutterEngine* engine,
- (UIWindowScene*)windowSceneIfViewLoaded {
if (self.viewIfLoaded == nil) {
FML_LOG(WARNING) << "Trying to access the window scene before the view is loaded.";
return nil;
}
return self.viewIfLoaded.window.windowScene;
}

- (UIScreen*)screenIfViewLoaded {
if (@available(iOS 13.0, *)) {
if (self.viewIfLoaded == nil) {
FML_LOG(WARNING) << "Trying to access the screen before the view is loaded.";
return nil;
}
return [self windowSceneIfViewLoaded].screen;
}
return UIScreen.mainScreen;
}

static void SendFakeTouchEvent(UIScreen* screen,
FlutterEngine* engine,
CGPoint location,
flutter::PointerData::Change change) {
const CGFloat scale = [UIScreen mainScreen].scale;
const CGFloat scale = screen.scale;
flutter::PointerData pointer_data = [[engine viewController] generatePointerDataForFake];
pointer_data.physical_x = location.x * scale;
pointer_data.physical_y = location.y * scale;
Expand All @@ -495,8 +515,11 @@ - (BOOL)scrollViewShouldScrollToTop:(UIScrollView*)scrollView {
return NO;
}
CGPoint statusBarPoint = CGPointZero;
SendFakeTouchEvent(_engine.get(), statusBarPoint, flutter::PointerData::Change::kDown);
SendFakeTouchEvent(_engine.get(), statusBarPoint, flutter::PointerData::Change::kUp);
UIScreen* screen = [self screenIfViewLoaded];
if (screen) {
SendFakeTouchEvent(screen, _engine.get(), statusBarPoint, flutter::PointerData::Change::kDown);
SendFakeTouchEvent(screen, _engine.get(), statusBarPoint, flutter::PointerData::Change::kUp);
}
return NO;
}

Expand Down Expand Up @@ -613,24 +636,6 @@ - (SpringAnimation*)keyboardSpringAnimation {
return _keyboardSpringAnimation.get();
}

- (UIScreen*)mainScreenIfViewLoaded {
if (@available(iOS 13.0, *)) {
if (self.viewIfLoaded == nil) {
FML_LOG(WARNING) << "Trying to access the view before it is loaded.";
}
return [self windowSceneIfViewLoaded].screen;
}
return UIScreen.mainScreen;
}

- (UIWindowScene*)windowSceneIfViewLoaded {
if (self.viewIfLoaded == nil) {
FML_LOG(WARNING) << "Trying to access the view before it is loaded.";
return nil;
}
return self.viewIfLoaded.window.windowScene;
}

- (BOOL)loadDefaultSplashScreenView {
NSString* launchscreenName =
[[[NSBundle mainBundle] infoDictionary] objectForKey:@"UILaunchStoryboardName"];
Expand Down Expand Up @@ -1065,7 +1070,7 @@ - (void)dispatchTouches:(NSSet*)touches
// Activate or pause the correction of delivery frame rate of touch events.
[self triggerTouchRateCorrectionIfNeeded:touches];

const CGFloat scale = [UIScreen mainScreen].scale;
const CGFloat scale = [self screenIfViewLoaded].scale;
auto packet =
std::make_unique<flutter::PointerDataPacket>(touches.count + touches_to_remove_count);

Expand Down Expand Up @@ -1280,7 +1285,7 @@ - (void)updateViewportMetricsIfNeeded {

- (void)viewDidLayoutSubviews {
CGRect viewBounds = self.view.bounds;
CGFloat scale = [UIScreen mainScreen].scale;
CGFloat scale = [self screenIfViewLoaded].scale;

// Purposefully place this not visible.
_scrollView.get().frame = CGRectMake(0.0, 0.0, viewBounds.size.width, 0.0);
Expand Down Expand Up @@ -1327,12 +1332,12 @@ - (void)viewSafeAreaInsetsDidChange {

// Set _viewportMetrics physical size.
- (void)setViewportMetricsSize {
UIScreen* mainScreen = [self mainScreenIfViewLoaded];
if (!mainScreen) {
UIScreen* screen = [self screenIfViewLoaded];
if (!screen) {
return;
}

CGFloat scale = mainScreen.scale;
CGFloat scale = screen.scale;
_viewportMetrics.physical_width = self.view.bounds.size.width * scale;
_viewportMetrics.physical_height = self.view.bounds.size.height * scale;
}
Expand All @@ -1341,12 +1346,12 @@ - (void)setViewportMetricsSize {
//
// Viewport paddings represent the iOS safe area insets.
- (void)setViewportMetricsPaddings {
UIScreen* mainScreen = [self mainScreenIfViewLoaded];
if (!mainScreen) {
UIScreen* screen = [self screenIfViewLoaded];
if (!screen) {
return;
}

CGFloat scale = mainScreen.scale;
CGFloat scale = screen.scale;
_viewportMetrics.physical_padding_top = self.view.safeAreaInsets.top * scale;
_viewportMetrics.physical_padding_left = self.view.safeAreaInsets.left * scale;
_viewportMetrics.physical_padding_right = self.view.safeAreaInsets.right * scale;
Expand Down Expand Up @@ -1507,7 +1512,7 @@ - (FlutterKeyboardMode)calculateKeyboardAttachMode:(NSNotification*)notification
return FlutterKeyboardModeHidden;
}

CGRect screenRect = [self mainScreenIfViewLoaded].bounds;
CGRect screenRect = [self screenIfViewLoaded].bounds;
CGRect adjustedKeyboardFrame = keyboardFrame;
adjustedKeyboardFrame.origin.y += [self calculateMultitaskingAdjustment:screenRect
keyboardFrame:keyboardFrame];
Expand Down Expand Up @@ -1547,7 +1552,7 @@ - (CGFloat)calculateMultitaskingAdjustment:(CGRect)screenRect keyboardFrame:(CGR
}
CGRect viewRectRelativeToScreen =
[self.viewIfLoaded convertRect:self.viewIfLoaded.frame
toCoordinateSpace:[self mainScreenIfViewLoaded].coordinateSpace];
toCoordinateSpace:[self screenIfViewLoaded].coordinateSpace];
CGFloat viewBottom = CGRectGetMaxY(viewRectRelativeToScreen);
CGFloat offset = screenHeight - viewBottom;
if (offset > 0) {
Expand All @@ -1563,14 +1568,14 @@ - (CGFloat)calculateKeyboardInset:(CGRect)keyboardFrame keyboardMode:(NSInteger)
// Calculate how much of the keyboard intersects with the view.
CGRect viewRectRelativeToScreen =
[self.viewIfLoaded convertRect:self.viewIfLoaded.frame
toCoordinateSpace:[self mainScreenIfViewLoaded].coordinateSpace];
toCoordinateSpace:[self screenIfViewLoaded].coordinateSpace];
CGRect intersection = CGRectIntersection(keyboardFrame, viewRectRelativeToScreen);
CGFloat portionOfKeyboardInView = CGRectGetHeight(intersection);

// The keyboard is treated as an inset since we want to effectively reduce the window size by
// the keyboard height. The Dart side will compute a value accounting for the keyboard-consuming
// bottom padding.
CGFloat scale = [self mainScreenIfViewLoaded].scale;
CGFloat scale = [self screenIfViewLoaded].scale;
return portionOfKeyboardInView * scale;
}
return 0;
Expand Down Expand Up @@ -1869,9 +1874,8 @@ - (void)performOrientationUpdate:(UIInterfaceOrientationMask)new_preferences {
if (@available(iOS 13.0, *)) {
UIWindowScene* windowScene = [self windowSceneIfViewLoaded];
if (!windowScene) {
// When the view is not loaded, it does not make sense to access the interface
// orientation, bail.
FML_LOG(WARNING) << "Trying to access the window scene before the view is loaded.";
Copy link
Contributor

Choose a reason for hiding this comment

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

is this intended change?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The log is a bit redundant, since the windowSceneIfViewLoaded function that is called in the line above already logs the message.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Although, I guess there could be a case where the windowScene could be null for other reasons. Maybe rather than delete the line, I should log out the comment instead?

Copy link
Contributor

Choose a reason for hiding this comment

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

yeah even if both are logged, one is for window scene, and the other is for screen, so not exactly duplicate.

FML_LOG(WARNING)
<< "Accessing the interface orientation when the window scene is unavailable.";
return;
}
currentInterfaceOrientation = 1 << windowScene.interfaceOrientation;
Expand Down Expand Up @@ -2291,7 +2295,7 @@ - (BOOL)gestureRecognizer:(UIGestureRecognizer*)gestureRecognizer

- (void)hoverEvent:(UIPanGestureRecognizer*)recognizer API_AVAILABLE(ios(13.4)) {
CGPoint location = [recognizer locationInView:self.view];
CGFloat scale = [UIScreen mainScreen].scale;
CGFloat scale = [self screenIfViewLoaded].scale;
CGPoint oldLocation = _mouseState.location;
_mouseState.location = {location.x * scale, location.y * scale};

Expand Down Expand Up @@ -2348,7 +2352,7 @@ - (void)hoverEvent:(UIPanGestureRecognizer*)recognizer API_AVAILABLE(ios(13.4))

- (void)discreteScrollEvent:(UIPanGestureRecognizer*)recognizer API_AVAILABLE(ios(13.4)) {
CGPoint translation = [recognizer translationInView:self.view];
const CGFloat scale = [UIScreen mainScreen].scale;
const CGFloat scale = [self screenIfViewLoaded].scale;

translation.x *= scale;
translation.y *= scale;
Expand Down Expand Up @@ -2377,7 +2381,7 @@ - (void)discreteScrollEvent:(UIPanGestureRecognizer*)recognizer API_AVAILABLE(io

- (void)continuousScrollEvent:(UIPanGestureRecognizer*)recognizer API_AVAILABLE(ios(13.4)) {
CGPoint translation = [recognizer translationInView:self.view];
const CGFloat scale = [UIScreen mainScreen].scale;
const CGFloat scale = [self screenIfViewLoaded].scale;

flutter::PointerData pointer_data = [self generatePointerDataAtLastMouseLocation];
pointer_data.device = reinterpret_cast<int64_t>(recognizer);
Expand Down
Loading