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
22 #include "wine/port.h"
37 #include "widltypes.h"
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
, ... )
49 print(client
, indent
, format
, va
);
54 static void check_pointers(const var_t
*func
)
58 if (!type_get_function_args(func
->type
))
61 LIST_FOR_EACH_ENTRY( var
, type_get_function_args(func
->type
), const var_t
, entry
)
63 if (is_var_ptr(var
) && cant_be_null(var
))
65 print_client("if (!%s)\n", var
->name
);
68 print_client("RpcRaiseException(RPC_X_NULL_REF_POINTER);\n");
70 print_client("}\n\n");
75 static void write_client_func_decl( const type_t
*iface
, const var_t
*func
)
77 const char *callconv
= get_attrp(func
->type
->attrs
, ATTR_CALLCONV
);
78 const var_list_t
*args
= type_get_function_args(func
->type
);
79 type_t
*rettype
= type_function_get_rettype(func
->type
);
81 write_type_decl_left(client
, rettype
);
82 if (needs_space_after(rettype
)) fprintf(client
, " ");
83 if (callconv
) fprintf(client
, "%s ", callconv
);
84 fprintf(client
, "%s%s(\n", prefix_client
, get_name(func
));
87 write_args(client
, args
, iface
->name
, 0, TRUE
);
90 fprintf(client
, ")\n");
94 static void write_function_stub( const type_t
*iface
, const var_t
*func
,
95 int method_count
, unsigned int proc_offset
)
97 unsigned char explicit_fc
, implicit_fc
;
98 int has_full_pointer
= is_full_pointer_function(func
);
99 type_t
*rettype
= type_function_get_rettype(func
->type
);
100 const var_list_t
*args
= type_get_function_args(func
->type
);
101 const var_t
*handle_var
= get_func_handle_var( iface
, func
, &explicit_fc
, &implicit_fc
);
102 int has_ret
= !is_void(rettype
);
104 if (is_interpreted_func( iface
, func
))
106 write_client_func_decl( iface
, func
);
107 fprintf(client
, "{\n");
109 if (has_ret
) print_client( "%s", "CLIENT_CALL_RETURN _RetVal;\n\n" );
110 print_client( "%sNdrClientCall( &%s_StubDesc, &__MIDL_ProcFormatString.Format[%u], ",
111 has_ret
? "_RetVal = " : "", iface
->name
, proc_offset
);
113 fprintf( client
, "(unsigned char *)&%s );\n",
114 LIST_ENTRY( list_head(args
), const var_t
, entry
)->name
);
116 fprintf( client
, "(unsigned char *)0 );\n" );
119 print_client( "return (" );
120 write_type_decl_left(client
, rettype
);
121 fprintf( client
, ")*(LONG_PTR *)&_RetVal;\n" );
124 print_client( "}\n\n");
128 print_client( "struct __frame_%s%s\n{\n", prefix_client
, get_name(func
) );
130 print_client( "__DECL_EXCEPTION_FRAME\n" );
131 print_client("MIDL_STUB_MESSAGE _StubMsg;\n");
134 if (explicit_fc
== RPC_FC_BIND_GENERIC
)
135 print_client("%s %s;\n",
136 get_explicit_generic_handle_type(handle_var
)->name
, handle_var
->name
);
137 print_client("RPC_BINDING_HANDLE _Handle;\n");
140 if (has_ret
&& decl_indirect(rettype
))
142 print_client("void *_p_%s;\n", "_RetVal" );
145 print_client( "};\n\n" );
147 print_client( "static void __finally_%s%s(", prefix_client
, get_name(func
) );
148 print_client( " struct __frame_%s%s *__frame )\n{\n", prefix_client
, get_name(func
) );
151 if (has_full_pointer
)
152 write_full_pointer_free(client
, indent
, func
);
154 print_client("NdrFreeBuffer(&__frame->_StubMsg);\n");
156 if (explicit_fc
== RPC_FC_BIND_GENERIC
)
158 fprintf(client
, "\n");
159 print_client("if (__frame->_Handle)\n");
161 print_client("%s_unbind(__frame->%s, __frame->_Handle);\n",
162 get_explicit_generic_handle_type(handle_var
)->name
, handle_var
->name
);
166 print_client( "}\n\n" );
168 write_client_func_decl( iface
, func
);
170 /* write the functions body */
171 fprintf(client
, "{\n");
173 print_client( "struct __frame_%s%s __f, * const __frame = &__f;\n", prefix_client
, get_name(func
) );
175 /* declare return value '_RetVal' */
178 print_client("%s", "");
179 write_type_decl_left(client
, rettype
);
180 fprintf(client
, " _RetVal;\n");
182 print_client("RPC_MESSAGE _RpcMessage;\n");
186 print_client( "__frame->_Handle = 0;\n" );
187 if (explicit_fc
== RPC_FC_BIND_GENERIC
)
188 print_client("__frame->%s = %s;\n", handle_var
->name
, handle_var
->name
);
190 if (has_ret
&& decl_indirect(rettype
))
192 print_client("__frame->_p_%s = &%s;\n",
193 "_RetVal", "_RetVal");
195 fprintf(client
, "\n");
197 print_client( "RpcExceptionInit( 0, __finally_%s%s );\n", prefix_client
, get_name(func
) );
199 if (has_full_pointer
)
200 write_full_pointer_init(client
, indent
, func
, FALSE
);
203 check_pointers(func
);
205 print_client("RpcTryFinally\n");
209 print_client("NdrClientInitializeNew(&_RpcMessage, &__frame->_StubMsg, &%s_StubDesc, %d);\n",
210 iface
->name
, method_count
);
212 if (is_attr(func
->attrs
, ATTR_IDEMPOTENT
) || is_attr(func
->attrs
, ATTR_BROADCAST
))
214 print_client("_RpcMessage.RpcFlags = ( RPC_NCA_FLAGS_DEFAULT ");
215 if (is_attr(func
->attrs
, ATTR_IDEMPOTENT
))
216 fprintf(client
, "| RPC_NCA_FLAGS_IDEMPOTENT ");
217 if (is_attr(func
->attrs
, ATTR_BROADCAST
))
218 fprintf(client
, "| RPC_NCA_FLAGS_BROADCAST ");
219 fprintf(client
, ");\n\n");
224 case RPC_FC_BIND_PRIMITIVE
:
225 print_client("__frame->_Handle = %s;\n", handle_var
->name
);
226 fprintf(client
, "\n");
228 case RPC_FC_BIND_GENERIC
:
229 print_client("__frame->_Handle = %s_bind(%s);\n",
230 get_explicit_generic_handle_type(handle_var
)->name
, handle_var
->name
);
231 fprintf(client
, "\n");
233 case RPC_FC_BIND_CONTEXT
:
235 /* if the context_handle attribute appears in the chain of types
236 * without pointers being followed, then the context handle must
237 * be direct, otherwise it is a pointer */
238 int is_ch_ptr
= !is_aliaschain_attr(handle_var
->type
, ATTR_CONTEXTHANDLE
);
239 print_client("if (%s%s != 0)\n", is_ch_ptr
? "*" : "", handle_var
->name
);
241 print_client("__frame->_Handle = NDRCContextBinding(%s%s);\n",
242 is_ch_ptr
? "*" : "", handle_var
->name
);
244 if (is_attr(handle_var
->attrs
, ATTR_IN
) && !is_attr(handle_var
->attrs
, ATTR_OUT
))
246 print_client("else\n");
248 print_client("RpcRaiseException(RPC_X_SS_IN_NULL_CONTEXT);\n");
251 fprintf(client
, "\n");
254 case 0: /* implicit handle */
257 print_client("__frame->_Handle = %s;\n", handle_var
->name
);
258 fprintf(client
, "\n");
263 write_remoting_arguments(client
, indent
, func
, "", PASS_IN
, PHASE_BUFFERSIZE
);
265 print_client("NdrGetBuffer(&__frame->_StubMsg, __frame->_StubMsg.BufferLength, ");
267 fprintf(client
, "__frame->_Handle);\n\n");
269 fprintf(client
,"%s__MIDL_AutoBindHandle);\n\n", iface
->name
);
271 /* marshal arguments */
272 write_remoting_arguments(client
, indent
, func
, "", PASS_IN
, PHASE_MARSHAL
);
274 /* send/receive message */
275 /* print_client("NdrNsSendReceive(\n"); */
276 /* print_client("(unsigned char *)__frame->_StubMsg.Buffer,\n"); */
277 /* print_client("(RPC_BINDING_HANDLE *) &%s__MIDL_AutoBindHandle);\n", iface->name); */
278 print_client("NdrSendReceive(&__frame->_StubMsg, __frame->_StubMsg.Buffer);\n\n");
280 print_client("__frame->_StubMsg.BufferStart = _RpcMessage.Buffer;\n");
281 print_client("__frame->_StubMsg.BufferEnd = __frame->_StubMsg.BufferStart + _RpcMessage.BufferLength;\n");
283 if (has_out_arg_or_return(func
))
285 fprintf(client
, "\n");
287 print_client("if ((_RpcMessage.DataRepresentation & 0x0000FFFFUL) != NDR_LOCAL_DATA_REPRESENTATION)\n");
289 print_client("NdrConvert(&__frame->_StubMsg, (PFORMAT_STRING)&__MIDL_ProcFormatString.Format[%u]);\n",
294 /* unmarshall arguments */
295 fprintf(client
, "\n");
296 write_remoting_arguments(client
, indent
, func
, "", PASS_OUT
, PHASE_UNMARSHAL
);
298 /* unmarshal return value */
301 if (decl_indirect(rettype
))
302 print_client("MIDL_memset(&%s, 0, sizeof(%s));\n", "_RetVal", "_RetVal");
303 else if (is_ptr(rettype
) || is_array(rettype
))
304 print_client("%s = 0;\n", "_RetVal");
305 write_remoting_arguments(client
, indent
, func
, "", PASS_RETURN
, PHASE_UNMARSHAL
);
310 print_client("RpcFinally\n");
313 print_client( "__finally_%s%s( __frame );\n", prefix_client
, get_name(func
) );
316 print_client("RpcEndFinally\n");
319 /* emit return code */
322 fprintf(client
, "\n");
323 print_client("return _RetVal;\n");
327 fprintf(client
, "}\n");
328 fprintf(client
, "\n");
331 static void write_function_stubs(type_t
*iface
, unsigned int *proc_offset
)
333 const statement_t
*stmt
;
334 const var_t
*implicit_handle
= get_attrp(iface
->attrs
, ATTR_IMPLICIT_HANDLE
);
335 int method_count
= 0;
337 if (!implicit_handle
)
338 print_client("static RPC_BINDING_HANDLE %s__MIDL_AutoBindHandle;\n\n", iface
->name
);
340 STATEMENTS_FOR_EACH_FUNC( stmt
, type_iface_get_stmts(iface
) )
342 const var_t
*func
= stmt
->u
.var
;
343 write_function_stub( iface
, func
, method_count
++, *proc_offset
);
344 *proc_offset
+= get_size_procformatstring_func( iface
, func
);
349 static void write_stubdescdecl(type_t
*iface
)
351 print_client("static const MIDL_STUB_DESC %s_StubDesc;\n", iface
->name
);
352 fprintf(client
, "\n");
356 static void write_stubdescriptor(type_t
*iface
, int expr_eval_routines
)
358 const var_t
*implicit_handle
= get_attrp(iface
->attrs
, ATTR_IMPLICIT_HANDLE
);
360 print_client("static const MIDL_STUB_DESC %s_StubDesc =\n", iface
->name
);
363 print_client("(void *)& %s___RpcClientInterface,\n", iface
->name
);
364 print_client("MIDL_user_allocate,\n");
365 print_client("MIDL_user_free,\n");
369 print_client("&%s,\n", implicit_handle
->name
);
371 print_client("&%s__MIDL_AutoBindHandle,\n", iface
->name
);
373 print_client("},\n");
374 print_client("0,\n");
375 if (!list_empty( &generic_handle_list
))
376 print_client("BindingRoutines,\n");
378 print_client("0,\n");
379 if (expr_eval_routines
)
380 print_client("ExprEvalRoutines,\n");
382 print_client("0,\n");
383 print_client("0,\n");
384 print_client("__MIDL_TypeFormatString.Format,\n");
385 print_client("1, /* -error bounds_check flag */\n");
386 print_client("0x10001, /* Ndr library version */\n");
387 print_client("0,\n");
388 print_client("0x50100a4, /* MIDL Version 5.1.164 */\n");
389 print_client("0,\n");
390 print_client("%s,\n", list_empty(&user_type_list
) ? "0" : "UserMarshalRoutines");
391 print_client("0, /* notify & notify_flag routine table */\n");
392 print_client("1, /* Flags */\n");
393 print_client("0, /* Reserved3 */\n");
394 print_client("0, /* Reserved4 */\n");
395 print_client("0 /* Reserved5 */\n");
397 print_client("};\n");
398 fprintf(client
, "\n");
402 static void write_clientinterfacedecl(type_t
*iface
)
404 unsigned int ver
= get_attrv(iface
->attrs
, ATTR_VERSION
);
405 const UUID
*uuid
= get_attrp(iface
->attrs
, ATTR_UUID
);
406 const str_list_t
*endpoints
= get_attrp(iface
->attrs
, ATTR_ENDPOINT
);
408 if (endpoints
) write_endpoints( client
, iface
->name
, endpoints
);
410 print_client("static const RPC_CLIENT_INTERFACE %s___RpcClientInterface =\n", iface
->name
);
413 print_client("sizeof(RPC_CLIENT_INTERFACE),\n");
414 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",
415 uuid
->Data1
, uuid
->Data2
, uuid
->Data3
, uuid
->Data4
[0], uuid
->Data4
[1],
416 uuid
->Data4
[2], uuid
->Data4
[3], uuid
->Data4
[4], uuid
->Data4
[5], uuid
->Data4
[6],
417 uuid
->Data4
[7], MAJORVERSION(ver
), MINORVERSION(ver
));
418 print_client("{{0x8a885d04,0x1ceb,0x11c9,{0x9f,0xe8,0x08,0x00,0x2b,0x10,0x48,0x60}},{2,0}},\n"); /* FIXME */
419 print_client("0,\n");
422 print_client("%u,\n", list_count(endpoints
));
423 print_client("(PRPC_PROTSEQ_ENDPOINT)%s__RpcProtseqEndpoint,\n", iface
->name
);
427 print_client("0,\n");
428 print_client("0,\n");
430 print_client("0,\n");
431 print_client("0,\n");
432 print_client("0,\n");
434 print_client("};\n");
436 print_client("RPC_IF_HANDLE %s_ClientIfHandle DECLSPEC_HIDDEN = (RPC_IF_HANDLE)& %s___RpcClientInterface;\n",
437 iface
->name
, iface
->name
);
439 print_client("RPC_IF_HANDLE %s%s_v%d_%d_c_ifspec DECLSPEC_HIDDEN = (RPC_IF_HANDLE)& %s___RpcClientInterface;\n",
440 prefix_client
, iface
->name
, MAJORVERSION(ver
), MINORVERSION(ver
), iface
->name
);
441 fprintf(client
, "\n");
445 static void write_implicithandledecl(type_t
*iface
)
447 const var_t
*implicit_handle
= get_attrp(iface
->attrs
, ATTR_IMPLICIT_HANDLE
);
451 write_type_decl( client
, implicit_handle
->type
, implicit_handle
->name
);
452 fprintf(client
, ";\n\n");
457 static void init_client(void)
460 if (!(client
= fopen(client_name
, "w")))
461 error("Could not open %s for output\n", client_name
);
463 print_client("/*** Autogenerated by WIDL %s from %s - Do not edit ***/\n", PACKAGE_VERSION
, input_name
);
464 print_client("#include <string.h>\n");
465 print_client("#ifdef _ALPHA_\n");
466 print_client("#include <stdarg.h>\n");
467 print_client("#endif\n");
468 fprintf(client
, "\n");
469 print_client("#include \"%s\"\n", header_name
);
471 print_client( "#ifndef DECLSPEC_HIDDEN\n");
472 print_client( "#define DECLSPEC_HIDDEN\n");
473 print_client( "#endif\n");
478 static void write_client_ifaces(const statement_list_t
*stmts
, int expr_eval_routines
, unsigned int *proc_offset
)
480 const statement_t
*stmt
;
481 if (stmts
) LIST_FOR_EACH_ENTRY( stmt
, stmts
, const statement_t
, entry
)
483 if (stmt
->type
== STMT_TYPE
&& type_get_type(stmt
->u
.type
) == TYPE_INTERFACE
)
486 const statement_t
*stmt2
;
487 type_t
*iface
= stmt
->u
.type
;
488 if (!need_stub(iface
))
491 fprintf(client
, "/*****************************************************************************\n");
492 fprintf(client
, " * %s interface\n", iface
->name
);
493 fprintf(client
, " */\n");
494 fprintf(client
, "\n");
496 STATEMENTS_FOR_EACH_FUNC(stmt2
, type_iface_get_stmts(iface
))
504 write_implicithandledecl(iface
);
506 write_clientinterfacedecl(iface
);
507 write_stubdescdecl(iface
);
508 write_function_stubs(iface
, proc_offset
);
510 print_client("#if !defined(__RPC_WIN%u__)\n", pointer_size
== 8 ? 64 : 32);
511 print_client("#error Invalid build platform for this stub.\n");
512 print_client("#endif\n");
514 fprintf(client
, "\n");
515 write_stubdescriptor(iface
, expr_eval_routines
);
518 else if (stmt
->type
== STMT_LIBRARY
)
519 write_client_ifaces(stmt
->u
.lib
->stmts
, expr_eval_routines
, proc_offset
);
523 static void write_generic_handle_routine_list(void)
525 generic_handle_t
*gh
;
527 if (list_empty( &generic_handle_list
)) return;
528 print_client( "static const GENERIC_BINDING_ROUTINE_PAIR BindingRoutines[] =\n" );
529 print_client( "{\n" );
531 LIST_FOR_EACH_ENTRY( gh
, &generic_handle_list
, generic_handle_t
, entry
)
533 print_client( "{ (GENERIC_BINDING_ROUTINE)%s_bind, (GENERIC_UNBIND_ROUTINE)%s_unbind },\n",
534 gh
->name
, gh
->name
);
537 print_client( "};\n\n" );
540 static void write_client_routines(const statement_list_t
*stmts
)
542 unsigned int proc_offset
= 0;
543 int expr_eval_routines
;
545 if (need_inline_stubs_file( stmts
))
547 write_exceptions( client
);
551 write_formatstringsdecl(client
, indent
, stmts
, need_stub
);
552 expr_eval_routines
= write_expr_eval_routines(client
, client_token
);
553 if (expr_eval_routines
)
554 write_expr_eval_routine_list(client
, client_token
);
555 write_generic_handle_routine_list();
556 write_user_quad_list(client
);
558 write_client_ifaces(stmts
, expr_eval_routines
, &proc_offset
);
560 fprintf(client
, "\n");
562 write_procformatstring(client
, stmts
, need_stub
);
563 write_typeformatstring(client
, stmts
, need_stub
);
566 void write_client(const statement_list_t
*stmts
)
570 if (do_everything
&& !need_stub_files(stmts
))
577 if (do_win32
&& do_win64
)
579 fprintf(client
, "#ifndef _WIN64\n\n");
581 write_client_routines( stmts
);
582 fprintf(client
, "\n#else /* _WIN64 */\n\n");
584 write_client_routines( stmts
);
585 fprintf(client
, "\n#endif /* _WIN64 */\n");
590 write_client_routines( stmts
);
595 write_client_routines( stmts
);