4 * Copyright 2002 Ove Kaaven
5 * Copyright 2004 Mike McCormack
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
23 #include "wine/port.h"
41 #define END_OF_LIST(list) \
44 while (NEXT_LINK(list)) \
45 list = NEXT_LINK(list); \
50 static int indent = 0;
52 /* FIXME: support generation of stubless proxies */
54 static void print_proxy( const char *format, ... )
57 va_start( va, format );
58 print( proxy, indent, format, va );
62 static void write_stubdescproto(void)
64 print_proxy( "static const MIDL_STUB_DESC Object_StubDesc;\n");
68 static void write_stubdesc(void)
70 print_proxy( "static const MIDL_STUB_DESC Object_StubDesc =\n{\n");
73 print_proxy( "NdrOleAllocate,\n");
74 print_proxy( "NdrOleFree,\n");
75 print_proxy( "{0}, 0, 0, 0, 0,\n");
76 print_proxy( "__MIDL_TypeFormatString.Format,\n");
77 print_proxy( "1, /* -error bounds_check flag */\n");
78 print_proxy( "0x10001, /* Ndr library version */\n");
80 print_proxy( "0x50100a4, /* MIDL Version 5.1.164 */\n");
82 print_proxy("%s,\n", list_empty(&user_type_list) ? "0" : "UserMarshalRoutines");
83 print_proxy( "0, /* notify & notify_flag routine table */\n");
84 print_proxy( "1, /* Flags */\n");
85 print_proxy( "0, /* Reserved3 */\n");
86 print_proxy( "0, /* Reserved4 */\n");
87 print_proxy( "0 /* Reserved5 */\n");
93 static void init_proxy(ifref_list_t *ifaces)
96 if(!(proxy = fopen(proxy_name, "w")))
97 error("Could not open %s for output\n", proxy_name);
98 print_proxy( "/*** Autogenerated by WIDL %s from %s - Do not edit ***/\n", PACKAGE_VERSION, input_name);
100 print_proxy( "#ifndef __REDQ_RPCPROXY_H_VERSION__\n");
101 print_proxy( "#define __REQUIRED_RPCPROXY_H_VERSION__ 440\n");
102 print_proxy( "#endif /* __REDQ_RPCPROXY_H_VERSION__ */\n");
104 print_proxy( "#define __midl_proxy\n");
105 print_proxy( "#include \"objbase.h\"\n");
106 print_proxy( "#include \"rpcproxy.h\"\n");
107 print_proxy( "#ifndef __RPCPROXY_H_VERSION__\n");
108 print_proxy( "#error This code needs a newer version of rpcproxy.h\n");
109 print_proxy( "#endif /* __RPCPROXY_H_VERSION__ */\n");
111 print_proxy( "#include \"%s\"\n", header_name);
113 write_formatstringsdecl(proxy, indent, ifaces, 1);
114 write_stubdescproto();
117 static void clear_output_vars( const var_list_t *args )
122 LIST_FOR_EACH_ENTRY( arg, args, const var_t, entry )
124 if (is_attr(arg->attrs, ATTR_OUT) && !is_attr(arg->attrs, ATTR_IN)) {
125 print_proxy( "if(%s)\n", arg->name );
127 print_proxy( "MIDL_memset( %s, 0, sizeof( *%s ));\n", arg->name, arg->name );
133 int is_var_ptr(const var_t *v)
135 return is_ptr(v->type);
138 int cant_be_null(const var_t *v)
140 /* Search backwards for the most recent pointer attribute. */
141 const attr_list_t *attrs = v->attrs;
142 const type_t *type = v->type;
152 int t = get_attrv(attrs, ATTR_POINTERTYPE);
154 if (t == RPC_FC_FP || t == RPC_FC_OP || t == RPC_FC_UP)
169 return 1; /* Default is RPC_FC_RP. */
172 static void proxy_check_pointers( const var_list_t *args )
177 LIST_FOR_EACH_ENTRY( arg, args, const var_t, entry )
179 if (is_var_ptr(arg) && cant_be_null(arg)) {
180 print_proxy( "if(!%s)\n", arg->name );
182 print_proxy( "RpcRaiseException(RPC_X_NULL_REF_POINTER);\n");
188 static void free_variable( const var_t *arg )
190 unsigned int type_offset = arg->type->typestring_offset;
195 expr = get_attrp( arg->attrs, ATTR_SIZEIS );
198 const expr_t *size = LIST_ENTRY( list_head(expr), const expr_t, entry );
199 print_proxy( "_StubMsg.MaxCount = " );
200 write_expr(proxy, size, 0);
201 fprintf(proxy, ";\n\n");
202 print_proxy( "NdrClearOutParameters( &_StubMsg, ");
203 fprintf(proxy, "&__MIDL_TypeFormatString.Format[%u], ", type_offset );
204 fprintf(proxy, "(void*)%s );\n", arg->name );
225 constraint = get_attrp( arg->attrs, ATTR_IIDIS );
227 print_proxy( "_StubMsg.MaxCount = (unsigned long) ( %s );\n",constraint->name);
228 print_proxy( "NdrClearOutParameters( &_StubMsg, ");
229 fprintf(proxy, "&__MIDL_TypeFormatString.Format[%u], ", type_offset );
230 fprintf(proxy, "(void*)%s );\n", arg->name );
234 print_proxy("/* FIXME: %s code for %s type %d missing */\n", __FUNCTION__, arg->name, type->type );
238 static void proxy_free_variables( var_list_t *args )
243 LIST_FOR_EACH_ENTRY( arg, args, const var_t, entry )
244 if (is_attr(arg->attrs, ATTR_OUT))
246 free_variable( arg );
247 fprintf(proxy, "\n");
251 static void gen_proxy(type_t *iface, const func_t *cur, int idx,
252 unsigned int proc_offset)
254 var_t *def = cur->def;
255 int has_ret = !is_void(def->type);
258 write_type_left(proxy, def->type);
259 print_proxy( " STDMETHODCALLTYPE %s_", iface->name);
260 write_name(proxy, def);
261 print_proxy( "_Proxy(\n");
262 write_args(proxy, cur->args, iface->name, 1, TRUE);
266 /* local variables */
269 write_type_left(proxy, def->type);
270 print_proxy( " _RetVal;\n");
272 print_proxy( "RPC_MESSAGE _RpcMessage;\n" );
273 print_proxy( "MIDL_STUB_MESSAGE _StubMsg;\n" );
277 clear_output_vars( cur->args );
279 print_proxy( "RpcTryExcept\n" );
280 print_proxy( "{\n" );
282 print_proxy( "NdrProxyInitialize(This, &_RpcMessage, &_StubMsg, &Object_StubDesc, %d);\n", idx);
283 proxy_check_pointers( cur->args );
285 print_proxy( "RpcTryFinally\n" );
286 print_proxy( "{\n" );
289 write_remoting_arguments(proxy, indent, cur, PASS_IN, PHASE_BUFFERSIZE);
291 print_proxy( "NdrProxyGetBuffer(This, &_StubMsg);\n" );
293 write_remoting_arguments(proxy, indent, cur, PASS_IN, PHASE_MARSHAL);
295 print_proxy( "NdrProxySendReceive(This, &_StubMsg);\n" );
296 fprintf(proxy, "\n");
297 print_proxy( "_StubMsg.BufferStart = _RpcMessage.Buffer;\n" );
298 print_proxy( "_StubMsg.BufferEnd = _StubMsg.BufferStart + _RpcMessage.BufferLength;\n\n" );
300 print_proxy("if ((_RpcMessage.DataRepresentation & 0xffff) != NDR_LOCAL_DATA_REPRESENTATION)\n");
302 print_proxy("NdrConvert( &_StubMsg, &__MIDL_ProcFormatString.Format[%u]);\n", proc_offset );
304 fprintf(proxy, "\n");
306 write_remoting_arguments(proxy, indent, cur, PASS_OUT, PHASE_UNMARSHAL);
309 print_phase_basetype(proxy, indent, PHASE_UNMARSHAL, PASS_RETURN, def, "_RetVal");
313 print_proxy( "RpcFinally\n" );
314 print_proxy( "{\n" );
316 print_proxy( "NdrProxyFreeBuffer(This, &_StubMsg);\n" );
319 print_proxy( "RpcEndFinally\n" );
321 print_proxy( "}\n" );
322 print_proxy( "RpcExcept(_StubMsg.dwStubPhase != PROXY_SENDRECEIVE)\n" );
323 print_proxy( "{\n" );
326 proxy_free_variables( cur->args );
327 print_proxy( "_RetVal = NdrProxyErrorHandler(RpcExceptionCode());\n" );
330 print_proxy( "}\n" );
331 print_proxy( "RpcEndExcept\n" );
334 print_proxy( "return _RetVal;\n" );
341 static void gen_stub(type_t *iface, const func_t *cur, const char *cas,
342 unsigned int proc_offset)
344 var_t *def = cur->def;
346 int has_ret = !is_void(def->type);
349 print_proxy( "void __RPC_STUB %s_", iface->name);
350 write_name(proxy, def);
351 print_proxy( "_Stub(\n");
353 print_proxy( "IRpcStubBuffer* This,\n");
354 print_proxy( "IRpcChannelBuffer *_pRpcChannelBuffer,\n");
355 print_proxy( "PRPC_MESSAGE _pRpcMessage,\n");
356 print_proxy( "DWORD* _pdwStubPhase)\n");
360 print_proxy("%s * _This = (%s*)((CStdStubBuffer*)This)->pvServerObject;\n", iface->name, iface->name);
361 print_proxy("MIDL_STUB_MESSAGE _StubMsg;\n");
362 declare_stub_args( proxy, indent, cur );
363 fprintf(proxy, "\n");
367 print_proxy("NdrStubInitialize(_pRpcMessage, &_StubMsg, &Object_StubDesc, _pRpcChannelBuffer);\n");
368 fprintf(proxy, "\n");
370 write_parameters_init(proxy, indent, cur);
372 print_proxy("RpcTryFinally\n");
375 print_proxy("if ((_pRpcMessage->DataRepresentation & 0xffff) != NDR_LOCAL_DATA_REPRESENTATION)\n");
377 print_proxy("NdrConvert( &_StubMsg, &__MIDL_ProcFormatString.Format[%u]);\n", proc_offset );
379 fprintf(proxy, "\n");
381 write_remoting_arguments(proxy, indent, cur, PASS_IN, PHASE_UNMARSHAL);
382 fprintf(proxy, "\n");
384 assign_stub_out_args( proxy, indent, cur );
386 print_proxy("*_pdwStubPhase = STUB_CALL_SERVER;\n");
387 fprintf(proxy, "\n");
389 if (has_ret) fprintf(proxy, "_RetVal = ");
390 if (cas) fprintf(proxy, "%s_%s_Stub", iface->name, cas);
393 fprintf(proxy, "_This->lpVtbl->");
394 write_name(proxy, def);
396 fprintf(proxy, "(_This");
400 LIST_FOR_EACH_ENTRY( arg, cur->args, const var_t, entry )
402 fprintf(proxy, ", ");
403 if (arg->type->declarray)
405 write_name(proxy, arg);
408 fprintf(proxy, ");\n");
409 fprintf(proxy, "\n");
410 print_proxy("*_pdwStubPhase = STUB_MARSHAL;\n");
411 fprintf(proxy, "\n");
413 write_remoting_arguments(proxy, indent, cur, PASS_OUT, PHASE_BUFFERSIZE);
415 print_proxy("NdrStubGetBuffer(This, _pRpcChannelBuffer, &_StubMsg);\n");
417 write_remoting_arguments(proxy, indent, cur, PASS_OUT, PHASE_MARSHAL);
418 fprintf(proxy, "\n");
421 print_phase_basetype(proxy, indent, PHASE_MARSHAL, PASS_RETURN, def, "_RetVal");
425 print_proxy("RpcFinally\n");
428 write_remoting_arguments(proxy, indent+1, cur, PASS_OUT, PHASE_FREE);
431 print_proxy("RpcEndFinally\n");
433 print_proxy("_pRpcMessage->BufferLength = _StubMsg.Buffer - (unsigned char *)_pRpcMessage->Buffer;\n");
440 static int write_proxy_methods(type_t *iface)
445 if (iface->ref) i = write_proxy_methods(iface->ref);
446 if (iface->funcs) LIST_FOR_EACH_ENTRY( cur, iface->funcs, const func_t, entry ) {
447 var_t *def = cur->def;
448 if (!is_callas(def->attrs)) {
449 if (i) fprintf(proxy, ",\n");
450 print_proxy( "%s_", iface->name);
451 write_name(proxy, def);
452 fprintf(proxy, "_Proxy");
459 static int write_stub_methods(type_t *iface)
464 if (iface->ref) i = write_stub_methods(iface->ref);
465 else return i; /* skip IUnknown */
467 if (iface->funcs) LIST_FOR_EACH_ENTRY( cur, iface->funcs, const func_t, entry ) {
468 var_t *def = cur->def;
469 if (!is_local(def->attrs)) {
470 if (i) fprintf(proxy,",\n");
471 print_proxy( "%s_", iface->name);
472 write_name(proxy, def);
473 fprintf(proxy, "_Stub");
480 static void write_proxy(type_t *iface, unsigned int *proc_offset)
482 int midx = -1, stubs;
485 if (!iface->funcs) return;
487 /* FIXME: check for [oleautomation], shouldn't generate proxies/stubs if specified */
489 fprintf(proxy, "/*****************************************************************************\n");
490 fprintf(proxy, " * %s interface\n", iface->name);
491 fprintf(proxy, " */\n");
492 LIST_FOR_EACH_ENTRY( cur, iface->funcs, const func_t, entry )
494 const var_t *def = cur->def;
495 if (!is_local(def->attrs)) {
496 const var_t *cas = is_callas(def->attrs);
497 const char *cname = cas ? cas->name : NULL;
501 LIST_FOR_EACH_ENTRY( m, iface->funcs, const func_t, entry )
502 if (!strcmp(m->def->name, cname))
508 gen_proxy(iface, cur, idx, *proc_offset);
509 gen_stub(iface, cur, cname, *proc_offset);
510 *proc_offset += get_size_procformatstring_func( cur );
511 if (midx == -1) midx = idx;
512 else if (midx != idx) parser_error("method index mismatch in write_proxy");
518 print_proxy( "static const CINTERFACE_PROXY_VTABLE(%d) _%sProxyVtbl =\n", midx, iface->name);
521 print_proxy( "{\n", iface->name);
523 print_proxy( "&IID_%s,\n", iface->name);
525 print_proxy( "},\n");
528 write_proxy_methods(iface);
529 fprintf(proxy, "\n");
533 print_proxy( "};\n");
534 fprintf(proxy, "\n\n");
537 print_proxy( "static const PRPC_STUB_FUNCTION %s_table[] =\n", iface->name);
540 stubs = write_stub_methods(iface);
541 fprintf(proxy, "\n");
543 fprintf(proxy, "};\n");
545 print_proxy( "static const CInterfaceStubVtbl _%sStubVtbl =\n", iface->name);
550 print_proxy( "&IID_%s,\n", iface->name);
551 print_proxy( "0,\n");
552 print_proxy( "%d,\n", stubs+3);
553 print_proxy( "&%s_table[-3],\n", iface->name);
555 print_proxy( "},\n", iface->name);
558 print_proxy( "CStdStubBuffer_METHODS\n");
562 print_proxy( "};\n");
566 void write_proxies(ifref_list_t *ifaces)
569 char *file_id = proxy_token;
571 unsigned int proc_offset = 0;
573 if (!do_proxies) return;
574 if (do_everything && !ifaces) return;
580 LIST_FOR_EACH_ENTRY( cur, ifaces, ifref_t, entry )
581 if (is_object(cur->iface->attrs) && !is_local(cur->iface->attrs))
582 write_proxy(cur->iface, &proc_offset);
584 write_user_quad_list(proxy);
587 print_proxy( "#if !defined(__RPC_WIN32__)\n");
588 print_proxy( "#error Currently only Wine and WIN32 are supported.\n");
589 print_proxy( "#endif\n");
591 write_procformatstring(proxy, ifaces, 1);
592 write_typeformatstring(proxy, ifaces, 1);
594 fprintf(proxy, "static const CInterfaceProxyVtbl* const _%s_ProxyVtblList[] =\n", file_id);
595 fprintf(proxy, "{\n");
597 LIST_FOR_EACH_ENTRY( cur, ifaces, ifref_t, entry )
598 if(cur->iface->ref && cur->iface->funcs &&
599 is_object(cur->iface->attrs) && !is_local(cur->iface->attrs))
600 fprintf(proxy, " (const CInterfaceProxyVtbl*)&_%sProxyVtbl,\n", cur->iface->name);
602 fprintf(proxy, " 0\n");
603 fprintf(proxy, "};\n");
604 fprintf(proxy, "\n");
606 fprintf(proxy, "static const CInterfaceStubVtbl* const _%s_StubVtblList[] =\n", file_id);
607 fprintf(proxy, "{\n");
609 LIST_FOR_EACH_ENTRY( cur, ifaces, ifref_t, entry )
610 if(cur->iface->ref && cur->iface->funcs &&
611 is_object(cur->iface->attrs) && !is_local(cur->iface->attrs))
612 fprintf(proxy, " (const CInterfaceStubVtbl*)&_%sStubVtbl,\n", cur->iface->name);
613 fprintf(proxy, " 0\n");
614 fprintf(proxy, "};\n");
615 fprintf(proxy, "\n");
617 fprintf(proxy, "static PCInterfaceName const _%s_InterfaceNamesList[] =\n", file_id);
618 fprintf(proxy, "{\n");
620 LIST_FOR_EACH_ENTRY( cur, ifaces, ifref_t, entry )
621 if(cur->iface->ref && cur->iface->funcs &&
622 is_object(cur->iface->attrs) && !is_local(cur->iface->attrs))
623 fprintf(proxy, " \"%s\",\n", cur->iface->name);
624 fprintf(proxy, " 0\n");
625 fprintf(proxy, "};\n");
626 fprintf(proxy, "\n");
628 fprintf(proxy, "#define _%s_CHECK_IID(n) IID_GENERIC_CHECK_IID(_%s, pIID, n)\n", file_id, file_id);
629 fprintf(proxy, "\n");
630 fprintf(proxy, "int __stdcall _%s_IID_Lookup(const IID* pIID, int* pIndex)\n", file_id);
631 fprintf(proxy, "{\n");
634 LIST_FOR_EACH_ENTRY( cur, ifaces, ifref_t, entry )
637 fprintf(proxy, " if (!_%s_CHECK_IID(%d))\n", file_id, c);
638 fprintf(proxy, " {\n");
639 fprintf(proxy, " *pIndex = %d;\n", c);
640 fprintf(proxy, " return 1;\n");
641 fprintf(proxy, " }\n");
644 fprintf(proxy, " return 0;\n");
645 fprintf(proxy, "}\n");
646 fprintf(proxy, "\n");
648 fprintf(proxy, "const ExtendedProxyFileInfo %s_ProxyFileInfo =\n", file_id);
649 fprintf(proxy, "{\n");
650 fprintf(proxy, " (const PCInterfaceProxyVtblList*)&_%s_ProxyVtblList,\n", file_id);
651 fprintf(proxy, " (const PCInterfaceStubVtblList*)&_%s_StubVtblList,\n", file_id);
652 fprintf(proxy, " _%s_InterfaceNamesList,\n", file_id);
653 fprintf(proxy, " 0,\n");
654 fprintf(proxy, " &_%s_IID_Lookup,\n", file_id);
655 fprintf(proxy, " %d,\n", c);
656 fprintf(proxy, " 1,\n");
657 fprintf(proxy, " 0,\n");
658 fprintf(proxy, " 0,\n");
659 fprintf(proxy, " 0,\n");
660 fprintf(proxy, " 0\n");
661 fprintf(proxy, "};\n");