Added an implementation of the MSVCRTD.DLL debugging C runtime DLL.
[wine] / server / protocol.def
1 /* -*- C -*-
2  *
3  * Wine server protocol definition
4  *
5  * Copyright (C) 2001 Alexandre Julliard
6  *
7  * This file is used by tools/make_requests to build the
8  * protocol structures in include/wine/server_protocol.h
9  *
10  * This library is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free Software Foundation; either
13  * version 2.1 of the License, or (at your option) any later version.
14  *
15  * This library is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with this library; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
23  */
24
25 @HEADER  /* start of C declarations */
26
27 #include <stdlib.h>
28 #include <time.h>
29 #include "winbase.h"
30
31 struct request_header
32 {
33     int          req;          /* request code */
34     size_t       request_size; /* request variable part size */
35     size_t       reply_size;   /* reply variable part maximum size */
36 };
37
38 struct reply_header
39 {
40     unsigned int error;        /* error result */
41     size_t       reply_size;   /* reply variable part size */
42 };
43
44 /* placeholder structure for the maximum allowed request size */
45 /* this is used to construct the generic_request union */
46 struct request_max_size
47 {
48     int pad[16]; /* the max request size is 16 ints */
49 };
50
51 typedef void *obj_handle_t;
52 typedef void *user_handle_t;
53 typedef unsigned short atom_t;
54 typedef unsigned int process_id_t;
55 typedef unsigned int thread_id_t;
56
57 #define FIRST_USER_HANDLE 0x0020  /* first possible value for low word of user handle */
58 #define LAST_USER_HANDLE  0xffef  /* last possible value for low word of user handle */
59
60
61 /* definitions of the event data depending on the event code */
62 struct debug_event_exception
63 {
64     EXCEPTION_RECORD record;   /* exception record */
65     int              first;    /* first chance exception? */
66 };
67 struct debug_event_create_thread
68 {
69     obj_handle_t handle;     /* handle to the new thread */
70     void        *teb;        /* thread teb (in debugged process address space) */
71     void        *start;      /* thread startup routine */
72 };
73 struct debug_event_create_process
74 {
75     obj_handle_t file;       /* handle to the process exe file */
76     obj_handle_t process;    /* handle to the new process */
77     obj_handle_t thread;     /* handle to the new thread */
78     void        *base;       /* base of executable image */
79     int          dbg_offset; /* offset of debug info in file */
80     int          dbg_size;   /* size of debug info */
81     void        *teb;        /* thread teb (in debugged process address space) */
82     void        *start;      /* thread startup routine */
83     void        *name;       /* image name (optional) */
84     int          unicode;    /* is it Unicode? */
85 };
86 struct debug_event_exit
87 {
88     int          exit_code;  /* thread or process exit code */
89 };
90 struct debug_event_load_dll
91 {
92     obj_handle_t handle;     /* file handle for the dll */
93     void        *base;       /* base address of the dll */
94     int          dbg_offset; /* offset of debug info in file */
95     int          dbg_size;   /* size of debug info */
96     void        *name;       /* image name (optional) */
97     int          unicode;    /* is it Unicode? */
98 };
99 struct debug_event_unload_dll
100 {
101     void       *base;       /* base address of the dll */
102 };
103 struct debug_event_output_string
104 {
105     void       *string;     /* string to display (in debugged process address space) */
106     int         unicode;    /* is it Unicode? */
107     int         length;     /* string length */
108 };
109 struct debug_event_rip_info
110 {
111     int         error;      /* ??? */
112     int         type;       /* ??? */
113 };
114 union debug_event_data
115 {
116     struct debug_event_exception      exception;
117     struct debug_event_create_thread  create_thread;
118     struct debug_event_create_process create_process;
119     struct debug_event_exit           exit;
120     struct debug_event_load_dll       load_dll;
121     struct debug_event_unload_dll     unload_dll;
122     struct debug_event_output_string  output_string;
123     struct debug_event_rip_info       rip_info;
124 };
125
126 /* debug event data */
127 typedef struct
128 {
129     int                      code;   /* event code */
130     union debug_event_data   info;   /* event information */
131 } debug_event_t;
132
133 /* structure used in sending an fd from client to server */
134 struct send_fd
135 {
136     thread_id_t tid;  /* thread id */
137     int         fd;   /* file descriptor on client-side */
138 };
139
140 /* structure sent by the server on the wait fifo */
141 struct wake_up_reply
142 {
143     void *cookie;    /* magic cookie that was passed in select_request */
144     int   signaled;  /* wait result */
145 };
146
147 /* structure for process startup info */
148 typedef struct
149 {
150     size_t       size;         /* size of this structure */
151     size_t       filename_len; /* length of filename */
152     size_t       cmdline_len;  /* length of cmd line */
153     size_t       desktop_len;  /* length of desktop name */
154     size_t       title_len;    /* length of title */
155     int          x;            /* window position */
156     int          y;
157     int          cx;           /* window size */
158     int          cy;
159     int          x_chars;      /* console size */
160     int          y_chars;
161     int          attribute;    /* console attributes */
162     int          cmd_show;     /* main window show mode */
163     unsigned int flags;        /* info flags */
164     /* char filename[...]; */
165     /* char cmdline[...]; */
166     /* char desktop[...]; */
167     /* char title[...]; */
168 } startup_info_t;
169
170 /* structure for absolute timeouts */
171 typedef struct
172 {
173     int            sec;      /* seconds since Unix epoch */
174     int            usec;     /* microseconds */
175 } abs_time_t;
176
177 /* structure returned in the list of window properties */
178 typedef struct
179 {
180     atom_t         atom;     /* property atom */
181     short          string;   /* was atom a string originally? */
182     obj_handle_t   handle;   /* handle stored in property */
183 } property_data_t;
184
185 /* structure to specify window rectangles */
186 typedef struct
187 {
188     int  left;
189     int  top;
190     int  right;
191     int  bottom;
192 } rectangle_t;
193
194 /* structure for console char/attribute info */
195 typedef struct
196 {
197     WCHAR          ch;
198     unsigned short attr;
199 } char_info_t;
200
201 /****************************************************************/
202 /* Request declarations */
203
204 /* Create a new process from the context of the parent */
205 @REQ(new_process)
206     int          inherit_all;  /* inherit all handles from parent */
207     int          use_handles;  /* use stdio handles */
208     int          create_flags; /* creation flags */
209     int          unix_pid;     /* Unix pid of new process */
210     obj_handle_t exe_file;     /* file handle for main exe */
211     obj_handle_t hstdin;       /* handle for stdin */
212     obj_handle_t hstdout;      /* handle for stdout */
213     obj_handle_t hstderr;      /* handle for stderr */
214     VARARG(info,startup_info); /* startup information */
215 @REPLY
216     obj_handle_t info;         /* new process info handle */
217 @END
218
219
220 /* Retrieve information about a newly started process */
221 @REQ(get_new_process_info)
222     obj_handle_t info;         /* info handle returned from new_process_request */
223     int          pinherit;     /* process handle inherit flag */
224     int          tinherit;     /* thread handle inherit flag */
225 @REPLY
226     process_id_t pid;          /* process id */
227     obj_handle_t phandle;      /* process handle (in the current process) */
228     thread_id_t  tid;          /* thread id */
229     obj_handle_t thandle;      /* thread handle (in the current process) */
230     int          success;      /* did the process start successfully? */
231 @END
232
233
234 /* Create a new thread from the context of the parent */
235 @REQ(new_thread)
236     int          suspend;      /* new thread should be suspended on creation */
237     int          inherit;      /* inherit flag */
238     int          request_fd;   /* fd for request pipe */
239 @REPLY
240     thread_id_t  tid;          /* thread id */
241     obj_handle_t handle;       /* thread handle (in the current process) */
242 @END
243
244
245 /* Signal that we are finished booting on the client side */
246 @REQ(boot_done)
247     int          debug_level;  /* new debug level */
248 @END
249
250
251 /* Initialize a process; called from the new process context */
252 @REQ(init_process)
253     void*        ldt_copy;     /* addr of LDT copy */
254 @REPLY
255     int          create_flags; /* creation flags */
256     unsigned int server_start; /* server start time (GetTickCount) */
257     size_t       info_size;    /* total size of startup info */
258     obj_handle_t exe_file;     /* file handle for main exe */
259     obj_handle_t hstdin;       /* handle for stdin */
260     obj_handle_t hstdout;      /* handle for stdout */
261     obj_handle_t hstderr;      /* handle for stderr */
262 @END
263
264
265 /* Retrieve the new process startup info */
266 @REQ(get_startup_info)
267 @REPLY
268     VARARG(info,startup_info); /* startup information */
269 @END
270
271
272 /* Signal the end of the process initialization */
273 @REQ(init_process_done)
274     void*        module;       /* main module base address */
275     size_t       module_size;  /* main module size */
276     void*        entry;        /* process entry point */
277     void*        name;         /* ptr to ptr to name (in process addr space) */
278     obj_handle_t exe_file;     /* file handle for main exe */
279     int          gui;          /* is it a GUI process? */
280     VARARG(filename,string);   /* file name of main exe */
281 @REPLY
282     int          debugged;     /* being debugged? */
283 @END
284
285
286 /* Initialize a thread; called from the child after fork()/clone() */
287 @REQ(init_thread)
288     int          unix_pid;     /* Unix pid of new thread */
289     int          unix_tid;     /* Unix tid of new thread */
290     void*        teb;          /* TEB of new thread (in thread address space) */
291     void*        entry;        /* thread entry point (in thread address space) */
292     int          reply_fd;     /* fd for reply pipe */
293     int          wait_fd;      /* fd for blocking calls pipe */
294 @REPLY
295     process_id_t pid;          /* process id of the new thread's process */
296     thread_id_t  tid;          /* thread id of the new thread */
297     int          boot;         /* is this the boot thread? */
298     int          version;      /* protocol version */
299 @END
300
301
302 /* Terminate a process */
303 @REQ(terminate_process)
304     obj_handle_t handle;       /* process handle to terminate */
305     int          exit_code;    /* process exit code */
306 @REPLY
307     int          self;         /* suicide? */
308 @END
309
310
311 /* Terminate a thread */
312 @REQ(terminate_thread)
313     obj_handle_t handle;       /* thread handle to terminate */
314     int          exit_code;    /* thread exit code */
315 @REPLY
316     int          self;         /* suicide? */
317     int          last;         /* last thread in this process? */
318 @END
319
320
321 /* Retrieve information about a process */
322 @REQ(get_process_info)
323     obj_handle_t handle;           /* process handle */
324 @REPLY
325     process_id_t pid;              /* server process id */
326     int          debugged;         /* debugged? */
327     int          exit_code;        /* process exit code */
328     int          priority;         /* priority class */
329     int          process_affinity; /* process affinity mask */
330     int          system_affinity;  /* system affinity mask */
331 @END
332
333
334 /* Set a process informations */
335 @REQ(set_process_info)
336     obj_handle_t handle;       /* process handle */
337     int          mask;         /* setting mask (see below) */
338     int          priority;     /* priority class */
339     int          affinity;     /* affinity mask */
340 @END
341 #define SET_PROCESS_INFO_PRIORITY 0x01
342 #define SET_PROCESS_INFO_AFFINITY 0x02
343
344
345 /* Retrieve information about a thread */
346 @REQ(get_thread_info)
347     obj_handle_t handle;        /* thread handle */
348     thread_id_t  tid_in;        /* thread id (optional) */
349 @REPLY
350     thread_id_t  tid;           /* server thread id */
351     void*        teb;           /* thread teb pointer */
352     int          exit_code;     /* thread exit code */
353     int          priority;      /* thread priority level */
354     time_t       creation_time; /* thread creation time */
355     time_t       exit_time;     /* thread exit time */
356 @END
357
358
359 /* Set a thread informations */
360 @REQ(set_thread_info)
361     obj_handle_t handle;       /* thread handle */
362     int          mask;         /* setting mask (see below) */
363     int          priority;     /* priority class */
364     int          affinity;     /* affinity mask */
365 @END
366 #define SET_THREAD_INFO_PRIORITY 0x01
367 #define SET_THREAD_INFO_AFFINITY 0x02
368
369
370 /* Retrieve information about a module */
371 @REQ(get_dll_info)
372     obj_handle_t handle;       /* process handle */
373     void*        base_address; /* base address of module */
374 @REPLY
375     size_t       size;          /* module size */
376     void*        entry_point;
377     VARARG(filename,string);    /* file name of module */
378 @END
379
380
381 /* Suspend a thread */
382 @REQ(suspend_thread)
383     obj_handle_t handle;       /* thread handle */
384 @REPLY
385     int          count;        /* new suspend count */
386 @END
387
388
389 /* Resume a thread */
390 @REQ(resume_thread)
391     obj_handle_t handle;       /* thread handle */
392 @REPLY
393     int          count;        /* new suspend count */
394 @END
395
396
397 /* Notify the server that a dll has been loaded */
398 @REQ(load_dll)
399     obj_handle_t handle;       /* file handle */
400     void*        base;         /* base address */
401     size_t       size;         /* dll size */
402     int          dbg_offset;   /* debug info offset */
403     int          dbg_size;     /* debug info size */
404     void*        name;         /* ptr to ptr to name (in process addr space) */
405     VARARG(filename,string);   /* file name of dll */
406 @END
407
408
409 /* Notify the server that a dll is being unloaded */
410 @REQ(unload_dll)
411     void*        base;         /* base address */
412 @END
413
414
415 /* Queue an APC for a thread */
416 @REQ(queue_apc)
417     obj_handle_t handle;       /* thread handle */
418     int          user;         /* user or system apc? */
419     void*        func;         /* function to call */
420     void*        param;        /* param for function to call */
421 @END
422
423
424 /* Get next APC to call */
425 @REQ(get_apc)
426     int          alertable;    /* is thread alertable? */
427 @REPLY
428     void*        func;         /* function to call */
429     int          type;         /* function type */
430     VARARG(args,ptrs);         /* function arguments */
431 @END
432 enum apc_type { APC_NONE, APC_USER, APC_TIMER, APC_ASYNC, APC_ASYNC_IO };
433
434
435 /* Close a handle for the current process */
436 @REQ(close_handle)
437     obj_handle_t handle;       /* handle to close */
438 @REPLY
439     int          fd;           /* associated fd to close */
440 @END
441
442
443 /* Set a handle information */
444 @REQ(set_handle_info)
445     obj_handle_t handle;       /* handle we are interested in */
446     int          flags;        /* new handle flags */
447     int          mask;         /* mask for flags to set */
448     int          fd;           /* file descriptor or -1 */
449 @REPLY
450     int          old_flags;    /* old flag value */
451     int          cur_fd;       /* current file descriptor */
452 @END
453
454
455 /* Duplicate a handle */
456 @REQ(dup_handle)
457     obj_handle_t src_process;  /* src process handle */
458     obj_handle_t src_handle;   /* src handle to duplicate */
459     obj_handle_t dst_process;  /* dst process handle */
460     unsigned int access;       /* wanted access rights */
461     int          inherit;      /* inherit flag */
462     int          options;      /* duplicate options (see below) */
463 @REPLY
464     obj_handle_t handle;       /* duplicated handle in dst process */
465     int          fd;           /* associated fd to close */
466 @END
467 #define DUP_HANDLE_CLOSE_SOURCE  DUPLICATE_CLOSE_SOURCE
468 #define DUP_HANDLE_SAME_ACCESS   DUPLICATE_SAME_ACCESS
469 #define DUP_HANDLE_MAKE_GLOBAL   0x80000000  /* Not a Windows flag */
470
471
472 /* Open a handle to a process */
473 @REQ(open_process)
474     process_id_t pid;          /* process id to open */
475     unsigned int access;       /* wanted access rights */
476     int          inherit;      /* inherit flag */
477 @REPLY
478     obj_handle_t handle;       /* handle to the process */
479 @END
480
481
482 /* Open a handle to a thread */
483 @REQ(open_thread)
484     thread_id_t  tid;          /* thread id to open */
485     unsigned int access;       /* wanted access rights */
486     int          inherit;      /* inherit flag */
487 @REPLY
488     obj_handle_t handle;       /* handle to the thread */
489 @END
490
491
492 /* Wait for handles */
493 @REQ(select)
494     int          flags;        /* wait flags (see below) */
495     void*        cookie;       /* magic cookie to return to client */
496     abs_time_t   timeout;      /* absolute timeout */
497     VARARG(handles,handles);   /* handles to select on */
498 @END
499 #define SELECT_ALL           1
500 #define SELECT_ALERTABLE     2
501 #define SELECT_INTERRUPTIBLE 4
502 #define SELECT_TIMEOUT       8
503
504
505 /* Create an event */
506 @REQ(create_event)
507     int          manual_reset;  /* manual reset event */
508     int          initial_state; /* initial state of the event */
509     int          inherit;       /* inherit flag */
510     VARARG(name,unicode_str);   /* object name */
511 @REPLY
512     obj_handle_t handle;        /* handle to the event */
513 @END
514
515 /* Event operation */
516 @REQ(event_op)
517     obj_handle_t  handle;       /* handle to event */
518     int           op;           /* event operation (see below) */
519 @END
520 enum event_op { PULSE_EVENT, SET_EVENT, RESET_EVENT };
521
522
523 /* Open an event */
524 @REQ(open_event)
525     unsigned int access;        /* wanted access rights */
526     int          inherit;       /* inherit flag */
527     VARARG(name,unicode_str);   /* object name */
528 @REPLY
529     obj_handle_t handle;        /* handle to the event */
530 @END
531
532
533 /* Create a mutex */
534 @REQ(create_mutex)
535     int          owned;         /* initially owned? */
536     int          inherit;       /* inherit flag */
537     VARARG(name,unicode_str);   /* object name */
538 @REPLY
539     obj_handle_t handle;        /* handle to the mutex */
540 @END
541
542
543 /* Release a mutex */
544 @REQ(release_mutex)
545     obj_handle_t handle;        /* handle to the mutex */
546 @END
547
548
549 /* Open a mutex */
550 @REQ(open_mutex)
551     unsigned int access;        /* wanted access rights */
552     int          inherit;       /* inherit flag */
553     VARARG(name,unicode_str);   /* object name */
554 @REPLY
555     obj_handle_t handle;        /* handle to the mutex */
556 @END
557
558
559 /* Create a semaphore */
560 @REQ(create_semaphore)
561     unsigned int initial;       /* initial count */
562     unsigned int max;           /* maximum count */
563     int          inherit;       /* inherit flag */
564     VARARG(name,unicode_str);   /* object name */
565 @REPLY
566     obj_handle_t handle;        /* handle to the semaphore */
567 @END
568
569
570 /* Release a semaphore */
571 @REQ(release_semaphore)
572     obj_handle_t handle;        /* handle to the semaphore */
573     unsigned int count;         /* count to add to semaphore */
574 @REPLY
575     unsigned int prev_count;    /* previous semaphore count */
576 @END
577
578
579 /* Open a semaphore */
580 @REQ(open_semaphore)
581     unsigned int access;        /* wanted access rights */
582     int          inherit;       /* inherit flag */
583     VARARG(name,unicode_str);   /* object name */
584 @REPLY
585     obj_handle_t handle;        /* handle to the semaphore */
586 @END
587
588
589 /* Create a file */
590 @REQ(create_file)
591     unsigned int access;        /* wanted access rights */
592     int          inherit;       /* inherit flag */
593     unsigned int sharing;       /* sharing flags */
594     int          create;        /* file create action */
595     unsigned int attrs;         /* file attributes for creation */
596     int          drive_type;    /* type of drive the file is on */
597     VARARG(filename,string);    /* file name */
598 @REPLY
599     obj_handle_t handle;        /* handle to the file */
600 @END
601
602
603 /* Allocate a file handle for a Unix fd */
604 @REQ(alloc_file_handle)
605     unsigned int access;        /* wanted access rights */
606     int          inherit;       /* inherit flag */
607     int          fd;            /* file descriptor on the client side */
608 @REPLY
609     obj_handle_t handle;        /* handle to the file */
610 @END
611
612
613 /* Get a Unix fd to access a file */
614 @REQ(get_handle_fd)
615     obj_handle_t handle;        /* handle to the file */
616     unsigned int access;        /* wanted access rights */
617 @REPLY
618     int          fd;            /* file descriptor */
619     int          type;          /* the type of file (see below) */
620     int          flags;         /* file read/write flags (see below) */
621 @END
622 enum fd_type
623 {
624     FD_TYPE_INVALID,
625     FD_TYPE_DEFAULT,
626     FD_TYPE_CONSOLE,
627     FD_TYPE_SOCKET,
628     FD_TYPE_SMB
629 };
630 #define FD_FLAG_OVERLAPPED         0x01
631 #define FD_FLAG_TIMEOUT            0x02
632 #define FD_FLAG_RECV_SHUTDOWN      0x04
633 #define FD_FLAG_SEND_SHUTDOWN      0x08
634
635 /* Set a file current position */
636 @REQ(set_file_pointer)
637     obj_handle_t handle;        /* handle to the file */
638     int          low;           /* position low word */
639     int          high;          /* position high word */
640     int          whence;        /* whence to seek */
641 @REPLY
642     int          new_low;       /* new position low word */
643     int          new_high;      /* new position high word */
644 @END
645
646
647 /* Truncate (or extend) a file */
648 @REQ(truncate_file)
649     obj_handle_t handle;        /* handle to the file */
650 @END
651
652
653 /* Set a file access and modification times */
654 @REQ(set_file_time)
655     obj_handle_t handle;        /* handle to the file */
656     time_t       access_time;   /* last access time */
657     time_t       write_time;    /* last write time */
658 @END
659
660
661 /* Flush a file buffers */
662 @REQ(flush_file)
663     obj_handle_t handle;        /* handle to the file */
664 @END
665
666
667 /* Get information about a file */
668 @REQ(get_file_info)
669     obj_handle_t handle;        /* handle to the file */
670 @REPLY
671     int          type;          /* file type */
672     int          attr;          /* file attributes */
673     time_t       access_time;   /* last access time */
674     time_t       write_time;    /* last write time */
675     int          size_high;     /* file size */
676     int          size_low;      /* file size */
677     int          links;         /* number of links */
678     int          index_high;    /* unique index */
679     int          index_low;     /* unique index */
680     unsigned int serial;        /* volume serial number */
681 @END
682
683
684 /* Lock a region of a file */
685 @REQ(lock_file)
686     obj_handle_t handle;        /* handle to the file */
687     unsigned int offset_low;    /* offset of start of lock */
688     unsigned int offset_high;   /* offset of start of lock */
689     unsigned int count_low;     /* count of bytes to lock */
690     unsigned int count_high;    /* count of bytes to lock */
691     int          shared;        /* shared or exclusive lock? */
692     int          wait;          /* do we want to wait? */
693 @REPLY
694     obj_handle_t handle;        /* handle to wait on */
695     int          overlapped;    /* is it an overlapped I/O handle? */
696 @END
697
698
699 /* Unlock a region of a file */
700 @REQ(unlock_file)
701     obj_handle_t handle;        /* handle to the file */
702     unsigned int offset_low;    /* offset of start of unlock */
703     unsigned int offset_high;   /* offset of start of unlock */
704     unsigned int count_low;     /* count of bytes to unlock */
705     unsigned int count_high;    /* count of bytes to unlock */
706 @END
707
708
709 /* Create an anonymous pipe */
710 @REQ(create_pipe)
711     int          inherit;       /* inherit flag */
712 @REPLY
713     obj_handle_t handle_read;   /* handle to the read-side of the pipe */
714     obj_handle_t handle_write;  /* handle to the write-side of the pipe */
715 @END
716
717
718 /* Create a socket */
719 @REQ(create_socket)
720     unsigned int access;        /* wanted access rights */
721     int          inherit;       /* inherit flag */
722     int          family;        /* family, see socket manpage */
723     int          type;          /* type, see socket manpage */
724     int          protocol;      /* protocol, see socket manpage */
725     unsigned int flags;         /* socket flags */
726 @REPLY
727     obj_handle_t handle;        /* handle to the new socket */
728 @END
729
730
731 /* Accept a socket */
732 @REQ(accept_socket)
733     obj_handle_t lhandle;       /* handle to the listening socket */
734     unsigned int access;        /* wanted access rights */
735     int          inherit;       /* inherit flag */
736 @REPLY
737     obj_handle_t handle;        /* handle to the new socket */
738 @END
739
740
741 /* Set socket event parameters */
742 @REQ(set_socket_event)
743     obj_handle_t  handle;        /* handle to the socket */
744     unsigned int  mask;          /* event mask */
745     obj_handle_t  event;         /* event object */
746     user_handle_t window;        /* window to send the message to */
747     unsigned int  msg;           /* message to send */
748 @END
749
750
751 /* Get socket event parameters */
752 @REQ(get_socket_event)
753     obj_handle_t handle;        /* handle to the socket */
754     int          service;       /* clear pending? */
755     obj_handle_t c_event;       /* event to clear */
756 @REPLY
757     unsigned int mask;          /* event mask */
758     unsigned int pmask;         /* pending events */
759     unsigned int state;         /* status bits */
760     VARARG(errors,ints);        /* event errors */
761 @END
762
763
764 /* Reenable pending socket events */
765 @REQ(enable_socket_event)
766     obj_handle_t handle;        /* handle to the socket */
767     unsigned int mask;          /* events to re-enable */
768     unsigned int sstate;        /* status bits to set */
769     unsigned int cstate;        /* status bits to clear */
770 @END
771
772 @REQ(set_socket_deferred)
773     obj_handle_t handle;        /* handle to the socket */
774     obj_handle_t deferred;      /* handle to the socket for which accept() is deferred */
775 @END
776
777 /* Allocate a console (only used by a console renderer) */
778 @REQ(alloc_console)
779     unsigned int access;        /* wanted access rights */
780     int          inherit;       /* inherit flag */
781     process_id_t pid;           /* pid of process which shall be attached to the console */
782 @REPLY
783     obj_handle_t handle_in;     /* handle to console input */
784     obj_handle_t event;         /* handle to renderer events change notification */
785 @END
786
787
788 /* Free the console of the current process */
789 @REQ(free_console)
790 @END
791
792
793 #define CONSOLE_RENDERER_NONE_EVENT        0x00
794 #define CONSOLE_RENDERER_TITLE_EVENT       0x01
795 #define CONSOLE_RENDERER_ACTIVE_SB_EVENT   0x02
796 #define CONSOLE_RENDERER_SB_RESIZE_EVENT   0x03
797 #define CONSOLE_RENDERER_UPDATE_EVENT      0x04
798 #define CONSOLE_RENDERER_CURSOR_POS_EVENT  0x05
799 #define CONSOLE_RENDERER_CURSOR_GEOM_EVENT 0x06
800 #define CONSOLE_RENDERER_DISPLAY_EVENT     0x07
801 #define CONSOLE_RENDERER_EXIT_EVENT        0x08
802 struct console_renderer_event
803 {
804     short event;
805     union
806     {
807         struct update
808         {
809             short top;
810             short bottom;
811         } update;
812         struct resize
813         {
814             short width;
815             short height;
816         } resize;
817         struct cursor_pos
818         {
819             short x;
820             short y;
821         } cursor_pos;
822         struct cursor_geom
823         {
824             short visible;
825             short size;
826         } cursor_geom;
827         struct display
828         {
829             short left;
830             short top;
831             short width;
832             short height;
833         } display;
834     } u;
835 };
836
837 /* retrieve console events for the renderer */
838 @REQ(get_console_renderer_events)
839     obj_handle_t handle;        /* handle to console input events */
840 @REPLY
841     VARARG(data,bytes);         /* the various console_renderer_events */
842 @END
843
844
845 /* Open a handle to the process console */
846 @REQ(open_console)
847     int          from;          /* 0 (resp 1) input (resp output) of current process console */
848                                 /* otherwise console_in handle to get active screen buffer? */
849     unsigned int access;        /* wanted access rights */
850     int          inherit;       /* inherit flag */
851     int          share;         /* share mask (only for output handles) */
852 @REPLY
853     obj_handle_t handle;        /* handle to the console */
854 @END
855
856
857 /* Get a console mode (input or output) */
858 @REQ(get_console_mode)
859     obj_handle_t handle;        /* handle to the console */
860 @REPLY
861     int          mode;          /* console mode */
862 @END
863
864
865 /* Set a console mode (input or output) */
866 @REQ(set_console_mode)
867     obj_handle_t handle;        /* handle to the console */
868     int          mode;          /* console mode */
869 @END
870
871
872 /* Set info about a console (input only) */
873 @REQ(set_console_input_info)
874     obj_handle_t handle;        /* handle to console input, or 0 for process' console */
875     int          mask;          /* setting mask (see below) */
876     obj_handle_t active_sb;     /* active screen buffer */
877     int          history_mode;  /* whether we duplicate lines in history */
878     int          history_size;  /* number of lines in history */
879     int          edition_mode;  /* index to the edition mode flavors */
880     VARARG(title,unicode_str);  /* console title */
881 @END
882 #define SET_CONSOLE_INPUT_INFO_ACTIVE_SB        0x01
883 #define SET_CONSOLE_INPUT_INFO_TITLE            0x02
884 #define SET_CONSOLE_INPUT_INFO_HISTORY_MODE     0x04
885 #define SET_CONSOLE_INPUT_INFO_HISTORY_SIZE     0x08
886 #define SET_CONSOLE_INPUT_INFO_EDITION_MODE     0x10
887
888
889 /* Get info about a console (input only) */
890 @REQ(get_console_input_info)
891     obj_handle_t handle;        /* handle to console input, or 0 for process' console */
892 @REPLY
893     int          history_mode;  /* whether we duplicate lines in history */
894     int          history_size;  /* number of lines in history */
895     int          history_index; /* number of used lines in history */
896     int          edition_mode;  /* index to the edition mode flavors */
897     VARARG(title,unicode_str);  /* console title */
898 @END
899
900
901 /* appends a string to console's history */
902 @REQ(append_console_input_history)
903     obj_handle_t handle;        /* handle to console input, or 0 for process' console */
904     VARARG(line,unicode_str);   /* line to add */
905 @END
906
907
908 /* appends a string to console's history */
909 @REQ(get_console_input_history)
910     obj_handle_t handle;        /* handle to console input, or 0 for process' console */
911     int          index;         /* index to get line from */
912 @REPLY
913     int          total;         /* total length of line in Unicode chars */
914     VARARG(line,unicode_str);   /* line to add */
915 @END
916
917
918 /* creates a new screen buffer on process' console */
919 @REQ(create_console_output)
920     obj_handle_t handle_in;     /* handle to console input, or 0 for process' console */
921     int          access;        /* wanted access rights */
922     int          share;         /* sharing credentials */
923     int          inherit;       /* inherit flag */
924 @REPLY
925     obj_handle_t handle_out;    /* handle to the screen buffer */
926 @END
927
928
929 /* Set info about a console (output only) */
930 @REQ(set_console_output_info)
931     obj_handle_t handle;        /* handle to the console */
932     int          mask;          /* setting mask (see below) */
933     short int    cursor_size;   /* size of cursor (percentage filled) */
934     short int    cursor_visible;/* cursor visibility flag */
935     short int    cursor_x;      /* position of cursor (x, y) */
936     short int    cursor_y;
937     short int    width;         /* width of the screen buffer */
938     short int    height;        /* height of the screen buffer */
939     short int    attr;          /* default attribute */
940     short int    win_left;      /* window actually displayed by renderer */
941     short int    win_top;       /* the rect area is expressed withing the */
942     short int    win_right;     /* boundaries of the screen buffer */
943     short int    win_bottom;
944     short int    max_width;     /* maximum size (width x height) for the window */
945     short int    max_height;
946 @END
947 #define SET_CONSOLE_OUTPUT_INFO_CURSOR_GEOM     0x01
948 #define SET_CONSOLE_OUTPUT_INFO_CURSOR_POS      0x02
949 #define SET_CONSOLE_OUTPUT_INFO_SIZE            0x04
950 #define SET_CONSOLE_OUTPUT_INFO_ATTR            0x08
951 #define SET_CONSOLE_OUTPUT_INFO_DISPLAY_WINDOW  0x10
952 #define SET_CONSOLE_OUTPUT_INFO_MAX_SIZE        0x20
953
954
955 /* Get info about a console (output only) */
956 @REQ(get_console_output_info)
957     obj_handle_t handle;        /* handle to the console */
958 @REPLY
959     short int    cursor_size;   /* size of cursor (percentage filled) */
960     short int    cursor_visible;/* cursor visibility flag */
961     short int    cursor_x;      /* position of cursor (x, y) */
962     short int    cursor_y;
963     short int    width;         /* width of the screen buffer */
964     short int    height;        /* height of the screen buffer */
965     short int    attr;          /* default attribute */
966     short int    win_left;      /* window actually displayed by renderer */
967     short int    win_top;       /* the rect area is expressed withing the */
968     short int    win_right;     /* boundaries of the screen buffer */
969     short int    win_bottom;
970     short int    max_width;     /* maximum size (width x height) for the window */
971     short int    max_height;
972 @END
973
974 /* Add input records to a console input queue */
975 @REQ(write_console_input)
976     obj_handle_t handle;        /* handle to the console input */
977     VARARG(rec,input_records);  /* input records */
978 @REPLY
979     int          written;       /* number of records written */
980 @END
981
982
983 /* Fetch input records from a console input queue */
984 @REQ(read_console_input)
985     obj_handle_t handle;        /* handle to the console input */
986     int          flush;         /* flush the retrieved records from the queue? */
987 @REPLY
988     int          read;          /* number of records read */
989     VARARG(rec,input_records);  /* input records */
990 @END
991
992
993 /* write data (chars and/or attributes) in a screen buffer */
994 @REQ(write_console_output)
995     obj_handle_t handle;        /* handle to the console output */
996     int          x;             /* position where to start writing */
997     int          y;
998     int          mode;          /* char info (see below) */
999     int          wrap;          /* wrap around at end of line? */
1000     VARARG(data,bytes);         /* info to write */
1001 @REPLY
1002     int          written;       /* number of char infos actually written */
1003     int          width;         /* width of screen buffer */
1004     int          height;        /* height of screen buffer */
1005 @END
1006 enum char_info_mode
1007 {
1008     CHAR_INFO_MODE_TEXT,        /* characters only */
1009     CHAR_INFO_MODE_ATTR,        /* attributes only */
1010     CHAR_INFO_MODE_TEXTATTR,    /* both characters and attributes */
1011     CHAR_INFO_MODE_TEXTSTDATTR  /* characters but use standard attributes */
1012 };
1013
1014
1015 /* fill a screen buffer with constant data (chars and/or attributes) */
1016 @REQ(fill_console_output)
1017     obj_handle_t handle;        /* handle to the console output */
1018     int          x;             /* position where to start writing */
1019     int          y;
1020     int          mode;          /* char info mode */
1021     int          count;         /* number to write */
1022     int          wrap;          /* wrap around at end of line? */
1023     char_info_t  data;          /* data to write */
1024 @REPLY
1025     int          written;       /* number of char infos actually written */
1026 @END
1027
1028
1029 /* read data (chars and/or attributes) from a screen buffer */
1030 @REQ(read_console_output)
1031     obj_handle_t handle;        /* handle to the console output */
1032     int          x;             /* position (x,y) where to start reading */
1033     int          y;
1034     int          mode;          /* char info mode */
1035     int          wrap;          /* wrap around at end of line? */
1036 @REPLY
1037     int          width;         /* width of screen buffer */
1038     int          height;        /* height of screen buffer */
1039     VARARG(data,bytes);
1040 @END
1041
1042
1043 /* move a rect (of data) in screen buffer content */
1044 @REQ(move_console_output)
1045     obj_handle_t handle;        /* handle to the console output */
1046     short int    x_src;         /* position (x, y) of rect to start moving from */
1047     short int    y_src;
1048     short int    x_dst;         /* position (x, y) of rect to move to */
1049     short int    y_dst;
1050     short int    w;             /* size of the rect (width, height) to move */
1051     short int    h;
1052 @END
1053
1054
1055 /* Sends a signal to a process group */
1056 @REQ(send_console_signal)
1057     int          signal;        /* the signal to send */
1058     process_id_t group_id;      /* the group to send the signal to */
1059 @END
1060
1061
1062 /* Create a change notification */
1063 @REQ(create_change_notification)
1064     obj_handle_t handle;        /* handle to the directory */
1065     int          subtree;       /* watch all the subtree */
1066     unsigned int filter;        /* notification filter */
1067 @REPLY
1068     obj_handle_t handle;        /* handle to the change notification */
1069 @END
1070
1071
1072 /* Move to the next change notification */
1073 @REQ(next_change_notification)
1074     obj_handle_t handle;        /* handle to the change notification */
1075 @END
1076
1077 /* Create a file mapping */
1078 @REQ(create_mapping)
1079     int          size_high;     /* mapping size */
1080     int          size_low;      /* mapping size */
1081     int          protect;       /* protection flags (see below) */
1082     unsigned int access;        /* wanted access rights */
1083     int          inherit;       /* inherit flag */
1084     obj_handle_t file_handle;   /* file handle */
1085     VARARG(name,unicode_str);   /* object name */
1086 @REPLY
1087     obj_handle_t handle;        /* handle to the mapping */
1088 @END
1089 /* protection flags */
1090 #define VPROT_READ       0x01
1091 #define VPROT_WRITE      0x02
1092 #define VPROT_EXEC       0x04
1093 #define VPROT_WRITECOPY  0x08
1094 #define VPROT_GUARD      0x10
1095 #define VPROT_NOCACHE    0x20
1096 #define VPROT_COMMITTED  0x40
1097 #define VPROT_IMAGE      0x80
1098
1099
1100 /* Open a mapping */
1101 @REQ(open_mapping)
1102     unsigned int access;        /* wanted access rights */
1103     int          inherit;       /* inherit flag */
1104     VARARG(name,unicode_str);   /* object name */
1105 @REPLY
1106     obj_handle_t handle;        /* handle to the mapping */
1107 @END
1108
1109
1110 /* Get information about a file mapping */
1111 @REQ(get_mapping_info)
1112     obj_handle_t handle;        /* handle to the mapping */
1113 @REPLY
1114     int          size_high;     /* mapping size */
1115     int          size_low;      /* mapping size */
1116     int          protect;       /* protection flags */
1117     int          header_size;   /* header size (for VPROT_IMAGE mapping) */
1118     void*        base;          /* default base addr (for VPROT_IMAGE mapping) */
1119     obj_handle_t shared_file;   /* shared mapping file handle */
1120     int          shared_size;   /* shared mapping size */
1121     int          drive_type;    /* type of drive the file is on */
1122 @END
1123
1124
1125 /* Create a device */
1126 @REQ(create_device)
1127     unsigned int access;        /* wanted access rights */
1128     int          inherit;       /* inherit flag */
1129     int          id;            /* client private id */
1130 @REPLY
1131     obj_handle_t handle;        /* handle to the device */
1132 @END
1133
1134
1135 /* Retrieve the client private id for a device */
1136 @REQ(get_device_id)
1137     obj_handle_t handle;        /* handle to the device */
1138 @REPLY
1139     int          id;            /* client private id */
1140 @END
1141
1142
1143 #define SNAP_HEAPLIST   0x00000001
1144 #define SNAP_PROCESS    0x00000002
1145 #define SNAP_THREAD     0x00000004
1146 #define SNAP_MODULE     0x00000008
1147 /* Create a snapshot */
1148 @REQ(create_snapshot)
1149     int          inherit;       /* inherit flag */
1150     int          flags;         /* snapshot flags (SNAP_*) */
1151     process_id_t pid;           /* process id */
1152 @REPLY
1153     obj_handle_t handle;        /* handle to the snapshot */
1154 @END
1155
1156
1157 /* Get the next process from a snapshot */
1158 @REQ(next_process)
1159     obj_handle_t handle;        /* handle to the snapshot */
1160     int          reset;         /* reset snapshot position? */
1161 @REPLY
1162     int          count;         /* process usage count */
1163     process_id_t pid;           /* process id */
1164     process_id_t ppid;          /* parent process id */
1165     void*        heap;          /* heap base */
1166     void*        module;        /* main module */
1167     int          threads;       /* number of threads */
1168     int          priority;      /* process priority */
1169     VARARG(filename,string);    /* file name of main exe */
1170 @END
1171
1172
1173 /* Get the next thread from a snapshot */
1174 @REQ(next_thread)
1175     obj_handle_t handle;        /* handle to the snapshot */
1176     int          reset;         /* reset snapshot position? */
1177 @REPLY
1178     int          count;         /* thread usage count */
1179     process_id_t pid;           /* process id */
1180     thread_id_t  tid;           /* thread id */
1181     int          base_pri;      /* base priority */
1182     int          delta_pri;     /* delta priority */
1183 @END
1184
1185
1186 /* Get the next module from a snapshot */
1187 @REQ(next_module)
1188     obj_handle_t handle;        /* handle to the snapshot */
1189     int          reset;         /* reset snapshot position? */
1190 @REPLY
1191     process_id_t pid;           /* process id */
1192     void*        base;          /* module base address */
1193     size_t       size;          /* module size */
1194     VARARG(filename,string);    /* file name of module */
1195 @END
1196
1197
1198 /* Wait for a debug event */
1199 @REQ(wait_debug_event)
1200     int           get_handle;  /* should we alloc a handle for waiting? */
1201 @REPLY
1202     process_id_t  pid;         /* process id */
1203     thread_id_t   tid;         /* thread id */
1204     obj_handle_t  wait;        /* wait handle if no event ready */
1205     VARARG(event,debug_event); /* debug event data */
1206 @END
1207
1208
1209 /* Queue an exception event */
1210 @REQ(queue_exception_event)
1211     int              first;    /* first chance exception? */
1212     VARARG(record,exc_event);  /* thread context followed by exception record */
1213 @REPLY
1214     obj_handle_t     handle;   /* handle to the queued event */
1215 @END
1216
1217
1218 /* Retrieve the status of an exception event */
1219 @REQ(get_exception_status)
1220     obj_handle_t     handle;   /* handle to the queued event */
1221 @REPLY
1222     int              status;   /* event continuation status */
1223     VARARG(context,context);   /* modified thread context */
1224 @END
1225
1226
1227 /* Send an output string to the debugger */
1228 @REQ(output_debug_string)
1229     void*         string;      /* string to display (in debugged process address space) */
1230     int           unicode;     /* is it Unicode? */
1231     int           length;      /* string length */
1232 @END
1233
1234
1235 /* Continue a debug event */
1236 @REQ(continue_debug_event)
1237     process_id_t pid;          /* process id to continue */
1238     thread_id_t  tid;          /* thread id to continue */
1239     int          status;       /* continuation status */
1240 @END
1241
1242
1243 /* Start/stop debugging an existing process */
1244 @REQ(debug_process)
1245     process_id_t pid;          /* id of the process to debug */
1246     int          attach;       /* 1=attaching / 0=detaching from the process */
1247 @END
1248
1249
1250 /* Simulate a breakpoint in a process */
1251 @REQ(debug_break)
1252     obj_handle_t handle;       /* process handle */
1253 @REPLY
1254     int          self;         /* was it the caller itself? */
1255 @END
1256
1257
1258 /* Set debugger kill on exit flag */
1259 @REQ(set_debugger_kill_on_exit)
1260     int          kill_on_exit;  /* 0=detach/1=kill debuggee when debugger dies */
1261 @END
1262
1263
1264 /* Read data from a process address space */
1265 @REQ(read_process_memory)
1266     obj_handle_t handle;       /* process handle */
1267     void*        addr;         /* addr to read from */
1268 @REPLY
1269     VARARG(data,bytes);        /* result data */
1270 @END
1271
1272
1273 /* Write data to a process address space */
1274 @REQ(write_process_memory)
1275     obj_handle_t handle;       /* process handle */
1276     void*        addr;         /* addr to write to (must be int-aligned) */
1277     unsigned int first_mask;   /* mask for first word */
1278     unsigned int last_mask;    /* mask for last word */
1279     VARARG(data,bytes);        /* data to write */
1280 @END
1281
1282
1283 /* Create a registry key */
1284 @REQ(create_key)
1285     obj_handle_t parent;       /* handle to the parent key */
1286     unsigned int access;       /* desired access rights */
1287     unsigned int options;      /* creation options */
1288     time_t       modif;        /* last modification time */
1289     size_t       namelen;      /* length of key name in bytes */
1290     VARARG(name,unicode_str,namelen);  /* key name */
1291     VARARG(class,unicode_str);         /* class name */
1292 @REPLY
1293     obj_handle_t hkey;         /* handle to the created key */
1294     int          created;      /* has it been newly created? */
1295 @END
1296
1297 /* Open a registry key */
1298 @REQ(open_key)
1299     obj_handle_t parent;       /* handle to the parent key */
1300     unsigned int access;       /* desired access rights */
1301     VARARG(name,unicode_str);  /* key name */
1302 @REPLY
1303     obj_handle_t hkey;         /* handle to the open key */
1304 @END
1305
1306
1307 /* Delete a registry key */
1308 @REQ(delete_key)
1309     obj_handle_t hkey;         /* handle to the key */
1310 @END
1311
1312
1313 /* Enumerate registry subkeys */
1314 @REQ(enum_key)
1315     obj_handle_t hkey;         /* handle to registry key */
1316     int          index;        /* index of subkey (or -1 for current key) */
1317     int          info_class;   /* requested information class */
1318 @REPLY
1319     int          subkeys;      /* number of subkeys */
1320     int          max_subkey;   /* longest subkey name */
1321     int          max_class;    /* longest class name */
1322     int          values;       /* number of values */
1323     int          max_value;    /* longest value name */
1324     int          max_data;     /* longest value data */
1325     time_t       modif;        /* last modification time */
1326     size_t       total;        /* total length needed for full name and class */
1327     size_t       namelen;      /* length of key name in bytes */
1328     VARARG(name,unicode_str,namelen);  /* key name */
1329     VARARG(class,unicode_str);         /* class name */
1330 @END
1331
1332
1333 /* Set a value of a registry key */
1334 @REQ(set_key_value)
1335     obj_handle_t hkey;         /* handle to registry key */
1336     int          type;         /* value type */
1337     size_t       namelen;      /* length of value name in bytes */
1338     VARARG(name,unicode_str,namelen);  /* value name */
1339     VARARG(data,bytes);                /* value data */
1340 @END
1341
1342
1343 /* Retrieve the value of a registry key */
1344 @REQ(get_key_value)
1345     obj_handle_t hkey;         /* handle to registry key */
1346     VARARG(name,unicode_str);  /* value name */
1347 @REPLY
1348     int          type;         /* value type */
1349     size_t       total;        /* total length needed for data */
1350     VARARG(data,bytes);        /* value data */
1351 @END
1352
1353
1354 /* Enumerate a value of a registry key */
1355 @REQ(enum_key_value)
1356     obj_handle_t hkey;         /* handle to registry key */
1357     int          index;        /* value index */
1358     int          info_class;   /* requested information class */
1359 @REPLY
1360     int          type;         /* value type */
1361     size_t       total;        /* total length needed for full name and data */
1362     size_t       namelen;      /* length of value name in bytes */
1363     VARARG(name,unicode_str,namelen);  /* value name */
1364     VARARG(data,bytes);                /* value data */
1365 @END
1366
1367
1368 /* Delete a value of a registry key */
1369 @REQ(delete_key_value)
1370     obj_handle_t hkey;         /* handle to registry key */
1371     VARARG(name,unicode_str);  /* value name */
1372 @END
1373
1374
1375 /* Load a registry branch from a file */
1376 @REQ(load_registry)
1377     obj_handle_t hkey;         /* root key to load to */
1378     obj_handle_t file;         /* file to load from */
1379     VARARG(name,unicode_str);  /* subkey name */
1380 @END
1381
1382
1383 /* Save a registry branch to a file */
1384 @REQ(save_registry)
1385     obj_handle_t hkey;         /* key to save */
1386     obj_handle_t file;         /* file to save to */
1387 @END
1388
1389
1390 /* Save a registry branch at server exit */
1391 @REQ(save_registry_atexit)
1392     obj_handle_t hkey;         /* key to save */
1393     VARARG(file,string);       /* file to save to */
1394 @END
1395
1396
1397 /* Set the current and saving level for the registry */
1398 @REQ(set_registry_levels)
1399     int          current;      /* new current level */
1400     int          saving;       /* new saving level */
1401     int          period;       /* duration between periodic saves (milliseconds) */
1402 @END
1403
1404
1405 @REQ(set_registry_notification)
1406     obj_handle_t hkey;         /* key to watch for changes */
1407     obj_handle_t event;        /* event to set */
1408     int          subtree;      /* should we watch the whole subtree? */
1409     unsigned int filter;       /* things to watch */
1410 @END
1411
1412
1413 /* Create a waitable timer */
1414 @REQ(create_timer)
1415     int          inherit;       /* inherit flag */
1416     int          manual;        /* manual reset */
1417     VARARG(name,unicode_str);   /* object name */
1418 @REPLY
1419     obj_handle_t handle;        /* handle to the timer */
1420 @END
1421
1422
1423 /* Open a waitable timer */
1424 @REQ(open_timer)
1425     unsigned int access;        /* wanted access rights */
1426     int          inherit;       /* inherit flag */
1427     VARARG(name,unicode_str);   /* object name */
1428 @REPLY
1429     obj_handle_t handle;        /* handle to the timer */
1430 @END
1431
1432 /* Set a waitable timer */
1433 @REQ(set_timer)
1434     obj_handle_t handle;        /* handle to the timer */
1435     abs_time_t   expire;        /* next expiration absolute time */
1436     int          period;        /* timer period in ms */
1437     void*        callback;      /* callback function */
1438     void*        arg;           /* callback argument */
1439 @END
1440
1441 /* Cancel a waitable timer */
1442 @REQ(cancel_timer)
1443     obj_handle_t handle;        /* handle to the timer */
1444 @END
1445
1446
1447 /* Retrieve the current context of a thread */
1448 @REQ(get_thread_context)
1449     obj_handle_t handle;       /* thread handle */
1450     unsigned int flags;        /* context flags */
1451 @REPLY
1452     VARARG(context,context);   /* thread context */
1453 @END
1454
1455
1456 /* Set the current context of a thread */
1457 @REQ(set_thread_context)
1458     obj_handle_t handle;       /* thread handle */
1459     unsigned int flags;        /* context flags */
1460     VARARG(context,context);   /* thread context */
1461 @END
1462
1463
1464 /* Fetch a selector entry for a thread */
1465 @REQ(get_selector_entry)
1466     obj_handle_t  handle;      /* thread handle */
1467     int           entry;       /* LDT entry */
1468 @REPLY
1469     unsigned int  base;        /* selector base */
1470     unsigned int  limit;       /* selector limit */
1471     unsigned char flags;       /* selector flags */
1472 @END
1473
1474
1475 /* Add an atom */
1476 @REQ(add_atom)
1477     int           local;       /* is atom in local process table? */
1478     VARARG(name,unicode_str);  /* atom name */
1479 @REPLY
1480     atom_t        atom;        /* resulting atom */
1481 @END
1482
1483
1484 /* Delete an atom */
1485 @REQ(delete_atom)
1486     atom_t        atom;        /* atom handle */
1487     int           local;       /* is atom in local process table? */
1488 @END
1489
1490
1491 /* Find an atom */
1492 @REQ(find_atom)
1493     int          local;        /* is atom in local process table? */
1494     VARARG(name,unicode_str);  /* atom name */
1495 @REPLY
1496     atom_t       atom;         /* atom handle */
1497 @END
1498
1499
1500 /* Get an atom name */
1501 @REQ(get_atom_name)
1502     atom_t       atom;         /* atom handle */
1503     int          local;        /* is atom in local process table? */
1504 @REPLY
1505     int          count;        /* atom lock count */
1506     VARARG(name,unicode_str);  /* atom name */
1507 @END
1508
1509
1510 /* Init the process atom table */
1511 @REQ(init_atom_table)
1512     int          entries;      /* number of entries */
1513 @END
1514
1515
1516 /* Get the message queue of the current thread */
1517 @REQ(get_msg_queue)
1518 @REPLY
1519     obj_handle_t handle;       /* handle to the queue */
1520 @END
1521
1522
1523 /* Set the current message queue wakeup mask */
1524 @REQ(set_queue_mask)
1525     unsigned int wake_mask;    /* wakeup bits mask */
1526     unsigned int changed_mask; /* changed bits mask */
1527     int          skip_wait;    /* will we skip waiting if signaled? */
1528 @REPLY
1529     unsigned int wake_bits;    /* current wake bits */
1530     unsigned int changed_bits; /* current changed bits */
1531 @END
1532
1533
1534 /* Get the current message queue status */
1535 @REQ(get_queue_status)
1536     int          clear;        /* should we clear the change bits? */
1537 @REPLY
1538     unsigned int wake_bits;    /* wake bits */
1539     unsigned int changed_bits; /* changed bits since last time */
1540 @END
1541
1542
1543 /* Wait for a process to start waiting on input */
1544 @REQ(wait_input_idle)
1545     obj_handle_t handle;       /* process handle */
1546     int          timeout;      /* timeout */
1547 @REPLY
1548     obj_handle_t event;        /* handle to idle event */
1549 @END
1550
1551
1552 /* Send a message to a thread queue */
1553 @REQ(send_message)
1554     thread_id_t     id;        /* thread id */
1555     int             type;      /* message type (see below) */
1556     user_handle_t   win;       /* window handle */
1557     unsigned int    msg;       /* message code */
1558     unsigned int    wparam;    /* parameters */
1559     unsigned int    lparam;    /* parameters */
1560     int             x;         /* x position */
1561     int             y;         /* y position */
1562     unsigned int    time;      /* message time */
1563     unsigned int    info;      /* extra info */
1564     int             timeout;   /* timeout for reply */
1565     VARARG(data,bytes);        /* message data for sent messages */
1566 @END
1567
1568 enum message_type
1569 {
1570     MSG_ASCII,          /* Ascii message (from SendMessageA) */
1571     MSG_UNICODE,        /* Unicode message (from SendMessageW) */
1572     MSG_NOTIFY,         /* notify message (from SendNotifyMessageW), always Unicode */
1573     MSG_CALLBACK,       /* callback message (from SendMessageCallbackW), always Unicode */
1574     MSG_OTHER_PROCESS,  /* sent from other process, may include vararg data, always Unicode */
1575     MSG_POSTED,         /* posted message (from PostMessageW), always Unicode */
1576     MSG_HARDWARE        /* hardware message */
1577 };
1578
1579
1580 /* Get a message from the current queue */
1581 @REQ(get_message)
1582     int             flags;     /* see below */
1583     user_handle_t   get_win;   /* window handle to get */
1584     unsigned int    get_first; /* first message code to get */
1585     unsigned int    get_last;  /* last message code to get */
1586 @REPLY
1587     int             type;      /* message type */
1588     user_handle_t   win;       /* window handle */
1589     unsigned int    msg;       /* message code */
1590     unsigned int    wparam;    /* parameters */
1591     unsigned int    lparam;    /* parameters */
1592     int             x;         /* x position */
1593     int             y;         /* y position */
1594     unsigned int    time;      /* message time */
1595     unsigned int    info;      /* extra info */
1596     size_t          total;     /* total size of extra data */
1597     VARARG(data,bytes);        /* message data for sent messages */
1598 @END
1599 #define GET_MSG_REMOVE      1  /* remove the message */
1600 #define GET_MSG_SENT_ONLY   2  /* only get sent messages */
1601
1602 /* Reply to a sent message */
1603 @REQ(reply_message)
1604     int             type;      /* type of original message */
1605     unsigned int    result;    /* message result */
1606     int             remove;    /* should we remove the message? */
1607     VARARG(data,bytes);        /* message data for sent messages */
1608 @END
1609
1610
1611 /* Retrieve the reply for the last message sent */
1612 @REQ(get_message_reply)
1613     int             cancel;    /* cancel message if not ready? */
1614 @REPLY
1615     unsigned int    result;    /* message result */
1616     VARARG(data,bytes);        /* message data for sent messages */
1617 @END
1618
1619
1620 /* Set a window timer */
1621 @REQ(set_win_timer)
1622     user_handle_t   win;       /* window handle */
1623     unsigned int    msg;       /* message to post */
1624     unsigned int    id;        /* timer id */
1625     unsigned int    rate;      /* timer rate in ms */
1626     unsigned int    lparam;    /* message lparam (callback proc) */
1627 @END
1628
1629
1630 /* Kill a window timer */
1631 @REQ(kill_win_timer)
1632     user_handle_t   win;       /* window handle */
1633     unsigned int    msg;       /* message to post */
1634     unsigned int    id;        /* timer id */
1635 @END
1636
1637
1638 /* Open a serial port */
1639 @REQ(create_serial)
1640     unsigned int access;       /* wanted access rights */
1641     int          inherit;      /* inherit flag */
1642     unsigned int attributes;   /* eg. FILE_FLAG_OVERLAPPED */
1643     unsigned int sharing;      /* sharing flags */
1644     VARARG(name,string);       /* file name */
1645 @REPLY
1646     obj_handle_t handle;       /* handle to the port */
1647 @END
1648
1649
1650 /* Retrieve info about a serial port */
1651 @REQ(get_serial_info)
1652     obj_handle_t handle;       /* handle to comm port */
1653 @REPLY
1654     unsigned int readinterval;
1655     unsigned int readconst;
1656     unsigned int readmult;
1657     unsigned int writeconst;
1658     unsigned int writemult;
1659     unsigned int eventmask;
1660     unsigned int commerror;
1661 @END
1662
1663
1664 /* Set info about a serial port */
1665 @REQ(set_serial_info)
1666     obj_handle_t handle;       /* handle to comm port */
1667     int          flags;        /* bitmask to set values (see below) */
1668     unsigned int readinterval;
1669     unsigned int readconst;
1670     unsigned int readmult;
1671     unsigned int writeconst;
1672     unsigned int writemult;
1673     unsigned int eventmask;
1674     unsigned int commerror;
1675 @END
1676 #define SERIALINFO_SET_TIMEOUTS  0x01
1677 #define SERIALINFO_SET_MASK      0x02
1678 #define SERIALINFO_SET_ERROR     0x04
1679
1680
1681 /* Create / reschedule an async I/O */
1682 @REQ(register_async)
1683     obj_handle_t handle;  /* handle to comm port, socket or file */
1684     int          type;
1685     void*        overlapped;
1686     int          count;
1687     unsigned int status;
1688 @END
1689 #define ASYNC_TYPE_NONE  0x00
1690 #define ASYNC_TYPE_READ  0x01
1691 #define ASYNC_TYPE_WRITE 0x02
1692 #define ASYNC_TYPE_WAIT  0x03
1693
1694
1695 /* Create a named pipe */
1696 @REQ(create_named_pipe)
1697     unsigned int   openmode;
1698     unsigned int   pipemode;
1699     unsigned int   maxinstances;
1700     unsigned int   outsize;
1701     unsigned int   insize;
1702     unsigned int   timeout;
1703     VARARG(name,unicode_str);    /* pipe name */
1704 @REPLY
1705     obj_handle_t   handle;       /* handle to the pipe */
1706 @END
1707
1708
1709 /* Open an existing named pipe */
1710 @REQ(open_named_pipe)
1711     unsigned int   access;
1712     VARARG(name,unicode_str);    /* pipe name */
1713 @REPLY
1714     obj_handle_t   handle;       /* handle to the pipe */
1715 @END
1716
1717
1718 /* Connect to a named pipe */
1719 @REQ(connect_named_pipe)
1720     obj_handle_t   handle;
1721     void*          overlapped;
1722     void*          func;
1723 @END
1724
1725
1726 /* Wait for a named pipe */
1727 @REQ(wait_named_pipe)
1728     unsigned int   timeout;
1729     void*          overlapped;
1730     void*          func;
1731     VARARG(name,unicode_str);    /* pipe name */
1732 @END
1733
1734
1735 /* Disconnect a named pipe */
1736 @REQ(disconnect_named_pipe)
1737     obj_handle_t   handle;
1738 @END
1739
1740
1741 @REQ(get_named_pipe_info)
1742     obj_handle_t   handle;
1743 @REPLY
1744     unsigned int   flags;
1745     unsigned int   maxinstances;
1746     unsigned int   outsize;
1747     unsigned int   insize;
1748 @END
1749
1750
1751 @REQ(create_smb)
1752     int            fd;
1753     unsigned int   tree_id;
1754     unsigned int   user_id;
1755     unsigned int   file_id;
1756     unsigned int   dialect;
1757 @REPLY
1758     obj_handle_t   handle;
1759 @END
1760
1761
1762 @REQ(get_smb_info)
1763     obj_handle_t   handle;
1764     unsigned int   flags;
1765     unsigned int   offset;
1766 @REPLY
1767     unsigned int   tree_id;
1768     unsigned int   user_id;
1769     unsigned int   dialect;
1770     unsigned int   file_id;
1771     unsigned int   offset;
1772 @END
1773 #define SMBINFO_SET_OFFSET    0x01
1774
1775
1776 /* Create a window */
1777 @REQ(create_window)
1778     user_handle_t  parent;      /* parent window */
1779     user_handle_t  owner;       /* owner window */
1780     atom_t         atom;        /* class atom */
1781 @REPLY
1782     user_handle_t  handle;      /* created window */
1783 @END
1784
1785
1786 /* Link a window into the tree */
1787 @REQ(link_window)
1788     user_handle_t  handle;      /* handle to the window */
1789     user_handle_t  parent;      /* handle to the parent */
1790     user_handle_t  previous;    /* previous child in Z-order */
1791 @REPLY
1792     user_handle_t  full_parent; /* full handle of new parent */
1793 @END
1794
1795
1796 /* Destroy a window */
1797 @REQ(destroy_window)
1798     user_handle_t  handle;      /* handle to the window */
1799 @END
1800
1801
1802 /* Set a window owner */
1803 @REQ(set_window_owner)
1804     user_handle_t  handle;      /* handle to the window */
1805     user_handle_t  owner;       /* new owner */
1806 @REPLY
1807     user_handle_t  full_owner;  /* full handle of new owner */
1808     user_handle_t  prev_owner;  /* full handle of previous owner */
1809 @END
1810
1811
1812 /* Get information from a window handle */
1813 @REQ(get_window_info)
1814     user_handle_t  handle;      /* handle to the window */
1815 @REPLY
1816     user_handle_t  full_handle; /* full 32-bit handle */
1817     user_handle_t  last_active; /* last active popup */
1818     process_id_t   pid;         /* process owning the window */
1819     thread_id_t    tid;         /* thread owning the window */
1820     atom_t         atom;        /* class atom */
1821 @END
1822
1823
1824 /* Set some information in a window */
1825 @REQ(set_window_info)
1826     user_handle_t  handle;        /* handle to the window */
1827     unsigned int   flags;         /* flags for fields to set (see below) */
1828     unsigned int   style;         /* window style */
1829     unsigned int   ex_style;      /* window extended style */
1830     unsigned int   id;            /* window id */
1831     void*          instance;      /* creator instance */
1832     void*          user_data;     /* user-specific data */
1833 @REPLY
1834     unsigned int   old_style;     /* old window style */
1835     unsigned int   old_ex_style;  /* old window extended style */
1836     unsigned int   old_id;        /* old window id */
1837     void*          old_instance;  /* old creator instance */
1838     void*          old_user_data; /* old user-specific data */
1839 @END
1840 #define SET_WIN_STYLE     0x01
1841 #define SET_WIN_EXSTYLE   0x02
1842 #define SET_WIN_ID        0x04
1843 #define SET_WIN_INSTANCE  0x08
1844 #define SET_WIN_USERDATA  0x10
1845
1846
1847 /* Get a list of the window parents, up to the root of the tree */
1848 @REQ(get_window_parents)
1849     user_handle_t  handle;        /* handle to the window */
1850 @REPLY
1851     int            count;         /* total count of parents */
1852     VARARG(parents,user_handles); /* parent handles */
1853 @END
1854
1855
1856 /* Get a list of the window children */
1857 @REQ(get_window_children)
1858     user_handle_t  parent;        /* parent window */
1859     atom_t         atom;          /* class atom for the listed children */
1860     thread_id_t    tid;           /* thread owning the listed children */
1861 @REPLY
1862     int            count;         /* total count of children */
1863     VARARG(children,user_handles); /* children handles */
1864 @END
1865
1866
1867 /* Get window tree information from a window handle */
1868 @REQ(get_window_tree)
1869     user_handle_t  handle;        /* handle to the window */
1870 @REPLY
1871     user_handle_t  parent;        /* parent window */
1872     user_handle_t  owner;         /* owner window */
1873     user_handle_t  next_sibling;  /* next sibling in Z-order */
1874     user_handle_t  prev_sibling;  /* prev sibling in Z-order */
1875     user_handle_t  first_sibling; /* first sibling in Z-order */
1876     user_handle_t  last_sibling;  /* last sibling in Z-order */
1877     user_handle_t  first_child;   /* first child */
1878     user_handle_t  last_child;    /* last child */
1879 @END
1880
1881 /* Set the window and client rectangles of a window */
1882 @REQ(set_window_rectangles)
1883     user_handle_t  handle;        /* handle to the window */
1884     rectangle_t    window;        /* window rectangle */
1885     rectangle_t    client;        /* client rectangle */
1886 @END
1887
1888
1889 /* Get the window and client rectangles of a window */
1890 @REQ(get_window_rectangles)
1891     user_handle_t  handle;        /* handle to the window */
1892 @REPLY
1893     rectangle_t    window;        /* window rectangle */
1894     rectangle_t    client;        /* client rectangle */
1895 @END
1896
1897
1898 /* Get the window text */
1899 @REQ(get_window_text)
1900     user_handle_t  handle;        /* handle to the window */
1901 @REPLY
1902     VARARG(text,unicode_str);     /* window text */
1903 @END
1904
1905
1906 /* Set the window text */
1907 @REQ(set_window_text)
1908     user_handle_t  handle;        /* handle to the window */
1909     VARARG(text,unicode_str);     /* window text */
1910 @END
1911
1912
1913 /* Increment the window paint count */
1914 @REQ(inc_window_paint_count)
1915     user_handle_t  handle;        /* handle to the window */
1916     int             incr;         /* increment (can be negative) */
1917 @END
1918
1919
1920 /* Get the coordinates offset between two windows */
1921 @REQ(get_windows_offset)
1922     user_handle_t  from;          /* handle to the first window */
1923     user_handle_t  to;            /* handle to the second window */
1924 @REPLY
1925     int            x;             /* x coordinate offset */
1926     int            y;             /* y coordinate offset */
1927 @END
1928
1929
1930 /* Set a window property */
1931 @REQ(set_window_property)
1932     user_handle_t  window;        /* handle to the window */
1933     atom_t         atom;          /* property atom (high-word set if it was a string) */
1934     int            string;        /* was atom a string originally? */
1935     obj_handle_t   handle;        /* handle to store */
1936 @END
1937
1938
1939 /* Remove a window property */
1940 @REQ(remove_window_property)
1941     user_handle_t  window;        /* handle to the window */
1942     atom_t         atom;          /* property atom */
1943 @REPLY
1944     obj_handle_t   handle;        /* handle stored in property */
1945 @END
1946
1947
1948 /* Get a window property */
1949 @REQ(get_window_property)
1950     user_handle_t  window;        /* handle to the window */
1951     atom_t         atom;          /* property atom */
1952 @REPLY
1953     obj_handle_t   handle;        /* handle stored in property */
1954 @END
1955
1956
1957 /* Get the list of properties of a window */
1958 @REQ(get_window_properties)
1959     user_handle_t  window;        /* handle to the window */
1960 @REPLY
1961     int            total;         /* total number of properties */
1962     VARARG(props,properties);     /* list of properties */
1963 @END
1964
1965
1966 /* Attach (or detach) thread inputs */
1967 @REQ(attach_thread_input)
1968     thread_id_t    tid_from;       /* thread to be attached */
1969     thread_id_t    tid_to;         /* thread to which tid_from should be attached */
1970     int            attach;         /* is it an attach? */
1971 @END
1972
1973
1974 /* Get input data for a given thread */
1975 @REQ(get_thread_input)
1976     thread_id_t    tid;           /* id of thread */
1977 @REPLY
1978     user_handle_t  focus;         /* handle to the focus window */
1979     user_handle_t  capture;       /* handle to the capture window */
1980     user_handle_t  active;        /* handle to the active window */
1981     user_handle_t  foreground;    /* handle to the global foreground window */
1982     user_handle_t  menu_owner;    /* handle to the menu owner */
1983     user_handle_t  move_size;     /* handle to the moving/resizing window */
1984     user_handle_t  caret;         /* handle to the caret window */
1985     rectangle_t    rect;          /* caret rectangle */
1986 @END
1987
1988 /* Retrieve queue keyboard state for a given thread */
1989 @REQ(get_key_state)
1990     thread_id_t    tid;           /* id of thread */
1991     int            key;           /* optional key code or -1 */
1992 @REPLY
1993     unsigned char  state;         /* state of specified key */
1994     VARARG(keystate,bytes);       /* state array for all the keys */
1995 @END
1996
1997 /* Set queue keyboard state for a given thread */
1998 @REQ(set_key_state)
1999     thread_id_t    tid;           /* id of thread */
2000     VARARG(keystate,bytes);       /* state array for all the keys */
2001 @END
2002
2003 /* Set the system foreground window */
2004 @REQ(set_foreground_window)
2005     user_handle_t  handle;        /* handle to the foreground window */
2006 @REPLY
2007     user_handle_t  previous;      /* handle to the previous foreground window */
2008     int            send_msg_old;  /* whether we have to send a msg to the old window */
2009     int            send_msg_new;  /* whether we have to send a msg to the new window */
2010 @END
2011
2012 /* Set the current thread focus window */
2013 @REQ(set_focus_window)
2014     user_handle_t  handle;        /* handle to the focus window */
2015 @REPLY
2016     user_handle_t  previous;      /* handle to the previous focus window */
2017 @END
2018
2019 /* Set the current thread active window */
2020 @REQ(set_active_window)
2021     user_handle_t  handle;        /* handle to the active window */
2022 @REPLY
2023     user_handle_t  previous;      /* handle to the previous active window */
2024 @END
2025
2026 /* Set the current thread capture window */
2027 @REQ(set_capture_window)
2028     user_handle_t  handle;        /* handle to the capture window */
2029     unsigned int   flags;         /* capture flags (see below) */
2030 @REPLY
2031     user_handle_t  previous;      /* handle to the previous capture window */
2032     user_handle_t  full_handle;   /* full 32-bit handle of new capture window */
2033 @END
2034 #define CAPTURE_MENU     0x01  /* capture is for a menu */
2035 #define CAPTURE_MOVESIZE 0x02  /* capture is for moving/resizing */
2036
2037
2038 /* Set the current thread caret window */
2039 @REQ(set_caret_window)
2040     user_handle_t  handle;        /* handle to the caret window */
2041     int            width;         /* caret width */
2042     int            height;        /* caret height */
2043 @REPLY
2044     user_handle_t  previous;      /* handle to the previous caret window */
2045     rectangle_t    old_rect;      /* previous caret rectangle */
2046     int            old_hide;      /* previous hide count */
2047     int            old_state;     /* previous caret state (1=on, 0=off) */
2048 @END
2049
2050
2051 /* Set the current thread caret information */
2052 @REQ(set_caret_info)
2053     unsigned int   flags;         /* caret flags (see below) */
2054     user_handle_t  handle;        /* handle to the caret window */
2055     int            x;             /* caret x position */
2056     int            y;             /* caret y position */
2057     int            hide;          /* increment for hide count (can be negative to show it) */
2058     int            state;         /* caret state (1=on, 0=off, -1=toggle current state) */
2059 @REPLY
2060     user_handle_t  full_handle;   /* handle to the current caret window */
2061     rectangle_t    old_rect;      /* previous caret rectangle */
2062     int            old_hide;      /* previous hide count */
2063     int            old_state;     /* previous caret state (1=on, 0=off) */
2064 @END
2065 #define SET_CARET_POS        0x01  /* set the caret position from x,y */
2066 #define SET_CARET_HIDE       0x02  /* increment the caret hide count */
2067 #define SET_CARET_STATE      0x04  /* set the caret on/off state */
2068
2069
2070 /* Set a window hook */
2071 @REQ(set_hook)
2072     int            id;             /* id of the hook */
2073     thread_id_t    tid;            /* id of thread to set the hook into */
2074     void*          proc;           /* hook procedure */
2075     int            unicode;        /* is it a unicode hook? */
2076     VARARG(module,unicode_str);    /* module name */
2077 @REPLY
2078     user_handle_t  handle;         /* handle to the hook */
2079 @END
2080
2081
2082 /* Remove a window hook */
2083 @REQ(remove_hook)
2084     user_handle_t  handle;         /* handle to the hook */
2085     int            id;             /* id of the hook if handle is 0 */
2086     void*          proc;           /* hook procedure if handle is 0 */
2087 @END
2088
2089
2090 /* Start calling a hook chain */
2091 @REQ(start_hook_chain)
2092     int            id;             /* id of the hook */
2093 @REPLY
2094     user_handle_t  handle;         /* handle to the next hook */
2095     void*          proc;           /* hook procedure */
2096     int            unicode;        /* is it a unicode hook? */
2097     VARARG(module,unicode_str);    /* module name */
2098 @END
2099
2100
2101 /* Finished calling a hook chain */
2102 @REQ(finish_hook_chain)
2103     int            id;             /* id of the hook */
2104 @END
2105
2106
2107 /* Get the next hook to call */
2108 @REQ(get_next_hook)
2109     user_handle_t  handle;         /* handle to the current hook */
2110 @REPLY
2111     user_handle_t  next;           /* handle to the next hook */
2112     int            id;             /* id of the next hook */
2113     void*          proc;           /* next hook procedure */
2114     int            prev_unicode;   /* was the previous a unicode hook? */
2115     int            next_unicode;   /* is the next a unicode hook? */
2116     VARARG(module,unicode_str);    /* module name */
2117 @END