git.oblomov.eu Git - wine/blob - tools/widl/client.c

   1 /*
   2  * IDL Compiler
   3  *
   4  * Copyright 2005 Eric Kohl
   5  *
   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.
  10  *
  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.
  15  *
  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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #include "config.h"
  22 #include "wine/port.h"
  23
  24 #include <stdio.h>
  25 #include <stdlib.h>
  26 #include <unistd.h>
  27 #include <string.h>
  28 #include <assert.h>
  29 #include <ctype.h>
  30 #include <signal.h>
  31
  32 #include "windef.h"
  33
  34 #include "widl.h"
  35 #include "utils.h"
  36 #include "parser.h"
  37 #include "header.h"
  38
  39 #include "widltypes.h"
  40 #include "typelib.h"
  41 #include "typelib_struct.h"
  42 #include "typegen.h"
  43
  44 #define END_OF_LIST(list)       \
  45   do {                          \
  46     if (list) {                 \
  47       while (NEXT_LINK(list))   \
  48         list = NEXT_LINK(list); \
  49     }                           \
  50   } while(0)
  51
  52 static FILE* client;
  53 static int indent = 0;
  54
  55 static int print_client( const char *format, ... )
  56 {
  57     va_list va;
  58     int i, r;
  59
  60     va_start(va, format);
  61     for (i = 0; i < indent; i++)
  62         fprintf(client, "    ");
  63     r = vfprintf(client, format, va);
  64     va_end(va);
  65     return r;
  66 }
  67
  68
  69 static void print_message_buffer_size(func_t *func)
  70 {
  71     unsigned int total_size = 0;
  72
  73     if (func->args)
  74     {
  75         var_t *var = func->args;
  76         while (NEXT_LINK(var)) var = NEXT_LINK(var);
  77         while (var)
  78         {
  79             unsigned int alignment;
  80
  81             total_size += get_required_buffer_size(var, &alignment);
  82             total_size += alignment;
  83
  84             var = PREV_LINK(var);
  85         }
  86     }
  87     fprintf(client, " %u", total_size);
  88 }
  89
  90
  91 static void write_function_stubs(type_t *iface)
  92 {
  93     func_t *func = iface->funcs;
  94     char *implicit_handle = get_attrp(iface->attrs, ATTR_IMPLICIT_HANDLE);
  95     int explicit_handle = is_attr(iface->attrs, ATTR_EXPLICIT_HANDLE);
  96     var_t *var;
  97     int method_count = 0;
  98     unsigned int proc_offset = 0;
  99     unsigned int type_offset = 2;
 100
 101     while (NEXT_LINK(func)) func = NEXT_LINK(func);
 102     while (func)
 103     {
 104         var_t *def = func->def;
 105         var_t* explicit_handle_var;
 106
 107         /* check for a defined binding handle */
 108         explicit_handle_var = get_explicit_handle_var(func);
 109         if (explicit_handle)
 110         {
 111             if (!explicit_handle_var)
 112             {
 113                 error("%s() does not define an explicit binding handle!\n", def->name);
 114                 return;
 115             }
 116         }
 117         else if (implicit_handle)
 118         {
 119             if (explicit_handle_var)
 120             {
 121                 error("%s() must not define a binding handle!\n", def->name);
 122                 return;
 123             }
 124         }
 125
 126         write_type(client, def->type, def, def->tname);
 127         fprintf(client, " ");
 128         write_name(client, def);
 129         fprintf(client, "(\n");
 130         indent++;
 131         if (func->args)
 132             write_args(client, func->args, iface->name, 0, TRUE);
 133         else
 134             print_client("void");
 135         fprintf(client, ")\n");
 136         indent--;
 137
 138         /* write the functions body */
 139         fprintf(client, "{\n");
 140         indent++;
 141
 142         /* declare return value '_RetVal' */
 143         if (!is_void(def->type, NULL))
 144         {
 145             print_client("");
 146             write_type(client, def->type, def, def->tname);
 147             fprintf(client, " _RetVal;\n");
 148         }
 149
 150         if (implicit_handle || explicit_handle_var)
 151             print_client("RPC_BINDING_HANDLE _Handle = 0;\n");
 152
 153         print_client("RPC_MESSAGE _RpcMessage;\n");
 154         print_client("MIDL_STUB_MESSAGE _StubMsg;\n");
 155         fprintf(client, "\n");
 156         print_client("RpcTryFinally\n");
 157         print_client("{\n");
 158         indent++;
 159
 160         print_client("NdrClientInitializeNew(\n");
 161         indent++;
 162         print_client("(PRPC_MESSAGE)&_RpcMessage,\n");
 163         print_client("(PMIDL_STUB_MESSAGE)&_StubMsg,\n");
 164         print_client("(PMIDL_STUB_DESC)&%s_StubDesc,\n", iface->name);
 165         print_client("%d);\n", method_count);
 166         indent--;
 167         fprintf(client, "\n");
 168
 169         if (implicit_handle)
 170         {
 171             print_client("_Handle = %s;\n", implicit_handle);
 172             fprintf(client, "\n");
 173         }
 174         else if (explicit_handle_var)
 175         {
 176             print_client("_Handle = %s;\n", explicit_handle_var->name);
 177             fprintf(client, "\n");
 178         }
 179
 180         /* emit the message buffer size */
 181         print_client("_StubMsg.BufferLength =");
 182         print_message_buffer_size(func);
 183         fprintf(client, ";\n");
 184
 185         print_client("NdrGetBuffer(\n");
 186         indent++;
 187         print_client("(PMIDL_STUB_MESSAGE)&_StubMsg,\n");
 188         print_client("_StubMsg.BufferLength,\n");
 189         if (implicit_handle || explicit_handle_var)
 190             print_client("_Handle);\n");
 191         else
 192             print_client("%s__MIDL_AutoBindHandle);\n", iface->name);
 193         indent--;
 194         fprintf(client, "\n");
 195
 196
 197         /* marshal arguments */
 198         marshall_arguments(client, indent, func, &type_offset, PASS_IN);
 199
 200         /* send/receive message */
 201         /* print_client("NdrNsSendReceive(\n"); */
 202         /* print_client("(unsigned char *)_StubMsg.Buffer,\n"); */
 203         /* print_client("(RPC_BINDING_HANDLE *) &%s__MIDL_AutoBindHandle);\n", iface->name); */
 204         print_client("NdrSendReceive(\n");
 205         indent++;
 206         print_client("(PMIDL_STUB_MESSAGE)&_StubMsg,\n");
 207         print_client("(unsigned char *)_StubMsg.Buffer);\n\n");
 208         indent--;
 209
 210         print_client("_StubMsg.BufferStart = (unsigned char *)_RpcMessage.Buffer;\n");
 211         print_client("_StubMsg.BufferEnd = _StubMsg.BufferStart + _RpcMessage.BufferLength;\n\n");
 212
 213         unmarshall_arguments(client, indent, func, &type_offset, PASS_OUT);
 214
 215         /* unmarshal return value */
 216         if (!is_void(def->type, NULL))
 217         {
 218             fprintf(client, "\n");
 219
 220             print_client("if ((_RpcMessage.DataRepresentation & 0x0000FFFFUL) != NDR_LOCAL_DATA_REPRESENTATION)\n");
 221             indent++;
 222             print_client("NdrConvert(\n");
 223             indent++;
 224             print_client("(PMIDL_STUB_MESSAGE)&_StubMsg,\n");
 225             print_client("(PFORMAT_STRING)&__MIDL_ProcFormatString.Format[%u]);\n", proc_offset);
 226             indent -= 2;
 227             fprintf(client, "\n");
 228
 229             print_client("_RetVal = *(");
 230             write_type(client, def->type, def, def->tname);
 231             fprintf(client, " *)_StubMsg.Buffer;\n");
 232             fprintf(client, "_StubMsg.Buffer += sizeof(");
 233             write_type(client, def->type, def, def->tname);
 234             fprintf(client, ");\n");
 235         }
 236
 237         /* update proc_offset */
 238         if (func->args)
 239         {
 240             var = func->args;
 241             while (NEXT_LINK(var)) var = NEXT_LINK(var);
 242             while (var)
 243             {
 244                 proc_offset += get_size_procformatstring_var(var);
 245                 var = PREV_LINK(var);
 246             }
 247         }
 248         if (!is_void(def->type, NULL))
 249             proc_offset += get_size_procformatstring_var(def);
 250
 251         indent--;
 252         print_client("}\n");
 253         print_client("RpcFinally\n");
 254         print_client("{\n");
 255         indent++;
 256
 257
 258         /* FIXME: emit client finally code */
 259
 260         print_client("NdrFreeBuffer((PMIDL_STUB_MESSAGE)&_StubMsg);\n");
 261
 262         indent--;
 263         print_client("}\n");
 264         print_client("RpcEndFinally\n");
 265
 266
 267         /* emit return code */
 268         if (!is_void(def->type, NULL))
 269         {
 270             fprintf(client, "\n");
 271             print_client("return _RetVal;\n");
 272         }
 273
 274         indent--;
 275         fprintf(client, "}\n");
 276         fprintf(client, "\n");
 277
 278         method_count++;
 279         func = PREV_LINK(func);
 280     }
 281 }
 282
 283
 284 static void write_bindinghandledecl(type_t *iface)
 285 {
 286     print_client("static RPC_BINDING_HANDLE %s__MIDL_AutoBindHandle;\n", iface->name);
 287     fprintf(client, "\n");
 288 }
 289
 290
 291 static void write_stubdescdecl(type_t *iface)
 292 {
 293     print_client("extern const MIDL_STUB_DESC %s_StubDesc;\n", iface->name);
 294     fprintf(client, "\n");
 295 }
 296
 297
 298 static void write_stubdescriptor(type_t *iface)
 299 {
 300     char *implicit_handle = get_attrp(iface->attrs, ATTR_IMPLICIT_HANDLE);
 301
 302     print_client("static const MIDL_STUB_DESC %s_StubDesc =\n", iface->name);
 303     print_client("{\n");
 304     indent++;
 305     print_client("(void *)& %s___RpcClientInterface,\n", iface->name);
 306     print_client("MIDL_user_allocate,\n");
 307     print_client("MIDL_user_free,\n");
 308     if (implicit_handle)
 309         print_client("&%s,\n", implicit_handle);
 310     else
 311         print_client("&%s__MIDL_AutoBindHandle,\n", iface->name);
 312     print_client("0,\n");
 313     print_client("0,\n");
 314     print_client("0,\n");
 315     print_client("0,\n");
 316     print_client("__MIDL_TypeFormatString.Format,\n");
 317     print_client("1, /* -error bounds_check flag */\n");
 318     print_client("0x10001, /* Ndr library version */\n");
 319     print_client("0,\n");
 320     print_client("0x50100a4, /* MIDL Version 5.1.164 */\n");
 321     print_client("0,\n");
 322     print_client("0,\n");
 323     print_client("0,  /* notify & notify_flag routine table */\n");
 324     print_client("1,  /* Flags */\n");
 325     print_client("0,  /* Reserved3 */\n");
 326     print_client("0,  /* Reserved4 */\n");
 327     print_client("0   /* Reserved5 */\n");
 328     indent--;
 329     print_client("};\n");
 330     fprintf(client, "\n");
 331 }
 332
 333
 334 static void write_clientinterfacedecl(type_t *iface)
 335 {
 336     unsigned long ver = get_attrv(iface->attrs, ATTR_VERSION);
 337     UUID *uuid = get_attrp(iface->attrs, ATTR_UUID);
 338
 339     print_client("static const RPC_CLIENT_INTERFACE %s___RpcClientInterface =\n", iface->name );
 340     print_client("{\n");
 341     indent++;
 342     print_client("sizeof(RPC_CLIENT_INTERFACE),\n");
 343     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",
 344                  uuid->Data1, uuid->Data2, uuid->Data3, uuid->Data4[0], uuid->Data4[1],
 345                  uuid->Data4[2], uuid->Data4[3], uuid->Data4[4], uuid->Data4[5], uuid->Data4[6],
 346                  uuid->Data4[7], LOWORD(ver), HIWORD(ver));
 347     print_client("{{0x8a885d04,0x1ceb,0x11c9,{0x9f,0xe8,0x08,0x00,0x2b,0x10,0x48,0x60}},{2,0}},\n"); /* FIXME */
 348     print_client("0,\n");
 349     print_client("0,\n");
 350     print_client("0,\n");
 351     print_client("0,\n");
 352     print_client("0,\n");
 353     print_client("0,\n");
 354     indent--;
 355     print_client("};\n");
 356     print_client("RPC_IF_HANDLE %s_v%d_%d_c_ifspec = (RPC_IF_HANDLE)& %s___RpcClientInterface;\n",
 357                  iface->name, LOWORD(ver), HIWORD(ver), iface->name);
 358     fprintf(client, "\n");
 359 }
 360
 361
 362 static void write_formatdesc( const char *str )
 363 {
 364     print_client("typedef struct _MIDL_%s_FORMAT_STRING\n", str );
 365     print_client("{\n");
 366     indent++;
 367     print_client("short Pad;\n");
 368     print_client("unsigned char Format[%s_FORMAT_STRING_SIZE];\n", str);
 369     indent--;
 370     print_client("} MIDL_%s_FORMAT_STRING;\n", str);
 371     print_client("\n");
 372 }
 373
 374
 375 static void write_formatstringsdecl(type_t *iface)
 376 {
 377     int byte_count = 1;
 378
 379     print_client("#define TYPE_FORMAT_STRING_SIZE %d\n", 3); /* FIXME */
 380
 381     /* determine the proc format string size */
 382     if (iface->funcs)
 383     {
 384         func_t *func = iface->funcs;
 385         while (NEXT_LINK(func)) func = NEXT_LINK(func);
 386         while (func)
 387         {
 388             /* argument list size */
 389             if (func->args)
 390             {
 391                 var_t *var = func->args;
 392                 while (NEXT_LINK(var)) var = NEXT_LINK(var);
 393                 while (var)
 394                 {
 395                     byte_count += 2; /* FIXME: determine real size */
 396                     var = PREV_LINK(var);
 397                 }
 398             }
 399
 400             /* return value size */
 401             byte_count += 2; /* FIXME: determine real size */
 402             func = PREV_LINK(func);
 403         }
 404     }
 405     print_client("#define PROC_FORMAT_STRING_SIZE %d\n", byte_count);
 406
 407     fprintf(client, "\n");
 408     write_formatdesc("TYPE");
 409     write_formatdesc("PROC");
 410     fprintf(client, "\n");
 411     print_client("extern const MIDL_TYPE_FORMAT_STRING __MIDL_TypeFormatString;\n");
 412     print_client("extern const MIDL_PROC_FORMAT_STRING __MIDL_ProcFormatString;\n");
 413     print_client("\n");
 414 }
 415
 416
 417 static void write_implicithandledecl(type_t *iface)
 418 {
 419     char *implicit_handle = get_attrp(iface->attrs, ATTR_IMPLICIT_HANDLE);
 420
 421     if (implicit_handle)
 422     {
 423         fprintf(client, "handle_t %s;\n", implicit_handle);
 424         fprintf(client, "\n");
 425     }
 426 }
 427
 428
 429 static void init_client(void)
 430 {
 431     if (client) return;
 432     if (!(client = fopen(client_name, "w")))
 433         error("Could not open %s for output\n", client_name);
 434
 435     print_client("/*** Autogenerated by WIDL %s from %s - Do not edit ***/\n", WIDL_FULLVERSION, input_name);
 436     print_client("#include <string.h>\n");
 437     print_client("#ifdef _ALPHA_\n");
 438     print_client("#include <stdarg.h>\n");
 439     print_client("#endif\n");
 440     fprintf(client, "\n");
 441     print_client("#include \"%s\"\n", header_name);
 442     fprintf(client, "\n");
 443 }
 444
 445
 446 void write_client(ifref_t *ifaces)
 447 {
 448     ifref_t *iface = ifaces;
 449
 450     if (!do_client)
 451         return;
 452     if (!iface)
 453         return;
 454     END_OF_LIST(iface);
 455
 456     init_client();
 457     if (!client)
 458         return;
 459
 460     while (iface)
 461     {
 462         fprintf(client, "/*****************************************************************************\n");
 463         fprintf(client, " * %s interface\n", iface->iface->name);
 464         fprintf(client, " */\n");
 465         fprintf(client, "\n");
 466
 467         if (iface->iface->funcs)
 468         {
 469             write_formatstringsdecl(iface->iface);
 470             write_implicithandledecl(iface->iface);
 471
 472             write_clientinterfacedecl(iface->iface);
 473             write_stubdescdecl(iface->iface);
 474             write_bindinghandledecl(iface->iface);
 475
 476             write_function_stubs(iface->iface);
 477             write_stubdescriptor(iface->iface);
 478         }
 479
 480         print_client("#if !defined(__RPC_WIN32__)\n");
 481         print_client("#error  Invalid build platform for this stub.\n");
 482         print_client("#endif\n");
 483         fprintf(client, "\n");
 484
 485         write_procformatstring(client, iface->iface);
 486         write_typeformatstring(client, iface->iface);
 487
 488         fprintf(client, "\n");
 489
 490         iface = PREV_LINK(iface);
 491     }
 492
 493     fclose(client);
 494 }