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"
39 #define END_OF_LIST(list) \
42 while (NEXT_LINK(list)) \
43 list = NEXT_LINK(list); \
48 static int indent = 0;
50 /* FIXME: support generation of stubless proxies */
52 static void print_proxy( const char *format, ... )
55 va_start( va, format );
56 print( proxy, indent, format, va );
60 static void write_stubdescproto(void)
62 print_proxy( "static const MIDL_STUB_DESC Object_StubDesc;\n");
66 static void write_stubdesc(int expr_eval_routines)
68 print_proxy( "static const MIDL_STUB_DESC Object_StubDesc =\n{\n");
71 print_proxy( "NdrOleAllocate,\n");
72 print_proxy( "NdrOleFree,\n");
73 print_proxy( "{0}, 0, 0, %s, 0,\n", expr_eval_routines ? "ExprEvalRoutines" : "0");
74 print_proxy( "__MIDL_TypeFormatString.Format,\n");
75 print_proxy( "1, /* -error bounds_check flag */\n");
76 print_proxy( "0x10001, /* Ndr library version */\n");
78 print_proxy( "0x50100a4, /* MIDL Version 5.1.164 */\n");
80 print_proxy("%s,\n", list_empty(&user_type_list) ? "0" : "UserMarshalRoutines");
81 print_proxy( "0, /* notify & notify_flag routine table */\n");
82 print_proxy( "1, /* Flags */\n");
83 print_proxy( "0, /* Reserved3 */\n");
84 print_proxy( "0, /* Reserved4 */\n");
85 print_proxy( "0 /* Reserved5 */\n");
91 static void init_proxy(ifref_list_t *ifaces)
94 if(!(proxy = fopen(proxy_name, "w")))
95 error("Could not open %s for output\n", proxy_name);
96 print_proxy( "/*** Autogenerated by WIDL %s from %s - Do not edit ***/\n", PACKAGE_VERSION, input_name);
98 print_proxy( "#ifndef __REDQ_RPCPROXY_H_VERSION__\n");
99 print_proxy( "#define __REQUIRED_RPCPROXY_H_VERSION__ 440\n");
100 print_proxy( "#endif /* __REDQ_RPCPROXY_H_VERSION__ */\n");
102 print_proxy( "#define __midl_proxy\n");
103 print_proxy( "#include \"objbase.h\"\n");
104 print_proxy( "#include \"rpcproxy.h\"\n");
105 print_proxy( "#ifndef __RPCPROXY_H_VERSION__\n");
106 print_proxy( "#error This code needs a newer version of rpcproxy.h\n");
107 print_proxy( "#endif /* __RPCPROXY_H_VERSION__ */\n");
109 print_proxy( "#include \"%s\"\n", header_name);
111 write_formatstringsdecl(proxy, indent, ifaces, need_proxy);
112 write_stubdescproto();
115 static void clear_output_vars( const var_list_t *args )
120 LIST_FOR_EACH_ENTRY( arg, args, const var_t, entry )
122 if (is_attr(arg->attrs, ATTR_OUT) && !is_attr(arg->attrs, ATTR_IN)) {
123 print_proxy( "if(%s)\n", arg->name );
125 print_proxy( "MIDL_memset( %s, 0, sizeof( *%s ));\n", arg->name, arg->name );
131 int is_var_ptr(const var_t *v)
133 return is_ptr(v->type);
136 int cant_be_null(const var_t *v)
138 /* Search backwards for the most recent pointer attribute. */
139 const attr_list_t *attrs = v->attrs;
140 const type_t *type = v->type;
150 int t = get_attrv(attrs, ATTR_POINTERTYPE);
152 if (t == RPC_FC_FP || t == RPC_FC_OP || t == RPC_FC_UP)
167 return 1; /* Default is RPC_FC_RP. */
170 static void proxy_check_pointers( const var_list_t *args )
175 LIST_FOR_EACH_ENTRY( arg, args, const var_t, entry )
177 if (is_var_ptr(arg) && cant_be_null(arg)) {
178 print_proxy( "if(!%s)\n", arg->name );
180 print_proxy( "RpcRaiseException(RPC_X_NULL_REF_POINTER);\n");
186 static void free_variable( const var_t *arg )
188 unsigned int type_offset = arg->type->typestring_offset;
190 type_t *type = arg->type;
191 expr_t *size = get_size_is_expr(type, arg->name);
195 print_proxy( "_StubMsg.MaxCount = " );
196 write_expr(proxy, size, 0);
197 fprintf(proxy, ";\n\n");
198 print_proxy( "NdrClearOutParameters( &_StubMsg, ");
199 fprintf(proxy, "&__MIDL_TypeFormatString.Format[%u], ", type_offset );
200 fprintf(proxy, "(void*)%s );\n", arg->name );
220 iid = get_attrp( arg->attrs, ATTR_IIDIS );
223 print_proxy( "_StubMsg.MaxCount = (unsigned long) " );
224 write_expr(proxy, iid, 1);
225 print_proxy( ";\n\n" );
227 print_proxy( "NdrClearOutParameters( &_StubMsg, ");
228 fprintf(proxy, "&__MIDL_TypeFormatString.Format[%u], ", type_offset );
229 fprintf(proxy, "(void*)%s );\n", arg->name );
233 print_proxy("/* FIXME: %s code for %s type %d missing */\n", __FUNCTION__, arg->name, type->type );
237 static void proxy_free_variables( var_list_t *args )
242 LIST_FOR_EACH_ENTRY( arg, args, const var_t, entry )
243 if (is_attr(arg->attrs, ATTR_OUT))
245 free_variable( arg );
246 fprintf(proxy, "\n");
250 static void gen_proxy(type_t *iface, const func_t *cur, int idx,
251 unsigned int proc_offset)
253 var_t *def = cur->def;
254 int has_ret = !is_void(def->type);
255 int has_full_pointer = is_full_pointer_function(cur);
258 write_type_decl_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_decl_left(proxy, def->type);
270 print_proxy( " _RetVal;\n");
272 print_proxy( "RPC_MESSAGE _RpcMessage;\n" );
273 print_proxy( "MIDL_STUB_MESSAGE _StubMsg;\n" );
275 if (decl_indirect(def->type))
276 print_proxy("void *_p_%s = &%s;\n",
277 "_RetVal", "_RetVal");
281 if (has_full_pointer)
282 write_full_pointer_init(proxy, indent, cur, FALSE);
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 write_remoting_arguments(proxy, indent, cur, PASS_IN, PHASE_BUFFERSIZE);
299 print_proxy( "NdrProxyGetBuffer(This, &_StubMsg);\n" );
301 write_remoting_arguments(proxy, indent, cur, PASS_IN, PHASE_MARSHAL);
303 print_proxy( "NdrProxySendReceive(This, &_StubMsg);\n" );
304 fprintf(proxy, "\n");
305 print_proxy( "_StubMsg.BufferStart = _RpcMessage.Buffer;\n" );
306 print_proxy( "_StubMsg.BufferEnd = _StubMsg.BufferStart + _RpcMessage.BufferLength;\n\n" );
308 print_proxy("if ((_RpcMessage.DataRepresentation & 0xffff) != NDR_LOCAL_DATA_REPRESENTATION)\n");
310 print_proxy("NdrConvert( &_StubMsg, &__MIDL_ProcFormatString.Format[%u]);\n", proc_offset );
312 fprintf(proxy, "\n");
314 write_remoting_arguments(proxy, indent, cur, PASS_OUT, PHASE_UNMARSHAL);
318 if (decl_indirect(def->type))
319 print_proxy("MIDL_memset(&%s, 0, sizeof(%s));\n", "_RetVal", "_RetVal");
320 else if (is_ptr(def->type) || is_array(def->type))
321 print_proxy("%s = 0;\n", "_RetVal");
322 write_remoting_arguments(proxy, indent, cur, PASS_RETURN, PHASE_UNMARSHAL);
327 print_proxy( "RpcFinally\n" );
328 print_proxy( "{\n" );
330 if (has_full_pointer)
331 write_full_pointer_free(proxy, indent, cur);
332 print_proxy( "NdrProxyFreeBuffer(This, &_StubMsg);\n" );
335 print_proxy( "RpcEndFinally\n" );
337 print_proxy( "}\n" );
338 print_proxy( "RpcExcept(_StubMsg.dwStubPhase != PROXY_SENDRECEIVE)\n" );
339 print_proxy( "{\n" );
342 proxy_free_variables( cur->args );
343 print_proxy( "_RetVal = NdrProxyErrorHandler(RpcExceptionCode());\n" );
346 print_proxy( "}\n" );
347 print_proxy( "RpcEndExcept\n" );
350 print_proxy( "return _RetVal;\n" );
357 static void gen_stub(type_t *iface, const func_t *cur, const char *cas,
358 unsigned int proc_offset)
360 var_t *def = cur->def;
362 int has_ret = !is_void(def->type);
363 int has_full_pointer = is_full_pointer_function(cur);
366 print_proxy( "void __RPC_STUB %s_", iface->name);
367 write_name(proxy, def);
368 print_proxy( "_Stub(\n");
370 print_proxy( "IRpcStubBuffer* This,\n");
371 print_proxy( "IRpcChannelBuffer *_pRpcChannelBuffer,\n");
372 print_proxy( "PRPC_MESSAGE _pRpcMessage,\n");
373 print_proxy( "DWORD* _pdwStubPhase)\n");
377 print_proxy("%s * _This = (%s*)((CStdStubBuffer*)This)->pvServerObject;\n", iface->name, iface->name);
378 print_proxy("MIDL_STUB_MESSAGE _StubMsg;\n");
379 declare_stub_args( proxy, indent, cur );
380 fprintf(proxy, "\n");
384 print_proxy("NdrStubInitialize(_pRpcMessage, &_StubMsg, &Object_StubDesc, _pRpcChannelBuffer);\n");
385 fprintf(proxy, "\n");
387 write_parameters_init(proxy, indent, cur);
389 print_proxy("RpcTryFinally\n");
392 if (has_full_pointer)
393 write_full_pointer_init(proxy, indent, cur, TRUE);
394 print_proxy("if ((_pRpcMessage->DataRepresentation & 0xffff) != NDR_LOCAL_DATA_REPRESENTATION)\n");
396 print_proxy("NdrConvert( &_StubMsg, &__MIDL_ProcFormatString.Format[%u]);\n", proc_offset );
398 fprintf(proxy, "\n");
400 write_remoting_arguments(proxy, indent, cur, PASS_IN, PHASE_UNMARSHAL);
401 fprintf(proxy, "\n");
403 assign_stub_out_args( proxy, indent, cur );
405 print_proxy("*_pdwStubPhase = STUB_CALL_SERVER;\n");
406 fprintf(proxy, "\n");
408 if (has_ret) fprintf(proxy, "_RetVal = ");
409 if (cas) fprintf(proxy, "%s_%s_Stub", iface->name, cas);
412 fprintf(proxy, "_This->lpVtbl->");
413 write_name(proxy, def);
415 fprintf(proxy, "(_This");
419 LIST_FOR_EACH_ENTRY( arg, cur->args, const var_t, entry )
421 fprintf(proxy, ", ");
422 if (arg->type->declarray)
424 write_name(proxy, arg);
427 fprintf(proxy, ");\n");
428 fprintf(proxy, "\n");
429 print_proxy("*_pdwStubPhase = STUB_MARSHAL;\n");
430 fprintf(proxy, "\n");
432 write_remoting_arguments(proxy, indent, cur, PASS_OUT, PHASE_BUFFERSIZE);
434 print_proxy("NdrStubGetBuffer(This, _pRpcChannelBuffer, &_StubMsg);\n");
436 write_remoting_arguments(proxy, indent, cur, PASS_OUT, PHASE_MARSHAL);
437 fprintf(proxy, "\n");
440 print_phase_basetype(proxy, indent, PHASE_MARSHAL, PASS_RETURN, def, "_RetVal");
444 print_proxy("RpcFinally\n");
447 write_remoting_arguments(proxy, indent+1, cur, PASS_OUT, PHASE_FREE);
449 if (has_full_pointer)
450 write_full_pointer_free(proxy, indent, cur);
453 print_proxy("RpcEndFinally\n");
455 print_proxy("_pRpcMessage->BufferLength = _StubMsg.Buffer - (unsigned char *)_pRpcMessage->Buffer;\n");
462 static int write_proxy_methods(type_t *iface)
467 if (iface->ref) i = write_proxy_methods(iface->ref);
468 if (iface->funcs) LIST_FOR_EACH_ENTRY( cur, iface->funcs, const func_t, entry ) {
469 var_t *def = cur->def;
470 if (!is_callas(def->attrs)) {
471 if (i) fprintf(proxy, ",\n");
472 print_proxy( "%s_", iface->name);
473 write_name(proxy, def);
474 fprintf(proxy, "_Proxy");
481 static int write_stub_methods(type_t *iface)
486 if (iface->ref) i = write_stub_methods(iface->ref);
487 else return i; /* skip IUnknown */
489 if (iface->funcs) LIST_FOR_EACH_ENTRY( cur, iface->funcs, const func_t, entry ) {
490 var_t *def = cur->def;
491 if (!is_local(def->attrs)) {
492 if (i) fprintf(proxy,",\n");
493 print_proxy( "%s_", iface->name);
494 write_name(proxy, def);
495 fprintf(proxy, "_Stub");
502 static void write_proxy(type_t *iface, unsigned int *proc_offset)
504 int midx = -1, stubs;
507 if (!iface->funcs) return;
509 /* FIXME: check for [oleautomation], shouldn't generate proxies/stubs if specified */
511 fprintf(proxy, "/*****************************************************************************\n");
512 fprintf(proxy, " * %s interface\n", iface->name);
513 fprintf(proxy, " */\n");
514 LIST_FOR_EACH_ENTRY( cur, iface->funcs, const func_t, entry )
516 const var_t *def = cur->def;
517 if (!is_local(def->attrs)) {
518 const var_t *cas = is_callas(def->attrs);
519 const char *cname = cas ? cas->name : NULL;
523 LIST_FOR_EACH_ENTRY( m, iface->funcs, const func_t, entry )
524 if (!strcmp(m->def->name, cname))
530 gen_proxy(iface, cur, idx, *proc_offset);
531 gen_stub(iface, cur, cname, *proc_offset);
532 *proc_offset += get_size_procformatstring_func( cur );
533 if (midx == -1) midx = idx;
534 else if (midx != idx) error("method index mismatch in write_proxy\n");
540 print_proxy( "static const CINTERFACE_PROXY_VTABLE(%d) _%sProxyVtbl =\n", midx, iface->name);
543 print_proxy( "{\n", iface->name);
545 print_proxy( "&IID_%s,\n", iface->name);
547 print_proxy( "},\n");
550 write_proxy_methods(iface);
551 fprintf(proxy, "\n");
555 print_proxy( "};\n");
556 fprintf(proxy, "\n\n");
559 print_proxy( "static const PRPC_STUB_FUNCTION %s_table[] =\n", iface->name);
562 stubs = write_stub_methods(iface);
563 fprintf(proxy, "\n");
565 fprintf(proxy, "};\n");
567 print_proxy( "static const CInterfaceStubVtbl _%sStubVtbl =\n", iface->name);
572 print_proxy( "&IID_%s,\n", iface->name);
573 print_proxy( "0,\n");
574 print_proxy( "%d,\n", stubs+3);
575 print_proxy( "&%s_table[-3],\n", iface->name);
577 print_proxy( "},\n", iface->name);
580 print_proxy( "CStdStubBuffer_METHODS\n");
584 print_proxy( "};\n");
588 static int does_any_iface(const ifref_list_t *ifaces, type_pred_t pred)
593 LIST_FOR_EACH_ENTRY(ir, ifaces, ifref_t, entry)
600 int need_proxy(const type_t *iface)
602 return is_object(iface->attrs) && !is_local(iface->attrs);
605 int need_stub(const type_t *iface)
607 return !is_object(iface->attrs) && !is_local(iface->attrs);
610 int need_proxy_file(const ifref_list_t *ifaces)
612 return does_any_iface(ifaces, need_proxy);
615 int need_stub_files(const ifref_list_t *ifaces)
617 return does_any_iface(ifaces, need_stub);
620 void write_proxies(ifref_list_t *ifaces)
623 int expr_eval_routines;
624 char *file_id = proxy_token;
626 unsigned int proc_offset = 0;
628 if (!do_proxies) return;
629 if (do_everything && !need_proxy_file(ifaces)) return;
635 LIST_FOR_EACH_ENTRY( cur, ifaces, ifref_t, entry )
636 if (need_proxy(cur->iface))
637 write_proxy(cur->iface, &proc_offset);
639 expr_eval_routines = write_expr_eval_routines(proxy, proxy_token);
640 if (expr_eval_routines)
641 write_expr_eval_routine_list(proxy, proxy_token);
642 write_user_quad_list(proxy);
643 write_stubdesc(expr_eval_routines);
645 print_proxy( "#if !defined(__RPC_WIN32__)\n");
646 print_proxy( "#error Currently only Wine and WIN32 are supported.\n");
647 print_proxy( "#endif\n");
649 write_procformatstring(proxy, ifaces, need_proxy);
650 write_typeformatstring(proxy, ifaces, need_proxy);
652 fprintf(proxy, "static const CInterfaceProxyVtbl* const _%s_ProxyVtblList[] =\n", file_id);
653 fprintf(proxy, "{\n");
655 LIST_FOR_EACH_ENTRY( cur, ifaces, ifref_t, entry )
656 if(cur->iface->ref && cur->iface->funcs && need_proxy(cur->iface))
657 fprintf(proxy, " (const CInterfaceProxyVtbl*)&_%sProxyVtbl,\n", cur->iface->name);
659 fprintf(proxy, " 0\n");
660 fprintf(proxy, "};\n");
661 fprintf(proxy, "\n");
663 fprintf(proxy, "static const CInterfaceStubVtbl* const _%s_StubVtblList[] =\n", file_id);
664 fprintf(proxy, "{\n");
666 LIST_FOR_EACH_ENTRY( cur, ifaces, ifref_t, entry )
667 if(cur->iface->ref && cur->iface->funcs && need_proxy(cur->iface))
668 fprintf(proxy, " (const CInterfaceStubVtbl*)&_%sStubVtbl,\n", cur->iface->name);
669 fprintf(proxy, " 0\n");
670 fprintf(proxy, "};\n");
671 fprintf(proxy, "\n");
673 fprintf(proxy, "static PCInterfaceName const _%s_InterfaceNamesList[] =\n", file_id);
674 fprintf(proxy, "{\n");
676 LIST_FOR_EACH_ENTRY( cur, ifaces, ifref_t, entry )
677 if(cur->iface->ref && cur->iface->funcs && need_proxy(cur->iface))
678 fprintf(proxy, " \"%s\",\n", cur->iface->name);
679 fprintf(proxy, " 0\n");
680 fprintf(proxy, "};\n");
681 fprintf(proxy, "\n");
683 fprintf(proxy, "#define _%s_CHECK_IID(n) IID_GENERIC_CHECK_IID(_%s, pIID, n)\n", file_id, file_id);
684 fprintf(proxy, "\n");
685 fprintf(proxy, "int __stdcall _%s_IID_Lookup(const IID* pIID, int* pIndex)\n", file_id);
686 fprintf(proxy, "{\n");
689 LIST_FOR_EACH_ENTRY( cur, ifaces, ifref_t, entry )
690 if(cur->iface->ref && cur->iface->funcs && need_proxy(cur->iface))
692 fprintf(proxy, " if (!_%s_CHECK_IID(%d))\n", file_id, c);
693 fprintf(proxy, " {\n");
694 fprintf(proxy, " *pIndex = %d;\n", c);
695 fprintf(proxy, " return 1;\n");
696 fprintf(proxy, " }\n");
699 fprintf(proxy, " return 0;\n");
700 fprintf(proxy, "}\n");
701 fprintf(proxy, "\n");
703 fprintf(proxy, "const ExtendedProxyFileInfo %s_ProxyFileInfo =\n", file_id);
704 fprintf(proxy, "{\n");
705 fprintf(proxy, " (const PCInterfaceProxyVtblList*)&_%s_ProxyVtblList,\n", file_id);
706 fprintf(proxy, " (const PCInterfaceStubVtblList*)&_%s_StubVtblList,\n", file_id);
707 fprintf(proxy, " _%s_InterfaceNamesList,\n", file_id);
708 fprintf(proxy, " 0,\n");
709 fprintf(proxy, " &_%s_IID_Lookup,\n", file_id);
710 fprintf(proxy, " %d,\n", c);
711 fprintf(proxy, " 1,\n");
712 fprintf(proxy, " 0,\n");
713 fprintf(proxy, " 0,\n");
714 fprintf(proxy, " 0,\n");
715 fprintf(proxy, " 0\n");
716 fprintf(proxy, "};\n");