server: Queue a WM_MOUSEMOVE message when the cursor position is explicitly changed.
[wine] / server / user.h
1 /*
2  * Wine server USER definitions
3  *
4  * Copyright (C) 2001 Alexandre Julliard
5  *
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.
10  *
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.
15  *
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
19  */
20
21 #ifndef __WINE_SERVER_USER_H
22 #define __WINE_SERVER_USER_H
23
24 #include "wine/server_protocol.h"
25
26 struct thread;
27 struct region;
28 struct window;
29 struct msg_queue;
30 struct hook_table;
31 struct window_class;
32 struct atom_table;
33 struct clipboard;
34
35 enum user_object
36 {
37     USER_WINDOW = 1,
38     USER_HOOK,
39     USER_CLIENT  /* arbitrary client handle */
40 };
41
42 #define DESKTOP_ATOM  ((atom_t)32769)
43
44 struct winstation
45 {
46     struct object      obj;                /* object header */
47     unsigned int       flags;              /* winstation flags */
48     struct list        entry;              /* entry in global winstation list */
49     struct list        desktops;           /* list of desktops of this winstation */
50     struct clipboard  *clipboard;          /* clipboard information */
51     struct atom_table *atom_table;         /* global atom table */
52 };
53
54 struct global_cursor
55 {
56     int                  x;                /* cursor position */
57     int                  y;
58     rectangle_t          clip;             /* cursor clip rectangle */
59     unsigned int         clip_msg;         /* message to post for cursor clip changes */
60     unsigned int         last_change;      /* time of last position change */
61 };
62
63 struct desktop
64 {
65     struct object        obj;              /* object header */
66     unsigned int         flags;            /* desktop flags */
67     struct winstation   *winstation;       /* winstation this desktop belongs to */
68     struct list          entry;            /* entry in winstation list of desktops */
69     struct window       *top_window;       /* desktop window for this desktop */
70     struct window       *msg_window;       /* HWND_MESSAGE top window */
71     struct hook_table   *global_hooks;     /* table of global hooks on this desktop */
72     struct timeout_user *close_timeout;    /* timeout before closing the desktop */
73     struct thread_input *foreground_input; /* thread input of foreground thread */
74     unsigned int         users;            /* processes and threads using this desktop */
75     struct global_cursor cursor;           /* global cursor information */
76     unsigned char        keystate[256];    /* asynchronous key state */
77 };
78
79 /* user handles functions */
80
81 extern user_handle_t alloc_user_handle( void *ptr, enum user_object type );
82 extern void *get_user_object( user_handle_t handle, enum user_object type );
83 extern void *get_user_object_handle( user_handle_t *handle, enum user_object type );
84 extern user_handle_t get_user_full_handle( user_handle_t handle );
85 extern void *free_user_handle( user_handle_t handle );
86 extern void *next_user_handle( user_handle_t *handle, enum user_object type );
87 extern void free_process_user_handles( struct process *process );
88
89 /* clipboard functions */
90
91 extern void cleanup_clipboard_thread( struct thread *thread );
92
93 /* hook functions */
94
95 extern void remove_thread_hooks( struct thread *thread );
96 extern unsigned int get_active_hooks(void);
97 extern struct thread *get_first_global_hook( int id );
98
99 /* queue functions */
100
101 extern void free_msg_queue( struct thread *thread );
102 extern struct hook_table *get_queue_hooks( struct thread *thread );
103 extern void set_queue_hooks( struct thread *thread, struct hook_table *hooks );
104 extern void inc_queue_paint_count( struct thread *thread, int incr );
105 extern void queue_cleanup_window( struct thread *thread, user_handle_t win );
106 extern int init_thread_queue( struct thread *thread );
107 extern int attach_thread_input( struct thread *thread_from, struct thread *thread_to );
108 extern void detach_thread_input( struct thread *thread_from );
109 extern void post_message( user_handle_t win, unsigned int message,
110                           lparam_t wparam, lparam_t lparam );
111 extern void post_win_event( struct thread *thread, unsigned int event,
112                             user_handle_t win, unsigned int object_id,
113                             unsigned int child_id, client_ptr_t proc,
114                             const WCHAR *module, data_size_t module_size,
115                             user_handle_t handle );
116
117 /* region functions */
118
119 extern struct region *create_empty_region(void);
120 extern struct region *create_region_from_req_data( const void *data, data_size_t size );
121 extern void free_region( struct region *region );
122 extern void set_region_rect( struct region *region, const rectangle_t *rect );
123 extern rectangle_t *get_region_data( const struct region *region, data_size_t max_size,
124                                      data_size_t *total_size );
125 extern rectangle_t *get_region_data_and_free( struct region *region, data_size_t max_size,
126                                               data_size_t *total_size );
127 extern int is_region_empty( const struct region *region );
128 extern void get_region_extents( const struct region *region, rectangle_t *rect );
129 extern void offset_region( struct region *region, int x, int y );
130 extern void mirror_region( const rectangle_t *client_rect, struct region *region );
131 extern struct region *copy_region( struct region *dst, const struct region *src );
132 extern struct region *intersect_region( struct region *dst, const struct region *src1,
133                                         const struct region *src2 );
134 extern struct region *subtract_region( struct region *dst, const struct region *src1,
135                                        const struct region *src2 );
136 extern struct region *union_region( struct region *dst, const struct region *src1,
137                                     const struct region *src2 );
138 extern struct region *xor_region( struct region *dst, const struct region *src1,
139                                   const struct region *src2 );
140 extern int point_in_region( struct region *region, int x, int y );
141 extern int rect_in_region( struct region *region, const rectangle_t *rect );
142
143 /* window functions */
144
145 extern struct process *get_top_window_owner( struct desktop *desktop );
146 extern void get_top_window_rectangle( struct desktop *desktop, rectangle_t *rect );
147 extern void post_desktop_message( struct desktop *desktop, unsigned int message,
148                                   lparam_t wparam, lparam_t lparam );
149 extern void destroy_window( struct window *win );
150 extern void destroy_thread_windows( struct thread *thread );
151 extern int is_child_window( user_handle_t parent, user_handle_t child );
152 extern int is_top_level_window( user_handle_t window );
153 extern int is_window_visible( user_handle_t window );
154 extern int is_window_transparent( user_handle_t window );
155 extern int make_window_active( user_handle_t window );
156 extern struct thread *get_window_thread( user_handle_t handle );
157 extern user_handle_t window_from_point( struct desktop *desktop, int x, int y );
158 extern user_handle_t find_window_to_repaint( user_handle_t parent, struct thread *thread );
159 extern struct window_class *get_window_class( user_handle_t window );
160
161 /* window class functions */
162
163 extern void destroy_process_classes( struct process *process );
164 extern struct window_class *grab_class( struct process *process, atom_t atom,
165                                         mod_handle_t instance, int *extra_bytes );
166 extern void release_class( struct window_class *class );
167 extern int is_desktop_class( struct window_class *class );
168 extern int is_hwnd_message_class( struct window_class *class );
169 extern atom_t get_class_atom( struct window_class *class );
170 extern client_ptr_t get_class_client_ptr( struct window_class *class );
171
172 /* windows station functions */
173
174 extern struct desktop *get_desktop_obj( struct process *process, obj_handle_t handle, unsigned int access );
175 extern struct winstation *get_process_winstation( struct process *process, unsigned int access );
176 extern struct desktop *get_thread_desktop( struct thread *thread, unsigned int access );
177 extern void connect_process_winstation( struct process *process, struct thread *parent );
178 extern void set_process_default_desktop( struct process *process, struct desktop *desktop,
179                                          obj_handle_t handle );
180 extern void close_process_desktop( struct process *process );
181 extern void close_thread_desktop( struct thread *thread );
182
183 /* mirror a rectangle respective to the window client area */
184 static inline void mirror_rect( const rectangle_t *client_rect, rectangle_t *rect )
185 {
186     int width = client_rect->right - client_rect->left;
187     int tmp = rect->left;
188     rect->left = width - rect->right;
189     rect->right = width - tmp;
190 }
191
192 /* compute the intersection of two rectangles; return 0 if the result is empty */
193 static inline int intersect_rect( rectangle_t *dst, const rectangle_t *src1, const rectangle_t *src2 )
194 {
195     dst->left   = max( src1->left, src2->left );
196     dst->top    = max( src1->top, src2->top );
197     dst->right  = min( src1->right, src2->right );
198     dst->bottom = min( src1->bottom, src2->bottom );
199     return (dst->left < dst->right && dst->top < dst->bottom);
200 }
201
202 #endif  /* __WINE_SERVER_USER_H */