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