tools/winedump/output.c

   1 /*
   2  *  Code generation functions
   3  *
   4  *  Copyright 2000-2002 Jon Griffiths
   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 "winedump.h"
  25
  26 /* Output files */
  27 static FILE *specfile = NULL;
  28 static FILE *hfile    = NULL;
  29 static FILE *cfile    = NULL;
  30
  31 static void  output_spec_postamble (void);
  32 static void  output_header_postamble (void);
  33 static void  output_c_postamble (void);
  34 static void  output_c_banner (const parsed_symbol *sym);
  35 static const char *get_format_str (int type);
  36 static const char *get_in_or_out (const parsed_symbol *sym, size_t arg);
  37
  38
  39 /*******************************************************************
  40  *         output_spec_preamble
  41  *
  42  * Write the first part of the .spec file
  43  */
  44 void  output_spec_preamble (void)
  45 {
  46   specfile = open_file (OUTPUT_DLL_NAME, ".spec", "w");
  47
  48   atexit (output_spec_postamble);
  49
  50   if (VERBOSE)
  51     puts ("Creating .spec preamble");
  52
  53   fprintf (specfile,
  54            "# Generated from %s by winedump\n\n", globals.input_name);
  55 }
  56
  57
  58 /*******************************************************************
  59  *         output_spec_symbol
  60  *
  61  * Write a symbol to the .spec file
  62  */
  63 void  output_spec_symbol (const parsed_symbol *sym)
  64 {
  65   char ord_spec[16];
  66
  67   assert (specfile);
  68   assert (sym && sym->symbol);
  69
  70   if (sym->ordinal >= 0)
  71     snprintf(ord_spec, 8, "%d", sym->ordinal);
  72   else
  73   {
  74     ord_spec[0] = '@';
  75     ord_spec[1] = '\0';
  76   }
  77   if (sym->flags & SYM_THISCALL)
  78     strcat (ord_spec, " -i386"); /* For binary compatibility only */
  79
  80   if (!globals.do_code || !sym->function_name)
  81   {
  82     if (sym->flags & SYM_DATA)
  83     {
  84       if (globals.forward_dll)
  85         fprintf (specfile, "%s forward %s %s.%s #", ord_spec, sym->symbol,
  86                  globals.forward_dll, sym->symbol);
  87
  88       fprintf (specfile, "%s extern %s %s\n", ord_spec, sym->symbol,
  89                sym->arg_name[0]);
  90       return;
  91     }
  92
  93     if (globals.forward_dll)
  94       fprintf (specfile, "%s forward %s %s.%s\n", ord_spec, sym->symbol,
  95                globals.forward_dll, sym->symbol);
  96     else
  97       fprintf (specfile, "%s stub %s\n", ord_spec, sym->symbol);
  98   }
  99   else
 100   {
 101     unsigned int i = sym->flags & SYM_THISCALL ? 1 : 0;
 102
 103     fprintf (specfile, "%s %s %s(", ord_spec, sym->varargs ? "varargs" :
 104              symbol_get_call_convention(sym), sym->symbol);
 105
 106     for (; i < sym->argc; i++)
 107       fprintf (specfile, " %s", symbol_get_spec_type(sym, i));
 108
 109     if (sym->argc)
 110       fputc (' ', specfile);
 111     fprintf (specfile, ") %s_%s", OUTPUT_UC_DLL_NAME, sym->function_name);
 112
 113     if (sym->flags & SYM_THISCALL)
 114       fputs (" # __thiscall", specfile);
 115
 116     fputc ('\n',specfile);
 117   }
 118 }
 119
 120
 121 /*******************************************************************
 122  *         output_spec_postamble
 123  *
 124  * Write the last part of the .spec file
 125  */
 126 static void output_spec_postamble (void)
 127 {
 128   if (specfile)
 129     fclose (specfile);
 130   specfile = NULL;
 131 }
 132
 133
 134 /*******************************************************************
 135  *         output_header_preamble
 136  *
 137  * Write the first part of the .h file
 138  */
 139 void  output_header_preamble (void)
 140 {
 141   hfile = open_file (OUTPUT_DLL_NAME, "_dll.h", "w");
 142
 143   atexit (output_header_postamble);
 144
 145   fprintf (hfile,
 146            "/*\n * %s.dll\n *\n * Generated from %s.dll by winedump.\n *\n"
 147            " * DO NOT SEND GENERATED DLLS FOR INCLUSION INTO WINE !\n * \n */"
 148            "\n#ifndef __WINE_%s_DLL_H\n#define __WINE_%s_DLL_H\n\n"
 149            "#include \"windef.h\"\n#include \"wine/debug.h\"\n"
 150            "#include \"winbase.h\"\n#include \"winnt.h\"\n\n\n",
 151            OUTPUT_DLL_NAME, OUTPUT_DLL_NAME, OUTPUT_UC_DLL_NAME,
 152            OUTPUT_UC_DLL_NAME);
 153 }
 154
 155
 156 /*******************************************************************
 157  *         output_header_symbol
 158  *
 159  * Write a symbol to the .h file
 160  */
 161 void  output_header_symbol (const parsed_symbol *sym)
 162 {
 163   assert (hfile);
 164   assert (sym && sym->symbol);
 165
 166   if (!globals.do_code)
 167     return;
 168
 169   if (sym->flags & SYM_DATA)
 170     return;
 171
 172   if (!sym->function_name)
 173     fprintf (hfile, "/* __%s %s_%s(); */\n", symbol_get_call_convention(sym),
 174              OUTPUT_UC_DLL_NAME, sym->symbol);
 175   else
 176   {
 177     output_prototype (hfile, sym);
 178     fputs (";\n", hfile);
 179   }
 180 }
 181
 182
 183 /*******************************************************************
 184  *         output_header_postamble
 185  *
 186  * Write the last part of the .h file
 187  */
 188 static void output_header_postamble (void)
 189 {
 190   if (hfile)
 191   {
 192     fprintf (hfile, "\n\n\n#endif\t/* __WINE_%s_DLL_H */\n",
 193              OUTPUT_UC_DLL_NAME);
 194     fclose (hfile);
 195     hfile = NULL;
 196   }
 197 }
 198
 199
 200 /*******************************************************************
 201  *         output_c_preamble
 202  *
 203  * Write the first part of the .c file
 204  */
 205 void  output_c_preamble (void)
 206 {
 207   cfile = open_file (OUTPUT_DLL_NAME, "_main.c", "w");
 208
 209   atexit (output_c_postamble);
 210
 211   fprintf (cfile,
 212            "/*\n * %s.dll\n *\n * Generated from %s by winedump.\n *\n"
 213            " * DO NOT SUBMIT GENERATED DLLS FOR INCLUSION INTO WINE!\n * \n */"
 214            "\n\n#include \"config.h\"\n#include \"%s_dll.h\"\n\n"
 215            "WINE_DEFAULT_DEBUG_CHANNEL(%s);\n\n",
 216            OUTPUT_DLL_NAME, globals.input_name, OUTPUT_DLL_NAME,
 217            OUTPUT_DLL_NAME);
 218
 219   if (globals.forward_dll)
 220   {
 221     if (VERBOSE)
 222       puts ("Creating a forwarding DLL");
 223
 224     fputs ("\nHMODULE hDLL=0;\t/* DLL to call */\n\n", cfile);
 225   }
 226
 227   fputs ("#ifdef __i386__\n#define GET_THIS(t,p) t p;\\\n__asm__ __volatile__"
 228          " (\"movl %%ecx, %0\" : \"=m\" (p))\n#endif\n\n\n", cfile);
 229
 230   fprintf (cfile,
 231            "BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID "
 232            "lpvReserved)\n{\n\tTRACE(\"(0x%%p, %%ld, %%p)\\n\",hinstDLL,"
 233            "fdwReason,lpvReserved);\n\n\t"
 234            "if (fdwReason == DLL_PROCESS_ATTACH)\n\t{\n\t\t");
 235
 236   if (globals.forward_dll)
 237   {
 238     fprintf (cfile,
 239              "hDLL = LoadLibraryA( \"%s\" );\n\t\t"
 240              "TRACE(\":Forwarding DLL (%s) loaded (%%ld)\\n\",(LONG)hDLL);",
 241              globals.forward_dll, globals.forward_dll);
 242   }
 243   else
 244     fputs ("/* FIXME: Initialisation */", cfile);
 245
 246   fputs ("\n\t}\n\telse if (fdwReason == DLL_PROCESS_DETACH)\n\t{\n\t\t",
 247          cfile);
 248
 249   if (globals.forward_dll)
 250   {
 251     fprintf (cfile,
 252              "FreeLibrary( hDLL );\n\t\tTRACE(\":Forwarding DLL (%s)"
 253              " freed\\n\");", globals.forward_dll);
 254   }
 255   else
 256     fputs ("/* FIXME: Cleanup */", cfile);
 257
 258   fputs ("\n\t}\n\n\treturn TRUE;\n}\n\n\n", cfile);
 259 }
 260
 261
 262 #define CPP_END  if (sym->flags & SYM_THISCALL) \
 263   fputs ("#endif\n", cfile); fputs ("\n\n", cfile)
 264 #define GET_THIS if (sym->flags & SYM_THISCALL) \
 265   fprintf (cfile, "\tGET_THIS(%s,%s);\n", sym->arg_text[0],sym->arg_name[0])
 266
 267 /*******************************************************************
 268  *         output_c_symbol
 269  *
 270  * Write a symbol to the .c file
 271  */
 272 void  output_c_symbol (const parsed_symbol *sym)
 273 {
 274   unsigned int i, start = sym->flags & SYM_THISCALL ? 1 : 0;
 275   int is_void;
 276
 277   assert (cfile);
 278   assert (sym && sym->symbol);
 279
 280   if (!globals.do_code)
 281     return;
 282
 283   if (sym->flags & SYM_DATA)
 284   {
 285     fprintf (cfile, "/* FIXME: Move to top of file */\n%s;\n\n",
 286              sym->arg_text[0]);
 287     return;
 288   }
 289
 290   if (sym->flags & SYM_THISCALL)
 291     fputs ("#ifdef __i386__\n", cfile);
 292
 293   output_c_banner(sym);
 294
 295   if (!sym->function_name)
 296   {
 297     /* #ifdef'd dummy */
 298     fprintf (cfile, "#if 0\n__%s %s_%s()\n{\n\t/* %s in .spec */\n}\n#endif\n",
 299              symbol_get_call_convention(sym), OUTPUT_UC_DLL_NAME, sym->symbol,
 300              globals.forward_dll ? "@forward" : "@stub");
 301     CPP_END;
 302     return;
 303   }
 304
 305   is_void = !strcmp (sym->return_text, "void");
 306
 307   output_prototype (cfile, sym);
 308   fputs ("\n{\n", cfile);
 309
 310   if (!globals.do_trace)
 311   {
 312     GET_THIS;
 313     fputs ("\tFIXME(\":stub\\n\");\n", cfile);
 314     if (!is_void)
 315         fprintf (cfile, "\treturn (%s) 0;\n", sym->return_text);
 316     fputs ("}\n", cfile);
 317     CPP_END;
 318     return;
 319   }
 320
 321   /* Tracing, maybe forwarding as well */
 322   if (globals.forward_dll)
 323   {
 324     /* Write variables for calling */
 325     if (sym->varargs)
 326       fputs("\tva_list valist;\n", cfile);
 327
 328     fprintf (cfile, "\t%s (__%s *pFunc)(", sym->return_text,
 329              symbol_get_call_convention(sym));
 330
 331     for (i = start; i < sym->argc; i++)
 332       fprintf (cfile, "%s%s", i > start ? ", " : "", sym->arg_text [i]);
 333
 334     fprintf (cfile, "%s);\n", sym->varargs ? ",..." : sym->argc == 1 &&
 335              sym->flags & SYM_THISCALL ? "" : sym->argc ? "" : "void");
 336
 337     if (!is_void)
 338       fprintf (cfile, "\t%s retVal;\n", sym->return_text);
 339
 340     GET_THIS;
 341
 342     fprintf (cfile, "\tpFunc=(void*)GetProcAddress(hDLL,\"%s\");\n",
 343              sym->symbol);
 344   }
 345
 346   /* TRACE input arguments */
 347   fprintf (cfile, "\tTRACE(\"(%s", !sym->argc ? "void" : "");
 348
 349   for (i = 0; i < sym->argc; i++)
 350     fprintf (cfile, "%s(%s)%s", i ? "," : "", sym->arg_text [i],
 351              get_format_str (sym->arg_type [i]));
 352
 353   fprintf (cfile, "%s): %s\\n\"", sym->varargs ? ",..." : "",
 354            globals.forward_dll ? "forward" : "stub");
 355
 356   for (i = 0; i < sym->argc; i++)
 357     if (sym->arg_type[i] != ARG_STRUCT)
 358       fprintf(cfile, ",%s%s%s%s", sym->arg_type[i] == ARG_LONG ? "(LONG)" : "",
 359               sym->arg_type[i] == ARG_WIDE_STRING ? "debugstr_w(" : "",
 360               sym->arg_name[i],
 361               sym->arg_type[i] == ARG_WIDE_STRING ? ")" : "");
 362
 363   fputs (");\n", cfile);
 364
 365   if (!globals.forward_dll)
 366   {
 367     if (!is_void)
 368       fprintf (cfile, "\treturn (%s) 0;\n", sym->return_text);
 369     fputs ("}\n", cfile);
 370     CPP_END;
 371     return;
 372   }
 373
 374   /* Call the DLL */
 375   if (sym->varargs)
 376     fprintf (cfile, "\tva_start(valist,%s);\n", sym->arg_name[sym->argc-1]);
 377
 378   fprintf (cfile, "\t%spFunc(", !is_void ? "retVal = " : "");
 379
 380   for (i = 0; i < sym->argc; i++)
 381     fprintf (cfile, "%s%s", i ? "," : "", sym->arg_name [i]);
 382
 383   fputs (sym->varargs ? ",valist);\n\tva_end(valist);" : ");", cfile);
 384
 385   /* TRACE return value */
 386   fprintf (cfile, "\n\tTRACE(\"Returned (%s)\\n\"",
 387            get_format_str (sym->return_type));
 388
 389   if (!is_void)
 390   {
 391     if (sym->return_type == ARG_WIDE_STRING)
 392       fputs (",debugstr_w(retVal)", cfile);
 393     else
 394       fprintf (cfile, ",%s%s", sym->return_type == ARG_LONG ? "(LONG)" : "",
 395                sym->return_type == ARG_STRUCT ? "" : "retVal");
 396     fputs (");\n\treturn retVal;\n", cfile);
 397   }
 398   else
 399     fputs (");\n", cfile);
 400
 401   fputs ("}\n", cfile);
 402   CPP_END;
 403 }
 404
 405
 406 /*******************************************************************
 407  *         output_c_postamble
 408  *
 409  * Write the last part of the .c file
 410  */
 411 static void output_c_postamble (void)
 412 {
 413   if (cfile)
 414     fclose (cfile);
 415   cfile = NULL;
 416 }
 417
 418
 419 /*******************************************************************
 420  *         output_makefile
 421  *
 422  * Write a Wine compatible makefile.in
 423  */
 424 void  output_makefile (void)
 425 {
 426   FILE *makefile = open_file ("Makefile", ".in", "w");
 427
 428   if (VERBOSE)
 429     puts ("Creating makefile");
 430
 431   fprintf (makefile,
 432            "# Generated from %s by winedump.\nTOPSRCDIR = @top_srcdir@\n"
 433            "TOPOBJDIR = ../..\nSRCDIR    = @srcdir@\nVPATH     = @srcdir@\n"
 434            "MODULE    = %s.dll\n", globals.input_name, OUTPUT_DLL_NAME);
 435
 436   fprintf (makefile, "IMPORTS   = kernel32");
 437   if (globals.forward_dll)
 438     fprintf (makefile, " %s", globals.forward_dll);
 439
 440   fprintf (makefile,
 441            "\n\nC_SRCS = \\\n\t%s_main.c\n\n@MAKE_DLL_RULES@\n\n### Dependencies:",
 442            OUTPUT_DLL_NAME);
 443
 444   if (globals.forward_dll)
 445     fprintf (specfile,"#import %s.dll\n", globals.forward_dll);
 446
 447   fclose (makefile);
 448 }
 449
 450
 451 /*******************************************************************
 452  *         output_install_script
 453  *
 454  * Write a script to insert the DLL into Wine
 455  *
 456  * Rather than using diff/patch, several sed calls are generated
 457  * so the script can be re-run at any time without breaking.
 458  */
 459 void  output_install_script (void)
 460 {
 461   FILE *install_file = open_file (OUTPUT_DLL_NAME, "_install", "w");
 462
 463   if (VERBOSE)
 464     puts ("Creating install script");
 465
 466   fprintf (install_file,
 467     "#!/bin/bash\n"
 468     "# Generated from %s.dll by winedump.\n\n"
 469     "if [ $# -ne 1 ] || [ ! -d $1 ] || [ ! -f $1/AUTHORS ]; then\n"
 470     "\t[ $# -eq 1 ] && echo \"Invalid path\"\n"
 471     "\techo \"Usage: $0 wine-base-dir\"\n"
 472     "\texit 1\n"
 473     "fi\n\n"
 474     "if [ -d $1/dlls/%s ]; then\n"
 475     "\techo \"DLL is already present\"\n"
 476     "\texit 1\n"
 477     "fi\n\n"
 478     "echo Adding DLL %s to Wine build tree...\n\n"
 479     "mkdir $1/dlls/%s\n"
 480     "cp %s.spec $1/dlls/%s\n"
 481     "cp %s_main.c $1/dlls/%s\n"
 482     "cp %s_dll.h $1/dlls/%s\n"
 483     "cp Makefile.in $1/dlls/%s/Makefile.in\n"
 484     "echo Copied DLL files\n\n"
 485     "cd $1\n\n"
 486     "sed '/dlls\\/x11drv\\/Makefile/"
 487         "{G;s/$/dlls\\/%s\\/Makefile/;}' configure.ac >t.tmp\n"
 488     "mv -f t.tmp configure.ac\n"
 489     "echo Patched configure.ac\n\n"
 490     "cd $1/dlls && ./make_dlls\n\n"
 491     "echo Run \\'autoconf\\', \\'./configure\\' then \\'make\\' to rebuild Wine\n\n",
 492            OUTPUT_DLL_NAME, OUTPUT_DLL_NAME, OUTPUT_DLL_NAME, OUTPUT_DLL_NAME,
 493            OUTPUT_DLL_NAME, OUTPUT_DLL_NAME, OUTPUT_DLL_NAME, OUTPUT_DLL_NAME,
 494            OUTPUT_DLL_NAME, OUTPUT_DLL_NAME, OUTPUT_DLL_NAME, OUTPUT_DLL_NAME);
 495
 496   fchmod (fileno(install_file), 0755);
 497   fclose (install_file);
 498 }
 499
 500
 501 /*******************************************************************
 502  *         output_prototype
 503  *
 504  * Write a C prototype for a parsed symbol
 505  */
 506 void  output_prototype (FILE *file, const parsed_symbol *sym)
 507 {
 508   unsigned int i, start = sym->flags & SYM_THISCALL ? 1 : 0;
 509
 510   fprintf (file, "%s __%s %s_%s(", sym->return_text, symbol_get_call_convention(sym),
 511            OUTPUT_UC_DLL_NAME, sym->function_name);
 512
 513   if (!sym->argc || (sym->argc == 1 && sym->flags & SYM_THISCALL))
 514     fputs ("void", file);
 515   else
 516     for (i = start; i < sym->argc; i++)
 517       fprintf (file, "%s%s %s", i > start ? ", " : "", sym->arg_text [i],
 518                sym->arg_name [i]);
 519   if (sym->varargs)
 520     fputs (", ...", file);
 521   fputc (')', file);
 522 }
 523
 524
 525 /*******************************************************************
 526  *         output_c_banner
 527  *
 528  * Write a function banner to the .c file
 529  */
 530 void  output_c_banner (const parsed_symbol *sym)
 531 {
 532   char ord_spec[16];
 533   size_t i;
 534
 535   if (sym->ordinal >= 0)
 536     snprintf(ord_spec, sizeof (ord_spec), "%d", sym->ordinal);
 537   else
 538   {
 539     ord_spec[0] = '@';
 540     ord_spec[1] = '\0';
 541   }
 542
 543   fprintf (cfile, "/*********************************************************"
 544            "*********\n *\t\t%s (%s.%s)\n *\n", sym->symbol,
 545            OUTPUT_UC_DLL_NAME, ord_spec);
 546
 547   if (globals.do_documentation && sym->function_name)
 548   {
 549     fputs (" *\n * PARAMS\n *\n", cfile);
 550
 551     if (!sym->argc)
 552       fputs (" *  None.\n *\n", cfile);
 553     else
 554     {
 555       for (i = 0; i < sym->argc; i++)
 556         fprintf (cfile, " *  %s [%s]%s\n", sym->arg_name [i],
 557                  get_in_or_out(sym, i),
 558                  strcmp (sym->arg_name [i], "_this") ? "" :
 559                  "     Pointer to the class object (in ECX)");
 560
 561       if (sym->varargs)
 562         fputs (" *  ...[I]\n", cfile);
 563       fputs (" *\n", cfile);
 564     }
 565
 566     fputs (" * RETURNS\n *\n", cfile);
 567
 568     if (sym->return_text && !strcmp (sym->return_text, "void"))
 569       fputs (" *  Nothing.\n", cfile);
 570     else
 571       fprintf (cfile, " *  %s\n", sym->return_text);
 572   }
 573   fputs (" *\n */\n", cfile);
 574 }
 575
 576
 577 /*******************************************************************
 578  *         get_format_str
 579  *
 580  * Get a string containing the correct format string for a type
 581  */
 582 static const char *get_format_str (int type)
 583 {
 584   switch (type)
 585   {
 586   case ARG_VOID:        return "void";
 587   case ARG_FLOAT:       return "%f";
 588   case ARG_DOUBLE:      return "%g";
 589   case ARG_POINTER:     return "%p";
 590   case ARG_WIDE_STRING:
 591   case ARG_STRING:      return "%s";
 592   case ARG_LONG:        return "%ld";
 593   case ARG_STRUCT:      return "struct";
 594   }
 595   assert (0);
 596   return "";
 597 }
 598
 599
 600 /*******************************************************************
 601  *         get_in_or_out
 602  *
 603  * Determine if a parameter is In or In/Out
 604  */
 605 static const char *get_in_or_out (const parsed_symbol *sym, size_t arg)
 606 {
 607   assert (sym && arg < sym->argc);
 608   assert (globals.do_documentation);
 609
 610   if (sym->arg_flag [arg] & CT_CONST)
 611     return "In";
 612
 613   switch (sym->arg_type [arg])
 614   {
 615   case ARG_FLOAT:
 616   case ARG_DOUBLE:
 617   case ARG_LONG:
 618   case ARG_STRUCT:      return "In";
 619   case ARG_POINTER:
 620   case ARG_WIDE_STRING:
 621   case ARG_STRING:      return "In/Out";
 622   }
 623   assert (0);
 624   return "";
 625 }