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   "d3dx9_36",
  50   "d3dx9_43",
  51   "d3dx9_42",
  52   "d3dx9_41",
  53   "d3dx9_40",
  54   "d3dx9_39",
  55   "d3dx9_38",
  56   "d3dx9_37",
  57   "d3dx9_35",
  58   "d3dx9_34",
  59   "d3dx9_33",
  60   "d3dx9_32",
  61   "d3dx9_31",
  62   "d3dx9_30",
  63   "d3dx9_29",
  64   "d3dx9_28",
  65   "d3dx9_27",
  66   "d3dx9_26",
  67   "d3dx9_25",
  68   "d3dx9_24",
  69  ],
  70  [
  71   "d3dx10_43",
  72   "d3dx10_42",
  73   "d3dx10_41",
  74   "d3dx10_40",
  75   "d3dx10_39",
  76   "d3dx10_38",
  77   "d3dx10_37",
  78   "d3dx10_36",
  79   "d3dx10_35",
  80   "d3dx10_34",
  81   "d3dx10_33",
  82  ],
  83  [
  84   "d3dx11_43",
  85   "d3dx11_42",
  86  ],
  87  [
  88   "d3dcompiler_43",
  89   "d3dcompiler_42",
  90   "d3dcompiler_41",
  91   "d3dcompiler_40",
  92   "d3dcompiler_39",
  93   "d3dcompiler_38",
  94   "d3dcompiler_37",
  95   "d3dcompiler_36",
  96   "d3dcompiler_35",
  97   "d3dcompiler_34",
  98   "d3dcompiler_33",
  99  ],
 100  [
 101   "xinput1_3",
 102   "xinput1_4",
 103   "xinput1_2",
 104   "xinput1_1",
 105   "xinput9_1_0",
 106  ],
 107  [
 108   "setupapi",
 109   "cfgmgr32",
 110  ],
 111  [
 112   "vcomp",
 113   "vcomp100",
 114   "vcomp90",
 115  ],
 116  [
 117   "advapi32",
 118   "api-ms-win-core-localregistry-l1-1-0",
 119   "api-ms-win-downlevel-advapi32-l1-1-0",
 120   "api-ms-win-downlevel-advapi32-l2-1-0",
 121   "api-ms-win-security-base-l1-1-0",
 122   "api-ms-win-core-registry-l1-1-0",
 123   "api-ms-win-eventing-provider-l1-1-0",
 124   "api-ms-win-security-base-l1-2-0",
 125   "api-ms-win-security-sddl-l1-1-0",
 126   "api-ms-win-service-core-l1-1-1",
 127   "api-ms-win-service-management-l1-1-0",
 128   "api-ms-win-service-winsvc-l1-2-0",
 129  ],
 130  [
 131   "kernel32",
 132   "api-ms-win-downlevel-normaliz-l1-1-0",
 133   "api-ms-win-core-processthreads-l1-1-0",
 134   "api-ms-win-core-processthreads-l1-1-1",
 135   "api-ms-win-core-debug-l1-1-1",
 136   "api-ms-win-core-errorhandling-l1-1-1",
 137   "api-ms-win-core-interlocked-l1-2-0",
 138   "api-ms-win-core-profile-l1-1-0",
 139   "api-ms-win-core-string-l1-1-0",
 140   "api-ms-win-core-sysinfo-l1-2-0",
 141   "api-ms-win-core-util-l1-1-0",
 142   "api-ms-win-core-synch-l1-2-0",
 143   "api-ms-win-core-console-l1-1-0",
 144   "api-ms-win-core-file-l1-2-0",
 145   "api-ms-win-core-handle-l1-1-0",
 146   "api-ms-win-core-heap-l1-2-0",
 147   "api-ms-win-core-heap-obsolete-l1-1-0",
 148   "api-ms-win-core-io-l1-1-1",
 149   "api-ms-win-core-kernel32-legacy-l1-1-0",
 150   "api-ms-win-core-libraryloader-l1-1-1",
 151   "api-ms-win-core-localization-l1-2-0",
 152   "api-ms-win-core-localization-obsolete-l1-1-0",
 153   "api-ms-win-core-memory-l1-1-1",
 154   "api-ms-win-core-namedpipe-l1-2-0",
 155   "api-ms-win-core-processenvironment-l1-2-0",
 156   "api-ms-win-core-psapi-l1-1-0",
 157   "api-ms-win-core-threadpool-legacy-l1-1-0",
 158   "api-ms-win-core-timezone-l1-1-0",
 159   "api-ms-win-core-file-l2-1-1",
 160   "api-ms-win-core-sysinfo-l1-2-1",
 161   "api-ms-win-core-processthreads-l1-1-2",
 162   "api-ms-win-core-fibers-l1-1-0",
 163   "api-ms-win-core-fibers-l1-1-1",
 164   "api-ms-win-core-file-l2-1-0",
 165   "api-ms-win-core-localization-l1-2-1",
 166   "api-ms-win-core-datetime-l1-1-0",
 167   "api-ms-win-core-datetime-l1-1-1",
 168   "api-ms-win-core-xstate-l2-1-0",
 169   "api-ms-win-core-errorhandling-l1-1-2",
 170  ],
 171  [
 172   "ole32",
 173   "api-ms-win-downlevel-ole32-l1-1-0",
 174   "api-ms-win-core-com-l1-1-0",
 175   "combase",
 176  ],
 177  [
 178   "shell32",
 179   "api-ms-win-downlevel-shell32-l1-1-0",
 180  ],
 181  [
 182   "shlwapi",
 183   "api-ms-win-downlevel-shlwapi-l1-1-0",
 184   "api-ms-win-downlevel-shlwapi-l2-1-0",
 185   "api-ms-win-core-shlwapi-legacy-l1-1-0",
 186   "api-ms-win-core-url-l1-1-0",
 187  ],
 188  [
 189   "user32",
 190   "api-ms-win-downlevel-user32-l1-1-0",
 191   "api-ms-win-ntuser-dc-access-l1-1-0",
 192  ],
 193  [
 194   "version",
 195   "api-ms-win-downlevel-version-l1-1-0",
 196  ],
 197  [
 198   "msvcrt",
 199   "ntdll",
 200   "ntoskrnl.exe",
 201   "api-ms-win-core-rtlsupport-l1-2-0",
 202  ],
 203  [
 204   "gdi32",
 205   "ext-ms-win-gdi-devcaps-l1-1-0",
 206  ],
 207 );
 208
 209 my $update_flags = 0;
 210 my $show_duplicates = 0;
 211
 212 foreach my $arg (@ARGV)
 213 {
 214     if ($arg eq "-f") { $update_flags = 1; }
 215     elsif ($arg eq "-d") { $show_duplicates = 1; }
 216 }
 217
 218 sub update_file($)
 219 {
 220     my $file = shift;
 221     my $ret = !(-f $file) || system "cmp $file $file.new >/dev/null";
 222     if (!$ret)
 223     {
 224         unlink "$file.new";
 225     }
 226     else
 227     {
 228         #system "diff -u $file $file.new";
 229         rename "$file.new", "$file";
 230         print "$file updated\n";
 231     }
 232     return $ret;
 233 }
 234
 235 # parse a spec file line
 236 sub parse_line($$$)
 237 {
 238     my ($name, $line, $str) = @_;
 239
 240     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*\#.*)?/)
 241     {
 242         return ( "ordinal" => $1, "callconv" => $2, "flags" => $3, "name" => $4, "args" => $5 || "",
 243                  "target" => $6 || $4, "comment" => $7, "spec" => $name );
 244     }
 245     return () if $str =~ /^\s*$/;
 246     return () if $str =~ /^\s*\#/;
 247     printf STDERR "$name.spec:$line: error: Unrecognized line $_\n";
 248 }
 249
 250 sub read_spec_file($)
 251 {
 252     my $name = shift;
 253     my $file = "dlls/$name/$name.spec";
 254     my %stubs;
 255     open SPEC, "<$file" or die "cannot open $file";
 256     while (<SPEC>)
 257     {
 258         chomp;
 259         my %descr = parse_line( $name, $., $_ );
 260         next unless %descr;
 261
 262         my $func = $descr{name};
 263         next if defined $funcs{$func};
 264         $funcs{$func} = \%descr;
 265     }
 266     close SPEC;
 267 }
 268
 269 sub update_spec_file($)
 270 {
 271     my $name = shift;
 272     my $file = "dlls/$name/$name.spec";
 273     my %stubs;
 274
 275     open SPEC, "<$file" or die "cannot open $file";
 276     open NEW, ">$file.new" or die "cannot create $file.new";
 277     while (<SPEC>)
 278     {
 279         chomp;
 280
 281         my $commented_out = 0;
 282         my %descr = parse_line( $name, $., $_ );
 283         if (!%descr)
 284         {
 285             # check for commented out exports
 286             if (/^\s*\#\s*((?:\@|\d+)\s+)?((?:extern|stub|stdcall|cdecl|varargs|thiscall)\s+.*)/)
 287             {
 288                 $commented_out = 1;
 289                 %descr = parse_line( $name, $., ($1 || "\@ ") . $2 );
 290             }
 291         }
 292         goto done unless %descr;
 293
 294         my $func = $descr{name};
 295         if (!defined $funcs{$func})
 296         {
 297             $funcs{$func} = \%descr unless $commented_out;
 298             goto done;
 299         }
 300
 301         my %parent = %{$funcs{$func}};
 302         goto done if $parent{spec} eq $descr{spec};  # the definition is in this spec file
 303         goto done if $descr{comment} && $descr{comment} =~ /don't forward/;
 304         if ($descr{callconv} ne "stub" && $descr{target} !~ /\./ && !$commented_out)
 305         {
 306             printf "%s:%u: note: %s already defined in %s\n", $file, $., $func, $parent{spec} if $show_duplicates;
 307             goto done;
 308         }
 309
 310         my $flags = $descr{flags};
 311         if ($parent{callconv} ne "stub" || $update_flags)
 312         {
 313             $flags = $parent{flags};
 314             $flags =~ s/-ordinal\s*// if $descr{ordinal} eq "@";
 315             $flags =~ s/-noname\s*// if $descr{ordinal} eq "@";
 316             if ($descr{flags} =~ /-private/)  # preserve -private flag
 317             {
 318                 $flags = "-private " . $flags unless $flags =~ /-private/;
 319             }
 320         }
 321
 322         if ($parent{callconv} ne "stub" || $parent{args})
 323         {
 324             my $callconv = $parent{callconv} ne "stub" ? $parent{callconv} :
 325                            $parent{spec} =~ /msvc/ ? "cdecl" : "stdcall";  # hack
 326             $_ = sprintf "$descr{ordinal} %s %s%s", $callconv, $flags, $func;
 327
 328             if ($parent{target} =~ /$group_head\./)  # use the same forward as parent if possible
 329             {
 330                 $_ .= sprintf "%s %s", $parent{args}, $parent{target};
 331             }
 332             else
 333             {
 334                 $_ .= sprintf "%s %s.%s", $parent{args}, $parent{spec}, $func;
 335             }
 336         }
 337         else
 338         {
 339             $_ = sprintf "$descr{ordinal} stub %s%s", $flags, $func;
 340         }
 341         $_ .= $descr{comment} || "";
 342
 343       done:
 344         print NEW "$_\n";
 345     }
 346     close SPEC;
 347     close NEW;
 348     update_file( $file );
 349 }
 350
 351 sub sync_spec_files(@)
 352 {
 353     %funcs = ();
 354     $group_head = shift;
 355     read_spec_file( $group_head );
 356     foreach my $spec (@_) { update_spec_file($spec); }
 357 }
 358
 359 foreach my $group (@dll_groups)
 360 {
 361     sync_spec_files( @{$group} );
 362 }