tools/widl/server.c

   1 /*
   2  * IDL Compiler
   3  *
   4  * Copyright 2005-2006 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #include "config.h"
  22 #include "wine/port.h"
  23
  24 #include <stdio.h>
  25 #include <stdlib.h>
  26 #ifdef HAVE_UNISTD_H
  27 # include <unistd.h>
  28 #endif
  29 #include <string.h>
  30 #include <assert.h>
  31 #include <ctype.h>
  32 #include <signal.h>
  33
  34 #include "widl.h"
  35 #include "utils.h"
  36 #include "parser.h"
  37 #include "header.h"
  38 #include "windef.h"
  39
  40 #include "widl.h"
  41 #include "typelib.h"
  42 #include "typelib_struct.h"
  43 #include "typegen.h"
  44
  45 static FILE* server;
  46 static int indent = 0;
  47
  48
  49 static int print_server(const char *format, ...)
  50 {
  51     va_list va;
  52     int i, r;
  53
  54     va_start(va, format);
  55     if (format[0] != '\n')
  56         for (i = 0; i < indent; i++)
  57             fprintf(server, "    ");
  58     r = vfprintf(server, format, va);
  59     va_end(va);
  60     return r;
  61 }
  62
  63
  64 static void write_parameters_init(const func_t *func)
  65 {
  66     const var_t *var;
  67
  68     if (!func->args)
  69         return;
  70
  71     LIST_FOR_EACH_ENTRY( var, func->args, const var_t, entry )
  72         if (var->type->type != RPC_FC_BIND_PRIMITIVE)
  73             print_server("%s = 0;\n", var->name);
  74
  75     fprintf(server, "\n");
  76 }
  77
  78
  79 static void write_function_stubs(type_t *iface, unsigned int *proc_offset)
  80 {
  81     char *implicit_handle = get_attrp(iface->attrs, ATTR_IMPLICIT_HANDLE);
  82     int explicit_handle = is_attr(iface->attrs, ATTR_EXPLICIT_HANDLE);
  83     const func_t *func;
  84     const var_t *var;
  85     const var_t* explicit_handle_var;
  86
  87     if (!iface->funcs) return;
  88     LIST_FOR_EACH_ENTRY( func, iface->funcs, const func_t, entry )
  89     {
  90         const var_t *def = func->def;
  91
  92         /* check for a defined binding handle */
  93         explicit_handle_var = get_explicit_handle_var(func);
  94         if (explicit_handle)
  95         {
  96             if (!explicit_handle_var)
  97             {
  98                 error("%s() does not define an explicit binding handle!\n", def->name);
  99                 return;
 100             }
 101         }
 102         else if (implicit_handle)
 103         {
 104             if (explicit_handle_var)
 105             {
 106                 error("%s() must not define a binding handle!\n", def->name);
 107                 return;
 108             }
 109         }
 110
 111         fprintf(server, "void __RPC_STUB\n");
 112         fprintf(server, "%s_", iface->name);
 113         write_name(server, def);
 114         fprintf(server, "(\n");
 115         indent++;
 116         print_server("PRPC_MESSAGE _pRpcMessage)\n");
 117         indent--;
 118
 119         /* write the functions body */
 120         fprintf(server, "{\n");
 121         indent++;
 122
 123         /* Declare arguments */
 124         declare_stub_args(server, indent, func);
 125
 126         print_server("MIDL_STUB_MESSAGE _StubMsg;\n");
 127         print_server("RPC_STATUS _Status;\n");
 128         fprintf(server, "\n");
 129
 130
 131         print_server("((void)(_Status));\n");
 132         print_server("NdrServerInitializeNew(\n");
 133         indent++;
 134         print_server("_pRpcMessage,\n");
 135         print_server("&_StubMsg,\n");
 136         print_server("&%s_StubDesc);\n", iface->name);
 137         indent--;
 138         fprintf(server, "\n");
 139
 140         write_parameters_init(func);
 141
 142         if (explicit_handle_var)
 143         {
 144             print_server("%s = _pRpcMessage->Handle;\n", explicit_handle_var->name);
 145             fprintf(server, "\n");
 146         }
 147
 148         print_server("RpcTryFinally\n");
 149         print_server("{\n");
 150         indent++;
 151         print_server("RpcTryExcept\n");
 152         print_server("{\n");
 153         indent++;
 154
 155         if (func->args)
 156         {
 157             print_server("if ((_pRpcMessage->DataRepresentation & 0x0000FFFFUL) != NDR_LOCAL_DATA_REPRESENTATION)\n");
 158             indent++;
 159             print_server("NdrConvert(\n");
 160             indent++;
 161             print_server("(PMIDL_STUB_MESSAGE)&_StubMsg,\n");
 162             print_server("(PFORMAT_STRING)&__MIDL_ProcFormatString.Format[%u]);\n", *proc_offset);
 163             indent -= 2;
 164             fprintf(server, "\n");
 165
 166             /* unmarshall arguments */
 167             write_remoting_arguments(server, indent, func, PASS_IN, PHASE_UNMARSHAL);
 168         }
 169
 170         print_server("if (_StubMsg.Buffer > _StubMsg.BufferEnd)\n");
 171         print_server("{\n");
 172         indent++;
 173         print_server("RpcRaiseException(RPC_X_BAD_STUB_DATA);\n");
 174         indent--;
 175         print_server("}\n");
 176         indent--;
 177         print_server("}\n");
 178         print_server("RpcExcept(RPC_BAD_STUB_DATA_EXCEPTION_FILTER)\n");
 179         print_server("{\n");
 180         indent++;
 181         print_server("RpcRaiseException(RPC_X_BAD_STUB_DATA);\n");
 182         indent--;
 183         print_server("}\n");
 184         print_server("RpcEndExcept\n");
 185         fprintf(server, "\n");
 186
 187         /* Assign 'out' arguments */
 188         assign_stub_out_args(server, indent, func);
 189
 190         /* Call the real server function */
 191         if (!is_void(def->type))
 192             print_server("_RetVal = ");
 193         else
 194             print_server("");
 195         write_prefix_name(server, prefix_server, def);
 196
 197         if (func->args)
 198         {
 199             int first_arg = 1;
 200
 201             fprintf(server, "(\n");
 202             indent++;
 203             LIST_FOR_EACH_ENTRY( var, func->args, const var_t, entry )
 204             {
 205                 if (first_arg)
 206                     first_arg = 0;
 207                 else
 208                     fprintf(server, ",\n");
 209                 print_server("");
 210                 if (var->array)
 211                     fprintf(server, "*");
 212                 write_name(server, var);
 213             }
 214             fprintf(server, ");\n");
 215             indent--;
 216         }
 217         else
 218         {
 219             fprintf(server, "();\n");
 220         }
 221
 222         if (has_out_arg_or_return(func))
 223         {
 224             write_remoting_arguments(server, indent, func, PASS_OUT, PHASE_BUFFERSIZE);
 225
 226             print_server("_pRpcMessage->BufferLength = _StubMsg.BufferLength;\n");
 227             fprintf(server, "\n");
 228             print_server("_Status = I_RpcGetBuffer(_pRpcMessage);\n");
 229             print_server("if (_Status)\n");
 230             indent++;
 231             print_server("RpcRaiseException(_Status);\n");
 232             indent--;
 233             fprintf(server, "\n");
 234             print_server("_StubMsg.Buffer = (unsigned char *)_pRpcMessage->Buffer;\n");
 235             fprintf(server, "\n");
 236         }
 237
 238         /* marshall arguments */
 239         write_remoting_arguments(server, indent, func, PASS_OUT, PHASE_MARSHAL);
 240
 241         /* marshall the return value */
 242         if (!is_void(def->type))
 243             print_phase_basetype(server, indent, PHASE_MARSHAL, PASS_RETURN, def, "_RetVal");
 244
 245         indent--;
 246         print_server("}\n");
 247         print_server("RpcFinally\n");
 248         print_server("{\n");
 249         indent++;
 250
 251         write_remoting_arguments(server, indent, func, PASS_OUT, PHASE_FREE);
 252
 253         indent--;
 254         print_server("}\n");
 255         print_server("RpcEndFinally\n");
 256
 257         /* calculate buffer length */
 258         fprintf(server, "\n");
 259         print_server("_pRpcMessage->BufferLength =\n");
 260         indent++;
 261         print_server("(unsigned int)(_StubMsg.Buffer - (unsigned char *)_pRpcMessage->Buffer);\n");
 262         indent--;
 263         indent--;
 264         fprintf(server, "}\n");
 265         fprintf(server, "\n");
 266
 267         /* update proc_offset */
 268         *proc_offset += get_size_procformatstring_func( func );
 269     }
 270 }
 271
 272
 273 static void write_dispatchtable(type_t *iface)
 274 {
 275     unsigned long ver = get_attrv(iface->attrs, ATTR_VERSION);
 276     unsigned long method_count = 0;
 277     const func_t *func;
 278
 279     print_server("static RPC_DISPATCH_FUNCTION %s_table[] =\n", iface->name);
 280     print_server("{\n");
 281     indent++;
 282
 283     if (iface->funcs) LIST_FOR_EACH_ENTRY( func, iface->funcs, const func_t, entry )
 284     {
 285         var_t *def = func->def;
 286
 287         print_server("%s_", iface->name);
 288         write_name(server, def);
 289         fprintf(server, ",\n");
 290
 291         method_count++;
 292     }
 293     print_server("0\n");
 294     indent--;
 295     print_server("};\n");
 296     print_server("RPC_DISPATCH_TABLE %s_v%d_%d_DispatchTable =\n", iface->name, LOWORD(ver), HIWORD(ver));
 297     print_server("{\n");
 298     indent++;
 299     print_server("%u,\n", method_count);
 300     print_server("%s_table\n", iface->name);
 301     indent--;
 302     print_server("};\n");
 303     fprintf(server, "\n");
 304 }
 305
 306
 307 static void write_stubdescdecl(type_t *iface)
 308 {
 309     print_server("static const MIDL_STUB_DESC %s_StubDesc;\n", iface->name);
 310     fprintf(server, "\n");
 311 }
 312
 313
 314 static void write_stubdescriptor(type_t *iface, int expr_eval_routines)
 315 {
 316     print_server("static const MIDL_STUB_DESC %s_StubDesc =\n", iface->name);
 317     print_server("{\n");
 318     indent++;
 319     print_server("(void *)& %s___RpcServerInterface,\n", iface->name);
 320     print_server("MIDL_user_allocate,\n");
 321     print_server("MIDL_user_free,\n");
 322     print_server("{\n");
 323     indent++;
 324     print_server("0,\n");
 325     indent--;
 326     print_server("},\n");
 327     print_server("0,\n");
 328     print_server("0,\n");
 329     if (expr_eval_routines)
 330         print_server("ExprEvalRoutines,\n");
 331     else
 332         print_server("0,\n");
 333     print_server("0,\n");
 334     print_server("__MIDL_TypeFormatString.Format,\n");
 335     print_server("1, /* -error bounds_check flag */\n");
 336     print_server("0x10001, /* Ndr library version */\n");
 337     print_server("0,\n");
 338     print_server("0x50100a4, /* MIDL Version 5.1.164 */\n");
 339     print_server("0,\n");
 340     print_server("0,\n");
 341     print_server("0,  /* notify & notify_flag routine table */\n");
 342     print_server("1,  /* Flags */\n");
 343     print_server("0,  /* Reserved3 */\n");
 344     print_server("0,  /* Reserved4 */\n");
 345     print_server("0   /* Reserved5 */\n");
 346     indent--;
 347     print_server("};\n");
 348     fprintf(server, "\n");
 349 }
 350
 351
 352 static void write_serverinterfacedecl(type_t *iface)
 353 {
 354     unsigned long ver = get_attrv(iface->attrs, ATTR_VERSION);
 355     UUID *uuid = get_attrp(iface->attrs, ATTR_UUID);
 356     const str_list_t *endpoints = get_attrp(iface->attrs, ATTR_ENDPOINT);
 357
 358     if (endpoints) write_endpoints( server, iface->name, endpoints );
 359
 360     print_server("extern RPC_DISPATCH_TABLE %s_v%d_%d_DispatchTable;\n", iface->name, LOWORD(ver), HIWORD(ver));
 361     fprintf(server, "\n");
 362     print_server("static const RPC_SERVER_INTERFACE %s___RpcServerInterface =\n", iface->name );
 363     print_server("{\n");
 364     indent++;
 365     print_server("sizeof(RPC_SERVER_INTERFACE),\n");
 366     print_server("{{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",
 367                  uuid->Data1, uuid->Data2, uuid->Data3, uuid->Data4[0], uuid->Data4[1],
 368                  uuid->Data4[2], uuid->Data4[3], uuid->Data4[4], uuid->Data4[5], uuid->Data4[6],
 369                  uuid->Data4[7], LOWORD(ver), HIWORD(ver));
 370     print_server("{{0x8a885d04,0x1ceb,0x11c9,{0x9f,0xe8,0x08,0x00,0x2b,0x10,0x48,0x60}},{2,0}},\n"); /* FIXME */
 371     print_server("&%s_v%d_%d_DispatchTable,\n", iface->name, LOWORD(ver), HIWORD(ver));
 372     if (endpoints)
 373     {
 374         print_server("%u,\n", list_count(endpoints));
 375         print_server("(PRPC_PROTSEQ_ENDPOINT)%s__RpcProtseqEndpoint,\n", iface->name);
 376     }
 377     else
 378     {
 379         print_server("0,\n");
 380         print_server("0,\n");
 381     }
 382     print_server("0,\n");
 383     print_server("0,\n");
 384     print_server("0,\n");
 385     indent--;
 386     print_server("};\n");
 387     if (old_names)
 388         print_server("RPC_IF_HANDLE %s_ServerIfHandle = (RPC_IF_HANDLE)& %s___RpcServerInterface;\n",
 389                      iface->name, iface->name);
 390     else
 391         print_server("RPC_IF_HANDLE %s%s_v%d_%d_s_ifspec = (RPC_IF_HANDLE)& %s___RpcServerInterface;\n",
 392                      prefix_server, iface->name, LOWORD(ver), HIWORD(ver), iface->name);
 393     fprintf(server, "\n");
 394 }
 395
 396
 397 static void init_server(void)
 398 {
 399     if (server)
 400         return;
 401     if (!(server = fopen(server_name, "w")))
 402         error("Could not open %s for output\n", server_name);
 403
 404     print_server("/*** Autogenerated by WIDL %s from %s - Do not edit ***/\n", PACKAGE_VERSION, input_name);
 405     print_server("#include <string.h>\n");
 406     fprintf(server, "\n");
 407     print_server("#include \"%s\"\n", header_name);
 408     fprintf(server, "\n");
 409 }
 410
 411
 412 void write_server(ifref_list_t *ifaces)
 413 {
 414     unsigned int proc_offset = 0;
 415     ifref_t *iface;
 416
 417     if (!do_server)
 418         return;
 419     if (do_everything && !ifaces)
 420         return;
 421
 422     init_server();
 423     if (!server)
 424         return;
 425
 426     write_formatstringsdecl(server, indent, ifaces, 0);
 427
 428     if (ifaces) LIST_FOR_EACH_ENTRY( iface, ifaces, ifref_t, entry )
 429     {
 430         if (is_object(iface->iface->attrs) || is_local(iface->iface->attrs))
 431             continue;
 432
 433         fprintf(server, "/*****************************************************************************\n");
 434         fprintf(server, " * %s interface\n", iface->iface->name);
 435         fprintf(server, " */\n");
 436         fprintf(server, "\n");
 437
 438         if (iface->iface->funcs)
 439         {
 440             int expr_eval_routines;
 441
 442             write_serverinterfacedecl(iface->iface);
 443             write_stubdescdecl(iface->iface);
 444
 445             write_function_stubs(iface->iface, &proc_offset);
 446
 447             print_server("#if !defined(__RPC_WIN32__)\n");
 448             print_server("#error  Invalid build platform for this stub.\n");
 449             print_server("#endif\n");
 450
 451             fprintf(server, "\n");
 452
 453             expr_eval_routines = write_expr_eval_routines(server, iface->iface->name);
 454             if (expr_eval_routines)
 455                 write_expr_eval_routine_list(server, iface->iface->name);
 456
 457             write_stubdescriptor(iface->iface, expr_eval_routines);
 458             write_dispatchtable(iface->iface);
 459         }
 460     }
 461
 462     fprintf(server, "\n");
 463
 464     write_procformatstring(server, ifaces, 0);
 465     write_typeformatstring(server, ifaces, 0);
 466
 467     fclose(server);
 468 }