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