blob: a6fe97b0d5383b22687b1c554f39b77cfd5aabd7 [file] [log] [blame]
// Copyright 2013 The Flutter 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 "flutter/shell/platform/windows/window.h"
#include "base/win/atl.h" // NOLINT(build/include_order)
#include <imm.h>
#include <oleacc.h>
#include <uiautomationcore.h>
#include <uiautomationcoreapi.h>
#include <wrl/client.h>
#include <cstring>
#include "flutter/shell/platform/windows/dpi_utils.h"
namespace flutter {
namespace {
static constexpr int32_t kDefaultPointerDeviceId = 0;
// This method is only valid during a window message related to mouse/touch
// input.
// See
// https://docs.microsoft.com/en-us/windows/win32/tablet/system-events-and-mouse-messages?redirectedfrom=MSDN#distinguishing-pen-input-from-mouse-and-touch.
static FlutterPointerDeviceKind GetFlutterPointerDeviceKind() {
constexpr LPARAM kTouchOrPenSignature = 0xFF515700;
constexpr LPARAM kTouchSignature = kTouchOrPenSignature | 0x80;
constexpr LPARAM kSignatureMask = 0xFFFFFF00;
LPARAM info = GetMessageExtraInfo();
if ((info & kSignatureMask) == kTouchOrPenSignature) {
if ((info & kTouchSignature) == kTouchSignature) {
return kFlutterPointerDeviceKindTouch;
}
return kFlutterPointerDeviceKindStylus;
}
return kFlutterPointerDeviceKindMouse;
}
char32_t CodePointFromSurrogatePair(wchar_t high, wchar_t low) {
return 0x10000 + ((static_cast<char32_t>(high) & 0x000003FF) << 10) +
(low & 0x3FF);
}
static const int kMinTouchDeviceId = 0;
static const int kMaxTouchDeviceId = 128;
static const int kLinesPerScrollWindowsDefault = 3;
} // namespace
Window::Window() : Window(nullptr, nullptr) {}
Window::Window(std::unique_ptr<WindowsProcTable> windows_proc_table,
std::unique_ptr<TextInputManager> text_input_manager)
: touch_id_generator_(kMinTouchDeviceId, kMaxTouchDeviceId),
windows_proc_table_(std::move(windows_proc_table)),
text_input_manager_(std::move(text_input_manager)),
accessibility_root_(nullptr) {
// Get the DPI of the primary monitor as the initial DPI. If Per-Monitor V2 is
// supported, |current_dpi_| should be updated in the
// kWmDpiChangedBeforeParent message.
current_dpi_ = GetDpiForHWND(nullptr);
// Get initial value for wheel scroll lines
// TODO: Listen to changes for this value
// https://github.com/flutter/flutter/issues/107248
UpdateScrollOffsetMultiplier();
if (windows_proc_table_ == nullptr) {
windows_proc_table_ = std::make_unique<WindowsProcTable>();
}
if (text_input_manager_ == nullptr) {
text_input_manager_ = std::make_unique<TextInputManager>();
}
keyboard_manager_ = std::make_unique<KeyboardManager>(this);
}
Window::~Window() {
Destroy();
}
void Window::InitializeChild(const char* title,
unsigned int width,
unsigned int height) {
Destroy();
std::wstring converted_title = NarrowToWide(title);
WNDCLASS window_class = RegisterWindowClass(converted_title);
auto* result = CreateWindowEx(
0, window_class.lpszClassName, converted_title.c_str(),
WS_CHILD | WS_VISIBLE, CW_DEFAULT, CW_DEFAULT, width, height,
HWND_MESSAGE, nullptr, window_class.hInstance, this);
if (result == nullptr) {
auto error = GetLastError();
LPWSTR message = nullptr;
size_t size = FormatMessageW(
FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM |
FORMAT_MESSAGE_IGNORE_INSERTS,
NULL, error, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
reinterpret_cast<LPWSTR>(&message), 0, NULL);
OutputDebugString(message);
LocalFree(message);
}
SetUserObjectInformationA(GetCurrentProcess(),
UOI_TIMERPROC_EXCEPTION_SUPPRESSION, FALSE, 1);
// SetTimer is not precise, if a 16 ms interval is requested, it will instead
// often fire in an interval of 32 ms. Providing a value of 14 will ensure it
// runs every 16 ms, which will allow for 60 Hz trackpad gesture events, which
// is the maximal frequency supported by SetTimer.
SetTimer(result, kDirectManipulationTimer, 14, nullptr);
direct_manipulation_owner_ = std::make_unique<DirectManipulationOwner>(this);
direct_manipulation_owner_->Init(width, height);
}
std::wstring Window::NarrowToWide(const char* source) {
size_t length = strlen(source);
size_t outlen = 0;
std::wstring wideTitle(length, L'#');
mbstowcs_s(&outlen, &wideTitle[0], length + 1, source, length);
return wideTitle;
}
WNDCLASS Window::RegisterWindowClass(std::wstring& title) {
window_class_name_ = title;
WNDCLASS window_class{};
window_class.hCursor = LoadCursor(nullptr, IDC_ARROW);
window_class.lpszClassName = title.c_str();
window_class.style = CS_HREDRAW | CS_VREDRAW;
window_class.cbClsExtra = 0;
window_class.cbWndExtra = 0;
window_class.hInstance = GetModuleHandle(nullptr);
window_class.hIcon = nullptr;
window_class.hbrBackground = 0;
window_class.lpszMenuName = nullptr;
window_class.lpfnWndProc = WndProc;
RegisterClass(&window_class);
return window_class;
}
LRESULT CALLBACK Window::WndProc(HWND const window,
UINT const message,
WPARAM const wparam,
LPARAM const lparam) noexcept {
if (message == WM_NCCREATE) {
auto cs = reinterpret_cast<CREATESTRUCT*>(lparam);
SetWindowLongPtr(window, GWLP_USERDATA,
reinterpret_cast<LONG_PTR>(cs->lpCreateParams));
auto that = static_cast<Window*>(cs->lpCreateParams);
that->window_handle_ = window;
that->text_input_manager_->SetWindowHandle(window);
RegisterTouchWindow(window, 0);
} else if (Window* that = GetThisFromHandle(window)) {
return that->HandleMessage(message, wparam, lparam);
}
return DefWindowProc(window, message, wparam, lparam);
}
void Window::TrackMouseLeaveEvent(HWND hwnd) {
if (!tracking_mouse_leave_) {
TRACKMOUSEEVENT tme;
tme.cbSize = sizeof(tme);
tme.hwndTrack = hwnd;
tme.dwFlags = TME_LEAVE;
TrackMouseEvent(&tme);
tracking_mouse_leave_ = true;
}
}
LRESULT Window::OnGetObject(UINT const message,
WPARAM const wparam,
LPARAM const lparam) {
LRESULT reference_result = static_cast<LRESULT>(0L);
// Only the lower 32 bits of lparam are valid when checking the object id
// because it sometimes gets sign-extended incorrectly (but not always).
DWORD obj_id = static_cast<DWORD>(static_cast<DWORD_PTR>(lparam));
bool is_uia_request = static_cast<DWORD>(UiaRootObjectId) == obj_id;
bool is_msaa_request = static_cast<DWORD>(OBJID_CLIENT) == obj_id;
if (is_uia_request || is_msaa_request) {
// On Windows, we don't get a notification that the screen reader has been
// enabled or disabled. There is an API to query for screen reader state,
// but that state isn't set by all screen readers, including by Narrator,
// the screen reader that ships with Windows:
// https://docs.microsoft.com/en-us/windows/win32/winauto/screen-reader-parameter
//
// Instead, we enable semantics in Flutter if Windows issues queries for
// Microsoft Active Accessibility (MSAA) COM objects.
OnUpdateSemanticsEnabled(true);
}
gfx::NativeViewAccessible root_view = GetNativeViewAccessible();
if (is_uia_request && root_view) {
// TODO(cbracken): https://github.com/flutter/flutter/issues/94782
// Implement when we adopt UIA support.
} else if (is_msaa_request && root_view) {
// Create the accessibility root if it does not already exist.
if (!accessibility_root_) {
CreateAccessibilityRootNode();
}
// Return the IAccessible for the root view.
// Microsoft::WRL::ComPtr<IAccessible> root(root_view);
accessibility_root_->SetWindow(root_view);
Microsoft::WRL::ComPtr<IAccessible> root(accessibility_root_);
LRESULT lresult = LresultFromObject(IID_IAccessible, wparam, root.Get());
return lresult;
}
return 0;
}
void Window::OnImeSetContext(UINT const message,
WPARAM const wparam,
LPARAM const lparam) {
if (wparam != 0) {
text_input_manager_->CreateImeWindow();
}
}
void Window::OnImeStartComposition(UINT const message,
WPARAM const wparam,
LPARAM const lparam) {
text_input_manager_->CreateImeWindow();
OnComposeBegin();
}
void Window::OnImeComposition(UINT const message,
WPARAM const wparam,
LPARAM const lparam) {
// Update the IME window position.
text_input_manager_->UpdateImeWindow();
if (lparam == 0) {
OnComposeChange(u"", 0);
OnComposeCommit();
}
// Process GCS_RESULTSTR at fisrt, because Google Japanese Input and ATOK send
// both GCS_RESULTSTR and GCS_COMPSTR to commit composed text and send new
// composing text.
if (lparam & GCS_RESULTSTR) {
// Commit but don't end composing.
// Read the committed composing string.
long pos = text_input_manager_->GetComposingCursorPosition();
std::optional<std::u16string> text = text_input_manager_->GetResultString();
if (text) {
OnComposeChange(text.value(), pos);
OnComposeCommit();
}
}
if (lparam & GCS_COMPSTR) {
// Read the in-progress composing string.
long pos = text_input_manager_->GetComposingCursorPosition();
std::optional<std::u16string> text =
text_input_manager_->GetComposingString();
if (text) {
OnComposeChange(text.value(), pos);
}
}
}
void Window::OnImeEndComposition(UINT const message,
WPARAM const wparam,
LPARAM const lparam) {
text_input_manager_->DestroyImeWindow();
OnComposeEnd();
}
void Window::OnImeRequest(UINT const message,
WPARAM const wparam,
LPARAM const lparam) {
// TODO(cbracken): Handle IMR_RECONVERTSTRING, IMR_DOCUMENTFEED,
// and IMR_QUERYCHARPOSITION messages.
// https://github.com/flutter/flutter/issues/74547
}
void Window::AbortImeComposing() {
text_input_manager_->AbortComposing();
}
void Window::UpdateCursorRect(const Rect& rect) {
text_input_manager_->UpdateCaretRect(rect);
}
static uint16_t ResolveKeyCode(uint16_t original,
bool extended,
uint8_t scancode) {
switch (original) {
case VK_SHIFT:
case VK_LSHIFT:
return MapVirtualKey(scancode, MAPVK_VSC_TO_VK_EX);
case VK_MENU:
case VK_LMENU:
return extended ? VK_RMENU : VK_LMENU;
case VK_CONTROL:
case VK_LCONTROL:
return extended ? VK_RCONTROL : VK_LCONTROL;
default:
return original;
}
}
static bool IsPrintable(uint32_t c) {
constexpr char32_t kMinPrintable = ' ';
constexpr char32_t kDelete = 0x7F;
return c >= kMinPrintable && c != kDelete;
}
LRESULT
Window::HandleMessage(UINT const message,
WPARAM const wparam,
LPARAM const lparam) noexcept {
LPARAM result_lparam = lparam;
int xPos = 0, yPos = 0;
UINT width = 0, height = 0;
UINT button_pressed = 0;
FlutterPointerDeviceKind device_kind;
switch (message) {
case kWmDpiChangedBeforeParent:
current_dpi_ = GetDpiForHWND(window_handle_);
OnDpiScale(current_dpi_);
return 0;
case WM_SIZE:
width = LOWORD(lparam);
height = HIWORD(lparam);
current_width_ = width;
current_height_ = height;
HandleResize(width, height);
break;
case WM_PAINT:
OnPaint();
break;
case WM_TOUCH: {
UINT num_points = LOWORD(wparam);
touch_points_.resize(num_points);
auto touch_input_handle = reinterpret_cast<HTOUCHINPUT>(lparam);
if (GetTouchInputInfo(touch_input_handle, num_points,
touch_points_.data(), sizeof(TOUCHINPUT))) {
for (const auto& touch : touch_points_) {
// Generate a mapped ID for the Windows-provided touch ID
auto touch_id = touch_id_generator_.GetGeneratedId(touch.dwID);
POINT pt = {TOUCH_COORD_TO_PIXEL(touch.x),
TOUCH_COORD_TO_PIXEL(touch.y)};
ScreenToClient(window_handle_, &pt);
auto x = static_cast<double>(pt.x);
auto y = static_cast<double>(pt.y);
if (touch.dwFlags & TOUCHEVENTF_DOWN) {
OnPointerDown(x, y, kFlutterPointerDeviceKindTouch, touch_id,
WM_LBUTTONDOWN);
} else if (touch.dwFlags & TOUCHEVENTF_MOVE) {
OnPointerMove(x, y, kFlutterPointerDeviceKindTouch, touch_id);
} else if (touch.dwFlags & TOUCHEVENTF_UP) {
OnPointerUp(x, y, kFlutterPointerDeviceKindTouch, touch_id,
WM_LBUTTONDOWN);
OnPointerLeave(x, y, kFlutterPointerDeviceKindTouch, touch_id);
touch_id_generator_.ReleaseNumber(touch.dwID);
}
}
CloseTouchInputHandle(touch_input_handle);
}
return 0;
}
case WM_MOUSEMOVE:
device_kind = GetFlutterPointerDeviceKind();
if (device_kind == kFlutterPointerDeviceKindMouse) {
TrackMouseLeaveEvent(window_handle_);
xPos = GET_X_LPARAM(lparam);
yPos = GET_Y_LPARAM(lparam);
mouse_x_ = static_cast<double>(xPos);
mouse_y_ = static_cast<double>(yPos);
OnPointerMove(mouse_x_, mouse_y_, device_kind, kDefaultPointerDeviceId);
}
break;
case WM_MOUSELEAVE:
device_kind = GetFlutterPointerDeviceKind();
if (device_kind == kFlutterPointerDeviceKindMouse) {
OnPointerLeave(mouse_x_, mouse_y_, device_kind,
kDefaultPointerDeviceId);
}
// Once the tracked event is received, the TrackMouseEvent function
// resets. Set to false to make sure it's called once mouse movement is
// detected again.
tracking_mouse_leave_ = false;
break;
case WM_SETCURSOR: {
UINT hit_test_result = LOWORD(lparam);
if (hit_test_result == HTCLIENT) {
OnSetCursor();
return TRUE;
}
break;
}
case WM_SETFOCUS:
::CreateCaret(window_handle_, nullptr, 1, 1);
break;
case WM_KILLFOCUS:
::DestroyCaret();
break;
case WM_LBUTTONDOWN:
case WM_RBUTTONDOWN:
case WM_MBUTTONDOWN:
case WM_XBUTTONDOWN:
device_kind = GetFlutterPointerDeviceKind();
if (device_kind != kFlutterPointerDeviceKindMouse) {
break;
}
if (message == WM_LBUTTONDOWN) {
// Capture the pointer in case the user drags outside the client area.
// In this case, the "mouse leave" event is delayed until the user
// releases the button. It's only activated on left click given that
// it's more common for apps to handle dragging with only the left
// button.
SetCapture(window_handle_);
}
button_pressed = message;
if (message == WM_XBUTTONDOWN) {
button_pressed = GET_XBUTTON_WPARAM(wparam);
}
xPos = GET_X_LPARAM(lparam);
yPos = GET_Y_LPARAM(lparam);
OnPointerDown(static_cast<double>(xPos), static_cast<double>(yPos),
device_kind, kDefaultPointerDeviceId, button_pressed);
break;
case WM_LBUTTONUP:
case WM_RBUTTONUP:
case WM_MBUTTONUP:
case WM_XBUTTONUP:
device_kind = GetFlutterPointerDeviceKind();
if (device_kind != kFlutterPointerDeviceKindMouse) {
break;
}
if (message == WM_LBUTTONUP) {
ReleaseCapture();
}
button_pressed = message;
if (message == WM_XBUTTONUP) {
button_pressed = GET_XBUTTON_WPARAM(wparam);
}
xPos = GET_X_LPARAM(lparam);
yPos = GET_Y_LPARAM(lparam);
OnPointerUp(static_cast<double>(xPos), static_cast<double>(yPos),
device_kind, kDefaultPointerDeviceId, button_pressed);
break;
case WM_MOUSEWHEEL:
OnScroll(0.0,
-(static_cast<short>(HIWORD(wparam)) /
static_cast<double>(WHEEL_DELTA)),
kFlutterPointerDeviceKindMouse, kDefaultPointerDeviceId);
break;
case WM_MOUSEHWHEEL:
OnScroll((static_cast<short>(HIWORD(wparam)) /
static_cast<double>(WHEEL_DELTA)),
0.0, kFlutterPointerDeviceKindMouse, kDefaultPointerDeviceId);
break;
case WM_GETOBJECT: {
LRESULT lresult = OnGetObject(message, wparam, lparam);
if (lresult) {
return lresult;
}
break;
}
case WM_TIMER:
if (wparam == kDirectManipulationTimer) {
direct_manipulation_owner_->Update();
return 0;
}
break;
case DM_POINTERHITTEST: {
if (direct_manipulation_owner_) {
UINT contact_id = GET_POINTERID_WPARAM(wparam);
POINTER_INPUT_TYPE pointer_type;
if (windows_proc_table_->GetPointerType(contact_id, &pointer_type) &&
pointer_type == PT_TOUCHPAD) {
direct_manipulation_owner_->SetContact(contact_id);
}
}
break;
}
case WM_INPUTLANGCHANGE:
// TODO(cbracken): pass this to TextInputManager to aid with
// language-specific issues.
break;
case WM_IME_SETCONTEXT:
OnImeSetContext(message, wparam, lparam);
// Strip the ISC_SHOWUICOMPOSITIONWINDOW bit from lparam before passing it
// to DefWindowProc() so that the composition window is hidden since
// Flutter renders the composing string itself.
result_lparam &= ~ISC_SHOWUICOMPOSITIONWINDOW;
break;
case WM_IME_STARTCOMPOSITION:
OnImeStartComposition(message, wparam, lparam);
// Suppress further processing by DefWindowProc() so that the default
// system IME style isn't used, but rather the one set in the
// WM_IME_SETCONTEXT handler.
return TRUE;
case WM_IME_COMPOSITION:
OnImeComposition(message, wparam, lparam);
if (lparam & GCS_RESULTSTR || lparam & GCS_COMPSTR) {
// Suppress further processing by DefWindowProc() since otherwise it
// will emit the result string as WM_CHAR messages on commit. Instead,
// committing the composing text to the EditableText string is handled
// in TextInputModel::CommitComposing, triggered by
// OnImeEndComposition().
return TRUE;
}
break;
case WM_IME_ENDCOMPOSITION:
OnImeEndComposition(message, wparam, lparam);
return TRUE;
case WM_IME_REQUEST:
OnImeRequest(message, wparam, lparam);
break;
case WM_UNICHAR: {
// Tell third-pary app, we can support Unicode.
if (wparam == UNICODE_NOCHAR)
return TRUE;
// DefWindowProc will send WM_CHAR for this WM_UNICHAR.
break;
}
case WM_THEMECHANGED:
OnThemeChange();
break;
case WM_DEADCHAR:
case WM_SYSDEADCHAR:
case WM_CHAR:
case WM_SYSCHAR:
case WM_KEYDOWN:
case WM_SYSKEYDOWN:
case WM_KEYUP:
case WM_SYSKEYUP:
if (keyboard_manager_->HandleMessage(message, wparam, lparam)) {
return 0;
}
break;
}
return Win32DefWindowProc(window_handle_, message, wparam, result_lparam);
}
UINT Window::GetCurrentDPI() {
return current_dpi_;
}
UINT Window::GetCurrentWidth() {
return current_width_;
}
UINT Window::GetCurrentHeight() {
return current_height_;
}
HWND Window::GetWindowHandle() {
return window_handle_;
}
float Window::GetScrollOffsetMultiplier() {
return scroll_offset_multiplier_;
}
void Window::UpdateScrollOffsetMultiplier() {
UINT lines_per_scroll = kLinesPerScrollWindowsDefault;
// Get lines per scroll wheel value from Windows
SystemParametersInfo(SPI_GETWHEELSCROLLLINES, 0, &lines_per_scroll, 0);
// This logic is based off Chromium's implementation
// https://source.chromium.org/chromium/chromium/src/+/main:ui/events/blink/web_input_event_builders_win.cc;l=319-331
scroll_offset_multiplier_ =
static_cast<float>(lines_per_scroll) * 100.0 / 3.0;
}
void Window::Destroy() {
if (window_handle_) {
text_input_manager_->SetWindowHandle(nullptr);
DestroyWindow(window_handle_);
window_handle_ = nullptr;
}
if (accessibility_root_) {
accessibility_root_->Release();
accessibility_root_ = nullptr;
}
UnregisterClass(window_class_name_.c_str(), nullptr);
}
void Window::HandleResize(UINT width, UINT height) {
current_width_ = width;
current_height_ = height;
if (direct_manipulation_owner_) {
direct_manipulation_owner_->ResizeViewport(width, height);
}
OnResize(width, height);
}
Window* Window::GetThisFromHandle(HWND const window) noexcept {
return reinterpret_cast<Window*>(GetWindowLongPtr(window, GWLP_USERDATA));
}
LRESULT Window::Win32DefWindowProc(HWND hWnd,
UINT Msg,
WPARAM wParam,
LPARAM lParam) {
return ::DefWindowProc(hWnd, Msg, wParam, lParam);
}
BOOL Window::Win32PeekMessage(LPMSG lpMsg,
UINT wMsgFilterMin,
UINT wMsgFilterMax,
UINT wRemoveMsg) {
return ::PeekMessage(lpMsg, window_handle_, wMsgFilterMin, wMsgFilterMax,
wRemoveMsg);
}
uint32_t Window::Win32MapVkToChar(uint32_t virtual_key) {
return ::MapVirtualKey(virtual_key, MAPVK_VK_TO_CHAR);
}
UINT Window::Win32DispatchMessage(UINT Msg, WPARAM wParam, LPARAM lParam) {
return ::SendMessage(window_handle_, Msg, wParam, lParam);
}
bool Window::GetHighContrastEnabled() {
HIGHCONTRAST high_contrast = {.cbSize = sizeof(HIGHCONTRAST)};
// API call is only supported on Windows 8+
if (SystemParametersInfoW(SPI_GETHIGHCONTRAST, sizeof(HIGHCONTRAST),
&high_contrast, 0)) {
return high_contrast.dwFlags & HCF_HIGHCONTRASTON;
} else {
FML_LOG(INFO) << "Failed to get status of high contrast feature,"
<< "support only for Windows 8 + ";
return false;
}
}
void Window::CreateAccessibilityRootNode() {
if (accessibility_root_) {
accessibility_root_->Release();
}
accessibility_root_ = AccessibilityRootNode::Create();
}
} // namespace flutter