pytest is not correctly auto-installed
[WebKit-https.git] / Tools / Scripts / do-webcore-rename
1 #!/usr/bin/env perl
2
3 # Copyright (C) 2006, 2007, 2008 Apple Inc. All rights reserved.
4 #
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions
7 # are met:
8 #
9 # 1.  Redistributions of source code must retain the above copyright
10 #     notice, this list of conditions and the following disclaimer. 
11 # 2.  Redistributions in binary form must reproduce the above copyright
12 #     notice, this list of conditions and the following disclaimer in the
13 #     documentation and/or other materials provided with the distribution. 
14 # 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15 #     its contributors may be used to endorse or promote products derived
16 #     from this software without specific prior written permission. 
17 #
18 # THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19 # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 # DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22 # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29 # Script to do a rename in JavaScriptCore, WebCore, and WebKit.
30
31 use strict;
32 use warnings;
33
34 use File::Find;
35 use FindBin;
36 use Getopt::Long qw(:config pass_through);
37
38 use lib $FindBin::Bin;
39 use webkitdirs;
40 use VCSUtils;
41
42 setConfiguration();
43 chdirWebKit();
44
45 my $showHelp;
46 my $verbose;
47
48 my $programName = basename($0);
49 my $usage = <<EOF;
50 Usage: $programName [options]
51   -h|--help                       Show this help message
52   -v|--verbose                    More verbose output
53 EOF
54
55 my $getOptionsResult = GetOptions(
56     'help|h' => \$showHelp,
57     'verbose|v' => \$verbose,
58 );
59
60 if (!$getOptionsResult || $showHelp) {
61     print STDERR $usage;
62     exit 1;
63 }
64
65 my @directoriesToIgnoreList = (
66     "expected",
67     "icu",
68 );
69 my %directoriesToIgnore = map { $_ => 1 } @directoriesToIgnoreList;
70
71 # find all files we want to process
72
73 my @paths;
74 find(\&wanted, "Source/JavaScriptCore");
75 find(\&wanted, "Source/WTF");
76 find(\&wanted, "Source/WebCore");
77 find(\&wanted, "Source/WebKitLegacy");
78 find(\&wanted, "Source/WebKit");
79 find(\&wanted, "Tools/DumpRenderTree");
80 find(\&wanted, "Tools/TestWebKitAPI");
81
82 sub wanted
83 {
84     my $file = $_;
85
86     # Ignore excluded and hidden files/directories.
87     if ($directoriesToIgnore{$file} or $file =~ /^\../ or $file =~ /^ChangeLog/) {
88         print "Ignoring $File::Find::name\n" if $verbose;
89         $File::Find::prune = 1;
90         return;
91     }
92
93     return if -d $file;
94
95     push @paths, $File::Find::name;
96 }
97
98 # Setting isDOMTypeRename to 1 rather than 0 expands the regexps used
99 # below to handle custom JavaScript bindings.
100 my $isDOMTypeRename = 0;
101 my %renames = (
102     # Renames go here in the form of:
103     "ConstructorRaisesException" => "ConstructorMayThrowLegacyException",
104     "GetterRaisesException" => "GetterMayThrowLegacyException",
105     "GetterRaisesExceptionWithMessage" => "GetterMayThrowLegacyExceptionWithMessage",
106     "RaisesException" => "MayThrowLegacyException",
107     "RaisesExceptionWithMessage" => "MayThrowLegacyExceptionWithMessage",
108     "SetterRaisesException" => "SetterMayThrowLegacyException",
109     "SetterRaisesExceptionWithMessage" => "SetterMayThrowLegacyExceptionWithMessage",
110 );
111
112 my %renamesContemplatedForTheFuture = (
113     "setDOMException" => "propagateException",
114     "setDOMExceptionSlow" => "propagateExceptionSlowPath",
115
116     "PassRefPtr" => "DeprecatedPassRefPtr",
117
118     "HTMLPlugInImageElement" => "HTMLEmbeddedObjectElement",
119     "isPlugInImageElement" => "isEmbeddedObjectElement",
120     "isHTMLPlugInImageElement" => "isHTMLEmbeddedObjectElement",
121     "toHTMLPlugInImageElement" => "toHTMLEmbeddedObjectElement",
122
123     "DOMObject" => "JSDOMObject",
124
125     "DateInstance" => "JSDate",
126     "ErrorInstance" => "JSError",
127
128     "TreeShared" => "TreeRefCounted",
129
130     "StringImpl" => "SharedString",
131
132     "RenderView" => "RenderViewport",
133
134     "ObjcFallbackObjectImp" => "ObjCFallbackObject",
135     "RuntimeObjectImp" => "ForeignObject",
136
137     "runtime_array" => "BridgedArray",
138     "runtime_method" => "BridgedFunction",
139     "runtime_object" => "BridgedObject",
140     "objc_runtime" => "ObjCBridge",
141
142     "WTF_UNICODE_H" => "Unicode_h",
143     "WTF_UNICODE_ICU_H" => "UnicodeICU_h",
144     "UnicodeIcu" => "UnicodeICU",
145
146     "LegacyWebArchive" => "WebArchive",
147     "LegacyWebArchive_h" => "WebArchive_h",
148
149     "NativeFunctionWrapper_h" => "JSHostFunction_h",
150     "NativeFunctionWrapper" => "JSHostFunction",
151     "nativeFunctionThunk" => "hostFunctionThunk",
152     "nativeFunction" => "hostFunction",
153     "NativeFunction" => "HostFunction",
154 );
155
156 # Sort the keys of the renames hash in order of decreasing length. This
157 # handles the case where some of the renames are substrings of others;
158 # i.e., "Foo" => "Bar" and "FooBuffer" => "BarBuffer".
159 my @sortedRenameKeys = sort { length($b) - length($a) } keys %renames;
160
161 # rename files
162
163 sub renameFile
164 {
165     my $file = shift;
166
167     if ($isDOMTypeRename) {
168         # Find the longest key in %renames which matches this more permissive regexp.
169         # (The old regexp would match ".../Foo.cpp" but not ".../JSFooCustom.cpp".)
170         # This handles renaming of custom JavaScript bindings even when some of the
171         # renames are substrings of others. The only reason we don't do this all the
172         # time is to avoid accidental file renamings for short, non-DOM renames.
173         for my $key (@sortedRenameKeys) {
174             my $newFile = "";
175             $newFile = "$1$renames{$2}$3" if $file =~ /^(.*\/\w*)($key)(\w*\.\w+)$/;
176             if ($newFile ne "") {
177                 return $newFile;
178             }
179         }
180     } else {
181        $file = "$1$renames{$2}$3" if $file =~ /^(.*\/)(\w+)(\.\w+)$/ && $renames{$2};
182     }
183     return $file;
184 }
185
186 my %newFile;
187 for my $file (sort @paths) {
188     my $f = renameFile($file);
189     if ($f ne $file) {
190         $newFile{$file} = $f;
191     }
192 }
193
194 for my $file (sort @paths) {
195     if ($newFile{$file}) {
196         my $newFile = $newFile{$file};
197         print "Renaming $file to $newFile\n";
198         scmMoveOrRenameFile($file, $newFile);
199     }
200 }
201
202 # change all file contents
203
204 for my $file (sort @paths) {
205     $file = $newFile{$file} if $newFile{$file};
206     my $contents;
207     {
208         local $/;
209         open FILE, $file or die "Failed to open $file";
210         $contents = <FILE>;
211         close FILE;
212     }
213     my $newContents = $contents;
214
215     if ($isDOMTypeRename) {
216         for my $from (@sortedRenameKeys) {
217             # Handle JavaScript custom bindings.
218             $newContents =~ s/\b(JS|to|)$from/$1$renames{$from}/g;
219         }
220     } else {
221         for my $from (@sortedRenameKeys) {
222             $newContents =~ s/\b$from(?!["\w])/$renames{$from}/g; # this " unconfuses Xcode syntax highlighting
223         }
224     }
225
226     # Remove the "virtual" keyword from virtual/override lines.
227     # Should be a no-op but also OK to remove this any time, now that we have done it once.
228     $newContents =~ s/^(\s*(\w+EXPORT\w*\s+)?)virtual ([^{;]+ override\b)/$1$3/mg;
229     $newContents =~ s/^(\s*(\w+EXPORT\w*\s+)?)virtual ([^{;]+ final\b)/$1$3/mg;
230     $newContents =~ s/\boverride\s+final\b/final/g;
231     $newContents =~ s/\bfinal\s+override\b/final/g;
232
233     if ($newContents ne $contents) {
234         open FILE, ">", $file or die "Failed to open $file";
235         print FILE $newContents;
236         close FILE;
237     }
238 }