tools/make_specfiles

   1 #!/usr/bin/perl -w
   2 #
   3 # Update spec files across dlls that share an implementation
   4 #
   5 # Copyright 2011 Alexandre Julliard
   6 #
   7 # This library is free software; you can redistribute it and/or
   8 # modify it under the terms of the GNU Lesser General Public
   9 # License as published by the Free Software Foundation; either
  10 # version 2.1 of the License, or (at your option) any later version.
  11 #
  12 # This library is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 # Lesser General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU Lesser General Public
  18 # License along with this library; if not, write to the Free Software
  19 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  20 #
  21
  22 use strict;
  23
  24 my %funcs;
  25 my $group_head;
  26
  27 my @dll_groups =
  28 (
  29  [
  30   "msvcrt",
  31   "msvcirt",
  32   "msvcrt40",
  33   "msvcrt20",
  34   "msvcrtd",
  35   "crtdll",
  36  ],
  37  [
  38   "msvcrt",
  39   "msvcp90",
  40   "msvcp100",
  41   "msvcp110",
  42   "msvcp120",
  43   "msvcp71",
  44   "msvcp80",
  45   "msvcp70",
  46   "msvcp60",
  47  ],
  48  [
  49   "msvcr120",
  50   "msvcr120_app",
  51  ],
  52  [
  53   "msvcp120",
  54   "msvcp120_app",
  55  ],
  56  [
  57   "d3dx9_36",
  58   "d3dx9_43",
  59   "d3dx9_42",
  60   "d3dx9_41",
  61   "d3dx9_40",
  62   "d3dx9_39",
  63   "d3dx9_38",
  64   "d3dx9_37",
  65   "d3dx9_35",
  66   "d3dx9_34",
  67   "d3dx9_33",
  68   "d3dx9_32",
  69   "d3dx9_31",
  70   "d3dx9_30",
  71   "d3dx9_29",
  72   "d3dx9_28",
  73   "d3dx9_27",
  74   "d3dx9_26",
  75   "d3dx9_25",
  76   "d3dx9_24",
  77  ],
  78  [
  79   "d3dx10_43",
  80   "d3dx10_42",
  81   "d3dx10_41",
  82   "d3dx10_40",
  83   "d3dx10_39",
  84   "d3dx10_38",
  85   "d3dx10_37",
  86   "d3dx10_36",
  87   "d3dx10_35",
  88   "d3dx10_34",
  89   "d3dx10_33",
  90  ],
  91  [
  92   "d3dx11_43",
  93   "d3dx11_42",
  94  ],
  95  [
  96   "d3dcompiler_43",
  97   "d3dcompiler_42",
  98   "d3dcompiler_41",
  99   "d3dcompiler_40",
 100   "d3dcompiler_39",
 101   "d3dcompiler_38",
 102   "d3dcompiler_37",
 103   "d3dcompiler_36",
 104   "d3dcompiler_35",
 105   "d3dcompiler_34",
 106   "d3dcompiler_33",
 107  ],
 108  [
 109   "xinput1_3",
 110   "xinput1_4",
 111   "xinput1_2",
 112   "xinput1_1",
 113   "xinput9_1_0",
 114  ],
 115  [
 116   "setupapi",
 117   "cfgmgr32",
 118  ],
 119  [
 120   "vcomp",
 121   "vcomp100",
 122   "vcomp90",
 123  ],
 124  [
 125   "advapi32",
 126   "api-ms-win-core-localregistry-l1-1-0",
 127   "api-ms-win-downlevel-advapi32-l1-1-0",
 128   "api-ms-win-downlevel-advapi32-l2-1-0",
 129   "api-ms-win-security-base-l1-1-0",
 130   "api-ms-win-core-registry-l1-1-0",
 131   "api-ms-win-eventing-provider-l1-1-0",
 132   "api-ms-win-security-base-l1-2-0",
 133   "api-ms-win-security-sddl-l1-1-0",
 134   "api-ms-win-service-core-l1-1-1",
 135   "api-ms-win-service-management-l1-1-0",
 136   "api-ms-win-service-winsvc-l1-2-0",
 137  ],
 138  [
 139   "kernel32",
 140   "api-ms-win-downlevel-normaliz-l1-1-0",
 141   "api-ms-win-core-processthreads-l1-1-0",
 142   "api-ms-win-core-debug-l1-1-0",
 143   "api-ms-win-core-debug-l1-1-1",
 144   "api-ms-win-core-errorhandling-l1-1-0",
 145   "api-ms-win-core-errorhandling-l1-1-1",
 146   "api-ms-win-core-interlocked-l1-1-0",
 147   "api-ms-win-core-interlocked-l1-2-0",
 148   "api-ms-win-core-misc-l1-1-0",
 149   "api-ms-win-core-profile-l1-1-0",
 150   "api-ms-win-core-string-l1-1-0",
 151   "api-ms-win-core-sysinfo-l1-1-0",
 152   "api-ms-win-core-sysinfo-l1-2-0",
 153   "api-ms-win-core-util-l1-1-0",
 154   "api-ms-win-core-synch-l1-1-0",
 155   "api-ms-win-core-synch-l1-2-0",
 156   "api-ms-win-core-console-l1-1-0",
 157   "api-ms-win-core-file-l1-1-0",
 158   "api-ms-win-core-file-l1-2-0",
 159   "api-ms-win-core-handle-l1-1-0",
 160   "api-ms-win-core-heap-l1-1-0",
 161   "api-ms-win-core-heap-l1-2-0",
 162   "api-ms-win-core-heap-obsolete-l1-1-0",
 163   "api-ms-win-core-io-l1-1-1",
 164   "api-ms-win-core-kernel32-legacy-l1-1-0",
 165   "api-ms-win-core-localization-l1-2-0",
 166   "api-ms-win-core-localization-obsolete-l1-1-0",
 167   "api-ms-win-core-memory-l1-1-0",
 168   "api-ms-win-core-memory-l1-1-1",
 169   "api-ms-win-core-processenvironment-l1-1-0",
 170   "api-ms-win-core-processenvironment-l1-2-0",
 171   "api-ms-win-core-psapi-l1-1-0",
 172   "api-ms-win-core-threadpool-legacy-l1-1-0",
 173   "api-ms-win-core-timezone-l1-1-0",
 174   "api-ms-win-core-file-l2-1-1",
 175   "api-ms-win-core-sysinfo-l1-2-1",
 176   "api-ms-win-core-processthreads-l1-1-2",
 177   "api-ms-win-core-fibers-l1-1-0",
 178   "api-ms-win-core-fibers-l1-1-1",
 179   "api-ms-win-core-file-l2-1-0",
 180   "api-ms-win-core-localization-l1-2-1",
 181   "api-ms-win-core-datetime-l1-1-0",
 182   "api-ms-win-core-datetime-l1-1-1",
 183   "api-ms-win-core-xstate-l2-1-0",
 184   "api-ms-win-core-errorhandling-l1-1-2",
 185  ],
 186  [
 187   "kernel32",
 188   "user32",
 189   "api-ms-win-core-libraryloader-l1-1-0",
 190   "api-ms-win-core-libraryloader-l1-1-1",
 191  ],
 192  [
 193   "kernel32",
 194   "advapi32",
 195   "api-ms-win-core-namedpipe-l1-1-0",
 196   "api-ms-win-core-namedpipe-l1-2-0",
 197   "api-ms-win-core-processthreads-l1-1-1",
 198  ],
 199  [
 200   "ole32",
 201   "api-ms-win-downlevel-ole32-l1-1-0",
 202   "api-ms-win-core-com-l1-1-0",
 203   "combase",
 204  ],
 205  [
 206   "shell32",
 207   "api-ms-win-downlevel-shell32-l1-1-0",
 208  ],
 209  [
 210   "shlwapi",
 211   "api-ms-win-downlevel-shlwapi-l1-1-0",
 212   "api-ms-win-downlevel-shlwapi-l2-1-0",
 213   "api-ms-win-core-shlwapi-legacy-l1-1-0",
 214   "api-ms-win-core-url-l1-1-0",
 215  ],
 216  [
 217   "user32",
 218   "api-ms-win-downlevel-user32-l1-1-0",
 219   "api-ms-win-ntuser-dc-access-l1-1-0",
 220  ],
 221  [
 222   "version",
 223   "api-ms-win-downlevel-version-l1-1-0",
 224  ],
 225  [
 226   "msvcrt",
 227   "ntdll",
 228   "ntoskrnl.exe",
 229   "api-ms-win-core-rtlsupport-l1-1-0",
 230   "api-ms-win-core-rtlsupport-l1-2-0",
 231  ],
 232  [
 233   "gdi32",
 234   "ext-ms-win-gdi-devcaps-l1-1-0",
 235  ],
 236  [
 237   "combase",
 238   "api-ms-win-core-winrt-l1-1-0",
 239   "api-ms-win-core-winrt-string-l1-1-0",
 240  ],
 241 );
 242
 243 my $update_flags = 0;
 244 my $show_duplicates = 0;
 245
 246 foreach my $arg (@ARGV)
 247 {
 248     if ($arg eq "-f") { $update_flags = 1; }
 249     elsif ($arg eq "-d") { $show_duplicates = 1; }
 250 }
 251
 252 sub update_file($)
 253 {
 254     my $file = shift;
 255     my $ret = !(-f $file) || system "cmp $file $file.new >/dev/null";
 256     if (!$ret)
 257     {
 258         unlink "$file.new";
 259     }
 260     else
 261     {
 262         #system "diff -u $file $file.new";
 263         rename "$file.new", "$file";
 264         print "$file updated\n";
 265     }
 266     return $ret;
 267 }
 268
 269 # parse a spec file line
 270 sub parse_line($$$)
 271 {
 272     my ($name, $line, $str) = @_;
 273
 274     if ($str =~ /^\s*(\@|\d+)\s+(stdcall|cdecl|varargs|thiscall|stub|extern)\s+((?:-\S+\s+)*)([A-Za-z0-9_\@\$?]+)(?:\s*(\([^)]*\)))?(?:\s+([A-Za-z0-9_\@\$?.]+))?(\s*\#.*)?/)
 275     {
 276         return ( "ordinal" => $1, "callconv" => $2, "flags" => $3, "name" => $4, "args" => $5 || "",
 277                  "target" => $6 || $4, "comment" => $7, "spec" => $name );
 278     }
 279     return () if $str =~ /^\s*$/;
 280     return () if $str =~ /^\s*\#/;
 281     printf STDERR "$name.spec:$line: error: Unrecognized line $_\n";
 282 }
 283
 284 sub read_spec_file($)
 285 {
 286     my $name = shift;
 287     my $file = "dlls/$name/$name.spec";
 288     my %stubs;
 289     open SPEC, "<$file" or die "cannot open $file";
 290     while (<SPEC>)
 291     {
 292         chomp;
 293         my %descr = parse_line( $name, $., $_ );
 294         next unless %descr;
 295
 296         my $func = $descr{name};
 297         next if defined $funcs{$func};
 298         $funcs{$func} = \%descr;
 299     }
 300     close SPEC;
 301 }
 302
 303 sub update_spec_file($)
 304 {
 305     my $name = shift;
 306     my $file = "dlls/$name/$name.spec";
 307     my %stubs;
 308
 309     open SPEC, "<$file" or die "cannot open $file";
 310     open NEW, ">$file.new" or die "cannot create $file.new";
 311     while (<SPEC>)
 312     {
 313         chomp;
 314
 315         my $commented_out = 0;
 316         my %descr = parse_line( $name, $., $_ );
 317         if (!%descr)
 318         {
 319             # check for commented out exports
 320             if (/^\s*\#\s*((?:\@|\d+)\s+)?((?:extern|stub|stdcall|cdecl|varargs|thiscall)\s+.*)/)
 321             {
 322                 $commented_out = 1;
 323                 %descr = parse_line( $name, $., ($1 || "\@ ") . $2 );
 324             }
 325         }
 326         goto done unless %descr;
 327
 328         my $func = $descr{name};
 329         if (!defined $funcs{$func})
 330         {
 331             $funcs{$func} = \%descr unless $commented_out;
 332             goto done;
 333         }
 334
 335         my %parent = %{$funcs{$func}};
 336         goto done if $parent{spec} eq $descr{spec};  # the definition is in this spec file
 337         goto done if $descr{comment} && $descr{comment} =~ /don't forward/;
 338         if ($descr{callconv} ne "stub" && $descr{target} !~ /\./ && !$commented_out)
 339         {
 340             printf "%s:%u: note: %s already defined in %s\n", $file, $., $func, $parent{spec} if $show_duplicates;
 341             goto done;
 342         }
 343
 344         my $flags = $descr{flags};
 345         if ($parent{callconv} ne "stub" || $update_flags)
 346         {
 347             $flags = $parent{flags};
 348             $flags =~ s/-ordinal\s*// if $descr{ordinal} eq "@";
 349             $flags =~ s/-noname\s*// if $descr{ordinal} eq "@";
 350             if ($descr{flags} =~ /-private/)  # preserve -private flag
 351             {
 352                 $flags = "-private " . $flags unless $flags =~ /-private/;
 353             }
 354         }
 355
 356         if ($parent{callconv} ne "stub" || $parent{args})
 357         {
 358             my $callconv = $parent{callconv} ne "stub" ? $parent{callconv} :
 359                            $parent{spec} =~ /msvc/ ? "cdecl" : "stdcall";  # hack
 360             $_ = sprintf "$descr{ordinal} %s %s%s", $callconv, $flags, $func;
 361
 362             if ($parent{target} =~ /$group_head\./)  # use the same forward as parent if possible
 363             {
 364                 $_ .= sprintf "%s %s", $parent{args}, $parent{target};
 365             }
 366             else
 367             {
 368                 $_ .= sprintf "%s %s.%s", $parent{args}, $parent{spec}, $func;
 369             }
 370         }
 371         else
 372         {
 373             $_ = sprintf "$descr{ordinal} stub %s%s", $flags, $func;
 374         }
 375         $_ .= $descr{comment} || "";
 376
 377       done:
 378         print NEW "$_\n";
 379     }
 380     close SPEC;
 381     close NEW;
 382     update_file( $file );
 383 }
 384
 385 sub sync_spec_files(@)
 386 {
 387     %funcs = ();
 388     $group_head = shift;
 389     read_spec_file( $group_head );
 390     foreach my $spec (@_) { update_spec_file($spec); }
 391 }
 392
 393 foreach my $group (@dll_groups)
 394 {
 395     sync_spec_files( @{$group} );
 396 }