tools: Spelling fixes.
[wine/multimedia.git] / server / window.c
blob8cf8001eb5aa313bbfa380574759a3cadcd748f5
1 /*
2 * Server-side window handling
4 * Copyright (C) 2001 Alexandre Julliard
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21 #include "config.h"
22 #include "wine/port.h"
24 #include <assert.h>
25 #include <stdarg.h>
27 #include "ntstatus.h"
28 #define WIN32_NO_STATUS
29 #include "windef.h"
30 #include "winbase.h"
31 #include "wingdi.h"
32 #include "winuser.h"
33 #include "winternl.h"
35 #include "object.h"
36 #include "request.h"
37 #include "thread.h"
38 #include "process.h"
39 #include "user.h"
40 #include "unicode.h"
42 /* a window property */
43 struct property
45 unsigned short type; /* property type (see below) */
46 atom_t atom; /* property atom */
47 obj_handle_t handle; /* property handle (user-defined storage) */
50 enum property_type
52 PROP_TYPE_FREE, /* free entry */
53 PROP_TYPE_STRING, /* atom that was originally a string */
54 PROP_TYPE_ATOM /* plain atom */
58 struct window
60 struct window *parent; /* parent window */
61 user_handle_t owner; /* owner of this window */
62 struct list children; /* list of children in Z-order */
63 struct list unlinked; /* list of children not linked in the Z-order list */
64 struct list entry; /* entry in parent's children list */
65 user_handle_t handle; /* full handle for this window */
66 struct thread *thread; /* thread owning the window */
67 struct desktop *desktop; /* desktop that the window belongs to */
68 struct window_class *class; /* window class */
69 atom_t atom; /* class atom */
70 user_handle_t last_active; /* last active popup */
71 rectangle_t window_rect; /* window rectangle (relative to parent client area) */
72 rectangle_t visible_rect; /* visible part of window rect (relative to parent client area) */
73 rectangle_t client_rect; /* client rectangle (relative to parent client area) */
74 struct region *win_region; /* region for shaped windows (relative to window rect) */
75 struct region *update_region; /* update region (relative to window rect) */
76 unsigned int style; /* window style */
77 unsigned int ex_style; /* window extended style */
78 unsigned int id; /* window id */
79 void* instance; /* creator instance */
80 unsigned int is_unicode : 1; /* ANSI or unicode */
81 unsigned int is_linked : 1; /* is it linked into the parent z-order list? */
82 unsigned long user_data; /* user-specific data */
83 WCHAR *text; /* window caption text */
84 unsigned int paint_flags; /* various painting flags */
85 int prop_inuse; /* number of in-use window properties */
86 int prop_alloc; /* number of allocated window properties */
87 struct property *properties; /* window properties array */
88 int nb_extra_bytes; /* number of extra bytes */
89 char extra_bytes[1]; /* extra bytes storage */
92 #define PAINT_INTERNAL 0x01 /* internal WM_PAINT pending */
93 #define PAINT_ERASE 0x02 /* needs WM_ERASEBKGND */
94 #define PAINT_NONCLIENT 0x04 /* needs WM_NCPAINT */
95 #define PAINT_DELAYED_ERASE 0x08 /* still needs erase after WM_ERASEBKGND */
97 /* growable array of user handles */
98 struct user_handle_array
100 user_handle_t *handles;
101 int count;
102 int total;
105 /* global window pointers */
106 static struct window *shell_window;
107 static struct window *shell_listview;
108 static struct window *progman_window;
109 static struct window *taskman_window;
111 /* magic HWND_TOP etc. pointers */
112 #define WINPTR_TOP ((struct window *)1L)
113 #define WINPTR_BOTTOM ((struct window *)2L)
114 #define WINPTR_TOPMOST ((struct window *)3L)
115 #define WINPTR_NOTOPMOST ((struct window *)4L)
117 /* retrieve a pointer to a window from its handle */
118 static inline struct window *get_window( user_handle_t handle )
120 struct window *ret = get_user_object( handle, USER_WINDOW );
121 if (!ret) set_win32_error( ERROR_INVALID_WINDOW_HANDLE );
122 return ret;
125 /* check if window is the desktop */
126 static inline int is_desktop_window( const struct window *win )
128 return !win->parent; /* only desktop windows have no parent */
131 /* get next window in Z-order list */
132 static inline struct window *get_next_window( struct window *win )
134 struct list *ptr = list_next( &win->parent->children, &win->entry );
135 return ptr ? LIST_ENTRY( ptr, struct window, entry ) : NULL;
138 /* get previous window in Z-order list */
139 static inline struct window *get_prev_window( struct window *win )
141 struct list *ptr = list_prev( &win->parent->children, &win->entry );
142 return ptr ? LIST_ENTRY( ptr, struct window, entry ) : NULL;
145 /* get first child in Z-order list */
146 static inline struct window *get_first_child( struct window *win )
148 struct list *ptr = list_head( &win->children );
149 return ptr ? LIST_ENTRY( ptr, struct window, entry ) : NULL;
152 /* get last child in Z-order list */
153 static inline struct window *get_last_child( struct window *win )
155 struct list *ptr = list_tail( &win->children );
156 return ptr ? LIST_ENTRY( ptr, struct window, entry ) : NULL;
159 /* link a window at the right place in the siblings list */
160 static void link_window( struct window *win, struct window *previous )
162 if (previous == WINPTR_NOTOPMOST)
164 if (!(win->ex_style & WS_EX_TOPMOST) && win->is_linked) return; /* nothing to do */
165 win->ex_style &= ~WS_EX_TOPMOST;
166 previous = WINPTR_TOP; /* fallback to the HWND_TOP case */
169 list_remove( &win->entry ); /* unlink it from the previous location */
171 if (previous == WINPTR_BOTTOM)
173 list_add_tail( &win->parent->children, &win->entry );
174 win->ex_style &= ~WS_EX_TOPMOST;
176 else if (previous == WINPTR_TOPMOST)
178 list_add_head( &win->parent->children, &win->entry );
179 win->ex_style |= WS_EX_TOPMOST;
181 else if (previous == WINPTR_TOP)
183 struct list *entry = win->parent->children.next;
184 if (!(win->ex_style & WS_EX_TOPMOST)) /* put it above the first non-topmost window */
186 while (entry != &win->parent->children &&
187 LIST_ENTRY( entry, struct window, entry )->ex_style & WS_EX_TOPMOST)
188 entry = entry->next;
190 list_add_before( entry, &win->entry );
192 else
194 list_add_after( &previous->entry, &win->entry );
195 if (!(previous->ex_style & WS_EX_TOPMOST)) win->ex_style &= ~WS_EX_TOPMOST;
196 else
198 struct window *next = get_next_window( win );
199 if (next && (next->ex_style & WS_EX_TOPMOST)) win->ex_style |= WS_EX_TOPMOST;
203 win->is_linked = 1;
206 /* change the parent of a window (or unlink the window if the new parent is NULL) */
207 static int set_parent_window( struct window *win, struct window *parent )
209 struct window *ptr;
211 /* make sure parent is not a child of window */
212 for (ptr = parent; ptr; ptr = ptr->parent)
214 if (ptr == win)
216 set_error( STATUS_INVALID_PARAMETER );
217 return 0;
221 if (parent)
223 win->parent = parent;
224 link_window( win, WINPTR_TOP );
226 /* if parent belongs to a different thread and the window isn't */
227 /* top-level, attach the two threads */
228 if (parent->thread && parent->thread != win->thread && !is_desktop_window(parent))
229 attach_thread_input( win->thread, parent->thread );
231 else /* move it to parent unlinked list */
233 list_remove( &win->entry ); /* unlink it from the previous location */
234 list_add_head( &win->parent->unlinked, &win->entry );
235 win->is_linked = 0;
237 return 1;
240 /* append a user handle to a handle array */
241 static int add_handle_to_array( struct user_handle_array *array, user_handle_t handle )
243 if (array->count >= array->total)
245 int new_total = max( array->total * 2, 32 );
246 user_handle_t *new_array = realloc( array->handles, new_total * sizeof(*new_array) );
247 if (!new_array)
249 free( array->handles );
250 set_error( STATUS_NO_MEMORY );
251 return 0;
253 array->handles = new_array;
254 array->total = new_total;
256 array->handles[array->count++] = handle;
257 return 1;
260 /* set a window property */
261 static void set_property( struct window *win, atom_t atom, obj_handle_t handle, enum property_type type )
263 int i, free = -1;
264 struct property *new_props;
266 /* check if it exists already */
267 for (i = 0; i < win->prop_inuse; i++)
269 if (win->properties[i].type == PROP_TYPE_FREE)
271 free = i;
272 continue;
274 if (win->properties[i].atom == atom)
276 win->properties[i].type = type;
277 win->properties[i].handle = handle;
278 return;
282 /* need to add an entry */
283 if (!grab_global_atom( NULL, atom )) return;
284 if (free == -1)
286 /* no free entry */
287 if (win->prop_inuse >= win->prop_alloc)
289 /* need to grow the array */
290 if (!(new_props = realloc( win->properties,
291 sizeof(*new_props) * (win->prop_alloc + 16) )))
293 set_error( STATUS_NO_MEMORY );
294 release_global_atom( NULL, atom );
295 return;
297 win->prop_alloc += 16;
298 win->properties = new_props;
300 free = win->prop_inuse++;
302 win->properties[free].atom = atom;
303 win->properties[free].type = type;
304 win->properties[free].handle = handle;
307 /* remove a window property */
308 static obj_handle_t remove_property( struct window *win, atom_t atom )
310 int i;
312 for (i = 0; i < win->prop_inuse; i++)
314 if (win->properties[i].type == PROP_TYPE_FREE) continue;
315 if (win->properties[i].atom == atom)
317 release_global_atom( NULL, atom );
318 win->properties[i].type = PROP_TYPE_FREE;
319 return win->properties[i].handle;
322 /* FIXME: last error? */
323 return 0;
326 /* find a window property */
327 static obj_handle_t get_property( struct window *win, atom_t atom )
329 int i;
331 for (i = 0; i < win->prop_inuse; i++)
333 if (win->properties[i].type == PROP_TYPE_FREE) continue;
334 if (win->properties[i].atom == atom) return win->properties[i].handle;
336 /* FIXME: last error? */
337 return 0;
340 /* destroy all properties of a window */
341 static inline void destroy_properties( struct window *win )
343 int i;
345 if (!win->properties) return;
346 for (i = 0; i < win->prop_inuse; i++)
348 if (win->properties[i].type == PROP_TYPE_FREE) continue;
349 release_global_atom( NULL, win->properties[i].atom );
351 free( win->properties );
354 /* detach a window from its owner thread but keep the window around */
355 static void detach_window_thread( struct window *win )
357 struct thread *thread = win->thread;
359 if (!thread) return;
360 if (thread->queue)
362 if (win->update_region) inc_queue_paint_count( thread, -1 );
363 if (win->paint_flags & PAINT_INTERNAL) inc_queue_paint_count( thread, -1 );
364 queue_cleanup_window( thread, win->handle );
366 assert( thread->desktop_users > 0 );
367 thread->desktop_users--;
368 release_class( win->class );
369 win->class = NULL;
371 /* don't hold a reference to the desktop so that the desktop window can be */
372 /* destroyed when the desktop ref count reaches zero */
373 release_object( win->desktop );
374 win->thread = NULL;
377 /* destroy a window */
378 void destroy_window( struct window *win )
380 /* destroy all children */
381 while (!list_empty(&win->children))
382 destroy_window( LIST_ENTRY( list_head(&win->children), struct window, entry ));
383 while (!list_empty(&win->unlinked))
384 destroy_window( LIST_ENTRY( list_head(&win->unlinked), struct window, entry ));
386 /* reset global window pointers, if the corresponding window is destroyed */
387 if (win == shell_window) shell_window = NULL;
388 if (win == shell_listview) shell_listview = NULL;
389 if (win == progman_window) progman_window = NULL;
390 if (win == taskman_window) taskman_window = NULL;
391 free_user_handle( win->handle );
392 destroy_properties( win );
393 list_remove( &win->entry );
394 if (is_desktop_window(win))
396 assert( win->desktop->top_window == win );
397 win->desktop->top_window = NULL;
399 detach_window_thread( win );
400 if (win->win_region) free_region( win->win_region );
401 if (win->update_region) free_region( win->update_region );
402 if (win->class) release_class( win->class );
403 free( win->text );
404 memset( win, 0x55, sizeof(*win) + win->nb_extra_bytes - 1 );
405 free( win );
408 /* get the process owning the top window of a given desktop */
409 struct process *get_top_window_owner( struct desktop *desktop )
411 struct window *win = desktop->top_window;
412 if (!win || !win->thread) return NULL;
413 return win->thread->process;
416 /* attempt to close the desktop window when the last process using it is gone */
417 void close_desktop_window( struct desktop *desktop )
419 struct window *win = desktop->top_window;
420 if (win && win->thread) post_message( win->handle, WM_CLOSE, 0, 0 );
423 /* create a new window structure (note: the window is not linked in the window tree) */
424 static struct window *create_window( struct window *parent, struct window *owner,
425 atom_t atom, void *instance )
427 int extra_bytes;
428 struct window *win;
429 struct desktop *desktop;
430 struct window_class *class;
432 if (!(desktop = get_thread_desktop( current, DESKTOP_CREATEWINDOW ))) return NULL;
434 if (!(class = grab_class( current->process, atom, instance, &extra_bytes )))
436 release_object( desktop );
437 return NULL;
440 if (!(win = mem_alloc( sizeof(*win) + extra_bytes - 1 ))) goto failed;
441 if (!(win->handle = alloc_user_handle( win, USER_WINDOW ))) goto failed;
443 win->parent = parent;
444 win->owner = owner ? owner->handle : 0;
445 win->thread = current;
446 win->desktop = desktop;
447 win->class = class;
448 win->atom = atom;
449 win->last_active = win->handle;
450 win->win_region = NULL;
451 win->update_region = NULL;
452 win->style = 0;
453 win->ex_style = 0;
454 win->id = 0;
455 win->instance = NULL;
456 win->is_unicode = 1;
457 win->is_linked = 0;
458 win->user_data = 0;
459 win->text = NULL;
460 win->paint_flags = 0;
461 win->prop_inuse = 0;
462 win->prop_alloc = 0;
463 win->properties = NULL;
464 win->nb_extra_bytes = extra_bytes;
465 memset( win->extra_bytes, 0, extra_bytes );
466 list_init( &win->children );
467 list_init( &win->unlinked );
469 /* parent must be on the same desktop */
470 if (parent && parent->desktop != desktop)
472 set_error( STATUS_ACCESS_DENIED );
473 goto failed;
476 /* if no parent, class must be the desktop */
477 if (!parent && !is_desktop_class( class ))
479 set_error( STATUS_ACCESS_DENIED );
480 goto failed;
483 /* if parent belongs to a different thread and the window isn't */
484 /* top-level, attach the two threads */
485 if (parent && parent->thread && parent->thread != current && !is_desktop_window(parent))
487 if (!attach_thread_input( current, parent->thread )) goto failed;
489 else /* otherwise just make sure that the thread has a message queue */
491 if (!current->queue && !init_thread_queue( current )) goto failed;
494 /* put it on parent unlinked list */
495 if (parent) list_add_head( &parent->unlinked, &win->entry );
496 else
498 list_init( &win->entry );
499 assert( !desktop->top_window );
500 desktop->top_window = win;
501 set_process_default_desktop( current->process, desktop, current->desktop );
504 current->desktop_users++;
505 return win;
507 failed:
508 if (win)
510 if (win->handle) free_user_handle( win->handle );
511 free( win );
513 release_object( desktop );
514 release_class( class );
515 return NULL;
518 /* destroy all windows belonging to a given thread */
519 void destroy_thread_windows( struct thread *thread )
521 user_handle_t handle = 0;
522 struct window *win;
524 while ((win = next_user_handle( &handle, USER_WINDOW )))
526 if (win->thread != thread) continue;
527 if (is_desktop_window( win )) detach_window_thread( win );
528 else destroy_window( win );
532 /* get the desktop window */
533 static struct window *get_desktop_window( struct thread *thread, int create )
535 struct window *top_window;
536 struct desktop *desktop = get_thread_desktop( thread, 0 );
538 if (!desktop) return NULL;
540 if (!(top_window = desktop->top_window) && create)
542 if ((top_window = create_window( NULL, NULL, DESKTOP_ATOM, 0 )))
544 detach_window_thread( top_window );
545 top_window->style = WS_POPUP | WS_VISIBLE | WS_CLIPSIBLINGS | WS_CLIPCHILDREN;
548 release_object( desktop );
549 return top_window;
552 /* check whether child is a descendant of parent */
553 int is_child_window( user_handle_t parent, user_handle_t child )
555 struct window *child_ptr = get_user_object( child, USER_WINDOW );
556 struct window *parent_ptr = get_user_object( parent, USER_WINDOW );
558 if (!child_ptr || !parent_ptr) return 0;
559 while (child_ptr->parent)
561 if (child_ptr->parent == parent_ptr) return 1;
562 child_ptr = child_ptr->parent;
564 return 0;
567 /* check whether window is a top-level window */
568 int is_top_level_window( user_handle_t window )
570 struct window *win = get_user_object( window, USER_WINDOW );
571 return (win && (is_desktop_window(win) || is_desktop_window(win->parent)));
574 /* make a window active if possible */
575 int make_window_active( user_handle_t window )
577 struct window *owner, *win = get_window( window );
579 if (!win) return 0;
581 /* set last active for window and its owner */
582 win->last_active = win->handle;
583 if ((owner = get_user_object( win->owner, USER_WINDOW ))) owner->last_active = win->handle;
584 return 1;
587 /* increment (or decrement) the window paint count */
588 static inline void inc_window_paint_count( struct window *win, int incr )
590 if (win->thread) inc_queue_paint_count( win->thread, incr );
593 /* check if window and all its ancestors are visible */
594 static int is_visible( const struct window *win )
596 while (win && win->parent)
598 if (!(win->style & WS_VISIBLE)) return 0;
599 win = win->parent;
600 /* if parent is minimized children are not visible */
601 if (win && (win->style & WS_MINIMIZE)) return 0;
603 return 1;
606 /* same as is_visible but takes a window handle */
607 int is_window_visible( user_handle_t window )
609 struct window *win = get_user_object( window, USER_WINDOW );
610 if (!win) return 0;
611 return is_visible( win );
614 /* check if point is inside the window */
615 static inline int is_point_in_window( struct window *win, int x, int y )
617 if (!(win->style & WS_VISIBLE)) return 0; /* not visible */
618 if ((win->style & (WS_POPUP|WS_CHILD|WS_DISABLED)) == (WS_CHILD|WS_DISABLED))
619 return 0; /* disabled child */
620 if ((win->ex_style & (WS_EX_LAYERED|WS_EX_TRANSPARENT)) == (WS_EX_LAYERED|WS_EX_TRANSPARENT))
621 return 0; /* transparent */
622 if (x < win->visible_rect.left || x >= win->visible_rect.right ||
623 y < win->visible_rect.top || y >= win->visible_rect.bottom)
624 return 0; /* not in window */
625 if (win->win_region &&
626 !point_in_region( win->win_region, x - win->window_rect.left, y - win->window_rect.top ))
627 return 0; /* not in window region */
628 return 1;
631 /* find child of 'parent' that contains the given point (in parent-relative coords) */
632 static struct window *child_window_from_point( struct window *parent, int x, int y )
634 struct window *ptr;
636 LIST_FOR_EACH_ENTRY( ptr, &parent->children, struct window, entry )
638 if (!is_point_in_window( ptr, x, y )) continue; /* skip it */
640 /* if window is minimized or disabled, return at once */
641 if (ptr->style & (WS_MINIMIZE|WS_DISABLED)) return ptr;
643 /* if point is not in client area, return at once */
644 if (x < ptr->client_rect.left || x >= ptr->client_rect.right ||
645 y < ptr->client_rect.top || y >= ptr->client_rect.bottom)
646 return ptr;
648 return child_window_from_point( ptr, x - ptr->client_rect.left, y - ptr->client_rect.top );
650 return parent; /* not found any child */
653 /* find all children of 'parent' that contain the given point */
654 static int get_window_children_from_point( struct window *parent, int x, int y,
655 struct user_handle_array *array )
657 struct window *ptr;
659 LIST_FOR_EACH_ENTRY( ptr, &parent->children, struct window, entry )
661 if (!is_point_in_window( ptr, x, y )) continue; /* skip it */
663 /* if point is in client area, and window is not minimized or disabled, check children */
664 if (!(ptr->style & (WS_MINIMIZE|WS_DISABLED)) &&
665 x >= ptr->client_rect.left && x < ptr->client_rect.right &&
666 y >= ptr->client_rect.top && y < ptr->client_rect.bottom)
668 if (!get_window_children_from_point( ptr, x - ptr->client_rect.left,
669 y - ptr->client_rect.top, array ))
670 return 0;
673 /* now add window to the array */
674 if (!add_handle_to_array( array, ptr->handle )) return 0;
676 return 1;
679 /* find window containing point (in absolute coords) */
680 user_handle_t window_from_point( struct desktop *desktop, int x, int y )
682 struct window *ret;
684 if (!desktop->top_window) return 0;
685 ret = child_window_from_point( desktop->top_window, x, y );
686 return ret->handle;
689 /* return list of all windows containing point (in absolute coords) */
690 static int all_windows_from_point( struct window *top, int x, int y, struct user_handle_array *array )
692 struct window *ptr;
694 /* make point relative to top window */
695 for (ptr = top->parent; ptr && !is_desktop_window(ptr); ptr = ptr->parent)
697 x -= ptr->client_rect.left;
698 y -= ptr->client_rect.top;
701 if (!is_point_in_window( top, x, y )) return 1;
703 /* if point is in client area, and window is not minimized or disabled, check children */
704 if (!(top->style & (WS_MINIMIZE|WS_DISABLED)) &&
705 x >= top->client_rect.left && x < top->client_rect.right &&
706 y >= top->client_rect.top && y < top->client_rect.bottom)
708 if (!is_desktop_window(top))
710 x -= top->client_rect.left;
711 y -= top->client_rect.top;
713 if (!get_window_children_from_point( top, x, y, array )) return 0;
715 /* now add window to the array */
716 if (!add_handle_to_array( array, top->handle )) return 0;
717 return 1;
721 /* return the thread owning a window */
722 struct thread *get_window_thread( user_handle_t handle )
724 struct window *win = get_user_object( handle, USER_WINDOW );
725 if (!win || !win->thread) return NULL;
726 return (struct thread *)grab_object( win->thread );
730 /* check if any area of a window needs repainting */
731 static inline int win_needs_repaint( struct window *win )
733 return win->update_region || (win->paint_flags & PAINT_INTERNAL);
737 /* find a child of the specified window that needs repainting */
738 static struct window *find_child_to_repaint( struct window *parent, struct thread *thread )
740 struct window *ptr, *ret = NULL;
742 LIST_FOR_EACH_ENTRY( ptr, &parent->children, struct window, entry )
744 if (!(ptr->style & WS_VISIBLE)) continue;
745 if (ptr->thread == thread && win_needs_repaint( ptr ))
746 ret = ptr;
747 else if (!(ptr->style & WS_MINIMIZE)) /* explore its children */
748 ret = find_child_to_repaint( ptr, thread );
749 if (ret) break;
752 if (ret && (ret->ex_style & WS_EX_TRANSPARENT))
754 /* transparent window, check for non-transparent sibling to paint first */
755 for (ptr = get_next_window(ret); ptr; ptr = get_next_window(ptr))
757 if (!(ptr->style & WS_VISIBLE)) continue;
758 if (ptr->ex_style & WS_EX_TRANSPARENT) continue;
759 if (ptr->thread != thread) continue;
760 if (win_needs_repaint( ptr )) return ptr;
763 return ret;
767 /* find a window that needs to receive a WM_PAINT; also clear its internal paint flag */
768 user_handle_t find_window_to_repaint( user_handle_t parent, struct thread *thread )
770 struct window *ptr, *win, *top_window = get_desktop_window( thread, 0 );
772 if (!top_window) return 0;
774 if (top_window->thread == thread && win_needs_repaint( top_window )) win = top_window;
775 else win = find_child_to_repaint( top_window, thread );
777 if (win && parent)
779 /* check that it is a child of the specified parent */
780 for (ptr = win; ptr; ptr = ptr->parent)
781 if (ptr->handle == parent) break;
782 /* otherwise don't return any window, we don't repaint a child before its parent */
783 if (!ptr) win = NULL;
785 if (!win) return 0;
786 win->paint_flags &= ~PAINT_INTERNAL;
787 return win->handle;
791 /* intersect the window region with the specified region, relative to the window parent */
792 static struct region *intersect_window_region( struct region *region, struct window *win )
794 /* make region relative to window rect */
795 offset_region( region, -win->window_rect.left, -win->window_rect.top );
796 if (!intersect_region( region, region, win->win_region )) return NULL;
797 /* make region relative to parent again */
798 offset_region( region, win->window_rect.left, win->window_rect.top );
799 return region;
803 /* convert coordinates from client to screen coords */
804 static inline void client_to_screen( struct window *win, int *x, int *y )
806 for ( ; win && !is_desktop_window(win); win = win->parent)
808 *x += win->client_rect.left;
809 *y += win->client_rect.top;
813 /* convert coordinates from client to screen coords */
814 static inline void client_to_screen_rect( struct window *win, rectangle_t *rect )
816 for ( ; win && !is_desktop_window(win); win = win->parent)
818 rect->left += win->client_rect.left;
819 rect->right += win->client_rect.left;
820 rect->top += win->client_rect.top;
821 rect->bottom += win->client_rect.top;
825 /* map the region from window to screen coordinates */
826 static inline void map_win_region_to_screen( struct window *win, struct region *region )
828 if (!is_desktop_window(win))
830 int x = win->window_rect.left;
831 int y = win->window_rect.top;
832 client_to_screen( win->parent, &x, &y );
833 offset_region( region, x, y );
838 /* clip all children of a given window out of the visible region */
839 static struct region *clip_children( struct window *parent, struct window *last,
840 struct region *region, int offset_x, int offset_y )
842 struct window *ptr;
843 struct region *tmp = create_empty_region();
845 if (!tmp) return NULL;
846 LIST_FOR_EACH_ENTRY( ptr, &parent->children, struct window, entry )
848 if (ptr == last) break;
849 if (!(ptr->style & WS_VISIBLE)) continue;
850 if (ptr->ex_style & WS_EX_TRANSPARENT) continue;
851 set_region_rect( tmp, &ptr->visible_rect );
852 if (ptr->win_region && !intersect_window_region( tmp, ptr ))
854 free_region( tmp );
855 return NULL;
857 offset_region( tmp, offset_x, offset_y );
858 if (!(region = subtract_region( region, region, tmp ))) break;
859 if (is_region_empty( region )) break;
861 free_region( tmp );
862 return region;
866 /* compute the intersection of two rectangles; return 0 if the result is empty */
867 static inline int intersect_rect( rectangle_t *dst, const rectangle_t *src1, const rectangle_t *src2 )
869 dst->left = max( src1->left, src2->left );
870 dst->top = max( src1->top, src2->top );
871 dst->right = min( src1->right, src2->right );
872 dst->bottom = min( src1->bottom, src2->bottom );
873 return (dst->left < dst->right && dst->top < dst->bottom);
877 /* set the region to the client rect clipped by the window rect, in parent-relative coordinates */
878 static void set_region_client_rect( struct region *region, struct window *win )
880 rectangle_t rect;
882 intersect_rect( &rect, &win->window_rect, &win->client_rect );
883 set_region_rect( region, &rect );
887 /* get the top-level window to clip against for a given window */
888 static inline struct window *get_top_clipping_window( struct window *win )
890 while (win->parent && !is_desktop_window(win->parent)) win = win->parent;
891 return win;
895 /* compute the visible region of a window, in window coordinates */
896 static struct region *get_visible_region( struct window *win, unsigned int flags )
898 struct region *tmp = NULL, *region;
899 int offset_x, offset_y;
901 if (!(region = create_empty_region())) return NULL;
903 /* first check if all ancestors are visible */
905 if (!is_visible( win )) return region; /* empty region */
907 /* create a region relative to the window itself */
909 if ((flags & DCX_PARENTCLIP) && win->parent && !is_desktop_window(win->parent))
911 set_region_client_rect( region, win->parent );
912 offset_region( region, -win->parent->client_rect.left, -win->parent->client_rect.top );
914 else if (flags & DCX_WINDOW)
916 set_region_rect( region, &win->visible_rect );
917 if (win->win_region && !intersect_window_region( region, win )) goto error;
919 else
921 set_region_client_rect( region, win );
922 if (win->win_region && !intersect_window_region( region, win )) goto error;
925 /* clip children */
927 if (flags & DCX_CLIPCHILDREN)
929 if (is_desktop_window(win)) offset_x = offset_y = 0;
930 else
932 offset_x = win->client_rect.left;
933 offset_y = win->client_rect.top;
935 if (!clip_children( win, NULL, region, offset_x, offset_y )) goto error;
938 /* clip siblings of ancestors */
940 if (is_desktop_window(win)) offset_x = offset_y = 0;
941 else
943 offset_x = win->window_rect.left;
944 offset_y = win->window_rect.top;
947 if ((tmp = create_empty_region()) != NULL)
949 while (win->parent)
951 /* we don't clip out top-level siblings as that's up to the native windowing system */
952 if ((win->style & WS_CLIPSIBLINGS) && !is_desktop_window( win->parent ))
954 if (!clip_children( win->parent, win, region, 0, 0 )) goto error;
955 if (is_region_empty( region )) break;
957 /* clip to parent client area */
958 win = win->parent;
959 if (!is_desktop_window(win))
961 offset_x += win->client_rect.left;
962 offset_y += win->client_rect.top;
963 offset_region( region, win->client_rect.left, win->client_rect.top );
965 set_region_client_rect( tmp, win );
966 if (win->win_region && !intersect_window_region( tmp, win )) goto error;
967 if (!intersect_region( region, region, tmp )) goto error;
968 if (is_region_empty( region )) break;
970 free_region( tmp );
972 offset_region( region, -offset_x, -offset_y ); /* make it relative to target window */
973 return region;
975 error:
976 if (tmp) free_region( tmp );
977 free_region( region );
978 return NULL;
982 /* get the window class of a window */
983 struct window_class* get_window_class( user_handle_t window )
985 struct window *win;
986 if (!(win = get_window( window ))) return NULL;
987 if (!win->class) set_error( STATUS_ACCESS_DENIED );
988 return win->class;
991 /* return a copy of the specified region cropped to the window client or frame rectangle, */
992 /* and converted from client to window coordinates. Helper for (in)validate_window. */
993 static struct region *crop_region_to_win_rect( struct window *win, struct region *region, int frame )
995 struct region *tmp = create_empty_region();
997 if (!tmp) return NULL;
999 /* get bounding rect in client coords */
1000 if (frame) set_region_rect( tmp, &win->window_rect );
1001 else set_region_client_rect( tmp, win );
1002 if (!is_desktop_window(win))
1003 offset_region( tmp, -win->client_rect.left, -win->client_rect.top );
1005 /* intersect specified region with bounding rect */
1006 if (region && !intersect_region( tmp, region, tmp )) goto done;
1007 if (is_region_empty( tmp )) goto done;
1009 /* map it to window coords */
1010 offset_region( tmp, win->client_rect.left - win->window_rect.left,
1011 win->client_rect.top - win->window_rect.top );
1012 return tmp;
1014 done:
1015 free_region( tmp );
1016 return NULL;
1020 /* set a region as new update region for the window */
1021 static void set_update_region( struct window *win, struct region *region )
1023 if (region && !is_region_empty( region ))
1025 if (!win->update_region) inc_window_paint_count( win, 1 );
1026 else free_region( win->update_region );
1027 win->update_region = region;
1029 else
1031 if (win->update_region)
1033 inc_window_paint_count( win, -1 );
1034 free_region( win->update_region );
1036 win->paint_flags &= ~(PAINT_ERASE | PAINT_DELAYED_ERASE | PAINT_NONCLIENT);
1037 win->update_region = NULL;
1038 if (region) free_region( region );
1043 /* add a region to the update region; the passed region is freed or reused */
1044 static int add_update_region( struct window *win, struct region *region )
1046 if (win->update_region && !union_region( region, win->update_region, region ))
1048 free_region( region );
1049 return 0;
1051 set_update_region( win, region );
1052 return 1;
1056 /* validate the non client area of a window */
1057 static void validate_non_client( struct window *win )
1059 struct region *tmp;
1060 rectangle_t rect;
1062 if (!win->update_region) return; /* nothing to do */
1064 /* get client rect in window coords */
1065 rect.left = win->client_rect.left - win->window_rect.left;
1066 rect.top = win->client_rect.top - win->window_rect.top;
1067 rect.right = win->client_rect.right - win->window_rect.left;
1068 rect.bottom = win->client_rect.bottom - win->window_rect.top;
1070 if ((tmp = create_empty_region()))
1072 set_region_rect( tmp, &rect );
1073 if (intersect_region( tmp, win->update_region, tmp ))
1074 set_update_region( win, tmp );
1075 else
1076 free_region( tmp );
1078 win->paint_flags &= ~PAINT_NONCLIENT;
1082 /* validate a window completely so that we don't get any further paint messages for it */
1083 static void validate_whole_window( struct window *win )
1085 set_update_region( win, NULL );
1087 if (win->paint_flags & PAINT_INTERNAL)
1089 win->paint_flags &= ~PAINT_INTERNAL;
1090 inc_window_paint_count( win, -1 );
1095 /* validate a window's children so that we don't get any further paint messages for it */
1096 static void validate_children( struct window *win )
1098 struct window *child;
1100 LIST_FOR_EACH_ENTRY( child, &win->children, struct window, entry )
1102 if (!(child->style & WS_VISIBLE)) continue;
1103 validate_children(child);
1104 validate_whole_window(child);
1109 /* validate the update region of a window on all parents; helper for get_update_region */
1110 static void validate_parents( struct window *child )
1112 int offset_x = 0, offset_y = 0;
1113 struct window *win = child;
1114 struct region *tmp = NULL;
1116 if (!child->update_region) return;
1118 while (win->parent)
1120 /* map to parent client coords */
1121 offset_x += win->window_rect.left;
1122 offset_y += win->window_rect.top;
1124 win = win->parent;
1126 /* and now map to window coords */
1127 offset_x += win->client_rect.left - win->window_rect.left;
1128 offset_y += win->client_rect.top - win->window_rect.top;
1130 if (win->update_region && !(win->style & WS_CLIPCHILDREN))
1132 if (!tmp && !(tmp = create_empty_region())) return;
1133 offset_region( child->update_region, offset_x, offset_y );
1134 if (subtract_region( tmp, win->update_region, child->update_region ))
1136 set_update_region( win, tmp );
1137 tmp = NULL;
1139 /* restore child coords */
1140 offset_region( child->update_region, -offset_x, -offset_y );
1143 if (tmp) free_region( tmp );
1147 /* add/subtract a region (in client coordinates) to the update region of the window */
1148 static void redraw_window( struct window *win, struct region *region, int frame, unsigned int flags )
1150 struct region *tmp;
1151 struct window *child;
1153 if (flags & RDW_INVALIDATE)
1155 if (!(tmp = crop_region_to_win_rect( win, region, frame ))) return;
1157 if (!add_update_region( win, tmp )) return;
1159 if (flags & RDW_FRAME) win->paint_flags |= PAINT_NONCLIENT;
1160 if (flags & RDW_ERASE) win->paint_flags |= PAINT_ERASE;
1162 else if (flags & RDW_VALIDATE)
1164 if (!region && (flags & RDW_NOFRAME)) /* shortcut: validate everything */
1166 set_update_region( win, NULL );
1168 else if (win->update_region)
1170 if ((tmp = crop_region_to_win_rect( win, region, frame )))
1172 if (!subtract_region( tmp, win->update_region, tmp ))
1174 free_region( tmp );
1175 return;
1177 set_update_region( win, tmp );
1179 if (flags & RDW_NOFRAME) validate_non_client( win );
1180 if (flags & RDW_NOERASE) win->paint_flags &= ~(PAINT_ERASE | PAINT_DELAYED_ERASE);
1184 if ((flags & RDW_INTERNALPAINT) && !(win->paint_flags & PAINT_INTERNAL))
1186 win->paint_flags |= PAINT_INTERNAL;
1187 inc_window_paint_count( win, 1 );
1189 else if ((flags & RDW_NOINTERNALPAINT) && (win->paint_flags & PAINT_INTERNAL))
1191 win->paint_flags &= ~PAINT_INTERNAL;
1192 inc_window_paint_count( win, -1 );
1195 /* now process children recursively */
1197 if (flags & RDW_NOCHILDREN) return;
1198 if (win->style & WS_MINIMIZE) return;
1199 if ((win->style & WS_CLIPCHILDREN) && !(flags & RDW_ALLCHILDREN)) return;
1201 if (!(tmp = crop_region_to_win_rect( win, region, 0 ))) return;
1203 /* map to client coordinates */
1204 offset_region( tmp, win->window_rect.left - win->client_rect.left,
1205 win->window_rect.top - win->client_rect.top );
1207 if (flags & RDW_INVALIDATE) flags |= RDW_FRAME | RDW_ERASE;
1209 LIST_FOR_EACH_ENTRY( child, &win->children, struct window, entry )
1211 if (!(child->style & WS_VISIBLE)) continue;
1212 if (!rect_in_region( tmp, &child->window_rect )) continue;
1213 offset_region( tmp, -child->client_rect.left, -child->client_rect.top );
1214 redraw_window( child, tmp, 1, flags );
1215 offset_region( tmp, child->client_rect.left, child->client_rect.top );
1217 free_region( tmp );
1221 /* retrieve the update flags for a window depending on the state of the update region */
1222 static unsigned int get_update_flags( struct window *win, unsigned int flags )
1224 unsigned int ret = 0;
1226 if (flags & UPDATE_NONCLIENT)
1228 if ((win->paint_flags & PAINT_NONCLIENT) && win->update_region) ret |= UPDATE_NONCLIENT;
1230 if (flags & UPDATE_ERASE)
1232 if ((win->paint_flags & PAINT_ERASE) && win->update_region) ret |= UPDATE_ERASE;
1234 if (flags & UPDATE_PAINT)
1236 if (win->update_region)
1238 if (win->paint_flags & PAINT_DELAYED_ERASE) ret |= UPDATE_DELAYED_ERASE;
1239 ret |= UPDATE_PAINT;
1242 if (flags & UPDATE_INTERNALPAINT)
1244 if (win->paint_flags & PAINT_INTERNAL)
1246 ret |= UPDATE_INTERNALPAINT;
1247 if (win->paint_flags & PAINT_DELAYED_ERASE) ret |= UPDATE_DELAYED_ERASE;
1250 return ret;
1254 /* iterate through the children of the given window until we find one with some update flags */
1255 static unsigned int get_child_update_flags( struct window *win, struct window *from_child,
1256 unsigned int flags, struct window **child )
1258 struct window *ptr;
1259 unsigned int ret = 0;
1261 /* first make sure we want to iterate children at all */
1263 if (win->style & WS_MINIMIZE) return 0;
1265 /* note: the WS_CLIPCHILDREN test is the opposite of the invalidation case,
1266 * here we only want to repaint children of windows that clip them, others
1267 * need to wait for WM_PAINT to be done in the parent first.
1269 if (!(flags & UPDATE_ALLCHILDREN) && !(win->style & WS_CLIPCHILDREN)) return 0;
1271 LIST_FOR_EACH_ENTRY( ptr, &win->children, struct window, entry )
1273 if (from_child) /* skip all children until from_child is found */
1275 if (ptr == from_child) from_child = NULL;
1276 continue;
1278 if (!(ptr->style & WS_VISIBLE)) continue;
1279 if ((ret = get_update_flags( ptr, flags )) != 0)
1281 *child = ptr;
1282 break;
1284 if ((ret = get_child_update_flags( ptr, NULL, flags, child ))) break;
1286 return ret;
1289 /* iterate through children and siblings of the given window until we find one with some update flags */
1290 static unsigned int get_window_update_flags( struct window *win, struct window *from_child,
1291 unsigned int flags, struct window **child )
1293 unsigned int ret;
1294 struct window *ptr, *from_sibling = NULL;
1296 /* if some parent is not visible start from the next sibling */
1298 if (!is_visible( win )) return 0;
1299 for (ptr = from_child; ptr; ptr = ptr->parent)
1301 if (!(ptr->style & WS_VISIBLE) || (ptr->style & WS_MINIMIZE)) from_sibling = ptr;
1302 if (ptr == win) break;
1305 /* non-client painting must be delayed if one of the parents is going to
1306 * be repainted and doesn't clip children */
1308 if ((flags & UPDATE_NONCLIENT) && !(flags & (UPDATE_PAINT|UPDATE_INTERNALPAINT)))
1310 for (ptr = win->parent; ptr; ptr = ptr->parent)
1312 if (!(ptr->style & WS_CLIPCHILDREN) && win_needs_repaint( ptr ))
1313 return 0;
1315 if (from_child && !(flags & UPDATE_ALLCHILDREN))
1317 for (ptr = from_sibling ? from_sibling : from_child; ptr; ptr = ptr->parent)
1319 if (!(ptr->style & WS_CLIPCHILDREN) && win_needs_repaint( ptr )) from_sibling = ptr;
1320 if (ptr == win) break;
1326 /* check window itself (only if not restarting from a child) */
1328 if (!from_child)
1330 if ((ret = get_update_flags( win, flags )))
1332 *child = win;
1333 return ret;
1335 from_child = win;
1338 /* now check children */
1340 if (flags & UPDATE_NOCHILDREN) return 0;
1341 if (!from_sibling)
1343 if ((ret = get_child_update_flags( from_child, NULL, flags, child ))) return ret;
1344 from_sibling = from_child;
1347 /* then check siblings and parent siblings */
1349 while (from_sibling->parent && from_sibling != win)
1351 if ((ret = get_child_update_flags( from_sibling->parent, from_sibling, flags, child )))
1352 return ret;
1353 from_sibling = from_sibling->parent;
1355 return 0;
1359 /* expose the areas revealed by a vis region change on the window parent */
1360 /* returns the region exposed on the window itself (in client coordinates) */
1361 static struct region *expose_window( struct window *win, const rectangle_t *old_window_rect,
1362 struct region *old_vis_rgn )
1364 struct window *parent = win;
1365 struct region *new_vis_rgn, *exposed_rgn;
1367 if (!(new_vis_rgn = get_visible_region( win, DCX_WINDOW ))) return NULL;
1369 if ((exposed_rgn = create_empty_region()))
1371 if (subtract_region( exposed_rgn, new_vis_rgn, old_vis_rgn ) && !is_region_empty( exposed_rgn ))
1373 /* make it relative to the new client area */
1374 offset_region( exposed_rgn, win->window_rect.left - win->client_rect.left,
1375 win->window_rect.top - win->client_rect.top );
1377 else
1379 free_region( exposed_rgn );
1380 exposed_rgn = NULL;
1384 /* make it relative to the old window pos for subtracting */
1385 offset_region( new_vis_rgn, win->window_rect.left - old_window_rect->left,
1386 win->window_rect.top - old_window_rect->top );
1388 if (subtract_region( new_vis_rgn, old_vis_rgn, new_vis_rgn ) && !is_region_empty( new_vis_rgn ))
1390 /* make it relative to new client rect again */
1391 int offset_x = old_window_rect->left - win->client_rect.left;
1392 int offset_y = old_window_rect->top - win->client_rect.top;
1393 if (win->parent && !is_desktop_window(win->parent))
1395 offset_x += win->client_rect.left;
1396 offset_y += win->client_rect.top;
1397 parent = win->parent;
1399 offset_region( new_vis_rgn, offset_x, offset_y );
1400 redraw_window( parent, new_vis_rgn, 0, RDW_INVALIDATE | RDW_ERASE | RDW_ALLCHILDREN );
1402 free_region( new_vis_rgn );
1403 return exposed_rgn;
1407 /* set the window and client rectangles, updating the update region if necessary */
1408 static void set_window_pos( struct window *win, struct window *previous,
1409 unsigned int swp_flags, const rectangle_t *window_rect,
1410 const rectangle_t *client_rect, const rectangle_t *visible_rect,
1411 const rectangle_t *valid_rects )
1413 struct region *old_vis_rgn = NULL, *exposed_rgn = NULL;
1414 const rectangle_t old_window_rect = win->window_rect;
1415 const rectangle_t old_visible_rect = win->visible_rect;
1416 const rectangle_t old_client_rect = win->client_rect;
1417 int client_changed, frame_changed;
1418 int visible = (win->style & WS_VISIBLE) || (swp_flags & SWP_SHOWWINDOW);
1420 if (win->parent && !is_visible( win->parent )) visible = 0;
1422 if (visible && !(old_vis_rgn = get_visible_region( win, DCX_WINDOW ))) return;
1424 /* set the new window info before invalidating anything */
1426 win->window_rect = *window_rect;
1427 win->visible_rect = *visible_rect;
1428 win->client_rect = *client_rect;
1429 if (!(swp_flags & SWP_NOZORDER) && win->parent) link_window( win, previous );
1430 if (swp_flags & SWP_SHOWWINDOW) win->style |= WS_VISIBLE;
1431 else if (swp_flags & SWP_HIDEWINDOW) win->style &= ~WS_VISIBLE;
1433 /* if the window is not visible, everything is easy */
1434 if (!visible) return;
1436 /* expose anything revealed by the change */
1438 if (!(swp_flags & SWP_NOREDRAW))
1439 exposed_rgn = expose_window( win, &old_window_rect, old_vis_rgn );
1441 if (!(win->style & WS_VISIBLE))
1443 /* clear the update region since the window is no longer visible */
1444 validate_whole_window( win );
1445 validate_children( win );
1446 goto done;
1449 /* crop update region to the new window rect */
1451 if (win->update_region &&
1452 (window_rect->right - window_rect->left < old_window_rect.right - old_window_rect.left ||
1453 window_rect->bottom - window_rect->top < old_window_rect.bottom - old_window_rect.top))
1455 struct region *tmp = create_empty_region();
1456 if (tmp)
1458 set_region_rect( tmp, window_rect );
1459 if (!is_desktop_window(win))
1460 offset_region( tmp, -window_rect->left, -window_rect->top );
1461 if (intersect_region( tmp, win->update_region, tmp ))
1462 set_update_region( win, tmp );
1463 else
1464 free_region( tmp );
1468 if (swp_flags & SWP_NOREDRAW) goto done; /* do not repaint anything */
1470 /* expose the whole non-client area if it changed in any way */
1472 if (swp_flags & SWP_NOCOPYBITS)
1474 frame_changed = ((swp_flags & SWP_FRAMECHANGED) ||
1475 memcmp( window_rect, &old_window_rect, sizeof(old_window_rect) ) ||
1476 memcmp( visible_rect, &old_visible_rect, sizeof(old_visible_rect) ));
1477 client_changed = memcmp( client_rect, &old_client_rect, sizeof(old_client_rect) );
1479 else
1481 /* assume the bits have been moved to follow the window rect */
1482 int x_offset = window_rect->left - old_window_rect.left;
1483 int y_offset = window_rect->top - old_window_rect.top;
1484 frame_changed = ((swp_flags & SWP_FRAMECHANGED) ||
1485 window_rect->right - old_window_rect.right != x_offset ||
1486 window_rect->bottom - old_window_rect.bottom != y_offset ||
1487 visible_rect->left - old_visible_rect.left != x_offset ||
1488 visible_rect->right - old_visible_rect.right != x_offset ||
1489 visible_rect->top - old_visible_rect.top != y_offset ||
1490 visible_rect->bottom - old_visible_rect.bottom != y_offset);
1491 client_changed = (client_rect->left - old_client_rect.left != x_offset ||
1492 client_rect->right - old_client_rect.right != x_offset ||
1493 client_rect->top - old_client_rect.top != y_offset ||
1494 client_rect->bottom - old_client_rect.bottom != y_offset);
1497 if (frame_changed || client_changed)
1499 struct region *tmp = create_empty_region();
1501 if (tmp)
1503 /* subtract the valid portion of client rect from the total region */
1504 if (!client_changed)
1505 set_region_rect( tmp, client_rect );
1506 else if (valid_rects)
1507 set_region_rect( tmp, &valid_rects[0] );
1509 set_region_rect( old_vis_rgn, window_rect );
1510 if (!subtract_region( tmp, old_vis_rgn, tmp )) free_region( tmp );
1511 else
1513 if (!is_desktop_window(win))
1514 offset_region( tmp, -client_rect->left, -client_rect->top );
1515 if (exposed_rgn)
1517 union_region( exposed_rgn, exposed_rgn, tmp );
1518 free_region( tmp );
1520 else exposed_rgn = tmp;
1525 if (exposed_rgn)
1526 redraw_window( win, exposed_rgn, 1, RDW_INVALIDATE | RDW_ERASE | RDW_FRAME | RDW_ALLCHILDREN );
1528 done:
1529 free_region( old_vis_rgn );
1530 if (exposed_rgn) free_region( exposed_rgn );
1531 clear_error(); /* we ignore out of memory errors once the new rects have been set */
1535 /* set the window region, updating the update region if necessary */
1536 static void set_window_region( struct window *win, struct region *region, int redraw )
1538 struct region *old_vis_rgn = NULL, *exposed_rgn;
1540 /* no need to redraw if window is not visible */
1541 if (redraw && !is_visible( win )) redraw = 0;
1543 if (redraw) old_vis_rgn = get_visible_region( win, DCX_WINDOW );
1545 if (win->win_region) free_region( win->win_region );
1546 win->win_region = region;
1548 /* expose anything revealed by the change */
1549 if (old_vis_rgn && ((exposed_rgn = expose_window( win, &win->window_rect, old_vis_rgn ))))
1551 redraw_window( win, exposed_rgn, 1, RDW_INVALIDATE | RDW_ERASE | RDW_FRAME | RDW_ALLCHILDREN );
1552 free_region( exposed_rgn );
1555 if (old_vis_rgn) free_region( old_vis_rgn );
1556 clear_error(); /* we ignore out of memory errors since the region has been set */
1560 /* create a window */
1561 DECL_HANDLER(create_window)
1563 struct window *win, *parent, *owner = NULL;
1564 atom_t atom;
1566 reply->handle = 0;
1568 if (!req->parent) parent = get_desktop_window( current, 0 );
1569 else if (!(parent = get_window( req->parent ))) return;
1571 if (req->owner)
1573 if (!(owner = get_window( req->owner ))) return;
1574 if (is_desktop_window(owner)) owner = NULL;
1575 else if (!is_desktop_window(parent))
1577 /* an owned window must be created as top-level */
1578 set_error( STATUS_ACCESS_DENIED );
1579 return;
1581 else /* owner must be a top-level window */
1582 while (!is_desktop_window(owner->parent)) owner = owner->parent;
1585 if (get_req_data_size())
1586 atom = find_global_atom( NULL, get_req_data(), get_req_data_size() / sizeof(WCHAR) );
1587 else
1588 atom = req->atom;
1590 if (!(win = create_window( parent, owner, atom, req->instance ))) return;
1592 reply->handle = win->handle;
1593 reply->parent = win->parent ? win->parent->handle : 0;
1594 reply->owner = win->owner;
1595 reply->extra = win->nb_extra_bytes;
1596 reply->class_ptr = get_class_client_ptr( win->class );
1600 /* set the parent of a window */
1601 DECL_HANDLER(set_parent)
1603 struct window *win, *parent = NULL;
1605 if (!(win = get_window( req->handle ))) return;
1606 if (req->parent && !(parent = get_window( req->parent ))) return;
1608 if (is_desktop_window(win))
1610 set_error( STATUS_INVALID_PARAMETER );
1611 return;
1613 reply->old_parent = win->parent->handle;
1614 reply->full_parent = parent ? parent->handle : 0;
1615 set_parent_window( win, parent );
1619 /* destroy a window */
1620 DECL_HANDLER(destroy_window)
1622 struct window *win = get_window( req->handle );
1623 if (win)
1625 if (!is_desktop_window(win)) destroy_window( win );
1626 else if (win->thread == current) detach_window_thread( win );
1627 else set_error( STATUS_ACCESS_DENIED );
1632 /* retrieve the desktop window for the current thread */
1633 DECL_HANDLER(get_desktop_window)
1635 struct window *win = get_desktop_window( current, req->force );
1637 if (win) reply->handle = win->handle;
1641 /* set a window owner */
1642 DECL_HANDLER(set_window_owner)
1644 struct window *win = get_window( req->handle );
1645 struct window *owner = NULL;
1647 if (!win) return;
1648 if (req->owner && !(owner = get_window( req->owner ))) return;
1649 if (is_desktop_window(win))
1651 set_error( STATUS_ACCESS_DENIED );
1652 return;
1654 reply->prev_owner = win->owner;
1655 reply->full_owner = win->owner = owner ? owner->handle : 0;
1659 /* get information from a window handle */
1660 DECL_HANDLER(get_window_info)
1662 struct window *win = get_window( req->handle );
1664 reply->full_handle = 0;
1665 reply->tid = reply->pid = 0;
1666 if (win)
1668 reply->full_handle = win->handle;
1669 reply->last_active = win->handle;
1670 reply->is_unicode = win->is_unicode;
1671 if (get_user_object( win->last_active, USER_WINDOW )) reply->last_active = win->last_active;
1672 if (win->thread)
1674 reply->tid = get_thread_id( win->thread );
1675 reply->pid = get_process_id( win->thread->process );
1676 reply->atom = win->class ? get_class_atom( win->class ) : DESKTOP_ATOM;
1682 /* set some information in a window */
1683 DECL_HANDLER(set_window_info)
1685 struct window *win = get_window( req->handle );
1687 if (!win) return;
1688 if (req->flags && is_desktop_window(win) && win->thread != current)
1690 set_error( STATUS_ACCESS_DENIED );
1691 return;
1693 if (req->extra_size > sizeof(req->extra_value) ||
1694 req->extra_offset < -1 ||
1695 req->extra_offset > win->nb_extra_bytes - (int)req->extra_size)
1697 set_win32_error( ERROR_INVALID_INDEX );
1698 return;
1700 if (req->extra_offset != -1)
1702 memcpy( &reply->old_extra_value, win->extra_bytes + req->extra_offset, req->extra_size );
1704 else if (req->flags & SET_WIN_EXTRA)
1706 set_win32_error( ERROR_INVALID_INDEX );
1707 return;
1709 reply->old_style = win->style;
1710 reply->old_ex_style = win->ex_style;
1711 reply->old_id = win->id;
1712 reply->old_instance = win->instance;
1713 reply->old_user_data = win->user_data;
1714 if (req->flags & SET_WIN_STYLE) win->style = req->style;
1715 if (req->flags & SET_WIN_EXSTYLE)
1717 /* WS_EX_TOPMOST can only be changed for unlinked windows */
1718 if (!win->is_linked) win->ex_style = req->ex_style;
1719 else win->ex_style = (req->ex_style & ~WS_EX_TOPMOST) | (win->ex_style & WS_EX_TOPMOST);
1721 if (req->flags & SET_WIN_ID) win->id = req->id;
1722 if (req->flags & SET_WIN_INSTANCE) win->instance = req->instance;
1723 if (req->flags & SET_WIN_UNICODE) win->is_unicode = req->is_unicode;
1724 if (req->flags & SET_WIN_USERDATA) win->user_data = req->user_data;
1725 if (req->flags & SET_WIN_EXTRA) memcpy( win->extra_bytes + req->extra_offset,
1726 &req->extra_value, req->extra_size );
1728 /* changing window style triggers a non-client paint */
1729 if (req->flags & SET_WIN_STYLE) win->paint_flags |= PAINT_NONCLIENT;
1733 /* get a list of the window parents, up to the root of the tree */
1734 DECL_HANDLER(get_window_parents)
1736 struct window *ptr, *win = get_window( req->handle );
1737 int total = 0;
1738 user_handle_t *data;
1739 data_size_t len;
1741 if (win) for (ptr = win->parent; ptr; ptr = ptr->parent) total++;
1743 reply->count = total;
1744 len = min( get_reply_max_size(), total * sizeof(user_handle_t) );
1745 if (len && ((data = set_reply_data_size( len ))))
1747 for (ptr = win->parent; ptr && len; ptr = ptr->parent, len -= sizeof(*data))
1748 *data++ = ptr->handle;
1753 /* get a list of the window children */
1754 DECL_HANDLER(get_window_children)
1756 struct window *ptr, *parent = get_window( req->parent );
1757 int total = 0;
1758 user_handle_t *data;
1759 data_size_t len;
1760 atom_t atom = req->atom;
1762 if (get_req_data_size())
1764 atom = find_global_atom( NULL, get_req_data(), get_req_data_size() / sizeof(WCHAR) );
1765 if (!atom) return;
1768 if (parent)
1770 LIST_FOR_EACH_ENTRY( ptr, &parent->children, struct window, entry )
1772 if (atom && get_class_atom(ptr->class) != atom) continue;
1773 if (req->tid && get_thread_id(ptr->thread) != req->tid) continue;
1774 total++;
1777 reply->count = total;
1778 len = min( get_reply_max_size(), total * sizeof(user_handle_t) );
1779 if (len && ((data = set_reply_data_size( len ))))
1781 LIST_FOR_EACH_ENTRY( ptr, &parent->children, struct window, entry )
1783 if (len < sizeof(*data)) break;
1784 if (atom && get_class_atom(ptr->class) != atom) continue;
1785 if (req->tid && get_thread_id(ptr->thread) != req->tid) continue;
1786 *data++ = ptr->handle;
1787 len -= sizeof(*data);
1793 /* get a list of the window children that contain a given point */
1794 DECL_HANDLER(get_window_children_from_point)
1796 struct user_handle_array array;
1797 struct window *parent = get_window( req->parent );
1798 data_size_t len;
1800 if (!parent) return;
1802 array.handles = NULL;
1803 array.count = 0;
1804 array.total = 0;
1805 if (!all_windows_from_point( parent, req->x, req->y, &array )) return;
1807 reply->count = array.count;
1808 len = min( get_reply_max_size(), array.count * sizeof(user_handle_t) );
1809 if (len) set_reply_data_ptr( array.handles, len );
1810 else free( array.handles );
1814 /* get window tree information from a window handle */
1815 DECL_HANDLER(get_window_tree)
1817 struct window *ptr, *win = get_window( req->handle );
1819 if (!win) return;
1821 reply->parent = 0;
1822 reply->owner = 0;
1823 reply->next_sibling = 0;
1824 reply->prev_sibling = 0;
1825 reply->first_sibling = 0;
1826 reply->last_sibling = 0;
1827 reply->first_child = 0;
1828 reply->last_child = 0;
1830 if (win->parent)
1832 struct window *parent = win->parent;
1833 reply->parent = parent->handle;
1834 reply->owner = win->owner;
1835 if (win->is_linked)
1837 if ((ptr = get_next_window( win ))) reply->next_sibling = ptr->handle;
1838 if ((ptr = get_prev_window( win ))) reply->prev_sibling = ptr->handle;
1840 if ((ptr = get_first_child( parent ))) reply->first_sibling = ptr->handle;
1841 if ((ptr = get_last_child( parent ))) reply->last_sibling = ptr->handle;
1843 if ((ptr = get_first_child( win ))) reply->first_child = ptr->handle;
1844 if ((ptr = get_last_child( win ))) reply->last_child = ptr->handle;
1848 /* set the position and Z order of a window */
1849 DECL_HANDLER(set_window_pos)
1851 const rectangle_t *visible_rect = NULL, *valid_rects = NULL;
1852 struct window *previous = NULL;
1853 struct window *win = get_window( req->handle );
1854 unsigned int flags = req->flags;
1856 if (!win) return;
1857 if (!win->parent) flags |= SWP_NOZORDER; /* no Z order for the desktop */
1859 if (!(flags & SWP_NOZORDER))
1861 switch ((int)(unsigned long)req->previous)
1863 case 0: /* HWND_TOP */
1864 previous = WINPTR_TOP;
1865 break;
1866 case 1: /* HWND_BOTTOM */
1867 previous = WINPTR_BOTTOM;
1868 break;
1869 case -1: /* HWND_TOPMOST */
1870 previous = WINPTR_TOPMOST;
1871 break;
1872 case -2: /* HWND_NOTOPMOST */
1873 previous = WINPTR_NOTOPMOST;
1874 break;
1875 default:
1876 if (!(previous = get_window( req->previous ))) return;
1877 /* previous must be a sibling */
1878 if (previous->parent != win->parent)
1880 set_error( STATUS_INVALID_PARAMETER );
1881 return;
1883 break;
1885 if (previous == win) flags |= SWP_NOZORDER; /* nothing to do */
1888 /* window rectangle must be ordered properly */
1889 if (req->window.right < req->window.left || req->window.bottom < req->window.top)
1891 set_error( STATUS_INVALID_PARAMETER );
1892 return;
1895 if (get_req_data_size() >= sizeof(rectangle_t)) visible_rect = get_req_data();
1896 if (get_req_data_size() >= 3 * sizeof(rectangle_t)) valid_rects = visible_rect + 1;
1898 if (!visible_rect) visible_rect = &req->window;
1899 set_window_pos( win, previous, flags, &req->window, &req->client, visible_rect, valid_rects );
1900 reply->new_style = win->style;
1901 reply->new_ex_style = win->ex_style;
1905 /* get the window and client rectangles of a window */
1906 DECL_HANDLER(get_window_rectangles)
1908 struct window *win = get_window( req->handle );
1910 if (win)
1912 reply->window = win->window_rect;
1913 reply->visible = win->visible_rect;
1914 reply->client = win->client_rect;
1919 /* get the window text */
1920 DECL_HANDLER(get_window_text)
1922 struct window *win = get_window( req->handle );
1924 if (win && win->text)
1926 data_size_t len = strlenW( win->text ) * sizeof(WCHAR);
1927 if (len > get_reply_max_size()) len = get_reply_max_size();
1928 set_reply_data( win->text, len );
1933 /* set the window text */
1934 DECL_HANDLER(set_window_text)
1936 struct window *win = get_window( req->handle );
1938 if (win)
1940 WCHAR *text = NULL;
1941 data_size_t len = get_req_data_size() / sizeof(WCHAR);
1942 if (len)
1944 if (!(text = mem_alloc( (len+1) * sizeof(WCHAR) ))) return;
1945 memcpy( text, get_req_data(), len * sizeof(WCHAR) );
1946 text[len] = 0;
1948 free( win->text );
1949 win->text = text;
1954 /* get the coordinates offset between two windows */
1955 DECL_HANDLER(get_windows_offset)
1957 struct window *win;
1959 reply->x = reply->y = 0;
1960 if (req->from)
1962 if (!(win = get_window( req->from ))) return;
1963 while (win && !is_desktop_window(win))
1965 reply->x += win->client_rect.left;
1966 reply->y += win->client_rect.top;
1967 win = win->parent;
1970 if (req->to)
1972 if (!(win = get_window( req->to ))) return;
1973 while (win && !is_desktop_window(win))
1975 reply->x -= win->client_rect.left;
1976 reply->y -= win->client_rect.top;
1977 win = win->parent;
1983 /* get the visible region of a window */
1984 DECL_HANDLER(get_visible_region)
1986 struct region *region;
1987 struct window *top, *win = get_window( req->window );
1989 if (!win) return;
1991 top = get_top_clipping_window( win );
1992 if ((region = get_visible_region( win, req->flags )))
1994 rectangle_t *data;
1995 map_win_region_to_screen( win, region );
1996 data = get_region_data_and_free( region, get_reply_max_size(), &reply->total_size );
1997 if (data) set_reply_data_ptr( data, reply->total_size );
1999 reply->top_win = top->handle;
2000 reply->top_rect = top->visible_rect;
2002 if (!is_desktop_window(win))
2004 reply->win_rect = (req->flags & DCX_WINDOW) ? win->window_rect : win->client_rect;
2005 client_to_screen_rect( top->parent, &reply->top_rect );
2006 client_to_screen_rect( win->parent, &reply->win_rect );
2008 else
2010 reply->win_rect.left = 0;
2011 reply->win_rect.top = 0;
2012 reply->win_rect.right = win->client_rect.right - win->client_rect.left;
2013 reply->win_rect.bottom = win->client_rect.bottom - win->client_rect.top;
2018 /* get the window region */
2019 DECL_HANDLER(get_window_region)
2021 struct window *win = get_window( req->window );
2023 if (!win) return;
2025 if (win->win_region)
2027 rectangle_t *data = get_region_data( win->win_region, get_reply_max_size(), &reply->total_size );
2028 if (data) set_reply_data_ptr( data, reply->total_size );
2033 /* set the window region */
2034 DECL_HANDLER(set_window_region)
2036 struct region *region = NULL;
2037 struct window *win = get_window( req->window );
2039 if (!win) return;
2041 if (get_req_data_size()) /* no data means remove the region completely */
2043 if (!(region = create_region_from_req_data( get_req_data(), get_req_data_size() )))
2044 return;
2046 set_window_region( win, region, req->redraw );
2050 /* get a window update region */
2051 DECL_HANDLER(get_update_region)
2053 rectangle_t *data;
2054 unsigned int flags = req->flags;
2055 struct window *from_child = NULL;
2056 struct window *win = get_window( req->window );
2058 reply->flags = 0;
2059 if (!win) return;
2061 if (req->from_child)
2063 struct window *ptr;
2065 if (!(from_child = get_window( req->from_child ))) return;
2067 /* make sure from_child is a child of win */
2068 ptr = from_child;
2069 while (ptr && ptr != win) ptr = ptr->parent;
2070 if (!ptr)
2072 set_error( STATUS_INVALID_PARAMETER );
2073 return;
2077 if (flags & UPDATE_DELAYED_ERASE) /* this means that the previous call didn't erase */
2079 if (from_child) from_child->paint_flags |= PAINT_DELAYED_ERASE;
2080 else win->paint_flags |= PAINT_DELAYED_ERASE;
2083 reply->flags = get_window_update_flags( win, from_child, flags, &win );
2084 reply->child = win->handle;
2086 if (flags & UPDATE_NOREGION) return;
2088 if (win->update_region)
2090 /* convert update region to screen coordinates */
2091 struct region *region = create_empty_region();
2093 if (!region) return;
2094 if (!copy_region( region, win->update_region ))
2096 free_region( region );
2097 return;
2099 map_win_region_to_screen( win, region );
2100 if (!(data = get_region_data_and_free( region, get_reply_max_size(),
2101 &reply->total_size ))) return;
2102 set_reply_data_ptr( data, reply->total_size );
2105 if (reply->flags & (UPDATE_PAINT|UPDATE_INTERNALPAINT)) /* validate everything */
2107 validate_parents( win );
2108 validate_whole_window( win );
2110 else
2112 if (reply->flags & UPDATE_NONCLIENT) validate_non_client( win );
2113 if (reply->flags & UPDATE_ERASE)
2115 win->paint_flags &= ~(PAINT_ERASE | PAINT_DELAYED_ERASE);
2116 /* desktop window only gets erased, not repainted */
2117 if (is_desktop_window(win)) validate_whole_window( win );
2123 /* update the z order of a window so that a given rectangle is fully visible */
2124 DECL_HANDLER(update_window_zorder)
2126 rectangle_t tmp;
2127 struct window *ptr, *win = get_window( req->window );
2129 if (!win || !win->parent || !is_visible( win )) return; /* nothing to do */
2131 LIST_FOR_EACH_ENTRY( ptr, &win->parent->children, struct window, entry )
2133 if (ptr == win) break;
2134 if (!(ptr->style & WS_VISIBLE)) continue;
2135 if (ptr->ex_style & WS_EX_TRANSPARENT) continue;
2136 if (!intersect_rect( &tmp, &ptr->visible_rect, &req->rect )) continue;
2137 if (ptr->win_region && !rect_in_region( ptr->win_region, &req->rect )) continue;
2138 /* found a window obscuring the rectangle, now move win above this one */
2139 /* making sure to not violate the topmost rule */
2140 if (!(ptr->ex_style & WS_EX_TOPMOST) || (win->ex_style & WS_EX_TOPMOST))
2142 list_remove( &win->entry );
2143 list_add_before( &ptr->entry, &win->entry );
2145 break;
2150 /* mark parts of a window as needing a redraw */
2151 DECL_HANDLER(redraw_window)
2153 struct region *region = NULL;
2154 struct window *win = get_window( req->window );
2156 if (!win) return;
2157 if (!is_visible( win )) return; /* nothing to do */
2159 if (req->flags & (RDW_VALIDATE|RDW_INVALIDATE))
2161 if (get_req_data_size()) /* no data means whole rectangle */
2163 if (!(region = create_region_from_req_data( get_req_data(), get_req_data_size() )))
2164 return;
2168 redraw_window( win, region, (req->flags & RDW_INVALIDATE) && (req->flags & RDW_FRAME),
2169 req->flags );
2170 if (region) free_region( region );
2174 /* set a window property */
2175 DECL_HANDLER(set_window_property)
2177 struct window *win = get_window( req->window );
2179 if (!win) return;
2181 if (get_req_data_size())
2183 atom_t atom = add_global_atom( NULL, get_req_data(), get_req_data_size() / sizeof(WCHAR) );
2184 if (atom)
2186 set_property( win, atom, req->handle, PROP_TYPE_STRING );
2187 release_global_atom( NULL, atom );
2190 else set_property( win, req->atom, req->handle, PROP_TYPE_ATOM );
2194 /* remove a window property */
2195 DECL_HANDLER(remove_window_property)
2197 struct window *win = get_window( req->window );
2199 if (win)
2201 atom_t atom = req->atom;
2202 if (get_req_data_size()) atom = find_global_atom( NULL, get_req_data(),
2203 get_req_data_size() / sizeof(WCHAR) );
2204 if (atom) reply->handle = remove_property( win, atom );
2209 /* get a window property */
2210 DECL_HANDLER(get_window_property)
2212 struct window *win = get_window( req->window );
2214 if (win)
2216 atom_t atom = req->atom;
2217 if (get_req_data_size()) atom = find_global_atom( NULL, get_req_data(),
2218 get_req_data_size() / sizeof(WCHAR) );
2219 if (atom) reply->handle = get_property( win, atom );
2224 /* get the list of properties of a window */
2225 DECL_HANDLER(get_window_properties)
2227 property_data_t *data;
2228 int i, count, max = get_reply_max_size() / sizeof(*data);
2229 struct window *win = get_window( req->window );
2231 reply->total = 0;
2232 if (!win) return;
2234 for (i = count = 0; i < win->prop_inuse; i++)
2235 if (win->properties[i].type != PROP_TYPE_FREE) count++;
2236 reply->total = count;
2238 if (count > max) count = max;
2239 if (!count || !(data = set_reply_data_size( count * sizeof(*data) ))) return;
2241 for (i = 0; i < win->prop_inuse && count; i++)
2243 if (win->properties[i].type == PROP_TYPE_FREE) continue;
2244 data->atom = win->properties[i].atom;
2245 data->string = (win->properties[i].type == PROP_TYPE_STRING);
2246 data->handle = win->properties[i].handle;
2247 data++;
2248 count--;
2253 /* get the new window pointer for a global window, checking permissions */
2254 /* helper for set_global_windows request */
2255 static int get_new_global_window( struct window **win, user_handle_t handle )
2257 if (!handle)
2259 *win = NULL;
2260 return 1;
2262 else if (*win)
2264 set_error( STATUS_ACCESS_DENIED );
2265 return 0;
2267 *win = get_window( handle );
2268 return (*win != NULL);
2271 /* Set/get the global windows */
2272 DECL_HANDLER(set_global_windows)
2274 struct window *new_shell_window = shell_window;
2275 struct window *new_shell_listview = shell_listview;
2276 struct window *new_progman_window = progman_window;
2277 struct window *new_taskman_window = taskman_window;
2279 reply->old_shell_window = shell_window ? shell_window->handle : 0;
2280 reply->old_shell_listview = shell_listview ? shell_listview->handle : 0;
2281 reply->old_progman_window = progman_window ? progman_window->handle : 0;
2282 reply->old_taskman_window = taskman_window ? taskman_window->handle : 0;
2284 if (req->flags & SET_GLOBAL_SHELL_WINDOWS)
2286 if (!get_new_global_window( &new_shell_window, req->shell_window )) return;
2287 if (!get_new_global_window( &new_shell_listview, req->shell_listview )) return;
2289 if (req->flags & SET_GLOBAL_PROGMAN_WINDOW)
2291 if (!get_new_global_window( &new_progman_window, req->progman_window )) return;
2293 if (req->flags & SET_GLOBAL_TASKMAN_WINDOW)
2295 if (!get_new_global_window( &new_taskman_window, req->taskman_window )) return;
2297 shell_window = new_shell_window;
2298 shell_listview = new_shell_listview;
2299 progman_window = new_progman_window;
2300 taskman_window = new_taskman_window;