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