e70117fe3b69495457818a2cffe6c8d3c5b8b85f
[WebKit.git] / WebKitTools / Scripts / build-webkit
1 #!/usr/bin/perl -w
2
3 # Copyright (C) 2005, 2006 Apple Inc. All rights reserved.
4 # Copyright (C) 2009 Google Inc. All rights reserved.
5 #
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions
8 # are met:
9 #
10 # 1.  Redistributions of source code must retain the above copyright
11 #     notice, this list of conditions and the following disclaimer. 
12 # 2.  Redistributions in binary form must reproduce the above copyright
13 #     notice, this list of conditions and the following disclaimer in the
14 #     documentation and/or other materials provided with the distribution. 
15 # 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
16 #     its contributors may be used to endorse or promote products derived
17 #     from this software without specific prior written permission. 
18 #
19 # THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
20 # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 # DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
23 # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30 # Build script wrapper for the WebKit Open Source Project.
31
32 use strict;
33 use File::Basename;
34 use File::Find;
35 use File::Spec;
36 use FindBin;
37 use Getopt::Long qw(:config pass_through);
38 use lib $FindBin::Bin;
39 use webkitdirs;
40 use webkitperl::features;
41 use POSIX;
42
43 sub formatBuildTime($);
44 sub writeCongrats();
45
46 my $originalWorkingDirectory = getcwd();
47 chdirWebKit();
48
49 my $showHelp = 0;
50 my $clean = 0;
51 my $minimal = 0;
52 my $installHeaders;
53 my $installLibs;
54 my $prefixPath;
55 my $makeArgs;
56 my $startTime = time();
57
58 my ($threeDCanvasSupport, $threeDRenderingSupport, $channelMessagingSupport, $clientBasedGeolocationSupport, $databaseSupport, $datagridSupport, $datalistSupport,
59     $domStorageSupport, $eventsourceSupport, $filtersSupport, $geolocationSupport, $iconDatabaseSupport, $indexedDatabaseSupport,
60     $javaScriptDebuggerSupport, $mathmlSupport, $offlineWebApplicationSupport, $rubySupport, $systemMallocSupport, $sandboxSupport, $sharedWorkersSupport,
61     $svgSupport, $svgAnimationSupport, $svgAsImageSupport, $svgDOMObjCBindingsSupport, $svgFontsSupport,
62     $svgForeignObjectSupport, $svgUseSupport, $videoSupport, $webSocketsSupport, $wmlSupport, $wcssSupport, $xhtmlmpSupport, $workersSupport,
63     $xpathSupport, $xsltSupport, $coverageSupport, $notificationsSupport, $blobSliceSupport, $tiledBackingStoreSupport,
64     $fileReaderSupport, $fileWriterSupport);
65
66 my @features = (
67     { option => "3d-canvas", desc => "Toggle 3D canvas support",
68       define => "ENABLE_3D_CANVAS", default => (isAppleMacWebKit() && !isTiger()), value => \$threeDCanvasSupport },
69
70     { option => "3d-rendering", desc => "Toggle 3D rendering support",
71       define => "ENABLE_3D_RENDERING", default => (isAppleMacWebKit() && !isTiger()), value => \$threeDRenderingSupport },
72
73     { option => "blob-slice", desc => "Toggle Blob.slice support",
74       define => "ENABLE_BLOB_SLICE", default => (isAppleMacWebKit()), value => \$blobSliceSupport },
75
76     { option => "channel-messaging", desc => "Toggle MessageChannel and MessagePort support",
77       define => "ENABLE_CHANNEL_MESSAGING", default => 1, value => \$channelMessagingSupport },
78
79     { option => "client-based-geolocation", desc => "Toggle client-based Geolocation support",
80       define => "ENABLE_CLIENT_BASED_GEOLOCATION", default => isAppleWebKit(), value => \$clientBasedGeolocationSupport },
81
82     { option => "coverage", desc => "Toggle code coverage support",
83       define => "", default => 0, value => \$coverageSupport },
84
85     { option => "database", desc => "Toggle Database Support",
86       define => "ENABLE_DATABASE", default => 1, value => \$databaseSupport },
87
88     { option => "datagrid", desc => "Toggle Datagrid Support",
89       define => "ENABLE_DATAGRID", default => 0, value => \$datagridSupport },
90       
91     { option => "datalist", desc => "Toggle HTML5 datalist support",
92       define => "ENABLE_DATALIST", default => 1, value => \$datalistSupport },
93           
94     { option => "dom-storage", desc => "Toggle DOM Storage Support",
95       define => "ENABLE_DOM_STORAGE", default => 1, value => \$domStorageSupport },
96
97     { option => "eventsource", desc => "Toggle server-sent events support",
98       define => "ENABLE_EVENTSOURCE", default => 1, value => \$eventsourceSupport },
99
100     { option => "filters", desc => "Toggle Filters support",
101       define => "ENABLE_FILTERS", default => (isAppleWebKit() || isGtk() || isQt()), value => \$filtersSupport },
102
103     { option => "geolocation", desc => "Toggle Geolocation support",
104       define => "ENABLE_GEOLOCATION", default => (isAppleWebKit() || isGtk()), value => \$geolocationSupport },
105
106     { option => "icon-database", desc => "Toggle Icon database support",
107       define => "ENABLE_ICONDATABASE", default => 1, value => \$iconDatabaseSupport },
108
109     { option => "indexed-database", desc => "Toggle Indexed Database API support",
110       define => "ENABLE_INDEXED_DATABASE", default => 0, value => \$indexedDatabaseSupport },
111
112     { option => "javascript-debugger", desc => "Toggle JavaScript Debugger/Profiler support",
113       define => "ENABLE_JAVASCRIPT_DEBUGGER", default => 1, value => \$javaScriptDebuggerSupport },
114
115     { option => "mathml", desc => "Toggle MathML support",
116       define => "ENABLE_MATHML", default => 0, value => \$mathmlSupport },
117
118     { option => "notifications", desc => "Toggle Desktop Notifications Support",
119       define => "ENABLE_NOTIFICATIONS", default => 0, value => \$notificationsSupport },
120
121     { option => "offline-web-applications", desc => "Toggle Offline Web Application Support",
122       define => "ENABLE_OFFLINE_WEB_APPLICATIONS", default => 1, value => \$offlineWebApplicationSupport },
123
124     { option => "ruby", desc => "Toggle HTML5 Ruby support",
125       define => "ENABLE_RUBY", default => 1, value => \$rubySupport },
126
127     { option => "system-malloc", desc => "Toggle system allocator instead of TCmalloc",
128       define => "USE_SYSTEM_MALLOC", default => 0, value => \$systemMallocSupport },
129
130     { option => "sandbox", desc => "Toggle HTML5 Sandboxed iframe support",
131       define => "ENABLE_SANDBOX", default => 1, value => \$sandboxSupport },
132
133     { option => "shared-workers", desc => "Toggle SharedWorkers support",
134       define => "ENABLE_SHARED_WORKERS", default => (isAppleWebKit() || isGtk()), value => \$sharedWorkersSupport },
135
136     { option => "svg", desc => "Toggle SVG support",
137       define => "ENABLE_SVG", default => 1, value => \$svgSupport },
138
139     { option => "svg-animation", desc => "Toggle SVG animation support (implies SVG support)",
140       define => "ENABLE_SVG_ANIMATION", default => 1, value => \$svgAnimationSupport },
141
142     { option => "svg-as-image", desc => "Toggle SVG as Image support (implies SVG support)",
143       define => "ENABLE_SVG_AS_IMAGE", default => 1, value => \$svgAsImageSupport },
144
145     { option => "svg-dom-objc-bindings", desc => "Toggle SVG DOM Objective-C bindings support (implies SVG support)",
146       define => "ENABLE_SVG_DOM_OBJC_BINDINGS", default => isAppleMacWebKit(), value => \$svgDOMObjCBindingsSupport },
147
148     { option => "svg-fonts", desc => "Toggle SVG fonts support (imples SVG support)",
149       define => "ENABLE_SVG_FONTS", default => 1, value => \$svgFontsSupport },
150
151     { option => "svg-foreign-object", desc => "Toggle SVG foreign object support (implies SVG support)",
152       define => "ENABLE_SVG_FOREIGN_OBJECT", default => 1, value => \$svgForeignObjectSupport },
153
154     { option => "svg-use", desc => "Toggle SVG use element support (implies SVG support)",
155       define => "ENABLE_SVG_USE", default => 1, value => \$svgUseSupport },
156
157     { option => "tiled-backing-store", desc => "Toggle Tiled Backing Store support",
158       define => "ENABLE_TILED_BACKING_STORE", default => isQt(), value => \$tiledBackingStoreSupport },
159
160     { option => "video", desc => "Toggle Video support",
161       define => "ENABLE_VIDEO", default => (isAppleWebKit() || isGtk()), value => \$videoSupport },
162
163     { option => "web-sockets", desc => "Toggle Web Sockets support",
164       define => "ENABLE_WEB_SOCKETS", default => 1, value=> \$webSocketsSupport },
165
166     { option => "wml", desc => "Toggle WML support",
167       define => "ENABLE_WML", default => 0, value => \$wmlSupport },
168
169     { option => "xhtmlmp", desc => "Toggle XHTML-MP support",
170       define => "ENABLE_XHTMLMP", default => 0, value => \$xhtmlmpSupport },
171
172     { option => "wcss", desc => "Toggle WCSS support",
173       define => "ENABLE_WCSS", default => 0, value => \$wcssSupport },
174
175     { option => "workers", desc => "Toggle Web Workers support",
176       define => "ENABLE_WORKERS", default => (isAppleWebKit() || isGtk()), value => \$workersSupport },
177
178     { option => "xpath", desc => "Toggle XPath support",
179       define => "ENABLE_XPATH", default => 1, value => \$xpathSupport },
180
181     { option => "xslt", desc => "Toggle XSLT support",
182       define => "ENABLE_XSLT", default => 1, value => \$xsltSupport },
183
184     { option => "file-reader", desc => "Toggle FileReader support",
185       define => "ENABLE_FILE_READER", default => isAppleWebKit(), value => \$fileReaderSupport },
186
187     { option => "file-writer", desc => "Toggle FileWriter support",
188       define => "ENABLE_FILE_WRITER", default => 0, value => \$fileWriterSupport },
189 );
190
191 # Update defaults from Qt's project file
192 if (isQt()) {
193     my %qtDefaults = qtFeatureDefaults();
194     foreach (@features) {
195         $_->{default} = $qtDefaults{$_->{define}} || 0;
196     }
197 }
198
199 # Additional environment parameters
200 push @ARGV, split(/ /, $ENV{'BUILD_WEBKIT_ARGS'}) if ($ENV{'BUILD_WEBKIT_ARGS'});
201
202 # Initialize values from defaults
203 foreach (@ARGV) {
204     if ($_ eq '--minimal') {
205         $minimal = 1;
206         last;
207     }
208 }
209
210 # Initialize values from defaults
211 foreach (@features) {
212     ${$_->{value}} = ($_->{default} && !$minimal) || 0;
213 }
214
215 $svgSupport = $svgSupport || $svgAnimationSupport || $svgAsImageSupport
216     || $svgDOMObjCBindingsSupport || $svgFontsSupport
217     || $svgForeignObjectSupport || $svgUseSupport;
218
219
220 my $programName = basename($0);
221 my $usage = <<EOF;
222 Usage: $programName [options] [options to pass to build system]
223   --help                            Show this help message
224   --clean                           Cleanup the build directory
225   --debug                           Compile in debug mode
226   --cairo-win32                     Build using Cairo (rather than CoreGraphics) on Windows
227   --chromium                        Build the Chromium port on Mac/Win/Linux
228   --gtk                             Build the GTK+ port
229   --qt                              Build the Qt port
230   --inspector-frontend              Copy changes to the inspector front-end files to the build directory
231
232   --install-headers=<path>          Set installation path for the headers (Qt only)
233   --install-libs=<path>             Set installation path for the libraries (Qt only)
234
235   --prefix=<path>                   Set installation prefix to the given path (Gtk only)
236   --makeargs=<arguments>            Optional Makefile flags
237
238   --minimal                         No optional features, unless explicitly enabled.
239
240 EOF
241
242 my %options = (
243     'help' => \$showHelp,
244     'clean' => \$clean,
245     'install-headers=s' => \$installHeaders,
246     'install-libs=s' => \$installLibs,
247     'prefix=s' => \$prefixPath,
248     'makeargs=s' => \$makeArgs,
249     'minimal' => \$minimal,
250 );
251
252 # Build usage text and options list from features
253 foreach (@features) {
254     my $opt = sprintf("%-35s", "  --[no-]$_->{option}");
255     $usage .= "$opt $_->{desc} (default: $_->{default})\n";
256     $options{"$_->{option}!"} = $_->{value};
257 }
258
259 GetOptions(%options);
260
261 if ($showHelp) {
262    print STDERR $usage;
263    exit 1;
264 }
265
266 checkRequiredSystemConfig();
267 setConfiguration();
268
269 my $productDir = productDir();
270
271 # Remove 0 byte sized files from productDir after slave lost for Qt buildbots.
272 File::Find::find(\&unlinkZeroFiles, $productDir) if isQt();
273
274 sub unlinkZeroFiles ()
275 {
276     my $file = $File::Find::name;
277     if (! -s $file) {
278         unlink $file;
279         print "0 byte sized file removed from build directory: $file\n";
280     }
281 }
282
283 # Check that all the project directories are there.
284 my @projects = ("JavaScriptCore", "WebCore", "WebKit");
285
286 my @otherDirs = ("WebKitLibraries");
287 for my $dir (@projects, @otherDirs) {
288     if (! -d $dir) {
289         die "Error: No $dir directory found. Please do a fresh checkout.\n";
290     }
291 }
292
293 my @options = ();
294
295 # enable autotool options accordingly
296 if (isGtk()) {
297     @options = @ARGV;
298     foreach (@features) {
299         push @options, autotoolsFlag(${$_->{value}}, $_->{option});
300     }
301
302     push @options, "--prefix=" . $prefixPath if defined($prefixPath);
303     push @options, "--makeargs=" . $makeArgs if defined($makeArgs);
304 } elsif (isAppleMacWebKit()) {
305     push @options, XcodeOptions();
306
307     sub option($$$)
308     {
309         my ($feature, $isEnabled, $defaultValue) = @_;
310         return "" if $defaultValue == $isEnabled;
311         return $feature . "=" . ($isEnabled ? $feature : " ");
312     }
313
314     foreach (@features) {
315         if ($_->{option} eq "coverage") {
316             push @options, XcodeCoverageSupportOptions() if $coverageSupport;
317         } else {
318             my $option = option($_->{define}, ${$_->{value}}, $_->{default});
319             push @options, $option unless $option eq "";
320         }
321     }
322
323     # Apple builds JavaScriptGlue, and only on the Mac.
324     splice @projects, 1, 0, "JavaScriptGlue";
325
326     # WebKit2 is only supported in SnowLeopard and later at present.
327     push @projects, ("WebKit2", "WebKitTools/MiniBrowser") if osXVersion()->{"minor"} >= 6;
328
329     # Copy library and header from WebKitLibraries to a findable place in the product directory.
330     my @librariesToCopy = (
331         "libWebKitSystemInterfaceTiger.a",
332         "libWebKitSystemInterfaceLeopard.a",
333         "libWebKitSystemInterfaceSnowLeopard.a",
334         "libWebCoreSQLite3.a",
335     );
336     foreach my $libName (@librariesToCopy) {
337         my $srcLib = "WebKitLibraries/" . $libName;
338         my $lib = "$productDir/" . $libName;
339         if (!-e $lib || -M $lib > -M $srcLib) {
340             print "Updating $lib\n";
341             system "ditto", $srcLib, $lib;
342             system "ranlib", $lib;
343         }
344     }
345
346     # FIXME: This code should be abstracted to not be copy/paste.
347     my $srcHeader = "WebKitLibraries/WebKitSystemInterface.h";
348     my $header = "$productDir/usr/local/include/WebKitSystemInterface.h";
349     if (!-e $header || -M $header > -M $srcHeader) {
350         print "Updating $header\n";
351         system "mkdir", "-p", "$productDir/usr/local/include";
352         system "ditto", $srcHeader, $header;
353     }
354
355     my $srcHeaderDir = "WebKitLibraries/WebCoreSQLite3";
356     my $headerDir = "$productDir/WebCoreSQLite3";
357     if (!-e $headerDir || -M $headerDir > -M $srcHeaderDir) {
358         print "Updating $headerDir\n";
359         system "ditto", $srcHeaderDir, $headerDir;
360     }
361 } elsif (isAppleWinWebKit()) {
362     # Copy WebKitSupportLibrary to the correct location in WebKitLibraries so it can be found.
363     # Will fail if WebKitSupportLibrary.zip is not in source root.
364     (system("perl WebKitTools/Scripts/update-webkit-support-libs") == 0) or die;
365 } elsif (isQt()) {
366     @options = @ARGV;
367     push @options, "--install-headers=" . $installHeaders if defined($installHeaders);
368     push @options, "--install-libs=" . $installLibs if defined($installLibs);
369     push @options, "--makeargs=" . $makeArgs if defined($makeArgs);
370
371     foreach (@features) {
372         push @options, "DEFINES+=$_->{define}=${$_->{value}}" if ${$_->{value}} != $_->{default};
373     }
374
375     if ($minimal) {
376         push @options, "CONFIG+=minimal";
377     }
378 }
379
380 # Force re-link of existing libraries if different than expected
381 removeLibraryDependingOnFeature("WebCore", "SVG", $svgSupport);
382
383 if (isInspectorFrontend()) {
384     exit exitStatus(copyInspectorFrontendFiles());
385 }
386
387 if (isWx()) {
388     downloadWafIfNeeded();
389     push @projects, 'WebKitTools/DumpRenderTree';
390     push @projects, 'WebKitTools/wx/browser';
391     push @projects, 'WebKit/wx/bindings/python';
392 }
393
394 if (isChromium()) {
395     @options = @ARGV;
396     # Chromium doesn't build by project directories.
397     @projects = ();
398     my $result = buildChromium($clean, @options);
399     exit exitStatus($result) if exitStatus($result);
400 }
401
402 # Build, and abort if the build fails.
403 for my $dir (@projects) {
404     chdir $dir or die;
405     my $result = 0;
406
407     # For Gtk and Qt the WebKit project builds all others
408     if ((isGtk() || isQt()) && $dir ne "WebKit") {
409         chdir ".." or die;
410         next;
411     }
412
413     if (isGtk()) {
414         $result = buildGtkProject($dir, $clean,  @options);
415     } elsif (isQt()) {
416         $result = buildQMakeQtProject($dir, $clean, @options);
417     } elsif (isAppleMacWebKit()) {
418         $dir = "MiniBrowser" if $dir eq "WebKitTools/MiniBrowser";
419         $result = buildXCodeProject($dir, $clean, @options, @ARGV);
420     } elsif (isAppleWinWebKit()) {
421         if ($dir eq "WebKit") {
422             $result = buildVisualStudioProject("win/WebKit.vcproj/WebKit.sln", $clean);
423         }
424     } elsif (isWx()) {
425         @options = ();
426         if (defined($makeArgs)) {
427             @options = split(/ /, $makeArgs);
428         }
429         if ($dir eq "WebKit" && isWx()) {
430             chdir 'wx' or die;
431         }
432             
433         $result = buildWafProject($dir, $clean, @options);
434     }
435
436     if (exitStatus($result)) {
437         if (isAppleWinWebKit()) {
438             print "\n\n===== BUILD FAILED ======\n\n";
439             my $scriptDir = relativeScriptsDir();
440             print "Please ensure you have run $scriptDir/update-webkit to install dependencies.\n\n";
441             my $baseProductDir = baseProductDir();
442             print "You can view build errors by checking the BuildLog.htm files located at:\n$baseProductDir/obj/<project>/<config>.\n";
443         }
444         exit exitStatus($result);
445     }
446     chdirWebKit();
447 }
448
449 # Don't report the "WebKit is now built" message after a clean operation.
450 exit if $clean;
451
452 # Write out congratulations message.
453 writeCongrats();
454
455 exit 0;
456
457 sub formatBuildTime($)
458 {
459     my ($buildTime) = @_;
460
461     my $buildHours = int($buildTime / 3600);
462     my $buildMins = int(($buildTime - $buildHours * 3600) / 60);
463     my $buildSecs = $buildTime - $buildHours * 3600 - $buildMins * 60;
464
465     if ($buildHours) {
466         return sprintf("%dh:%02dm:%02ds", $buildHours, $buildMins, $buildSecs);
467     }
468     return sprintf("%02dm:%02ds", $buildMins, $buildSecs);
469 }
470
471 sub writeCongrats()
472 {
473     my $launcherPath = launcherPath();
474     my $launcherName = launcherName();
475     my $endTime = time();
476     my $buildTime = formatBuildTime($endTime - $startTime);
477
478     print "\n";
479     print "===========================================================\n";
480     print " WebKit is now built ($buildTime). \n";
481     if (!isChromium()) {
482         print " To run $launcherName with this newly-built code, use the\n";
483         print " \"$launcherPath\" script.\n";
484     }
485     print "===========================================================\n";
486 }