Remove two ancient FAQ entries that did more harm than good.
[wine.git] / server / request.h
blob2b779196966f4a8848aea200005c9ead85c3e546
1 /*
2 * Wine server requests
4 * Copyright (C) 1999 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #ifndef __WINE_SERVER_REQUEST_H
22 #define __WINE_SERVER_REQUEST_H
24 #include <assert.h>
26 #include "thread.h"
27 #include "wine/server_protocol.h"
29 /* max request length */
30 #define MAX_REQUEST_LENGTH 8192
32 /* request handler definition */
33 #define DECL_HANDLER(name) \
34 void req_##name( const struct name##_request *req, struct name##_reply *reply )
36 /* request functions */
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
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 );
65 extern void trace_request(void);
66 extern void trace_reply( enum request req, const union generic_reply *reply );
68 /* get the request vararg data */
69 inline static const void *get_req_data(void)
71 return current->req_data;
74 /* get the request vararg size */
75 inline static size_t get_req_data_size(void)
77 return current->req.request_header.request_size;
80 /* get the reply maximum vararg size */
81 inline static size_t get_reply_max_size(void)
83 return current->req.request_header.reply_size;
86 /* allocate and fill the reply data */
87 inline static void *set_reply_data( const void *data, size_t size )
89 void *ret = set_reply_data_size( size );
90 if (ret) memcpy( ret, data, size );
91 return ret;
94 /* set the reply data pointer directly (will be freed by request code) */
95 inline static void set_reply_data_ptr( void *data, size_t size )
97 assert( size <= get_reply_max_size() );
98 current->reply_size = size;
99 current->reply_data = data;
103 /* Everything below this line is generated automatically by tools/make_requests */
104 /* ### make_requests begin ### */
106 DECL_HANDLER(new_process);
107 DECL_HANDLER(get_new_process_info);
108 DECL_HANDLER(new_thread);
109 DECL_HANDLER(boot_done);
110 DECL_HANDLER(init_process);
111 DECL_HANDLER(get_startup_info);
112 DECL_HANDLER(init_process_done);
113 DECL_HANDLER(init_thread);
114 DECL_HANDLER(terminate_process);
115 DECL_HANDLER(terminate_thread);
116 DECL_HANDLER(get_process_info);
117 DECL_HANDLER(set_process_info);
118 DECL_HANDLER(get_thread_info);
119 DECL_HANDLER(set_thread_info);
120 DECL_HANDLER(get_dll_info);
121 DECL_HANDLER(suspend_thread);
122 DECL_HANDLER(resume_thread);
123 DECL_HANDLER(load_dll);
124 DECL_HANDLER(unload_dll);
125 DECL_HANDLER(queue_apc);
126 DECL_HANDLER(get_apc);
127 DECL_HANDLER(close_handle);
128 DECL_HANDLER(set_handle_info);
129 DECL_HANDLER(dup_handle);
130 DECL_HANDLER(open_process);
131 DECL_HANDLER(open_thread);
132 DECL_HANDLER(select);
133 DECL_HANDLER(create_event);
134 DECL_HANDLER(event_op);
135 DECL_HANDLER(open_event);
136 DECL_HANDLER(create_mutex);
137 DECL_HANDLER(release_mutex);
138 DECL_HANDLER(open_mutex);
139 DECL_HANDLER(create_semaphore);
140 DECL_HANDLER(release_semaphore);
141 DECL_HANDLER(open_semaphore);
142 DECL_HANDLER(create_file);
143 DECL_HANDLER(alloc_file_handle);
144 DECL_HANDLER(get_handle_fd);
145 DECL_HANDLER(flush_file);
146 DECL_HANDLER(lock_file);
147 DECL_HANDLER(unlock_file);
148 DECL_HANDLER(create_socket);
149 DECL_HANDLER(accept_socket);
150 DECL_HANDLER(set_socket_event);
151 DECL_HANDLER(get_socket_event);
152 DECL_HANDLER(enable_socket_event);
153 DECL_HANDLER(set_socket_deferred);
154 DECL_HANDLER(alloc_console);
155 DECL_HANDLER(free_console);
156 DECL_HANDLER(get_console_renderer_events);
157 DECL_HANDLER(open_console);
158 DECL_HANDLER(get_console_wait_event);
159 DECL_HANDLER(get_console_mode);
160 DECL_HANDLER(set_console_mode);
161 DECL_HANDLER(set_console_input_info);
162 DECL_HANDLER(get_console_input_info);
163 DECL_HANDLER(append_console_input_history);
164 DECL_HANDLER(get_console_input_history);
165 DECL_HANDLER(create_console_output);
166 DECL_HANDLER(set_console_output_info);
167 DECL_HANDLER(get_console_output_info);
168 DECL_HANDLER(write_console_input);
169 DECL_HANDLER(read_console_input);
170 DECL_HANDLER(write_console_output);
171 DECL_HANDLER(fill_console_output);
172 DECL_HANDLER(read_console_output);
173 DECL_HANDLER(move_console_output);
174 DECL_HANDLER(send_console_signal);
175 DECL_HANDLER(create_change_notification);
176 DECL_HANDLER(next_change_notification);
177 DECL_HANDLER(create_mapping);
178 DECL_HANDLER(open_mapping);
179 DECL_HANDLER(get_mapping_info);
180 DECL_HANDLER(create_snapshot);
181 DECL_HANDLER(next_process);
182 DECL_HANDLER(next_thread);
183 DECL_HANDLER(next_module);
184 DECL_HANDLER(wait_debug_event);
185 DECL_HANDLER(queue_exception_event);
186 DECL_HANDLER(get_exception_status);
187 DECL_HANDLER(output_debug_string);
188 DECL_HANDLER(continue_debug_event);
189 DECL_HANDLER(debug_process);
190 DECL_HANDLER(debug_break);
191 DECL_HANDLER(set_debugger_kill_on_exit);
192 DECL_HANDLER(read_process_memory);
193 DECL_HANDLER(write_process_memory);
194 DECL_HANDLER(create_key);
195 DECL_HANDLER(open_key);
196 DECL_HANDLER(delete_key);
197 DECL_HANDLER(flush_key);
198 DECL_HANDLER(enum_key);
199 DECL_HANDLER(set_key_value);
200 DECL_HANDLER(get_key_value);
201 DECL_HANDLER(enum_key_value);
202 DECL_HANDLER(delete_key_value);
203 DECL_HANDLER(load_registry);
204 DECL_HANDLER(unload_registry);
205 DECL_HANDLER(save_registry);
206 DECL_HANDLER(load_user_registries);
207 DECL_HANDLER(set_registry_notification);
208 DECL_HANDLER(create_timer);
209 DECL_HANDLER(open_timer);
210 DECL_HANDLER(set_timer);
211 DECL_HANDLER(cancel_timer);
212 DECL_HANDLER(get_timer_info);
213 DECL_HANDLER(get_thread_context);
214 DECL_HANDLER(set_thread_context);
215 DECL_HANDLER(get_selector_entry);
216 DECL_HANDLER(add_atom);
217 DECL_HANDLER(delete_atom);
218 DECL_HANDLER(find_atom);
219 DECL_HANDLER(get_atom_name);
220 DECL_HANDLER(init_atom_table);
221 DECL_HANDLER(get_msg_queue);
222 DECL_HANDLER(set_queue_mask);
223 DECL_HANDLER(get_queue_status);
224 DECL_HANDLER(wait_input_idle);
225 DECL_HANDLER(send_message);
226 DECL_HANDLER(get_message);
227 DECL_HANDLER(reply_message);
228 DECL_HANDLER(get_message_reply);
229 DECL_HANDLER(set_win_timer);
230 DECL_HANDLER(kill_win_timer);
231 DECL_HANDLER(get_serial_info);
232 DECL_HANDLER(set_serial_info);
233 DECL_HANDLER(register_async);
234 DECL_HANDLER(cancel_async);
235 DECL_HANDLER(create_named_pipe);
236 DECL_HANDLER(open_named_pipe);
237 DECL_HANDLER(connect_named_pipe);
238 DECL_HANDLER(wait_named_pipe);
239 DECL_HANDLER(disconnect_named_pipe);
240 DECL_HANDLER(get_named_pipe_info);
241 DECL_HANDLER(create_window);
242 DECL_HANDLER(link_window);
243 DECL_HANDLER(destroy_window);
244 DECL_HANDLER(set_window_owner);
245 DECL_HANDLER(get_window_info);
246 DECL_HANDLER(set_window_info);
247 DECL_HANDLER(get_window_parents);
248 DECL_HANDLER(get_window_children);
249 DECL_HANDLER(get_window_children_from_point);
250 DECL_HANDLER(get_window_tree);
251 DECL_HANDLER(set_window_pos);
252 DECL_HANDLER(get_window_rectangles);
253 DECL_HANDLER(get_window_text);
254 DECL_HANDLER(set_window_text);
255 DECL_HANDLER(get_windows_offset);
256 DECL_HANDLER(get_visible_region);
257 DECL_HANDLER(get_window_region);
258 DECL_HANDLER(set_window_region);
259 DECL_HANDLER(get_update_region);
260 DECL_HANDLER(redraw_window);
261 DECL_HANDLER(set_window_property);
262 DECL_HANDLER(remove_window_property);
263 DECL_HANDLER(get_window_property);
264 DECL_HANDLER(get_window_properties);
265 DECL_HANDLER(attach_thread_input);
266 DECL_HANDLER(get_thread_input);
267 DECL_HANDLER(get_key_state);
268 DECL_HANDLER(set_key_state);
269 DECL_HANDLER(set_foreground_window);
270 DECL_HANDLER(set_focus_window);
271 DECL_HANDLER(set_active_window);
272 DECL_HANDLER(set_capture_window);
273 DECL_HANDLER(set_caret_window);
274 DECL_HANDLER(set_caret_info);
275 DECL_HANDLER(set_hook);
276 DECL_HANDLER(remove_hook);
277 DECL_HANDLER(start_hook_chain);
278 DECL_HANDLER(finish_hook_chain);
279 DECL_HANDLER(get_next_hook);
280 DECL_HANDLER(create_class);
281 DECL_HANDLER(destroy_class);
282 DECL_HANDLER(set_class_info);
283 DECL_HANDLER(set_clipboard_info);
284 DECL_HANDLER(open_token);
285 DECL_HANDLER(set_global_windows);
287 #ifdef WANT_REQUEST_HANDLERS
289 typedef void (*req_handler)( const void *req, void *reply );
290 static const req_handler req_handlers[REQ_NB_REQUESTS] =
292 (req_handler)req_new_process,
293 (req_handler)req_get_new_process_info,
294 (req_handler)req_new_thread,
295 (req_handler)req_boot_done,
296 (req_handler)req_init_process,
297 (req_handler)req_get_startup_info,
298 (req_handler)req_init_process_done,
299 (req_handler)req_init_thread,
300 (req_handler)req_terminate_process,
301 (req_handler)req_terminate_thread,
302 (req_handler)req_get_process_info,
303 (req_handler)req_set_process_info,
304 (req_handler)req_get_thread_info,
305 (req_handler)req_set_thread_info,
306 (req_handler)req_get_dll_info,
307 (req_handler)req_suspend_thread,
308 (req_handler)req_resume_thread,
309 (req_handler)req_load_dll,
310 (req_handler)req_unload_dll,
311 (req_handler)req_queue_apc,
312 (req_handler)req_get_apc,
313 (req_handler)req_close_handle,
314 (req_handler)req_set_handle_info,
315 (req_handler)req_dup_handle,
316 (req_handler)req_open_process,
317 (req_handler)req_open_thread,
318 (req_handler)req_select,
319 (req_handler)req_create_event,
320 (req_handler)req_event_op,
321 (req_handler)req_open_event,
322 (req_handler)req_create_mutex,
323 (req_handler)req_release_mutex,
324 (req_handler)req_open_mutex,
325 (req_handler)req_create_semaphore,
326 (req_handler)req_release_semaphore,
327 (req_handler)req_open_semaphore,
328 (req_handler)req_create_file,
329 (req_handler)req_alloc_file_handle,
330 (req_handler)req_get_handle_fd,
331 (req_handler)req_flush_file,
332 (req_handler)req_lock_file,
333 (req_handler)req_unlock_file,
334 (req_handler)req_create_socket,
335 (req_handler)req_accept_socket,
336 (req_handler)req_set_socket_event,
337 (req_handler)req_get_socket_event,
338 (req_handler)req_enable_socket_event,
339 (req_handler)req_set_socket_deferred,
340 (req_handler)req_alloc_console,
341 (req_handler)req_free_console,
342 (req_handler)req_get_console_renderer_events,
343 (req_handler)req_open_console,
344 (req_handler)req_get_console_wait_event,
345 (req_handler)req_get_console_mode,
346 (req_handler)req_set_console_mode,
347 (req_handler)req_set_console_input_info,
348 (req_handler)req_get_console_input_info,
349 (req_handler)req_append_console_input_history,
350 (req_handler)req_get_console_input_history,
351 (req_handler)req_create_console_output,
352 (req_handler)req_set_console_output_info,
353 (req_handler)req_get_console_output_info,
354 (req_handler)req_write_console_input,
355 (req_handler)req_read_console_input,
356 (req_handler)req_write_console_output,
357 (req_handler)req_fill_console_output,
358 (req_handler)req_read_console_output,
359 (req_handler)req_move_console_output,
360 (req_handler)req_send_console_signal,
361 (req_handler)req_create_change_notification,
362 (req_handler)req_next_change_notification,
363 (req_handler)req_create_mapping,
364 (req_handler)req_open_mapping,
365 (req_handler)req_get_mapping_info,
366 (req_handler)req_create_snapshot,
367 (req_handler)req_next_process,
368 (req_handler)req_next_thread,
369 (req_handler)req_next_module,
370 (req_handler)req_wait_debug_event,
371 (req_handler)req_queue_exception_event,
372 (req_handler)req_get_exception_status,
373 (req_handler)req_output_debug_string,
374 (req_handler)req_continue_debug_event,
375 (req_handler)req_debug_process,
376 (req_handler)req_debug_break,
377 (req_handler)req_set_debugger_kill_on_exit,
378 (req_handler)req_read_process_memory,
379 (req_handler)req_write_process_memory,
380 (req_handler)req_create_key,
381 (req_handler)req_open_key,
382 (req_handler)req_delete_key,
383 (req_handler)req_flush_key,
384 (req_handler)req_enum_key,
385 (req_handler)req_set_key_value,
386 (req_handler)req_get_key_value,
387 (req_handler)req_enum_key_value,
388 (req_handler)req_delete_key_value,
389 (req_handler)req_load_registry,
390 (req_handler)req_unload_registry,
391 (req_handler)req_save_registry,
392 (req_handler)req_load_user_registries,
393 (req_handler)req_set_registry_notification,
394 (req_handler)req_create_timer,
395 (req_handler)req_open_timer,
396 (req_handler)req_set_timer,
397 (req_handler)req_cancel_timer,
398 (req_handler)req_get_timer_info,
399 (req_handler)req_get_thread_context,
400 (req_handler)req_set_thread_context,
401 (req_handler)req_get_selector_entry,
402 (req_handler)req_add_atom,
403 (req_handler)req_delete_atom,
404 (req_handler)req_find_atom,
405 (req_handler)req_get_atom_name,
406 (req_handler)req_init_atom_table,
407 (req_handler)req_get_msg_queue,
408 (req_handler)req_set_queue_mask,
409 (req_handler)req_get_queue_status,
410 (req_handler)req_wait_input_idle,
411 (req_handler)req_send_message,
412 (req_handler)req_get_message,
413 (req_handler)req_reply_message,
414 (req_handler)req_get_message_reply,
415 (req_handler)req_set_win_timer,
416 (req_handler)req_kill_win_timer,
417 (req_handler)req_get_serial_info,
418 (req_handler)req_set_serial_info,
419 (req_handler)req_register_async,
420 (req_handler)req_cancel_async,
421 (req_handler)req_create_named_pipe,
422 (req_handler)req_open_named_pipe,
423 (req_handler)req_connect_named_pipe,
424 (req_handler)req_wait_named_pipe,
425 (req_handler)req_disconnect_named_pipe,
426 (req_handler)req_get_named_pipe_info,
427 (req_handler)req_create_window,
428 (req_handler)req_link_window,
429 (req_handler)req_destroy_window,
430 (req_handler)req_set_window_owner,
431 (req_handler)req_get_window_info,
432 (req_handler)req_set_window_info,
433 (req_handler)req_get_window_parents,
434 (req_handler)req_get_window_children,
435 (req_handler)req_get_window_children_from_point,
436 (req_handler)req_get_window_tree,
437 (req_handler)req_set_window_pos,
438 (req_handler)req_get_window_rectangles,
439 (req_handler)req_get_window_text,
440 (req_handler)req_set_window_text,
441 (req_handler)req_get_windows_offset,
442 (req_handler)req_get_visible_region,
443 (req_handler)req_get_window_region,
444 (req_handler)req_set_window_region,
445 (req_handler)req_get_update_region,
446 (req_handler)req_redraw_window,
447 (req_handler)req_set_window_property,
448 (req_handler)req_remove_window_property,
449 (req_handler)req_get_window_property,
450 (req_handler)req_get_window_properties,
451 (req_handler)req_attach_thread_input,
452 (req_handler)req_get_thread_input,
453 (req_handler)req_get_key_state,
454 (req_handler)req_set_key_state,
455 (req_handler)req_set_foreground_window,
456 (req_handler)req_set_focus_window,
457 (req_handler)req_set_active_window,
458 (req_handler)req_set_capture_window,
459 (req_handler)req_set_caret_window,
460 (req_handler)req_set_caret_info,
461 (req_handler)req_set_hook,
462 (req_handler)req_remove_hook,
463 (req_handler)req_start_hook_chain,
464 (req_handler)req_finish_hook_chain,
465 (req_handler)req_get_next_hook,
466 (req_handler)req_create_class,
467 (req_handler)req_destroy_class,
468 (req_handler)req_set_class_info,
469 (req_handler)req_set_clipboard_info,
470 (req_handler)req_open_token,
471 (req_handler)req_set_global_windows,
473 #endif /* WANT_REQUEST_HANDLERS */
475 /* ### make_requests end ### */
476 /* Everything above this line is generated automatically by tools/make_requests */
478 #endif /* __WINE_SERVER_REQUEST_H */