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"
41 static int indent
= 0;
43 static void print_client( const char *format
, ... )
47 print(client
, indent
, format
, va
);
52 static void check_pointers(const func_t
*func
)
59 LIST_FOR_EACH_ENTRY( var
, func
->args
, const var_t
, entry
)
61 if (is_var_ptr(var
) && cant_be_null(var
))
63 print_client("if (!%s)\n", var
->name
);
66 print_client("RpcRaiseException(RPC_X_NULL_REF_POINTER);\n");
68 print_client("}\n\n");
73 const var_t
* get_context_handle_var(const func_t
* func
)
80 LIST_FOR_EACH_ENTRY( var
, func
->args
, const var_t
, entry
)
81 if (is_attr(var
->attrs
, ATTR_IN
) && is_context_handle(var
->type
))
87 static void write_function_stubs(type_t
*iface
, unsigned int *proc_offset
)
90 const char *implicit_handle
= get_attrp(iface
->attrs
, ATTR_IMPLICIT_HANDLE
);
91 int explicit_handle
= is_attr(iface
->attrs
, ATTR_EXPLICIT_HANDLE
);
96 print_client("static RPC_BINDING_HANDLE %s__MIDL_AutoBindHandle;\n\n", iface
->name
);
98 if (iface
->funcs
) LIST_FOR_EACH_ENTRY( func
, iface
->funcs
, const func_t
, entry
)
100 const var_t
*def
= func
->def
;
101 const var_t
* explicit_handle_var
;
102 const var_t
* explicit_generic_handle_var
= NULL
;
103 const var_t
* context_handle_var
= NULL
;
104 int has_full_pointer
= is_full_pointer_function(func
);
105 const char *callconv
= get_attrp(def
->type
->attrs
, ATTR_CALLCONV
);
107 /* check for a defined binding handle */
108 explicit_handle_var
= get_explicit_handle_var(func
);
109 if (!explicit_handle_var
)
111 explicit_generic_handle_var
= get_explicit_generic_handle_var(func
);
112 if (!explicit_generic_handle_var
)
113 context_handle_var
= get_context_handle_var(func
);
117 if (!explicit_handle_var
|| !explicit_generic_handle_var
|| !context_handle_var
)
119 error("%s() does not define an explicit binding handle!\n", def
->name
);
123 else if (implicit_handle
)
125 if (explicit_handle_var
)
127 error("%s() must not define a binding handle!\n", def
->name
);
132 write_type_decl_left(client
, get_func_return_type(func
));
133 if (needs_space_after(get_func_return_type(func
)))
134 fprintf(client
, " ");
135 if (callconv
) fprintf(client
, "%s ", callconv
);
136 write_prefix_name(client
, prefix_client
, def
);
137 fprintf(client
, "(\n");
140 write_args(client
, func
->args
, iface
->name
, 0, TRUE
);
142 print_client("void");
143 fprintf(client
, ")\n");
146 /* write the functions body */
147 fprintf(client
, "{\n");
150 /* declare return value '_RetVal' */
151 if (!is_void(get_func_return_type(func
)))
154 write_type_decl_left(client
, get_func_return_type(func
));
155 fprintf(client
, " _RetVal;\n");
158 if (implicit_handle
|| explicit_handle_var
|| explicit_generic_handle_var
|| context_handle_var
)
159 print_client("RPC_BINDING_HANDLE _Handle = 0;\n");
161 print_client("RPC_MESSAGE _RpcMessage;\n");
162 print_client("MIDL_STUB_MESSAGE _StubMsg;\n");
163 if (!is_void(get_func_return_type(func
)) && decl_indirect(get_func_return_type(func
)))
165 print_client("void *_p_%s = &%s;\n",
166 "_RetVal", "_RetVal");
168 fprintf(client
, "\n");
170 if (has_full_pointer
)
171 write_full_pointer_init(client
, indent
, func
, FALSE
);
174 check_pointers(func
);
176 print_client("RpcTryFinally\n");
180 print_client("NdrClientInitializeNew(\n");
182 print_client("(PRPC_MESSAGE)&_RpcMessage,\n");
183 print_client("(PMIDL_STUB_MESSAGE)&_StubMsg,\n");
184 print_client("(PMIDL_STUB_DESC)&%s_StubDesc,\n", iface
->name
);
185 print_client("%d);\n", method_count
);
187 fprintf(client
, "\n");
191 print_client("_Handle = %s;\n", implicit_handle
);
192 fprintf(client
, "\n");
194 else if (explicit_handle_var
)
196 print_client("_Handle = %s;\n", explicit_handle_var
->name
);
197 fprintf(client
, "\n");
199 else if (explicit_generic_handle_var
)
201 print_client("_Handle = %s_bind(%s);\n",
202 get_explicit_generic_handle_type(explicit_generic_handle_var
)->name
,
203 explicit_generic_handle_var
->name
);
204 fprintf(client
, "\n");
206 else if (context_handle_var
)
208 /* if the context_handle attribute appears in the chain of types
209 * without pointers being followed, then the context handle must
210 * be direct, otherwise it is a pointer */
211 int is_ch_ptr
= is_aliaschain_attr(context_handle_var
->type
, ATTR_CONTEXTHANDLE
) ? FALSE
: TRUE
;
212 print_client("if (%s%s != 0)\n", is_ch_ptr
? "*" : "", context_handle_var
->name
);
214 print_client("_Handle = NDRCContextBinding(%s%s);\n", is_ch_ptr
? "*" : "", context_handle_var
->name
);
216 fprintf(client
, "\n");
219 write_remoting_arguments(client
, indent
, func
, PASS_IN
, PHASE_BUFFERSIZE
);
221 print_client("NdrGetBuffer(\n");
223 print_client("(PMIDL_STUB_MESSAGE)&_StubMsg,\n");
224 print_client("_StubMsg.BufferLength,\n");
225 if (implicit_handle
|| explicit_handle_var
|| explicit_generic_handle_var
|| context_handle_var
)
226 print_client("_Handle);\n");
228 print_client("%s__MIDL_AutoBindHandle);\n", iface
->name
);
230 fprintf(client
, "\n");
232 /* marshal arguments */
233 write_remoting_arguments(client
, indent
, func
, PASS_IN
, PHASE_MARSHAL
);
235 /* send/receive message */
236 /* print_client("NdrNsSendReceive(\n"); */
237 /* print_client("(unsigned char *)_StubMsg.Buffer,\n"); */
238 /* print_client("(RPC_BINDING_HANDLE *) &%s__MIDL_AutoBindHandle);\n", iface->name); */
239 print_client("NdrSendReceive(\n");
241 print_client("(PMIDL_STUB_MESSAGE)&_StubMsg,\n");
242 print_client("(unsigned char *)_StubMsg.Buffer);\n\n");
245 print_client("_StubMsg.BufferStart = (unsigned char *)_RpcMessage.Buffer;\n");
246 print_client("_StubMsg.BufferEnd = _StubMsg.BufferStart + _RpcMessage.BufferLength;\n");
248 if (has_out_arg_or_return(func
))
250 fprintf(client
, "\n");
252 print_client("if ((_RpcMessage.DataRepresentation & 0x0000FFFFUL) != NDR_LOCAL_DATA_REPRESENTATION)\n");
254 print_client("NdrConvert(\n");
256 print_client("(PMIDL_STUB_MESSAGE)&_StubMsg,\n");
257 print_client("(PFORMAT_STRING)&__MIDL_ProcFormatString.Format[%u]);\n", *proc_offset
);
261 /* unmarshall arguments */
262 fprintf(client
, "\n");
263 write_remoting_arguments(client
, indent
, func
, PASS_OUT
, PHASE_UNMARSHAL
);
265 /* unmarshal return value */
266 if (!is_void(get_func_return_type(func
)))
268 if (decl_indirect(get_func_return_type(func
)))
269 print_client("MIDL_memset(&%s, 0, sizeof(%s));\n", "_RetVal", "_RetVal");
270 else if (is_ptr(get_func_return_type(func
)) || is_array(get_func_return_type(func
)))
271 print_client("%s = 0;\n", "_RetVal");
272 write_remoting_arguments(client
, indent
, func
, PASS_RETURN
, PHASE_UNMARSHAL
);
275 /* update proc_offset */
278 LIST_FOR_EACH_ENTRY( var
, func
->args
, const var_t
, entry
)
279 *proc_offset
+= get_size_procformatstring_type(var
->name
, var
->type
, var
->attrs
);
281 if (!is_void(get_func_return_type(func
)))
282 *proc_offset
+= get_size_procformatstring_type("return value", get_func_return_type(func
), NULL
);
284 *proc_offset
+= 2; /* FC_END and FC_PAD */
288 print_client("RpcFinally\n");
293 /* FIXME: emit client finally code */
295 if (has_full_pointer
)
296 write_full_pointer_free(client
, indent
, func
);
298 print_client("NdrFreeBuffer((PMIDL_STUB_MESSAGE)&_StubMsg);\n");
300 if (!implicit_handle
&& explicit_generic_handle_var
)
302 fprintf(client
, "\n");
303 print_client("if (_Handle)\n");
305 print_client("%s_unbind(%s, _Handle);\n",
306 get_explicit_generic_handle_type(explicit_generic_handle_var
)->name
,
307 explicit_generic_handle_var
->name
);
313 print_client("RpcEndFinally\n");
316 /* emit return code */
317 if (!is_void(get_func_return_type(func
)))
319 fprintf(client
, "\n");
320 print_client("return _RetVal;\n");
324 fprintf(client
, "}\n");
325 fprintf(client
, "\n");
332 static void write_stubdescdecl(type_t
*iface
)
334 print_client("static const MIDL_STUB_DESC %s_StubDesc;\n", iface
->name
);
335 fprintf(client
, "\n");
339 static void write_stubdescriptor(type_t
*iface
, int expr_eval_routines
)
341 const char *implicit_handle
= get_attrp(iface
->attrs
, ATTR_IMPLICIT_HANDLE
);
343 print_client("static const MIDL_STUB_DESC %s_StubDesc =\n", iface
->name
);
346 print_client("(void *)& %s___RpcClientInterface,\n", iface
->name
);
347 print_client("MIDL_user_allocate,\n");
348 print_client("MIDL_user_free,\n");
352 print_client("&%s,\n", implicit_handle
);
354 print_client("&%s__MIDL_AutoBindHandle,\n", iface
->name
);
356 print_client("},\n");
357 print_client("0,\n");
358 print_client("0,\n");
359 if (expr_eval_routines
)
360 print_client("ExprEvalRoutines,\n");
362 print_client("0,\n");
363 print_client("0,\n");
364 print_client("__MIDL_TypeFormatString.Format,\n");
365 print_client("1, /* -error bounds_check flag */\n");
366 print_client("0x10001, /* Ndr library version */\n");
367 print_client("0,\n");
368 print_client("0x50100a4, /* MIDL Version 5.1.164 */\n");
369 print_client("0,\n");
370 print_client("%s,\n", list_empty(&user_type_list
) ? "0" : "UserMarshalRoutines");
371 print_client("0, /* notify & notify_flag routine table */\n");
372 print_client("1, /* Flags */\n");
373 print_client("0, /* Reserved3 */\n");
374 print_client("0, /* Reserved4 */\n");
375 print_client("0 /* Reserved5 */\n");
377 print_client("};\n");
378 fprintf(client
, "\n");
382 static void write_clientinterfacedecl(type_t
*iface
)
384 unsigned long ver
= get_attrv(iface
->attrs
, ATTR_VERSION
);
385 const UUID
*uuid
= get_attrp(iface
->attrs
, ATTR_UUID
);
386 const str_list_t
*endpoints
= get_attrp(iface
->attrs
, ATTR_ENDPOINT
);
388 if (endpoints
) write_endpoints( client
, iface
->name
, endpoints
);
390 print_client("static const RPC_CLIENT_INTERFACE %s___RpcClientInterface =\n", iface
->name
);
393 print_client("sizeof(RPC_CLIENT_INTERFACE),\n");
394 print_client("{{0x%08lx,0x%04x,0x%04x,{0x%02x,0x%02x,0x%02x,0x%02x,0x%02x,0x%02x,0x%02x,0x%02x}},{%d,%d}},\n",
395 uuid
->Data1
, uuid
->Data2
, uuid
->Data3
, uuid
->Data4
[0], uuid
->Data4
[1],
396 uuid
->Data4
[2], uuid
->Data4
[3], uuid
->Data4
[4], uuid
->Data4
[5], uuid
->Data4
[6],
397 uuid
->Data4
[7], MAJORVERSION(ver
), MINORVERSION(ver
));
398 print_client("{{0x8a885d04,0x1ceb,0x11c9,{0x9f,0xe8,0x08,0x00,0x2b,0x10,0x48,0x60}},{2,0}},\n"); /* FIXME */
399 print_client("0,\n");
402 print_client("%u,\n", list_count(endpoints
));
403 print_client("(PRPC_PROTSEQ_ENDPOINT)%s__RpcProtseqEndpoint,\n", iface
->name
);
407 print_client("0,\n");
408 print_client("0,\n");
410 print_client("0,\n");
411 print_client("0,\n");
412 print_client("0,\n");
414 print_client("};\n");
416 print_client("RPC_IF_HANDLE %s_ClientIfHandle = (RPC_IF_HANDLE)& %s___RpcClientInterface;\n",
417 iface
->name
, iface
->name
);
419 print_client("RPC_IF_HANDLE %s%s_v%d_%d_c_ifspec = (RPC_IF_HANDLE)& %s___RpcClientInterface;\n",
420 prefix_client
, iface
->name
, MAJORVERSION(ver
), MINORVERSION(ver
), iface
->name
);
421 fprintf(client
, "\n");
425 static void write_implicithandledecl(type_t
*iface
)
427 const char *implicit_handle
= get_attrp(iface
->attrs
, ATTR_IMPLICIT_HANDLE
);
431 fprintf(client
, "handle_t %s;\n", implicit_handle
);
432 fprintf(client
, "\n");
437 static void init_client(void)
440 if (!(client
= fopen(client_name
, "w")))
441 error("Could not open %s for output\n", client_name
);
443 print_client("/*** Autogenerated by WIDL %s from %s - Do not edit ***/\n", PACKAGE_VERSION
, input_name
);
444 print_client("#include <string.h>\n");
445 print_client("#ifdef _ALPHA_\n");
446 print_client("#include <stdarg.h>\n");
447 print_client("#endif\n");
448 fprintf(client
, "\n");
449 print_client("#include \"%s\"\n", header_name
);
450 fprintf(client
, "\n");
454 void write_client(ifref_list_t
*ifaces
)
456 unsigned int proc_offset
= 0;
457 int expr_eval_routines
;
462 if (do_everything
&& !need_stub_files(ifaces
))
469 write_formatstringsdecl(client
, indent
, ifaces
, need_stub
);
470 expr_eval_routines
= write_expr_eval_routines(client
, client_token
);
471 if (expr_eval_routines
)
472 write_expr_eval_routine_list(client
, client_token
);
473 write_user_quad_list(client
);
475 if (ifaces
) LIST_FOR_EACH_ENTRY( iface
, ifaces
, ifref_t
, entry
)
477 if (!need_stub(iface
->iface
))
480 fprintf(client
, "/*****************************************************************************\n");
481 fprintf(client
, " * %s interface\n", iface
->iface
->name
);
482 fprintf(client
, " */\n");
483 fprintf(client
, "\n");
485 if (iface
->iface
->funcs
)
487 write_implicithandledecl(iface
->iface
);
489 write_clientinterfacedecl(iface
->iface
);
490 write_stubdescdecl(iface
->iface
);
491 write_function_stubs(iface
->iface
, &proc_offset
);
493 print_client("#if !defined(__RPC_WIN32__)\n");
494 print_client("#error Invalid build platform for this stub.\n");
495 print_client("#endif\n");
497 fprintf(client
, "\n");
498 write_stubdescriptor(iface
->iface
, expr_eval_routines
);
502 fprintf(client
, "\n");
504 write_procformatstring(client
, ifaces
, need_stub
);
505 write_typeformatstring(client
, ifaces
, need_stub
);