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