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