Update tools and configurations after renaming Source/WebKit to Source/WebKitLegacy.
[WebKit-https.git] / Tools / Scripts / do-webcore-rename
1 #!/usr/bin/perl -w
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
33 use File::Find;
34 use FindBin;
35 use Getopt::Long qw(:config pass_through);
36
37 use lib $FindBin::Bin;
38 use webkitdirs;
39 use VCSUtils;
40
41 setConfiguration();
42 chdirWebKit();
43
44 my $showHelp;
45 my $verbose;
46
47 my $programName = basename($0);
48 my $usage = <<EOF;
49 Usage: $programName [options]
50   -h|--help                       Show this help message
51   -v|--verbose                    More verbose output
52 EOF
53
54 my $getOptionsResult = GetOptions(
55     'help|h' => \$showHelp,
56     'verbose|v' => \$verbose,
57 );
58
59 if (!$getOptionsResult || $showHelp) {
60     print STDERR $usage;
61     exit 1;
62 }
63
64 my @directoriesToIgnoreList = (
65     "expected",
66     "icu",
67 );
68 my %directoriesToIgnore = map { $_ => 1 } @directoriesToIgnoreList;
69
70 # find all files we want to process
71
72 my @paths;
73 find(\&wanted, "Source/JavaScriptCore");
74 find(\&wanted, "Source/WTF");
75 find(\&wanted, "Source/WebCore");
76 find(\&wanted, "Source/WebKitLegacy");
77 find(\&wanted, "Source/WebKit2");
78 find(\&wanted, "Tools/DumpRenderTree");
79 find(\&wanted, "Tools/TestWebKitAPI");
80
81 sub wanted
82 {
83     my $file = $_;
84
85     # Ignore excluded and hidden files/directories.
86     if ($directoriesToIgnore{$file} or $file =~ /^\../ or $file =~ /^ChangeLog/) {
87         print "Ignoring $File::Find::name\n" if $verbose;
88         $File::Find::prune = 1;
89         return;
90     }
91
92     return if -d $file;
93
94     push @paths, $File::Find::name;
95 }
96
97 # Setting isDOMTypeRename to 1 rather than 0 expands the regexps used
98 # below to handle custom JavaScript bindings.
99 my $isDOMTypeRename = 0;
100 my %renames = (
101     # Renames go here in the form of:
102     "ConstructorRaisesException" => "ConstructorMayThrowLegacyException",
103     "GetterRaisesException" => "GetterMayThrowLegacyException",
104     "GetterRaisesExceptionWithMessage" => "GetterMayThrowLegacyExceptionWithMessage",
105     "RaisesException" => "MayThrowLegacyException",
106     "RaisesExceptionWithMessage" => "MayThrowLegacyExceptionWithMessage",
107     "SetterRaisesException" => "SetterMayThrowLegacyException",
108     "SetterRaisesExceptionWithMessage" => "SetterMayThrowLegacyExceptionWithMessage",
109 );
110
111 my %renamesContemplatedForTheFuture = (
112     "setDOMException" => "propagateException",
113     "setDOMExceptionSlow" => "propagateExceptionSlowPath",
114
115     "PassRefPtr" => "DeprecatedPassRefPtr",
116
117     "HTMLPlugInImageElement" => "HTMLEmbeddedObjectElement",
118     "isPlugInImageElement" => "isEmbeddedObjectElement",
119     "isHTMLPlugInImageElement" => "isHTMLEmbeddedObjectElement",
120     "toHTMLPlugInImageElement" => "toHTMLEmbeddedObjectElement",
121
122     "DOMObject" => "JSDOMObject",
123
124     "DateInstance" => "JSDate",
125     "ErrorInstance" => "JSError",
126
127     "TreeShared" => "TreeRefCounted",
128
129     "StringImpl" => "SharedString",
130
131     "RenderView" => "RenderViewport",
132
133     "ObjcFallbackObjectImp" => "ObjCFallbackObject",
134     "RuntimeObjectImp" => "ForeignObject",
135
136     "runtime_array" => "BridgedArray",
137     "runtime_method" => "BridgedFunction",
138     "runtime_object" => "BridgedObject",
139     "objc_runtime" => "ObjCBridge",
140
141     "WTF_UNICODE_H" => "Unicode_h",
142     "WTF_UNICODE_ICU_H" => "UnicodeICU_h",
143     "UnicodeIcu" => "UnicodeICU",
144
145     "LegacyWebArchive" => "WebArchive",
146     "LegacyWebArchive_h" => "WebArchive_h",
147
148     "NativeFunctionWrapper_h" => "JSHostFunction_h",
149     "NativeFunctionWrapper" => "JSHostFunction",
150     "nativeFunctionThunk" => "hostFunctionThunk",
151     "nativeFunction" => "hostFunction",
152     "NativeFunction" => "HostFunction",
153 );
154
155 # Sort the keys of the renames hash in order of decreasing length. This
156 # handles the case where some of the renames are substrings of others;
157 # i.e., "Foo" => "Bar" and "FooBuffer" => "BarBuffer".
158 my @sortedRenameKeys = sort { length($b) - length($a) } keys %renames;
159
160 # rename files
161
162 sub renameFile
163 {
164     my $file = shift;
165
166     if ($isDOMTypeRename) {
167         # Find the longest key in %renames which matches this more permissive regexp.
168         # (The old regexp would match ".../Foo.cpp" but not ".../JSFooCustom.cpp".)
169         # This handles renaming of custom JavaScript bindings even when some of the
170         # renames are substrings of others. The only reason we don't do this all the
171         # time is to avoid accidental file renamings for short, non-DOM renames.
172         for my $key (@sortedRenameKeys) {
173             my $newFile = "";
174             $newFile = "$1$renames{$2}$3" if $file =~ /^(.*\/\w*)($key)(\w*\.\w+)$/;
175             if ($newFile ne "") {
176                 return $newFile;
177             }
178         }
179     } else {
180        $file = "$1$renames{$2}$3" if $file =~ /^(.*\/)(\w+)(\.\w+)$/ && $renames{$2};
181     }
182     return $file;
183 }
184
185 my %newFile;
186 for my $file (sort @paths) {
187     my $f = renameFile($file);
188     if ($f ne $file) {
189         $newFile{$file} = $f;
190     }
191 }
192
193 for my $file (sort @paths) {
194     if ($newFile{$file}) {
195         my $newFile = $newFile{$file};
196         print "Renaming $file to $newFile\n";
197         scmMoveOrRenameFile($file, $newFile);
198     }
199 }
200
201 # change all file contents
202
203 for my $file (sort @paths) {
204     $file = $newFile{$file} if $newFile{$file};
205     my $contents;
206     {
207         local $/;
208         open FILE, $file or die "Failed to open $file";
209         $contents = <FILE>;
210         close FILE;
211     }
212     my $newContents = $contents;
213
214     if ($isDOMTypeRename) {
215         for my $from (@sortedRenameKeys) {
216             # Handle JavaScript custom bindings.
217             $newContents =~ s/\b(JS|to|)$from/$1$renames{$from}/g;
218         }
219     } else {
220         for my $from (@sortedRenameKeys) {
221             $newContents =~ s/\b$from(?!["\w])/$renames{$from}/g; # this " unconfuses Xcode syntax highlighting
222         }
223     }
224
225     # Remove the "virtual" keyword from virtual/override lines.
226     # Should be a no-op but also OK to remove this any time, now that we have done it once.
227     $newContents =~ s/^(\s*(\w+EXPORT\w*\s+)?)virtual ([^{;]+ override\b)/$1$3/mg;
228     $newContents =~ s/^(\s*(\w+EXPORT\w*\s+)?)virtual ([^{;]+ final\b)/$1$3/mg;
229     $newContents =~ s/\boverride\s+final\b/final/g;
230     $newContents =~ s/\bfinal\s+override\b/final/g;
231
232     if ($newContents ne $contents) {
233         open FILE, ">", $file or die "Failed to open $file";
234         print FILE $newContents;
235         close FILE;
236     }
237 }