Assorted spelling fixes.
[wine] / server / request.h
1 /*
2  * Wine server requests
3  *
4  * Copyright (C) 1999 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20
21 #ifndef __WINE_SERVER_REQUEST_H
22 #define __WINE_SERVER_REQUEST_H
23
24 #include <assert.h>
25
26 #include "thread.h"
27 #include "wine/server_protocol.h"
28
29 /* max request length */
30 #define MAX_REQUEST_LENGTH  8192
31
32 /* request handler definition */
33 #define DECL_HANDLER(name) \
34     void req_##name( const struct name##_request *req, struct name##_reply *reply )
35
36 /* request functions */
37
38 #ifdef __GNUC__
39 extern void fatal_protocol_error( struct thread *thread,
40                                   const char *err, ... ) __attribute__((format (printf,2,3)));
41 extern void fatal_protocol_perror( struct thread *thread,
42                                    const char *err, ... ) __attribute__((format (printf,2,3)));
43 extern void fatal_error( const char *err, ... )  __attribute__((noreturn,format(printf,1,2)));
44 extern void fatal_perror( const char *err, ... )  __attribute__((noreturn,format(printf,1,2)));
45 #else
46 extern void fatal_protocol_error( struct thread *thread, const char *err, ... );
47 extern void fatal_protocol_perror( struct thread *thread, const char *err, ... );
48 extern void fatal_error( const char *err, ... );
49 extern void fatal_perror( const char *err, ... );
50 #endif
51
52 extern const char *get_config_dir(void);
53 extern void *set_reply_data_size( size_t size );
54 extern int receive_fd( struct process *process );
55 extern int send_client_fd( struct process *process, int fd, obj_handle_t handle );
56 extern void read_request( struct thread *thread );
57 extern void write_reply( struct thread *thread );
58 extern unsigned int get_tick_count(void);
59 extern void open_master_socket(void);
60 extern void close_master_socket(void);
61 extern void lock_master_socket( int locked );
62 extern int wait_for_lock(void);
63 extern int kill_lock_owner( int sig );
64
65 extern void trace_request(void);
66 extern void trace_reply( enum request req, const union generic_reply *reply );
67
68 /* get the request vararg data */
69 inline static const void *get_req_data(void)
70 {
71     return current->req_data;
72 }
73
74 /* get the request vararg size */
75 inline static size_t get_req_data_size(void)
76 {
77     return current->req.request_header.request_size;
78 }
79
80 /* get the request vararg as unicode string */
81 inline static void get_req_unicode_str( struct unicode_str *str )
82 {
83     str->str = get_req_data();
84     str->len = (get_req_data_size() / sizeof(WCHAR)) * sizeof(WCHAR);
85 }
86
87 /* get the reply maximum vararg size */
88 inline static size_t get_reply_max_size(void)
89 {
90     return current->req.request_header.reply_size;
91 }
92
93 /* allocate and fill the reply data */
94 inline static void *set_reply_data( const void *data, size_t size )
95 {
96     void *ret = set_reply_data_size( size );
97     if (ret) memcpy( ret, data, size );
98     return ret;
99 }
100
101 /* set the reply data pointer directly (will be freed by request code) */
102 inline static void set_reply_data_ptr( void *data, size_t size )
103 {
104     assert( size <= get_reply_max_size() );
105     current->reply_size = size;
106     current->reply_data = data;
107 }
108
109
110 /* Everything below this line is generated automatically by tools/make_requests */
111 /* ### make_requests begin ### */
112
113 DECL_HANDLER(new_process);
114 DECL_HANDLER(get_new_process_info);
115 DECL_HANDLER(new_thread);
116 DECL_HANDLER(get_startup_info);
117 DECL_HANDLER(init_process_done);
118 DECL_HANDLER(init_thread);
119 DECL_HANDLER(terminate_process);
120 DECL_HANDLER(terminate_thread);
121 DECL_HANDLER(get_process_info);
122 DECL_HANDLER(set_process_info);
123 DECL_HANDLER(get_thread_info);
124 DECL_HANDLER(set_thread_info);
125 DECL_HANDLER(get_dll_info);
126 DECL_HANDLER(suspend_thread);
127 DECL_HANDLER(resume_thread);
128 DECL_HANDLER(load_dll);
129 DECL_HANDLER(unload_dll);
130 DECL_HANDLER(queue_apc);
131 DECL_HANDLER(get_apc);
132 DECL_HANDLER(close_handle);
133 DECL_HANDLER(set_handle_info);
134 DECL_HANDLER(dup_handle);
135 DECL_HANDLER(open_process);
136 DECL_HANDLER(open_thread);
137 DECL_HANDLER(select);
138 DECL_HANDLER(create_event);
139 DECL_HANDLER(event_op);
140 DECL_HANDLER(open_event);
141 DECL_HANDLER(create_mutex);
142 DECL_HANDLER(release_mutex);
143 DECL_HANDLER(open_mutex);
144 DECL_HANDLER(create_semaphore);
145 DECL_HANDLER(release_semaphore);
146 DECL_HANDLER(open_semaphore);
147 DECL_HANDLER(create_file);
148 DECL_HANDLER(open_file_object);
149 DECL_HANDLER(alloc_file_handle);
150 DECL_HANDLER(get_handle_fd);
151 DECL_HANDLER(set_handle_fd);
152 DECL_HANDLER(flush_file);
153 DECL_HANDLER(lock_file);
154 DECL_HANDLER(unlock_file);
155 DECL_HANDLER(unmount_device);
156 DECL_HANDLER(create_socket);
157 DECL_HANDLER(accept_socket);
158 DECL_HANDLER(set_socket_event);
159 DECL_HANDLER(get_socket_event);
160 DECL_HANDLER(enable_socket_event);
161 DECL_HANDLER(set_socket_deferred);
162 DECL_HANDLER(alloc_console);
163 DECL_HANDLER(free_console);
164 DECL_HANDLER(get_console_renderer_events);
165 DECL_HANDLER(open_console);
166 DECL_HANDLER(get_console_wait_event);
167 DECL_HANDLER(get_console_mode);
168 DECL_HANDLER(set_console_mode);
169 DECL_HANDLER(set_console_input_info);
170 DECL_HANDLER(get_console_input_info);
171 DECL_HANDLER(append_console_input_history);
172 DECL_HANDLER(get_console_input_history);
173 DECL_HANDLER(create_console_output);
174 DECL_HANDLER(set_console_output_info);
175 DECL_HANDLER(get_console_output_info);
176 DECL_HANDLER(write_console_input);
177 DECL_HANDLER(read_console_input);
178 DECL_HANDLER(write_console_output);
179 DECL_HANDLER(fill_console_output);
180 DECL_HANDLER(read_console_output);
181 DECL_HANDLER(move_console_output);
182 DECL_HANDLER(send_console_signal);
183 DECL_HANDLER(read_directory_changes);
184 DECL_HANDLER(read_change);
185 DECL_HANDLER(create_mapping);
186 DECL_HANDLER(open_mapping);
187 DECL_HANDLER(get_mapping_info);
188 DECL_HANDLER(create_snapshot);
189 DECL_HANDLER(next_process);
190 DECL_HANDLER(next_thread);
191 DECL_HANDLER(next_module);
192 DECL_HANDLER(wait_debug_event);
193 DECL_HANDLER(queue_exception_event);
194 DECL_HANDLER(get_exception_status);
195 DECL_HANDLER(output_debug_string);
196 DECL_HANDLER(continue_debug_event);
197 DECL_HANDLER(debug_process);
198 DECL_HANDLER(debug_break);
199 DECL_HANDLER(set_debugger_kill_on_exit);
200 DECL_HANDLER(read_process_memory);
201 DECL_HANDLER(write_process_memory);
202 DECL_HANDLER(create_key);
203 DECL_HANDLER(open_key);
204 DECL_HANDLER(delete_key);
205 DECL_HANDLER(flush_key);
206 DECL_HANDLER(enum_key);
207 DECL_HANDLER(set_key_value);
208 DECL_HANDLER(get_key_value);
209 DECL_HANDLER(enum_key_value);
210 DECL_HANDLER(delete_key_value);
211 DECL_HANDLER(load_registry);
212 DECL_HANDLER(unload_registry);
213 DECL_HANDLER(save_registry);
214 DECL_HANDLER(set_registry_notification);
215 DECL_HANDLER(create_timer);
216 DECL_HANDLER(open_timer);
217 DECL_HANDLER(set_timer);
218 DECL_HANDLER(cancel_timer);
219 DECL_HANDLER(get_timer_info);
220 DECL_HANDLER(get_thread_context);
221 DECL_HANDLER(set_thread_context);
222 DECL_HANDLER(get_selector_entry);
223 DECL_HANDLER(add_atom);
224 DECL_HANDLER(delete_atom);
225 DECL_HANDLER(find_atom);
226 DECL_HANDLER(get_atom_information);
227 DECL_HANDLER(set_atom_information);
228 DECL_HANDLER(empty_atom_table);
229 DECL_HANDLER(init_atom_table);
230 DECL_HANDLER(get_msg_queue);
231 DECL_HANDLER(set_queue_mask);
232 DECL_HANDLER(get_queue_status);
233 DECL_HANDLER(wait_input_idle);
234 DECL_HANDLER(send_message);
235 DECL_HANDLER(post_quit_message);
236 DECL_HANDLER(get_message);
237 DECL_HANDLER(reply_message);
238 DECL_HANDLER(accept_hardware_message);
239 DECL_HANDLER(get_message_reply);
240 DECL_HANDLER(set_win_timer);
241 DECL_HANDLER(kill_win_timer);
242 DECL_HANDLER(get_serial_info);
243 DECL_HANDLER(set_serial_info);
244 DECL_HANDLER(register_async);
245 DECL_HANDLER(cancel_async);
246 DECL_HANDLER(create_named_pipe);
247 DECL_HANDLER(open_named_pipe);
248 DECL_HANDLER(connect_named_pipe);
249 DECL_HANDLER(wait_named_pipe);
250 DECL_HANDLER(disconnect_named_pipe);
251 DECL_HANDLER(get_named_pipe_info);
252 DECL_HANDLER(create_window);
253 DECL_HANDLER(destroy_window);
254 DECL_HANDLER(get_desktop_window);
255 DECL_HANDLER(set_window_owner);
256 DECL_HANDLER(get_window_info);
257 DECL_HANDLER(set_window_info);
258 DECL_HANDLER(set_parent);
259 DECL_HANDLER(get_window_parents);
260 DECL_HANDLER(get_window_children);
261 DECL_HANDLER(get_window_children_from_point);
262 DECL_HANDLER(get_window_tree);
263 DECL_HANDLER(set_window_pos);
264 DECL_HANDLER(get_window_rectangles);
265 DECL_HANDLER(get_window_text);
266 DECL_HANDLER(set_window_text);
267 DECL_HANDLER(get_windows_offset);
268 DECL_HANDLER(get_visible_region);
269 DECL_HANDLER(get_window_region);
270 DECL_HANDLER(set_window_region);
271 DECL_HANDLER(get_update_region);
272 DECL_HANDLER(update_window_zorder);
273 DECL_HANDLER(redraw_window);
274 DECL_HANDLER(set_window_property);
275 DECL_HANDLER(remove_window_property);
276 DECL_HANDLER(get_window_property);
277 DECL_HANDLER(get_window_properties);
278 DECL_HANDLER(create_winstation);
279 DECL_HANDLER(open_winstation);
280 DECL_HANDLER(close_winstation);
281 DECL_HANDLER(get_process_winstation);
282 DECL_HANDLER(set_process_winstation);
283 DECL_HANDLER(create_desktop);
284 DECL_HANDLER(open_desktop);
285 DECL_HANDLER(close_desktop);
286 DECL_HANDLER(get_thread_desktop);
287 DECL_HANDLER(set_thread_desktop);
288 DECL_HANDLER(set_user_object_info);
289 DECL_HANDLER(attach_thread_input);
290 DECL_HANDLER(get_thread_input);
291 DECL_HANDLER(get_last_input_time);
292 DECL_HANDLER(get_key_state);
293 DECL_HANDLER(set_key_state);
294 DECL_HANDLER(set_foreground_window);
295 DECL_HANDLER(set_focus_window);
296 DECL_HANDLER(set_active_window);
297 DECL_HANDLER(set_capture_window);
298 DECL_HANDLER(set_caret_window);
299 DECL_HANDLER(set_caret_info);
300 DECL_HANDLER(set_hook);
301 DECL_HANDLER(remove_hook);
302 DECL_HANDLER(start_hook_chain);
303 DECL_HANDLER(finish_hook_chain);
304 DECL_HANDLER(get_next_hook);
305 DECL_HANDLER(create_class);
306 DECL_HANDLER(destroy_class);
307 DECL_HANDLER(set_class_info);
308 DECL_HANDLER(set_clipboard_info);
309 DECL_HANDLER(open_token);
310 DECL_HANDLER(set_global_windows);
311 DECL_HANDLER(adjust_token_privileges);
312 DECL_HANDLER(get_token_privileges);
313 DECL_HANDLER(check_token_privileges);
314 DECL_HANDLER(duplicate_token);
315 DECL_HANDLER(access_check);
316 DECL_HANDLER(get_token_user);
317 DECL_HANDLER(create_mailslot);
318 DECL_HANDLER(open_mailslot);
319 DECL_HANDLER(set_mailslot_info);
320 DECL_HANDLER(create_directory);
321 DECL_HANDLER(open_directory);
322 DECL_HANDLER(create_symlink);
323 DECL_HANDLER(open_symlink);
324 DECL_HANDLER(query_symlink);
325
326 #ifdef WANT_REQUEST_HANDLERS
327
328 typedef void (*req_handler)( const void *req, void *reply );
329 static const req_handler req_handlers[REQ_NB_REQUESTS] =
330 {
331     (req_handler)req_new_process,
332     (req_handler)req_get_new_process_info,
333     (req_handler)req_new_thread,
334     (req_handler)req_get_startup_info,
335     (req_handler)req_init_process_done,
336     (req_handler)req_init_thread,
337     (req_handler)req_terminate_process,
338     (req_handler)req_terminate_thread,
339     (req_handler)req_get_process_info,
340     (req_handler)req_set_process_info,
341     (req_handler)req_get_thread_info,
342     (req_handler)req_set_thread_info,
343     (req_handler)req_get_dll_info,
344     (req_handler)req_suspend_thread,
345     (req_handler)req_resume_thread,
346     (req_handler)req_load_dll,
347     (req_handler)req_unload_dll,
348     (req_handler)req_queue_apc,
349     (req_handler)req_get_apc,
350     (req_handler)req_close_handle,
351     (req_handler)req_set_handle_info,
352     (req_handler)req_dup_handle,
353     (req_handler)req_open_process,
354     (req_handler)req_open_thread,
355     (req_handler)req_select,
356     (req_handler)req_create_event,
357     (req_handler)req_event_op,
358     (req_handler)req_open_event,
359     (req_handler)req_create_mutex,
360     (req_handler)req_release_mutex,
361     (req_handler)req_open_mutex,
362     (req_handler)req_create_semaphore,
363     (req_handler)req_release_semaphore,
364     (req_handler)req_open_semaphore,
365     (req_handler)req_create_file,
366     (req_handler)req_open_file_object,
367     (req_handler)req_alloc_file_handle,
368     (req_handler)req_get_handle_fd,
369     (req_handler)req_set_handle_fd,
370     (req_handler)req_flush_file,
371     (req_handler)req_lock_file,
372     (req_handler)req_unlock_file,
373     (req_handler)req_unmount_device,
374     (req_handler)req_create_socket,
375     (req_handler)req_accept_socket,
376     (req_handler)req_set_socket_event,
377     (req_handler)req_get_socket_event,
378     (req_handler)req_enable_socket_event,
379     (req_handler)req_set_socket_deferred,
380     (req_handler)req_alloc_console,
381     (req_handler)req_free_console,
382     (req_handler)req_get_console_renderer_events,
383     (req_handler)req_open_console,
384     (req_handler)req_get_console_wait_event,
385     (req_handler)req_get_console_mode,
386     (req_handler)req_set_console_mode,
387     (req_handler)req_set_console_input_info,
388     (req_handler)req_get_console_input_info,
389     (req_handler)req_append_console_input_history,
390     (req_handler)req_get_console_input_history,
391     (req_handler)req_create_console_output,
392     (req_handler)req_set_console_output_info,
393     (req_handler)req_get_console_output_info,
394     (req_handler)req_write_console_input,
395     (req_handler)req_read_console_input,
396     (req_handler)req_write_console_output,
397     (req_handler)req_fill_console_output,
398     (req_handler)req_read_console_output,
399     (req_handler)req_move_console_output,
400     (req_handler)req_send_console_signal,
401     (req_handler)req_read_directory_changes,
402     (req_handler)req_read_change,
403     (req_handler)req_create_mapping,
404     (req_handler)req_open_mapping,
405     (req_handler)req_get_mapping_info,
406     (req_handler)req_create_snapshot,
407     (req_handler)req_next_process,
408     (req_handler)req_next_thread,
409     (req_handler)req_next_module,
410     (req_handler)req_wait_debug_event,
411     (req_handler)req_queue_exception_event,
412     (req_handler)req_get_exception_status,
413     (req_handler)req_output_debug_string,
414     (req_handler)req_continue_debug_event,
415     (req_handler)req_debug_process,
416     (req_handler)req_debug_break,
417     (req_handler)req_set_debugger_kill_on_exit,
418     (req_handler)req_read_process_memory,
419     (req_handler)req_write_process_memory,
420     (req_handler)req_create_key,
421     (req_handler)req_open_key,
422     (req_handler)req_delete_key,
423     (req_handler)req_flush_key,
424     (req_handler)req_enum_key,
425     (req_handler)req_set_key_value,
426     (req_handler)req_get_key_value,
427     (req_handler)req_enum_key_value,
428     (req_handler)req_delete_key_value,
429     (req_handler)req_load_registry,
430     (req_handler)req_unload_registry,
431     (req_handler)req_save_registry,
432     (req_handler)req_set_registry_notification,
433     (req_handler)req_create_timer,
434     (req_handler)req_open_timer,
435     (req_handler)req_set_timer,
436     (req_handler)req_cancel_timer,
437     (req_handler)req_get_timer_info,
438     (req_handler)req_get_thread_context,
439     (req_handler)req_set_thread_context,
440     (req_handler)req_get_selector_entry,
441     (req_handler)req_add_atom,
442     (req_handler)req_delete_atom,
443     (req_handler)req_find_atom,
444     (req_handler)req_get_atom_information,
445     (req_handler)req_set_atom_information,
446     (req_handler)req_empty_atom_table,
447     (req_handler)req_init_atom_table,
448     (req_handler)req_get_msg_queue,
449     (req_handler)req_set_queue_mask,
450     (req_handler)req_get_queue_status,
451     (req_handler)req_wait_input_idle,
452     (req_handler)req_send_message,
453     (req_handler)req_post_quit_message,
454     (req_handler)req_get_message,
455     (req_handler)req_reply_message,
456     (req_handler)req_accept_hardware_message,
457     (req_handler)req_get_message_reply,
458     (req_handler)req_set_win_timer,
459     (req_handler)req_kill_win_timer,
460     (req_handler)req_get_serial_info,
461     (req_handler)req_set_serial_info,
462     (req_handler)req_register_async,
463     (req_handler)req_cancel_async,
464     (req_handler)req_create_named_pipe,
465     (req_handler)req_open_named_pipe,
466     (req_handler)req_connect_named_pipe,
467     (req_handler)req_wait_named_pipe,
468     (req_handler)req_disconnect_named_pipe,
469     (req_handler)req_get_named_pipe_info,
470     (req_handler)req_create_window,
471     (req_handler)req_destroy_window,
472     (req_handler)req_get_desktop_window,
473     (req_handler)req_set_window_owner,
474     (req_handler)req_get_window_info,
475     (req_handler)req_set_window_info,
476     (req_handler)req_set_parent,
477     (req_handler)req_get_window_parents,
478     (req_handler)req_get_window_children,
479     (req_handler)req_get_window_children_from_point,
480     (req_handler)req_get_window_tree,
481     (req_handler)req_set_window_pos,
482     (req_handler)req_get_window_rectangles,
483     (req_handler)req_get_window_text,
484     (req_handler)req_set_window_text,
485     (req_handler)req_get_windows_offset,
486     (req_handler)req_get_visible_region,
487     (req_handler)req_get_window_region,
488     (req_handler)req_set_window_region,
489     (req_handler)req_get_update_region,
490     (req_handler)req_update_window_zorder,
491     (req_handler)req_redraw_window,
492     (req_handler)req_set_window_property,
493     (req_handler)req_remove_window_property,
494     (req_handler)req_get_window_property,
495     (req_handler)req_get_window_properties,
496     (req_handler)req_create_winstation,
497     (req_handler)req_open_winstation,
498     (req_handler)req_close_winstation,
499     (req_handler)req_get_process_winstation,
500     (req_handler)req_set_process_winstation,
501     (req_handler)req_create_desktop,
502     (req_handler)req_open_desktop,
503     (req_handler)req_close_desktop,
504     (req_handler)req_get_thread_desktop,
505     (req_handler)req_set_thread_desktop,
506     (req_handler)req_set_user_object_info,
507     (req_handler)req_attach_thread_input,
508     (req_handler)req_get_thread_input,
509     (req_handler)req_get_last_input_time,
510     (req_handler)req_get_key_state,
511     (req_handler)req_set_key_state,
512     (req_handler)req_set_foreground_window,
513     (req_handler)req_set_focus_window,
514     (req_handler)req_set_active_window,
515     (req_handler)req_set_capture_window,
516     (req_handler)req_set_caret_window,
517     (req_handler)req_set_caret_info,
518     (req_handler)req_set_hook,
519     (req_handler)req_remove_hook,
520     (req_handler)req_start_hook_chain,
521     (req_handler)req_finish_hook_chain,
522     (req_handler)req_get_next_hook,
523     (req_handler)req_create_class,
524     (req_handler)req_destroy_class,
525     (req_handler)req_set_class_info,
526     (req_handler)req_set_clipboard_info,
527     (req_handler)req_open_token,
528     (req_handler)req_set_global_windows,
529     (req_handler)req_adjust_token_privileges,
530     (req_handler)req_get_token_privileges,
531     (req_handler)req_check_token_privileges,
532     (req_handler)req_duplicate_token,
533     (req_handler)req_access_check,
534     (req_handler)req_get_token_user,
535     (req_handler)req_create_mailslot,
536     (req_handler)req_open_mailslot,
537     (req_handler)req_set_mailslot_info,
538     (req_handler)req_create_directory,
539     (req_handler)req_open_directory,
540     (req_handler)req_create_symlink,
541     (req_handler)req_open_symlink,
542     (req_handler)req_query_symlink,
543 };
544 #endif  /* WANT_REQUEST_HANDLERS */
545
546 /* ### make_requests end ### */
547 /* Everything above this line is generated automatically by tools/make_requests */
548
549 #endif  /* __WINE_SERVER_REQUEST_H */