hlink: Add hlguids.h (based on a patch by Aric Stewart).
[wine] / include / wine / server.h
1 /*
2  * Definitions for the client side of the Wine server communication
3  *
4  * Copyright (C) 1998 Alexandre Julliard
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20
21 #ifndef __WINE_WINE_SERVER_H
22 #define __WINE_WINE_SERVER_H
23
24 #include <stdarg.h>
25 #include <windef.h>
26 #include <winbase.h>
27 #include <winternl.h>
28 #include <wine/server_protocol.h>
29
30 /* client communication functions */
31
32 struct __server_iovec
33 {
34     const void  *ptr;
35     unsigned int size;
36 };
37
38 #define __SERVER_MAX_DATA 5
39
40 struct __server_request_info
41 {
42     union
43     {
44         union generic_request req;    /* request structure */
45         union generic_reply   reply;  /* reply structure */
46     } u;
47     unsigned int          data_count; /* count of request data pointers */
48     void                 *reply_data; /* reply data pointer */
49     struct __server_iovec data[__SERVER_MAX_DATA];  /* request variable size data */
50 };
51
52 extern unsigned int wine_server_call( void *req_ptr );
53 extern void wine_server_send_fd( int fd );
54 extern int wine_server_fd_to_handle( int fd, unsigned int access, unsigned int attributes, obj_handle_t *handle );
55 extern int wine_server_handle_to_fd( obj_handle_t handle, unsigned int access, int *unix_fd, int *flags );
56 extern void wine_server_release_fd( obj_handle_t handle, int unix_fd );
57
58 /* do a server call and set the last error code */
59 inline static unsigned int wine_server_call_err( void *req_ptr )
60 {
61     unsigned int res = wine_server_call( req_ptr );
62     if (res) SetLastError( RtlNtStatusToDosError(res) );
63     return res;
64 }
65
66 /* get the size of the variable part of the returned reply */
67 inline static size_t wine_server_reply_size( const void *reply )
68 {
69     return ((const struct reply_header *)reply)->reply_size;
70 }
71
72 /* add some data to be sent along with the request */
73 inline static void wine_server_add_data( void *req_ptr, const void *ptr, unsigned int size )
74 {
75     struct __server_request_info * const req = req_ptr;
76     if (size)
77     {
78         req->data[req->data_count].ptr = ptr;
79         req->data[req->data_count++].size = size;
80         req->u.req.request_header.request_size += size;
81     }
82 }
83
84 /* set the pointer and max size for the reply var data */
85 inline static void wine_server_set_reply( void *req_ptr, void *ptr, unsigned int max_size )
86 {
87     struct __server_request_info * const req = req_ptr;
88     req->reply_data = ptr;
89     req->u.req.request_header.reply_size = max_size;
90 }
91
92
93 /* macros for server requests */
94
95 #define SERVER_START_REQ(type) \
96     do { \
97         struct __server_request_info __req; \
98         struct type##_request * const req = &__req.u.req.type##_request; \
99         const struct type##_reply * const reply = &__req.u.reply.type##_reply; \
100         memset( &__req.u.req, 0, sizeof(__req.u.req) ); \
101         __req.u.req.request_header.req = REQ_##type; \
102         __req.data_count = 0; \
103         (void)reply; \
104         do
105
106 #define SERVER_END_REQ \
107         while(0); \
108     } while(0)
109
110
111 #endif  /* __WINE_WINE_SERVER_H */