2010-02-19 Maciej Stachowiak <mjs@apple.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 #
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::Spec;
35 use FindBin;
36 use Getopt::Long qw(:config pass_through);
37 use lib $FindBin::Bin;
38 use webkitdirs;
39 use webkitperl::features;
40 use POSIX;
41
42 sub formatBuildTime($);
43 sub writeCongrats();
44
45 my $originalWorkingDirectory = getcwd();
46 chdirWebKit();
47
48 my $showHelp = 0;
49 my $clean = 0;
50 my $minimal = 0;
51 my $makeArgs;
52 my $startTime = time();
53
54 my ($threeDCanvasSupport, $threeDRenderingSupport, $channelMessagingSupport, $clientBasedGeolocationSupport, $databaseSupport, $datagridSupport, $datalistSupport,
55     $domStorageSupport, $eventsourceSupport, $filtersSupport, $geolocationSupport, $iconDatabaseSupport, $indexedDatabaseSupport,
56     $javaScriptDebuggerSupport, $mathmlSupport, $offlineWebApplicationSupport, $rubySupport, $sandboxSupport, $sharedWorkersSupport,
57     $svgSupport, $svgAnimationSupport, $svgAsImageSupport, $svgDOMObjCBindingsSupport, $svgFontsSupport,
58     $svgForeignObjectSupport, $svgUseSupport, $videoSupport, $webSocketsSupport, $wmlSupport, $wcssSupport, $xhtmlmpSupport, $workersSupport,
59     $xpathSupport, $xsltSupport, $coverageSupport, $notificationsSupport);
60
61 my @features = (
62     { option => "3d-canvas", desc => "Toggle 3D canvas support",
63       define => "ENABLE_3D_CANVAS", default => (isAppleMacWebKit() && !isTiger()), value => \$threeDCanvasSupport },
64
65     { option => "3d-rendering", desc => "Toggle 3D rendering support",
66       define => "ENABLE_3D_RENDERING", default => (isAppleMacWebKit() && !isTiger()), value => \$threeDRenderingSupport },
67
68     { option => "channel-messaging", desc => "Toggle MessageChannel and MessagePort support",
69       define => "ENABLE_CHANNEL_MESSAGING", default => 1, value => \$channelMessagingSupport },
70
71     { option => "client-based-geolocation", desc => "Toggle client-based Geolocation support",
72       define => "ENABLE_CLIENT_BASED_GEOLOCATION", default => isAppleWebKit(), value => \$clientBasedGeolocationSupport },
73
74     { option => "coverage", desc => "Toggle code coverage support",
75       define => "", default => 0, value => \$coverageSupport },
76
77     { option => "database", desc => "Toggle Database Support",
78       define => "ENABLE_DATABASE", default => 1, value => \$databaseSupport },
79
80     { option => "datagrid", desc => "Toggle Datagrid Support",
81       define => "ENABLE_DATAGRID", default => 0, value => \$datagridSupport },
82       
83     { option => "datalist", desc => "Toggle HTML5 datalist support",
84       define => "ENABLE_DATALIST", default => 1, value => \$datalistSupport },
85           
86     { option => "dom-storage", desc => "Toggle DOM Storage Support",
87       define => "ENABLE_DOM_STORAGE", default => 1, value => \$domStorageSupport },
88
89     { option => "eventsource", desc => "Toggle server-sent events support",
90       define => "ENABLE_EVENTSOURCE", default => 1, value => \$eventsourceSupport },
91
92     { option => "filters", desc => "Toggle Filters support",
93       define => "ENABLE_FILTERS", default => (isAppleWebKit() || isGtk() || isQt()), value => \$filtersSupport },
94
95     { option => "geolocation", desc => "Toggle Geolocation support",
96       define => "ENABLE_GEOLOCATION", default => (isAppleWebKit() || isGtk()), value => \$geolocationSupport },
97
98     { option => "icon-database", desc => "Toggle Icon database support",
99       define => "ENABLE_ICONDATABASE", default => 1, value => \$iconDatabaseSupport },
100
101     { option => "indexed-database", desc => "Toggle Indexed Database API support",
102       define => "ENABLE_INDEXED_DATABASE", default => 0, value => \$indexedDatabaseSupport },
103
104     { option => "javascript-debugger", desc => "Toggle JavaScript Debugger/Profiler support",
105       define => "ENABLE_JAVASCRIPT_DEBUGGER", default => 1, value => \$javaScriptDebuggerSupport },
106
107     { option => "mathml", desc => "Toggle MathML support",
108       define => "ENABLE_MATHML", default => 0, value => \$mathmlSupport },
109
110     { option => "notifications", desc => "Toggle Desktop Notifications Support",
111       define => "ENABLE_NOTIFICATIONS", default => 0, value => \$notificationsSupport },
112
113     { option => "offline-web-applications", desc => "Toggle Offline Web Application Support",
114       define => "ENABLE_OFFLINE_WEB_APPLICATIONS", default => 1, value => \$offlineWebApplicationSupport },
115
116     { option => "ruby", desc => "Toggle HTML5 Ruby support",
117       define => "ENABLE_RUBY", default => 1, value => \$rubySupport },
118
119     { option => "sandbox", desc => "Toggle HTML5 Sandboxed iframe support",
120       define => "ENABLE_SANDBOX", default => 1, value => \$sandboxSupport },
121
122     { option => "shared-workers", desc => "Toggle SharedWorkers support",
123       define => "ENABLE_SHARED_WORKERS", default => (isAppleWebKit() || isGtk()), value => \$sharedWorkersSupport },
124
125     { option => "svg", desc => "Toggle SVG support",
126       define => "ENABLE_SVG", default => 1, value => \$svgSupport },
127
128     { option => "svg-animation", desc => "Toggle SVG animation support (implies SVG support)",
129       define => "ENABLE_SVG_ANIMATION", default => 1, value => \$svgAnimationSupport },
130
131     { option => "svg-as-image", desc => "Toggle SVG as Image support (implies SVG support)",
132       define => "ENABLE_SVG_AS_IMAGE", default => 1, value => \$svgAsImageSupport },
133
134     { option => "svg-dom-objc-bindings", desc => "Toggle SVG DOM Objective-C bindings support (implies SVG support)",
135       define => "ENABLE_SVG_DOM_OBJC_BINDINGS", default => isAppleMacWebKit(), value => \$svgDOMObjCBindingsSupport },
136
137     { option => "svg-fonts", desc => "Toggle SVG fonts support (imples SVG support)",
138       define => "ENABLE_SVG_FONTS", default => 1, value => \$svgFontsSupport },
139
140     { option => "svg-foreign-object", desc => "Toggle SVG foreign object support (implies SVG support)",
141       define => "ENABLE_SVG_FOREIGN_OBJECT", default => 1, value => \$svgForeignObjectSupport },
142
143     { option => "svg-use", desc => "Toggle SVG use element support (implies SVG support)",
144       define => "ENABLE_SVG_USE", default => 1, value => \$svgUseSupport },
145
146     { option => "video", desc => "Toggle Video support",
147       define => "ENABLE_VIDEO", default => (isAppleWebKit() || isGtk()), value => \$videoSupport },
148
149     { option => "web-sockets", desc => "Toggle Web Sockets support",
150       define => "ENABLE_WEB_SOCKETS", default => 1, value=> \$webSocketsSupport },
151
152     { option => "wml", desc => "Toggle WML support",
153       define => "ENABLE_WML", default => 0, value => \$wmlSupport },
154
155     { option => "xhtmlmp", desc => "Toggle XHTML-MP support",
156       define => "ENABLE_XHTMLMP", default => 0, value => \$xhtmlmpSupport },
157
158     { option => "wcss", desc => "Toggle WCSS support",
159       define => "ENABLE_WCSS", default => 0, value => \$wcssSupport },
160
161     { option => "workers", desc => "Toggle Web Workers support",
162       define => "ENABLE_WORKERS", default => (isAppleWebKit() || isGtk()), value => \$workersSupport },
163
164     { option => "xpath", desc => "Toggle XPath support",
165       define => "ENABLE_XPATH", default => 1, value => \$xpathSupport },
166
167     { option => "xslt", desc => "Toggle XSLT support",
168       define => "ENABLE_XSLT", default => 1, value => \$xsltSupport },
169 );
170
171 # Update defaults from Qt's project file
172 if (isQt()) {
173     my %qtDefaults = qtFeatureDefaults();
174     foreach (@features) {
175         $_->{default} = $qtDefaults{$_->{define}} || 0;
176     }
177 }
178
179 # Additional environment parameters
180 push @ARGV, split(/ /, $ENV{'BUILD_WEBKIT_ARGS'}) if ($ENV{'BUILD_WEBKIT_ARGS'});
181
182 # Initialize values from defaults
183 foreach (@ARGV) {
184     if ($_ eq '--minimal') {
185         $minimal = 1;
186         last;
187     }
188 }
189
190 # Initialize values from defaults
191 foreach (@features) {
192     ${$_->{value}} = ($_->{default} && !$minimal) || 0;
193 }
194
195 $svgSupport = $svgSupport || $svgAnimationSupport || $svgAsImageSupport
196     || $svgDOMObjCBindingsSupport || $svgFontsSupport
197     || $svgForeignObjectSupport || $svgUseSupport;
198
199
200 my $programName = basename($0);
201 my $usage = <<EOF;
202 Usage: $programName [options] [options to pass to build system]
203   --help                            Show this help message
204   --clean                           Cleanup the build directory
205   --debug                           Compile in debug mode
206   --cairo-win32                     Build using Cairo (rather than CoreGraphics) on Windows
207   --chromium                        Build the Chromium port on Mac/Win/Linux
208   --gtk                             Build the GTK+ port
209   --qt                              Build the Qt port
210   --inspector-frontend              Copy changes to the inspector front-end files to the build directory
211
212   --makeargs=<arguments>            Optional Makefile flags
213
214   --minimal                         No optional features, unless explicitly enabled.
215
216 EOF
217
218 my %options = (
219     'help' => \$showHelp,
220     'clean' => \$clean,
221     'makeargs=s' => \$makeArgs,
222     'minimal' => \$minimal,
223 );
224
225 # Build usage text and options list from features
226 foreach (@features) {
227     my $opt = sprintf("%-35s", "  --[no-]$_->{option}");
228     $usage .= "$opt $_->{desc} (default: $_->{default})\n";
229     $options{"$_->{option}!"} = $_->{value};
230 }
231
232 GetOptions(%options);
233
234 if ($showHelp) {
235    print STDERR $usage;
236    exit 1;
237 }
238
239 checkRequiredSystemConfig();
240 setConfiguration();
241
242 my $productDir = productDir();
243
244 # Check that all the project directories are there.
245 my @projects = ("JavaScriptCore", "WebCore", "WebKit");
246 # Only Apple builds JavaScriptGlue, and only on the Mac
247 splice @projects, 1, 0, "JavaScriptGlue" if isAppleMacWebKit();
248
249 my @otherDirs = ("WebKitLibraries");
250 for my $dir (@projects, @otherDirs) {
251     if (! -d $dir) {
252         die "Error: No $dir directory found. Please do a fresh checkout.\n";
253     }
254 }
255
256 my @options = ();
257
258 # enable autotool options accordingly
259 if (isGtk()) {
260     foreach (@features) {
261         push @options, autotoolsFlag(${$_->{value}}, $_->{option});
262     }
263
264     push @options, "--makeargs=" . $makeArgs if defined($makeArgs);
265 } elsif (isAppleMacWebKit()) {
266     push @options, XcodeOptions();
267
268     sub option($$)
269     {
270         my ($feature, $isEnabled) = @_;
271         return $feature . "=" . ($isEnabled ? $feature : " ");
272     }
273
274     foreach (@features) {
275         if ($_->{option} eq "coverage") {
276             push @options, XcodeCoverageSupportOptions() if $coverageSupport;
277         } else {
278             push @options, option($_->{define}, ${$_->{value}});
279         }
280     }
281
282     # Copy library and header from WebKitLibraries to a findable place in the product directory.
283
284     my @librariesToCopy = (
285         "libWebKitSystemInterfaceTiger.a",
286         "libWebKitSystemInterfaceLeopard.a",
287         "libWebKitSystemInterfaceSnowLeopard.a",
288         "libWebCoreSQLite3.a",
289     );
290     foreach my $libName (@librariesToCopy) {
291         my $srcLib = "WebKitLibraries/" . $libName;
292         my $lib = "$productDir/" . $libName;
293         if (!-e $lib || -M $lib > -M $srcLib) {
294             print "Updating $lib\n";
295             system "ditto", $srcLib, $lib;
296             system "ranlib", $lib;
297         }
298     }
299
300     # FIXME: This code should be abstracted to not be copy/paste.
301     my $srcHeader = "WebKitLibraries/WebKitSystemInterface.h";
302     my $header = "$productDir/usr/local/include/WebKitSystemInterface.h";
303     if (!-e $header || -M $header > -M $srcHeader) {
304         print "Updating $header\n";
305         system "mkdir", "-p", "$productDir/usr/local/include";
306         system "ditto", $srcHeader, $header;
307     }
308
309     my $srcHeaderDir = "WebKitLibraries/WebCoreSQLite3";
310     my $headerDir = "$productDir/WebCoreSQLite3";
311     if (!-e $headerDir || -M $headerDir > -M $srcHeaderDir) {
312         print "Updating $headerDir\n";
313         system "ditto", $srcHeaderDir, $headerDir;
314     }
315 } elsif (isAppleWinWebKit()) {
316     # Copy WebKitSupportLibrary to the correct location in WebKitLibraries so it can be found.
317     # Will fail if WebKitSupportLibrary.zip is not in source root.
318     (system("perl WebKitTools/Scripts/update-webkit-support-libs") == 0) or die;
319 } elsif (isQt()) {
320     @options = @ARGV;
321     push @options, "--makeargs=" . $makeArgs if defined($makeArgs);
322
323     foreach (@features) {
324         push @options, "DEFINES+=$_->{define}=${$_->{value}}" if ${$_->{value}} != $_->{default};
325     }
326 }
327
328 # Force re-link of existing libraries if different than expected
329 removeLibraryDependingOnFeature("WebCore", "SVG", $svgSupport);
330
331 if (isInspectorFrontend()) {
332     exit exitStatus(copyInspectorFrontendFiles());
333 }
334
335 if (isWx()) {
336     downloadWafIfNeeded();
337     push @projects, 'WebKitTools/DumpRenderTree';
338     push @projects, 'WebKitTools/wx/browser';
339     push @projects, 'WebKit/wx/bindings/python';
340 }
341
342 if (isChromium()) {
343     # Chromium doesn't build by project directories.
344     @projects = ();
345     my $result = buildChromium($clean, @options);
346     exit exitStatus($result) if exitStatus($result);
347 }
348
349 # Build, and abort if the build fails.
350 for my $dir (@projects) {
351     chdir $dir or die;
352     my $result = 0;
353
354     # For Gtk and Qt the WebKit project builds all others
355     if ((isGtk() || isQt()) && $dir ne "WebKit") {
356         chdir ".." or die;
357         next;
358     }
359
360     if (isGtk()) {
361         $result = buildGtkProject($dir, $clean,  @options);
362     } elsif (isQt()) {
363         $result = buildQMakeQtProject($dir, $clean, @options);
364     } elsif (isAppleMacWebKit()) {
365         $result = buildXCodeProject($dir, $clean, @options, @ARGV);
366     } elsif (isAppleWinWebKit()) {
367         if ($dir eq "WebKit") {
368             $result = buildVisualStudioProject("win/WebKit.vcproj/WebKit.sln", $clean);
369         }
370     } elsif (isWx()) {
371         @options = ();
372         if (defined($makeArgs)) {
373             @options = split(/ /, $makeArgs);
374         }
375         if ($dir eq "WebKit" && isWx()) {
376             chdir 'wx' or die;
377         }
378             
379         $result = buildWafProject($dir, $clean, @options);
380     }
381
382     if (exitStatus($result)) {
383         if (isAppleWinWebKit()) {
384             print "\n\n===== BUILD FAILED ======\n\n";
385             my $scriptDir = relativeScriptsDir();
386             print "Please ensure you have run $scriptDir/update-webkit to install dependencies.\n\n";
387             my $baseProductDir = baseProductDir();
388             print "You can view build errors by checking the BuildLog.htm files located at:\n$baseProductDir/obj/<project>/<config>.\n";
389         }
390         exit exitStatus($result);
391     }
392     chdirWebKit();
393 }
394
395 # Don't report the "WebKit is now built" message after a clean operation.
396 exit if $clean;
397
398 # Write out congratulations message.
399 writeCongrats();
400
401 exit 0;
402
403 sub formatBuildTime($)
404 {
405     my ($buildTime) = @_;
406
407     my $buildHours = int($buildTime / 3600);
408     my $buildMins = int(($buildTime - $buildHours * 3600) / 60);
409     my $buildSecs = $buildTime - $buildHours * 3600 - $buildMins * 60;
410
411     if ($buildHours) {
412         return sprintf("%dh:%02dm:%02ds", $buildHours, $buildMins, $buildSecs);
413     }
414     return sprintf("%02dm:%02ds", $buildMins, $buildSecs);
415 }
416
417 sub writeCongrats()
418 {
419     my $launcherPath = launcherPath();
420     my $launcherName = launcherName();
421     my $endTime = time();
422     my $buildTime = formatBuildTime($endTime - $startTime);
423
424     print "\n";
425     print "===========================================================\n";
426     print " WebKit is now built ($buildTime). \n";
427     if (!isChromium()) {
428         print " To run $launcherName with this newly-built code, use the\n";
429         print " \"$launcherPath\" script.\n";
430     }
431     print "===========================================================\n";
432 }