widl: Fix detection of complex arrays.
[wine] / tools / widl / server.c
1 /*
2  * IDL Compiler
3  *
4  * Copyright 2005-2006 Eric Kohl
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 #include "config.h"
22 #include "wine/port.h"
23
24 #include <stdio.h>
25 #include <stdlib.h>
26 #ifdef HAVE_UNISTD_H
27 # include <unistd.h>
28 #endif
29 #include <string.h>
30 #include <assert.h>
31 #include <ctype.h>
32 #include <signal.h>
33
34 #include "widl.h"
35 #include "utils.h"
36 #include "parser.h"
37 #include "header.h"
38 #include "windef.h"
39
40 #include "widl.h"
41 #include "typelib.h"
42 #include "typelib_struct.h"
43 #include "typegen.h"
44
45 static FILE* server;
46 static int indent = 0;
47
48
49 static void print_server(const char *format, ...)
50 {
51     va_list va;
52     va_start(va, format);
53     print(server, indent, format, va);
54     va_end(va);
55 }
56
57 static void write_function_stubs(type_t *iface, unsigned int *proc_offset)
58 {
59     char *implicit_handle = get_attrp(iface->attrs, ATTR_IMPLICIT_HANDLE);
60     int explicit_handle = is_attr(iface->attrs, ATTR_EXPLICIT_HANDLE);
61     const func_t *func;
62     const var_t *var;
63     const var_t* explicit_handle_var;
64
65     if (!iface->funcs) return;
66     LIST_FOR_EACH_ENTRY( func, iface->funcs, const func_t, entry )
67     {
68         const var_t *def = func->def;
69
70         /* check for a defined binding handle */
71         explicit_handle_var = get_explicit_handle_var(func);
72         if (explicit_handle)
73         {
74             if (!explicit_handle_var)
75             {
76                 error("%s() does not define an explicit binding handle!\n", def->name);
77                 return;
78             }
79         }
80         else if (implicit_handle)
81         {
82             if (explicit_handle_var)
83             {
84                 error("%s() must not define a binding handle!\n", def->name);
85                 return;
86             }
87         }
88
89         fprintf(server, "void __RPC_STUB\n");
90         fprintf(server, "%s_", iface->name);
91         write_name(server, def);
92         fprintf(server, "(\n");
93         indent++;
94         print_server("PRPC_MESSAGE _pRpcMessage)\n");
95         indent--;
96
97         /* write the functions body */
98         fprintf(server, "{\n");
99         indent++;
100
101         /* Declare arguments */
102         declare_stub_args(server, indent, func);
103
104         print_server("MIDL_STUB_MESSAGE _StubMsg;\n");
105         print_server("RPC_STATUS _Status;\n");
106         fprintf(server, "\n");
107
108
109         print_server("((void)(_Status));\n");
110         print_server("NdrServerInitializeNew(\n");
111         indent++;
112         print_server("_pRpcMessage,\n");
113         print_server("&_StubMsg,\n");
114         print_server("&%s_StubDesc);\n", iface->name);
115         indent--;
116         fprintf(server, "\n");
117
118         write_parameters_init(server, indent, func);
119
120         if (explicit_handle_var)
121         {
122             print_server("%s = _pRpcMessage->Handle;\n", explicit_handle_var->name);
123             fprintf(server, "\n");
124         }
125
126         print_server("RpcTryFinally\n");
127         print_server("{\n");
128         indent++;
129         print_server("RpcTryExcept\n");
130         print_server("{\n");
131         indent++;
132
133         if (func->args)
134         {
135             print_server("if ((_pRpcMessage->DataRepresentation & 0x0000FFFFUL) != NDR_LOCAL_DATA_REPRESENTATION)\n");
136             indent++;
137             print_server("NdrConvert(\n");
138             indent++;
139             print_server("(PMIDL_STUB_MESSAGE)&_StubMsg,\n");
140             print_server("(PFORMAT_STRING)&__MIDL_ProcFormatString.Format[%u]);\n", *proc_offset);
141             indent -= 2;
142             fprintf(server, "\n");
143
144             /* unmarshall arguments */
145             write_remoting_arguments(server, indent, func, PASS_IN, PHASE_UNMARSHAL);
146         }
147
148         print_server("if (_StubMsg.Buffer > _StubMsg.BufferEnd)\n");
149         print_server("{\n");
150         indent++;
151         print_server("RpcRaiseException(RPC_X_BAD_STUB_DATA);\n");
152         indent--;
153         print_server("}\n");
154         indent--;
155         print_server("}\n");
156         print_server("RpcExcept(RPC_BAD_STUB_DATA_EXCEPTION_FILTER)\n");
157         print_server("{\n");
158         indent++;
159         print_server("RpcRaiseException(RPC_X_BAD_STUB_DATA);\n");
160         indent--;
161         print_server("}\n");
162         print_server("RpcEndExcept\n");
163         fprintf(server, "\n");
164
165         /* Assign 'out' arguments */
166         assign_stub_out_args(server, indent, func);
167
168         /* Call the real server function */
169         if (!is_void(def->type))
170             print_server("_RetVal = ");
171         else
172             print_server("");
173         write_prefix_name(server, prefix_server, def);
174
175         if (func->args)
176         {
177             int first_arg = 1;
178
179             fprintf(server, "(\n");
180             indent++;
181             LIST_FOR_EACH_ENTRY( var, func->args, const var_t, entry )
182             {
183                 if (first_arg)
184                     first_arg = 0;
185                 else
186                     fprintf(server, ",\n");
187                 print_server("");
188                 if (var->type->declarray)
189                     fprintf(server, "*");
190                 write_name(server, var);
191             }
192             fprintf(server, ");\n");
193             indent--;
194         }
195         else
196         {
197             fprintf(server, "();\n");
198         }
199
200         if (has_out_arg_or_return(func))
201         {
202             write_remoting_arguments(server, indent, func, PASS_OUT, PHASE_BUFFERSIZE);
203
204             print_server("_pRpcMessage->BufferLength = _StubMsg.BufferLength;\n");
205             fprintf(server, "\n");
206             print_server("_Status = I_RpcGetBuffer(_pRpcMessage);\n");
207             print_server("if (_Status)\n");
208             indent++;
209             print_server("RpcRaiseException(_Status);\n");
210             indent--;
211             fprintf(server, "\n");
212             print_server("_StubMsg.Buffer = (unsigned char *)_pRpcMessage->Buffer;\n");
213             fprintf(server, "\n");
214         }
215
216         /* marshall arguments */
217         write_remoting_arguments(server, indent, func, PASS_OUT, PHASE_MARSHAL);
218
219         /* marshall the return value */
220         if (!is_void(def->type))
221             print_phase_basetype(server, indent, PHASE_MARSHAL, PASS_RETURN, def, "_RetVal");
222
223         indent--;
224         print_server("}\n");
225         print_server("RpcFinally\n");
226         print_server("{\n");
227         indent++;
228
229         write_remoting_arguments(server, indent, func, PASS_OUT, PHASE_FREE);
230
231         indent--;
232         print_server("}\n");
233         print_server("RpcEndFinally\n");
234
235         /* calculate buffer length */
236         fprintf(server, "\n");
237         print_server("_pRpcMessage->BufferLength =\n");
238         indent++;
239         print_server("(unsigned int)(_StubMsg.Buffer - (unsigned char *)_pRpcMessage->Buffer);\n");
240         indent--;
241         indent--;
242         fprintf(server, "}\n");
243         fprintf(server, "\n");
244
245         /* update proc_offset */
246         *proc_offset += get_size_procformatstring_func( func );
247     }
248 }
249
250
251 static void write_dispatchtable(type_t *iface)
252 {
253     unsigned long ver = get_attrv(iface->attrs, ATTR_VERSION);
254     unsigned long method_count = 0;
255     const func_t *func;
256
257     print_server("static RPC_DISPATCH_FUNCTION %s_table[] =\n", iface->name);
258     print_server("{\n");
259     indent++;
260
261     if (iface->funcs) LIST_FOR_EACH_ENTRY( func, iface->funcs, const func_t, entry )
262     {
263         var_t *def = func->def;
264
265         print_server("%s_", iface->name);
266         write_name(server, def);
267         fprintf(server, ",\n");
268
269         method_count++;
270     }
271     print_server("0\n");
272     indent--;
273     print_server("};\n");
274     print_server("RPC_DISPATCH_TABLE %s_v%d_%d_DispatchTable =\n", iface->name, LOWORD(ver), HIWORD(ver));
275     print_server("{\n");
276     indent++;
277     print_server("%u,\n", method_count);
278     print_server("%s_table\n", iface->name);
279     indent--;
280     print_server("};\n");
281     fprintf(server, "\n");
282 }
283
284
285 static void write_stubdescdecl(type_t *iface)
286 {
287     print_server("static const MIDL_STUB_DESC %s_StubDesc;\n", iface->name);
288     fprintf(server, "\n");
289 }
290
291
292 static void write_stubdescriptor(type_t *iface, int expr_eval_routines)
293 {
294     print_server("static const MIDL_STUB_DESC %s_StubDesc =\n", iface->name);
295     print_server("{\n");
296     indent++;
297     print_server("(void *)& %s___RpcServerInterface,\n", iface->name);
298     print_server("MIDL_user_allocate,\n");
299     print_server("MIDL_user_free,\n");
300     print_server("{\n");
301     indent++;
302     print_server("0,\n");
303     indent--;
304     print_server("},\n");
305     print_server("0,\n");
306     print_server("0,\n");
307     if (expr_eval_routines)
308         print_server("ExprEvalRoutines,\n");
309     else
310         print_server("0,\n");
311     print_server("0,\n");
312     print_server("__MIDL_TypeFormatString.Format,\n");
313     print_server("1, /* -error bounds_check flag */\n");
314     print_server("0x10001, /* Ndr library version */\n");
315     print_server("0,\n");
316     print_server("0x50100a4, /* MIDL Version 5.1.164 */\n");
317     print_server("0,\n");
318     print_server("%s,\n", list_empty(&user_type_list) ? "0" : "UserMarshalRoutines");
319     print_server("0,  /* notify & notify_flag routine table */\n");
320     print_server("1,  /* Flags */\n");
321     print_server("0,  /* Reserved3 */\n");
322     print_server("0,  /* Reserved4 */\n");
323     print_server("0   /* Reserved5 */\n");
324     indent--;
325     print_server("};\n");
326     fprintf(server, "\n");
327 }
328
329
330 static void write_serverinterfacedecl(type_t *iface)
331 {
332     unsigned long ver = get_attrv(iface->attrs, ATTR_VERSION);
333     UUID *uuid = get_attrp(iface->attrs, ATTR_UUID);
334     const str_list_t *endpoints = get_attrp(iface->attrs, ATTR_ENDPOINT);
335
336     if (endpoints) write_endpoints( server, iface->name, endpoints );
337
338     print_server("extern RPC_DISPATCH_TABLE %s_v%d_%d_DispatchTable;\n", iface->name, LOWORD(ver), HIWORD(ver));
339     fprintf(server, "\n");
340     print_server("static const RPC_SERVER_INTERFACE %s___RpcServerInterface =\n", iface->name );
341     print_server("{\n");
342     indent++;
343     print_server("sizeof(RPC_SERVER_INTERFACE),\n");
344     print_server("{{0x%08lx,0x%04x,0x%04x,{0x%02x,0x%02x,0x%02x,0x%02x,0x%02x,0x%02x,0x%02x,0x%02x}},{%d,%d}},\n",
345                  uuid->Data1, uuid->Data2, uuid->Data3, uuid->Data4[0], uuid->Data4[1],
346                  uuid->Data4[2], uuid->Data4[3], uuid->Data4[4], uuid->Data4[5], uuid->Data4[6],
347                  uuid->Data4[7], LOWORD(ver), HIWORD(ver));
348     print_server("{{0x8a885d04,0x1ceb,0x11c9,{0x9f,0xe8,0x08,0x00,0x2b,0x10,0x48,0x60}},{2,0}},\n"); /* FIXME */
349     print_server("&%s_v%d_%d_DispatchTable,\n", iface->name, LOWORD(ver), HIWORD(ver));
350     if (endpoints)
351     {
352         print_server("%u,\n", list_count(endpoints));
353         print_server("(PRPC_PROTSEQ_ENDPOINT)%s__RpcProtseqEndpoint,\n", iface->name);
354     }
355     else
356     {
357         print_server("0,\n");
358         print_server("0,\n");
359     }
360     print_server("0,\n");
361     print_server("0,\n");
362     print_server("0,\n");
363     indent--;
364     print_server("};\n");
365     if (old_names)
366         print_server("RPC_IF_HANDLE %s_ServerIfHandle = (RPC_IF_HANDLE)& %s___RpcServerInterface;\n",
367                      iface->name, iface->name);
368     else
369         print_server("RPC_IF_HANDLE %s%s_v%d_%d_s_ifspec = (RPC_IF_HANDLE)& %s___RpcServerInterface;\n",
370                      prefix_server, iface->name, LOWORD(ver), HIWORD(ver), iface->name);
371     fprintf(server, "\n");
372 }
373
374
375 static void init_server(void)
376 {
377     if (server)
378         return;
379     if (!(server = fopen(server_name, "w")))
380         error("Could not open %s for output\n", server_name);
381
382     print_server("/*** Autogenerated by WIDL %s from %s - Do not edit ***/\n", PACKAGE_VERSION, input_name);
383     print_server("#include <string.h>\n");
384     fprintf(server, "\n");
385     print_server("#include \"%s\"\n", header_name);
386     fprintf(server, "\n");
387 }
388
389
390 void write_server(ifref_list_t *ifaces)
391 {
392     unsigned int proc_offset = 0;
393     ifref_t *iface;
394
395     if (!do_server)
396         return;
397     if (do_everything && !ifaces)
398         return;
399
400     init_server();
401     if (!server)
402         return;
403
404     write_formatstringsdecl(server, indent, ifaces, 0);
405
406     if (ifaces) LIST_FOR_EACH_ENTRY( iface, ifaces, ifref_t, entry )
407     {
408         if (is_object(iface->iface->attrs) || is_local(iface->iface->attrs))
409             continue;
410
411         fprintf(server, "/*****************************************************************************\n");
412         fprintf(server, " * %s interface\n", iface->iface->name);
413         fprintf(server, " */\n");
414         fprintf(server, "\n");
415
416         if (iface->iface->funcs)
417         {
418             int expr_eval_routines;
419
420             write_serverinterfacedecl(iface->iface);
421             write_stubdescdecl(iface->iface);
422     
423             write_function_stubs(iface->iface, &proc_offset);
424     
425             print_server("#if !defined(__RPC_WIN32__)\n");
426             print_server("#error  Invalid build platform for this stub.\n");
427             print_server("#endif\n");
428
429             fprintf(server, "\n");
430
431             expr_eval_routines = write_expr_eval_routines(server, iface->iface->name);
432             if (expr_eval_routines)
433                 write_expr_eval_routine_list(server, iface->iface->name);
434
435             write_user_quad_list(server);
436             write_stubdescriptor(iface->iface, expr_eval_routines);
437             write_dispatchtable(iface->iface);
438         }
439     }
440
441     fprintf(server, "\n");
442
443     write_procformatstring(server, ifaces, 0);
444     write_typeformatstring(server, ifaces, 0);
445
446     fclose(server);
447 }