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
);
106 /* check for a defined binding handle */
107 explicit_handle_var
= get_explicit_handle_var(func
);
108 if (!explicit_handle_var
)
110 explicit_generic_handle_var
= get_explicit_generic_handle_var(func
);
111 if (!explicit_generic_handle_var
)
112 context_handle_var
= get_context_handle_var(func
);
116 if (!explicit_handle_var
|| !explicit_generic_handle_var
|| !context_handle_var
)
118 error("%s() does not define an explicit binding handle!\n", def
->name
);
122 else if (implicit_handle
)
124 if (explicit_handle_var
)
126 error("%s() must not define a binding handle!\n", def
->name
);
131 write_type_decl_left(client
, def
->type
);
132 if (needs_space_after(def
->type
))
133 fprintf(client
, " ");
134 write_prefix_name(client
, prefix_client
, def
);
135 fprintf(client
, "(\n");
138 write_args(client
, func
->args
, iface
->name
, 0, TRUE
);
140 print_client("void");
141 fprintf(client
, ")\n");
144 /* write the functions body */
145 fprintf(client
, "{\n");
148 /* declare return value '_RetVal' */
149 if (!is_void(def
->type
))
152 write_type_decl_left(client
, def
->type
);
153 fprintf(client
, " _RetVal;\n");
156 if (implicit_handle
|| explicit_handle_var
|| explicit_generic_handle_var
|| context_handle_var
)
157 print_client("RPC_BINDING_HANDLE _Handle = 0;\n");
159 print_client("RPC_MESSAGE _RpcMessage;\n");
160 print_client("MIDL_STUB_MESSAGE _StubMsg;\n");
161 if (!is_void(def
->type
) && decl_indirect(def
->type
))
163 print_client("void *_p_%s = &%s;\n",
164 "_RetVal", "_RetVal");
166 fprintf(client
, "\n");
168 if (has_full_pointer
)
169 write_full_pointer_init(client
, indent
, func
, FALSE
);
172 check_pointers(func
);
174 print_client("RpcTryFinally\n");
178 print_client("NdrClientInitializeNew(\n");
180 print_client("(PRPC_MESSAGE)&_RpcMessage,\n");
181 print_client("(PMIDL_STUB_MESSAGE)&_StubMsg,\n");
182 print_client("(PMIDL_STUB_DESC)&%s_StubDesc,\n", iface
->name
);
183 print_client("%d);\n", method_count
);
185 fprintf(client
, "\n");
189 print_client("_Handle = %s;\n", implicit_handle
);
190 fprintf(client
, "\n");
192 else if (explicit_handle_var
)
194 print_client("_Handle = %s;\n", explicit_handle_var
->name
);
195 fprintf(client
, "\n");
197 else if (explicit_generic_handle_var
)
199 print_client("_Handle = %s_bind(%s);\n",
200 get_explicit_generic_handle_type(explicit_generic_handle_var
)->name
,
201 explicit_generic_handle_var
->name
);
202 fprintf(client
, "\n");
204 else if (context_handle_var
)
206 /* if the context_handle attribute appears in the chain of types
207 * without pointers being followed, then the context handle must
208 * be direct, otherwise it is a pointer */
209 int is_ch_ptr
= is_aliaschain_attr(context_handle_var
->type
, ATTR_CONTEXTHANDLE
) ? FALSE
: TRUE
;
210 print_client("if (%s%s != 0)\n", is_ch_ptr
? "*" : "", context_handle_var
->name
);
212 print_client("_Handle = NDRCContextBinding(%s%s);\n", is_ch_ptr
? "*" : "", context_handle_var
->name
);
214 fprintf(client
, "\n");
217 write_remoting_arguments(client
, indent
, func
, PASS_IN
, PHASE_BUFFERSIZE
);
219 print_client("NdrGetBuffer(\n");
221 print_client("(PMIDL_STUB_MESSAGE)&_StubMsg,\n");
222 print_client("_StubMsg.BufferLength,\n");
223 if (implicit_handle
|| explicit_handle_var
|| explicit_generic_handle_var
|| context_handle_var
)
224 print_client("_Handle);\n");
226 print_client("%s__MIDL_AutoBindHandle);\n", iface
->name
);
228 fprintf(client
, "\n");
230 /* marshal arguments */
231 write_remoting_arguments(client
, indent
, func
, PASS_IN
, PHASE_MARSHAL
);
233 /* send/receive message */
234 /* print_client("NdrNsSendReceive(\n"); */
235 /* print_client("(unsigned char *)_StubMsg.Buffer,\n"); */
236 /* print_client("(RPC_BINDING_HANDLE *) &%s__MIDL_AutoBindHandle);\n", iface->name); */
237 print_client("NdrSendReceive(\n");
239 print_client("(PMIDL_STUB_MESSAGE)&_StubMsg,\n");
240 print_client("(unsigned char *)_StubMsg.Buffer);\n\n");
243 print_client("_StubMsg.BufferStart = (unsigned char *)_RpcMessage.Buffer;\n");
244 print_client("_StubMsg.BufferEnd = _StubMsg.BufferStart + _RpcMessage.BufferLength;\n");
246 if (has_out_arg_or_return(func
))
248 fprintf(client
, "\n");
250 print_client("if ((_RpcMessage.DataRepresentation & 0x0000FFFFUL) != NDR_LOCAL_DATA_REPRESENTATION)\n");
252 print_client("NdrConvert(\n");
254 print_client("(PMIDL_STUB_MESSAGE)&_StubMsg,\n");
255 print_client("(PFORMAT_STRING)&__MIDL_ProcFormatString.Format[%u]);\n", *proc_offset
);
259 /* unmarshall arguments */
260 fprintf(client
, "\n");
261 write_remoting_arguments(client
, indent
, func
, PASS_OUT
, PHASE_UNMARSHAL
);
263 /* unmarshal return value */
264 if (!is_void(def
->type
))
266 if (decl_indirect(def
->type
))
267 print_client("MIDL_memset(&%s, 0, sizeof(%s));\n", "_RetVal", "_RetVal");
268 else if (is_ptr(def
->type
) || is_array(def
->type
))
269 print_client("%s = 0;\n", "_RetVal");
270 write_remoting_arguments(client
, indent
, func
, PASS_RETURN
, PHASE_UNMARSHAL
);
273 /* update proc_offset */
276 LIST_FOR_EACH_ENTRY( var
, func
->args
, const var_t
, entry
)
277 *proc_offset
+= get_size_procformatstring_var(var
);
279 if (!is_void(def
->type
))
280 *proc_offset
+= get_size_procformatstring_var(def
);
282 *proc_offset
+= 2; /* FC_END and FC_PAD */
286 print_client("RpcFinally\n");
291 /* FIXME: emit client finally code */
293 if (has_full_pointer
)
294 write_full_pointer_free(client
, indent
, func
);
296 print_client("NdrFreeBuffer((PMIDL_STUB_MESSAGE)&_StubMsg);\n");
298 if (!implicit_handle
&& explicit_generic_handle_var
)
300 fprintf(client
, "\n");
301 print_client("if (_Handle)\n");
303 print_client("%s_unbind(%s, _Handle);\n",
304 get_explicit_generic_handle_type(explicit_generic_handle_var
)->name
,
305 explicit_generic_handle_var
->name
);
311 print_client("RpcEndFinally\n");
314 /* emit return code */
315 if (!is_void(def
->type
))
317 fprintf(client
, "\n");
318 print_client("return _RetVal;\n");
322 fprintf(client
, "}\n");
323 fprintf(client
, "\n");
330 static void write_stubdescdecl(type_t
*iface
)
332 print_client("static const MIDL_STUB_DESC %s_StubDesc;\n", iface
->name
);
333 fprintf(client
, "\n");
337 static void write_stubdescriptor(type_t
*iface
, int expr_eval_routines
)
339 const char *implicit_handle
= get_attrp(iface
->attrs
, ATTR_IMPLICIT_HANDLE
);
341 print_client("static const MIDL_STUB_DESC %s_StubDesc =\n", iface
->name
);
344 print_client("(void *)& %s___RpcClientInterface,\n", iface
->name
);
345 print_client("MIDL_user_allocate,\n");
346 print_client("MIDL_user_free,\n");
350 print_client("&%s,\n", implicit_handle
);
352 print_client("&%s__MIDL_AutoBindHandle,\n", iface
->name
);
354 print_client("},\n");
355 print_client("0,\n");
356 print_client("0,\n");
357 if (expr_eval_routines
)
358 print_client("ExprEvalRoutines,\n");
360 print_client("0,\n");
361 print_client("0,\n");
362 print_client("__MIDL_TypeFormatString.Format,\n");
363 print_client("1, /* -error bounds_check flag */\n");
364 print_client("0x10001, /* Ndr library version */\n");
365 print_client("0,\n");
366 print_client("0x50100a4, /* MIDL Version 5.1.164 */\n");
367 print_client("0,\n");
368 print_client("%s,\n", list_empty(&user_type_list
) ? "0" : "UserMarshalRoutines");
369 print_client("0, /* notify & notify_flag routine table */\n");
370 print_client("1, /* Flags */\n");
371 print_client("0, /* Reserved3 */\n");
372 print_client("0, /* Reserved4 */\n");
373 print_client("0 /* Reserved5 */\n");
375 print_client("};\n");
376 fprintf(client
, "\n");
380 static void write_clientinterfacedecl(type_t
*iface
)
382 unsigned long ver
= get_attrv(iface
->attrs
, ATTR_VERSION
);
383 const UUID
*uuid
= get_attrp(iface
->attrs
, ATTR_UUID
);
384 const str_list_t
*endpoints
= get_attrp(iface
->attrs
, ATTR_ENDPOINT
);
386 if (endpoints
) write_endpoints( client
, iface
->name
, endpoints
);
388 print_client("static const RPC_CLIENT_INTERFACE %s___RpcClientInterface =\n", iface
->name
);
391 print_client("sizeof(RPC_CLIENT_INTERFACE),\n");
392 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",
393 uuid
->Data1
, uuid
->Data2
, uuid
->Data3
, uuid
->Data4
[0], uuid
->Data4
[1],
394 uuid
->Data4
[2], uuid
->Data4
[3], uuid
->Data4
[4], uuid
->Data4
[5], uuid
->Data4
[6],
395 uuid
->Data4
[7], MAJORVERSION(ver
), MINORVERSION(ver
));
396 print_client("{{0x8a885d04,0x1ceb,0x11c9,{0x9f,0xe8,0x08,0x00,0x2b,0x10,0x48,0x60}},{2,0}},\n"); /* FIXME */
397 print_client("0,\n");
400 print_client("%u,\n", list_count(endpoints
));
401 print_client("(PRPC_PROTSEQ_ENDPOINT)%s__RpcProtseqEndpoint,\n", iface
->name
);
405 print_client("0,\n");
406 print_client("0,\n");
408 print_client("0,\n");
409 print_client("0,\n");
410 print_client("0,\n");
412 print_client("};\n");
414 print_client("RPC_IF_HANDLE %s_ClientIfHandle = (RPC_IF_HANDLE)& %s___RpcClientInterface;\n",
415 iface
->name
, iface
->name
);
417 print_client("RPC_IF_HANDLE %s%s_v%d_%d_c_ifspec = (RPC_IF_HANDLE)& %s___RpcClientInterface;\n",
418 prefix_client
, iface
->name
, MAJORVERSION(ver
), MINORVERSION(ver
), iface
->name
);
419 fprintf(client
, "\n");
423 static void write_implicithandledecl(type_t
*iface
)
425 const char *implicit_handle
= get_attrp(iface
->attrs
, ATTR_IMPLICIT_HANDLE
);
429 fprintf(client
, "handle_t %s;\n", implicit_handle
);
430 fprintf(client
, "\n");
435 static void init_client(void)
438 if (!(client
= fopen(client_name
, "w")))
439 error("Could not open %s for output\n", client_name
);
441 print_client("/*** Autogenerated by WIDL %s from %s - Do not edit ***/\n", PACKAGE_VERSION
, input_name
);
442 print_client("#include <string.h>\n");
443 print_client("#ifdef _ALPHA_\n");
444 print_client("#include <stdarg.h>\n");
445 print_client("#endif\n");
446 fprintf(client
, "\n");
447 print_client("#include \"%s\"\n", header_name
);
448 fprintf(client
, "\n");
452 void write_client(ifref_list_t
*ifaces
)
454 unsigned int proc_offset
= 0;
455 int expr_eval_routines
;
460 if (do_everything
&& !need_stub_files(ifaces
))
467 write_formatstringsdecl(client
, indent
, ifaces
, need_stub
);
468 expr_eval_routines
= write_expr_eval_routines(client
, client_token
);
469 if (expr_eval_routines
)
470 write_expr_eval_routine_list(client
, client_token
);
471 write_user_quad_list(client
);
473 if (ifaces
) LIST_FOR_EACH_ENTRY( iface
, ifaces
, ifref_t
, entry
)
475 if (!need_stub(iface
->iface
))
478 fprintf(client
, "/*****************************************************************************\n");
479 fprintf(client
, " * %s interface\n", iface
->iface
->name
);
480 fprintf(client
, " */\n");
481 fprintf(client
, "\n");
483 if (iface
->iface
->funcs
)
485 write_implicithandledecl(iface
->iface
);
487 write_clientinterfacedecl(iface
->iface
);
488 write_stubdescdecl(iface
->iface
);
489 write_function_stubs(iface
->iface
, &proc_offset
);
491 print_client("#if !defined(__RPC_WIN32__)\n");
492 print_client("#error Invalid build platform for this stub.\n");
493 print_client("#endif\n");
495 fprintf(client
, "\n");
496 write_stubdescriptor(iface
->iface
, expr_eval_routines
);
500 fprintf(client
, "\n");
502 write_procformatstring(client
, ifaces
, need_stub
);
503 write_typeformatstring(client
, ifaces
, need_stub
);