Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions .github/workflows/windows-permissions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,7 @@ jobs:
- name: Run the download test
shell: pwsh
run: ./tests/windows_download_test.ps1 -BuildDir build

- name: Run the click-through test
shell: pwsh
run: ./tests/windows_click_through_test.ps1 -BuildDir build
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ The library is meant to be used as a submodule. The host application:
reusable returns false and hides itself, as it would through `hide`.
- `WindowOptions::resizeEdges` draws strips along the window's edges, after each page load, and a press on one starts a resize
from that edge. The page doesn't need to draw them. It applies when `resizable` is set and the window isn't autosize.
- `WindowOptions::clickThrough` makes the window pass mouse clicks to whatever is beneath it, so the page gets no pointer input.
It's fixed when the window opens. On Windows it sets `WS_EX_TRANSPARENT`; on Linux it sets an empty input shape on the GTK window.

## Permissions

Expand Down Expand Up @@ -56,8 +58,10 @@ when the library is used as a submodule. The WebView2 runtime must be installed

## Status

- Windows: built and run with the example. The permission hook compiles with MinGW but hasn't been run on Windows yet.
- Linux: built and run with the example. `tests/linux_example_test.sh` and `tests/linux_permission_test.sh` check it.
- Windows: built and run with the example. The permission hook compiles with MinGW but hasn't been run on Windows yet. The
click-through test (`tests/windows_click_through_test.ps1`) is in `.github/workflows/windows-permissions.yml`; it hasn't run yet.
- Linux: built and run with the example. `tests/linux_example_test.sh`, `tests/linux_permission_test.sh` and
`tests/linux_click_through_test.sh` check it. The click-through test passes on X11.
- macOS: the window, its WKWebView, and the example's features are implemented in `platform/macos/`. The
`.github/workflows/macos.yml` workflow builds the library and example on a macOS runner. The `tests/macos_*.sh` scripts check the
window's behaviour on a Mac; CI only builds them.
5 changes: 5 additions & 0 deletions examples/main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
// --min-size <w> <h> the smallest size the user can resize the window to
// --startup-timeout <s> seconds the page has to report ready before the window fails (0 for no limit)
// --no-ready the built-in page never reports ready, so the window fails at the startup timeout
// --click-through the window passes mouse clicks through to the windows beneath it
// The state is one line: "visible=<0|1> open=<0|1> frame=<x>,<y>,<width>,<height> area=<x>,<y>,<width>,<height>". The frame is the
// window's rectangle on the screen in pixels, or "frame=none" when it has no native window. The area is the work area of the
// monitor the window is on, or "area=none".
Expand Down Expand Up @@ -81,6 +82,7 @@ struct Settings {
bool autosize = false;
bool invisible = false;
bool noReady = false;
bool clickThrough = false;
int minWidth = 0;
int minHeight = 0;
std::chrono::seconds startupTimeout = std::chrono::seconds(30);
Expand Down Expand Up @@ -177,6 +179,7 @@ class ExampleWindow : public WebViewWindow {
options.skipTaskbar = settings.skipTaskbar;
options.utility = settings.utility;
options.transparent = !settings.opaque;
options.clickThrough = settings.clickThrough;
options.titleBar = !settings.noTitleBar;
options.resizable = !settings.notResizable;
options.resizeEdges = settings.resizeEdges;
Expand Down Expand Up @@ -272,6 +275,8 @@ bool parseSettings(int argc, char** argv, Settings& settings) {
settings.utility = true;
} else if (arg == "--opaque") {
settings.opaque = true;
} else if (arg == "--click-through") {
settings.clickThrough = true;
} else if (arg == "--clear-page") {
settings.clearPage = true;
} else if (arg == "--no-titlebar") {
Expand Down
3 changes: 3 additions & 0 deletions include/WebViewWindow.h
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,9 @@ struct WindowOptions {
// The window's background is see-through, where the platform can show the desktop through it. Nothing is drawn behind the
// page, so the page fills whatever it wants drawn.
bool transparent = true;
// The window never takes mouse clicks: they pass through to whatever is beneath it. The page gets no input. It's fixed when the
// window opens, so it suits an overlay that's only ever seen, not used.
bool clickThrough = false;
// The page's hardware acceleration policy. Unset leaves WebKit's default in place.
std::optional<HardwareAcceleration> hardwareAcceleration;
// The folder WebView2 keeps its profile and caches in. Empty means a folder beside the executable.
Expand Down
20 changes: 20 additions & 0 deletions platform/linux/WebViewWindow.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,11 @@ struct GtkApi {
void (*widget_show)(GtkWidget*) = nullptr;
void (*widget_show_all)(GtkWidget*) = nullptr;
GdkWindow* (*widget_get_window)(GtkWidget*) = nullptr;
void (*widget_realize)(GtkWidget*) = nullptr;
// The input shape takes a cairo region, which the cairo library makes. Both come from the libraries opened at start.
void (*widget_input_shape_combine_region)(GtkWidget*, void*) = nullptr;
void* (*cairo_region_create)() = nullptr;
void (*cairo_region_destroy)(void*) = nullptr;
guint32 (*x11_server_time)(GdkWindow*) = nullptr;
void (*window_begin_resize_drag)(GtkWindow*, GdkWindowEdge, gint, gint, gint, guint32) = nullptr;
void (*window_begin_move_drag)(GtkWindow*, gint, gint, gint, guint32) = nullptr;
Expand Down Expand Up @@ -214,6 +219,13 @@ GtkApi loadApi() {
bind(api.widget_show, library, "gtk_widget_show");
bind(api.widget_show_all, library, "gtk_widget_show_all");
bind(api.widget_get_window, library, "gtk_widget_get_window");
bind(api.widget_realize, library, "gtk_widget_realize");
bind(api.widget_input_shape_combine_region, library, "gtk_widget_input_shape_combine_region");
// Cairo is the library GTK draws with, so it's there whenever GTK is. It's opened here for the one region the input shape needs.
if (void* cairo = dlopen("libcairo.so.2", RTLD_LAZY | RTLD_LOCAL)) {
bind(api.cairo_region_create, cairo, "cairo_region_create");
bind(api.cairo_region_destroy, cairo, "cairo_region_destroy");
}
// Only on X11. Without it the focus request carries no time, and the window manager may refuse it.
api.x11_server_time = reinterpret_cast<decltype(api.x11_server_time)>(dlsym(library, "gdk_x11_get_server_time"));
bind(api.widget_hide, library, "gtk_widget_hide");
Expand Down Expand Up @@ -513,6 +525,14 @@ void WebViewWindow::platformOpen() {
const RgbaColor clear{0, 0, 0, 0};
gtk.web_view_set_background_color(native.view, &clear);
}
if (options_.clickThrough && gtk.cairo_region_create) {
// An empty input shape means the window takes no pointer input, so clicks reach whatever is beneath it. The shape is set once
// the widget is realized, and GTK copies the region, so it's released straight after.
gtk.widget_realize(native.window);
void* empty = gtk.cairo_region_create();
gtk.widget_input_shape_combine_region(native.window, empty);
gtk.cairo_region_destroy(empty);
}
gtk.container_add(reinterpret_cast<GtkContainer*>(native.window), reinterpret_cast<GtkWidget*>(native.view));
gtk.g_signal_connect_data(native.view, "web-process-crashed", reinterpret_cast<GCallback>(onWebProcessCrashed), this,
nullptr, static_cast<GConnectFlags>(0));
Expand Down
4 changes: 4 additions & 0 deletions platform/windows/WebViewWindow.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -844,6 +844,10 @@ void WebViewWindow::platformOpen() {
// The window has no surface of its own, so what the composition draws over it is all that shows.
exStyle |= WS_EX_NOREDIRECTIONBITMAP;
}
if (options.clickThrough) {
// Hit testing skips the window, so mouse clicks reach whatever is beneath it.
exStyle |= WS_EX_TRANSPARENT;
}

native_.reset(new NativeWindow);
NativeWindow* native = native_.get();
Expand Down
68 changes: 68 additions & 0 deletions tests/linux_click_through_test.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
#!/usr/bin/env bash
# Checks that a window opened with clickThrough passes the pointer through to the windows beneath it. The pointer is moved over the
# middle of the example's window, and the window the X server reports under it must not be the example's. The control runs the same
# check without --click-through, where the example's window must be the one under the pointer. Every wait is at most 10 seconds.
#
# The check uses xdotool, so the test needs an X display.
#
# Usage: tests/linux_click_through_test.sh [build-dir]
set -euo pipefail

source "$(dirname "$0")/linux_common.sh"

# The window the X server reports under the pointer, as a hexadecimal id, or "none" when the query gives nothing.
window_under_pointer() {
local px="$1" py="$2" id
xdotool mousemove --sync "$px" "$py"
id="$(xdotool getmouselocation --shell | sed -n 's/^WINDOW=//p')"
echo "${id:-none}"
}

# The example's own window, by its title. Empty when it isn't on screen.
example_window_id() {
xdotool search --onlyvisible --name "^${title}$" 2>/dev/null | head -n 1
}

# The pointer's target: the middle of the example's frame, from the example's report.
pointer_target() {
local x y w h
IFS=, read -r x y w h <<< "$(frame_now)"
echo "$((x + w / 2)) $((y + h / 2))"
}

# Both runs use one build: the given build directory, or the one start_example makes in the work folder.
given_build="${1:-}"
build_dir="${given_build:-$work/build}"

start_example "$given_build" --click-through

if wait_for_line_after 0 '^loaded$'; then pass "page loaded"; else fail "page never reported loaded"; fi
if wait_for_window shown; then pass "window is shown"; else fail "window never appeared"; fi

read -r px py <<< "$(pointer_target)"
own="$(example_window_id)"
under="$(window_under_pointer "$px" "$py")"
if [[ -n "$own" && "$under" != "none" && "$under" != "$own" ]]; then
pass "with --click-through, the pointer over the window reaches the window beneath it ($under, not $own)"
else
fail "with --click-through, the pointer over the window reached the example's window: under=$under own=$own"
fi
stop_example

# The control: the same window without clickThrough takes the pointer itself.
start_example "$build_dir"

if wait_for_line_after 0 '^loaded$'; then pass "control page loaded"; else fail "control page never reported loaded"; fi
if wait_for_window shown; then pass "control window is shown"; else fail "control window never appeared"; fi

read -r px py <<< "$(pointer_target)"
own="$(example_window_id)"
under="$(window_under_pointer "$px" "$py")"
if [[ -n "$own" && "$under" == "$own" ]]; then
pass "without --click-through, the example's window is under the pointer"
else
fail "without --click-through, the window under the pointer is $under, not the example's $own"
fi
stop_example

finish
61 changes: 61 additions & 0 deletions tests/windows_click_through_test.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Checks that a window opened with clickThrough passes the pointer through to the windows beneath it. The pointer is moved over the
# middle of the example's window, and the top-level window that hit testing finds there must not be the example's. The control runs
# the same check without --click-through, where the example's window must be the one under the pointer. Every wait is at most 10
# seconds.
#
# The pointer is moved with SetCursorPos, so the test needs an interactive desktop.
#
# Usage: tests/windows_click_through_test.ps1 [-BuildDir <build-dir>]
param([string]$BuildDir = "")

. "$PSScriptRoot\windows_common.ps1"

# The pointer's target: the middle of the example's frame, from its report.
function Get-PointerTarget {
$x, $y, $w, $h = Split-Rect (Get-FrameNow)
return @(($x + [math]::Floor($w / 2)), ($y + [math]::Floor($h / 2)))
}

try {
# Both runs use one build: the given build directory, or the one Start-Example makes in the work folder.
$build = if ($BuildDir) { $BuildDir } else { Join-Path $script:work "build" }

Start-Example -BuildDir $BuildDir -Arguments @("--click-through")

if (Wait-ForLineAfter 0 '^loaded$') { Pass "page loaded" } else { Fail "page never reported loaded" }
if (Wait-ForWindow "shown") { Pass "window is shown" } else { Fail "window never appeared" }

$px, $py = Get-PointerTarget
[WebViewTestNative]::MovePointer($px, $py)
Start-Sleep -Milliseconds 200
$own = Get-ExampleWindow
$under = [WebViewTestNative]::TopLevelAt($px, $py)
if (($under -ne [IntPtr]::Zero) -and (-not $under.Equals($own))) {
Pass "with --click-through, the pointer over the window reaches the window beneath it"
} else {
Fail "with --click-through, the pointer over the window reached the example's window: under=$under own=$own"
}
Stop-Example

# The control: the same window without clickThrough takes the pointer itself.
Start-Example -BuildDir $build

if (Wait-ForLineAfter 0 '^loaded$') { Pass "control page loaded" } else { Fail "control page never reported loaded" }
if (Wait-ForWindow "shown") { Pass "control window is shown" } else { Fail "control window never appeared" }

$px, $py = Get-PointerTarget
[WebViewTestNative]::MovePointer($px, $py)
Start-Sleep -Milliseconds 200
$own = Get-ExampleWindow
$under = [WebViewTestNative]::TopLevelAt($px, $py)
if (($own -ne [IntPtr]::Zero) -and $under.Equals($own)) {
Pass "without --click-through, the example's window is under the pointer"
} else {
Fail "without --click-through, the window under the pointer is $under, not the example's $own"
}
Stop-Example
} finally {
Remove-Harness
}

Finish
20 changes: 20 additions & 0 deletions tests/windows_common.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,16 @@ public static class WebViewTestNative {
private static extern bool SetCursorPos(int x, int y);
[DllImport("user32.dll")]
private static extern void mouse_event(uint flags, uint dx, uint dy, uint data, UIntPtr extraInfo);
[DllImport("user32.dll")]
private static extern IntPtr WindowFromPoint(POINT point);
[DllImport("user32.dll")]
private static extern IntPtr GetAncestor(IntPtr window, uint flags);

[StructLayout(LayoutKind.Sequential)]
private struct POINT {
public int X;
public int Y;
}

// The top-level window of a process with the title, shown or hidden, or IntPtr.Zero.
public static IntPtr FindWindow(uint processId, string title) {
Expand Down Expand Up @@ -83,6 +93,16 @@ public static class WebViewTestNative {
SetCursorPos(x, y);
}

// The top-level window that hit testing finds at the screen point, skipping windows that are click-through, or IntPtr.Zero.
public static IntPtr TopLevelAt(int x, int y) {
const uint gaRoot = 2;
POINT point;
point.X = x;
point.Y = y;
IntPtr window = WindowFromPoint(point);
return window == IntPtr.Zero ? IntPtr.Zero : GetAncestor(window, gaRoot);
}

// The left button, pressed or released where the pointer is.
public static void SetLeftButton(bool down) {
const uint leftDown = 0x0002;
Expand Down
Loading