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 v->ptr_level || 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 )
197 int index = 0; /* FIXME */
201 expr = get_attrp( arg->attrs, ATTR_SIZEIS );
204 print_proxy( "_StubMsg.MaxCount = ", arg->name );
205 write_expr(proxy, expr, 0);
206 fprintf(proxy, ";\n\n");
207 print_proxy( "NdrClearOutParameters( &_StubMsg, ");
208 fprintf(proxy, "&__MIDL_TypeFormatString.Format[%d], ", index );
209 fprintf(proxy, "(void*)%s );\n", arg->name );
230 constraint = get_attrp( arg->attrs, ATTR_IIDIS );
232 print_proxy( "_StubMsg.MaxCount = (unsigned long) ( %s );\n",constraint->name);
233 print_proxy( "NdrClearOutParameters( &_StubMsg, ");
234 fprintf(proxy, "&__MIDL_TypeFormatString.Format[%d], ", index );
235 fprintf(proxy, "(void*)%s );\n", arg->name );
239 print_proxy("/* FIXME: %s code for %s type %d missing */\n", __FUNCTION__, arg->name, type->type );
243 static void proxy_free_variables( var_list_t *args )
248 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");
258 static void gen_proxy(type_t *iface, const func_t *cur, int idx,
259 unsigned int proc_offset, unsigned int *type_offset)
261 var_t *def = cur->def;
262 int has_ret = !is_void(def->type, def);
266 write_type(proxy, def->type, def, def->tname);
267 print_proxy( " STDMETHODCALLTYPE %s_", iface->name);
268 write_name(proxy, def);
269 print_proxy( "_Proxy(\n");
270 write_args(proxy, cur->args, iface->name, 1, TRUE);
274 /* local variables */
277 write_type(proxy, def->type, def, def->tname);
278 print_proxy( " _RetVal;\n");
280 print_proxy( "RPC_MESSAGE _RpcMessage;\n" );
281 print_proxy( "MIDL_STUB_MESSAGE _StubMsg;\n" );
285 clear_output_vars( cur->args );
287 print_proxy( "RpcTryExcept\n" );
288 print_proxy( "{\n" );
290 print_proxy( "NdrProxyInitialize(This, &_RpcMessage, &_StubMsg, &Object_StubDesc, %d);\n", idx);
291 proxy_check_pointers( cur->args );
293 print_proxy( "RpcTryFinally\n" );
294 print_proxy( "{\n" );
297 offset = *type_offset;
298 write_remoting_arguments(proxy, indent, cur, &offset, PASS_IN, PHASE_BUFFERSIZE);
300 print_proxy( "NdrProxyGetBuffer(This, &_StubMsg);\n" );
302 offset = *type_offset;
303 write_remoting_arguments(proxy, indent, cur, type_offset, PASS_IN, PHASE_MARSHAL);
305 print_proxy( "NdrProxySendReceive(This, &_StubMsg);\n" );
306 fprintf(proxy, "\n");
307 print_proxy( "_StubMsg.BufferStart = _RpcMessage.Buffer;\n" );
308 print_proxy( "_StubMsg.BufferEnd = _StubMsg.BufferStart + _RpcMessage.BufferLength;\n\n" );
310 print_proxy("if ((_RpcMessage.DataRepresentation & 0xffff) != NDR_LOCAL_DATA_REPRESENTATION)\n");
312 print_proxy("NdrConvert( &_StubMsg, &__MIDL_ProcFormatString.Format[%u]);\n", proc_offset );
314 fprintf(proxy, "\n");
316 write_remoting_arguments(proxy, indent, cur, &offset, PASS_OUT, PHASE_UNMARSHAL);
319 print_phase_basetype(proxy, indent, PHASE_UNMARSHAL, PASS_RETURN, def, "_RetVal");
323 print_proxy( "RpcFinally\n" );
324 print_proxy( "{\n" );
326 print_proxy( "NdrProxyFreeBuffer(This, &_StubMsg);\n" );
329 print_proxy( "RpcEndFinally\n" );
331 print_proxy( "}\n" );
332 print_proxy( "RpcExcept(_StubMsg.dwStubPhase != PROXY_SENDRECEIVE)\n" );
333 print_proxy( "{\n" );
336 proxy_free_variables( cur->args );
337 print_proxy( "_RetVal = NdrProxyErrorHandler(RpcExceptionCode());\n" );
340 print_proxy( "}\n" );
341 print_proxy( "RpcEndExcept\n" );
344 print_proxy( "return _RetVal;\n" );
351 static void gen_stub(type_t *iface, const func_t *cur, const char *cas,
352 unsigned int proc_offset, unsigned int *type_offset)
354 var_t *def = cur->def;
356 int has_ret = !is_void(def->type, def);
360 print_proxy( "void __RPC_STUB %s_", iface->name);
361 write_name(proxy, def);
362 print_proxy( "_Stub(\n");
364 print_proxy( "IRpcStubBuffer* This,\n");
365 print_proxy( "IRpcChannelBuffer *_pRpcChannelBuffer,\n");
366 print_proxy( "PRPC_MESSAGE _pRpcMessage,\n");
367 print_proxy( "DWORD* _pdwStubPhase)\n");
371 print_proxy("%s * _This = (%s*)((CStdStubBuffer*)This)->pvServerObject;\n", iface->name, iface->name);
372 print_proxy("MIDL_STUB_MESSAGE _StubMsg;\n");
373 declare_stub_args( proxy, indent, cur );
374 fprintf(proxy, "\n");
378 print_proxy("NdrStubInitialize(_pRpcMessage, &_StubMsg, &Object_StubDesc, _pRpcChannelBuffer);\n");
379 fprintf(proxy, "\n");
382 LIST_FOR_EACH_ENTRY( arg, cur->args, const var_t, entry )
383 print_proxy("%s = 0;\n", arg->name);
385 print_proxy("RpcTryFinally\n");
388 print_proxy("if ((_pRpcMessage->DataRepresentation & 0xffff) != NDR_LOCAL_DATA_REPRESENTATION)\n");
390 print_proxy("NdrConvert( &_StubMsg, &__MIDL_ProcFormatString.Format[%u]);\n", proc_offset );
392 fprintf(proxy, "\n");
394 offset = *type_offset;
395 write_remoting_arguments(proxy, indent, cur, &offset, PASS_IN, PHASE_UNMARSHAL);
396 fprintf(proxy, "\n");
398 assign_stub_out_args( proxy, indent, cur );
400 print_proxy("*_pdwStubPhase = STUB_CALL_SERVER;\n");
401 fprintf(proxy, "\n");
403 if (has_ret) fprintf(proxy, "_RetVal = ");
404 fprintf(proxy, "%s_", iface->name);
405 if (cas) fprintf(proxy, "%s_Stub", cas);
406 else write_name(proxy, def);
407 fprintf(proxy, "(_This");
411 LIST_FOR_EACH_ENTRY( arg, cur->args, const var_t, entry )
413 fprintf(proxy, ", ");
414 write_name(proxy, arg);
417 fprintf(proxy, ");\n");
418 fprintf(proxy, "\n");
419 print_proxy("*_pdwStubPhase = STUB_MARSHAL;\n");
420 fprintf(proxy, "\n");
422 offset = *type_offset;
423 write_remoting_arguments(proxy, indent, cur, &offset, PASS_OUT, PHASE_BUFFERSIZE);
425 print_proxy("NdrStubGetBuffer(This, _pRpcChannelBuffer, &_StubMsg);\n");
427 offset = *type_offset;
428 write_remoting_arguments(proxy, indent, cur, &offset, PASS_OUT, PHASE_MARSHAL);
429 fprintf(proxy, "\n");
432 print_phase_basetype(proxy, indent, PHASE_MARSHAL, PASS_RETURN, def, "_RetVal");
436 print_proxy("RpcFinally\n");
439 offset = *type_offset;
440 write_remoting_arguments(proxy, indent+1, cur, &offset, PASS_OUT, PHASE_FREE);
443 print_proxy("RpcEndFinally\n");
445 print_proxy("_pRpcMessage->BufferLength = _StubMsg.Buffer - (unsigned char *)_pRpcMessage->Buffer;\n");
452 static int write_proxy_methods(type_t *iface)
457 if (iface->ref) i = write_proxy_methods(iface->ref);
458 if (iface->funcs) LIST_FOR_EACH_ENTRY( cur, iface->funcs, const func_t, entry ) {
459 var_t *def = cur->def;
460 if (!is_callas(def->attrs)) {
461 if (i) fprintf(proxy, ",\n");
462 print_proxy( "%s_", iface->name);
463 write_name(proxy, def);
464 fprintf(proxy, "_Proxy");
471 static int write_stub_methods(type_t *iface)
476 if (iface->ref) i = write_stub_methods(iface->ref);
477 else return i; /* skip IUnknown */
479 if (iface->funcs) LIST_FOR_EACH_ENTRY( cur, iface->funcs, const func_t, entry ) {
480 var_t *def = cur->def;
481 if (!is_local(def->attrs)) {
482 if (i) fprintf(proxy,",\n");
483 print_proxy( "%s_", iface->name);
484 write_name(proxy, def);
485 fprintf(proxy, "_Stub");
492 static void write_proxy(type_t *iface, unsigned int *proc_offset, unsigned int *type_offset)
494 int midx = -1, stubs;
498 if (!iface->funcs) return;
500 /* FIXME: check for [oleautomation], shouldn't generate proxies/stubs if specified */
502 fprintf(proxy, "/*****************************************************************************\n");
503 fprintf(proxy, " * %s interface\n", iface->name);
504 fprintf(proxy, " */\n");
505 LIST_FOR_EACH_ENTRY( cur, iface->funcs, const func_t, entry )
507 const var_t *def = cur->def;
508 if (!is_local(def->attrs)) {
509 const var_t *cas = is_callas(def->attrs);
510 const char *cname = cas ? cas->name : NULL;
514 LIST_FOR_EACH_ENTRY( m, iface->funcs, const func_t, entry )
515 if (!strcmp(get_name(m->def), cname))
521 offset = *type_offset;
522 gen_proxy(iface, cur, idx, *proc_offset, type_offset);
523 gen_stub(iface, cur, cname, *proc_offset, &offset);
524 *proc_offset += get_size_procformatstring_func( cur );
525 if (midx == -1) midx = idx;
526 else if (midx != idx) parser_error("method index mismatch in write_proxy");
532 print_proxy( "const CINTERFACE_PROXY_VTABLE(%d) _%sProxyVtbl =\n", midx, iface->name);
535 print_proxy( "{\n", iface->name);
537 print_proxy( "&IID_%s,\n", iface->name);
539 print_proxy( "},\n");
542 write_proxy_methods(iface);
543 fprintf(proxy, "\n");
547 print_proxy( "};\n");
548 fprintf(proxy, "\n\n");
551 print_proxy( "static const PRPC_STUB_FUNCTION %s_table[] =\n", iface->name);
554 stubs = write_stub_methods(iface);
555 fprintf(proxy, "\n");
557 fprintf(proxy, "};\n");
559 print_proxy( "const CInterfaceStubVtbl _%sStubVtbl =\n", iface->name);
564 print_proxy( "&IID_%s,\n", iface->name);
565 print_proxy( "0,\n");
566 print_proxy( "%d,\n", stubs+3);
567 print_proxy( "&%s_table[-3],\n", iface->name);
569 print_proxy( "},\n", iface->name);
572 print_proxy( "CStdStubBuffer_METHODS\n");
576 print_proxy( "};\n");
580 void write_proxies(ifref_list_t *ifaces)
583 char *file_id = proxy_token;
585 unsigned int proc_offset = 0, type_offset = 0;
587 if (!do_proxies) return;
588 if (do_everything && !ifaces) return;
594 LIST_FOR_EACH_ENTRY( cur, ifaces, ifref_t, entry )
595 if (is_object(cur->iface->attrs) && !is_local(cur->iface->attrs))
596 write_proxy(cur->iface, &proc_offset, &type_offset);
600 print_proxy( "#if !defined(__RPC_WIN32__)\n");
601 print_proxy( "#error Currently only Wine and WIN32 are supported.\n");
602 print_proxy( "#endif\n");
604 write_procformatstring(proxy, ifaces, 1);
605 write_typeformatstring(proxy, ifaces, 1);
607 fprintf(proxy, "const CInterfaceProxyVtbl* _%s_ProxyVtblList[] =\n", file_id);
608 fprintf(proxy, "{\n");
610 LIST_FOR_EACH_ENTRY( cur, ifaces, ifref_t, entry )
611 if(cur->iface->ref && cur->iface->funcs &&
612 is_object(cur->iface->attrs) && !is_local(cur->iface->attrs))
613 fprintf(proxy, " (CInterfaceProxyVtbl*)&_%sProxyVtbl,\n", cur->iface->name);
615 fprintf(proxy, " 0\n");
616 fprintf(proxy, "};\n");
617 fprintf(proxy, "\n");
619 fprintf(proxy, "const CInterfaceStubVtbl* _%s_StubVtblList[] =\n", file_id);
620 fprintf(proxy, "{\n");
622 LIST_FOR_EACH_ENTRY( cur, ifaces, ifref_t, entry )
623 if(cur->iface->ref && cur->iface->funcs &&
624 is_object(cur->iface->attrs) && !is_local(cur->iface->attrs))
625 fprintf(proxy, " (CInterfaceStubVtbl*)&_%sStubVtbl,\n", cur->iface->name);
626 fprintf(proxy, " 0\n");
627 fprintf(proxy, "};\n");
628 fprintf(proxy, "\n");
630 fprintf(proxy, "PCInterfaceName const _%s_InterfaceNamesList[] =\n", file_id);
631 fprintf(proxy, "{\n");
633 LIST_FOR_EACH_ENTRY( cur, ifaces, ifref_t, entry )
634 if(cur->iface->ref && cur->iface->funcs &&
635 is_object(cur->iface->attrs) && !is_local(cur->iface->attrs))
636 fprintf(proxy, " \"%s\",\n", cur->iface->name);
637 fprintf(proxy, " 0\n");
638 fprintf(proxy, "};\n");
639 fprintf(proxy, "\n");
641 fprintf(proxy, "#define _%s_CHECK_IID(n) IID_GENERIC_CHECK_IID(_%s, pIID, n)\n", file_id, file_id);
642 fprintf(proxy, "\n");
643 fprintf(proxy, "int __stdcall _%s_IID_Lookup(const IID* pIID, int* pIndex)\n", file_id);
644 fprintf(proxy, "{\n");
647 LIST_FOR_EACH_ENTRY( cur, ifaces, ifref_t, entry )
650 fprintf(proxy, " if (!_%s_CHECK_IID(%d))\n", file_id, c);
651 fprintf(proxy, " {\n");
652 fprintf(proxy, " *pIndex = %d;\n", c);
653 fprintf(proxy, " return 1;\n");
654 fprintf(proxy, " }\n");
657 fprintf(proxy, " return 0;\n");
658 fprintf(proxy, "}\n");
659 fprintf(proxy, "\n");
661 fprintf(proxy, "const ExtendedProxyFileInfo %s_ProxyFileInfo =\n", file_id);
662 fprintf(proxy, "{\n");
663 fprintf(proxy, " (PCInterfaceProxyVtblList*)&_%s_ProxyVtblList,\n", file_id);
664 fprintf(proxy, " (PCInterfaceStubVtblList*)&_%s_StubVtblList,\n", file_id);
665 fprintf(proxy, " (const PCInterfaceName*)&_%s_InterfaceNamesList,\n", file_id);
666 fprintf(proxy, " 0,\n");
667 fprintf(proxy, " &_%s_IID_Lookup,\n", file_id);
668 fprintf(proxy, " %d,\n", c);
669 fprintf(proxy, " 1,\n");
670 fprintf(proxy, " 0,\n");
671 fprintf(proxy, " 0,\n");
672 fprintf(proxy, " 0,\n");
673 fprintf(proxy, " 0\n");
674 fprintf(proxy, "};\n");