blob: 6268e0a0bcd2493c082adda901bd052217412bdf [file] [log] [blame]
// Copyright (c) 2013 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "ui/wm/core/capture_controller.h"
#include <utility>
#include "base/logging.h"
#include "base/macros.h"
#include "ui/aura/client/capture_delegate.h"
#include "ui/aura/env.h"
#include "ui/aura/test/aura_test_base.h"
#include "ui/aura/test/test_screen.h"
#include "ui/aura/test/test_window_delegate.h"
#include "ui/aura/window.h"
#include "ui/aura/window_event_dispatcher.h"
#include "ui/events/event.h"
#include "ui/events/event_utils.h"
#include "ui/events/test/event_generator.h"
#include "ui/wm/core/capture_controller.h"
namespace wm {
namespace {
// aura::client::CaptureDelegate which allows querying whether native capture
// has been acquired.
class TestCaptureDelegate : public aura::client::CaptureDelegate {
public:
TestCaptureDelegate() : has_capture_(false) {}
~TestCaptureDelegate() override {}
bool HasNativeCapture() const {
return has_capture_;
}
// aura::client::CaptureDelegate:
void UpdateCapture(aura::Window* old_capture,
aura::Window* new_capture) override {}
void OnOtherRootGotCapture() override {}
void SetNativeCapture() override { has_capture_ = true; }
void ReleaseNativeCapture() override { has_capture_ = false; }
private:
bool has_capture_;
DISALLOW_COPY_AND_ASSIGN(TestCaptureDelegate);
};
} // namespace
class CaptureControllerTest : public aura::test::AuraTestBase {
public:
CaptureControllerTest() {}
void SetUp() override {
AuraTestBase::SetUp();
capture_controller_.reset(new ScopedCaptureClient(root_window()));
second_host_.reset(aura::WindowTreeHost::Create(gfx::Rect(0, 0, 800, 600)));
second_host_->InitHost();
second_host_->window()->Show();
second_host_->SetBounds(gfx::Rect(800, 600));
second_capture_controller_.reset(
new ScopedCaptureClient(second_host_->window()));
}
void TearDown() override {
RunAllPendingInMessageLoop();
second_capture_controller_.reset();
// Kill any active compositors before we hit the compositor shutdown paths.
second_host_.reset();
capture_controller_.reset();
AuraTestBase::TearDown();
}
aura::Window* CreateNormalWindowWithBounds(int id,
aura::Window* parent,
const gfx::Rect& bounds,
aura::WindowDelegate* delegate) {
aura::Window* window = new aura::Window(
delegate
? delegate
: aura::test::TestWindowDelegate::CreateSelfDestroyingDelegate());
window->set_id(id);
window->Init(ui::LAYER_TEXTURED);
parent->AddChild(window);
window->SetBounds(bounds);
window->Show();
return window;
}
aura::Window* GetCaptureWindow() {
return capture_controller_->capture_client()->GetCaptureWindow();
}
aura::Window* GetSecondCaptureWindow() {
return second_capture_controller_->capture_client()->GetCaptureWindow();
}
std::unique_ptr<ScopedCaptureClient> capture_controller_;
std::unique_ptr<aura::WindowTreeHost> second_host_;
std::unique_ptr<ScopedCaptureClient> second_capture_controller_;
DISALLOW_COPY_AND_ASSIGN(CaptureControllerTest);
};
// Makes sure that internal details that are set on mouse down (such as
// mouse_pressed_handler()) are cleared when another root window takes capture.
TEST_F(CaptureControllerTest, ResetMouseEventHandlerOnCapture) {
// Create a window inside the WindowEventDispatcher.
std::unique_ptr<aura::Window> w1(CreateNormalWindow(1, root_window(), NULL));
// Make a synthesized mouse down event. Ensure that the WindowEventDispatcher
// will dispatch further mouse events to |w1|.
ui::MouseEvent mouse_pressed_event(ui::ET_MOUSE_PRESSED, gfx::Point(5, 5),
gfx::Point(5, 5), ui::EventTimeForNow(), 0,
0);
DispatchEventUsingWindowDispatcher(&mouse_pressed_event);
EXPECT_EQ(w1.get(), host()->dispatcher()->mouse_pressed_handler());
// Build a window in the second WindowEventDispatcher.
std::unique_ptr<aura::Window> w2(
CreateNormalWindow(2, second_host_->window(), NULL));
// The act of having the second window take capture should clear out mouse
// pressed handler in the first WindowEventDispatcher.
w2->SetCapture();
EXPECT_EQ(NULL, host()->dispatcher()->mouse_pressed_handler());
}
// Makes sure that when one window gets capture, it forces the release on the
// other. This is needed has to be handled explicitly on Linux, and is a sanity
// check on Windows.
TEST_F(CaptureControllerTest, ResetOtherWindowCaptureOnCapture) {
// Create a window inside the WindowEventDispatcher.
std::unique_ptr<aura::Window> w1(CreateNormalWindow(1, root_window(), NULL));
w1->SetCapture();
// Both capture clients should return the same capture window.
EXPECT_EQ(w1.get(), GetCaptureWindow());
EXPECT_EQ(w1.get(), GetSecondCaptureWindow());
// Build a window in the second WindowEventDispatcher and give it capture.
// Both capture clients should return the same capture window.
std::unique_ptr<aura::Window> w2(
CreateNormalWindow(2, second_host_->window(), NULL));
w2->SetCapture();
EXPECT_EQ(w2.get(), GetCaptureWindow());
EXPECT_EQ(w2.get(), GetSecondCaptureWindow());
}
// Verifies the touch target for the WindowEventDispatcher gets reset on
// releasing capture.
TEST_F(CaptureControllerTest, TouchTargetResetOnCaptureChange) {
// Create a window inside the WindowEventDispatcher.
std::unique_ptr<aura::Window> w1(CreateNormalWindow(1, root_window(), NULL));
ui::test::EventGenerator event_generator1(root_window());
event_generator1.PressTouch();
w1->SetCapture();
// Both capture clients should return the same capture window.
EXPECT_EQ(w1.get(), GetCaptureWindow());
EXPECT_EQ(w1.get(), GetSecondCaptureWindow());
// Build a window in the second WindowEventDispatcher and give it capture.
// Both capture clients should return the same capture window.
std::unique_ptr<aura::Window> w2(
CreateNormalWindow(2, second_host_->window(), NULL));
w2->SetCapture();
EXPECT_EQ(w2.get(), GetCaptureWindow());
EXPECT_EQ(w2.get(), GetSecondCaptureWindow());
// Release capture on the window. Releasing capture should reset the touch
// target of the first WindowEventDispatcher (as it no longer contains the
// capture target).
w2->ReleaseCapture();
EXPECT_EQ(static_cast<aura::Window*>(NULL), GetCaptureWindow());
EXPECT_EQ(static_cast<aura::Window*>(NULL), GetSecondCaptureWindow());
}
// Test that native capture is released properly when the window with capture
// is reparented to a different root window while it has capture.
TEST_F(CaptureControllerTest, ReparentedWhileCaptured) {
std::unique_ptr<TestCaptureDelegate> delegate(new TestCaptureDelegate);
ScopedCaptureClient::TestApi(capture_controller_.get())
.SetDelegate(delegate.get());
std::unique_ptr<TestCaptureDelegate> delegate2(new TestCaptureDelegate);
ScopedCaptureClient::TestApi(second_capture_controller_.get())
.SetDelegate(delegate2.get());
std::unique_ptr<aura::Window> w(CreateNormalWindow(1, root_window(), NULL));
w->SetCapture();
EXPECT_EQ(w.get(), GetCaptureWindow());
EXPECT_EQ(w.get(), GetSecondCaptureWindow());
EXPECT_TRUE(delegate->HasNativeCapture());
EXPECT_FALSE(delegate2->HasNativeCapture());
second_host_->window()->AddChild(w.get());
EXPECT_EQ(w.get(), GetCaptureWindow());
EXPECT_EQ(w.get(), GetSecondCaptureWindow());
EXPECT_TRUE(delegate->HasNativeCapture());
EXPECT_FALSE(delegate2->HasNativeCapture());
w->ReleaseCapture();
EXPECT_EQ(nullptr, GetCaptureWindow());
EXPECT_EQ(nullptr, GetSecondCaptureWindow());
EXPECT_FALSE(delegate->HasNativeCapture());
EXPECT_FALSE(delegate2->HasNativeCapture());
}
// A delegate that deletes a window on scroll cancel gesture event.
class GestureEventDeleteWindowOnScrollEnd
: public aura::test::TestWindowDelegate {
public:
GestureEventDeleteWindowOnScrollEnd() {}
void SetWindow(std::unique_ptr<aura::Window> window) {
window_ = std::move(window);
}
aura::Window* window() { return window_.get(); }
// aura::test::TestWindowDelegate:
void OnGestureEvent(ui::GestureEvent* gesture) override {
TestWindowDelegate::OnGestureEvent(gesture);
if (gesture->type() != ui::ET_GESTURE_SCROLL_END)
return;
window_.reset();
}
private:
std::unique_ptr<aura::Window> window_;
DISALLOW_COPY_AND_ASSIGN(GestureEventDeleteWindowOnScrollEnd);
};
// Tests a scenario when a window gets deleted while a capture is being set on
// it and when that window releases its capture prior to being deleted.
// This scenario should end safely without capture being set.
TEST_F(CaptureControllerTest, GestureResetWithCapture) {
std::unique_ptr<GestureEventDeleteWindowOnScrollEnd> delegate(
new GestureEventDeleteWindowOnScrollEnd());
const int kWindowWidth = 123;
const int kWindowHeight = 45;
gfx::Rect bounds(100, 200, kWindowWidth, kWindowHeight);
std::unique_ptr<aura::Window> window1(
CreateNormalWindowWithBounds(-1235, root_window(), bounds, nullptr));
bounds.Offset(0, 100);
std::unique_ptr<aura::Window> window2(CreateNormalWindowWithBounds(
-1234, root_window(), bounds, delegate.get()));
delegate->SetWindow(std::move(window1));
ui::test::EventGenerator event_generator(root_window());
const int position_x = bounds.x() + 1;
int position_y = bounds.y() + 1;
event_generator.MoveTouch(gfx::Point(position_x, position_y));
event_generator.PressTouch();
for (int idx = 0 ; idx < 20 ; idx++, position_y++)
event_generator.MoveTouch(gfx::Point(position_x, position_y));
// Setting capture on |window1| cancels touch gestures that are active on
// |window2|. GestureEventDeleteWindowOnScrollEnd will then delete |window1|
// and should release capture on it.
delegate->window()->SetCapture();
// capture should not be set upon exit from SetCapture() above.
aura::client::CaptureClient* capture_client =
aura::client::GetCaptureClient(root_window());
ASSERT_NE(nullptr, capture_client);
EXPECT_EQ(nullptr, capture_client->GetCaptureWindow());
// Send a mouse click. We no longer hold capture so this should not crash.
ui::MouseEvent mouse_press(ui::ET_MOUSE_PRESSED, gfx::Point(), gfx::Point(),
base::TimeTicks(), 0, 0);
DispatchEventUsingWindowDispatcher(&mouse_press);
}
} // namespace wm