tools: Add a script to help synchronize spec files that share an implementation.
[wine] / 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   "msvcr90",
32   "msvcirt",
33   "msvcr100",
34   "msvcr80",
35   "msvcr71",
36   "msvcr70",
37   "msvcrt40",
38   "msvcrt20",
39   "msvcrtd",
40   "crtdll",
41  ],
42  [
43   "msvcrt",
44   "msvcp90",
45   "msvcp100",
46   "msvcp80",
47   "msvcp71",
48   "msvcp70",
49   "msvcp60",
50  ],
51 );
52
53 my $update_flags = 0;
54 my $show_duplicates = 0;
55
56 foreach my $arg (@ARGV)
57 {
58     if ($arg eq "-f") { $update_flags = 1; }
59     elsif ($arg eq "-d") { $show_duplicates = 1; }
60 }
61
62 sub update_file($)
63 {
64     my $file = shift;
65     my $ret = !(-f $file) || system "cmp $file $file.new >/dev/null";
66     if (!$ret)
67     {
68         unlink "$file.new";
69     }
70     else
71     {
72         #system "diff -u $file $file.new";
73         rename "$file.new", "$file";
74         print "$file updated\n";
75     }
76     return $ret;
77 }
78
79 # parse a spec file line
80 sub parse_line($$$)
81 {
82     my ($name, $line, $_) = @_;
83
84     if (/^\s*(\@|\d+)\s+(stdcall|cdecl|varargs|thiscall|stub|extern)\s+((?:-\S+\s+)*)([A-Za-z0-9_\@\$?]+)(?:\s*(\([^)]*\)))?(?:\s+([A-Za-z0-9_\@\$?.]+))?(\s*\#.*)?/)
85     {
86         return ( "ordinal" => $1, "callconv" => $2, "flags" => $3, "name" => $4, "args" => $5 || "",
87                  "target" => $6 || $4, "comment" => $7, "spec" => $name );
88     }
89     return () if /^\s*$/;
90     return () if /^\s*\#/;
91     printf STDERR "$name.spec:$line: error: Unrecognized line $_\n";
92 }
93
94 sub read_spec_file($)
95 {
96     my $name = shift;
97     my $file = "dlls/$name/$name.spec";
98     my %stubs;
99     open SPEC, "<$file" or die "cannot open $file";
100     while (<SPEC>)
101     {
102         chomp;
103         my %descr = parse_line( $name, $., $_ );
104         next unless %descr;
105
106         my $func = $descr{name};
107         next if defined $funcs{$func};
108         $funcs{$func} = \%descr;
109     }
110     close SPEC;
111 }
112
113 sub update_spec_file($)
114 {
115     my $name = shift;
116     my $file = "dlls/$name/$name.spec";
117     my %stubs;
118
119     open SPEC, "<$file" or die "cannot open $file";
120     open NEW, ">$file.new" or die "cannot create $file.new";
121     while (<SPEC>)
122     {
123         chomp;
124
125         my $commented_out = 0;
126         my %descr = parse_line( $name, $., $_ );
127         if (!%descr)
128         {
129             # check for commented out exports
130             if (/^\s*\#\s*((?:\@|\d+)\s+)?((?:extern|stub|stdcall|cdecl|varargs|thiscall)\s+.*)/)
131             {
132                 $commented_out = 1;
133                 %descr = parse_line( $name, $., ($1 || "\@ ") . $2 );
134             }
135         }
136         goto done unless %descr;
137
138         my $func = $descr{name};
139         if (!defined $funcs{$func})
140         {
141             $funcs{$func} = \%descr unless $commented_out;
142             goto done;
143         }
144
145         my %parent = %{$funcs{$func}};
146         goto done if $parent{spec} eq $descr{spec};  # the definition is in this spec file
147         if ($descr{callconv} ne "stub" && $descr{target} !~ /\./)
148         {
149             printf "%s:%u: note: %s already defined in %s\n", $file, $., $func, $parent{spec} if $show_duplicates;
150             goto done;
151         }
152
153         my $flags = ($parent{callconv} ne "stub" || $update_flags) ? $parent{flags} : $descr{flags};
154
155         if ($parent{callconv} ne "stub")
156         {
157             my $callconv = $parent{callconv} ne "stub" ? $parent{callconv} :
158                            $parent{spec} =~ /msvc/ ? "cdecl" : "stdcall";  # hack
159             $_ = sprintf "@ %s %s%s", $callconv, $flags, $func;
160
161             if ($parent{target} =~ /$group_head\./)  # use the same forward as parent if possible
162             {
163                 $_ .= sprintf "%s %s", $parent{args}, $parent{target};
164             }
165             else
166             {
167                 $_ .= sprintf "%s %s.%s", $parent{args}, $parent{spec}, $func;
168             }
169         }
170         else
171         {
172             $_ = sprintf "@ stub %s%s", $flags, $func;
173         }
174         $_ .= $descr{comment} || "";
175
176       done:
177         print NEW "$_\n";
178     }
179     close SPEC;
180     close NEW;
181     update_file( $file );
182 }
183
184 sub sync_spec_files(@)
185 {
186     %funcs = ();
187     $group_head = shift;
188     read_spec_file( $group_head );
189     foreach my $spec (@_) { update_spec_file($spec); }
190 }
191
192 foreach my $group (@dll_groups)
193 {
194     sync_spec_files( @{$group} );
195 }