1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
|
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#import <Cocoa/Cocoa.h>
#include <memory>
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/mac/mac_util.h"
#include "components/remote_cocoa/app_shim/bridged_content_view.h"
#include "components/remote_cocoa/app_shim/immersive_mode_controller_cocoa.h"
#include "components/remote_cocoa/app_shim/immersive_mode_tabbed_controller_cocoa.h"
#include "components/remote_cocoa/app_shim/native_widget_mac_nswindow.h"
#import "components/remote_cocoa/app_shim/native_widget_mac_overlay_nswindow.h"
#include "testing/gmock/include/gmock/gmock.h"
#import "ui/base/cocoa/window_size_constants.h"
#import "ui/base/test/cocoa_helper.h"
@interface NSTitlebarAccessoryViewController (Chrome)
- (void)setRevealAmount:(double)input;
@end
namespace {
constexpr float kBrowserHeight = 200;
constexpr float kBrowserWidth = 400;
constexpr float kOverlayViewHeight = 100;
constexpr float kOverlayViewWidth = kBrowserWidth;
constexpr float kTabOverlayViewHeight = 50;
constexpr float kTabOverlayViewWidth = kBrowserWidth;
constexpr float kPopupHeight = 100;
constexpr float kPopupWidth = kPopupHeight;
inline bool UsePermanentThinController() {
return base::mac::MacOSMajorVersion() >= 13;
}
void SetupWindow(NativeWidgetMacNSWindow* window,
CGFloat width,
CGFloat height) {
window.releasedWhenClosed = NO;
[window setFrame:NSMakeRect(0, 0, width, height) display:YES];
window.contentView = [[BridgedContentView alloc] initWithBridge:nullptr
bounds:gfx::Rect()];
[window.contentView setFrame:NSMakeRect(0, 0, width, height)];
}
BrowserNativeWidgetWindow* CreateBrowserWindow(CGFloat width, CGFloat height) {
BrowserNativeWidgetWindow* browser_window = [[BrowserNativeWidgetWindow alloc]
initWithContentRect:ui::kWindowSizeDeterminedLater
styleMask:NSWindowStyleMaskTitled | NSWindowStyleMaskClosable |
NSWindowStyleMaskMiniaturizable |
NSWindowStyleMaskResizable
backing:NSBackingStoreBuffered
defer:NO];
SetupWindow(browser_window, width, height);
return browser_window;
}
NativeWidgetMacNSWindow* CreateNativeWidgetMacNSWindow(
CGFloat width,
CGFloat height,
NSWindowStyleMask style_mask = NSWindowStyleMaskBorderless) {
NativeWidgetMacNSWindow* window = [[NativeWidgetMacNSWindow alloc]
initWithContentRect:ui::kWindowSizeDeterminedLater
styleMask:style_mask
backing:NSBackingStoreBuffered
defer:NO];
SetupWindow(window, width, height);
return window;
}
NativeWidgetMacOverlayNSWindow* CreateNativeWidgetMacOverlayNSWindow(
CGFloat width,
CGFloat height,
NSWindowStyleMask style_mask = NSWindowStyleMaskBorderless) {
NativeWidgetMacOverlayNSWindow* window =
[[NativeWidgetMacOverlayNSWindow alloc]
initWithContentRect:ui::kWindowSizeDeterminedLater
styleMask:style_mask
backing:NSBackingStoreBuffered
defer:NO];
SetupWindow(window, width, height);
return window;
}
} // namespace
namespace remote_cocoa {
class CocoaImmersiveModeControllerTest : public ui::CocoaTest {
public:
CocoaImmersiveModeControllerTest() = default;
CocoaImmersiveModeControllerTest(const CocoaImmersiveModeControllerTest&) =
delete;
CocoaImmersiveModeControllerTest& operator=(
const CocoaImmersiveModeControllerTest&) = delete;
void SetUp() override {
ui::CocoaTest::SetUp();
// Create a blank browser window.
browser_ = CreateBrowserWindow(kBrowserWidth, kBrowserHeight);
[browser_ orderBack:nil];
// Create a blank overlay window.
overlay_ = CreateNativeWidgetMacOverlayNSWindow(kOverlayViewWidth,
kOverlayViewHeight);
[browser_ addChildWindow:overlay_ ordered:NSWindowAbove];
EXPECT_EQ(overlay_.isVisible, YES);
// Create a blank tab overlay window as a child of overlay window.
tab_overlay_ = CreateNativeWidgetMacOverlayNSWindow(kTabOverlayViewWidth,
kTabOverlayViewHeight);
[overlay_ addChildWindow:tab_overlay_ ordered:NSWindowAbove];
EXPECT_EQ(tab_overlay_.isVisible, YES);
}
void TearDown() override {
unsigned int expected_controllers = UsePermanentThinController() ? 1u : 0u;
EXPECT_EQ(browser_.titlebarAccessoryViewControllers.count,
expected_controllers);
[tab_overlay_ close];
tab_overlay_ = nil;
[overlay_ close];
overlay_ = nil;
[browser_ close];
browser_ = nil;
ui::CocoaTest::TearDown();
}
BrowserNativeWidgetWindow* browser() { return browser_; }
NativeWidgetMacOverlayNSWindow* overlay() { return overlay_; }
NativeWidgetMacOverlayNSWindow* tab_overlay() { return tab_overlay_; }
NSArray<__kindof NSTitlebarAccessoryViewController*>* controllers() {
return browser_.titlebarAccessoryViewControllers;
}
private:
BrowserNativeWidgetWindow* __strong browser_;
NativeWidgetMacOverlayNSWindow* __strong overlay_;
NativeWidgetMacOverlayNSWindow* __strong tab_overlay_;
};
// Test ImmersiveModeController construction and destruction.
TEST_F(CocoaImmersiveModeControllerTest, ImmersiveModeController) {
// Controller under test.
auto immersive_mode_controller =
std::make_unique<ImmersiveModeControllerCocoa>(browser(), overlay());
immersive_mode_controller->Init();
EXPECT_EQ(controllers().count, 2u);
}
// Test that reveal locks work as expected.
TEST_F(CocoaImmersiveModeControllerTest, RevealLock) {
// Controller under test.
auto immersive_mode_controller =
std::make_unique<ImmersiveModeControllerCocoa>(browser(), overlay());
immersive_mode_controller->Init();
// Autohide top chrome.
immersive_mode_controller->UpdateToolbarVisibility(
mojom::ToolbarVisibilityStyle::kAutohide);
EXPECT_EQ(controllers().count, 2u);
// The thin controller's height is 0.5px.
EXPECT_EQ(controllers().firstObject.fullScreenMinHeight, 0.5);
// The regular controller's height is 0.
EXPECT_EQ(controllers().lastObject.fullScreenMinHeight, 0);
// Grab 3 reveal locks and make sure that top chrome is displayed.
EXPECT_EQ(immersive_mode_controller->reveal_lock_count(), 0);
immersive_mode_controller->RevealLock();
immersive_mode_controller->RevealLock();
immersive_mode_controller->RevealLock();
EXPECT_EQ(immersive_mode_controller->reveal_lock_count(), 3);
EXPECT_EQ(controllers().lastObject.fullScreenMinHeight,
controllers().lastObject.view.frame.size.height);
// Let go of 2 reveal locks and make sure that top chrome is still displayed.
immersive_mode_controller->RevealUnlock();
immersive_mode_controller->RevealUnlock();
EXPECT_EQ(controllers().lastObject.fullScreenMinHeight,
controllers().lastObject.view.frame.size.height);
// Let go of the final reveal lock and make sure top chrome is hidden.
immersive_mode_controller->RevealUnlock();
EXPECT_EQ(controllers().lastObject.fullScreenMinHeight, 0);
}
// Test that IsReveal() reflects the toolbar visibility.
TEST_F(CocoaImmersiveModeControllerTest, IsRevealed) {
// Create a fake NSToolbarFullScreenWindow and associated views.
NSView* titlebar_container_view = [[NSView alloc]
initWithFrame:NSMakeRect(0, kOverlayViewHeight, kOverlayViewWidth,
kOverlayViewHeight)];
NSWindow* fullscreen_window = [[NSWindow alloc]
initWithContentRect:NSMakeRect(0, 0, kOverlayViewWidth, kBrowserHeight)
styleMask:NSWindowStyleMaskBorderless
backing:NSBackingStoreBuffered
defer:NO];
fullscreen_window.releasedWhenClosed = NO;
[fullscreen_window.contentView addSubview:titlebar_container_view];
[fullscreen_window orderBack:nil];
auto immersive_mode_controller =
std::make_unique<ImmersiveModeControllerCocoa>(browser(), overlay());
base::WeakPtrFactory<ImmersiveModeControllerCocoa> weak_ptr_factory(
immersive_mode_controller.get());
NSTitlebarAccessoryViewController* titlebar_view_controller =
immersive_mode_controller
->immersive_mode_titlebar_view_controller_for_testing();
// Grab the content view from the controller and add it to the test
// `titlebar_container_view`.
BridgedContentView* overlay_view =
immersive_mode_controller->overlay_content_view();
[titlebar_container_view addSubview:overlay_view];
overlay_view.frame = NSMakeRect(0, 0, kOverlayViewWidth, kOverlayViewHeight);
[titlebar_view_controller setRevealAmount:0];
titlebar_view_controller.fullScreenMinHeight = 0;
EXPECT_FALSE(immersive_mode_controller->IsToolbarRevealed());
[titlebar_view_controller setRevealAmount:1];
EXPECT_TRUE(immersive_mode_controller->IsToolbarRevealed());
[titlebar_view_controller setRevealAmount:0];
titlebar_view_controller.fullScreenMinHeight = 100;
EXPECT_TRUE(immersive_mode_controller->IsToolbarRevealed());
[fullscreen_window close];
fullscreen_window = nil;
}
// Test ImmersiveModeController toolbar visibility.
TEST_F(CocoaImmersiveModeControllerTest, ToolbarVisibility) {
unsigned int baseline_controllers = UsePermanentThinController() ? 1u : 0u;
ASSERT_EQ(controllers().count, baseline_controllers);
// Controller under test.
auto immersive_mode_controller =
std::make_unique<ImmersiveModeTabbedControllerCocoa>(browser(), overlay(),
tab_overlay());
immersive_mode_controller->Init();
// kAutoHide sets the NSWindowStyleMaskFullSizeContentView bit on the
// browser's style mask.
immersive_mode_controller->UpdateToolbarVisibility(
mojom::ToolbarVisibilityStyle::kAutohide);
// kAlways typically removes the NSWindowStyleMaskFullSizeContentView bit,
// however is set until the fullscreen transition is complete.
immersive_mode_controller->UpdateToolbarVisibility(
mojom::ToolbarVisibilityStyle::kAlways);
EXPECT_TRUE(browser().styleMask & NSWindowStyleMaskFullSizeContentView);
immersive_mode_controller->FullscreenTransitionCompleted();
EXPECT_FALSE(browser().styleMask & NSWindowStyleMaskFullSizeContentView);
immersive_mode_controller->UpdateToolbarVisibility(
mojom::ToolbarVisibilityStyle::kNone);
// The first object is the permanent thin controller, if present.
// The last object is the regular controller.
EXPECT_EQ(controllers().count, 2u);
EXPECT_TRUE(controllers().lastObject.hidden);
immersive_mode_controller->UpdateToolbarVisibility(
mojom::ToolbarVisibilityStyle::kAutohide);
EXPECT_FALSE(controllers().lastObject.hidden);
}
// Test ImmersiveModeTabbedController construction and destruction.
TEST_F(CocoaImmersiveModeControllerTest, Tabbed) {
// Controller under test.
auto immersive_mode_controller =
std::make_unique<ImmersiveModeTabbedControllerCocoa>(browser(), overlay(),
tab_overlay());
immersive_mode_controller->Init();
immersive_mode_controller->UpdateToolbarVisibility(
mojom::ToolbarVisibilityStyle::kAutohide);
EXPECT_EQ(controllers().count, 3u);
immersive_mode_controller->UpdateToolbarVisibility(
mojom::ToolbarVisibilityStyle::kNone);
EXPECT_EQ(controllers().count, 2u);
}
// Test ImmersiveModeTabbedController reveal lock tests.
TEST_F(CocoaImmersiveModeControllerTest, TabbedRevealLock) {
// Controller under test.
auto immersive_mode_controller =
std::make_unique<ImmersiveModeTabbedControllerCocoa>(browser(), overlay(),
tab_overlay());
immersive_mode_controller->Init();
immersive_mode_controller->FullscreenTransitionCompleted();
// Autohide top chrome.
immersive_mode_controller->UpdateToolbarVisibility(
mojom::ToolbarVisibilityStyle::kAutohide);
// A visible NSToolbar will reveal the titlebar, which hosts the tab view
// controller. Make sure reveal lock and unlock work as expected.
EXPECT_FALSE(browser().toolbar.visible);
immersive_mode_controller->RevealLock();
EXPECT_TRUE(browser().toolbar.visible);
immersive_mode_controller->RevealUnlock();
EXPECT_FALSE(browser().toolbar.visible);
// Make sure the visibility state doesn't change while a reveal lock is
// active.
immersive_mode_controller->UpdateToolbarVisibility(
mojom::ToolbarVisibilityStyle::kAlways);
EXPECT_TRUE(browser().toolbar.visible);
immersive_mode_controller->RevealLock();
immersive_mode_controller->UpdateToolbarVisibility(
mojom::ToolbarVisibilityStyle::kAutohide);
EXPECT_TRUE(browser().toolbar.visible);
// Make sure the visibility state updates after the last reveal lock has
// been released.
immersive_mode_controller->RevealUnlock();
EXPECT_FALSE(browser().toolbar.visible);
}
// Test ImmersiveModeTabbedController construction and destruction.
TEST_F(CocoaImmersiveModeControllerTest, TabbedChildWindow) {
// Controller under test.
auto immersive_mode_controller =
std::make_unique<ImmersiveModeTabbedControllerCocoa>(browser(), overlay(),
tab_overlay());
immersive_mode_controller->Init();
immersive_mode_controller->FullscreenTransitionCompleted();
// Autohide top chrome.
immersive_mode_controller->UpdateToolbarVisibility(
mojom::ToolbarVisibilityStyle::kAutohide);
// Create a popup.
NSWindow* popup = CreateNativeWidgetMacNSWindow(kPopupWidth, kPopupHeight);
EXPECT_EQ(immersive_mode_controller->reveal_lock_count(), 0);
// Add the popup as a child of tab_overlay.
[tab_overlay() addChildWindow:popup ordered:NSWindowAbove];
EXPECT_EQ(immersive_mode_controller->reveal_lock_count(), 1);
// Make sure that closing the popup results in the reveal lock count
// decrementing.
[popup close];
EXPECT_EQ(immersive_mode_controller->reveal_lock_count(), 0);
}
// Test ImmersiveModeTabbedController z-order test.
TEST_F(CocoaImmersiveModeControllerTest, TabbedChildWindowZOrder) {
// Controller under test.
auto immersive_mode_controller =
std::make_unique<ImmersiveModeTabbedControllerCocoa>(browser(), overlay(),
tab_overlay());
immersive_mode_controller->Init();
immersive_mode_controller->FullscreenTransitionCompleted();
// Create a popup.
NSWindow* popup = CreateNativeWidgetMacNSWindow(kPopupWidth, kPopupHeight);
EXPECT_EQ(immersive_mode_controller->reveal_lock_count(), 0);
// Add the popup as a child of overlay.
[overlay() addChildWindow:popup ordered:NSWindowAbove];
// Make sure the tab overlay window stays on z-order top.
EXPECT_EQ(overlay().childWindows.lastObject, tab_overlay());
[popup close];
}
class MockImmersiveModeTabbedControllerCocoa
: public ImmersiveModeTabbedControllerCocoa {
public:
MockImmersiveModeTabbedControllerCocoa(
BrowserNativeWidgetWindow* browser_window,
NativeWidgetMacOverlayNSWindow* overlay_window,
NativeWidgetMacOverlayNSWindow* tab_window)
: ImmersiveModeTabbedControllerCocoa(browser_window,
overlay_window,
tab_window) {}
MOCK_METHOD(void, RevealLocked, (), (override));
MOCK_METHOD(void, RevealUnlocked, (), (override));
};
TEST_F(CocoaImmersiveModeControllerTest,
NoRevealUnlockedDuringChildReordering) {
// Controller under test.
testing::StrictMock<MockImmersiveModeTabbedControllerCocoa>
immersive_mode_controller(browser(), overlay(), tab_overlay());
immersive_mode_controller.Init();
immersive_mode_controller.FullscreenTransitionCompleted();
// Create a popup.
NSWindow* popup = CreateNativeWidgetMacNSWindow(100, 100);
// Add the popup as a child of overlay.
// Reveal lock once on child add.
EXPECT_CALL(immersive_mode_controller, RevealLocked()).Times(1);
[overlay() addChildWindow:popup ordered:NSWindowAbove];
// During re-ordering, no reveal lock or unlock should happen.
[overlay() orderWindowByShuffling:NSWindowAbove relativeTo:0];
// Reveal unlock once on child removal.
EXPECT_CALL(immersive_mode_controller, RevealUnlocked()).Times(1);
[popup close];
}
TEST_F(CocoaImmersiveModeControllerTest, IgnoreRevealLocks) {
// Controller under test.
testing::StrictMock<MockImmersiveModeTabbedControllerCocoa>
immersive_mode_controller(browser(), overlay(), tab_overlay());
immersive_mode_controller.Init();
immersive_mode_controller.FullscreenTransitionCompleted();
// Grab a reveal lock while ignore reveal locks is enabled. RevealLocked()
// should not be called.
EXPECT_CALL(immersive_mode_controller, RevealLocked()).Times(0);
immersive_mode_controller.SetIgnoreRevealLocks(true);
immersive_mode_controller.RevealLock();
// Upon disabling ignore reveal locks, RevealLocked() should fire.
EXPECT_CALL(immersive_mode_controller, RevealLocked()).Times(1);
immersive_mode_controller.SetIgnoreRevealLocks(false);
// Enable ignore reveal locks while there is an active reveal lock then call
// RevealUnlock(). We expect RevealUnlocked() not to be called.
EXPECT_CALL(immersive_mode_controller, RevealUnlocked()).Times(0);
immersive_mode_controller.SetIgnoreRevealLocks(true);
immersive_mode_controller.RevealUnlock();
// Upon disabling ignore reveal locks, RevealUnlocked() should fire.
EXPECT_CALL(immersive_mode_controller, RevealUnlocked()).Times(1);
immersive_mode_controller.SetIgnoreRevealLocks(false);
}
} // namespace remote_cocoa
|