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