winevulkan: Update to VK spec version 1.2.188.
[wine.git] / tools / widl / client.c
blob6ecae4187d3167d96ca90cd2214b582a4eb12487
1 /*
2 * IDL Compiler
4 * Copyright 2005-2006 Eric Kohl
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21 #include "config.h"
22 #include "wine/port.h"
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 <ctype.h>
32 #include "widl.h"
33 #include "utils.h"
34 #include "parser.h"
35 #include "header.h"
37 #include "widltypes.h"
38 #include "typegen.h"
39 #include "expr.h"
41 static FILE* client;
42 static int indent = 0;
44 static void print_client( const char *format, ... ) __attribute__((format (printf, 1, 2)));
45 static void print_client( const char *format, ... )
47 va_list va;
48 va_start(va, format);
49 print(client, indent, format, va);
50 va_end(va);
53 static void write_client_func_decl( const type_t *iface, const var_t *func )
55 const char *callconv = get_attrp(func->declspec.type->attrs, ATTR_CALLCONV);
56 const var_list_t *args = type_function_get_args(func->declspec.type);
57 const decl_spec_t *rettype = type_function_get_ret(func->declspec.type);
59 if (!callconv) callconv = "__cdecl";
60 write_type_decl_left(client, rettype);
61 fprintf(client, " %s ", callconv);
62 fprintf(client, "%s%s(\n", prefix_client, get_name(func));
63 indent++;
64 if (args) write_args(client, args, iface->name, 0, TRUE, NAME_DEFAULT);
65 else
66 print_client("void");
67 fprintf(client, ")\n");
68 indent--;
71 static void write_function_stub( const type_t *iface, const var_t *func,
72 int method_count, unsigned int proc_offset )
74 unsigned char explicit_fc, implicit_fc;
75 int has_full_pointer = is_full_pointer_function(func);
76 var_t *retval = type_function_get_retval(func->declspec.type);
77 const var_t *handle_var = get_func_handle_var( iface, func, &explicit_fc, &implicit_fc );
78 int has_ret = !is_void(retval->declspec.type);
80 if (is_interpreted_func( iface, func ))
82 write_client_func_decl( iface, func );
83 write_client_call_routine( client, iface, func, iface->name, proc_offset );
84 return;
87 print_client( "struct __frame_%s%s\n{\n", prefix_client, get_name(func) );
88 indent++;
89 print_client( "__DECL_EXCEPTION_FRAME\n" );
90 print_client("MIDL_STUB_MESSAGE _StubMsg;\n");
91 if (handle_var)
93 if (explicit_fc == FC_BIND_GENERIC)
94 print_client("%s %s;\n",
95 get_explicit_generic_handle_type(handle_var)->name, handle_var->name );
96 print_client("RPC_BINDING_HANDLE _Handle;\n");
99 if (has_ret && decl_indirect(retval->declspec.type))
101 print_client("void *_p_%s;\n", retval->name);
103 indent--;
104 print_client( "};\n\n" );
106 print_client( "static void __finally_%s%s(", prefix_client, get_name(func) );
107 print_client( " struct __frame_%s%s *__frame )\n{\n", prefix_client, get_name(func) );
108 indent++;
110 if (has_full_pointer)
111 write_full_pointer_free(client, indent, func);
113 print_client("NdrFreeBuffer(&__frame->_StubMsg);\n");
115 if (explicit_fc == FC_BIND_GENERIC)
117 fprintf(client, "\n");
118 print_client("if (__frame->_Handle)\n");
119 indent++;
120 print_client("%s_unbind(__frame->%s, __frame->_Handle);\n",
121 get_explicit_generic_handle_type(handle_var)->name, handle_var->name);
122 indent--;
124 indent--;
125 print_client( "}\n\n" );
127 write_client_func_decl( iface, func );
129 /* write the functions body */
130 fprintf(client, "{\n");
131 indent++;
132 print_client( "struct __frame_%s%s __f, * const __frame = &__f;\n", prefix_client, get_name(func) );
134 /* declare return value */
135 if (has_ret)
137 print_client("%s", "");
138 write_type_decl(client, &retval->declspec, retval->name);
139 fprintf(client, ";\n");
141 print_client("RPC_MESSAGE _RpcMessage;\n");
143 if (handle_var)
145 print_client( "__frame->_Handle = 0;\n" );
146 if (explicit_fc == FC_BIND_GENERIC)
147 print_client("__frame->%s = %s;\n", handle_var->name, handle_var->name );
149 if (has_ret && decl_indirect(retval->declspec.type))
151 print_client("__frame->_p_%s = &%s;\n", retval->name, retval->name);
153 fprintf(client, "\n");
155 print_client( "RpcExceptionInit( 0, __finally_%s%s );\n", prefix_client, get_name(func) );
157 if (has_full_pointer)
158 write_full_pointer_init(client, indent, func, FALSE);
160 /* check pointers */
161 write_pointer_checks( client, indent, func );
163 print_client("RpcTryFinally\n");
164 print_client("{\n");
165 indent++;
167 print_client("NdrClientInitializeNew(&_RpcMessage, &__frame->_StubMsg, &%s_StubDesc, %d);\n",
168 iface->name, method_count);
170 if (is_attr(func->attrs, ATTR_IDEMPOTENT) || is_attr(func->attrs, ATTR_BROADCAST))
172 print_client("_RpcMessage.RpcFlags = ( RPC_NCA_FLAGS_DEFAULT ");
173 if (is_attr(func->attrs, ATTR_IDEMPOTENT))
174 fprintf(client, "| RPC_NCA_FLAGS_IDEMPOTENT ");
175 if (is_attr(func->attrs, ATTR_BROADCAST))
176 fprintf(client, "| RPC_NCA_FLAGS_BROADCAST ");
177 fprintf(client, ");\n\n");
180 switch (explicit_fc)
182 case FC_BIND_PRIMITIVE:
183 print_client("__frame->_Handle = %s;\n", handle_var->name);
184 fprintf(client, "\n");
185 break;
186 case FC_BIND_GENERIC:
187 print_client("__frame->_Handle = %s_bind(%s);\n",
188 get_explicit_generic_handle_type(handle_var)->name, handle_var->name);
189 fprintf(client, "\n");
190 break;
191 case FC_BIND_CONTEXT:
193 /* if the context_handle attribute appears in the chain of types
194 * without pointers being followed, then the context handle must
195 * be direct, otherwise it is a pointer */
196 int is_ch_ptr = !is_aliaschain_attr(handle_var->declspec.type, ATTR_CONTEXTHANDLE);
197 print_client("if (%s%s != 0)\n", is_ch_ptr ? "*" : "", handle_var->name);
198 indent++;
199 print_client("__frame->_Handle = NDRCContextBinding(%s%s);\n",
200 is_ch_ptr ? "*" : "", handle_var->name);
201 indent--;
202 if (is_attr(handle_var->attrs, ATTR_IN) && !is_attr(handle_var->attrs, ATTR_OUT))
204 print_client("else\n");
205 indent++;
206 print_client("RpcRaiseException(RPC_X_SS_IN_NULL_CONTEXT);\n");
207 indent--;
209 fprintf(client, "\n");
210 break;
212 case 0: /* implicit handle */
213 if (handle_var)
215 print_client("__frame->_Handle = %s;\n", handle_var->name);
216 fprintf(client, "\n");
218 break;
221 write_remoting_arguments(client, indent, func, "", PASS_IN, PHASE_BUFFERSIZE);
223 print_client("NdrGetBuffer(&__frame->_StubMsg, __frame->_StubMsg.BufferLength, ");
224 if (handle_var)
225 fprintf(client, "__frame->_Handle);\n\n");
226 else
227 fprintf(client,"%s__MIDL_AutoBindHandle);\n\n", iface->name);
229 /* marshal arguments */
230 write_remoting_arguments(client, indent, func, "", PASS_IN, PHASE_MARSHAL);
232 /* send/receive message */
233 /* print_client("NdrNsSendReceive(\n"); */
234 /* print_client("(unsigned char *)__frame->_StubMsg.Buffer,\n"); */
235 /* print_client("(RPC_BINDING_HANDLE *) &%s__MIDL_AutoBindHandle);\n", iface->name); */
236 print_client("NdrSendReceive(&__frame->_StubMsg, __frame->_StubMsg.Buffer);\n\n");
238 print_client("__frame->_StubMsg.BufferStart = _RpcMessage.Buffer;\n");
239 print_client("__frame->_StubMsg.BufferEnd = __frame->_StubMsg.BufferStart + _RpcMessage.BufferLength;\n");
241 if (has_out_arg_or_return(func))
243 fprintf(client, "\n");
245 print_client("if ((_RpcMessage.DataRepresentation & 0x0000FFFFUL) != NDR_LOCAL_DATA_REPRESENTATION)\n");
246 indent++;
247 print_client("NdrConvert(&__frame->_StubMsg, (PFORMAT_STRING)&__MIDL_ProcFormatString.Format[%u]);\n",
248 proc_offset);
249 indent--;
252 /* unmarshall arguments */
253 fprintf(client, "\n");
254 write_remoting_arguments(client, indent, func, "", PASS_OUT, PHASE_UNMARSHAL);
256 /* unmarshal return value */
257 if (has_ret)
259 if (decl_indirect(retval->declspec.type))
260 print_client("MIDL_memset(&%s, 0, sizeof(%s));\n", retval->name, retval->name);
261 else if (is_ptr(retval->declspec.type) || is_array(retval->declspec.type))
262 print_client("%s = 0;\n", retval->name);
263 write_remoting_arguments(client, indent, func, "", PASS_RETURN, PHASE_UNMARSHAL);
266 indent--;
267 print_client("}\n");
268 print_client("RpcFinally\n");
269 print_client("{\n");
270 indent++;
271 print_client( "__finally_%s%s( __frame );\n", prefix_client, get_name(func) );
272 indent--;
273 print_client("}\n");
274 print_client("RpcEndFinally\n");
277 /* emit return code */
278 if (has_ret)
280 fprintf(client, "\n");
281 print_client("return %s;\n", retval->name);
284 indent--;
285 fprintf(client, "}\n");
286 fprintf(client, "\n");
289 static void write_serialize_function(FILE *file, const type_t *type, const type_t *iface,
290 const char *func_name, const char *ret_type)
292 enum stub_mode mode = get_stub_mode();
293 static int emitted_pickling_info;
295 if (iface && !type->typestring_offset)
297 /* FIXME: Those are mostly basic types. They should be implemented
298 * using NdrMesSimpleType* functions */
299 if (ret_type) warning("Serialization of type %s is not supported\n", type->name);
300 return;
303 if (!emitted_pickling_info && iface && mode != MODE_Os)
305 fprintf(file, "static const MIDL_TYPE_PICKLING_INFO __MIDL_TypePicklingInfo =\n");
306 fprintf(file, "{\n");
307 fprintf(file, " 0x33205054,\n");
308 fprintf(file, " 0x3,\n");
309 fprintf(file, " 0,\n");
310 fprintf(file, " 0,\n");
311 fprintf(file, " 0\n");
312 fprintf(file, "};\n");
313 fprintf(file, "\n");
314 emitted_pickling_info = 1;
317 /* FIXME: Assuming explicit handle */
319 fprintf(file, "%s __cdecl %s_%s(handle_t IDL_handle, %s *IDL_type)%s\n",
320 ret_type ? ret_type : "void", type->name, func_name, type->name, iface ? "" : ";");
321 if (!iface) return; /* declaration only */
323 fprintf(file, "{\n");
324 fprintf(file, " %sNdrMesType%s%s(\n", ret_type ? "return " : "", func_name,
325 mode != MODE_Os ? "2" : "");
326 fprintf(file, " IDL_handle,\n");
327 if (mode != MODE_Os)
328 fprintf(file, " (MIDL_TYPE_PICKLING_INFO*)&__MIDL_TypePicklingInfo,\n");
329 fprintf(file, " &%s_StubDesc,\n", iface->name);
330 fprintf(file, " (PFORMAT_STRING)&__MIDL_TypeFormatString.Format[%u],\n",
331 type->typestring_offset);
332 fprintf(file, " IDL_type);\n");
333 fprintf(file, "}\n");
334 fprintf(file, "\n");
337 void write_serialize_functions(FILE *file, const type_t *type, const type_t *iface)
339 if (is_attr(type->attrs, ATTR_ENCODE))
341 write_serialize_function(file, type, iface, "AlignSize", "SIZE_T");
342 write_serialize_function(file, type, iface, "Encode", NULL);
344 if (is_attr(type->attrs, ATTR_DECODE))
346 write_serialize_function(file, type, iface, "Decode", NULL);
347 write_serialize_function(file, type, iface, "Free", NULL);
351 static void write_function_stubs(type_t *iface, unsigned int *proc_offset)
353 const statement_t *stmt;
354 const var_t *implicit_handle = get_attrp(iface->attrs, ATTR_IMPLICIT_HANDLE);
355 int method_count = 0;
357 if (!implicit_handle)
358 print_client("static RPC_BINDING_HANDLE %s__MIDL_AutoBindHandle;\n\n", iface->name);
360 LIST_FOR_EACH_ENTRY( stmt, type_iface_get_stmts(iface), const statement_t, entry )
362 switch (stmt->type)
364 case STMT_DECLARATION:
366 const var_t *func = stmt->u.var;
367 if (stmt->u.var->declspec.stgclass != STG_NONE
368 || type_get_type_detect_alias(stmt->u.var->declspec.type) != TYPE_FUNCTION)
369 continue;
370 write_function_stub( iface, func, method_count++, *proc_offset );
371 *proc_offset += get_size_procformatstring_func( iface, func );
372 break;
374 case STMT_TYPEDEF:
376 typeref_t *ref;
377 if (stmt->u.type_list) LIST_FOR_EACH_ENTRY(ref, stmt->u.type_list, typeref_t, entry)
378 write_serialize_functions(client, ref->type, iface);
379 break;
381 default:
382 break;
388 static void write_stubdescdecl(type_t *iface)
390 print_client("static const MIDL_STUB_DESC %s_StubDesc;\n", iface->name);
391 fprintf(client, "\n");
395 static void write_stubdescriptor(type_t *iface, int expr_eval_routines)
397 const var_t *implicit_handle = get_attrp(iface->attrs, ATTR_IMPLICIT_HANDLE);
399 print_client("static const MIDL_STUB_DESC %s_StubDesc =\n", iface->name);
400 print_client("{\n");
401 indent++;
402 print_client("(void *)& %s___RpcClientInterface,\n", iface->name);
403 print_client("MIDL_user_allocate,\n");
404 print_client("MIDL_user_free,\n");
405 print_client("{\n");
406 indent++;
407 if (implicit_handle)
408 print_client("&%s,\n", implicit_handle->name);
409 else
410 print_client("&%s__MIDL_AutoBindHandle,\n", iface->name);
411 indent--;
412 print_client("},\n");
413 print_client("0,\n");
414 if (!list_empty( &generic_handle_list ))
415 print_client("BindingRoutines,\n");
416 else
417 print_client("0,\n");
418 if (expr_eval_routines)
419 print_client("ExprEvalRoutines,\n");
420 else
421 print_client("0,\n");
422 print_client("0,\n");
423 print_client("__MIDL_TypeFormatString.Format,\n");
424 print_client("1, /* -error bounds_check flag */\n");
425 print_client("0x%x, /* Ndr library version */\n", get_stub_mode() == MODE_Oif ? 0x50002 : 0x10001);
426 print_client("0,\n");
427 print_client("0x50200ca, /* MIDL Version 5.2.202 */\n");
428 print_client("0,\n");
429 print_client("%s,\n", list_empty(&user_type_list) ? "0" : "UserMarshalRoutines");
430 print_client("0, /* notify & notify_flag routine table */\n");
431 print_client("1, /* Flags */\n");
432 print_client("0, /* Reserved3 */\n");
433 print_client("0, /* Reserved4 */\n");
434 print_client("0 /* Reserved5 */\n");
435 indent--;
436 print_client("};\n");
437 fprintf(client, "\n");
441 static void write_clientinterfacedecl(type_t *iface)
443 unsigned int ver = get_attrv(iface->attrs, ATTR_VERSION);
444 const UUID *uuid = get_attrp(iface->attrs, ATTR_UUID);
445 const str_list_t *endpoints = get_attrp(iface->attrs, ATTR_ENDPOINT);
447 if (endpoints) write_endpoints( client, iface->name, endpoints );
449 print_client("static const RPC_CLIENT_INTERFACE %s___RpcClientInterface =\n", iface->name );
450 print_client("{\n");
451 indent++;
452 print_client("sizeof(RPC_CLIENT_INTERFACE),\n");
453 print_client("{{0x%08x,0x%04x,0x%04x,{0x%02x,0x%02x,0x%02x,0x%02x,0x%02x,0x%02x,0x%02x,0x%02x}},{%d,%d}},\n",
454 uuid->Data1, uuid->Data2, uuid->Data3, uuid->Data4[0], uuid->Data4[1],
455 uuid->Data4[2], uuid->Data4[3], uuid->Data4[4], uuid->Data4[5], uuid->Data4[6],
456 uuid->Data4[7], MAJORVERSION(ver), MINORVERSION(ver));
457 print_client("{{0x8a885d04,0x1ceb,0x11c9,{0x9f,0xe8,0x08,0x00,0x2b,0x10,0x48,0x60}},{2,0}},\n"); /* FIXME */
458 print_client("0,\n");
459 if (endpoints)
461 print_client("%u,\n", list_count(endpoints));
462 print_client("(PRPC_PROTSEQ_ENDPOINT)%s__RpcProtseqEndpoint,\n", iface->name);
464 else
466 print_client("0,\n");
467 print_client("0,\n");
469 print_client("0,\n");
470 print_client("0,\n");
471 print_client("0,\n");
472 indent--;
473 print_client("};\n");
474 if (old_names)
475 print_client("RPC_IF_HANDLE %s_ClientIfHandle DECLSPEC_HIDDEN = (RPC_IF_HANDLE)& %s___RpcClientInterface;\n",
476 iface->name, iface->name);
477 else
478 print_client("RPC_IF_HANDLE %s%s_v%d_%d_c_ifspec DECLSPEC_HIDDEN = (RPC_IF_HANDLE)& %s___RpcClientInterface;\n",
479 prefix_client, iface->name, MAJORVERSION(ver), MINORVERSION(ver), iface->name);
480 fprintf(client, "\n");
484 static void write_implicithandledecl(type_t *iface)
486 const var_t *implicit_handle = get_attrp(iface->attrs, ATTR_IMPLICIT_HANDLE);
488 if (implicit_handle)
490 write_type_decl(client, &implicit_handle->declspec, implicit_handle->name);
491 fprintf(client, ";\n\n");
496 static void init_client(void)
498 if (client) return;
499 if (!(client = fopen(client_name, "w")))
500 error("Could not open %s for output\n", client_name);
502 print_client("/*** Autogenerated by WIDL %s from %s - Do not edit ***/\n", PACKAGE_VERSION, input_name);
503 print_client("#include <string.h>\n");
504 print_client( "\n");
505 print_client("#include \"%s\"\n", header_name);
506 print_client( "\n");
507 print_client( "#ifndef DECLSPEC_HIDDEN\n");
508 print_client( "#define DECLSPEC_HIDDEN\n");
509 print_client( "#endif\n");
510 print_client( "\n");
514 static void write_client_ifaces(const statement_list_t *stmts, int expr_eval_routines, unsigned int *proc_offset)
516 const statement_t *stmt;
517 if (stmts) LIST_FOR_EACH_ENTRY( stmt, stmts, const statement_t, entry )
519 if (stmt->type == STMT_TYPE && type_get_type(stmt->u.type) == TYPE_INTERFACE)
521 int needs_stub = 0;
522 const statement_t *stmt2;
523 type_t *iface = stmt->u.type;
524 if (!need_stub(iface))
525 return;
527 fprintf(client, "/*****************************************************************************\n");
528 fprintf(client, " * %s interface\n", iface->name);
529 fprintf(client, " */\n");
530 fprintf(client, "\n");
532 LIST_FOR_EACH_ENTRY(stmt2, type_iface_get_stmts(iface), const statement_t, entry)
534 if (stmt2->type == STMT_DECLARATION && stmt2->u.var->declspec.stgclass == STG_NONE &&
535 type_get_type_detect_alias(stmt2->u.var->declspec.type) == TYPE_FUNCTION)
537 needs_stub = 1;
538 break;
540 if (stmt2->type == STMT_TYPEDEF)
542 typeref_t *ref;
543 if (stmt2->u.type_list) LIST_FOR_EACH_ENTRY(ref, stmt2->u.type_list, typeref_t, entry)
545 if (is_attr(ref->type->attrs, ATTR_ENCODE)
546 || is_attr(ref->type->attrs, ATTR_DECODE))
548 needs_stub = 1;
549 break;
552 if (needs_stub)
553 break;
556 if (needs_stub)
558 write_implicithandledecl(iface);
560 write_clientinterfacedecl(iface);
561 write_stubdescdecl(iface);
562 write_function_stubs(iface, proc_offset);
564 print_client("#if !defined(__RPC_WIN%u__)\n", pointer_size == 8 ? 64 : 32);
565 print_client("#error Invalid build platform for this stub.\n");
566 print_client("#endif\n");
568 fprintf(client, "\n");
569 write_stubdescriptor(iface, expr_eval_routines);
575 static void write_generic_handle_routine_list(void)
577 generic_handle_t *gh;
579 if (list_empty( &generic_handle_list )) return;
580 print_client( "static const GENERIC_BINDING_ROUTINE_PAIR BindingRoutines[] =\n" );
581 print_client( "{\n" );
582 indent++;
583 LIST_FOR_EACH_ENTRY( gh, &generic_handle_list, generic_handle_t, entry )
585 print_client( "{ (GENERIC_BINDING_ROUTINE)%s_bind, (GENERIC_UNBIND_ROUTINE)%s_unbind },\n",
586 gh->name, gh->name );
588 indent--;
589 print_client( "};\n\n" );
592 static void write_client_routines(const statement_list_t *stmts)
594 unsigned int proc_offset = 0;
595 int expr_eval_routines;
597 if (need_inline_stubs_file( stmts ))
599 write_exceptions( client );
600 print_client( "\n");
603 write_formatstringsdecl(client, indent, stmts, need_stub);
604 expr_eval_routines = write_expr_eval_routines(client, client_token);
605 if (expr_eval_routines)
606 write_expr_eval_routine_list(client, client_token);
607 write_generic_handle_routine_list();
608 write_user_quad_list(client);
610 write_client_ifaces(stmts, expr_eval_routines, &proc_offset);
612 fprintf(client, "\n");
614 write_procformatstring(client, stmts, need_stub);
615 write_typeformatstring(client, stmts, need_stub);
618 void write_client(const statement_list_t *stmts)
620 if (!do_client)
621 return;
622 if (do_everything && !need_stub_files(stmts))
623 return;
625 init_client();
626 if (!client)
627 return;
629 write_client_routines( stmts );
630 fclose(client);