mirror of https://github.com/wailsapp/wails.git synced 2026-03-14 14:45:49 +01:00

Lea Anthony 5dc3e21699

feat(linux): GTK4 + WebKitGTK 6.0 support (opt-in via -tags gtk4) (#4958 )

* chore: add WebKitGTK 6.0/GTK4 epic and beads issue tracking

Initialize beads (bd) issue tracker with comprehensive epic for
WebKitGTK 6.0 / GTK4 support as the new default for Wails v3 Linux.

Epic: wails-webview2gtk6-t4e (40 tasks)
- GTK4/WebKit6 as default (no build tag needed)
- GTK3/WebKit4.1 via -tags gtk3 for legacy
- Docker container with both library sets for cross-compilation
- Comprehensive test strategy including benchmarks
- task build:linux (GTK4) and task build:linux:gtk3 (legacy)

* feat(linux): add WebKitGTK 6.0 / GTK4 support infrastructure [WIP]

Architecture change for modern Linux desktop support:
- GTK4/WebKitGTK 6.0 is the new DEFAULT (no build tag)
- GTK3/WebKit2GTK 4.1 is LEGACY (requires -tags gtk3)

Changes:
- Add gtk3 build constraint to existing GTK3 CGO files
- Create GTK4 stub implementations (linux_cgo_gtk4.go, application_linux_gtk4.go)
- Create WebKitGTK 6.0 asset server stubs (webkit6.go, request/responsewriter)

Known limitations (documented):
- Window positioning is NO-OP on GTK4/Wayland (protocol limitation)
- Menu system needs GMenu/GAction rewrite (stub only)
- Some methods have TODO markers for full implementation

This establishes the build infrastructure for GTK4 support.
Full implementation requires GTK4 dev environment for testing.

* docs: add implementation tracker for WebKitGTK 6.0/GTK4 work

- Create IMPLEMENTATION.md to track progress, decisions, and API differences
- Update AGENTS.md with instructions to maintain IMPLEMENTATION.md
- Document Phase 1 completion and remaining phases

* feat(linux): update doctor and capabilities for GTK4/WebKitGTK 6.0 support

- Update all 7 package managers (apt, dnf, pacman, zypper, emerge, eopkg, nixpkgs)
  to check for GTK4/WebKitGTK 6.0 as primary dependencies
- Mark GTK3/WebKit2GTK packages as optional/legacy
- Add GTKVersion and WebKitVersion fields to Capabilities struct
- Create capabilities_linux_gtk3.go for legacy build path
- Update IMPLEMENTATION.md to mark Phase 2 complete

GTK4 packages are now checked by default. Legacy GTK3 packages
are marked optional and only needed when building with -tags gtk3.

* feat(linux): implement GTK4 window management and event handling

- Add GtkEventController-based event handling for GTK4:
  - GtkEventControllerFocus for focus in/out
  - GtkGestureClick for button press/release
  - GtkEventControllerKey for keyboard events
- Implement window drag/resize using GdkToplevel API
- Add complete drag-and-drop support with GtkDropTarget
- Fix window state detection (minimized, maximized, fullscreen)
- Fix size() to properly return window dimensions in GTK4
- Update IMPLEMENTATION.md to mark Phase 3 complete

GTK4 uses a fundamentally different event model with controllers
instead of direct signal handlers. This commit implements all the
necessary event handling for window management.

* feat(linux): implement GTK4 menu system with GMenu/GAction

Phase 4 of WebKitGTK 6.0/GTK4 implementation.

GTK4 completely replaces the menu system. GTK3's GtkMenu/GtkMenuItem
are replaced by:
- GMenu: Menu model (data structure, not a widget)
- GMenuItem: Individual menu item in the model
- GSimpleAction: Action triggered when menu item is activated
- GSimpleActionGroup: Container for actions, attached to widgets
- GtkPopoverMenuBar: Menu bar widget created from GMenu model

Key changes:
- linux_cgo_gtk4.go: Added C helpers and Go functions for GMenu/GAction
  - menuActionActivated() callback for action triggers
  - menuItemNewWithId/menuCheckItemNewWithId/menuRadioItemNewWithId
  - set_action_enabled/set_action_state for state management
- menu_linux_gtk4.go: GTK4 menu processing (processMenu, addMenuItem)
- menuitem_linux_gtk4.go: GTK4 menu item handling and role menus
- menu_linux.go: Added gtk3 build tag
- menuitem_linux.go: Added gtk3 build tag

Deferred to future work:
- Context menus with GtkPopoverMenu
- Keyboard accelerators with GtkShortcut

* feat(linux): add missing CGO exports for GTK4 asset server

Phase 5 of WebKitGTK 6.0/GTK4 implementation.

The GTK4 CGO file was missing two critical exports that existed in the
GTK3 version:

1. onProcessRequest - Handles WebKit URI scheme requests. This callback
   is registered with webkit_web_context_register_uri_scheme and routes
   asset requests to the webviewRequests channel for processing.

2. sendMessageToBackend - Handles JavaScript to Go communication. This
   is called when JavaScript sends messages via the webkit user content
   manager, enabling the IPC bridge.

The asset server files (webkit6.go, request_linux_gtk4.go,
responsewriter_linux_gtk4.go) were already complete from Phase 1.
WebKitGTK 6.0 uses the same URI scheme handler API as WebKitGTK 4.1.

* build(linux): add GTK4 support to Docker and Taskfile

Phase 6 of WebKitGTK 6.0/GTK4 implementation.

Docker containers (Ubuntu 24.04):
- Install both GTK4/WebKitGTK 6.0 (default) and GTK3/WebKit2GTK 4.1 (legacy)
- Build scripts support BUILD_TAGS environment variable
- Default build uses GTK4, BUILD_TAGS=gtk3 uses legacy GTK3

Taskfile targets:
- test:example:linux - Build with GTK4 (default)
- test:example:linux:gtk3 - Build with GTK3 (legacy)
- test:examples:linux:docker:x86_64 - Docker build with GTK4
- test:examples:linux:docker:x86_64:gtk3 - Docker build with GTK3
- test:examples:linux:docker:arm64 - Docker build with GTK4 (ARM64)
- test:examples:linux:docker:arm64:gtk3 - Docker build with GTK3 (ARM64)

This allows testing both the new GTK4 default and legacy GTK3 builds.

* feat(linux): implement GTK4 dialog system with GtkFileDialog and GtkAlertDialog

Phase 8 of WebKitGTK 6.0/GTK4 implementation.

GTK4 completely replaced the dialog APIs. GTK3's GtkFileChooserDialog
and gtk_dialog_run() are deprecated/removed in GTK4.

File Dialogs (GtkFileDialog):
- gtk_file_dialog_open() for single file selection
- gtk_file_dialog_open_multiple() for multiple files
- gtk_file_dialog_select_folder() for folder selection
- gtk_file_dialog_save() for save dialogs
- Filters use GListStore of GtkFileFilter objects
- All operations are async with GAsyncResult callbacks

Message Dialogs (GtkAlertDialog):
- gtk_alert_dialog_choose() with button array
- Configurable default and cancel button indices
- Async response via callback

Implementation:
- Request ID tracking for async callback matching
- fileDialogCallback/alertDialogCallback C exports
- runChooserDialog/runQuestionDialog Go wrappers
- runOpenFileDialog/runSaveFileDialog convenience functions

* feat(linux): implement GTK4 keyboard accelerators for menu items

Add keyboard accelerator support using gtk_application_set_accels_for_action():

- Add namedKeysToGTK map with GDK keysym values for special keys
- Add parseKeyGTK() to convert key names to GDK keysyms
- Add parseModifiersGTK() to convert Wails modifiers to GDK modifier masks
- Add acceleratorToGTK() for full accelerator conversion
- Add setMenuItemAccelerator() Go wrapper calling C helpers
- Integrate accelerator setting in newMenuItemImpl, newCheckMenuItemImpl,
  and newRadioMenuItemImpl during menu item creation
- Update setAccelerator() method on linuxMenuItem to use new function

Completes Phase 9 of GTK4 implementation.

* refactor(linux): extract GTK4 C code to separate files and fix WebKitGTK 6.0 API

Extract C code from linux_cgo_gtk4.go to dedicated C files for better
IDE support and maintainability:
- linux_cgo_gtk4.h: Function declarations and type definitions
- linux_cgo_gtk4.c: C implementations for GTK4/WebKitGTK 6.0

WebKitGTK 6.0 API fixes:
- webkit_web_view_new_with_user_content_manager() removed
  -> Use create_webview_with_user_content_manager() with g_object_new()
- WEBKIT_HARDWARE_ACCELERATION_POLICY_ON_DEMAND removed
  -> Default to ALWAYS (only ALWAYS/NEVER available in 6.0)
- WebKitJavascriptResult replaced with JSCValue in callbacks
  -> sendMessageToBackend now receives JSCValue* directly

Also:
- Remove duplicate show()/hide() methods (use shared file)
- Remove duplicate startResize() (wrong signature)
- Add set_app_menu_model() setter for C global variable access
- Fix webview.Scheme reference to use hardcoded 'wails' string

Note: Some pre-existing compilation errors remain in the codebase
that are unrelated to this refactoring.

* fix(linux): resolve GTK4 compilation errors and add missing platform methods

- Add missing App methods: logPlatformInfo, platformEnvironment, fatalHandler
- Add missing linuxApp methods: hide, show, on, isOnMainThread, getAccentColor
- Add missing CGO functions: getPrimaryScreen, openDevTools, enableDevTools, handleLoadChanged
- Fix options.Linux nil check (struct not pointer)
- Fix runSaveFileDialog return type to match interface
- Fix registerWindow signature to accept pointer type
- Fix GdkRGBA to use float instead of double
- Add webview import for asset request handling
- Add sanity check task to Taskfile for quick compilation verification

* fix(linux): resolve GTK3/GTK4 symbol conflict in operatingsystem package

- Add gtk3 build tag to webkit_linux.go to prevent GTK3 linking in GTK4 builds
- Create webkit_linux_gtk4.go with GTK4/WebKitGTK 6.0 pkg-config
- Move app initialization from init() to newPlatformApp() for cleaner setup
- Fixes runtime crash: 'GTK 2/3 symbols detected in GTK 4 process'

* docs: update implementation tracker for GTK3/GTK4 symbol conflict fix

* fix(linux): add GTK4 activation gate to prevent window creation before app activation

GTK4 requires the application to be 'activated' before gtk_application_window_new()
can be called. This adds a synchronization mechanism:

- Add activated channel and sync.Once to linuxApp struct
- Mark application as activated in activateLinux callback
- Wait for activation in WebviewWindow.Run() before creating windows

Fixes SIGSEGV crash when creating windows on GTK4.

* feat(linux): add primary menu style option and fix GTK4 menu issues

- Add LinuxMenuStyle option for MenuBar vs PrimaryMenu (hamburger) display
- Fix menu separators using GMenu sections instead of separator items
- Fix radio button styling with proper string-valued stateful actions
- Fix app not terminating when last window closed
- Fix Window→Zoom to toggle maximize instead of webview zoom
- Add build constraints to .c/.h files for GTK3 compatibility
- Document MenuStyle option in window reference docs
- Update implementation tracker with session changes

* chore(examples): use PrimaryMenu style in menu example

* feat(linux): implement Systray API v2 with smart defaults and window options

- Add smart defaults for systray click behavior:
  - Window only: left-click toggles window
  - Menu only: right-click shows menu
  - Window + Menu: left-click toggles, right-click shows menu

- Add HideOnEscape and HideOnFocusLost window options:
  - HideOnEscape: hides window when Escape key pressed
  - HideOnFocusLost: hides window on focus lost (auto-disabled on
    focus-follows-mouse WMs like Hyprland, Sway, i3)

- Add WebviewWindow.RegisterKeyBinding() public method

- Fix Linux systray handlers:
  - Activate() now calls clickHandler (was doubleClickHandler)
  - SecondaryActivate() calls rightClickHandler or opens menu
  - ItemIsMenu always false to let handlers control behavior

- Add environment_linux.go with compositor detection:
  - detectCompositor(), detectFocusFollowsMouse(), isTilingWM()
  - Cursor position detection for Hyprland/Sway

- Add comprehensive manual test suite in v3/test/manual/systray/
  - window-only, menu-only, window-menu, custom-handlers, hide-options
  - Builds for both GTK3 and GTK4
  - README with test matrix for different environments

- Update systray-basic example to use new options

* feat: add doctor-ng package with modern TUI for system diagnostics

Introduces a new pkg/doctor-ng package with a clean public API designed
for reuse by both CLI and future GUI tools. Features include:

- Public API types (Report, SystemInfo, Dependency, DiagnosticResult)
- Platform-specific dependency detection (Linux, macOS, Windows)
- Package manager support (apt, dnf, pacman, emerge, eopkg, nixpkgs, zypper)
- Modern TUI using bubbletea/lipgloss with:
  - Interactive dependency navigation (j/k keys)
  - Install missing dependencies prompt (i key)
  - Refresh/rescan capability (r key)
- Non-interactive mode for CI/scripts (-n flag)

The new command is available as 'wails3 doctor-ng' for testing while
the existing 'wails3 doctor' command remains unchanged.

* fix(doctor-ng): stabilize display order, conditional cursor, add copy to clipboard

- Sort platform extras alphabetically to prevent bouncing
- Only show dependency cursor when there are missing deps to act on
- Add 'c' key to copy sanitized report to clipboard
- Update help text to be contextual based on system state

* feat(doctor-ng): add package manager detection for macOS/Windows, remove unused code

- macOS: detect homebrew, macports, nix; show in platform extras
- Windows: detect winget, scoop, choco; show in platform extras
- Remove unused tui/install.go (replaced by tea.ExecProcess)
- Remove unused stateInstall/viewInstall from model.go
- Remove j/k navigation from help (cursor was already removed)

* feat(cli): add wails3 tool capabilities command

Checks system build capabilities via pkg-config:
- GTK4 and WebKitGTK 6.0 availability
- GTK3 and WebKit2GTK 4.1 availability
- Recommends gtk4 or gtk3 based on what's installed

Output is JSON for easy parsing by Taskfile/scripts.

* fix(linux/gtk4): avoid checkptr errors when building with -race

Go's race detector enables checkptr, which flags storing integers
as pointers (a common GLib/C pattern using GINT_TO_POINTER).

Changes:
- Change signal_connect to accept uintptr_t instead of void* for data
- Change enableDND/disableDND to accept uintptr_t instead of gpointer
- Replace unsafe.Pointer(uintptr(id)) with C.uintptr_t(id) in Go code
- Replace g_object_set/get_data for menu item IDs with Go-side map
- Pass 0 instead of nil for unused signal data parameters

This allows building with 'go build -race' for debugging without
triggering 'checkptr: pointer arithmetic computed bad pointer value'
fatal errors.

* fix(examples/dialogs): use window menu for GTK4 compatibility

GTK4 requires menus to be set on windows, not the application.
Use LinuxMenuStylePrimaryMenu to show menu in header bar.

* test(linux): add manual dialog test suite

Comprehensive test programs for GTK4 dialogs:
- message-info, message-question, message-warning, message-error
- file-open, file-open-multi, file-save, file-directory

Each test has multiple test cases accessible via menu.
Use 'go-task build:gtk4' or 'go-task build:gtk3' to build.

* fix(linux/gtk4): fix file dialog hang by not prematurely freeing dialog

GtkFileDialog is async - gtk_file_dialog_select_folder() returns
immediately and the callback fires later. The defer g_object_unref
was freeing the dialog before the user could interact with it.

GTK manages the dialog lifecycle internally for async operations.

* fix: add mutex to protect runtimeLoaded and pendingJS from races

Multiple goroutines access runtimeLoaded and pendingJS concurrently:
- ExecJS reads/writes from window event handlers
- HandleMessage writes when runtime becomes ready
- InitiateFrontendDropProcessing reads/writes during drag-drop

Added pendingJSMutex to synchronize access. Also changed HandleMessage
to copy pending slice before releasing lock to avoid holding it during
InvokeSync calls.

* fix(linux/gtk4): fix dialog deadlock and alert dialog lifecycle

- dialogs_linux.go: Change InvokeAsync to go func() to prevent deadlock
  when show() is called - runQuestionDialog uses InvokeAsync internally
  and blocks on channel, which deadlocks if caller is also using InvokeAsync
- linux_cgo_gtk4.c: Remove premature g_object_unref from show_alert_dialog
  as GtkAlertDialog is async and GTK manages the lifecycle
- linux_cgo_gtk4.c: Add DEBUG_LOG macro for compile-time debug output
  (CGO_CFLAGS="-DWAILS_GTK_DEBUG" go build ...)
- linux_cgo_gtk4.c: Handle cancelled-with-no-error case in file dialogs
- linux_cgo_gtk4.go: Fix runQuestionDialog to use options.Title as message
- linux_cgo_gtk4.go: Add default OK button when no buttons specified

* feat(linux/gtk4): implement custom message dialogs with proper styling

GTK4's GtkAlertDialog lacks icon support and visual differentiation.
This implements a custom GtkWindow-based dialog with:

- Escape key triggers cancel button via GtkEventControllerKey
- Enter key activates default button via gtk_window_set_default_widget
- Custom icons from bytes with gtk_image_set_pixel_size (64px max)
- Symbolic icons for info/warning/error/question dialogs
- 300px minimum width for better short message appearance
- Proper memory cleanup via message_dialog_cleanup()
- close-request returns cancel button index or -1

* fix(linux/gtk4): use native size for custom dialog icons

Custom icons now display at their native size.
Built-in symbolic icons remain at 32px as designed.

* fix(linux/gtk4): implement native file drag-and-drop

Use GtkDropControllerMotion and GtkDropTarget with GTK_PHASE_CAPTURE
to intercept file drops before WebKit's internal GtkDropTargetAsync
handler in the bubble phase.

- Add on_drop_accept to filter for GDK_TYPE_FILE_LIST
- Add motion controller for enter/leave/motion events
- Set capture phase so our handlers run before WebKit's
- Both controllers attached to WebKitWebView widget

* docs: update implementation tracker and dialog docs

- Update IMPLEMENTATION.md with GTK4 dialog progress
- Add GTK4 dialog documentation to reference docs
- Fix RLock -> Lock in cleanup to allow window modification
- Simplify manual dialog test menus (remove nested submenus)

* fix(linux/gtk4): parse runtime call params from query string

WebKitGTK 6.0 sends POST data as URL query parameters for custom URI
schemes instead of in the request body. Add fallback to parse object,
method, and args from query params when body is empty.

* fix(linux): fallback to application menu when no window menu set

Windows without an explicit Linux.Menu option now inherit the
application-level menu set via app.Menu.Set().

* fix(linux/gtk4): implement sync clipboard API

GTK4 uses async clipboard operations. Implement clipboard_get_text_sync
which iterates the GLib main context until the async read completes.
This avoids deadlock when called from the main thread (e.g., menu handlers).

* fix(linux/gtk4): DPI scaling and menu duplication fixes

- Implement proper DPI scaling using gdk_monitor_get_scale (GTK 4.14+)
  for fractional scaling support on Linux/GTK4
- Calculate PhysicalBounds correctly by multiplying logical coords by scale
- Fix menu items duplicating when creating new windows by adding
  processed flag to prevent re-processing menus
- Add safe type assertion helpers in screen example to prevent crashes
- Add CSS to prevent text selection during drag in screen example
- Document tiling WM limitations (Hyprland, Sway, i3) in official docs

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(tests): add GTK3 vs GTK4 benchmark suite

Add comprehensive benchmark suite for comparing GTK3 and GTK4 performance
in Wails applications. Benchmarks cover:

- Screen enumeration and primary screen query
- Window create/destroy, resize, show/hide operations
- Menu creation (simple, complex, with accelerators)
- Event emit and receive timing
- Dialog setup

Includes comparison tool for side-by-side analysis of results.

Usage:
  go build -tags gtk3 -o benchmark-gtk3 .
  go build -tags gtk4 -o benchmark-gtk4 .
  ./benchmark-gtk3 && ./benchmark-gtk4
  go run compare.go benchmark-GTK3-*.json benchmark-GTK4-*.json

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(examples): add WebView API compatibility checker

Cross-platform example that tests and reports which Web APIs are
available in the current WebView engine. Tests 200+ APIs across
categories:

- Storage (localStorage, IndexedDB, Cache API, File System)
- Network (Fetch, WebSocket, WebTransport, SSE)
- Media (Web Audio, MediaRecorder, Speech APIs)
- Graphics (Canvas, WebGL, WebGL2, WebGPU)
- Device (Geolocation, Sensors, Bluetooth, USB, Serial)
- Workers (Web Workers, Service Workers, Shared Workers)
- Performance (Observers, Timing APIs)
- Security (Web Crypto, WebAuthn, Credentials)
- UI/DOM (Custom Elements, Shadow DOM, Clipboard)
- CSS (CSSOM, Container Queries, Modern Selectors)
- JavaScript (ES Modules, BigInt, Private Fields)

Useful for understanding API availability differences between:
- WebKitGTK (Linux) vs WebView2 (Windows) vs WKWebView (macOS)
- GTK3/WebKit2GTK 4.1 vs GTK4/WebKitGTK 6.0

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(examples): add Web API examples demonstrating browser capabilities

Add 15 interactive Web API examples in v3/examples/web-apis/:
- Storage: localStorage, IndexedDB
- Network: Fetch API, WebSocket
- Media: Canvas 2D, WebGL, Web Audio
- Device: Geolocation, Clipboard, Fullscreen
- Security: WebCrypto
- Notifications API
- Workers: Web Workers
- Observers: Intersection Observer, Resize Observer

Each example includes an interactive demo with API documentation
and feature detection to help developers understand what's
available in WebView environments.

Also updates webview-api-check with autorun support for
automated API compatibility testing.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(examples): add 26 more Web API examples

Expand web-apis examples from 15 to 41 total, covering:

Storage: sessionStorage, Cache API, Page Visibility
Network: XMLHttpRequest, EventSource (SSE), Beacon API
Media: MediaDevices, MediaRecorder, Speech Synthesis
Device: Device Orientation, Vibration, Gamepad
Performance: Performance API, Mutation Observer
UI/DOM: Web Components, Pointer Events, Selection, Dialog
Messaging: Drag and Drop, Broadcast Channel, History API
Data: Streams, File API, Blob, Share, Permissions

Each example includes interactive demos, API detection,
and follows the consistent dark-themed styling pattern.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: update changelog with full web-api examples count

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor(examples): simplify beacon demo with local server

Replace the complex beacon demo with a simpler version that includes:
- Local HTTP server on port 9999 that receives beacon data
- Go service to retrieve and display received beacons
- Quick buttons for common beacon types (pageview, click, error, timing)
- Live display of received beacon data with auto-refresh
- Clear explanation of how the demo works

This makes the demo more educational by showing both the sending
and receiving sides of the Beacon API.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor(examples): streamline beacon demo UI

Revert to original standalone implementation with httpbin.org endpoint
but with a compact two-column layout that fits without scrolling:
- Left: endpoint config, data type selector, data input, example buttons
- Right: stats (sent/queued/failed/bytes), auto-unload option, event log

Features retained: String/JSON/FormData/Blob data types, analytics/error/
timing examples, auto-beacon on page unload.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor(examples): streamline blob demo with tabbed layout

Redesign blob demo to fit without scrolling using:
- Three-column layout: Create | Stored Blobs | Output
- Tabbed interface for blob creation (Text/JSON/Binary/SVG)
- Compact blob list with download and delete actions
- Operations panel for conversions and slicing
- Feature badges showing API support status

Reduced from 846 lines to 349 lines while keeping core functionality.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(examples): fix dropdown styling in blob demo

Style select option elements with dark background to match theme.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(examples): add MDN links to demo titles

Link API names in titles to their MDN documentation pages.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor(examples): streamline broadcast-channel with Wails windows

Redesign broadcast-channel demo for Wails environment:
- Replace browser tabs with Wails windows via WindowService
- Compact two-column layout: Channel/Send | Messages
- "Open New Window" button creates new Wails window
- Each window gets unique ID for message tracking
- Join/leave notifications when windows open/close
- Quick message buttons, ping all, stats display
- MDN link in title

Reduced from 737 lines to 245 lines.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(examples): simplify broadcast-channel to use multiple app instances

Remove WindowService that required generated bindings. Instead, instruct
users to run multiple instances of the app to test cross-window messaging.
BroadcastChannel API works across windows of the same origin.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(examples): add API feature badges to broadcast-channel demo

Show supported features: BroadcastChannel, postMessage, close,
onmessage, onmessageerror, MessageChannel - consistent with other demos.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(examples): add multi-window support to broadcast-channel demo

Use Wails runtime.js and WindowService to open new windows for
cross-window BroadcastChannel API testing. Streamlined UI with
feature detection badges and MDN link.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(linux): make GTK4 opt-in via -tags gtk4, keep GTK3 as default

This change inverts the build tag logic so that:
- GTK3/WebKit2GTK 4.1 is the stable default (no tag required)
- GTK4/WebKitGTK 6.0 is experimental opt-in via `-tags gtk4`

This allows the branch to be merged into v3-alpha without breaking
existing apps, while enabling early adopters to test GTK4 support.

Changes:
- Updated 20 Go files: `gtk3` → `!gtk4`, `!gtk3` → `gtk4`
- Updated IMPLEMENTATION.md to reflect new build strategy
- Updated benchmark README with correct build commands
- Added GTK4_FEEDBACK_ISSUE.md template for community testing
- Added Armaan's signing guide link to docs

Build commands after this change:
  go build ./v3/...            # GTK3 (default)
  go build -tags gtk4 ./v3/... # GTK4 (experimental)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor(linux): rename capabilities files to follow naming convention

Renamed for consistency with other GTK3/GTK4 file pairs:
- capabilities_linux.go (default, GTK3)
- capabilities_linux_gtk4.go (opt-in, GTK4)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(linux/gtk4): add experimental notice with feedback issue link

When building with -tags gtk4, the app now displays a notice at startup
directing users to the feedback issue for reporting problems.

Issue: https://github.com/wailsapp/wails/issues/4957

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* ci(linux): add GTK4 testing for webkit-gtk6-support branch

- Fix box alignment in experimental notice
- Add GTK4 dependency installation for this branch only
- Run Go tests with both default (GTK3) and -tags gtk4
- Build examples with both GTK versions
- Build templates with both GTK versions

The GTK4 tests only run when PR source branch is feature/webkit-gtk6-support.
This ensures existing PRs are not affected while enabling full GTK4 CI coverage.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(doctor): make GTK3 primary, GTK4 experimental in package checks

Updated all 7 package managers to match new build tag strategy:
- GTK3/WebKit2GTK 4.1 → primary (required for default builds)
- GTK4/WebKitGTK 6.0 → optional/experimental (for -tags gtk4)

Affected: apt, dnf, pacman, zypper, emerge, eopkg, nixpkgs

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs(dialogs): fix GTK3/GTK4 documentation to reflect default behavior

GTK3 is the default, GTK4 is opt-in via -tags gtk4. Updated the dialogs
documentation to clarify this instead of suggesting GTK3 is opt-in.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(examples): escape HTML in web-apis examples to prevent DOM XSS

Add escapeHtml() helper function and escape all user-controlled or
dynamic values before inserting them into innerHTML to address CodeQL
security alerts.

Files fixed:
- beacon: escape log type, message, and class names
- eventsource: escape time and type in log entries
- file-api: escape file name, size, and type
- mediadevices: escape time, type, and message in log entries
- selection: escape text content before applying highlight regex
- share: escape file name, size, and type in file list
- speech-synthesis: escape time, type, and message in log entries
- web-components: escape title and color in shadow DOM template

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(linux): correct GTK4 build tags and Taskfile for GTK3 default

- Fix build tags in linux_cgo_gtk4.c and linux_cgo_gtk4.h from
  `!gtk3` to `gtk4` to match the Go file constraints
- Update Taskfile.yaml to reflect GTK3 as default, GTK4 as opt-in
- Rename test:example:linux:gtk3 to test:example:linux:gtk4
- Comment out GTK4 tests in test:examples since CI doesn't have GTK4 deps

This fixes the CI failure where GTK4 C files were being compiled
by default due to incorrect build constraints.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(systemtray): add missing defaultClickHandler method

Add the defaultClickHandler method that was in v3-alpha but not
properly merged. This method is called from systemtray_darwin.go
when handling tray icon clicks.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(tests): add linux build constraint to gtk4-benchmark

The gtk4-benchmark test is Linux-only but was missing a build
constraint on main.go, causing build failures on macOS/Windows.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* ci(linux): skip hanging GTK4 service tests in CI

The service startup/shutdown tests hang in GTK4 CI environment due to
display initialization issues with xvfb. Skip these specific tests for
now while keeping other GTK4 tests running.

Skipped tests:
- TestServiceStartup
- TestServiceShutdown
- TestServiceStartupShutdown

The *Error variants of these tests still run as they fail fast before
the hang occurs.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* ci(linux): skip all service tests for GTK4 in CI

All service tests hang in GTK4 CI because they require a fully
functional GTK4 display that xvfb cannot provide. Skip all tests
matching "TestService" pattern.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* ci(linux): remove unsupported GTK4 template build test

The wails build command doesn't support the -tags flag yet.
GTK4 compilation is already verified by Go tests, so this
additional template build step is not necessary.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Fix Copilot review feedback on PR #4958

- Use JSON.stringify() for onclick handlers in storage examples to safely
  handle keys with quotes (sessionstorage, localstorage)
- Guard DeviceOrientationEvent check to prevent ReferenceError on
  unsupported browsers (device-orientation)
- Add type assertion check for Bounds to prevent panic on malformed
  JSON (screens.go)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>

2026-02-06 21:55:45 +11:00

24 KiB

Raw Permalink Blame History

WebKitGTK 6.0 / GTK4 Implementation Tracker

Overview

This document tracks the implementation of WebKitGTK 6.0 (GTK4) support for Wails v3 on Linux.

Goal: Provide GTK4/WebKitGTK 6.0 support as an EXPERIMENTAL opt-in via -tags gtk4, while maintaining GTK3/WebKit2GTK 4.1 as the stable default.

Architecture Decisions

Decision 1: GTK3 as Default, GTK4 Opt-In (2026-02-04)

Context: Need to support modern Linux distributions with GTK4 while maintaining stability for existing apps.

Decision: GTK3 remains the stable default (no build tag required). GTK4 is available as experimental via -tags gtk4.

Rationale:

GTK3/WebKit2GTK 4.1 is battle-tested and widely deployed
GTK4 support needs more community testing before becoming default
Allows gradual migration and feedback collection
Protects existing apps from unexpected breakage

Build Tags:

Default (no tag): //go:build linux && cgo && !gtk4 && !android
Experimental GTK4: //go:build linux && cgo && gtk4 && !android

Decision 2: pkg-config Libraries (2026-01-04)

GTK4/WebKitGTK 6.0:

#cgo linux pkg-config: gtk4 webkitgtk-6.0 libsoup-3.0

GTK3/WebKit2GTK 4.1 (legacy):

#cgo linux pkg-config: gtk+-3.0 webkit2gtk-4.1 libsoup-3.0

Decision 3: Wayland Window Positioning (2026-01-04)

Context: GTK4/Wayland doesn't support arbitrary window positioning - this is a Wayland protocol limitation.

Decision: Window positioning functions (move(), setPosition(), center()) are documented NO-OPs on GTK4/Wayland.

Rationale: This is a fundamental Wayland design decision, not a limitation we can work around. Users need to be aware of this behavioral difference.

Context: GTK4 removes GtkMenu/GtkMenuItem in favor of GMenu/GAction.

Decision: Complete rewrite of menu system for GTK4 using GMenu/GAction/GtkPopoverMenuBar.

Status: Stub implementations only. Full implementation pending.

Decision 5: System Tray Compatibility (2026-01-04)

Context: v3's system tray uses D-Bus StatusNotifierItem protocol.

Decision: No changes needed - system tray is already GTK-agnostic.

Implementation Progress

Phase 1: Build Infrastructure ✅ COMPLETE

Commit: a0ca13fdc (2026-01-04)

1.1 Add gtk3 constraint to existing files

Files modified:

v3/pkg/application/application_linux.go - Added gtk3 constraint
v3/pkg/application/linux_cgo.go - Added gtk3 constraint
v3/internal/assetserver/webview/request_linux.go - Added gtk3 constraint
v3/internal/assetserver/webview/responsewriter_linux.go - Added gtk3 constraint
v3/internal/assetserver/webview/webkit2.go - Added gtk3 constraint

1.2 Create GTK4 stub files

Files created:

v3/pkg/application/linux_cgo_gtk4.go (~1000 lines)
- Main CGO file with GTK4 bindings
- Implements: window management, clipboard, basic menu stubs
- Uses gtk4 webkitgtk-6.0 pkg-config
v3/pkg/application/application_linux_gtk4.go (~250 lines)
- Application lifecycle management
- System theme detection via D-Bus
- NVIDIA DMA-BUF workaround for Wayland

1.3 Create WebKitGTK 6.0 asset server stubs

Files created:

v3/internal/assetserver/webview/webkit6.go
v3/internal/assetserver/webview/request_linux_gtk4.go
v3/internal/assetserver/webview/responsewriter_linux_gtk4.go

Phase 2: Doctor & Capabilities ✅ COMPLETE

Goal: Update wails doctor to check for GTK4 as primary, GTK3 as secondary.

2.1 Package Manager Updates

All 7 package managers updated to check GTK4/WebKitGTK 6.0 as primary, GTK3 as optional/legacy:

v3/internal/doctor/packagemanager/apt.go ✅
v3/internal/doctor/packagemanager/dnf.go ✅
v3/internal/doctor/packagemanager/pacman.go ✅
v3/internal/doctor/packagemanager/zypper.go ✅
v3/internal/doctor/packagemanager/emerge.go ✅
v3/internal/doctor/packagemanager/eopkg.go ✅
v3/internal/doctor/packagemanager/nixpkgs.go ✅

Package key naming convention: gtk3, webkit2gtk-4.1 (primary/default), gtk4, webkitgtk-6.0 (experimental, optional)

2.2 Capabilities Detection

Files created/updated:

v3/internal/capabilities/capabilities.go - Added GTKVersion (int) and WebKitVersion (string) fields
v3/internal/capabilities/capabilities_linux.go - GTK4 default: GTKVersion: 4, WebKitVersion: "6.0"
v3/internal/capabilities/capabilities_linux_gtk3.go - GTK3 legacy: GTKVersion: 3, WebKitVersion: "4.1"

TODO (deferred to Phase 3):

Update v3/internal/doctor/doctor_linux.go - Improve output to show GTK4 vs GTK3 status

Phase 3: Window Management ✅ COMPLETE

3.1 GTK4 Event Controllers

GTK4 replaces direct signal handlers with GtkEventController objects:

GtkEventControllerFocus for focus in/out events
GtkGestureClick for button press/release events
GtkEventControllerKey for keyboard events
Window signals: close-request, notify::maximized, notify::fullscreened

New C function setupWindowEventControllers() sets up all event controllers.

3.2 Window Drag and Resize

GTK4 uses GdkToplevel API instead of GTK3's gtk_window_begin_move_drag:

gdk_toplevel_begin_move() for window drag
gdk_toplevel_begin_resize() for window resize
Requires gtk_native_get_surface() to get the GdkSurface

3.3 Drag-and-Drop with GtkDropTarget

Complete implementation using GTK4's GtkDropTarget:

on_drop_enter / on_drop_leave for drag enter/exit events
on_drop_motion for drag position updates
on_drop handles file drops via GDK_TYPE_FILE_LIST
Go callbacks: onDropEnter, onDropLeave, onDropMotion, onDropFiles

3.4 Window State Detection

isMinimised() uses gdk_toplevel_get_state() with GDK_TOPLEVEL_STATE_MINIMIZED
isMaximised() uses gtk_window_is_maximized()
isFullscreen() uses gtk_window_is_fullscreen()

3.5 Size Constraints

GTK4 removed gtk_window_set_geometry_hints(). Now using gtk_widget_set_size_request() for minimum size.

TODO (deferred):

Test window lifecycle on GTK4 with actual GTK4 libraries

GTK4 completely replaced the menu system. GTK3's GtkMenu/GtkMenuItem are gone.

4.1 GMenu/GAction Architecture

GMenu - Menu model (data structure, not a widget)
GMenuItem - Individual menu item in the model
GSimpleAction - Action that gets triggered when menu item is activated
GSimpleActionGroup - Container for actions, attached to widgets

GtkPopoverMenuBar created from GMenu model via create_menu_bar_from_model()
Action group attached to window with attach_action_group_to_widget()
Actions use "app.action_name" namespace

4.3 New Files Created

v3/pkg/application/menu_linux_gtk4.go - GTK4 menu processing
v3/pkg/application/menuitem_linux_gtk4.go - GTK4 menu item handling

4.4 Build Tag Changes

menu_linux.go - Added gtk3 tag
menuitem_linux.go - Added gtk3 tag

4.5 Key Functions

menuActionActivated() - Callback when GAction is triggered
menuItemNewWithId() - Creates GMenuItem + associated GSimpleAction
menuCheckItemNewWithId() - Creates stateful toggle action
menuRadioItemNewWithId() - Creates radio action
set_action_enabled() / set_action_state() - Manage action state

TODO (deferred):

Context menus with GtkPopoverMenu

Phase 5: Asset Server ✅ COMPLETE

WebKitGTK 6.0 uses the same URI scheme handler API as WebKitGTK 4.1. The asset server implementation is identical between GTK3 and GTK4.

5.1 Asset Server Files (already created in Phase 1)

v3/internal/assetserver/webview/webkit6.go - WebKitGTK 6.0 helpers
v3/internal/assetserver/webview/request_linux_gtk4.go - Request handling
v3/internal/assetserver/webview/responsewriter_linux_gtk4.go - Response writing

5.2 Missing Exports Added

The GTK4 CGO file was missing two critical exports that were in the GTK3 file:

onProcessRequest - Handles URI scheme requests from WebKit
sendMessageToBackend - Handles JavaScript to Go communication

Both exports were added to linux_cgo_gtk4.go.

5.3 Key Differences from GTK3

Aspect	GTK3	GTK4
pkg-config	`webkit2gtk-4.1`	`webkitgtk-6.0`
Headers	`webkit2/webkit2.h`	`webkit/webkit.h`
Min version	2.40	6.0
URI scheme API	Same	Same

TODO (deferred to testing phase):

Test asset loading on actual GTK4 system
Verify JavaScript execution works correctly

Phase 6: Docker & Build System ✅ COMPLETE

6.1 Docker Container Updates

Updated both Dockerfile.linux-x86_64 and Dockerfile.linux-arm64 to install:

GTK3 + WebKit2GTK 4.1 (default build target)
GTK4 + WebKitGTK 6.0 (for experimental -tags gtk4 builds)

Build scripts now support BUILD_TAGS environment variable:

Default: Builds with GTK3/WebKit2GTK 4.1
BUILD_TAGS=gtk4: Builds with GTK4/WebKitGTK 6.0 (experimental)

6.2 Taskfile Targets

New targets added to v3/Taskfile.yaml:

Target	Description
`test:example:linux`	Build single example with GTK3 (native, default)
`test:example:linux:gtk4`	Build single example with GTK4 (native, experimental)
`test:examples:linux:docker:x86_64`	Build all examples with GTK3 in Docker
`test:examples:linux:docker:x86_64:gtk4`	Build all examples with GTK4 in Docker (experimental)
`test:examples:linux:docker:arm64`	Build all examples with GTK3 in Docker (ARM64)
`test:examples:linux:docker:arm64:gtk4`	Build all examples with GTK4 in Docker (ARM64, experimental)

TODO (deferred):

Update CI/CD workflows to test both GTK versions

Phase 8: Dialog System ✅ COMPLETE

GTK4 completely replaced the dialog APIs. GTK3's GtkFileChooserDialog and gtk_message_dialog_new are deprecated/removed.

8.1 File Dialogs

GTK4 uses GtkFileDialog with async API:

gtk_file_dialog_open() - Open single file
gtk_file_dialog_open_multiple() - Open multiple files
gtk_file_dialog_select_folder() - Select folder
gtk_file_dialog_select_multiple_folders() - Select multiple folders
gtk_file_dialog_save() - Save file

Key differences:

No more gtk_dialog_run() - everything is async with callbacks
Filters use GListStore of GtkFileFilter objects
Results delivered via GAsyncResult callbacks
Custom button text via gtk_file_dialog_set_accept_label()

8.1.1 GTK4 File Dialog Limitations (Portal-based)

GTK4's GtkFileDialog uses xdg-desktop-portal for native file dialogs. This provides better desktop integration but removes some application control:

Feature	GTK3	GTK4	Notes
`ShowHiddenFiles()`	✅ Works	❌ No effect	User controls via portal UI toggle
`CanCreateDirectories()`	✅ Works	❌ No effect	Always enabled in portal
`ResolvesAliases()`	✅ Works	❌ No effect	Portal handles symlinks
`SetButtonText()`	✅ Works	✅ Works	`gtk_file_dialog_set_accept_label()`
Multiple folders	✅ Works	✅ Works	`gtk_file_dialog_select_multiple_folders()`

Why these limitations exist: GTK4's portal-based dialogs delegate UI control to the desktop environment (GNOME, KDE, etc.). This is intentional - the portal provides consistent UX across applications and respects user preferences.

8.2 Message Dialogs

GTK4 uses GtkAlertDialog:

gtk_alert_dialog_choose() - Show dialog with buttons
Buttons specified as NULL-terminated string array
Default and cancel button indices configurable

8.3 Implementation Details

Request ID tracking for async callback matching
fileDialogCallback / alertDialogCallback C exports for results
runChooserDialog() and runQuestionDialog() Go wrappers
runOpenFileDialog() and runSaveFileDialog() convenience functions

GTK3	GTK4
`GtkFileChooserDialog`	`GtkFileDialog`
`gtk_dialog_run()`	Async callbacks
`gtk_message_dialog_new()`	`GtkAlertDialog`
`gtk_widget_destroy()`	`g_object_unref()`

Phase 9: Keyboard Accelerators ✅ COMPLETE

GTK4 uses gtk_application_set_accels_for_action() to bind keyboard shortcuts to GActions.

9.1 Key Components

C Helper Functions (in linux_cgo_gtk4.go):

set_action_accelerator(app, action_name, accel) - Sets accelerator for a GAction
build_accelerator_string(key, mods) - Converts key+modifiers to GTK accelerator string

Go Functions (in linux_cgo_gtk4.go):

namedKeysToGTK - Map of key names to GDK keysym values (e.g., "backspace" → 0xff08)
parseKeyGTK(key) - Converts Wails key string to GDK keysym
parseModifiersGTK(modifiers) - Converts Wails modifiers to GdkModifierType
acceleratorToGTK(accel) - Converts full accelerator to GTK format
setMenuItemAccelerator(itemId, accel) - Sets accelerator for a menu item

Integration (in menuitem_linux_gtk4.go):

setAccelerator() method on linuxMenuItem calls setMenuItemAccelerator()
newMenuItemImpl(), newCheckMenuItemImpl(), newRadioMenuItemImpl() all set accelerators during creation

9.2 Accelerator String Format

GTK accelerator strings use format like:

<Control>q - Ctrl+Q
<Control><Shift>s - Ctrl+Shift+S
<Alt>F4 - Alt+F4
<Super>e - Super+E (Windows/Command key)

9.3 Modifier Mapping

Wails Modifier	GDK Modifier
`CmdOrCtrlKey`	`GDK_CONTROL_MASK`
`ControlKey`	`GDK_CONTROL_MASK`
`OptionOrAltKey`	`GDK_ALT_MASK`
`ShiftKey`	`GDK_SHIFT_MASK`
`SuperKey`	`GDK_SUPER_MASK`

Phase 10: Testing 📋 PENDING

TODO:

Test on Ubuntu 24.04 (native GTK4)
Test on Ubuntu 22.04 (backported WebKitGTK 6.0)
Test legacy build on older systems
Performance benchmarks
Verify file dialogs work correctly
Verify message dialogs work correctly

API Differences: GTK3 vs GTK4

Feature	GTK3	GTK4
Init	`gtk_init(&argc, &argv)`	`gtk_init_check()`
Container	`gtk_container_add()`	`gtk_window_set_child()`
Show	`gtk_widget_show_all()`	Widgets visible by default
Hide	`gtk_widget_hide()`	`gtk_widget_set_visible(w, FALSE)`
Clipboard	`GtkClipboard`	`GdkClipboard`
Menu	`GtkMenu/GtkMenuItem`	`GMenu/GAction`
Menu Bar	`GtkMenuBar`	`GtkPopoverMenuBar`
Window Move	`gtk_window_move()`	NO-OP on Wayland
Window Position	`gtk_window_get_position()`	Not available on Wayland
Destroy	`gtk_widget_destroy()`	`gtk_window_destroy()`
Drag Start	`gtk_window_begin_move_drag()`	`gtk_native_get_surface()` + surface drag

Files Reference

GTK3 (Default) Files

v3/pkg/application/
  linux_cgo.go              # Main CGO (!gtk4 tag - default)
  application_linux.go       # App lifecycle (!gtk4 tag - default)

v3/internal/assetserver/webview/
  webkit2.go                 # WebKit2GTK helpers (!gtk4 tag - default)
  request_linux.go           # Request handling (!gtk4 tag - default)
  responsewriter_linux.go    # Response writing (!gtk4 tag - default)

v3/internal/capabilities/
  capabilities_linux_gtk3.go # GTK3 capabilities (!gtk4 tag - default)

v3/internal/operatingsystem/
  webkit_linux.go           # WebKit version info (!gtk4 tag - default)

GTK4 (Experimental) Files

v3/pkg/application/
  linux_cgo_gtk4.go          # Main CGO (gtk4 tag - experimental)
  application_linux_gtk4.go   # App lifecycle (gtk4 tag - experimental)

v3/internal/assetserver/webview/
  webkit6.go                 # WebKitGTK 6.0 helpers (gtk4 tag - experimental)
  request_linux_gtk4.go      # Request handling (gtk4 tag - experimental)
  responsewriter_linux_gtk4.go # Response writing (gtk4 tag - experimental)

v3/internal/capabilities/
  capabilities_linux.go      # GTK4 capabilities (gtk4 tag - experimental)

v3/internal/operatingsystem/
  webkit_linux_gtk4.go       # WebKit version info (gtk4 tag - experimental)

Shared Files (no GTK-specific code)

v3/pkg/application/
  webview_window_linux.go    # Window wrapper (uses methods from CGO files)
  systemtray_linux.go        # D-Bus based, GTK-agnostic
  
v3/internal/assetserver/webview/
  request.go                 # Interface definitions
  responsewriter.go          # Interface definitions

Changelog

2026-01-07 (Session 11)

Fixed GTK4 dialog system bugs
File Dialog Fix: Removed premature g_object_unref() that freed dialog before async callback
- GTK4 async dialogs manage their own lifecycle
- Commit: 6f9c5beb5
Alert Dialog Fixes:
- Removed premature g_object_unref(dialog) from show_alert_dialog() (same issue as file dialogs)
- Fixed deadlock in dialogs_linux.go - InvokeAsync → go func() since runQuestionDialog blocks internally
- Fixed runQuestionDialog to use options.Title as message (was using options.Message)
- Added default "OK" button when no buttons specified
- Commit: 1a77e6091
Other Fixes:
- Fixed checkptr errors with -race flag by changing C signal functions to accept uintptr_t (3999f1f24)
- Fixed ExecJS race condition by adding mutex for runtimeLoaded/pendingJS (8e386034e)
Added DEBUG_LOG macro for compile-time debug output: CGO_CFLAGS="-DWAILS_GTK_DEBUG" go build ...
Added manual dialog test suite in v3/test/manual/dialog/
Additional Dialog Fixes (Session 11 continued):
- Added gtk_file_dialog_set_accept_label() for custom button text
- Added gtk_file_dialog_select_multiple_folders() for multiple directory selection
- Fixed data race in application.go cleanup - was using RLock() when writing a.windows = nil
- Documented GTK4 portal limitations (ShowHiddenFiles, CanCreateDirectories have no effect)
Files modified:
- v3/pkg/application/linux_cgo_gtk4.go - dialog fixes, race fixes, accept label, multiple folders
- v3/pkg/application/linux_cgo_gtk4.c - DEBUG_LOG macro, alert dialog lifecycle fix, select_multiple_folders callback
- v3/pkg/application/linux_cgo_gtk4.h - uintptr_t for signal functions
- v3/pkg/application/dialogs_linux.go - deadlock fix
- v3/pkg/application/webview_window.go - pendingJS mutex
- v3/pkg/application/application.go - RLock → Lock for cleanup writes
- docs/src/content/docs/reference/dialogs.mdx - documented GTK4 limitations

2026-01-04 (Session 10)

Fixed Window → Zoom menu behavior to toggle maximize/restore (was incorrectly calling webview zoomIn)
Fixed radio button styling in GTK4 GMenu (now shows dots instead of checkmarks)
- Implemented proper GMenu radio groups with string-valued stateful actions
- All items in group share same action name with unique target values
- Added create_radio_menu_item() C helper and menuRadioItemNewWithGroup() Go wrapper
Researched Wayland minimize behavior:
- gtk_window_minimize() works on GNOME/KDE (sends xdg_toplevel_set_minimized)
- May be no-op on tiling WMs (Sway, etc.) per Wayland protocol design
Fixed app not terminating when last window closed
- Added quit logic to unregisterWindow() in application_linux_gtk4.go
- Respects DisableQuitOnLastWindowClosed option
Fixed menu separators not showing
- GMenu uses sections for visual separators (not separate separator items)
- Rewrote menu processing to group items into sections, separators create new sections
- Added menuNewSection(), menuAppendSection(), menuAppendItemToSection() helpers
Added CSS provider to reduce popover menu padding
Removed all debug println statements
Files modified:
- v3/pkg/application/linux_cgo_gtk4.go - added radio group support, section helpers
- v3/pkg/application/linux_cgo_gtk4.c - added create_radio_menu_item(), init_menu_css()
- v3/pkg/application/linux_cgo_gtk4.h - added function declaration
- v3/pkg/application/application_linux_gtk4.go - added quit-on-last-window logic
- v3/pkg/application/menu_linux_gtk4.go - section-based menu processing, radio groups
- v3/pkg/application/menuitem_linux_gtk4.go - updated radio item creation
- v3/pkg/application/webview_window_linux.go - fixed zoom() to toggle maximize
- v3/pkg/application/window_manager.go - removed debug output

2026-01-04 (Session 9)

Fixed GTK4 window creation crash (SIGSEGV in gtk_application_window_new)
Root Cause: GTK4 requires app to be "activated" before creating windows
Solution: Added activation synchronization mechanism:
- Added activated channel and sync.Once to linuxApp struct
- Added markActivated() method called from activateLinux() callback
- Added waitForActivation() method for callers to block until ready
- Modified WebviewWindow.Run() to wait for activation before InvokeSync
Files modified:
- v3/pkg/application/application_linux_gtk4.go - activation gate
- v3/pkg/application/linux_cgo_gtk4.go - call markActivated() in activateLinux
- v3/pkg/application/webview_window.go - wait for activation on GTK4
GTK4 apps now create windows successfully without crashes

2026-01-04 (Session 8)

Fixed GTK3/GTK4 symbol conflict in operatingsystem package
Added gtk3 build tag to v3/internal/operatingsystem/webkit_linux.go
Created v3/internal/operatingsystem/webkit_linux_gtk4.go with GTK4/WebKitGTK 6.0
Moved app initialization from init() to newPlatformApp() for cleaner setup
Resolved runtime crash: "GTK 2/3 symbols detected in GTK 4 process"
Verified menu example runs successfully with GTK 4.20.3 and WebKitGTK 2.50.3

2026-01-04 (Session 7)

Completed Phase 9: Keyboard Accelerators
Added namedKeysToGTK map with GDK keysym values for all special keys
Added parseKeyGTK() and parseModifiersGTK() conversion functions
Added acceleratorToGTK() to convert Wails accelerator format to GTK
Added setMenuItemAccelerator() Go wrapper that calls C helpers
Integrated accelerator setting in all menu item creation functions
Uses gtk_application_set_accels_for_action() for GTK4 shortcut binding

2026-01-04 (Session 6)

Completed Phase 8: Dialog System
Implemented GtkFileDialog for file open/save/folder dialogs
Implemented GtkAlertDialog for message dialogs
Added async callback system for GTK4 dialogs (no more gtk_dialog_run)
Added C helper functions and Go wrapper functions

2026-01-04 (Session 5 continued)

Completed Phase 6: Docker & Build System
Updated Dockerfile.linux-x86_64 and Dockerfile.linux-arm64 for GTK4 + GTK3
Added BUILD_TAGS environment variable support in build scripts
Added Taskfile targets for GTK4 (default) and GTK3 (legacy) builds

2026-01-04 (Session 5)

Completed Phase 5: Asset Server
Verified WebKitGTK 6.0 uses same URI scheme handler API as WebKitGTK 4.1
Added missing onProcessRequest export to linux_cgo_gtk4.go
Added missing sendMessageToBackend export to linux_cgo_gtk4.go
Confirmed asset server files (webkit6.go, request/responsewriter) are complete

2026-01-04 (Session 4)

Completed Phase 4: Menu System
Implemented GMenu/GAction architecture for GTK4 menus
Created GtkPopoverMenuBar integration
Added menu_linux_gtk4.go and menuitem_linux_gtk4.go
Added gtk3 build tags to original menu files
Implemented stateful actions for checkboxes and radio items

2026-01-04 (Session 3)

Completed Phase 3: Window Management
Implemented GTK4 event controllers (GtkEventControllerFocus, GtkGestureClick, GtkEventControllerKey)
Implemented window drag using GdkToplevel API (gdk_toplevel_begin_move/resize)
Implemented complete drag-and-drop with GtkDropTarget
Fixed window state detection (isMinimised, isMaximised, isFullscreen)
Fixed size() function to properly return window dimensions
Updated windowSetGeometryHints for GTK4 (uses gtk_widget_set_size_request)

2026-01-04 (Session 2)

Completed Phase 2: Doctor & Capabilities
Updated all 7 package managers for GTK4/WebKitGTK 6.0 as primary
Added GTKVersion and WebKitVersion fields to Capabilities struct
Created capabilities_linux_gtk3.go for legacy build path

2026-01-04 (Session 1)

Initial implementation of GTK4 build infrastructure
Added gtk3 constraint to 5 existing files
Created 5 new GTK4 stub files
Updated UNRELEASED_CHANGELOG.md

24 KiB Raw Permalink Blame History

WebKitGTK 6.0 / GTK4 Implementation Tracker

Overview

Architecture Decisions

Decision 1: GTK3 as Default, GTK4 Opt-In (2026-02-04)

Decision 2: pkg-config Libraries (2026-01-04)

Decision 3: Wayland Window Positioning (2026-01-04)

Decision 4: Menu System Architecture (2026-01-04)

Decision 5: System Tray Compatibility (2026-01-04)

Implementation Progress

Phase 1: Build Infrastructure ✅ COMPLETE

1.1 Add gtk3 constraint to existing files

1.2 Create GTK4 stub files

1.3 Create WebKitGTK 6.0 asset server stubs

Phase 2: Doctor & Capabilities ✅ COMPLETE

2.1 Package Manager Updates

2.2 Capabilities Detection

Phase 3: Window Management ✅ COMPLETE

3.1 GTK4 Event Controllers

3.2 Window Drag and Resize

3.3 Drag-and-Drop with GtkDropTarget

3.4 Window State Detection

3.5 Size Constraints

Phase 4: Menu System ✅ COMPLETE

4.1 GMenu/GAction Architecture

4.2 Menu Bar Implementation

4.3 New Files Created

4.4 Build Tag Changes

4.5 Key Functions

Phase 5: Asset Server ✅ COMPLETE

5.1 Asset Server Files (already created in Phase 1)

5.2 Missing Exports Added

5.3 Key Differences from GTK3

Phase 6: Docker & Build System ✅ COMPLETE

6.1 Docker Container Updates

6.2 Taskfile Targets

Phase 8: Dialog System ✅ COMPLETE

8.1 File Dialogs

8.1.1 GTK4 File Dialog Limitations (Portal-based)

8.2 Message Dialogs

8.3 Implementation Details

Phase 9: Keyboard Accelerators ✅ COMPLETE

9.1 Key Components

9.2 Accelerator String Format

9.3 Modifier Mapping

Phase 10: Testing 📋 PENDING

API Differences: GTK3 vs GTK4

Files Reference

GTK3 (Default) Files

GTK4 (Experimental) Files

Shared Files (no GTK-specific code)

Changelog

2026-01-07 (Session 11)

2026-01-04 (Session 10)

2026-01-04 (Session 9)

2026-01-04 (Session 8)

2026-01-04 (Session 7)

2026-01-04 (Session 6)

2026-01-04 (Session 5 continued)

2026-01-04 (Session 5)

2026-01-04 (Session 4)

2026-01-04 (Session 3)

2026-01-04 (Session 2)

2026-01-04 (Session 1)

24 KiB

Raw Permalink Blame History