[PATCH v26 0/1] MR6938: winewayland.drv: Implement support for xdg-toplevel-icon.
-- v26: winewayland.drv: Implement support for xdg-toplevel-icon. https://gitlab.winehq.org/wine/wine/-/merge_requests/6938
From: Etaash Mathamsetty <etaash.mathamsetty(a)gmail.com> --- dlls/winewayland.drv/Makefile.in | 1 + dlls/winewayland.drv/wayland.c | 8 + dlls/winewayland.drv/wayland_pointer.c | 94 +------- dlls/winewayland.drv/wayland_surface.c | 167 ++++++++++++++ dlls/winewayland.drv/waylanddrv.h | 33 ++- dlls/winewayland.drv/waylanddrv_main.c | 1 + dlls/winewayland.drv/window.c | 69 +++++- dlls/winewayland.drv/xdg-toplevel-icon-v1.xml | 205 ++++++++++++++++++ 8 files changed, 472 insertions(+), 106 deletions(-) create mode 100644 dlls/winewayland.drv/xdg-toplevel-icon-v1.xml diff --git a/dlls/winewayland.drv/Makefile.in b/dlls/winewayland.drv/Makefile.in index 4141e36c9a8..320ebe8c91d 100644 --- a/dlls/winewayland.drv/Makefile.in +++ b/dlls/winewayland.drv/Makefile.in @@ -11,6 +11,7 @@ SOURCES = \ pointer-constraints-unstable-v1.xml \ relative-pointer-unstable-v1.xml \ text-input-unstable-v3.xml \ + xdg-toplevel-icon-v1.xml \ version.rc \ viewporter.xml \ vulkan.c \ diff --git a/dlls/winewayland.drv/wayland.c b/dlls/winewayland.drv/wayland.c index 7caf33c872e..ba09d32ed89 100644 --- a/dlls/winewayland.drv/wayland.c +++ b/dlls/winewayland.drv/wayland.c @@ -189,6 +189,11 @@ static void registry_handle_global(void *data, struct wl_registry *registry, process_wayland.wl_data_device_manager = wl_registry_bind(registry, id, &wl_data_device_manager_interface, 2); } + else if (strcmp(interface, "xdg_toplevel_icon_manager_v1") == 0) + { + process_wayland.xdg_toplevel_icon_manager_v1 = + wl_registry_bind(registry, id, &xdg_toplevel_icon_manager_v1_interface, 1); + } } static void registry_handle_global_remove(void *data, struct wl_registry *registry, @@ -319,6 +324,9 @@ BOOL wayland_process_init(void) ERR("Wayland compositor doesn't support optional zwlr_data_control_manager_v1 (clipboard functionality will be limited)\n"); } + if (!process_wayland.xdg_toplevel_icon_manager_v1) + ERR("Wayland compositor doesn't support xdg_toplevel_icon_manager_v1 (window icons will not be supported)\n"); + process_wayland.initialized = TRUE; return TRUE; diff --git a/dlls/winewayland.drv/wayland_pointer.c b/dlls/winewayland.drv/wayland_pointer.c index 457c3675cf1..6c852292c1d 100644 --- a/dlls/winewayland.drv/wayland_pointer.c +++ b/dlls/winewayland.drv/wayland_pointer.c @@ -382,98 +382,6 @@ done: return shm_buffer; } -/*********************************************************************** - * create_color_cursor_buffer - * - * Create a wayland_shm_buffer for a color cursor bitmap. - * - * Adapted from wineandroid.drv code. - */ -static struct wayland_shm_buffer *create_color_cursor_buffer(HDC hdc, HBITMAP color, - HBITMAP mask) -{ - struct wayland_shm_buffer *shm_buffer = NULL; - char buffer[FIELD_OFFSET(BITMAPINFO, bmiColors[256])]; - BITMAPINFO *info = (BITMAPINFO *)buffer; - BITMAP bm; - unsigned int *ptr, *bits = NULL; - unsigned char *mask_bits = NULL; - int i, j; - BOOL has_alpha = FALSE; - - if (!NtGdiExtGetObjectW(color, sizeof(bm), &bm)) goto failed; - - shm_buffer = wayland_shm_buffer_create(bm.bmWidth, bm.bmHeight, - WL_SHM_FORMAT_ARGB8888); - if (!shm_buffer) goto failed; - bits = shm_buffer->map_data; - - info->bmiHeader.biSize = sizeof(BITMAPINFOHEADER); - info->bmiHeader.biWidth = bm.bmWidth; - info->bmiHeader.biHeight = -bm.bmHeight; - info->bmiHeader.biPlanes = 1; - info->bmiHeader.biBitCount = 32; - info->bmiHeader.biCompression = BI_RGB; - info->bmiHeader.biSizeImage = bm.bmWidth * bm.bmHeight * 4; - info->bmiHeader.biXPelsPerMeter = 0; - info->bmiHeader.biYPelsPerMeter = 0; - info->bmiHeader.biClrUsed = 0; - info->bmiHeader.biClrImportant = 0; - - if (!NtGdiGetDIBitsInternal(hdc, color, 0, bm.bmHeight, bits, info, - DIB_RGB_COLORS, 0, 0)) - goto failed; - - for (i = 0; i < bm.bmWidth * bm.bmHeight; i++) - if ((has_alpha = (bits[i] & 0xff000000) != 0)) break; - - if (!has_alpha) - { - unsigned int width_bytes = (bm.bmWidth + 31) / 32 * 4; - /* generate alpha channel from the mask */ - info->bmiHeader.biBitCount = 1; - info->bmiHeader.biSizeImage = width_bytes * bm.bmHeight; - if (!(mask_bits = malloc(info->bmiHeader.biSizeImage))) goto failed; - if (!NtGdiGetDIBitsInternal(hdc, mask, 0, bm.bmHeight, mask_bits, - info, DIB_RGB_COLORS, 0, 0)) - goto failed; - ptr = bits; - for (i = 0; i < bm.bmHeight; i++) - { - for (j = 0; j < bm.bmWidth; j++, ptr++) - { - if (!((mask_bits[i * width_bytes + j / 8] << (j % 8)) & 0x80)) - *ptr |= 0xff000000; - } - } - free(mask_bits); - } - - /* Wayland requires pre-multiplied alpha values */ - for (ptr = bits, i = 0; i < bm.bmWidth * bm.bmHeight; ptr++, i++) - { - unsigned char alpha = *ptr >> 24; - if (alpha == 0) - { - *ptr = 0; - } - else if (alpha != 255) - { - *ptr = (alpha << 24) | - (((BYTE)(*ptr >> 16) * alpha / 255) << 16) | - (((BYTE)(*ptr >> 8) * alpha / 255) << 8) | - (((BYTE)*ptr * alpha / 255)); - } - } - - return shm_buffer; - -failed: - if (shm_buffer) wayland_shm_buffer_unref(shm_buffer); - free(mask_bits); - return NULL; -} - /*********************************************************************** * get_icon_info * @@ -535,7 +443,7 @@ static void wayland_pointer_update_cursor_buffer(HCURSOR hcursor, double scale) { HDC hdc = NtGdiCreateCompatibleDC(0); cursor->shm_buffer = - create_color_cursor_buffer(hdc, info.hbmColor, info.hbmMask); + wayland_shm_buffer_from_color_bitmaps(hdc, info.hbmColor, info.hbmMask); NtGdiDeleteObjectApp(hdc); } else diff --git a/dlls/winewayland.drv/wayland_surface.c b/dlls/winewayland.drv/wayland_surface.c index 701085847a4..39b6991a5eb 100644 --- a/dlls/winewayland.drv/wayland_surface.c +++ b/dlls/winewayland.drv/wayland_surface.c @@ -329,6 +329,21 @@ void wayland_surface_clear_role(struct wayland_surface *surface) break; case WAYLAND_SURFACE_ROLE_TOPLEVEL: + if (surface->xdg_toplevel_icon) + { + xdg_toplevel_icon_manager_v1_set_icon( + process_wayland.xdg_toplevel_icon_manager_v1, + surface->xdg_toplevel, NULL); + xdg_toplevel_icon_v1_destroy(surface->xdg_toplevel_icon); + if (surface->big_icon_buffer) + wayland_shm_buffer_unref(surface->big_icon_buffer); + if (surface->small_icon_buffer) + wayland_shm_buffer_unref(surface->small_icon_buffer); + surface->big_icon_buffer = NULL; + surface->small_icon_buffer = NULL; + surface->xdg_toplevel_icon = NULL; + } + if (surface->xdg_toplevel) { xdg_toplevel_destroy(surface->xdg_toplevel); @@ -851,6 +866,98 @@ err: return NULL; } +/*********************************************************************** + * wayland_shm_buffer_from_color_bitmaps + * + * Create a wayland_shm_buffer for a color bitmap. + * + * Adapted from wineandroid.drv code. + */ +struct wayland_shm_buffer *wayland_shm_buffer_from_color_bitmaps(HDC hdc, HBITMAP color, + HBITMAP mask) +{ + struct wayland_shm_buffer *shm_buffer = NULL; + char buffer[FIELD_OFFSET(BITMAPINFO, bmiColors[256])]; + BITMAPINFO *info = (BITMAPINFO *)buffer; + BITMAP bm; + unsigned int *ptr, *bits = NULL; + unsigned char *mask_bits = NULL; + int i, j; + BOOL has_alpha = FALSE; + + if (!NtGdiExtGetObjectW(color, sizeof(bm), &bm)) goto failed; + + shm_buffer = wayland_shm_buffer_create(bm.bmWidth, bm.bmHeight, + WL_SHM_FORMAT_ARGB8888); + if (!shm_buffer) goto failed; + bits = shm_buffer->map_data; + + info->bmiHeader.biSize = sizeof(BITMAPINFOHEADER); + info->bmiHeader.biWidth = bm.bmWidth; + info->bmiHeader.biHeight = -bm.bmHeight; + info->bmiHeader.biPlanes = 1; + info->bmiHeader.biBitCount = 32; + info->bmiHeader.biCompression = BI_RGB; + info->bmiHeader.biSizeImage = bm.bmWidth * bm.bmHeight * 4; + info->bmiHeader.biXPelsPerMeter = 0; + info->bmiHeader.biYPelsPerMeter = 0; + info->bmiHeader.biClrUsed = 0; + info->bmiHeader.biClrImportant = 0; + + if (!NtGdiGetDIBitsInternal(hdc, color, 0, bm.bmHeight, bits, info, + DIB_RGB_COLORS, 0, 0)) + goto failed; + + for (i = 0; i < bm.bmWidth * bm.bmHeight; i++) + if ((has_alpha = (bits[i] & 0xff000000) != 0)) break; + + if (!has_alpha) + { + unsigned int width_bytes = (bm.bmWidth + 31) / 32 * 4; + /* generate alpha channel from the mask */ + info->bmiHeader.biBitCount = 1; + info->bmiHeader.biSizeImage = width_bytes * bm.bmHeight; + if (!(mask_bits = malloc(info->bmiHeader.biSizeImage))) goto failed; + if (!NtGdiGetDIBitsInternal(hdc, mask, 0, bm.bmHeight, mask_bits, + info, DIB_RGB_COLORS, 0, 0)) + goto failed; + ptr = bits; + for (i = 0; i < bm.bmHeight; i++) + { + for (j = 0; j < bm.bmWidth; j++, ptr++) + { + if (!((mask_bits[i * width_bytes + j / 8] << (j % 8)) & 0x80)) + *ptr |= 0xff000000; + } + } + free(mask_bits); + } + + /* Wayland requires pre-multiplied alpha values */ + for (ptr = bits, i = 0; i < bm.bmWidth * bm.bmHeight; ptr++, i++) + { + unsigned char alpha = *ptr >> 24; + if (alpha == 0) + { + *ptr = 0; + } + else if (alpha != 255) + { + *ptr = (alpha << 24) | + (((BYTE)(*ptr >> 16) * alpha / 255) << 16) | + (((BYTE)(*ptr >> 8) * alpha / 255) << 8) | + (((BYTE)*ptr * alpha / 255)); + } + } + + return shm_buffer; + +failed: + if (shm_buffer) wayland_shm_buffer_unref(shm_buffer); + free(mask_bits); + return NULL; +} + /********************************************************************** * wayland_surface_coords_from_window * @@ -1081,3 +1188,63 @@ void wayland_surface_set_title(struct wayland_surface *surface, LPCWSTR text) free(utf8); } + +/********************************************************************** + * wayland_surface_set_icon + */ +void wayland_surface_set_icon(struct wayland_surface *surface, UINT type, ICONINFO *ii) +{ + HDC hDC; + struct wayland_shm_buffer *icon_buf; + + assert(ii); + assert(surface->role == WAYLAND_SURFACE_ROLE_TOPLEVEL && surface->xdg_toplevel); + + hDC = NtGdiCreateCompatibleDC(0); + icon_buf = wayland_shm_buffer_from_color_bitmaps(hDC, ii->hbmColor, ii->hbmMask); + NtGdiDeleteObjectApp(hDC); + + if (surface->xdg_toplevel_icon) + { + xdg_toplevel_icon_manager_v1_set_icon(process_wayland.xdg_toplevel_icon_manager_v1, + surface->xdg_toplevel, NULL); + xdg_toplevel_icon_v1_destroy(surface->xdg_toplevel_icon); + if (surface->big_icon_buffer && type == ICON_BIG) + { + wayland_shm_buffer_unref(surface->big_icon_buffer); + surface->big_icon_buffer = NULL; + } + else if (surface->small_icon_buffer && type != ICON_BIG) + { + wayland_shm_buffer_unref(surface->small_icon_buffer); + surface->small_icon_buffer = NULL; + } + surface->xdg_toplevel_icon = NULL; + } + + if (icon_buf) + { + surface->xdg_toplevel_icon = + xdg_toplevel_icon_manager_v1_create_icon(process_wayland.xdg_toplevel_icon_manager_v1); + + if (type == ICON_BIG) surface->big_icon_buffer = icon_buf; + else surface->small_icon_buffer = icon_buf; + + /* FIXME: what to do with scale ? */ + if (surface->big_icon_buffer) + { + xdg_toplevel_icon_v1_add_buffer(surface->xdg_toplevel_icon, + surface->big_icon_buffer->wl_buffer, 1); + } + if (surface->small_icon_buffer) + { + xdg_toplevel_icon_v1_add_buffer(surface->xdg_toplevel_icon, + surface->small_icon_buffer->wl_buffer, 1); + } + + xdg_toplevel_icon_v1_set_name(surface->xdg_toplevel_icon, ""); + + xdg_toplevel_icon_manager_v1_set_icon(process_wayland.xdg_toplevel_icon_manager_v1, + surface->xdg_toplevel, surface->xdg_toplevel_icon); + } +} diff --git a/dlls/winewayland.drv/waylanddrv.h b/dlls/winewayland.drv/waylanddrv.h index 3929754c680..50d5fc44079 100644 --- a/dlls/winewayland.drv/waylanddrv.h +++ b/dlls/winewayland.drv/waylanddrv.h @@ -36,6 +36,7 @@ #include "xdg-output-unstable-v1-client-protocol.h" #include "xdg-shell-client-protocol.h" #include "wlr-data-control-unstable-v1-client-protocol.h" +#include "xdg-toplevel-icon-v1-client-protocol.h" #include "windef.h" #include "winbase.h" @@ -168,6 +169,7 @@ struct wayland struct zwp_text_input_manager_v3 *zwp_text_input_manager_v3; struct zwlr_data_control_manager_v1 *zwlr_data_control_manager_v1; struct wl_data_device_manager *wl_data_device_manager; + struct xdg_toplevel_icon_manager_v1 *xdg_toplevel_icon_manager_v1; struct wayland_seat seat; struct wayland_keyboard keyboard; struct wayland_pointer pointer; @@ -237,6 +239,18 @@ struct wayland_client_surface struct wp_viewport *wp_viewport; }; +struct wayland_shm_buffer +{ + struct wl_list link; + struct wl_buffer *wl_buffer; + int width, height; + void *map_data; + size_t map_size; + BOOL busy; + LONG ref; + HRGN damage_region; +}; + struct wayland_surface { HWND hwnd; @@ -251,6 +265,9 @@ struct wayland_surface { struct xdg_surface *xdg_surface; struct xdg_toplevel *xdg_toplevel; + struct xdg_toplevel_icon_v1 *xdg_toplevel_icon; + struct wayland_shm_buffer *small_icon_buffer; + struct wayland_shm_buffer *big_icon_buffer; }; struct { @@ -266,18 +283,6 @@ struct wayland_surface HCURSOR hcursor; }; -struct wayland_shm_buffer -{ - struct wl_list link; - struct wl_buffer *wl_buffer; - int width, height; - void *map_data; - size_t map_size; - BOOL busy; - LONG ref; - HRGN damage_region; -}; - /********************************************************************** * Wayland initialization */ @@ -321,6 +326,7 @@ void wayland_client_surface_attach(struct wayland_client_surface *client, HWND t void wayland_client_surface_detach(struct wayland_client_surface *client); void wayland_surface_ensure_contents(struct wayland_surface *surface); void wayland_surface_set_title(struct wayland_surface *surface, LPCWSTR title); +void wayland_surface_set_icon(struct wayland_surface *surface, UINT type, ICONINFO *ii); /********************************************************************** * Wayland SHM buffer @@ -328,6 +334,8 @@ void wayland_surface_set_title(struct wayland_surface *surface, LPCWSTR title); struct wayland_shm_buffer *wayland_shm_buffer_create(int width, int height, enum wl_shm_format format); +struct wayland_shm_buffer *wayland_shm_buffer_from_color_bitmaps(HDC hdc, HBITMAP color, + HBITMAP mask); void wayland_shm_buffer_ref(struct wayland_shm_buffer *shm_buffer); void wayland_shm_buffer_unref(struct wayland_shm_buffer *shm_buffer); @@ -430,6 +438,7 @@ void WAYLAND_DestroyWindow(HWND hwnd); BOOL WAYLAND_SetIMECompositionRect(HWND hwnd, RECT rect); void WAYLAND_SetCursor(HWND hwnd, HCURSOR hcursor); BOOL WAYLAND_SetCursorPos(INT x, INT y); +void WAYLAND_SetWindowIcon(HWND hwnd, UINT type, HICON icon); void WAYLAND_SetWindowText(HWND hwnd, LPCWSTR text); LRESULT WAYLAND_SysCommand(HWND hwnd, WPARAM wparam, LPARAM lparam, const POINT *pos); UINT WAYLAND_UpdateDisplayDevices(const struct gdi_device_manager *device_manager, void *param); diff --git a/dlls/winewayland.drv/waylanddrv_main.c b/dlls/winewayland.drv/waylanddrv_main.c index 8e310963ef3..1c6a0d95d58 100644 --- a/dlls/winewayland.drv/waylanddrv_main.c +++ b/dlls/winewayland.drv/waylanddrv_main.c @@ -44,6 +44,7 @@ static const struct user_driver_funcs waylanddrv_funcs = .pReleaseKbdTables = WAYLAND_ReleaseKbdTables, .pSetCursor = WAYLAND_SetCursor, .pSetCursorPos = WAYLAND_SetCursorPos, + .pSetWindowIcon = WAYLAND_SetWindowIcon, .pSetWindowText = WAYLAND_SetWindowText, .pSysCommand = WAYLAND_SysCommand, .pUpdateDisplayDevices = WAYLAND_UpdateDisplayDevices, diff --git a/dlls/winewayland.drv/window.c b/dlls/winewayland.drv/window.c index e80bebdc042..184d09c2ed4 100644 --- a/dlls/winewayland.drv/window.c +++ b/dlls/winewayland.drv/window.c @@ -422,6 +422,28 @@ BOOL WAYLAND_WindowPosChanging(HWND hwnd, UINT swp_flags, BOOL shaped, const str return TRUE; } +static HICON get_icon_info(HICON icon, ICONINFO *ii) +{ + return icon && NtUserGetIconInfo(icon, ii, NULL, NULL, NULL, 0) ? icon : NULL; +} + +static HICON get_window_icon(HWND hwnd, UINT type, HICON icon, ICONINFO *ret) +{ + icon = get_icon_info(icon, ret); + if (!icon) + { + icon = get_icon_info((HICON)send_message(hwnd, WM_GETICON, type, 0), ret); + if (!icon) + icon = get_icon_info((HICON)NtUserGetClassLongPtrW(hwnd, GCLP_HICON), ret); + if (!icon && type == ICON_BIG) + { + icon = LoadImageW(0, (const WCHAR *)IDI_WINLOGO, IMAGE_ICON, 0, 0, + LR_SHARED | LR_DEFAULTSIZE); + icon = get_icon_info(icon, ret); + } + } + return icon; +} /*********************************************************************** * WAYLAND_WindowPosChanged @@ -433,7 +455,7 @@ void WAYLAND_WindowPosChanged(HWND hwnd, HWND insert_after, HWND owner_hint, UIN struct wayland_surface *toplevel_surface; struct wayland_client_surface *client; struct wayland_win_data *data, *toplevel_data; - BOOL managed; + BOOL managed, needs_icon; TRACE("hwnd %p new_rects %s after %p flags %08x\n", hwnd, debugstr_window_rects(new_rects), insert_after, swp_flags); @@ -471,7 +493,28 @@ void WAYLAND_WindowPosChanged(HWND hwnd, HWND insert_after, HWND owner_hint, UIN wayland_win_data_update_wayland_state(data); } + needs_icon = data->wayland_surface && !data->wayland_surface->big_icon_buffer && + data->wayland_surface->role == WAYLAND_SURFACE_ROLE_TOPLEVEL && + data->wayland_surface->xdg_toplevel && + process_wayland.xdg_toplevel_icon_manager_v1; + wayland_win_data_release(data); + + if (needs_icon) + { + HICON big, small; + ICONINFO ii, ii_small; + big = get_window_icon(hwnd, ICON_BIG, 0, &ii); + small = get_window_icon(hwnd, ICON_SMALL, 0, &ii_small); + + if((data = wayland_win_data_get(hwnd))) + { + if (big) wayland_surface_set_icon(data->wayland_surface, ICON_BIG, &ii); + if (small) wayland_surface_set_icon(data->wayland_surface, ICON_SMALL, &ii_small); + + wayland_win_data_release(data); + } + } } static void wayland_configure_window(HWND hwnd) @@ -642,6 +685,30 @@ static enum xdg_toplevel_resize_edge hittest_to_resize_edge(WPARAM hittest) } } +/***************************************************************** + * WAYLAND_SetWindowIcon + */ +void WAYLAND_SetWindowIcon(HWND hwnd, UINT type, HICON icon) +{ + struct wayland_win_data *data; + ICONINFO ii; + + TRACE("hwnd=%p type=%u icon=%p\n", hwnd, type, icon); + + if (process_wayland.xdg_toplevel_icon_manager_v1) + { + icon = get_window_icon(hwnd, type, icon, &ii); + if (icon && (data = wayland_win_data_get(hwnd))) + { + if (data->wayland_surface && + data->wayland_surface->role == WAYLAND_SURFACE_ROLE_TOPLEVEL && + data->wayland_surface->xdg_toplevel) + wayland_surface_set_icon(data->wayland_surface, type, &ii); + wayland_win_data_release(data); + } + } +} + /***************************************************************** * WAYLAND_SetWindowText */ diff --git a/dlls/winewayland.drv/xdg-toplevel-icon-v1.xml b/dlls/winewayland.drv/xdg-toplevel-icon-v1.xml new file mode 100644 index 00000000000..fc409fef7c6 --- /dev/null +++ b/dlls/winewayland.drv/xdg-toplevel-icon-v1.xml @@ -0,0 +1,205 @@ +<?xml version="1.0" encoding="UTF-8"?> +<protocol name="xdg_toplevel_icon_v1"> + + <copyright> + Copyright © 2023-2024 Matthias Klumpp + Copyright © 2024 David Edmundson + + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and associated documentation files (the "Software"), + to deal in the Software without restriction, including without limitation + the rights to use, copy, modify, merge, publish, distribute, sublicense, + and/or sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice (including the next + paragraph) shall be included in all copies or substantial portions of the + Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + DEALINGS IN THE SOFTWARE. + </copyright> + + <description summary="protocol to assign icons to toplevels"> + This protocol allows clients to set icons for their toplevel surfaces + either via the XDG icon stock (using an icon name), or from pixel data. + + A toplevel icon represents the individual toplevel (unlike the application + or launcher icon, which represents the application as a whole), and may be + shown in window switchers, window overviews and taskbars that list + individual windows. + + This document adheres to RFC 2119 when using words like "must", + "should", "may", etc. + + Warning! The protocol described in this file is currently in the testing + phase. Backward compatible changes may be added together with the + corresponding interface version bump. Backward incompatible changes can + only be done by creating a new major version of the extension. + </description> + + <interface name="xdg_toplevel_icon_manager_v1" version="1"> + <description summary="interface to manage toplevel icons"> + This interface allows clients to create toplevel window icons and set + them on toplevel windows to be displayed to the user. + </description> + + <request name="destroy" type="destructor"> + <description summary="destroy the toplevel icon manager"> + Destroy the toplevel icon manager. + This does not destroy objects created with the manager. + </description> + </request> + + <request name="create_icon"> + <description summary="create a new icon instance"> + Creates a new icon object. This icon can then be attached to a + xdg_toplevel via the 'set_icon' request. + </description> + <arg name="id" type="new_id" interface="xdg_toplevel_icon_v1"/> + </request> + + <request name="set_icon"> + <description summary="set an icon on a toplevel window"> + This request assigns the icon 'icon' to 'toplevel', or clears the + toplevel icon if 'icon' was null. + This state is double-buffered and is applied on the next + wl_surface.commit of the toplevel. + + After making this call, the xdg_toplevel_icon_v1 provided as 'icon' + can be destroyed by the client without 'toplevel' losing its icon. + The xdg_toplevel_icon_v1 is immutable from this point, and any + future attempts to change it must raise the + 'xdg_toplevel_icon_v1.immutable' protocol error. + + The compositor must set the toplevel icon from either the pixel data + the icon provides, or by loading a stock icon using the icon name. + See the description of 'xdg_toplevel_icon_v1' for details. + + If 'icon' is set to null, the icon of the respective toplevel is reset + to its default icon (usually the icon of the application, derived from + its desktop-entry file, or a placeholder icon). + If this request is passed an icon with no pixel buffers or icon name + assigned, the icon must be reset just like if 'icon' was null. + </description> + <arg name="toplevel" type="object" interface="xdg_toplevel" summary="the toplevel to act on"/> + <arg name="icon" type="object" interface="xdg_toplevel_icon_v1" allow-null="true"/> + </request> + + <event name="icon_size"> + <description summary="describes a supported & preferred icon size"> + This event indicates an icon size the compositor prefers to be + available if the client has scalable icons and can render to any size. + + When the 'xdg_toplevel_icon_manager_v1' object is created, the + compositor may send one or more 'icon_size' events to describe the list + of preferred icon sizes. If the compositor has no size preference, it + may not send any 'icon_size' event, and it is up to the client to + decide a suitable icon size. + + A sequence of 'icon_size' events must be finished with a 'done' event. + If the compositor has no size preferences, it must still send the + 'done' event, without any preceding 'icon_size' events. + </description> + <arg name="size" type="int" + summary="the edge size of the square icon in surface-local coordinates, e.g. 64"/> + </event> + + <event name="done"> + <description summary="all information has been sent"> + This event is sent after all 'icon_size' events have been sent. + </description> + </event> + </interface> + + <interface name="xdg_toplevel_icon_v1" version="1"> + <description summary="a toplevel window icon"> + This interface defines a toplevel icon. + An icon can have a name, and multiple buffers. + In order to be applied, the icon must have either a name, or at least + one buffer assigned. Applying an empty icon (with no buffer or name) to + a toplevel should reset its icon to the default icon. + + It is up to compositor policy whether to prefer using a buffer or loading + an icon via its name. See 'set_name' and 'add_buffer' for details. + </description> + + <enum name="error"> + <entry name="invalid_buffer" + summary="the provided buffer does not satisfy requirements" + value="1"/> + <entry name="immutable" + summary="the icon has already been assigned to a toplevel and must not be changed" + value="2"/> + <entry name="no_buffer" + summary="the provided buffer has been destroyed before the toplevel icon" + value="3"/> + </enum> + + <request name="destroy" type="destructor"> + <description summary="destroy the icon object"> + Destroys the 'xdg_toplevel_icon_v1' object. + The icon must still remain set on every toplevel it was assigned to, + until the toplevel icon is reset explicitly. + </description> + </request> + + <request name="set_name"> + <description summary="set an icon name"> + This request assigns an icon name to this icon. + Any previously set name is overridden. + + The compositor must resolve 'icon_name' according to the lookup rules + described in the XDG icon theme specification[1] using the + environment's current icon theme. + + If the compositor does not support icon names or cannot resolve + 'icon_name' according to the XDG icon theme specification it must + fall back to using pixel buffer data instead. + + If this request is made after the icon has been assigned to a toplevel + via 'set_icon', a 'immutable' error must be raised. + + [1]: https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-lates... + </description> + <arg name="icon_name" type="string"/> + </request> + + <request name="add_buffer"> + <description summary="add icon data from a pixel buffer"> + This request adds pixel data supplied as wl_buffer to the icon. + + The client should add pixel data for all icon sizes and scales that + it can provide, or which are explicitly requested by the compositor + via 'icon_size' events on xdg_toplevel_icon_manager_v1. + + The wl_buffer supplying pixel data as 'buffer' must be backed by wl_shm + and must be a square (width and height being equal). + If any of these buffer requirements are not fulfilled, a 'invalid_buffer' + error must be raised. + + If this icon instance already has a buffer of the same size and scale + from a previous 'add_buffer' request, data from the last request + overrides the preexisting pixel data. + + The wl_buffer must be kept alive for as long as the xdg_toplevel_icon + it is associated with is not destroyed, otherwise a 'no_buffer' error + is raised. The buffer contents must not be modified after it was + assigned to the icon. As a result, the region of the wl_shm_pool's + backing storage used for the wl_buffer must not be modified after this + request is sent. The wl_buffer.release event is unused. + + If this request is made after the icon has been assigned to a toplevel + via 'set_icon', a 'immutable' error must be raised. + </description> + <arg name="buffer" type="object" interface="wl_buffer"/> + <arg name="scale" type="int" + summary="the scaling factor of the icon, e.g. 1"/> + </request> + </interface> +</protocol> -- GitLab https://gitlab.winehq.org/wine/wine/-/merge_requests/6938
v4: applied suggestions again -- https://gitlab.winehq.org/wine/wine/-/merge_requests/6938#note_100448
This merge request was approved by Alexandros Frantzis. -- https://gitlab.winehq.org/wine/wine/-/merge_requests/6938
@etaash.mathamsetty Thanks! -- https://gitlab.winehq.org/wine/wine/-/merge_requests/6938#note_100554
participants (3)
-
Alexandros Frantzis (＠afrantzis) -
Etaash Mathamsetty
-
Etaash Mathamsetty (＠etaash.mathamsetty)