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