FreeRDP
Loading...
Searching...
No Matches
xf_window.c
1
23#include <freerdp/config.h>
24
25#include <stdarg.h>
26#include <stdint.h>
27#include <unistd.h>
28#include <sys/types.h>
29
30#include <X11/Xlib.h>
31#include <X11/Xutil.h>
32#include <X11/Xatom.h>
33
34#include <sys/mman.h>
35#include <sys/stat.h>
36#include <fcntl.h>
37
38#include <winpr/assert.h>
39#include <winpr/thread.h>
40#include <winpr/crt.h>
41#include <winpr/string.h>
42
43#include <freerdp/rail.h>
44#include <freerdp/log.h>
45
46#ifdef WITH_XEXT
47#include <X11/extensions/shape.h>
48#endif
49
50#ifdef WITH_XI
51#include <X11/extensions/XInput2.h>
52#endif
53
54#include "xf_gfx.h"
55#include "xf_rail.h"
56#include "xf_input.h"
57#include "xf_keyboard.h"
58#include "xf_utils.h"
59#include "xf_debug.h"
60
61#define TAG CLIENT_TAG("x11")
62
63#include <FreeRDP_Icon_256px.h>
64#define xf_icon_prop FreeRDP_Icon_256px_prop
65
66#include "xf_window.h"
67
68/* Extended Window Manager Hints: http://standards.freedesktop.org/wm-spec/wm-spec-1.3.html */
69
70/* bit definitions for MwmHints.flags */
71#define MWM_HINTS_FUNCTIONS (1L << 0)
72#define MWM_HINTS_DECORATIONS (1L << 1)
73// #define MWM_HINTS_INPUT_MODE (1L << 2)
74// #define MWM_HINTS_STATUS (1L << 3)
75
76/* bit definitions for MwmHints.functions */
77#define MWM_FUNC_ALL (1L << 0)
78// #define MWM_FUNC_RESIZE (1L << 1)
79// #define MWM_FUNC_MOVE (1L << 2)
80// #define MWM_FUNC_MINIMIZE (1L << 3)
81// #define MWM_FUNC_MAXIMIZE (1L << 4)
82// #define MWM_FUNC_CLOSE (1L << 5)
83
84/* bit definitions for MwmHints.decorations */
85#define MWM_DECOR_ALL (1L << 0)
86// #define MWM_DECOR_BORDER (1L << 1)
87// #define MWM_DECOR_RESIZEH (1L << 2)
88// #define MWM_DECOR_TITLE (1L << 3)
89// #define MWM_DECOR_MENU (1L << 4)
90// #define MWM_DECOR_MINIMIZE (1L << 5)
91// #define MWM_DECOR_MAXIMIZE (1L << 6)
92
93#define PROP_MOTIF_WM_HINTS_ELEMENTS 5
94
95#define ENTRY(x) \
96 case x: \
97 return #x
98
99typedef struct
100{
101 unsigned long flags;
102 unsigned long functions;
103 unsigned long decorations;
104 long inputMode;
105 unsigned long status;
106} PropMotifWmHints;
107
108static void xf_XSetTransientForHint(xfContext* xfc, xfAppWindow* window);
109
110static const char* window_style_to_string(UINT32 style)
111{
112 switch (style)
113 {
114 ENTRY(WS_NONE);
115 ENTRY(WS_BORDER);
116 ENTRY(WS_CAPTION);
117 ENTRY(WS_CHILD);
118 ENTRY(WS_CLIPCHILDREN);
119 ENTRY(WS_CLIPSIBLINGS);
120 ENTRY(WS_DISABLED);
121 ENTRY(WS_DLGFRAME);
122 ENTRY(WS_GROUP);
123 ENTRY(WS_HSCROLL);
124 ENTRY(WS_MAXIMIZE);
125 ENTRY(WS_MAXIMIZEBOX);
126 ENTRY(WS_MINIMIZE);
127 ENTRY(WS_OVERLAPPEDWINDOW);
128 ENTRY(WS_POPUP);
129 ENTRY(WS_POPUPWINDOW);
130 ENTRY(WS_SIZEBOX);
131 ENTRY(WS_SYSMENU);
132 ENTRY(WS_VISIBLE);
133 ENTRY(WS_VSCROLL);
134 default:
135 return nullptr;
136 }
137}
138
139const char* window_styles_to_string(UINT32 style, char* buffer, size_t length)
140{
141 (void)_snprintf(buffer, length, "style[0x%08" PRIx32 "] {", style);
142 const char* sep = "";
143 for (size_t x = 0; x < 32; x++)
144 {
145 const UINT32 val = 1u << x;
146 if ((style & val) != 0)
147 {
148 const char* str = window_style_to_string(val);
149 if (str)
150 {
151 winpr_str_append(str, buffer, length, sep);
152 sep = "|";
153 }
154 }
155 }
156 winpr_str_append("}", buffer, length, "");
157
158 return buffer;
159}
160
161static const char* window_style_ex_to_string(UINT32 styleEx)
162{
163 switch (styleEx)
164 {
165 ENTRY(WS_EX_ACCEPTFILES);
166 ENTRY(WS_EX_APPWINDOW);
167 ENTRY(WS_EX_CLIENTEDGE);
168 ENTRY(WS_EX_COMPOSITED);
169 ENTRY(WS_EX_CONTEXTHELP);
170 ENTRY(WS_EX_CONTROLPARENT);
171 ENTRY(WS_EX_DLGMODALFRAME);
172 ENTRY(WS_EX_LAYERED);
173 ENTRY(WS_EX_LAYOUTRTL);
174 ENTRY(WS_EX_LEFTSCROLLBAR);
175 ENTRY(WS_EX_MDICHILD);
176 ENTRY(WS_EX_NOACTIVATE);
177 ENTRY(WS_EX_NOINHERITLAYOUT);
178 ENTRY(WS_EX_NOPARENTNOTIFY);
179 ENTRY(WS_EX_OVERLAPPEDWINDOW);
180 ENTRY(WS_EX_PALETTEWINDOW);
181 ENTRY(WS_EX_RIGHT);
182 ENTRY(WS_EX_RIGHTSCROLLBAR);
183 ENTRY(WS_EX_RTLREADING);
184 ENTRY(WS_EX_STATICEDGE);
185 ENTRY(WS_EX_TOOLWINDOW);
186 ENTRY(WS_EX_TOPMOST);
187 ENTRY(WS_EX_TRANSPARENT);
188 ENTRY(WS_EX_WINDOWEDGE);
189 default:
190 return nullptr;
191 }
192}
193
194const char* window_styles_ex_to_string(UINT32 styleEx, char* buffer, size_t length)
195{
196 (void)_snprintf(buffer, length, "styleEx[0x%08" PRIx32 "] {", styleEx);
197 const char* sep = "";
198 for (size_t x = 0; x < 32; x++)
199 {
200 const UINT32 val = (UINT32)(1UL << x);
201 if ((styleEx & val) != 0)
202 {
203 const char* str = window_style_ex_to_string(val);
204 if (str)
205 {
206 winpr_str_append(str, buffer, length, sep);
207 sep = "|";
208 }
209 }
210 }
211 winpr_str_append("}", buffer, length, "");
212
213 return buffer;
214}
215
216static void xf_SetWindowTitleText(xfContext* xfc, Window window, const char* name)
217{
218 WINPR_ASSERT(xfc);
219 WINPR_ASSERT(name);
220
221 const size_t i = strnlen(name, MAX_PATH);
222 XStoreName(xfc->display, window, name);
223 Atom wm_Name = xfc->NET_WM_NAME;
224 Atom utf8Str = xfc->UTF8_STRING;
225 LogDynAndXChangeProperty(xfc->log, xfc->display, window, wm_Name, utf8Str, 8, PropModeReplace,
226 (const unsigned char*)name, (int)i);
227}
228
232void xf_SendClientEvent(xfContext* xfc, Window window, Atom atom, unsigned int numArgs, ...)
233{
234 XEvent xevent = WINPR_C_ARRAY_INIT;
235 va_list argp = WINPR_C_ARRAY_INIT;
236 va_start(argp, numArgs);
237
238 xevent.xclient.type = ClientMessage;
239 xevent.xclient.serial = 0;
240 xevent.xclient.send_event = False;
241 xevent.xclient.display = xfc->display;
242 xevent.xclient.window = window;
243 xevent.xclient.message_type = atom;
244 xevent.xclient.format = 32;
245
246 for (size_t i = 0; i < numArgs; i++)
247 {
248 xevent.xclient.data.l[i] = va_arg(argp, int);
249 }
250
251 WLog_Print(xfc->log, WLOG_TRACE, "Send ClientMessage Event: wnd=0x%04lX",
252 (unsigned long)xevent.xclient.window);
253 LogDynAndXSendEvent(xfc->log, xfc->display, RootWindowOfScreen(xfc->screen), False,
254 SubstructureRedirectMask | SubstructureNotifyMask, &xevent);
255 LogDynAndXSync(xfc->log, xfc->display, False);
256 va_end(argp);
257}
258
259void xf_SetWindowMinimized(xfContext* xfc, xfWindow* window)
260{
261 XIconifyWindow(xfc->display, window->handle, xfc->screen_number);
262}
263
264void xf_SetWindowFullscreen(xfContext* xfc, xfWindow* window, BOOL fullscreen)
265{
266 const rdpSettings* settings = nullptr;
267 int startX = 0;
268 int startY = 0;
269 UINT32 width = WINPR_ASSERTING_INT_CAST(uint32_t, window->width);
270 UINT32 height = WINPR_ASSERTING_INT_CAST(uint32_t, window->height);
271
272 WINPR_ASSERT(xfc);
273
274 settings = xfc->common.context.settings;
275 WINPR_ASSERT(settings);
276
277 /* xfc->decorations is set by caller depending on settings and whether it is fullscreen or not
278 */
279 window->decorations = xfc->decorations;
280 /* show/hide decorations (e.g. title bar) as guided by xfc->decorations */
281 xf_SetWindowDecorations(xfc, window->handle, window->decorations);
282 WLog_Print(xfc->log, WLOG_TRACE, "X window decoration set to %d", (int)window->decorations);
283 xf_floatbar_toggle_fullscreen(xfc->window->floatbar, fullscreen);
284
285 if (fullscreen)
286 {
287 xfc->savedWidth = xfc->window->width;
288 xfc->savedHeight = xfc->window->height;
289 xfc->savedPosX = xfc->window->left;
290 xfc->savedPosY = xfc->window->top;
291
292 startX = (freerdp_settings_get_uint32(settings, FreeRDP_DesktopPosX) != UINT32_MAX)
293 ? WINPR_ASSERTING_INT_CAST(
294 int, freerdp_settings_get_uint32(settings, FreeRDP_DesktopPosX))
295 : 0;
296 startY = (freerdp_settings_get_uint32(settings, FreeRDP_DesktopPosY) != UINT32_MAX)
297 ? WINPR_ASSERTING_INT_CAST(
298 int, freerdp_settings_get_uint32(settings, FreeRDP_DesktopPosY))
299 : 0;
300 }
301 else
302 {
303 width = WINPR_ASSERTING_INT_CAST(uint32_t, xfc->savedWidth);
304 height = WINPR_ASSERTING_INT_CAST(uint32_t, xfc->savedHeight);
305 startX = xfc->savedPosX;
306 startY = xfc->savedPosY;
307 }
308
309 /* Determine the x,y starting location for the fullscreen window */
310 if (fullscreen)
311 {
312 const rdpMonitor* firstMonitor =
313 freerdp_settings_get_pointer_array(settings, FreeRDP_MonitorDefArray, 0);
314 /* Initialize startX and startY with reasonable values */
315 startX = firstMonitor->x;
316 startY = firstMonitor->y;
317
318 /* Search all monitors to find the lowest startX and startY values */
319 for (size_t i = 0; i < freerdp_settings_get_uint32(settings, FreeRDP_MonitorCount); i++)
320 {
321 const rdpMonitor* monitor =
322 freerdp_settings_get_pointer_array(settings, FreeRDP_MonitorDefArray, i);
323 startX = MIN(startX, monitor->x);
324 startY = MIN(startY, monitor->y);
325 }
326
327 /* Lastly apply any monitor shift(translation from remote to local coordinate system)
328 * to startX and startY values
329 */
330 startX += freerdp_settings_get_int32(settings, FreeRDP_MonitorLocalShiftX);
331 startY += freerdp_settings_get_int32(settings, FreeRDP_MonitorLocalShiftY);
332 }
333
334 /*
335 It is safe to proceed with simply toggling _NET_WM_STATE_FULLSCREEN window state on the
336 following conditions:
337 - The window manager supports multiple monitor full screen
338 - The user requested to use a single monitor to render the remote desktop
339 */
340 if (xfc->NET_WM_FULLSCREEN_MONITORS != None ||
341 freerdp_settings_get_uint32(settings, FreeRDP_MonitorCount) == 1)
342 {
343 xf_ResizeDesktopWindow(xfc, window, WINPR_ASSERTING_INT_CAST(int, width),
344 WINPR_ASSERTING_INT_CAST(int, height));
345
346 if (fullscreen)
347 {
348 /* enter full screen: move the window before adding NET_WM_STATE_FULLSCREEN */
349 LogDynAndXMoveWindow(xfc->log, xfc->display, window->handle, startX, startY);
350 }
351
352 /* Set the fullscreen state */
353 xf_SendClientEvent(xfc, window->handle, xfc->NET_WM_STATE, 4,
354 fullscreen ? NET_WM_STATE_ADD : NET_WM_STATE_REMOVE,
355 xfc->NET_WM_STATE_FULLSCREEN, 0, 0);
356
357 if (!fullscreen)
358 {
359 /* leave full screen: move the window after removing NET_WM_STATE_FULLSCREEN
360 * Resize the window again, the previous call to xf_SendClientEvent might have
361 * changed the window size (borders, ...)
362 */
363 xf_ResizeDesktopWindow(xfc, window, WINPR_ASSERTING_INT_CAST(int, width),
364 WINPR_ASSERTING_INT_CAST(int, height));
365 LogDynAndXMoveWindow(xfc->log, xfc->display, window->handle, startX, startY);
366 }
367
368 /* Set monitor bounds */
369 if (freerdp_settings_get_uint32(settings, FreeRDP_MonitorCount) > 1)
370 {
371 xf_SendClientEvent(xfc, window->handle, xfc->NET_WM_FULLSCREEN_MONITORS, 5,
372 xfc->fullscreenMonitors.top, xfc->fullscreenMonitors.bottom,
373 xfc->fullscreenMonitors.left, xfc->fullscreenMonitors.right, 1);
374 }
375 }
376 else
377 {
378 if (fullscreen)
379 {
380 xf_SetWindowDecorations(xfc, window->handle, FALSE);
381
382 if (xfc->fullscreenMonitors.top)
383 {
384 xf_SendClientEvent(xfc, window->handle, xfc->NET_WM_STATE, 4, NET_WM_STATE_ADD,
385 xfc->fullscreenMonitors.top, 0, 0);
386 }
387 else
388 {
389 XSetWindowAttributes xswa = WINPR_C_ARRAY_INIT;
390 xswa.override_redirect = True;
391 LogDynAndXChangeWindowAttributes(xfc->log, xfc->display, window->handle,
392 CWOverrideRedirect, &xswa);
393 LogDynAndXRaiseWindow(xfc->log, xfc->display, window->handle);
394 xswa.override_redirect = False;
395 LogDynAndXChangeWindowAttributes(xfc->log, xfc->display, window->handle,
396 CWOverrideRedirect, &xswa);
397 }
398
399 /* if window is in maximized state, save and remove */
400 if (xfc->NET_WM_STATE_MAXIMIZED_VERT != None)
401 {
402 BYTE state = 0;
403 unsigned long nitems = 0;
404 unsigned long bytes = 0;
405 BYTE* prop = nullptr;
406
407 if (xf_GetWindowProperty(xfc, window->handle, xfc->NET_WM_STATE, 255, &nitems,
408 &bytes, &prop))
409 {
410 const Atom* aprop = (const Atom*)prop;
411 state = 0;
412
413 for (size_t x = 0; x < nitems; x++)
414 {
415 if (aprop[x] == xfc->NET_WM_STATE_MAXIMIZED_VERT)
416 state |= 0x01;
417
418 if (aprop[x] == xfc->NET_WM_STATE_MAXIMIZED_HORZ)
419 state |= 0x02;
420 }
421
422 if (state)
423 {
424 xf_SendClientEvent(xfc, window->handle, xfc->NET_WM_STATE, 4,
425 NET_WM_STATE_REMOVE, xfc->NET_WM_STATE_MAXIMIZED_VERT, 0,
426 0);
427 xf_SendClientEvent(xfc, window->handle, xfc->NET_WM_STATE, 4,
428 NET_WM_STATE_REMOVE, xfc->NET_WM_STATE_MAXIMIZED_HORZ, 0,
429 0);
430 xfc->savedMaximizedState = state;
431 }
432
433 XFree(prop);
434 }
435 }
436
437 width = xfc->vscreen.area.right - xfc->vscreen.area.left + 1;
438 height = xfc->vscreen.area.bottom - xfc->vscreen.area.top + 1;
439 WLog_Print(xfc->log, WLOG_TRACE,
440 "X window move and resize %dx%d@%" PRIu32 "x%" PRIu32 "", startX, startY,
441 width, height);
442 xf_ResizeDesktopWindow(xfc, window, WINPR_ASSERTING_INT_CAST(int, width),
443 WINPR_ASSERTING_INT_CAST(int, height));
444 LogDynAndXMoveWindow(xfc->log, xfc->display, window->handle, startX, startY);
445 }
446 else
447 {
448 xf_SetWindowDecorations(xfc, window->handle, window->decorations);
449 xf_ResizeDesktopWindow(xfc, window, WINPR_ASSERTING_INT_CAST(int, width),
450 WINPR_ASSERTING_INT_CAST(int, height));
451 LogDynAndXMoveWindow(xfc->log, xfc->display, window->handle, startX, startY);
452
453 if (xfc->fullscreenMonitors.top)
454 {
455 xf_SendClientEvent(xfc, window->handle, xfc->NET_WM_STATE, 4, NET_WM_STATE_REMOVE,
456 xfc->fullscreenMonitors.top, 0, 0);
457 }
458
459 /* restore maximized state, if the window was maximized before setting fullscreen */
460 if (xfc->savedMaximizedState & 0x01)
461 {
462 xf_SendClientEvent(xfc, window->handle, xfc->NET_WM_STATE, 4, NET_WM_STATE_ADD,
463 xfc->NET_WM_STATE_MAXIMIZED_VERT, 0, 0);
464 }
465
466 if (xfc->savedMaximizedState & 0x02)
467 {
468 xf_SendClientEvent(xfc, window->handle, xfc->NET_WM_STATE, 4, NET_WM_STATE_ADD,
469 xfc->NET_WM_STATE_MAXIMIZED_HORZ, 0, 0);
470 }
471
472 xfc->savedMaximizedState = 0;
473 }
474 }
475}
476
477/* http://tronche.com/gui/x/xlib/window-information/XGetWindowProperty.html */
478
479BOOL xf_GetWindowProperty(xfContext* xfc, Window window, Atom property, int length,
480 unsigned long* nitems, unsigned long* bytes, BYTE** prop)
481{
482 int status = 0;
483 Atom actual_type = None;
484 int actual_format = 0;
485
486 WINPR_ASSERT(prop);
487
488 if (property == None)
489 return FALSE;
490
491 status = LogDynAndXGetWindowProperty(xfc->log, xfc->display, window, property, 0, length, False,
492 AnyPropertyType, &actual_type, &actual_format, nitems,
493 bytes, prop);
494
495 if (status != Success)
496 return FALSE;
497
498 if (actual_type == None)
499 {
500 WLog_DBG(TAG, "Property %lu does not exist", (unsigned long)property);
501 if (*prop)
502 XFree(*prop);
503 *prop = nullptr;
504 return FALSE;
505 }
506
507 return TRUE;
508}
509
510static BOOL xf_GetNumberOfDesktops(xfContext* xfc, Window root, unsigned* pval)
511{
512 unsigned long nitems = 0;
513 unsigned long bytes = 0;
514 BYTE* bprop = nullptr;
515
516 WINPR_ASSERT(xfc);
517 WINPR_ASSERT(pval);
518
519 const BOOL rc =
520 xf_GetWindowProperty(xfc, root, xfc->NET_NUMBER_OF_DESKTOPS, 1, &nitems, &bytes, &bprop);
521
522 long* prop = (long*)bprop;
523 *pval = 0;
524
525 BOOL res = FALSE;
526 if (rc)
527 {
528 if ((*prop >= 0) && (*prop <= UINT32_MAX))
529 {
530 *pval = (UINT32)*prop;
531 res = TRUE;
532 }
533 }
534 if (prop)
535 XFree(prop);
536 return res;
537}
538
539static BOOL xf_GetCurrentDesktop(xfContext* xfc, Window root)
540{
541 unsigned long nitems = 0;
542 unsigned long bytes = 0;
543 BYTE* bprop = nullptr;
544 unsigned max = 0;
545
546 if (!xf_GetNumberOfDesktops(xfc, root, &max))
547 return FALSE;
548 if (max < 1)
549 return FALSE;
550
551 const BOOL rc =
552 xf_GetWindowProperty(xfc, root, xfc->NET_CURRENT_DESKTOP, 1, &nitems, &bytes, &bprop);
553
554 long* prop = (long*)bprop;
555 xfc->current_desktop = 0;
556 if (rc)
557 xfc->current_desktop = (int)MIN(max - 1, *prop);
558 if (prop)
559 XFree(prop);
560 return rc;
561}
562
563static BOOL xf_GetWorkArea_NET_WORKAREA(xfContext* xfc, Window root)
564{
565 BOOL rc = FALSE;
566 unsigned long nitems = 0;
567 unsigned long bytes = 0;
568 BYTE* bprop = nullptr;
569
570 const BOOL status =
571 xf_GetWindowProperty(xfc, root, xfc->NET_WORKAREA, INT_MAX, &nitems, &bytes, &bprop);
572 long* prop = (long*)bprop;
573
574 if (!status)
575 goto fail;
576
577 if ((xfc->current_desktop * 4 + 3) >= (INT64)nitems)
578 goto fail;
579
580 xfc->workArea.x = (INT32)MIN(INT32_MAX, prop[xfc->current_desktop * 4 + 0]);
581 xfc->workArea.y = (INT32)MIN(INT32_MAX, prop[xfc->current_desktop * 4 + 1]);
582 xfc->workArea.width = (UINT32)MIN(UINT32_MAX, prop[xfc->current_desktop * 4 + 2]);
583 xfc->workArea.height = (UINT32)MIN(UINT32_MAX, prop[xfc->current_desktop * 4 + 3]);
584
585 rc = TRUE;
586fail:
587 XFree(prop);
588 return rc;
589}
590
591BOOL xf_GetWorkArea(xfContext* xfc)
592{
593 WINPR_ASSERT(xfc);
594
595 Window root = DefaultRootWindow(xfc->display);
596 (void)xf_GetCurrentDesktop(xfc, root);
597 return xf_GetWorkArea_NET_WORKAREA(xfc, root);
598}
599
600void xf_SetWindowDecorations(xfContext* xfc, Window window, BOOL show)
601{
602 PropMotifWmHints hints = { .decorations = (show) ? MWM_DECOR_ALL : 0,
603 .functions = MWM_FUNC_ALL,
604 .flags = MWM_HINTS_DECORATIONS | MWM_HINTS_FUNCTIONS,
605 .inputMode = 0,
606 .status = 0 };
607 WINPR_ASSERT(xfc);
608 LogDynAndXChangeProperty(xfc->log, xfc->display, window, xfc->MOTIF_WM_HINTS,
609 xfc->MOTIF_WM_HINTS, 32, PropModeReplace, (BYTE*)&hints,
610 PROP_MOTIF_WM_HINTS_ELEMENTS);
611}
612
613void xf_SetWindowUnlisted(xfContext* xfc, Window window)
614{
615 WINPR_ASSERT(xfc);
616 Atom window_state[] = { xfc->NET_WM_STATE_SKIP_PAGER, xfc->NET_WM_STATE_SKIP_TASKBAR };
617 LogDynAndXChangeProperty(xfc->log, xfc->display, window, xfc->NET_WM_STATE, XA_ATOM, 32,
618 PropModeReplace, (BYTE*)window_state, 2);
619}
620
621static void xf_SetWindowPID(xfContext* xfc, Window window, pid_t pid)
622{
623 Atom am_wm_pid = 0;
624
625 WINPR_ASSERT(xfc);
626 if (!pid)
627 pid = getpid();
628
629 am_wm_pid = xfc->NET_WM_PID;
630 LogDynAndXChangeProperty(xfc->log, xfc->display, window, am_wm_pid, XA_CARDINAL, 32,
631 PropModeReplace, (BYTE*)&pid, 1);
632}
633
634static const char* get_shm_id(void)
635{
636 static char shm_id[64];
637 (void)sprintf_s(shm_id, sizeof(shm_id), "/com.freerdp.xfreerdp.tsmf_%016X",
638 GetCurrentProcessId());
639 return shm_id;
640}
641
642Window xf_CreateDummyWindow(xfContext* xfc)
643{
644 return LogDynAndXCreateWindow(
645 xfc->log, xfc->display, RootWindowOfScreen(xfc->screen),
646 WINPR_ASSERTING_INT_CAST(int, xfc->workArea.x),
647 WINPR_ASSERTING_INT_CAST(int, xfc->workArea.y), 1, 1, 0, xfc->depth, InputOutput,
648 xfc->visual, WINPR_ASSERTING_INT_CAST(uint32_t, xfc->attribs_mask), &xfc->attribs);
649}
650
651void xf_DestroyDummyWindow(xfContext* xfc, Window window)
652{
653 if (window)
654 LogDynAndXDestroyWindow(xfc->log, xfc->display, window);
655}
656
657xfWindow* xf_CreateDesktopWindow(xfContext* xfc, char* name, int width, int height)
658{
659 XEvent xevent = WINPR_C_ARRAY_INIT;
660 int input_mask = 0;
661 XClassHint* classHints = nullptr;
662 xfWindow* window = (xfWindow*)calloc(1, sizeof(xfWindow));
663
664 if (!window)
665 return nullptr;
666
667 rdpSettings* settings = xfc->common.context.settings;
668 WINPR_ASSERT(settings);
669
670 Window parentWindow = (Window)freerdp_settings_get_uint64(settings, FreeRDP_ParentWindowId);
671 window->width = width;
672 window->height = height;
673 window->decorations = xfc->decorations;
674 window->is_mapped = FALSE;
675 window->is_transient = FALSE;
676
677 WINPR_ASSERT(xfc->depth != 0);
678 window->handle = LogDynAndXCreateWindow(
679 xfc->log, xfc->display, RootWindowOfScreen(xfc->screen),
680 WINPR_ASSERTING_INT_CAST(int, xfc->workArea.x),
681 WINPR_ASSERTING_INT_CAST(int, xfc->workArea.y), xfc->workArea.width, xfc->workArea.height,
682 0, xfc->depth, InputOutput, xfc->visual,
683 WINPR_ASSERTING_INT_CAST(uint32_t, xfc->attribs_mask), &xfc->attribs);
684 window->shmid = shm_open(get_shm_id(), (O_CREAT | O_RDWR), (S_IREAD | S_IWRITE));
685
686 if (window->shmid < 0)
687 {
688 WLog_Print(xfc->log, WLOG_TRACE,
689 "xf_CreateDesktopWindow: failed to get access to shared memory - shmget()\n");
690 }
691 else
692 {
693 int rc = ftruncate(window->shmid, sizeof(window->handle));
694 if (rc != 0)
695 {
696 char ebuffer[256] = WINPR_C_ARRAY_INIT;
697 WLog_Print(xfc->log, WLOG_TRACE, "ftruncate failed with %s [%d]",
698 winpr_strerror(rc, ebuffer, sizeof(ebuffer)), rc);
699 }
700 else
701 {
702 void* mem = mmap(nullptr, sizeof(window->handle), PROT_READ | PROT_WRITE, MAP_SHARED,
703 window->shmid, 0);
704
705 if (mem == MAP_FAILED)
706 {
707 WLog_Print(
708 xfc->log, WLOG_TRACE,
709 "xf_CreateDesktopWindow: failed to assign pointer to the memory address - "
710 "shmat()\n");
711 }
712 else
713 {
714 window->xfwin = mem;
715 *window->xfwin = window->handle;
716 }
717 }
718 }
719
720 classHints = XAllocClassHint();
721
722 if (classHints)
723 {
724 classHints->res_name = "xfreerdp";
725
726 char* res_class = nullptr;
727 const char* WmClass = freerdp_settings_get_string(settings, FreeRDP_WmClass);
728 if (WmClass)
729 res_class = _strdup(WmClass);
730 else
731 res_class = _strdup("xfreerdp");
732
733 classHints->res_class = res_class;
734 XSetClassHint(xfc->display, window->handle, classHints);
735 XFree(classHints);
736 free(res_class);
737 }
738
739 xf_ResizeDesktopWindow(xfc, window, width, height);
740 xf_SetWindowDecorations(xfc, window->handle, window->decorations);
741 xf_SetWindowPID(xfc, window->handle, 0);
742 input_mask = KeyPressMask | KeyReleaseMask | ButtonPressMask | ButtonReleaseMask |
743 VisibilityChangeMask | FocusChangeMask | StructureNotifyMask | PointerMotionMask |
744 ExposureMask | PropertyChangeMask;
745
746 if (xfc->grab_keyboard)
747 input_mask |= EnterWindowMask | LeaveWindowMask;
748
749 LogDynAndXChangeProperty(xfc->log, xfc->display, window->handle, xfc->NET_WM_ICON, XA_CARDINAL,
750 32, PropModeReplace, (BYTE*)xf_icon_prop, ARRAYSIZE(xf_icon_prop));
751
752 if (parentWindow)
753 LogDynAndXReparentWindow(xfc->log, xfc->display, window->handle, parentWindow, 0, 0);
754
755 XSelectInput(xfc->display, window->handle, input_mask);
756 LogDynAndXClearWindow(xfc->log, xfc->display, window->handle);
757 xf_SetWindowTitleText(xfc, window->handle, name);
758 LogDynAndXMapWindow(xfc->log, xfc->display, window->handle);
759 if (xf_input_init(xfc, window->handle) < 0)
760 {
761 xf_DestroyDesktopWindow(xfc, window);
762 return nullptr;
763 }
764
765 /*
766 * NOTE: This must be done here to handle reparenting the window,
767 * so that we don't miss the event and hang waiting for the next one
768 */
769 do
770 {
771 XMaskEvent(xfc->display, VisibilityChangeMask, &xevent);
772 } while (xevent.type != VisibilityNotify);
773
774 /*
775 * The XCreateWindow call will start the window in the upper-left corner of our current
776 * monitor instead of the upper-left monitor for remote app mode (which uses all monitors).
777 * This extra call after the window is mapped will position the login window correctly
778 */
779 if (freerdp_settings_get_bool(settings, FreeRDP_RemoteApplicationMode))
780 {
781 LogDynAndXMoveWindow(xfc->log, xfc->display, window->handle, 0, 0);
782 }
783 else if ((freerdp_settings_get_uint32(settings, FreeRDP_DesktopPosX) != UINT32_MAX) &&
784 (freerdp_settings_get_uint32(settings, FreeRDP_DesktopPosY) != UINT32_MAX))
785 {
786 LogDynAndXMoveWindow(xfc->log, xfc->display, window->handle,
787 WINPR_ASSERTING_INT_CAST(
788 int, freerdp_settings_get_uint32(settings, FreeRDP_DesktopPosX)),
789 WINPR_ASSERTING_INT_CAST(
790 int, freerdp_settings_get_uint32(settings, FreeRDP_DesktopPosY)));
791 }
792
793 window->floatbar = xf_floatbar_new(xfc, window->handle, name,
794 freerdp_settings_get_uint32(settings, FreeRDP_Floatbar));
795
796 if (xfc->XWAYLAND_MAY_GRAB_KEYBOARD)
797 xf_SendClientEvent(xfc, window->handle, xfc->XWAYLAND_MAY_GRAB_KEYBOARD, 1, 1);
798
799 return window;
800}
801
802void xf_ResizeDesktopWindow(xfContext* xfc, xfWindow* window, int width, int height)
803{
804 XSizeHints* size_hints = nullptr;
805 rdpSettings* settings = nullptr;
806
807 if (!xfc || !window)
808 return;
809
810 settings = xfc->common.context.settings;
811 WINPR_ASSERT(settings);
812
813 if (!(size_hints = XAllocSizeHints()))
814 return;
815
816 size_hints->flags = PMinSize | PMaxSize | PWinGravity;
817 size_hints->win_gravity = NorthWestGravity;
818 size_hints->min_width = size_hints->min_height = 1;
819 size_hints->max_width = size_hints->max_height = 16384;
820 LogDynAndXResizeWindow(xfc->log, xfc->display, window->handle,
821 WINPR_ASSERTING_INT_CAST(uint32_t, width),
822 WINPR_ASSERTING_INT_CAST(uint32_t, height));
823#ifdef WITH_XRENDER
824
825 if (!freerdp_settings_get_bool(settings, FreeRDP_SmartSizing) &&
826 !freerdp_settings_get_bool(settings, FreeRDP_DynamicResolutionUpdate))
827#endif
828 {
829 if (!xfc->fullscreen)
830 {
831 /* min == max is an hint for the WM to indicate that the window should
832 * not be resizable */
833 size_hints->min_width = size_hints->max_width = width;
834 size_hints->min_height = size_hints->max_height = height;
835 }
836 }
837
838 XSetWMNormalHints(xfc->display, window->handle, size_hints);
839 XFree(size_hints);
840}
841
842void xf_DestroyDesktopWindow(xfContext* xfc, xfWindow* window)
843{
844 WINPR_ASSERT(xfc);
845
846 if (!window)
847 return;
848
849 if (xfc->window == window)
850 xfc->window = nullptr;
851
852 /* Reset XI2 event flags so standard X11 events are processed for RAIL
853 * windows. The per-window XI2 registrations were on the now-destroyed
854 * desktop window and will no longer fire. */
855 xfc->xi_event = false;
856 xfc->xi_rawevent = false;
857 xf_ungrab(xfc);
858
859 xf_floatbar_free(window->floatbar);
860
861 if (window->gc)
862 LogDynAndXFreeGC(xfc->log, xfc->display, window->gc);
863
864 if (window->handle)
865 {
866 LogDynAndXUnmapWindow(xfc->log, xfc->display, window->handle);
867 LogDynAndXDestroyWindow(xfc->log, xfc->display, window->handle);
868 }
869
870 if (window->xfwin)
871 munmap(window->xfwin, sizeof(*window->xfwin));
872
873 if (window->shmid >= 0)
874 close(window->shmid);
875
876 shm_unlink(get_shm_id());
877 window->xfwin = (Window*)-1;
878 window->shmid = -1;
879 free(window);
880}
881
882void xf_SetWindowStyle(xfContext* xfc, xfAppWindow* appWindow, UINT32 style, UINT32 ex_style)
883{
884 Atom window_type = 0;
885 BOOL redirect = FALSE;
886
887 window_type = xfc->NET_WM_WINDOW_TYPE_NORMAL;
888
889 if ((ex_style & WS_EX_NOACTIVATE) || (ex_style & WS_EX_TOOLWINDOW))
890 {
891 redirect = TRUE;
892 appWindow->is_transient = TRUE;
893 xf_SetWindowUnlisted(xfc, appWindow->handle);
894 window_type = xfc->NET_WM_WINDOW_TYPE_DROPDOWN_MENU;
895 }
896 /*
897 * TOPMOST window that is not a tool window is treated like a regular window (i.e. task
898 * manager). Want to do this here, since the window may have type WS_POPUP
899 */
900 else if (ex_style & WS_EX_TOPMOST)
901 {
902 window_type = xfc->NET_WM_WINDOW_TYPE_NORMAL;
903 }
904
905 if (style & WS_POPUP)
906 {
907 window_type = xfc->NET_WM_WINDOW_TYPE_DIALOG;
908 /* this includes dialogs, popups, etc, that need to be full-fledged windows */
909
910 if (!((ex_style & WS_EX_DLGMODALFRAME) || (ex_style & WS_EX_LAYERED) ||
911 (style & WS_SYSMENU)))
912 {
913 appWindow->is_transient = TRUE;
914 redirect = TRUE;
915
916 xf_SetWindowUnlisted(xfc, appWindow->handle);
917 }
918 }
919
920 if (!(style == 0 && ex_style == 0))
921 {
922 xf_SetWindowActions(xfc, appWindow);
923 }
924
925 {
926 /*
927 * Tooltips and menu items should be unmanaged windows
928 * (called "override redirect" in X windows parlance)
929 * If they are managed, there are issues with window focus that
930 * cause the windows to behave improperly. For example, a mouse
931 * press will dismiss a drop-down menu because the RDP server
932 * sees that as a focus out event from the window owning the
933 * dropdown.
934 */
935 XSetWindowAttributes attrs = WINPR_C_ARRAY_INIT;
936 attrs.override_redirect = redirect ? True : False;
937 LogDynAndXChangeWindowAttributes(xfc->log, xfc->display, appWindow->handle,
938 CWOverrideRedirect, &attrs);
939 }
940
941 LogDynAndXChangeProperty(xfc->log, xfc->display, appWindow->handle, xfc->NET_WM_WINDOW_TYPE,
942 XA_ATOM, 32, PropModeReplace, (BYTE*)&window_type, 1);
943
944 const BOOL above = (ex_style & WS_EX_TOPMOST) != 0;
945 const BOOL transient = (style & WS_CHILD) == 0;
946
947 if (transient)
948 xf_XSetTransientForHint(
949 xfc, appWindow); // xf_XSetTransientForHint only sets the hint if there is a parent
950
951 xf_SendClientEvent(xfc, appWindow->handle, xfc->NET_WM_STATE, 4,
952 above ? NET_WM_STATE_ADD : NET_WM_STATE_REMOVE, xfc->NET_WM_STATE_ABOVE, 0,
953 0);
954}
955
956void xf_SetWindowActions(xfContext* xfc, xfAppWindow* appWindow)
957{
958 Atom allowed_actions[] = {
959 xfc->NET_WM_ACTION_CLOSE, xfc->NET_WM_ACTION_MINIMIZE,
960 xfc->NET_WM_ACTION_MOVE, xfc->NET_WM_ACTION_RESIZE,
961 xfc->NET_WM_ACTION_MAXIMIZE_HORZ, xfc->NET_WM_ACTION_MAXIMIZE_VERT,
962 xfc->NET_WM_ACTION_FULLSCREEN, xfc->NET_WM_ACTION_CHANGE_DESKTOP
963 };
964
965 if (!(appWindow->dwStyle & WS_SYSMENU))
966 allowed_actions[0] = 0;
967
968 if (!(appWindow->dwStyle & WS_MINIMIZEBOX))
969 allowed_actions[1] = 0;
970
971 if (!(appWindow->dwStyle & WS_SIZEBOX))
972 allowed_actions[3] = 0;
973
974 if (!(appWindow->dwStyle & WS_MAXIMIZEBOX))
975 {
976 allowed_actions[4] = 0;
977 allowed_actions[5] = 0;
978 allowed_actions[6] = 0;
979 }
980
981 LogDynAndXChangeProperty(xfc->log, xfc->display, appWindow->handle, xfc->NET_WM_ALLOWED_ACTIONS,
982 XA_ATOM, 32, PropModeReplace, (unsigned char*)&allowed_actions, 8);
983}
984
985void xf_SetWindowText(xfContext* xfc, xfAppWindow* appWindow, const char* name)
986{
987 xf_SetWindowTitleText(xfc, appWindow->handle, name);
988}
989
990static void xf_FixWindowCoordinates(xfContext* xfc, int* x, int* y, int* width, int* height)
991{
992 int vscreen_width = 0;
993 int vscreen_height = 0;
994 vscreen_width = xfc->vscreen.area.right - xfc->vscreen.area.left + 1;
995 vscreen_height = xfc->vscreen.area.bottom - xfc->vscreen.area.top + 1;
996
997 if (*x < xfc->vscreen.area.left)
998 {
999 *width += *x;
1000 *x = xfc->vscreen.area.left;
1001 }
1002
1003 if (*y < xfc->vscreen.area.top)
1004 {
1005 *height += *y;
1006 *y = xfc->vscreen.area.top;
1007 }
1008
1009 if (*width > vscreen_width)
1010 {
1011 *width = vscreen_width;
1012 }
1013
1014 if (*height > vscreen_height)
1015 {
1016 *height = vscreen_height;
1017 }
1018
1019 if (*width < 1)
1020 {
1021 *width = 1;
1022 }
1023
1024 if (*height < 1)
1025 {
1026 *height = 1;
1027 }
1028}
1029
1030int xf_AppWindowInit(xfContext* xfc, xfAppWindow* appWindow)
1031{
1032 if (!xfc || !appWindow)
1033 return -1;
1034
1035 xf_SetWindowDecorations(xfc, appWindow->handle, appWindow->decorations);
1036 xf_SetWindowStyle(xfc, appWindow, appWindow->dwStyle, appWindow->dwExStyle);
1037 xf_SetWindowPID(xfc, appWindow->handle, 0);
1038 xf_ShowWindow(xfc, appWindow, WINDOW_SHOW);
1039 LogDynAndXClearWindow(xfc->log, xfc->display, appWindow->handle);
1040 LogDynAndXMapWindow(xfc->log, xfc->display, appWindow->handle);
1041 /* Move doesn't seem to work until window is mapped. */
1042 xf_MoveWindow(xfc, appWindow, appWindow->x, appWindow->y, appWindow->width, appWindow->height);
1043 xf_SetWindowText(xfc, appWindow, appWindow->title);
1044 return 1;
1045}
1046
1047BOOL xf_AppWindowCreate(xfContext* xfc, xfAppWindow* appWindow)
1048{
1049 XGCValues gcv = WINPR_C_ARRAY_INIT;
1050 int input_mask = 0;
1051 XWMHints* InputModeHint = nullptr;
1052 XClassHint* class_hints = nullptr;
1053 const rdpSettings* settings = nullptr;
1054
1055 WINPR_ASSERT(xfc);
1056 WINPR_ASSERT(appWindow);
1057
1058 settings = xfc->common.context.settings;
1059 WINPR_ASSERT(settings);
1060
1061 xf_FixWindowCoordinates(xfc, &appWindow->x, &appWindow->y, &appWindow->width,
1062 &appWindow->height);
1063 appWindow->shmid = -1;
1064 appWindow->decorations = FALSE;
1065 appWindow->fullscreen = FALSE;
1066 appWindow->local_move.state = LMS_NOT_ACTIVE;
1067 appWindow->is_mapped = FALSE;
1068 appWindow->is_transient = FALSE;
1069 appWindow->rail_state = 0;
1070 appWindow->maxVert = FALSE;
1071 appWindow->maxHorz = FALSE;
1072 appWindow->minimized = FALSE;
1073 appWindow->rail_ignore_configure = FALSE;
1074 appWindow->rail_fullscreen_normalizing = FALSE;
1075
1076 WINPR_ASSERT(xfc->depth != 0);
1077 appWindow->handle = LogDynAndXCreateWindow(
1078 xfc->log, xfc->display, RootWindowOfScreen(xfc->screen), appWindow->x, appWindow->y,
1079 WINPR_ASSERTING_INT_CAST(uint32_t, appWindow->width),
1080 WINPR_ASSERTING_INT_CAST(uint32_t, appWindow->height), 0, xfc->depth, InputOutput,
1081 xfc->visual, WINPR_ASSERTING_INT_CAST(uint32_t, xfc->attribs_mask), &xfc->attribs);
1082
1083 if (!appWindow->handle)
1084 return FALSE;
1085
1086 appWindow->gc =
1087 LogDynAndXCreateGC(xfc->log, xfc->display, appWindow->handle, GCGraphicsExposures, &gcv);
1088
1089 if (!xf_AppWindowResize(xfc, appWindow))
1090 return FALSE;
1091
1092 class_hints = XAllocClassHint();
1093
1094 if (class_hints)
1095 {
1096 char* strclass = nullptr;
1097
1098 const char* WmClass = freerdp_settings_get_string(settings, FreeRDP_WmClass);
1099 if (WmClass)
1100 strclass = _strdup(WmClass);
1101 else
1102 {
1103 size_t size = 0;
1104 winpr_asprintf(&strclass, &size, "RAIL:%08" PRIX64 "", appWindow->windowId);
1105 }
1106 class_hints->res_class = strclass;
1107 class_hints->res_name = "RAIL";
1108 XSetClassHint(xfc->display, appWindow->handle, class_hints);
1109 XFree(class_hints);
1110 free(strclass);
1111 }
1112
1113 /* Set the input mode hint for the WM */
1114 InputModeHint = XAllocWMHints();
1115 InputModeHint->flags = (1L << 0);
1116 InputModeHint->input = True;
1117 XSetWMHints(xfc->display, appWindow->handle, InputModeHint);
1118 XFree(InputModeHint);
1119 XSetWMProtocols(xfc->display, appWindow->handle, &(xfc->WM_DELETE_WINDOW), 1);
1120 input_mask = KeyPressMask | KeyReleaseMask | ButtonPressMask | ButtonReleaseMask |
1121 EnterWindowMask | LeaveWindowMask | PointerMotionMask | Button1MotionMask |
1122 Button2MotionMask | Button3MotionMask | Button4MotionMask | Button5MotionMask |
1123 ButtonMotionMask | KeymapStateMask | ExposureMask | VisibilityChangeMask |
1124 StructureNotifyMask | SubstructureNotifyMask | SubstructureRedirectMask |
1125 FocusChangeMask | PropertyChangeMask | ColormapChangeMask | OwnerGrabButtonMask;
1126 XSelectInput(xfc->display, appWindow->handle, input_mask);
1127
1128 if (xfc->XWAYLAND_MAY_GRAB_KEYBOARD)
1129 xf_SendClientEvent(xfc, appWindow->handle, xfc->XWAYLAND_MAY_GRAB_KEYBOARD, 1, 1);
1130
1131 return TRUE;
1132}
1133
1134void xf_SetWindowMinMaxInfo(xfContext* xfc, xfAppWindow* appWindow, WINPR_ATTR_UNUSED int maxWidth,
1135 WINPR_ATTR_UNUSED int maxHeight, WINPR_ATTR_UNUSED int maxPosX,
1136 WINPR_ATTR_UNUSED int maxPosY, int minTrackWidth, int minTrackHeight,
1137 int maxTrackWidth, int maxTrackHeight)
1138{
1139 XSizeHints* size_hints = nullptr;
1140 size_hints = XAllocSizeHints();
1141
1142 if (size_hints)
1143 {
1144 size_hints->flags = PMinSize | PMaxSize | PResizeInc;
1145 size_hints->min_width = minTrackWidth;
1146 size_hints->min_height = minTrackHeight;
1147 size_hints->max_width = maxTrackWidth;
1148 size_hints->max_height = maxTrackHeight;
1149 /* to speedup window drawing we need to select optimal value for sizing step. */
1150 size_hints->width_inc = size_hints->height_inc = 1;
1151 XSetWMNormalHints(xfc->display, appWindow->handle, size_hints);
1152 XFree(size_hints);
1153 }
1154}
1155
1156void xf_StartLocalMoveSize(xfContext* xfc, xfAppWindow* appWindow, int direction, int x, int y)
1157{
1158 if (appWindow->local_move.state != LMS_NOT_ACTIVE)
1159 return;
1160
1161 /*
1162 * Save original mouse location relative to root. This will be needed
1163 * to end local move to RDP server and/or X server
1164 */
1165 appWindow->local_move.root_x = x;
1166 appWindow->local_move.root_y = y;
1167 appWindow->local_move.state = LMS_STARTING;
1168 appWindow->local_move.direction = direction;
1169
1170 xf_ungrab(xfc);
1171
1172 xf_SendClientEvent(
1173 xfc, appWindow->handle,
1174 xfc->NET_WM_MOVERESIZE, /* request X window manager to initiate a local move */
1175 5, /* 5 arguments to follow */
1176 x, /* x relative to root window */
1177 y, /* y relative to root window */
1178 direction, /* extended ICCM direction flag */
1179 1, /* simulated mouse button 1 */
1180 1); /* 1 == application request per extended ICCM */
1181}
1182
1183void xf_EndLocalMoveSize(xfContext* xfc, xfAppWindow* appWindow)
1184{
1185 if (appWindow->local_move.state == LMS_NOT_ACTIVE)
1186 return;
1187
1188 if (appWindow->local_move.state == LMS_STARTING)
1189 {
1190 /*
1191 * The move never was property started. This can happen due to race
1192 * conditions between the mouse button up and the communications to the
1193 * RDP server for local moves. We must cancel the X window manager move.
1194 * Per ICCM, the X client can ask to cancel an active move.
1195 */
1196 xf_SendClientEvent(
1197 xfc, appWindow->handle,
1198 xfc->NET_WM_MOVERESIZE, /* request X window manager to abort a local move */
1199 5, /* 5 arguments to follow */
1200 appWindow->local_move.root_x, /* x relative to root window */
1201 appWindow->local_move.root_y, /* y relative to root window */
1202 NET_WM_MOVERESIZE_CANCEL, /* extended ICCM direction flag */
1203 1, /* simulated mouse button 1 */
1204 1); /* 1 == application request per extended ICCM */
1205 }
1206
1207 appWindow->local_move.state = LMS_NOT_ACTIVE;
1208}
1209
1210void xf_MoveWindow(xfContext* xfc, xfAppWindow* appWindow, int x, int y, int width, int height)
1211{
1212 BOOL resize = FALSE;
1213
1214 if ((width * height) < 1)
1215 return;
1216
1217 if ((appWindow->width != width) || (appWindow->height != height))
1218 resize = TRUE;
1219
1220 if (appWindow->local_move.state == LMS_STARTING || appWindow->local_move.state == LMS_ACTIVE)
1221 return;
1222
1223 appWindow->x = x;
1224 appWindow->y = y;
1225 appWindow->width = width;
1226 appWindow->height = height;
1227
1228 if (resize)
1229 {
1230 if (!xf_AppWindowResize(xfc, appWindow))
1231 return;
1232
1233 LogDynAndXMoveResizeWindow(xfc->log, xfc->display, appWindow->handle, x, y,
1234 WINPR_ASSERTING_INT_CAST(uint32_t, width),
1235 WINPR_ASSERTING_INT_CAST(uint32_t, height));
1236 }
1237 else
1238 LogDynAndXMoveWindow(xfc->log, xfc->display, appWindow->handle, x, y);
1239
1240 xf_UpdateWindowArea(xfc, appWindow, 0, 0, width, height);
1241}
1242
1243void xf_ShowWindow(xfContext* xfc, xfAppWindow* appWindow, BYTE state)
1244{
1245 WINPR_ASSERT(xfc);
1246 WINPR_ASSERT(appWindow);
1247
1248 switch (state)
1249 {
1250 case WINDOW_HIDE:
1251 LogDynAndXWithdrawWindow(xfc->log, xfc->display, appWindow->handle, xfc->screen_number);
1252 break;
1253
1254 case WINDOW_SHOW_MINIMIZED:
1255 appWindow->minimized = TRUE;
1256 XIconifyWindow(xfc->display, appWindow->handle, xfc->screen_number);
1257 break;
1258
1259 case WINDOW_SHOW_MAXIMIZED:
1260 /* Set the window as maximized */
1261 appWindow->maxHorz = TRUE;
1262 appWindow->maxVert = TRUE;
1263 xf_SendClientEvent(xfc, appWindow->handle, xfc->NET_WM_STATE, 4, NET_WM_STATE_ADD,
1264 xfc->NET_WM_STATE_MAXIMIZED_VERT, xfc->NET_WM_STATE_MAXIMIZED_HORZ,
1265 0);
1266
1267 /*
1268 * This is a workaround for the case where the window is maximized locally before the
1269 * rail server is told to maximize the window, this appears to be a race condition where
1270 * the local window with incomplete data and once the window is actually maximized on
1271 * the server
1272 * - an update of the new areas may not happen. So, we simply to do a full update of the
1273 * entire window once the rail server notifies us that the window is now maximized.
1274 */
1275 if (appWindow->rail_state == WINDOW_SHOW_MAXIMIZED)
1276 {
1277 xf_UpdateWindowArea(xfc, appWindow, 0, 0,
1278 WINPR_ASSERTING_INT_CAST(int, appWindow->windowWidth),
1279 WINPR_ASSERTING_INT_CAST(int, appWindow->windowHeight));
1280 }
1281
1282 break;
1283
1284 case WINDOW_SHOW:
1285 /* Ensure the window is not maximized */
1286 xf_SendClientEvent(xfc, appWindow->handle, xfc->NET_WM_STATE, 4, NET_WM_STATE_REMOVE,
1287 xfc->NET_WM_STATE_MAXIMIZED_VERT, xfc->NET_WM_STATE_MAXIMIZED_HORZ,
1288 0);
1289
1290 /*
1291 * Ignore configure requests until both the Maximized properties have been processed
1292 * to prevent condition where WM overrides size of request due to one or both of these
1293 * properties still being set - which causes a position adjustment to be sent back to
1294 * the server thus causing the window to not return to its original size
1295 */
1296 if (appWindow->rail_state == WINDOW_SHOW_MAXIMIZED)
1297 appWindow->rail_ignore_configure = TRUE;
1298
1299 if (appWindow->is_transient)
1300 xf_SetWindowUnlisted(xfc, appWindow->handle);
1301
1302 LogDynAndXMapWindow(xfc->log, xfc->display, appWindow->handle);
1303 break;
1304 default:
1305 break;
1306 }
1307
1308 /* Save the current rail state of this window */
1309 appWindow->rail_state = state;
1310 LogDynAndXFlush(xfc->log, xfc->display);
1311}
1312
1313void xf_SetWindowRects(xfContext* xfc, xfAppWindow* appWindow, RECTANGLE_16* rects, int nrects)
1314{
1315 XRectangle* xrects = nullptr;
1316
1317 if (nrects < 1)
1318 return;
1319
1320#ifdef WITH_XEXT
1321 xrects = (XRectangle*)calloc(WINPR_ASSERTING_INT_CAST(uint32_t, nrects), sizeof(XRectangle));
1322
1323 for (int i = 0; i < nrects; i++)
1324 {
1325 /* Coords may be negative (INT16 in UINT16 fields); cast modularly, no assert. */
1326 xrects[i].x = WINPR_CXX_COMPAT_CAST(short, rects[i].left);
1327 xrects[i].y = WINPR_CXX_COMPAT_CAST(short, rects[i].top);
1328 xrects[i].width = WINPR_CXX_COMPAT_CAST(unsigned short, rects[i].right - rects[i].left);
1329 xrects[i].height = WINPR_CXX_COMPAT_CAST(unsigned short, rects[i].bottom - rects[i].top);
1330 }
1331
1332 XShapeCombineRectangles(xfc->display, appWindow->handle, ShapeBounding, 0, 0, xrects, nrects,
1333 ShapeSet, 0);
1334 free(xrects);
1335#endif
1336}
1337
1338void xf_SetWindowVisibilityRects(xfContext* xfc, xfAppWindow* appWindow, UINT32 rectsOffsetX,
1339 UINT32 rectsOffsetY, RECTANGLE_16* rects, int nrects)
1340{
1341 XRectangle* xrects = nullptr;
1342
1343 if (nrects < 1)
1344 return;
1345
1346#ifdef WITH_XEXT
1347 xrects = (XRectangle*)calloc(WINPR_ASSERTING_INT_CAST(uint32_t, nrects), sizeof(XRectangle));
1348
1349 for (int i = 0; i < nrects; i++)
1350 {
1351 /* Coords may be negative (INT16 in UINT16 fields); cast modularly, no assert. */
1352 xrects[i].x = WINPR_CXX_COMPAT_CAST(short, rects[i].left);
1353 xrects[i].y = WINPR_CXX_COMPAT_CAST(short, rects[i].top);
1354 xrects[i].width = WINPR_CXX_COMPAT_CAST(unsigned short, rects[i].right - rects[i].left);
1355 xrects[i].height = WINPR_CXX_COMPAT_CAST(unsigned short, rects[i].bottom - rects[i].top);
1356 }
1357
1358 XShapeCombineRectangles(
1359 xfc->display, appWindow->handle, ShapeBounding, WINPR_ASSERTING_INT_CAST(int, rectsOffsetX),
1360 WINPR_ASSERTING_INT_CAST(int, rectsOffsetY), xrects, nrects, ShapeSet, 0);
1361 free(xrects);
1362#endif
1363}
1364
1365void xf_ClearWindowVisibilityRects(xfContext* xfc, xfAppWindow* appWindow)
1366{
1367 WINPR_ASSERT(xfc);
1368 WINPR_ASSERT(appWindow);
1369#ifdef WITH_XEXT
1370 /* Drop the bounding shape so the whole window is visible. */
1371 XShapeCombineMask(xfc->display, appWindow->handle, ShapeBounding, 0, 0, None, ShapeSet);
1372#endif
1373}
1374
1375void xf_UpdateWindowArea(xfContext* xfc, xfAppWindow* appWindow, int x, int y, int width,
1376 int height)
1377{
1378 int ax = 0;
1379 int ay = 0;
1380 const rdpSettings* settings = nullptr;
1381
1382 WINPR_ASSERT(xfc);
1383
1384 settings = xfc->common.context.settings;
1385 WINPR_ASSERT(settings);
1386
1387 if (appWindow == nullptr)
1388 return;
1389
1390 if (appWindow->surfaceId < UINT16_MAX)
1391 return;
1392
1393 ax = x + appWindow->windowOffsetX;
1394 ay = y + appWindow->windowOffsetY;
1395
1396 if (ax + width > appWindow->windowOffsetX + appWindow->width)
1397 width = (appWindow->windowOffsetX + appWindow->width - 1) - ax;
1398
1399 if (ay + height > appWindow->windowOffsetY + appWindow->height)
1400 height = (appWindow->windowOffsetY + appWindow->height - 1) - ay;
1401
1402 if (freerdp_settings_get_bool(settings, FreeRDP_SoftwareGdi))
1403 {
1404 LogDynAndXPutImage(xfc->log, xfc->display, appWindow->pixmap, appWindow->gc, xfc->image, ax,
1405 ay, x, y, WINPR_ASSERTING_INT_CAST(uint32_t, width),
1406 WINPR_ASSERTING_INT_CAST(uint32_t, height));
1407 }
1408
1409 LogDynAndXCopyArea(xfc->log, xfc->display, appWindow->pixmap, appWindow->handle, appWindow->gc,
1410 x, y, WINPR_ASSERTING_INT_CAST(uint32_t, width),
1411 WINPR_ASSERTING_INT_CAST(uint32_t, height), x, y);
1412 LogDynAndXFlush(xfc->log, xfc->display);
1413}
1414
1415void xf_AppWindowDestroyImage(xfAppWindow* appWindow)
1416{
1417 WINPR_ASSERT(appWindow);
1418 if (appWindow->image)
1419 {
1420 appWindow->image->data = nullptr;
1421 XDestroyImage(appWindow->image);
1422 appWindow->image = nullptr;
1423 }
1424}
1425
1426void xf_DestroyWindow(xfContext* xfc, xfAppWindow* appWindow)
1427{
1428 if (!appWindow)
1429 return;
1430
1431 if (xfc->appWindow == appWindow)
1432 xfc->appWindow = nullptr;
1433
1434 if (appWindow->gc)
1435 LogDynAndXFreeGC(xfc->log, xfc->display, appWindow->gc);
1436
1437 if (appWindow->pixmap)
1438 LogDynAndXFreePixmap(xfc->log, xfc->display, appWindow->pixmap);
1439
1440 xf_AppWindowDestroyImage(appWindow);
1441
1442 if (appWindow->handle)
1443 {
1444 LogDynAndXUnmapWindow(xfc->log, xfc->display, appWindow->handle);
1445 LogDynAndXDestroyWindow(xfc->log, xfc->display, appWindow->handle);
1446 }
1447
1448 if (appWindow->xfwin)
1449 munmap(nullptr, sizeof(*appWindow->xfwin));
1450
1451 if (appWindow->shmid >= 0)
1452 close(appWindow->shmid);
1453
1454 shm_unlink(get_shm_id());
1455 appWindow->xfwin = (Window*)-1;
1456 appWindow->shmid = -1;
1457 free(appWindow->title);
1458 free(appWindow->windowRects);
1459 free(appWindow->visibilityRects);
1460 free(appWindow);
1461}
1462
1463static xfAppWindow* get_windowUnlocked(xfContext* xfc, UINT64 id)
1464{
1465 WINPR_ASSERT(xfc);
1466 return HashTable_GetItemValue(xfc->railWindows, &id);
1467}
1468
1469xfAppWindow* xf_rail_get_windowFrom(xfContext* xfc, UINT64 id, BOOL alreadyLocked, const char* file,
1470 const char* fkt, size_t line)
1471{
1472 if (!xfc)
1473 return nullptr;
1474
1475 if (!xfc->railWindows)
1476 return nullptr;
1477
1478 if (!alreadyLocked)
1479 xfAppWindowsLockFrom(xfc, file, fkt, line);
1480
1481 xfAppWindow* window = get_windowUnlocked(xfc, id);
1482
1483 if (!window && !alreadyLocked)
1484 xfAppWindowsUnlockFrom(xfc, file, fkt, line);
1485
1486 return window;
1487}
1488
1489xfAppWindow* xf_AppWindowFromX11WindowFrom(xfContext* xfc, Window wnd, const char* file,
1490 const char* fkt, size_t line)
1491{
1492 ULONG_PTR* pKeys = nullptr;
1493
1494 WINPR_ASSERT(xfc);
1495 if (!xfc->railWindows)
1496 return nullptr;
1497
1498 xfAppWindowsLockFrom(xfc, file, fkt, line);
1499 size_t count = HashTable_GetKeys(xfc->railWindows, &pKeys);
1500
1501 for (size_t index = 0; index < count; index++)
1502 {
1503 xfAppWindow* appWindow = get_windowUnlocked(xfc, *(UINT64*)pKeys[index]);
1504
1505 if (!appWindow)
1506 {
1507 xfAppWindowsUnlockFrom(xfc, file, fkt, line);
1508 free(pKeys);
1509 return nullptr;
1510 }
1511
1512 if (appWindow->handle == wnd)
1513 {
1514 free(pKeys);
1515 return appWindow;
1516 }
1517 }
1518
1519 xfAppWindowsUnlockFrom(xfc, file, fkt, line);
1520 free(pKeys);
1521 return nullptr;
1522}
1523
1524UINT xf_AppUpdateWindowFromSurface(xfContext* xfc, gdiGfxSurface* surface)
1525{
1526 XImage* image = nullptr;
1527 UINT rc = ERROR_INTERNAL_ERROR;
1528
1529 WINPR_ASSERT(xfc);
1530 WINPR_ASSERT(surface);
1531
1532 xfAppWindow* appWindow = xf_rail_get_window(xfc, surface->windowId, FALSE);
1533 if (!appWindow)
1534 {
1535 WLog_VRB(TAG, "Failed to find a window for id=0x%08" PRIx64, surface->windowId);
1536 return CHANNEL_RC_OK;
1537 }
1538
1539 const BOOL surfaceChanged = (appWindow->surfaceId != surface->surfaceId);
1540 if (surfaceChanged)
1541 appWindow->surfaceId = surface->surfaceId;
1542
1543 const BOOL maximized = (appWindow->dwStyle & WS_MAXIMIZE) != 0;
1544 const UINT32 winW = WINPR_ASSERTING_INT_CAST(uint32_t, appWindow->width);
1545 const UINT32 winH = WINPR_ASSERTING_INT_CAST(uint32_t, appWindow->height);
1546
1547 const BOOL swGdi = freerdp_settings_get_bool(xfc->common.context.settings, FreeRDP_SoftwareGdi);
1548 UINT32 nrects = 0;
1549 const RECTANGLE_16* rects = region16_rects(&surface->invalidRegion, &nrects);
1550
1551 RECTANGLE_16 fullRect = WINPR_C_ARRAY_INIT;
1552 if (surfaceChanged)
1553 {
1554 fullRect.right = WINPR_ASSERTING_INT_CAST(UINT16, MIN(winW, surface->width));
1555 fullRect.bottom = WINPR_ASSERTING_INT_CAST(UINT16, MIN(winH, surface->height));
1556 if ((fullRect.right > 0) && (fullRect.bottom > 0))
1557 {
1558 rects = &fullRect;
1559 nrects = 1;
1560 }
1561 }
1562
1563 if (swGdi)
1564 {
1565 if (surfaceChanged || (appWindow->width != (INT64)surface->width) ||
1566 (appWindow->height != (INT64)surface->height))
1567 xf_AppWindowDestroyImage(appWindow);
1568
1569 if (!appWindow->image)
1570 {
1571 WINPR_ASSERT(xfc->depth != 0);
1572 appWindow->image = LogDynAndXCreateImage(
1573 xfc->log, xfc->display, xfc->visual, WINPR_ASSERTING_INT_CAST(uint32_t, xfc->depth),
1574 ZPixmap, 0, (char*)surface->data, surface->width, surface->height,
1575 xfc->scanline_pad, WINPR_ASSERTING_INT_CAST(int, surface->scanline));
1576 if (!appWindow->image)
1577 {
1578 WLog_WARN(TAG,
1579 "Failed create a XImage[%" PRIu32 "x%" PRIu32 ", scanline=%" PRIu32
1580 ", bpp=%" PRId32 "] for window id=0x%08" PRIx64,
1581 surface->width, surface->height, surface->scanline, xfc->depth,
1582 surface->windowId);
1583 goto fail;
1584 }
1585 appWindow->image->byte_order = LSBFirst;
1586 appWindow->image->bitmap_bit_order = LSBFirst;
1587 }
1588
1589 image = appWindow->image;
1590 }
1591 else
1592 {
1593 xfGfxSurface* xfSurface = (xfGfxSurface*)surface;
1594 image = xfSurface->image;
1595 }
1596
1597 /* Skip the off-screen resize-margin frame a maximized surface carries: shift the blit by the
1598 * real left/top margin so content fills from (0,0). */
1599 const int insetX =
1600 (maximized && (surface->mappedWidth > winW)) ? (int)appWindow->resizeMarginLeft : 0;
1601 const int insetY =
1602 (maximized && (surface->mappedHeight > winH)) ? (int)appWindow->resizeMarginTop : 0;
1603
1604 for (UINT32 x = 0; x < nrects; x++)
1605 {
1606 const RECTANGLE_16* rect = &rects[x];
1607 int srcX = rect->left;
1608 int srcY = rect->top;
1609 int dstX = (int)rect->left - insetX;
1610 int dstY = (int)rect->top - insetY;
1611 int w = (int)rect->right - rect->left;
1612 int h = (int)rect->bottom - rect->top;
1613
1614 if (dstX < 0)
1615 {
1616 srcX -= dstX;
1617 w += dstX;
1618 dstX = 0;
1619 }
1620 if (dstY < 0)
1621 {
1622 srcY -= dstY;
1623 h += dstY;
1624 dstY = 0;
1625 }
1626 if ((w <= 0) || (h <= 0))
1627 continue;
1628
1629 LogDynAndXPutImage(xfc->log, xfc->display, appWindow->pixmap, appWindow->gc, image, srcX,
1630 srcY, dstX, dstY, WINPR_ASSERTING_INT_CAST(uint32_t, w),
1631 WINPR_ASSERTING_INT_CAST(uint32_t, h));
1632
1633 LogDynAndXCopyArea(xfc->log, xfc->display, appWindow->pixmap, appWindow->handle,
1634 appWindow->gc, dstX, dstY, WINPR_ASSERTING_INT_CAST(uint32_t, w),
1635 WINPR_ASSERTING_INT_CAST(uint32_t, h), dstX, dstY);
1636 }
1637
1638 rc = CHANNEL_RC_OK;
1639fail:
1640 xf_rail_return_window(appWindow, FALSE);
1641 LogDynAndXFlush(xfc->log, xfc->display);
1642
1643 return rc;
1644}
1645
1646BOOL xf_AppWindowResize(xfContext* xfc, xfAppWindow* appWindow)
1647{
1648 WINPR_ASSERT(xfc);
1649 WINPR_ASSERT(appWindow);
1650
1651 if (appWindow->pixmap != 0)
1652 LogDynAndXFreePixmap(xfc->log, xfc->display, appWindow->pixmap);
1653
1654 WINPR_ASSERT(xfc->depth != 0);
1655 appWindow->pixmap = LogDynAndXCreatePixmap(
1656 xfc->log, xfc->display, xfc->drawable, WINPR_ASSERTING_INT_CAST(uint32_t, appWindow->width),
1657 WINPR_ASSERTING_INT_CAST(uint32_t, appWindow->height),
1658 WINPR_ASSERTING_INT_CAST(uint32_t, xfc->depth));
1659 xf_AppWindowDestroyImage(appWindow);
1660
1661 return appWindow->pixmap != 0;
1662}
1663
1664void xf_XSetTransientForHint(xfContext* xfc, xfAppWindow* window)
1665{
1666 WINPR_ASSERT(xfc);
1667 WINPR_ASSERT(window);
1668
1669 if (window->ownerWindowId == 0)
1670 return;
1671
1672 xfAppWindow* parent = xf_rail_get_window(xfc, window->ownerWindowId, TRUE);
1673 if (!parent)
1674 return;
1675
1676 (void)LogDynAndXSetTransientForHint(xfc->log, xfc->display, window->handle, parent->handle);
1677 xf_rail_return_window(parent, TRUE);
1678}
1679
1680void xfAppWindowsLockFrom(xfContext* xfc, WINPR_ATTR_UNUSED const char* file,
1681 WINPR_ATTR_UNUSED const char* fkt, WINPR_ATTR_UNUSED size_t line)
1682{
1683 WINPR_ASSERT(xfc);
1684
1685#if defined(WITH_VERBOSE_WINPR_ASSERT)
1686 const DWORD level = WLOG_TRACE;
1687 if (WLog_IsLevelActive(xfc->log, level))
1688 WLog_PrintTextMessage(xfc->log, level, line, file, fkt, "[rails] locking [%s]", fkt);
1689#endif
1690
1691 xf_lock_x11(xfc);
1692 if (xfc->railWindows)
1693 HashTable_Lock(xfc->railWindows);
1694
1695#if defined(WITH_VERBOSE_WINPR_ASSERT)
1696 WINPR_ASSERT(!xfc->isRailWindowsLocked);
1697 xfc->isRailWindowsLocked = TRUE;
1698#endif
1699}
1700
1701void xfAppWindowsUnlockFrom(xfContext* xfc, WINPR_ATTR_UNUSED const char* file,
1702 WINPR_ATTR_UNUSED const char* fkt, WINPR_ATTR_UNUSED size_t line)
1703{
1704 WINPR_ASSERT(xfc);
1705
1706#if defined(WITH_VERBOSE_WINPR_ASSERT)
1707 const DWORD level = WLOG_TRACE;
1708 if (WLog_IsLevelActive(xfc->log, level))
1709 WLog_PrintTextMessage(xfc->log, level, line, file, fkt, "[rails] unocking [%s]", fkt);
1710
1711 WINPR_ASSERT(xfc->isRailWindowsLocked);
1712 xfc->isRailWindowsLocked = FALSE;
1713#endif
1714
1715 if (xfc->railWindows)
1716 HashTable_Unlock(xfc->railWindows);
1717 xf_unlock_x11(xfc);
1718}
WINPR_ATTR_NODISCARD FREERDP_API const char * freerdp_settings_get_string(const rdpSettings *settings, FreeRDP_Settings_Keys_String id)
Returns a immutable string settings value.
WINPR_ATTR_NODISCARD FREERDP_API INT32 freerdp_settings_get_int32(const rdpSettings *settings, FreeRDP_Settings_Keys_Int32 id)
Returns a INT32 settings value.
WINPR_ATTR_NODISCARD FREERDP_API UINT64 freerdp_settings_get_uint64(const rdpSettings *settings, FreeRDP_Settings_Keys_UInt64 id)
Returns a UINT64 settings value.
WINPR_ATTR_NODISCARD FREERDP_API UINT32 freerdp_settings_get_uint32(const rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id)
Returns a UINT32 settings value.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings *settings, FreeRDP_Settings_Keys_Bool id)
Returns a boolean settings value.