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 int print_proxy( const char *format, ... )
59 va_start( va, format );
60 if ( format[0] != '\n' )
61 for( i=0; i<indent; i++ )
62 fprintf( proxy, " " );
63 r = vfprintf( proxy, format, va );
68 static void write_stubdescproto(void)
70 print_proxy( "static const MIDL_STUB_DESC Object_StubDesc;\n");
74 static void write_stubdesc(void)
76 print_proxy( "static const MIDL_STUB_DESC Object_StubDesc =\n{\n");
79 print_proxy( "NdrOleAllocate,\n");
80 print_proxy( "NdrOleFree,\n");
81 print_proxy( "{0}, 0, 0, 0, 0,\n");
82 print_proxy( "__MIDL_TypeFormatString.Format,\n");
83 print_proxy( "1, /* -error bounds_check flag */\n");
84 print_proxy( "0x10001, /* Ndr library version */\n");
86 print_proxy( "0x50100a4, /* MIDL Version 5.1.164 */\n");
89 print_proxy( "0, /* notify & notify_flag routine table */\n");
90 print_proxy( "1, /* Flags */\n");
91 print_proxy( "0, /* Reserved3 */\n");
92 print_proxy( "0, /* Reserved4 */\n");
93 print_proxy( "0 /* Reserved5 */\n");
99 static void init_proxy(ifref_list_t *ifaces)
102 if(!(proxy = fopen(proxy_name, "w")))
103 error("Could not open %s for output\n", proxy_name);
104 print_proxy( "/*** Autogenerated by WIDL %s from %s - Do not edit ***/\n", PACKAGE_VERSION, input_name);
106 print_proxy( "#ifndef __REDQ_RPCPROXY_H_VERSION__\n");
107 print_proxy( "#define __REQUIRED_RPCPROXY_H_VERSION__ 440\n");
108 print_proxy( "#endif /* __REDQ_RPCPROXY_H_VERSION__ */\n");
110 print_proxy( "#define __midl_proxy\n");
111 print_proxy( "#include \"objbase.h\"\n");
112 print_proxy( "#include \"rpcproxy.h\"\n");
113 print_proxy( "#ifndef __RPCPROXY_H_VERSION__\n");
114 print_proxy( "#error This code needs a newer version of rpcproxy.h\n");
115 print_proxy( "#endif /* __RPCPROXY_H_VERSION__ */\n");
117 print_proxy( "#include \"%s\"\n", header_name);
119 write_formatstringsdecl(proxy, indent, ifaces, 1);
120 write_stubdescproto();
123 static void clear_output_vars( const var_list_t *args )
128 LIST_FOR_EACH_ENTRY( arg, args, const var_t, entry )
130 if (is_attr(arg->attrs, ATTR_OUT) && !is_attr(arg->attrs, ATTR_IN)) {
131 print_proxy( "if(%s)\n", arg->name );
133 print_proxy( "MIDL_memset( %s, 0, sizeof( *%s ));\n", arg->name, arg->name );
139 int is_var_ptr(const var_t *v)
141 return is_ptr(v->type);
144 int cant_be_null(const var_t *v)
146 /* Search backwards for the most recent pointer attribute. */
147 const attr_list_t *attrs = v->attrs;
148 const type_t *type = v->type;
158 int t = get_attrv(attrs, ATTR_POINTERTYPE);
160 if (t == RPC_FC_FP || t == RPC_FC_OP || t == RPC_FC_UP)
175 return 1; /* Default is RPC_FC_RP. */
178 static void proxy_check_pointers( const var_list_t *args )
183 LIST_FOR_EACH_ENTRY( arg, args, const var_t, entry )
185 if (is_var_ptr(arg) && cant_be_null(arg)) {
186 print_proxy( "if(!%s)\n", arg->name );
188 print_proxy( "RpcRaiseException(RPC_X_NULL_REF_POINTER);\n");
194 static void free_variable( const var_t *arg )
196 unsigned int type_offset = arg->type->typestring_offset;
201 expr = get_attrp( arg->attrs, ATTR_SIZEIS );
204 const expr_t *size = LIST_ENTRY( list_head(expr), const expr_t, entry );
205 print_proxy( "_StubMsg.MaxCount = " );
206 write_expr(proxy, size, 0);
207 fprintf(proxy, ";\n\n");
208 print_proxy( "NdrClearOutParameters( &_StubMsg, ");
209 fprintf(proxy, "&__MIDL_TypeFormatString.Format[%u], ", type_offset );
210 fprintf(proxy, "(void*)%s );\n", arg->name );
231 constraint = get_attrp( arg->attrs, ATTR_IIDIS );
233 print_proxy( "_StubMsg.MaxCount = (unsigned long) ( %s );\n",constraint->name);
234 print_proxy( "NdrClearOutParameters( &_StubMsg, ");
235 fprintf(proxy, "&__MIDL_TypeFormatString.Format[%u], ", type_offset );
236 fprintf(proxy, "(void*)%s );\n", arg->name );
240 print_proxy("/* FIXME: %s code for %s type %d missing */\n", __FUNCTION__, arg->name, type->type );
244 static void proxy_free_variables( var_list_t *args )
249 LIST_FOR_EACH_ENTRY( arg, args, const var_t, entry )
250 if (is_attr(arg->attrs, ATTR_OUT))
252 free_variable( arg );
253 fprintf(proxy, "\n");
257 static void gen_proxy(type_t *iface, const func_t *cur, int idx,
258 unsigned int proc_offset)
260 var_t *def = cur->def;
261 int has_ret = !is_void(def->type);
264 write_type(proxy, def->type);
265 print_proxy( " STDMETHODCALLTYPE %s_", iface->name);
266 write_name(proxy, def);
267 print_proxy( "_Proxy(\n");
268 write_args(proxy, cur->args, iface->name, 1, TRUE);
272 /* local variables */
275 write_type(proxy, def->type);
276 print_proxy( " _RetVal;\n");
278 print_proxy( "RPC_MESSAGE _RpcMessage;\n" );
279 print_proxy( "MIDL_STUB_MESSAGE _StubMsg;\n" );
283 clear_output_vars( cur->args );
285 print_proxy( "RpcTryExcept\n" );
286 print_proxy( "{\n" );
288 print_proxy( "NdrProxyInitialize(This, &_RpcMessage, &_StubMsg, &Object_StubDesc, %d);\n", idx);
289 proxy_check_pointers( cur->args );
291 print_proxy( "RpcTryFinally\n" );
292 print_proxy( "{\n" );
295 write_remoting_arguments(proxy, indent, cur, PASS_IN, PHASE_BUFFERSIZE);
297 print_proxy( "NdrProxyGetBuffer(This, &_StubMsg);\n" );
299 write_remoting_arguments(proxy, indent, cur, PASS_IN, PHASE_MARSHAL);
301 print_proxy( "NdrProxySendReceive(This, &_StubMsg);\n" );
302 fprintf(proxy, "\n");
303 print_proxy( "_StubMsg.BufferStart = _RpcMessage.Buffer;\n" );
304 print_proxy( "_StubMsg.BufferEnd = _StubMsg.BufferStart + _RpcMessage.BufferLength;\n\n" );
306 print_proxy("if ((_RpcMessage.DataRepresentation & 0xffff) != NDR_LOCAL_DATA_REPRESENTATION)\n");
308 print_proxy("NdrConvert( &_StubMsg, &__MIDL_ProcFormatString.Format[%u]);\n", proc_offset );
310 fprintf(proxy, "\n");
312 write_remoting_arguments(proxy, indent, cur, PASS_OUT, PHASE_UNMARSHAL);
315 print_phase_basetype(proxy, indent, PHASE_UNMARSHAL, PASS_RETURN, def, "_RetVal");
319 print_proxy( "RpcFinally\n" );
320 print_proxy( "{\n" );
322 print_proxy( "NdrProxyFreeBuffer(This, &_StubMsg);\n" );
325 print_proxy( "RpcEndFinally\n" );
327 print_proxy( "}\n" );
328 print_proxy( "RpcExcept(_StubMsg.dwStubPhase != PROXY_SENDRECEIVE)\n" );
329 print_proxy( "{\n" );
332 proxy_free_variables( cur->args );
333 print_proxy( "_RetVal = NdrProxyErrorHandler(RpcExceptionCode());\n" );
336 print_proxy( "}\n" );
337 print_proxy( "RpcEndExcept\n" );
340 print_proxy( "return _RetVal;\n" );
347 static void gen_stub(type_t *iface, const func_t *cur, const char *cas,
348 unsigned int proc_offset)
350 var_t *def = cur->def;
352 int has_ret = !is_void(def->type);
355 print_proxy( "void __RPC_STUB %s_", iface->name);
356 write_name(proxy, def);
357 print_proxy( "_Stub(\n");
359 print_proxy( "IRpcStubBuffer* This,\n");
360 print_proxy( "IRpcChannelBuffer *_pRpcChannelBuffer,\n");
361 print_proxy( "PRPC_MESSAGE _pRpcMessage,\n");
362 print_proxy( "DWORD* _pdwStubPhase)\n");
366 print_proxy("%s * _This = (%s*)((CStdStubBuffer*)This)->pvServerObject;\n", iface->name, iface->name);
367 print_proxy("MIDL_STUB_MESSAGE _StubMsg;\n");
368 declare_stub_args( proxy, indent, cur );
369 fprintf(proxy, "\n");
373 print_proxy("NdrStubInitialize(_pRpcMessage, &_StubMsg, &Object_StubDesc, _pRpcChannelBuffer);\n");
374 fprintf(proxy, "\n");
377 LIST_FOR_EACH_ENTRY( arg, cur->args, const var_t, entry )
378 print_proxy("%s = 0;\n", arg->name);
380 print_proxy("RpcTryFinally\n");
383 print_proxy("if ((_pRpcMessage->DataRepresentation & 0xffff) != NDR_LOCAL_DATA_REPRESENTATION)\n");
385 print_proxy("NdrConvert( &_StubMsg, &__MIDL_ProcFormatString.Format[%u]);\n", proc_offset );
387 fprintf(proxy, "\n");
389 write_remoting_arguments(proxy, indent, cur, PASS_IN, PHASE_UNMARSHAL);
390 fprintf(proxy, "\n");
392 assign_stub_out_args( proxy, indent, cur );
394 print_proxy("*_pdwStubPhase = STUB_CALL_SERVER;\n");
395 fprintf(proxy, "\n");
397 if (has_ret) fprintf(proxy, "_RetVal = ");
398 if (cas) fprintf(proxy, "%s_%s_Stub", iface->name, cas);
401 fprintf(proxy, "_This->lpVtbl->");
402 write_name(proxy, def);
404 fprintf(proxy, "(_This");
408 LIST_FOR_EACH_ENTRY( arg, cur->args, const var_t, entry )
410 fprintf(proxy, ", ");
413 write_name(proxy, arg);
416 fprintf(proxy, ");\n");
417 fprintf(proxy, "\n");
418 print_proxy("*_pdwStubPhase = STUB_MARSHAL;\n");
419 fprintf(proxy, "\n");
421 write_remoting_arguments(proxy, indent, cur, PASS_OUT, PHASE_BUFFERSIZE);
423 print_proxy("NdrStubGetBuffer(This, _pRpcChannelBuffer, &_StubMsg);\n");
425 write_remoting_arguments(proxy, indent, cur, PASS_OUT, PHASE_MARSHAL);
426 fprintf(proxy, "\n");
429 print_phase_basetype(proxy, indent, PHASE_MARSHAL, PASS_RETURN, def, "_RetVal");
433 print_proxy("RpcFinally\n");
436 write_remoting_arguments(proxy, indent+1, cur, PASS_OUT, PHASE_FREE);
439 print_proxy("RpcEndFinally\n");
441 print_proxy("_pRpcMessage->BufferLength = _StubMsg.Buffer - (unsigned char *)_pRpcMessage->Buffer;\n");
448 static int write_proxy_methods(type_t *iface)
453 if (iface->ref) i = write_proxy_methods(iface->ref);
454 if (iface->funcs) LIST_FOR_EACH_ENTRY( cur, iface->funcs, const func_t, entry ) {
455 var_t *def = cur->def;
456 if (!is_callas(def->attrs)) {
457 if (i) fprintf(proxy, ",\n");
458 print_proxy( "%s_", iface->name);
459 write_name(proxy, def);
460 fprintf(proxy, "_Proxy");
467 static int write_stub_methods(type_t *iface)
472 if (iface->ref) i = write_stub_methods(iface->ref);
473 else return i; /* skip IUnknown */
475 if (iface->funcs) LIST_FOR_EACH_ENTRY( cur, iface->funcs, const func_t, entry ) {
476 var_t *def = cur->def;
477 if (!is_local(def->attrs)) {
478 if (i) fprintf(proxy,",\n");
479 print_proxy( "%s_", iface->name);
480 write_name(proxy, def);
481 fprintf(proxy, "_Stub");
488 static void write_proxy(type_t *iface, unsigned int *proc_offset)
490 int midx = -1, stubs;
493 if (!iface->funcs) return;
495 /* FIXME: check for [oleautomation], shouldn't generate proxies/stubs if specified */
497 fprintf(proxy, "/*****************************************************************************\n");
498 fprintf(proxy, " * %s interface\n", iface->name);
499 fprintf(proxy, " */\n");
500 LIST_FOR_EACH_ENTRY( cur, iface->funcs, const func_t, entry )
502 const var_t *def = cur->def;
503 if (!is_local(def->attrs)) {
504 const var_t *cas = is_callas(def->attrs);
505 const char *cname = cas ? cas->name : NULL;
509 LIST_FOR_EACH_ENTRY( m, iface->funcs, const func_t, entry )
510 if (!strcmp(get_name(m->def), cname))
516 gen_proxy(iface, cur, idx, *proc_offset);
517 gen_stub(iface, cur, cname, *proc_offset);
518 *proc_offset += get_size_procformatstring_func( cur );
519 if (midx == -1) midx = idx;
520 else if (midx != idx) parser_error("method index mismatch in write_proxy");
526 print_proxy( "static const CINTERFACE_PROXY_VTABLE(%d) _%sProxyVtbl =\n", midx, iface->name);
529 print_proxy( "{\n", iface->name);
531 print_proxy( "&IID_%s,\n", iface->name);
533 print_proxy( "},\n");
536 write_proxy_methods(iface);
537 fprintf(proxy, "\n");
541 print_proxy( "};\n");
542 fprintf(proxy, "\n\n");
545 print_proxy( "static const PRPC_STUB_FUNCTION %s_table[] =\n", iface->name);
548 stubs = write_stub_methods(iface);
549 fprintf(proxy, "\n");
551 fprintf(proxy, "};\n");
553 print_proxy( "static const CInterfaceStubVtbl _%sStubVtbl =\n", iface->name);
558 print_proxy( "&IID_%s,\n", iface->name);
559 print_proxy( "0,\n");
560 print_proxy( "%d,\n", stubs+3);
561 print_proxy( "&%s_table[-3],\n", iface->name);
563 print_proxy( "},\n", iface->name);
566 print_proxy( "CStdStubBuffer_METHODS\n");
570 print_proxy( "};\n");
574 void write_proxies(ifref_list_t *ifaces)
577 char *file_id = proxy_token;
579 unsigned int proc_offset = 0;
581 if (!do_proxies) return;
582 if (do_everything && !ifaces) return;
588 LIST_FOR_EACH_ENTRY( cur, ifaces, ifref_t, entry )
589 if (is_object(cur->iface->attrs) && !is_local(cur->iface->attrs))
590 write_proxy(cur->iface, &proc_offset);
594 print_proxy( "#if !defined(__RPC_WIN32__)\n");
595 print_proxy( "#error Currently only Wine and WIN32 are supported.\n");
596 print_proxy( "#endif\n");
598 write_procformatstring(proxy, ifaces, 1);
599 write_typeformatstring(proxy, ifaces, 1);
601 fprintf(proxy, "static const CInterfaceProxyVtbl* const _%s_ProxyVtblList[] =\n", file_id);
602 fprintf(proxy, "{\n");
604 LIST_FOR_EACH_ENTRY( cur, ifaces, ifref_t, entry )
605 if(cur->iface->ref && cur->iface->funcs &&
606 is_object(cur->iface->attrs) && !is_local(cur->iface->attrs))
607 fprintf(proxy, " (const CInterfaceProxyVtbl*)&_%sProxyVtbl,\n", cur->iface->name);
609 fprintf(proxy, " 0\n");
610 fprintf(proxy, "};\n");
611 fprintf(proxy, "\n");
613 fprintf(proxy, "static const CInterfaceStubVtbl* const _%s_StubVtblList[] =\n", file_id);
614 fprintf(proxy, "{\n");
616 LIST_FOR_EACH_ENTRY( cur, ifaces, ifref_t, entry )
617 if(cur->iface->ref && cur->iface->funcs &&
618 is_object(cur->iface->attrs) && !is_local(cur->iface->attrs))
619 fprintf(proxy, " (const CInterfaceStubVtbl*)&_%sStubVtbl,\n", cur->iface->name);
620 fprintf(proxy, " 0\n");
621 fprintf(proxy, "};\n");
622 fprintf(proxy, "\n");
624 fprintf(proxy, "static PCInterfaceName const _%s_InterfaceNamesList[] =\n", file_id);
625 fprintf(proxy, "{\n");
627 LIST_FOR_EACH_ENTRY( cur, ifaces, ifref_t, entry )
628 if(cur->iface->ref && cur->iface->funcs &&
629 is_object(cur->iface->attrs) && !is_local(cur->iface->attrs))
630 fprintf(proxy, " \"%s\",\n", cur->iface->name);
631 fprintf(proxy, " 0\n");
632 fprintf(proxy, "};\n");
633 fprintf(proxy, "\n");
635 fprintf(proxy, "#define _%s_CHECK_IID(n) IID_GENERIC_CHECK_IID(_%s, pIID, n)\n", file_id, file_id);
636 fprintf(proxy, "\n");
637 fprintf(proxy, "int __stdcall _%s_IID_Lookup(const IID* pIID, int* pIndex)\n", file_id);
638 fprintf(proxy, "{\n");
641 LIST_FOR_EACH_ENTRY( cur, ifaces, ifref_t, entry )
644 fprintf(proxy, " if (!_%s_CHECK_IID(%d))\n", file_id, c);
645 fprintf(proxy, " {\n");
646 fprintf(proxy, " *pIndex = %d;\n", c);
647 fprintf(proxy, " return 1;\n");
648 fprintf(proxy, " }\n");
651 fprintf(proxy, " return 0;\n");
652 fprintf(proxy, "}\n");
653 fprintf(proxy, "\n");
655 fprintf(proxy, "const ExtendedProxyFileInfo %s_ProxyFileInfo =\n", file_id);
656 fprintf(proxy, "{\n");
657 fprintf(proxy, " (const PCInterfaceProxyVtblList*)&_%s_ProxyVtblList,\n", file_id);
658 fprintf(proxy, " (const PCInterfaceStubVtblList*)&_%s_StubVtblList,\n", file_id);
659 fprintf(proxy, " _%s_InterfaceNamesList,\n", file_id);
660 fprintf(proxy, " 0,\n");
661 fprintf(proxy, " &_%s_IID_Lookup,\n", file_id);
662 fprintf(proxy, " %d,\n", c);
663 fprintf(proxy, " 1,\n");
664 fprintf(proxy, " 0,\n");
665 fprintf(proxy, " 0,\n");
666 fprintf(proxy, " 0,\n");
667 fprintf(proxy, " 0\n");
668 fprintf(proxy, "};\n");