ntdll: Add a test for NtReadVirtualMemory.
[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 };
40
41 #define DESKTOP_ATOM  ((atom_t)32769)
42
43 struct winstation
44 {
45     struct object      obj;                /* object header */
46     unsigned int       flags;              /* winstation flags */
47     struct list        entry;              /* entry in global winstation list */
48     struct list        desktops;           /* list of desktops of this winstation */
49     struct clipboard  *clipboard;          /* clipboard information */
50     struct atom_table *atom_table;         /* global atom table */
51 };
52
53 struct desktop
54 {
55     struct object        obj;            /* object header */
56     unsigned int         flags;          /* desktop flags */
57     struct winstation   *winstation;     /* winstation this desktop belongs to */
58     struct list          entry;          /* entry in winstation list of desktops */
59     struct window       *top_window;     /* desktop window for this desktop */
60     struct hook_table   *global_hooks;   /* table of global hooks on this desktop */
61     struct timeout_user *close_timeout;  /* timeout before closing the desktop */
62     unsigned int         users;          /* processes and threads using this desktop */
63 };
64
65 /* user handles functions */
66
67 extern user_handle_t alloc_user_handle( void *ptr, enum user_object type );
68 extern void *get_user_object( user_handle_t handle, enum user_object type );
69 extern void *get_user_object_handle( user_handle_t *handle, enum user_object type );
70 extern user_handle_t get_user_full_handle( user_handle_t handle );
71 extern void *free_user_handle( user_handle_t handle );
72 extern void *next_user_handle( user_handle_t *handle, enum user_object type );
73
74 /* clipboard functions */
75
76 extern void cleanup_clipboard_thread( struct thread *thread );
77
78 /* hook functions */
79
80 extern void remove_thread_hooks( struct thread *thread );
81 extern unsigned int get_active_hooks(void);
82
83 /* queue functions */
84
85 extern void free_msg_queue( struct thread *thread );
86 extern struct hook_table *get_queue_hooks( struct thread *thread );
87 extern void set_queue_hooks( struct thread *thread, struct hook_table *hooks );
88 extern void inc_queue_paint_count( struct thread *thread, int incr );
89 extern void queue_cleanup_window( struct thread *thread, user_handle_t win );
90 extern int init_thread_queue( struct thread *thread );
91 extern int attach_thread_input( struct thread *thread_from, struct thread *thread_to );
92 extern void detach_thread_input( struct thread *thread_from );
93 extern void post_message( user_handle_t win, unsigned int message,
94                           unsigned long wparam, unsigned long lparam );
95 extern void post_win_event( struct thread *thread, unsigned int event,
96                             user_handle_t win, unsigned int object_id,
97                             unsigned int child_id, void *proc,
98                             const WCHAR *module, data_size_t module_size,
99                             user_handle_t handle );
100
101 /* region functions */
102
103 extern struct region *create_empty_region(void);
104 extern struct region *create_region_from_req_data( const void *data, data_size_t size );
105 extern void free_region( struct region *region );
106 extern void set_region_rect( struct region *region, const rectangle_t *rect );
107 extern rectangle_t *get_region_data( const struct region *region, data_size_t max_size,
108                                      data_size_t *total_size );
109 extern rectangle_t *get_region_data_and_free( struct region *region, data_size_t max_size,
110                                               data_size_t *total_size );
111 extern int is_region_empty( const struct region *region );
112 extern void get_region_extents( const struct region *region, rectangle_t *rect );
113 extern void offset_region( struct region *region, int x, int y );
114 extern struct region *copy_region( struct region *dst, const struct region *src );
115 extern struct region *intersect_region( struct region *dst, const struct region *src1,
116                                         const struct region *src2 );
117 extern struct region *subtract_region( struct region *dst, const struct region *src1,
118                                        const struct region *src2 );
119 extern struct region *union_region( struct region *dst, const struct region *src1,
120                                     const struct region *src2 );
121 extern struct region *xor_region( struct region *dst, const struct region *src1,
122                                   const struct region *src2 );
123 extern int point_in_region( struct region *region, int x, int y );
124 extern int rect_in_region( struct region *region, const rectangle_t *rect );
125
126 /* window functions */
127
128 extern struct process *get_top_window_owner( struct desktop *desktop );
129 extern void close_desktop_window( struct desktop *desktop );
130 extern void destroy_window( struct window *win );
131 extern void destroy_thread_windows( struct thread *thread );
132 extern int is_child_window( user_handle_t parent, user_handle_t child );
133 extern int is_top_level_window( user_handle_t window );
134 extern int is_window_visible( user_handle_t window );
135 extern int make_window_active( user_handle_t window );
136 extern struct thread *get_window_thread( user_handle_t handle );
137 extern user_handle_t window_from_point( struct desktop *desktop, int x, int y );
138 extern user_handle_t find_window_to_repaint( user_handle_t parent, struct thread *thread );
139 extern struct window_class *get_window_class( user_handle_t window );
140
141 /* window class functions */
142
143 extern void destroy_process_classes( struct process *process );
144 extern struct window_class *grab_class( struct process *process, atom_t atom,
145                                         void *instance, int *extra_bytes );
146 extern void release_class( struct window_class *class );
147 extern int is_desktop_class( struct window_class *class );
148 extern atom_t get_class_atom( struct window_class *class );
149 extern void *get_class_client_ptr( struct window_class *class );
150
151 /* windows station functions */
152
153 extern struct winstation *get_process_winstation( struct process *process, unsigned int access );
154 extern struct desktop *get_thread_desktop( struct thread *thread, unsigned int access );
155 extern void connect_process_winstation( struct process *process, struct thread *parent );
156 extern void set_process_default_desktop( struct process *process, struct desktop *desktop,
157                                          obj_handle_t handle );
158 extern void close_process_desktop( struct process *process );
159 extern void close_thread_desktop( struct thread *thread );
160
161 #endif  /* __WINE_SERVER_USER_H */